telnyx 5.160.0 → 5.161.0

data/lib/telnyx/models/meeting_session_delete_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#delete
+    class MeetingSessionDeleteParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_delete_recording_media_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#delete_recording_media
+    class MeetingSessionDeleteRecordingMediaParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_delete_recording_media_response.rb

@@ -0,0 +1,61 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#delete_recording_media
+    class MeetingSessionDeleteRecordingMediaResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data]
+      required :data, -> { Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data }
+
+      # @!method initialize(data:)
+      #   @param data [Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data]
+
+      # @see Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse#data
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute deletion_status
+        #
+        #   @return [Symbol, Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::DeletionStatus]
+        required :deletion_status,
+                 enum: -> { Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::DeletionStatus }
+
+        # @!attribute meeting_session_id
+        #   The account-scoped Meeting Session identifier.
+        #
+        #   @return [String]
+        required :meeting_session_id, String
+
+        # @!attribute provider
+        #
+        #   @return [Symbol, :recall]
+        required :provider, const: :recall
+
+        # @!attribute scope
+        #
+        #   @return [Symbol, :provider_recording_media]
+        required :scope, const: :provider_recording_media
+
+        # @!method initialize(deletion_status:, meeting_session_id:, provider: :recall, scope: :provider_recording_media)
+        #   @param deletion_status [Symbol, Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data::DeletionStatus]
+        #
+        #   @param meeting_session_id [String] The account-scoped Meeting Session identifier.
+        #
+        #   @param provider [Symbol, :recall]
+        #
+        #   @param scope [Symbol, :provider_recording_media]
+
+        # @see Telnyx::Models::MeetingSessionDeleteRecordingMediaResponse::Data#deletion_status
+        module DeletionStatus
+          extend Telnyx::Internal::Type::Enum
+
+          REQUESTED = :requested
+          ALREADY_IN_PROGRESS = :already_in_progress
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_list_params.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#list
+    class MeetingSessionListParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute status
+      #   Filter meeting sessions by current status.
+      #
+      #   @return [Symbol, Telnyx::Models::MeetingSessionListParams::Status, nil]
+      optional :status, enum: -> { Telnyx::MeetingSessionListParams::Status }
+
+      # @!method initialize(status: nil, request_options: {})
+      #   @param status [Symbol, Telnyx::Models::MeetingSessionListParams::Status] Filter meeting sessions by current status.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+
+      # Filter meeting sessions by current 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_list_response.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#list
+    class MeetingSessionListResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::MeetingSession>]
+      required :data, -> { Telnyx::Internal::Type::ArrayOf[Telnyx::MeetingSession] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<Telnyx::Models::MeetingSession>]
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_response.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#create
+    class MeetingSessionResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #   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.
+      #
+      #   @return [Telnyx::Models::MeetingSession]
+      required :data, -> { Telnyx::MeetingSession }
+
+      # @!method initialize(data:)
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MeetingSessionResponse} for more details.
+      #
+      #   @param data [Telnyx::Models::MeetingSession] Represents a meeting session. All serializer fields are present and required; nu
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_retrieve_events_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#retrieve_events
+    class MeetingSessionRetrieveEventsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute after
+      #   Return results with a cursor position after this value.
+      #
+      #   @return [Integer, nil]
+      optional :after, Integer
+
+      # @!attribute limit
+      #   Maximum number of results to return per page.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!method initialize(id:, after: nil, limit: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param after [Integer] Return results with a cursor position after this value.
+      #
+      #   @param limit [Integer] Maximum number of results to return per page.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_retrieve_events_response.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#retrieve_events
+    class MeetingSessionRetrieveEventsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::MeetingSessionRetrieveEventsResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::MeetingSessionRetrieveEventsResponse::Data] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<Telnyx::Models::MeetingSessionRetrieveEventsResponse::Data>]
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute occurred_at
+        #
+        #   @return [Time]
+        required :occurred_at, Time
+
+        # @!attribute payload
+        #
+        #   @return [Hash{Symbol=>Object}]
+        required :payload, Telnyx::Internal::Type::HashOf[Telnyx::Internal::Type::Unknown]
+
+        # @!attribute seq
+        #
+        #   @return [Integer]
+        required :seq, Integer
+
+        # @!attribute type
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!method initialize(occurred_at:, payload:, seq:, type:)
+        #   @param occurred_at [Time]
+        #   @param payload [Hash{Symbol=>Object}]
+        #   @param seq [Integer]
+        #   @param type [String]
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_retrieve_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#retrieve
+    class MeetingSessionRetrieveParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_retrieve_recordings_params.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#retrieve_recordings
+    class MeetingSessionRetrieveRecordingsParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!method initialize(id:, request_options: {})
+      #   @param id [String]
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_retrieve_recordings_response.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#retrieve_recordings
+    class MeetingSessionRetrieveRecordingsResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::MeetingSessionRetrieveRecordingsResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::MeetingSessionRetrieveRecordingsResponse::Data] }
+
+      # @!method initialize(data:)
+      #   @param data [Array<Telnyx::Models::MeetingSessionRetrieveRecordingsResponse::Data>]
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute expires_at
+        #   Expiry timestamp when supplied by the provider, or null. The current adapter
+        #   returns null.
+        #
+        #   @return [String, nil]
+        required :expires_at, String, nil?: true
+
+        # @!attribute type
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!attribute url
+        #   Current provider download URL. The API does not guarantee URL lifetime or
+        #   refresh behavior.
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!method initialize(expires_at:, type:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSessionRetrieveRecordingsResponse::Data} for more
+        #   details.
+        #
+        #   @param expires_at [String, nil] Expiry timestamp when supplied by the provider, or null. The current adapter ret
+        #
+        #   @param type [String]
+        #
+        #   @param url [String] Current provider download URL. The API does not guarantee URL lifetime or refres
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_retrieve_transcript_params.rb

