telnyx 5.160.0 → 5.161.0

data/sig/telnyx/models/meeting_session.rbs

@@ -0,0 +1,277 @@
+module Telnyx
+  module Models
+    type meeting_session =
+      {
+        id: String,
+        account_id: String,
+        assistant: Telnyx::MeetingSession::Assistant?,
+        assistant_state: Telnyx::Models::MeetingSession::assistant_state?,
+        assistant_state_changed_at: Time?,
+        avatar: Telnyx::MeetingSession::Avatar?,
+        avatar_state: Telnyx::Models::MeetingSession::avatar_state?,
+        avatar_state_changed_at: Time?,
+        bot_name: String,
+        config: Telnyx::MeetingSession::Config,
+        created_at: Time,
+        ended_at: Time?,
+        failure_reason: String?,
+        join_at: Time?,
+        joined_at: Time?,
+        meeting_url: String,
+        metadata: ::Hash[Symbol, top],
+        platform: Telnyx::Models::MeetingSession::platform,
+        provider: String,
+        recording: bool,
+        status: Telnyx::Models::MeetingSession::status,
+        status_detail: String?,
+        updated_at: Time,
+        webhook_url: String?
+      }
+
+    class MeetingSession < Telnyx::Internal::Type::BaseModel
+      attr_accessor id: String
+
+      attr_accessor account_id: String
+
+      attr_accessor assistant: Telnyx::MeetingSession::Assistant?
+
+      attr_accessor assistant_state: Telnyx::Models::MeetingSession::assistant_state?
+
+      attr_accessor assistant_state_changed_at: Time?
+
+      attr_accessor avatar: Telnyx::MeetingSession::Avatar?
+
+      attr_accessor avatar_state: Telnyx::Models::MeetingSession::avatar_state?
+
+      attr_accessor avatar_state_changed_at: Time?
+
+      attr_accessor bot_name: String
+
+      attr_accessor config: Telnyx::MeetingSession::Config
+
+      attr_accessor created_at: Time
+
+      attr_accessor ended_at: Time?
+
+      attr_accessor failure_reason: String?
+
+      attr_accessor join_at: Time?
+
+      attr_accessor joined_at: Time?
+
+      attr_accessor meeting_url: String
+
+      attr_accessor metadata: ::Hash[Symbol, top]
+
+      attr_accessor platform: Telnyx::Models::MeetingSession::platform
+
+      attr_accessor provider: String
+
+      attr_accessor recording: bool
+
+      attr_accessor status: Telnyx::Models::MeetingSession::status
+
+      attr_accessor status_detail: String?
+
+      attr_accessor updated_at: Time
+
+      attr_accessor webhook_url: String?
+
+      def initialize: (
+        id: String,
+        account_id: String,
+        assistant: Telnyx::MeetingSession::Assistant?,
+        assistant_state: Telnyx::Models::MeetingSession::assistant_state?,
+        assistant_state_changed_at: Time?,
+        avatar: Telnyx::MeetingSession::Avatar?,
+        avatar_state: Telnyx::Models::MeetingSession::avatar_state?,
+        avatar_state_changed_at: Time?,
+        bot_name: String,
+        config: Telnyx::MeetingSession::Config,
+        created_at: Time,
+        ended_at: Time?,
+        failure_reason: String?,
+        join_at: Time?,
+        joined_at: Time?,
+        meeting_url: String,
+        metadata: ::Hash[Symbol, top],
+        platform: Telnyx::Models::MeetingSession::platform,
+        provider: String,
+        recording: bool,
+        status: Telnyx::Models::MeetingSession::status,
+        status_detail: String?,
+        updated_at: Time,
+        webhook_url: String?
+      ) -> void
+
+      def to_hash: -> {
+        id: String,
+        account_id: String,
+        assistant: Telnyx::MeetingSession::Assistant?,
+        assistant_state: Telnyx::Models::MeetingSession::assistant_state?,
+        assistant_state_changed_at: Time?,
+        avatar: Telnyx::MeetingSession::Avatar?,
+        avatar_state: Telnyx::Models::MeetingSession::avatar_state?,
+        avatar_state_changed_at: Time?,
+        bot_name: String,
+        config: Telnyx::MeetingSession::Config,
+        created_at: Time,
+        ended_at: Time?,
+        failure_reason: String?,
+        join_at: Time?,
+        joined_at: Time?,
+        meeting_url: String,
+        metadata: ::Hash[Symbol, top],
+        platform: Telnyx::Models::MeetingSession::platform,
+        provider: String,
+        recording: bool,
+        status: Telnyx::Models::MeetingSession::status,
+        status_detail: String?,
+        updated_at: Time,
+        webhook_url: String?
+      }
+
+      type assistant =
+        {
+          id: String,
+          audio_gate: Telnyx::Models::MeetingSession::Assistant::audio_gate
+        }
+
+      class Assistant < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor audio_gate: Telnyx::Models::MeetingSession::Assistant::audio_gate
+
+        def initialize: (
+          id: String,
+          audio_gate: Telnyx::Models::MeetingSession::Assistant::audio_gate
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          audio_gate: Telnyx::Models::MeetingSession::Assistant::audio_gate
+        }
+
+        type audio_gate = :none | :half_duplex
+
+        module AudioGate
+          extend Telnyx::Internal::Type::Enum
+
+          NONE: :none
+          HALF_DUPLEX: :half_duplex
+
+          def self?.values: -> ::Array[Telnyx::Models::MeetingSession::Assistant::audio_gate]
+        end
+      end
+
+      type assistant_state = :starting | :connected | :failed | :ended
+
+      module AssistantState
+        extend Telnyx::Internal::Type::Enum
+
+        STARTING: :starting
+        CONNECTED: :connected
+        FAILED: :failed
+        ENDED: :ended
+
+        def self?.values: -> ::Array[Telnyx::Models::MeetingSession::assistant_state]
+      end
+
+      type avatar = { avatar_id: String, provider: :anam }
+
+      class Avatar < Telnyx::Internal::Type::BaseModel
+        attr_accessor avatar_id: String
+
+        attr_accessor provider: :anam
+
+        def initialize: (avatar_id: String, ?provider: :anam) -> void
+
+        def to_hash: -> { avatar_id: String, provider: :anam }
+      end
+
+      type avatar_state = :starting | :connected | :degraded | :disconnected
+
+      module AvatarState
+        extend Telnyx::Internal::Type::Enum
+
+        STARTING: :starting
+        CONNECTED: :connected
+        DEGRADED: :degraded
+        DISCONNECTED: :disconnected
+
+        def self?.values: -> ::Array[Telnyx::Models::MeetingSession::avatar_state]
+      end
+
+      type config =
+        {
+          barge_in: bool,
+          speak_on_enter: String?,
+          summarize_on_end: bool,
+          voice: String?
+        }
+
+      class Config < Telnyx::Internal::Type::BaseModel
+        attr_accessor barge_in: bool
+
+        attr_accessor speak_on_enter: String?
+
+        attr_accessor summarize_on_end: bool
+
+        attr_accessor voice: String?
+
+        def initialize: (
+          barge_in: bool,
+          speak_on_enter: String?,
+          summarize_on_end: bool,
+          voice: String?
+        ) -> void
+
+        def to_hash: -> {
+          barge_in: bool,
+          speak_on_enter: String?,
+          summarize_on_end: bool,
+          voice: String?
+        }
+      end
+
+      type platform = :zoom | :google_meet | :teams | :webex | :unknown
+
+      module Platform
+        extend Telnyx::Internal::Type::Enum
+
+        ZOOM: :zoom
+        GOOGLE_MEET: :google_meet
+        TEAMS: :teams
+        WEBEX: :webex
+        UNKNOWN: :unknown
+
+        def self?.values: -> ::Array[Telnyx::Models::MeetingSession::platform]
+      end
+
+      type status =
+        :scheduled
+        | :joining
+        | :waiting_for_admission
+        | :active
+        | :leaving
+        | :ended
+        | :failed
+        | :admission_denied
+
+      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
+
+        def self?.values: -> ::Array[Telnyx::Models::MeetingSession::status]
+      end
+    end
+  end
+end

