telnyx 5.160.0 → 5.161.0

data/lib/telnyx/models/meeting_session.rb

@@ -0,0 +1,380 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    class MeetingSession < Telnyx::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the meeting session.
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute account_id
+      #   Identifier of the owning account.
+      #
+      #   @return [String]
+      required :account_id, String
+
+      # @!attribute assistant
+      #   Assistant configuration if an assistant is attached, otherwise null.
+      #
+      #   @return [Telnyx::Models::MeetingSession::Assistant, nil]
+      required :assistant, -> { Telnyx::MeetingSession::Assistant }, nil?: true
+
+      # @!attribute assistant_state
+      #   Current state of the assistant, or null if no assistant is attached.
+      #
+      #   @return [Symbol, Telnyx::Models::MeetingSession::AssistantState, nil]
+      required :assistant_state, enum: -> { Telnyx::MeetingSession::AssistantState }, nil?: true
+
+      # @!attribute assistant_state_changed_at
+      #   Timestamp of the last assistant state change, or null.
+      #
+      #   @return [Time, nil]
+      required :assistant_state_changed_at, Time, nil?: true
+
+      # @!attribute avatar
+      #   Avatar configuration if an avatar is attached, otherwise null.
+      #
+      #   @return [Telnyx::Models::MeetingSession::Avatar, nil]
+      required :avatar, -> { Telnyx::MeetingSession::Avatar }, nil?: true
+
+      # @!attribute avatar_state
+      #   Current state of the avatar connection, or null if no avatar is attached.
+      #
+      #   @return [Symbol, Telnyx::Models::MeetingSession::AvatarState, nil]
+      required :avatar_state, enum: -> { Telnyx::MeetingSession::AvatarState }, nil?: true
+
+      # @!attribute avatar_state_changed_at
+      #   Timestamp of the last avatar state change, or null.
+      #
+      #   @return [Time, nil]
+      required :avatar_state_changed_at, Time, nil?: true
+
+      # @!attribute bot_name
+      #   Display name of the bot in the meeting.
+      #
+      #   @return [String]
+      required :bot_name, String
+
+      # @!attribute config
+      #
+      #   @return [Telnyx::Models::MeetingSession::Config]
+      required :config, -> { Telnyx::MeetingSession::Config }
+
+      # @!attribute created_at
+      #   Timestamp when the session was created.
+      #
+      #   @return [Time]
+      required :created_at, Time
+
+      # @!attribute ended_at
+      #   Timestamp when the session ended, or null if ongoing.
+      #
+      #   @return [Time, nil]
+      required :ended_at, Time, nil?: true
+
+      # @!attribute failure_reason
+      #   Human-readable failure reason if the session failed, or null.
+      #
+      #   @return [String, nil]
+      required :failure_reason, String, nil?: true
+
+      # @!attribute join_at
+      #   Scheduled join time, or null for immediate join.
+      #
+      #   @return [Time, nil]
+      required :join_at, Time, nil?: true
+
+      # @!attribute joined_at
+      #   Timestamp when the session first became `active`, or null if it never became
+      #   active. This remains positive admission evidence after terminal transitions.
+      #
+      #   @return [Time, nil]
+      required :joined_at, Time, nil?: true
+
+      # @!attribute meeting_url
+      #   The meeting URL the bot joins.
+      #
+      #   @return [String]
+      required :meeting_url, String
+
+      # @!attribute metadata
+      #   Arbitrary key-value metadata attached to the session.
+      #
+      #   @return [Hash{Symbol=>Object}]
+      required :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute platform
+      #   Detected meeting platform.
+      #
+      #   @return [Symbol, Telnyx::Models::MeetingSession::Platform]
+      required :platform, enum: -> { Telnyx::MeetingSession::Platform }
+
+      # @!attribute provider
+      #   Provider handling the meeting session.
+      #
+      #   @return [String]
+      required :provider, String
+
+      # @!attribute recording
+      #   Whether the session is being recorded.
+      #
+      #   @return [Boolean]
+      required :recording, Telnyx::Internal::Type::Boolean
+
+      # @!attribute status
+      #   Lifecycle status. `waiting_for_admission` means the bot reached the meeting
+      #   lobby and may require host approval. `active` means the bot entered the
+      #   meeting/media path. `ended` alone does not prove attendance; use non-null
+      #   `joined_at` as positive evidence that the session became active.
+      #   `admission_denied` is reserved for an explicit provider denial, while
+      #   cancellation or another termination can end a never-admitted session as `ended`.
+      #
+      #   @return [Symbol, Telnyx::Models::MeetingSession::Status]
+      required :status, enum: -> { Telnyx::MeetingSession::Status }
+
+      # @!attribute status_detail
+      #   Additional human-readable detail about the status, or null.
+      #
+      #   @return [String, nil]
+      required :status_detail, String, nil?: true
+
+      # @!attribute updated_at
+      #   Timestamp of the last update to the session.
+      #
+      #   @return [Time]
+      required :updated_at, Time
+
+      # @!attribute webhook_url
+      #   Webhook endpoint for session lifecycle callbacks, or null if not configured.
+      #
+      #   @return [String, nil]
+      required :webhook_url, String, nil?: true
+
+      # @!method initialize(id:, account_id:, assistant:, assistant_state:, assistant_state_changed_at:, avatar:, avatar_state:, avatar_state_changed_at:, bot_name:, config:, created_at:, ended_at:, failure_reason:, join_at:, joined_at:, meeting_url:, metadata:, platform:, provider:, recording:, status:, status_detail:, updated_at:, webhook_url:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MeetingSession} for more details.
+      #
+      #   Represents a meeting session. All serializer fields are present and required;
+      #   nullable fields use null when absent. No actor, provider-bot, idempotency,
+      #   routing, key, or internal fields are exposed.
+      #
+      #   @param id [String] Unique identifier for the meeting session.
+      #
+      #   @param account_id [String] Identifier of the owning account.
+      #
+      #   @param assistant [Telnyx::Models::MeetingSession::Assistant, nil] Assistant configuration if an assistant is attached, otherwise null.
+      #
+      #   @param assistant_state [Symbol, Telnyx::Models::MeetingSession::AssistantState, nil] Current state of the assistant, or null if no assistant is attached.
+      #
+      #   @param assistant_state_changed_at [Time, nil] Timestamp of the last assistant state change, or null.
+      #
+      #   @param avatar [Telnyx::Models::MeetingSession::Avatar, nil] Avatar configuration if an avatar is attached, otherwise null.
+      #
+      #   @param avatar_state [Symbol, Telnyx::Models::MeetingSession::AvatarState, nil] Current state of the avatar connection, or null if no avatar is attached.
+      #
+      #   @param avatar_state_changed_at [Time, nil] Timestamp of the last avatar state change, or null.
+      #
+      #   @param bot_name [String] Display name of the bot in the meeting.
+      #
+      #   @param config [Telnyx::Models::MeetingSession::Config]
+      #
+      #   @param created_at [Time] Timestamp when the session was created.
+      #
+      #   @param ended_at [Time, nil] Timestamp when the session ended, or null if ongoing.
+      #
+      #   @param failure_reason [String, nil] Human-readable failure reason if the session failed, or null.
+      #
+      #   @param join_at [Time, nil] Scheduled join time, or null for immediate join.
+      #
+      #   @param joined_at [Time, nil] Timestamp when the session first became `active`, or null if it never became act
+      #
+      #   @param meeting_url [String] The meeting URL the bot joins.
+      #
+      #   @param metadata [Hash{Symbol=>Object}] Arbitrary key-value metadata attached to the session.
+      #
+      #   @param platform [Symbol, Telnyx::Models::MeetingSession::Platform] Detected meeting platform.
+      #
+      #   @param provider [String] Provider handling the meeting session.
+      #
+      #   @param recording [Boolean] Whether the session is being recorded.
+      #
+      #   @param status [Symbol, Telnyx::Models::MeetingSession::Status] Lifecycle status. `waiting_for_admission` means the bot reached the meeting lobb
+      #
+      #   @param status_detail [String, nil] Additional human-readable detail about the status, or null.
+      #
+      #   @param updated_at [Time] Timestamp of the last update to the session.
+      #
+      #   @param webhook_url [String, nil] Webhook endpoint for session lifecycle callbacks, or null if not configured.
+
+      # @see Telnyx::Models::MeetingSession#assistant
+      class Assistant < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifier of the assistant.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute audio_gate
+        #   Audio gating strategy for the assistant call leg.
+        #
+        #   @return [Symbol, Telnyx::Models::MeetingSession::Assistant::AudioGate]
+        required :audio_gate, enum: -> { Telnyx::MeetingSession::Assistant::AudioGate }
+
+        # @!method initialize(id:, audio_gate:)
+        #   Assistant configuration if an assistant is attached, otherwise null.
+        #
+        #   @param id [String] Identifier of the assistant.
+        #
+        #   @param audio_gate [Symbol, Telnyx::Models::MeetingSession::Assistant::AudioGate] Audio gating strategy for the assistant call leg.
+
+        # Audio gating strategy for the assistant call leg.
+        #
+        # @see Telnyx::Models::MeetingSession::Assistant#audio_gate
+        module AudioGate
+          extend Telnyx::Internal::Type::Enum
+
+          NONE = :none
+          HALF_DUPLEX = :half_duplex
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      # Current state of the assistant, or null if no assistant is attached.
+      #
+      # @see Telnyx::Models::MeetingSession#assistant_state
+      module AssistantState
+        extend Telnyx::Internal::Type::Enum
+
+        STARTING = :starting
+        CONNECTED = :connected
+        FAILED = :failed
+        ENDED = :ended
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::MeetingSession#avatar
+      class Avatar < Telnyx::Internal::Type::BaseModel
+        # @!attribute avatar_id
+        #   Identifier of the avatar.
+        #
+        #   @return [String]
+        required :avatar_id, String
+
+        # @!attribute provider
+        #   Avatar provider identifier.
+        #
+        #   @return [Symbol, :anam]
+        required :provider, const: :anam
+
+        # @!method initialize(avatar_id:, provider: :anam)
+        #   Avatar configuration if an avatar is attached, otherwise null.
+        #
+        #   @param avatar_id [String] Identifier of the avatar.
+        #
+        #   @param provider [Symbol, :anam] Avatar provider identifier.
+      end
+
+      # Current state of the avatar connection, or null if no avatar is attached.
+      #
+      # @see Telnyx::Models::MeetingSession#avatar_state
+      module AvatarState
+        extend Telnyx::Internal::Type::Enum
+
+        STARTING = :starting
+        CONNECTED = :connected
+        DEGRADED = :degraded
+        DISCONNECTED = :disconnected
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # @see Telnyx::Models::MeetingSession#config
+      class Config < Telnyx::Internal::Type::BaseModel
+        # @!attribute barge_in
+        #   When enabled, a human participant `speech_on` event interrupts and stops the
+        #   current bot audio; it does not bypass admission or initiate speech. Assistant
+        #   sessions reject `barge_in: true`.
+        #
+        #   @return [Boolean]
+        required :barge_in, Telnyx::Internal::Type::Boolean
+
+        # @!attribute speak_on_enter
+        #   Text spoken on meeting entry, or null if not set.
+        #
+        #   @return [String, nil]
+        required :speak_on_enter, String, nil?: true
+
+        # @!attribute summarize_on_end
+        #   Whether a summary artifact is generated on session end.
+        #
+        #   @return [Boolean]
+        required :summarize_on_end, Telnyx::Internal::Type::Boolean
+
+        # @!attribute voice
+        #   Configured voice identifier, or null if not set.
+        #
+        #   @return [String, nil]
+        required :voice, String, nil?: true
+
+        # @!method initialize(barge_in:, speak_on_enter:, summarize_on_end:, voice:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSession::Config} for more details.
+        #
+        #   @param barge_in [Boolean] When enabled, a human participant `speech_on` event interrupts and stops the cur
+        #
+        #   @param speak_on_enter [String, nil] Text spoken on meeting entry, or null if not set.
+        #
+        #   @param summarize_on_end [Boolean] Whether a summary artifact is generated on session end.
+        #
+        #   @param voice [String, nil] Configured voice identifier, or null if not set.
+      end
+
+      # Detected meeting platform.
+      #
+      # @see Telnyx::Models::MeetingSession#platform
+      module Platform
+        extend Telnyx::Internal::Type::Enum
+
+        ZOOM = :zoom
+        GOOGLE_MEET = :google_meet
+        TEAMS = :teams
+        WEBEX = :webex
+        UNKNOWN = :unknown
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # Lifecycle status. `waiting_for_admission` means the bot reached the meeting
+      # lobby and may require host approval. `active` means the bot entered the
+      # meeting/media path. `ended` alone does not prove attendance; use non-null
+      # `joined_at` as positive evidence that the session became active.
+      # `admission_denied` is reserved for an explicit provider denial, while
+      # cancellation or another termination can end a never-admitted session as `ended`.
+      #
+      # @see Telnyx::Models::MeetingSession#status
+      module Status
+        extend Telnyx::Internal::Type::Enum
+
+        SCHEDULED = :scheduled
+        JOINING = :joining
+        WAITING_FOR_ADMISSION = :waiting_for_admission
+        ACTIVE = :active
+        LEAVING = :leaving
+        ENDED = :ended
+        FAILED = :failed
+        ADMISSION_DENIED = :admission_denied
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_create_params.rb