@@ -0,0 +1,50 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#retrieve_transcript
+    class MeetingSessionRetrieveTranscriptParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute after
+      #   Return results with a cursor position after this value.
+      #
+      #   @return [Integer, nil]
+      optional :after, Integer
+
+      # @!attribute limit
+      #   Maximum number of results to return per page.
+      #
+      #   @return [Integer, nil]
+      optional :limit, Integer
+
+      # @!attribute wait_seconds
+      #   Long-poll duration in seconds. The server holds the connection open for up to
+      #   this many seconds, waiting for new or updated results before returning an empty
+      #   response. Set to 0 for an immediate response.
+      #
+      #   @return [Integer, nil]
+      optional :wait_seconds, Integer
+
+      # @!method initialize(id:, after: nil, limit: nil, wait_seconds: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Telnyx::Models::MeetingSessionRetrieveTranscriptParams} for more details.
+      #
+      #   @param id [String]
+      #
+      #   @param after [Integer] Return results with a cursor position after this value.
+      #
+      #   @param limit [Integer] Maximum number of results to return per page.
+      #
+      #   @param wait_seconds [Integer] Long-poll duration in seconds. The server holds the connection open for up to th
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_retrieve_transcript_response.rb

@@ -0,0 +1,80 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#retrieve_transcript
+    class MeetingSessionRetrieveTranscriptResponse < Telnyx::Internal::Type::BaseModel
+      # @!attribute data
+      #
+      #   @return [Array<Telnyx::Models::MeetingSessionRetrieveTranscriptResponse::Data>]
+      required :data,
+               -> { Telnyx::Internal::Type::ArrayOf[Telnyx::Models::MeetingSessionRetrieveTranscriptResponse::Data] }
+
+      # @!attribute meta
+      #
+      #   @return [Telnyx::Models::MeetingSessionRetrieveTranscriptResponse::Meta]
+      required :meta, -> { Telnyx::Models::MeetingSessionRetrieveTranscriptResponse::Meta }
+
+      # @!method initialize(data:, meta:)
+      #   @param data [Array<Telnyx::Models::MeetingSessionRetrieveTranscriptResponse::Data>]
+      #   @param meta [Telnyx::Models::MeetingSessionRetrieveTranscriptResponse::Meta]
+
+      class Data < Telnyx::Internal::Type::BaseModel
+        # @!attribute confidence
+        #
+        #   @return [Float, nil]
+        required :confidence, Float, nil?: true
+
+        # @!attribute occurred_at
+        #
+        #   @return [Time]
+        required :occurred_at, Time
+
+        # @!attribute relative_ts
+        #
+        #   @return [Float, nil]
+        required :relative_ts, Float, nil?: true
+
+        # @!attribute seq
+        #
+        #   @return [Integer]
+        required :seq, Integer
+
+        # @!attribute speaker_label
+        #
+        #   @return [String, nil]
+        required :speaker_label, String, nil?: true
+
+        # @!attribute text
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!method initialize(confidence:, occurred_at:, relative_ts:, seq:, speaker_label:, text:)
+        #   @param confidence [Float, nil]
+        #   @param occurred_at [Time]
+        #   @param relative_ts [Float, nil]
+        #   @param seq [Integer]
+        #   @param speaker_label [String, nil]
+        #   @param text [String]
+      end
+
+      # @see Telnyx::Models::MeetingSessionRetrieveTranscriptResponse#meta
+      class Meta < Telnyx::Internal::Type::BaseModel
+        # @!attribute next_after
+        #   Cursor to pass as `after` on the next request, or null when the response
+        #   contains no segments.
+        #
+        #   @return [Integer, nil]
+        required :next_after, Integer, nil?: true
+
+        # @!method initialize(next_after:)
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSessionRetrieveTranscriptResponse::Meta} for more
+        #   details.
+        #
+        #   @param next_after [Integer, nil] Cursor to pass as `after` on the next request, or null when the response contain
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_session_update_params.rb