data/sig/telnyx/models/meeting_session_create_params.rbs

@@ -0,0 +1,222 @@
+module Telnyx
+  module Models
+    type meeting_session_create_params =
+      {
+        meeting_url: String,
+        assistant: Telnyx::MeetingSessionCreateParams::Assistant,
+        avatar: Telnyx::MeetingSessionCreateParams::Avatar,
+        barge_in: bool,
+        bot_name: String,
+        camera_image: Telnyx::Models::MeetingSessionCreateParams::camera_image,
+        idempotency_key: String,
+        join_at: Time,
+        metadata: ::Hash[Symbol, top],
+        speak_on_enter: String,
+        summarize_on_end: bool,
+        voice: String,
+        webhook_url: String
+      }
+      & Telnyx::Internal::Type::request_parameters
+
+    class MeetingSessionCreateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor meeting_url: String
+
+      attr_reader assistant: Telnyx::MeetingSessionCreateParams::Assistant?
+
+      def assistant=: (
+        Telnyx::MeetingSessionCreateParams::Assistant
+      ) -> Telnyx::MeetingSessionCreateParams::Assistant
+
+      attr_reader avatar: Telnyx::MeetingSessionCreateParams::Avatar?
+
+      def avatar=: (
+        Telnyx::MeetingSessionCreateParams::Avatar
+      ) -> Telnyx::MeetingSessionCreateParams::Avatar
+
+      attr_reader barge_in: bool?
+
+      def barge_in=: (bool) -> bool
+
+      attr_reader bot_name: String?
+
+      def bot_name=: (String) -> String
+
+      attr_reader camera_image: Telnyx::Models::MeetingSessionCreateParams::camera_image?
+
+      def camera_image=: (
+        Telnyx::Models::MeetingSessionCreateParams::camera_image
+      ) -> Telnyx::Models::MeetingSessionCreateParams::camera_image
+
+      attr_reader idempotency_key: String?
+
+      def idempotency_key=: (String) -> String
+
+      attr_reader join_at: Time?
+
+      def join_at=: (Time) -> Time
+
+      attr_reader metadata: ::Hash[Symbol, top]?
+
+      def metadata=: (::Hash[Symbol, top]) -> ::Hash[Symbol, top]
+
+      attr_reader speak_on_enter: String?
+
+      def speak_on_enter=: (String) -> String
+
+      attr_reader summarize_on_end: bool?
+
+      def summarize_on_end=: (bool) -> bool
+
+      attr_reader voice: String?
+
+      def voice=: (String) -> String
+
+      attr_reader webhook_url: String?
+
+      def webhook_url=: (String) -> String
+
+      def initialize: (
+        meeting_url: String,
+        ?assistant: Telnyx::MeetingSessionCreateParams::Assistant,
+        ?avatar: Telnyx::MeetingSessionCreateParams::Avatar,
+        ?barge_in: bool,
+        ?bot_name: String,
+        ?camera_image: Telnyx::Models::MeetingSessionCreateParams::camera_image,
+        ?idempotency_key: String,
+        ?join_at: Time,
+        ?metadata: ::Hash[Symbol, top],
+        ?speak_on_enter: String,
+        ?summarize_on_end: bool,
+        ?voice: String,
+        ?webhook_url: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        meeting_url: String,
+        assistant: Telnyx::MeetingSessionCreateParams::Assistant,
+        avatar: Telnyx::MeetingSessionCreateParams::Avatar,
+        barge_in: bool,
+        bot_name: String,
+        camera_image: Telnyx::Models::MeetingSessionCreateParams::camera_image,
+        idempotency_key: String,
+        join_at: Time,
+        metadata: ::Hash[Symbol, top],
+        speak_on_enter: String,
+        summarize_on_end: bool,
+        voice: String,
+        webhook_url: String,
+        request_options: Telnyx::RequestOptions
+      }
+
+      type assistant =
+        {
+          id: String,
+          call_control_connection_id: String,
+          from: String,
+          loopback_sip_uri: String,
+          audio_gate: Telnyx::Models::MeetingSessionCreateParams::Assistant::audio_gate
+        }
+
+      class Assistant < Telnyx::Internal::Type::BaseModel
+        attr_accessor id: String
+
+        attr_accessor call_control_connection_id: String
+
+        attr_accessor from: String
+
+        attr_accessor loopback_sip_uri: String
+
+        attr_reader audio_gate: Telnyx::Models::MeetingSessionCreateParams::Assistant::audio_gate?
+
+        def audio_gate=: (
+          Telnyx::Models::MeetingSessionCreateParams::Assistant::audio_gate
+        ) -> Telnyx::Models::MeetingSessionCreateParams::Assistant::audio_gate
+
+        def initialize: (
+          id: String,
+          call_control_connection_id: String,
+          from: String,
+          loopback_sip_uri: String,
+          ?audio_gate: Telnyx::Models::MeetingSessionCreateParams::Assistant::audio_gate
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          call_control_connection_id: String,
+          from: String,
+          loopback_sip_uri: String,
+          audio_gate: Telnyx::Models::MeetingSessionCreateParams::Assistant::audio_gate
+        }
+
+        type audio_gate = :none | :half_duplex
+
+        module AudioGate
+          extend Telnyx::Internal::Type::Enum
+
+          NONE: :none
+          HALF_DUPLEX: :half_duplex
+
+          def self?.values: -> ::Array[Telnyx::Models::MeetingSessionCreateParams::Assistant::audio_gate]
+        end
+      end
+
+      type avatar = { api_key: String, avatar_id: String, provider: :anam }
+
+      class Avatar < Telnyx::Internal::Type::BaseModel
+        attr_accessor avatar_id: String
+
+        attr_accessor provider: :anam
+
+        attr_accessor api_key: String
+
+        def initialize: (
+          api_key: String,
+          avatar_id: String,
+          ?provider: :anam
+        ) -> void
+
+        def to_hash: -> { api_key: String, avatar_id: String, provider: :anam }
+      end
+
+      type camera_image =
+        Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageBase64Source
+        | Telnyx::MeetingSessionCreateParams::CameraImage::MeetingSessionCameraImageURLSource
+
+      module CameraImage
+        extend Telnyx::Internal::Type::Union
+
+        type meeting_session_camera_image_base64_source =
+          { :base64_data => String, format_: :jpeg }
+
+        class MeetingSessionCameraImageBase64Source < Telnyx::Internal::Type::BaseModel
+          attr_accessor base64_data: String
+
+          attr_accessor format_: :jpeg
+
+          def initialize: (base64_data: String, ?format_: :jpeg) -> void
+
+          def to_hash: -> { :base64_data => String, format_: :jpeg }
+        end
+
+        type meeting_session_camera_image_url_source =
+          { format_: :jpeg, url: String }
+
+        class MeetingSessionCameraImageURLSource < Telnyx::Internal::Type::BaseModel
+          attr_accessor format_: :jpeg
+
+          attr_accessor url: String
+
+          def initialize: (url: String, ?format_: :jpeg) -> void
+
+          def to_hash: -> { format_: :jpeg, url: String }
+        end
+
+        def self?.variants: -> ::Array[Telnyx::Models::MeetingSessionCreateParams::camera_image]
+      end
+    end
+  end
+end

