swift-sdk/Sources/Hanzo/Models/Capabilities.swift

//
// Capabilities.swift
//
// Generated by openapi-generator
// https://openapi-generator.tech
//

import Foundation

public struct Capabilities: Sendable, Codable, ParameterConvertible, Hashable {

    /** Actions is whether the transport renders an INTERACTIVE control natively, and it is the flag to read before composing one. The vocabulary is a closed kind-tagged union (envelope.go), exactly four kinds, each carrying only its own field plus an optional label:   command  — a bot command to run (`command`), rendered as a button that             invokes it.  url      — an external link (`url`), rendered as a link button.  select   — a menu (`options`, each a label and the value choosing it             returns), rendered as a picker.  approval — a reference to an approval request (`approval.id`), rendered as             approve/deny controls bound to that id.  False on every transport, and nothing refuses a send for it: actions are accepted, validated per kind, and flattened by renderText to one line each after the text — `[label] command`, `[label] url`, `[label] opt | opt`, `[label] approval requested: <id>`. So a caller that needs a real control must read this flag and degrade itself; a caller that only needs the choice communicated can send actions and take the text form. */
    public var actions: Bool?
    /** DM is whether the transport carries a DIRECT message at all. True for slack, teams, telegram and whatsapp — whatsapp is nothing else, since the Cloud API addresses a person's number and there is no room a third party joins. False for discord, honestly: that ingress is guild-scoped slash commands — an interaction without a guild id is refused at the endpoint — so nothing ever arrives classified as a DM, no reply route is ever learned for one, and a send addressed at a Discord DM is refused 409. */
    public var dm: Bool?
    /** Group is whether the transport carries multi-person rooms — a Discord guild channel, a Slack channel, a Teams channel or group chat, a Telegram group or supergroup. False on whatsapp alone, which has no such room to carry. */
    public var group: Bool?
    /** Media is whether the transport renders an ATTACHMENT natively. False everywhere, and a send is not refused for it: renderText flattens each attachment to one `kind: url (mime)` line after the text rather than dropping it. A transport whose egress passes the raw text straight through would drop the attachment instead, and an attachment-only send would reach the platform with nothing to say — which is why the flag and the flattening are pinned together. */
    public var media: Bool?
    /** Thread is whether a reply can be threaded UNDER a specific message. True for slack alone: it is the only transport whose ingress reports a thread (thread_ts, published as the envelope's replyTo) and whose send posts back into it. Discord's replyTo makes an inline reply rather than a thread, Telegram's and WhatsApp's each quote one message, and Teams carries no reply target at all — a replyTo sent to it is ignored. */
    public var thread: Bool?

    public init(actions: Bool? = nil, dm: Bool? = nil, group: Bool? = nil, media: Bool? = nil, thread: Bool? = nil) {
        self.actions = actions
        self.dm = dm
        self.group = group
        self.media = media
        self.thread = thread
    }

    public enum CodingKeys: String, CodingKey, CaseIterable {
        case actions
        case dm
        case group
        case media
        case thread
    }

    // Encodable protocol methods

    public func encode(to encoder: Encoder) throws {
        var container = encoder.container(keyedBy: CodingKeys.self)
        try container.encodeIfPresent(actions, forKey: .actions)
        try container.encodeIfPresent(dm, forKey: .dm)
        try container.encodeIfPresent(group, forKey: .group)
        try container.encodeIfPresent(media, forKey: .media)
        try container.encodeIfPresent(thread, forKey: .thread)
    }
}