@@ -0,0 +1,37 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    # @see Telnyx::Resources::MeetingSessions#update
+    class MeetingSessionUpdateParams < Telnyx::Internal::Type::BaseModel
+      extend Telnyx::Internal::Type::RequestParameters::Converter
+      include Telnyx::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute bot_name
+      #   Updated display name for the bot.
+      #
+      #   @return [String, nil]
+      optional :bot_name, String
+
+      # @!attribute join_at
+      #   ISO-8601 timestamp for the bot to join. May be updated to reschedule.
+      #
+      #   @return [Time, nil]
+      optional :join_at, Time
+
+      # @!method initialize(id:, bot_name: nil, join_at: nil, request_options: {})
+      #   @param id [String]
+      #
+      #   @param bot_name [String] Updated display name for the bot.
+      #
+      #   @param join_at [Time] ISO-8601 timestamp for the bot to join. May be updated to reschedule.
+      #
+      #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/telnyx/models/meeting_sessions/action_accepted_response.rb

@@ -0,0 +1,29 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module MeetingSessions
+      # @see Telnyx::Resources::MeetingSessions::Actions#send_chat
+      class ActionAcceptedResponse < Telnyx::Internal::Type::BaseModel
+        # @!attribute data
+        #
+        #   @return [Telnyx::Models::MeetingSessions::ActionAcceptedResponse::Data]
+        required :data, -> { Telnyx::MeetingSessions::ActionAcceptedResponse::Data }
+
+        # @!method initialize(data:)
+        #   @param data [Telnyx::Models::MeetingSessions::ActionAcceptedResponse::Data]
+
+        # @see Telnyx::Models::MeetingSessions::ActionAcceptedResponse#data
+        class Data < Telnyx::Internal::Type::BaseModel
+          # @!attribute accepted
+          #
+          #   @return [Boolean, true]
+          required :accepted, const: true
+
+          # @!method initialize(accepted: true)
+          #   @param accepted [Boolean, true]
+        end
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_sessions/action_send_chat_params.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module MeetingSessions
+      # @see Telnyx::Resources::MeetingSessions::Actions#send_chat
+      class ActionSendChatParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute text
+        #   Chat message text to send in the meeting.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!method initialize(id:, text:, request_options: {})
+        #   @param id [String]
+        #
+        #   @param text [String] Chat message text to send in the meeting.
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_sessions/action_speak_params.rb

@@ -0,0 +1,52 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module MeetingSessions
+      # @see Telnyx::Resources::MeetingSessions::Actions#speak
+      class ActionSpeakParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute text
+        #   Text for the bot to speak.
+        #
+        #   @return [String]
+        required :text, String
+
+        # @!attribute interrupt
+        #   If true, interrupt any currently playing audio to speak this text immediately.
+        #
+        #   @return [Boolean, nil]
+        optional :interrupt, Telnyx::Internal::Type::Boolean
+
+        # @!attribute voice
+        #   Voice identifier to use for this utterance. When supplied, it overrides the
+        #   session-default voice configured at creation; otherwise the speak action uses
+        #   that session default.
+        #
+        #   @return [String, nil]
+        optional :voice, String
+
+        # @!method initialize(id:, text:, interrupt: nil, voice: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Telnyx::Models::MeetingSessions::ActionSpeakParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param text [String] Text for the bot to speak.
+        #
+        #   @param interrupt [Boolean] If true, interrupt any currently playing audio to speak this text immediately.
+        #
+        #   @param voice [String] Voice identifier to use for this utterance. When supplied, it overrides the sess
+        #
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/telnyx/models/meeting_sessions/action_stop_speaking_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Telnyx
+  module Models
+    module MeetingSessions
+      # @see Telnyx::Resources::MeetingSessions::Actions#stop_speaking
+      class ActionStopSpeakingParams < Telnyx::Internal::Type::BaseModel
+        extend Telnyx::Internal::Type::RequestParameters::Converter
+        include Telnyx::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!method initialize(id:, request_options: {})
+        #   @param id [String]
+        #   @param request_options [Telnyx::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end