@@ -0,0 +1,309 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#create
+    class MeetingSessionCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute meeting_url
+      #   The meeting URL the bot should join.
+      #
+      #   @return [String]
+      required :meeting_url, String
+
+      # @!attribute assistant
+      #   Request options for attaching a voice assistant to the session. Routing fields
+      #   (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
+      #   establish the assistant call leg and are omitted from response objects.
+      #   `audio_gate` is returned with `id` in the assistant response object.
+      #
+      #   @return [Telnyx::Models::MeetingSessionCreateParams::Assistant, nil]
+      optional :assistant, -> { Telnyx::MeetingSessionCreateParams::Assistant }
+
+      # @!attribute avatar
+      #   Request options for attaching a bring-your-own-key avatar to the session.
+      #
+      #   @return [Telnyx::Models::MeetingSessionCreateParams::Avatar, nil]
+      optional :avatar, -> { Telnyx::MeetingSessionCreateParams::Avatar }
+
+      # @!attribute barge_in
+      #   When enabled, a human participant `speech_on` event interrupts and stops the
+      #   current bot audio; it does not bypass admission or initiate speech. Assistant
+      #   sessions reject `barge_in: true`.
+      #
+      #   @return [Boolean, nil]
+      optional :barge_in, Telnyx::Internal::Type::Boolean
+
+      # @!attribute bot_name
+      #   Display name for the bot in the meeting. Defaults to "Meeting Bot".
+      #
+      #   @return [String, nil]
+      optional :bot_name, String
+
+      # @!attribute camera_image
+      #   Write-only static camera-tile image for this session, not a native account or
+      #   participant profile photo. Supply exactly one JPEG source. When effective, the
+      #   image is used as the bot's static camera/video output; presentation varies by
+      #   meeting platform and recording configuration and is not guaranteed in
+      #   recordings. An effective Avatar or Assistant webpage output takes precedence, so
+      #   this input is ignored and a URL source is not fetched.
+      #
+      #   @return [Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source, Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource, nil]
+      optional :camera_image, union: -> { Telnyx::MeetingSessionCreateParams::CameraImage }
+
+      # @!attribute idempotency_key
+      #   Client-supplied idempotency key to safely retry creation requests without
+      #   duplicating sessions. Lookup is scoped to the authenticated account and compares
+      #   the key only; the request payload is not fingerprinted or compared.
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!attribute join_at
+      #   ISO-8601 timestamp in the future at which the bot should join. If omitted, the
+      #   bot joins immediately.
+      #
+      #   @return [Time, nil]
+      optional :join_at, Time
+
+      # @!attribute metadata
+      #   Arbitrary key-value metadata attached to the session. The serialized JSON
+      #   representation must not exceed 16384 characters at runtime.
+      #
+      #   @return [Hash{Symbol=>Object}, nil]
+      optional :metadata, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+      # @!attribute speak_on_enter
+      #   Text the bot speaks when it enters the meeting.
+      #
+      #   @return [String, nil]
+      optional :speak_on_enter, String
+
+      # @!attribute summarize_on_end
+      #   If true, generate a summary artifact when the session ends.
+      #
+      #   @return [Boolean, nil]
+      optional :summarize_on_end, Telnyx::Internal::Type::Boolean
+
+      # @!attribute voice
+      #   Session-default voice identifier used for `speak_on_enter` and ordinary speak
+      #   actions. A voice supplied on an individual speak action overrides this default
+      #   for that utterance.
+      #
+      #   @return [String, nil]
+      optional :voice, String
+
+      # @!attribute webhook_url
+      #   HTTPS endpoint to receive session lifecycle callbacks. Static validation
+      #   requires HTTPS, rejects embedded credentials and blocked hosts, and enforces
+      #   egress policy. Validation makes no network request to the endpoint.
+      #
+      #   @return [String, nil]
+      optional :webhook_url, String
+
+      # @!method initialize(meeting_url:, assistant: nil, avatar: nil, barge_in: nil, bot_name: nil, camera_image: nil, idempotency_key: nil, join_at: nil, metadata: nil, speak_on_enter: nil, summarize_on_end: nil, voice: nil, webhook_url: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MeetingSessionCreateParams} for more details.
+      #
+      #   @param meeting_url [String] The meeting URL the bot should join.
+      #
+      #   @param assistant [Telnyx::Models::MeetingSessionCreateParams::Assistant] Request options for attaching a voice assistant to the session. Routing fields (
+      #
+      #   @param avatar [Telnyx::Models::MeetingSessionCreateParams::Avatar] Request options for attaching a bring-your-own-key avatar to the session.
+      #
+      #   @param barge_in [Boolean] When enabled, a human participant `speech_on` event interrupts and stops the cur
+      #
+      #   @param bot_name [String] Display name for the bot in the meeting. Defaults to "Meeting Bot".
+      #
+      #   @param camera_image [Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source, Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource] Write-only static camera-tile image for this session, not a native account or pa
+      #
+      #   @param idempotency_key [String] Client-supplied idempotency key to safely retry creation requests without duplic
+      #
+      #   @param join_at [Time] ISO-8601 timestamp in the future at which the bot should join. If omitted, the b
+      #
+      #   @param metadata [Hash{Symbol=>Object}] Arbitrary key-value metadata attached to the session. The serialized JSON repres
+      #
+      #   @param speak_on_enter [String] Text the bot speaks when it enters the meeting.
+      #
+      #   @param summarize_on_end [Boolean] If true, generate a summary artifact when the session ends.
+      #
+      #   @param voice [String] Session-default voice identifier used for `speak_on_enter` and ordinary speak ac
+      #
+      #   @param webhook_url [String] HTTPS endpoint to receive session lifecycle callbacks. Static validation require
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      class Assistant < Telnyx::Internal::Type::BaseModel
+        # @!attribute id
+        #   Identifier of the assistant to attach.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute call_control_connection_id
+        #   Call control connection used to bridge the assistant into the meeting audio.
+        #
+        #   @return [String]
+        required :call_control_connection_id, String
+
+        # @!attribute from
+        #   E.164 calling number used as the originating party for the assistant call leg.
+        #
+        #   @return [String]
+        required :from, String
+
+        # @!attribute loopback_sip_uri
+        #   SIP URI to which the assistant media loopback is established.
+        #
+        #   @return [String]
+        required :loopback_sip_uri, String
+
+        # @!attribute audio_gate
+        #   Audio gating strategy for the assistant call leg.
+        #
+        #   @return [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate, nil]
+        optional :audio_gate, enum: -> { Telnyx::MeetingSessionCreateParams::Assistant::AudioGate }
+
+        # @!method initialize(id:, call_control_connection_id:, from:, loopback_sip_uri:, audio_gate: nil)
+        #   Request options for attaching a voice assistant to the session. Routing fields
+        #   (`call_control_connection_id`, `from`, and `loopback_sip_uri`) are used only to
+        #   establish the assistant call leg and are omitted from response objects.
+        #   `audio_gate` is returned with `id` in the assistant response object.
+        #
+        #   @param id [String] Identifier of the assistant to attach.
+        #
+        #   @param call_control_connection_id [String] Call control connection used to bridge the assistant into the meeting audio.
+        #
+        #   @param from [String] E.164 calling number used as the originating party for the assistant call leg.
+        #
+        #   @param loopback_sip_uri [String] SIP URI to which the assistant media loopback is established.
+        #
+        #   @param audio_gate [Symbol, Telnyx::Models::MeetingSessionCreateParams::Assistant::AudioGate] Audio gating strategy for the assistant call leg.
+
+        # Audio gating strategy for the assistant call leg.
+        #
+        # @see Telnyx::Models::MeetingSessionCreateParams::Assistant#audio_gate
+        module AudioGate
+          extend Telnyx::Internal::Type::Enum
+
+          NONE = :none
+          HALF_DUPLEX = :half_duplex
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
+      class Avatar < Telnyx::Internal::Type::BaseModel
+        # @!attribute avatar_id
+        #   Identifier of the avatar to use.
+        #
+        #   @return [String]
+        required :avatar_id, String
+
+        # @!attribute provider
+        #   Avatar provider identifier. Currently only "anam" is supported.
+        #
+        #   @return [Symbol, :anam]
+        required :provider, const: :anam
+
+        request_only do
+          # @!attribute api_key
+          #   Bring-your-own-key API key for the avatar provider. The key is never stored or
+          #   returned by the API.
+          #
+          #   @return [String]
+          required :api_key, String
+        end
+
+        # @!method initialize(api_key:, avatar_id:, provider: :anam)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSessionCreateParams::Avatar} for more details.
+        #
+        #   Request options for attaching a bring-your-own-key avatar to the session.
+        #
+        #   @param api_key [String] Bring-your-own-key API key for the avatar provider. The key is never stored or r
+        #
+        #   @param avatar_id [String] Identifier of the avatar to use.
+        #
+        #   @param provider [Symbol, :anam] Avatar provider identifier. Currently only "anam" is supported.
+      end
+
+      # Write-only static camera-tile image for this session, not a native account or
+      # participant profile photo. Supply exactly one JPEG source. When effective, the
+      # image is used as the bot's static camera/video output; presentation varies by
+      # meeting platform and recording configuration and is not guaranteed in
+      # recordings. An effective Avatar or Assistant webpage output takes precedence, so
+      # this input is ignored and a URL source is not fetched.
+      module CameraImage
+        extend Telnyx::Internal::Type::Union
+
+        variant -> { Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source }
+
+        variant -> { Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource }
+
+        class MeetingSessionCameraImageBase64Source < Telnyx::Internal::Type::BaseModel
+          # @!attribute base64_data
+          #   Canonical plain RFC 4648 Base64 for a valid decoded JPEG. Data URIs, whitespace,
+          #   and the URL-safe alphabet are rejected. The encoded value is limited to
+          #   1,835,008 characters and the decoded JPEG to 1,363,148 bytes. The JPEG is
+          #   limited to 4,096 pixels per dimension, 4 megapixels, and 128 MB of decoder
+          #   memory. The image bytes are not persisted, returned, or logged.
+          #
+          #   @return [String]
+          required :base64_data, String
+
+          # @!attribute format_
+          #   Only JPEG images are accepted.
+          #
+          #   @return [Symbol, :jpeg]
+          required :format_, const: :jpeg, api_name: :format
+
+          # @!method initialize(base64_data:, format_: :jpeg)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source}
+          #   for more details.
+          #
+          #   @param base64_data [String] Canonical plain RFC 4648 Base64 for a valid decoded JPEG. Data URIs, whitespace,
+          #
+          #   @param format_ [Symbol, :jpeg] Only JPEG images are accepted.
+        end
+
+        class MeetingSessionCameraImageURLSource < Telnyx::Internal::Type::BaseModel
+          # @!attribute format_
+          #   Only JPEG images are accepted.
+          #
+          #   @return [Symbol, :jpeg]
+          required :format_, const: :jpeg, api_name: :format
+
+          # @!attribute url
+          #   Public HTTPS JPEG URL with at most 2,048 characters and no credentials,
+          #   fragment, surrounding whitespace, raw control characters, or explicit
+          #   non-default port. Signed queries are allowed but must be treated as credentials.
+          #   Fetching is limited to public network destinations, a five-second timeout, no
+          #   redirects, a 2xx image/jpeg response with identity or no content encoding, and a
+          #   1,363,148-byte limit enforced against both declared and streamed content. The
+          #   service resolves the URL before bot creation and does not persist, return, or
+          #   log the URL or image bytes.
+          #
+          #   @return [String]
+          required :url, String
+
+          # @!method initialize(url:, format_: :jpeg)
+          #   Some parameter documentations has been truncated, see
+          #   {Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource}
+          #   for more details.
+          #
+          #   @param url [String] Public HTTPS JPEG URL with at most 2,048 characters and no credentials, fragment
+          #
+          #   @param format_ [Symbol, :jpeg] Only JPEG images are accepted.
+        end
+
+        # @!method self.variants
+        #   @return [Array(Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source, Telnyx::Models::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource)]
+      end
+    end
+  end
+end