data/sig/telnyx/models/meeting_session_delete_params.rbs

@@ -0,0 +1,20 @@
+module Telnyx
+  module Models
+    type meeting_session_delete_params =
+      { id: String } & Telnyx::Internal::Type::request_parameters
+
+    class MeetingSessionDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Telnyx::RequestOptions }
+    end
+  end
+end

data/sig/telnyx/models/meeting_session_delete_recording_media_params.rbs

@@ -0,0 +1,20 @@
+module Telnyx
+  module Models
+    type meeting_session_delete_recording_media_params =
+      { id: String } & Telnyx::Internal::Type::request_parameters
+
+    class MeetingSessionDeleteRecordingMediaParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_accessor id: String
+
+      def initialize: (
+        id: String,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> { id: String, request_options: Telnyx::RequestOptions }
+    end
+  end
+end

data/sig/telnyx/models/meeting_session_delete_recording_media_response.rbs

@@ -0,0 +1,61 @@
+module Telnyx
+  module Models
+    type meeting_session_delete_recording_media_response =
+      { data: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data }
+
+    class MeetingSessionDeleteRecordingMediaResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data
+
+      def initialize: (
+        data: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data
+      ) -> void
+
+      def to_hash: -> {
+        data: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data
+      }
+
+      type data =
+        {
+          deletion_status: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::deletion_status,
+          meeting_session_id: String,
+          provider: :recall,
+          scope: :provider_recording_media
+        }
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        attr_accessor deletion_status: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::deletion_status
+
+        attr_accessor meeting_session_id: String
+
+        attr_accessor provider: :recall
+
+        attr_accessor scope: :provider_recording_media
+
+        def initialize: (
+          deletion_status: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::deletion_status,
+          meeting_session_id: String,
+          ?provider: :recall,
+          ?scope: :provider_recording_media
+        ) -> void
+
+        def to_hash: -> {
+          deletion_status: Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::deletion_status,
+          meeting_session_id: String,
+          provider: :recall,
+          scope: :provider_recording_media
+        }
+
+        type deletion_status = :requested | :already_in_progress
+
+        module DeletionStatus
+          extend Telnyx::Internal::Type::Enum
+
+          REQUESTED: :requested
+          ALREADY_IN_PROGRESS: :already_in_progress
+
+          def self?.values: -> ::Array[Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::deletion_status]
+        end
+      end
+    end
+  end
+end

data/sig/telnyx/models/meeting_session_list_params.rbs

@@ -0,0 +1,53 @@
+module Telnyx
+  module Models
+    type meeting_session_list_params =
+      { status: Telnyx::Models::MeetingSessionListParams::status }
+      & Telnyx::Internal::Type::request_parameters
+
+    class MeetingSessionListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      attr_reader status: Telnyx::Models::MeetingSessionListParams::status?
+
+      def status=: (
+        Telnyx::Models::MeetingSessionListParams::status
+      ) -> Telnyx::Models::MeetingSessionListParams::status
+
+      def initialize: (
+        ?status: Telnyx::Models::MeetingSessionListParams::status,
+        ?request_options: Telnyx::request_opts
+      ) -> void
+
+      def to_hash: -> {
+        status: Telnyx::Models::MeetingSessionListParams::status,
+        request_options: Telnyx::RequestOptions
+      }
+
+      type status =
+        :scheduled
+        | :joining
+        | :waiting_for_admission
+        | :active
+        | :leaving
+        | :ended
+        | :failed
+        | :admission_denied
+
+      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
+
+        def self?.values: -> ::Array[Telnyx::Models::MeetingSessionListParams::status]
+      end
+    end
+  end
+end

data/sig/telnyx/models/meeting_session_list_response.rbs

@@ -0,0 +1,14 @@
+module Telnyx
+  module Models
+    type meeting_session_list_response =
+      { data: ::Array[Telnyx::MeetingSession] }
+
+    class MeetingSessionListResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: ::Array[Telnyx::MeetingSession]
+
+      def initialize: (data: ::Array[Telnyx::MeetingSession]) -> void
+
+      def to_hash: -> { data: ::Array[Telnyx::MeetingSession] }
+    end
+  end
+end

data/sig/telnyx/models/meeting_session_response.rbs

@@ -0,0 +1,13 @@
+module Telnyx
+  module Models
+    type meeting_session_response = { data: Telnyx::MeetingSession }
+
+    class MeetingSessionResponse < Telnyx::Internal::Type::BaseModel
+      attr_accessor data: Telnyx::MeetingSession
+
+      def initialize: (data: Telnyx::MeetingSession) -> void
+
+      def to_hash: -> { data: Telnyx::MeetingSession }
+    end
+  end
+end