sentdm 0.38.1 → 0.40.0

data/lib/sentdm/models/voice/call_timeline_entry.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallTimelineEntry < Sentdm::Internal::Type::BaseModel
+        # @!attribute status
+        #   INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute timestamp
+        #   When the call entered this status (UTC)
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!method initialize(status: nil, timestamp: nil)
+        #   When a call entered a status
+        #
+        #   @param status [String] INITIATED, RINGING, ANSWERED, COMPLETED, FAILED, NO_ANSWER or REJECTED
+        #
+        #   @param timestamp [Time] When the call entered this status (UTC)
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/api_response_of_list_of_call_participant.rb

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#list
+        class APIResponseOfListOfCallParticipant < Sentdm::Internal::Type::BaseModel
+          # @!attribute data
+          #   The response data (null if error)
+          #
+          #   @return [Array<Sentdm::Models::Voice::Calls::CallParticipant>, nil]
+          optional :data,
+                   -> {
+                     Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::Calls::CallParticipant]
+                   },
+                   nil?: true
+
+          # @!attribute error
+          #   Error information
+          #
+          #   @return [Sentdm::Models::ErrorDetail, nil]
+          optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+          # @!attribute meta
+          #   Request and response metadata
+          #
+          #   @return [Sentdm::Models::APIMeta, nil]
+          optional :meta, -> { Sentdm::APIMeta }
+
+          # @!attribute success
+          #   Indicates whether the request was successful
+          #
+          #   @return [Boolean, nil]
+          optional :success, Sentdm::Internal::Type::Boolean
+
+          # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+          #   Standard API response envelope for all v3 endpoints
+          #
+          #   @param data [Array<Sentdm::Models::Voice::Calls::CallParticipant>, nil] The response data (null if error)
+          #
+          #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+          #
+          #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+          #
+          #   @param success [Boolean] Indicates whether the request was successful
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/call_participant.rb

@@ -0,0 +1,62 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        class CallParticipant < Sentdm::Internal::Type::BaseModel
+          # @!attribute id
+          #   The participant's own call id: what the mute and remove endpoints take, and what
+          #   GET /v3/voice/calls/{id} accepts
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute duration_seconds
+          #   How long the participant has been connected to the room, in seconds
+          #
+          #   @return [Integer, nil]
+          optional :duration_seconds, Integer
+
+          # @!attribute kind
+          #   user for one of your app users, number for a phone number, anonymous for a
+          #   caller who withheld their number
+          #
+          #   @return [String, nil]
+          optional :kind, String
+
+          # @!attribute muted
+          #   True while the room mutes this participant
+          #
+          #   @return [Boolean, nil]
+          optional :muted, Sentdm::Internal::Type::Boolean
+
+          # @!attribute value
+          #   The app user's identity or the phone number in E.164 format. Null when the kind
+          #   is anonymous
+          #
+          #   @return [String, nil]
+          optional :value, String, nil?: true
+
+          # @!method initialize(id: nil, duration_seconds: nil, kind: nil, muted: nil, value: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Voice::Calls::CallParticipant} for more details.
+          #
+          #   A participant of a conference call
+          #
+          #   @param id [String] The participant's own call id: what the mute and remove endpoints take, and what
+          #
+          #   @param duration_seconds [Integer] How long the participant has been connected to the room, in seconds
+          #
+          #   @param kind [String] user for one of your app users, number for a phone number, anonymous for a calle
+          #
+          #   @param muted [Boolean] True while the room mutes this participant
+          #
+          #   @param value [String, nil] The app user's identity or the phone number in E.164 format. Null when the kind
+        end
+      end
+
+      CallParticipant = Calls::CallParticipant
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/call_participant_target.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        class CallParticipantTarget < Sentdm::Internal::Type::BaseModel
+          # @!attribute kind
+          #   user for one of your app users, number for a phone number
+          #
+          #   @return [String, nil]
+          optional :kind, String
+
+          # @!attribute value
+          #   The app user's identity, or the phone number in E.164 format
+          #
+          #   @return [String, nil]
+          optional :value, String
+
+          # @!method initialize(kind: nil, value: nil)
+          #   A participant to add to a call
+          #
+          #   @param kind [String] user for one of your app users, number for a phone number
+          #
+          #   @param value [String] The app user's identity, or the phone number in E.164 format
+        end
+      end
+
+      CallParticipantTarget = Calls::CallParticipantTarget
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_add_params.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#add
+        class ParticipantAddParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute caller_id
+          #   The number shown to a phone participant as the caller, in E.164 format. Must be
+          #   one of your numbers. The call's owning number when omitted
+          #
+          #   @return [String, nil]
+          optional :caller_id, String, nil?: true
+
+          # @!attribute sandbox
+          #   Sandbox flag - when true, the operation is simulated without side effects Useful
+          #   for testing integrations without actual execution
+          #
+          #   @return [Boolean, nil]
+          optional :sandbox, Sentdm::Internal::Type::Boolean
+
+          # @!attribute to
+          #   A participant to add to a call
+          #
+          #   @return [Sentdm::Models::Voice::Calls::CallParticipantTarget, nil]
+          optional :to, -> { Sentdm::Voice::Calls::CallParticipantTarget }
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, caller_id: nil, sandbox: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Voice::Calls::ParticipantAddParams} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param caller_id [String, nil] The number shown to a phone participant as the caller, in E.164 format. Must be
+          #
+          #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+          #
+          #   @param to [Sentdm::Models::Voice::Calls::CallParticipantTarget] A participant to add to a call
+          #
+          #   @param idempotency_key [String]
+          #
+          #   @param x_profile_id [String]
+          #
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_list_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#list
+        class ParticipantListParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, x_profile_id: nil, request_options: {})
+          #   @param id [String]
+          #   @param x_profile_id [String]
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_remove_all_params.rb

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#remove_all
+        class ParticipantRemoveAllParams < Sentdm::Models::MutationRequest
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, x_profile_id: nil, request_options: {})
+          #   @param id [String]
+          #   @param x_profile_id [String]
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_remove_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#remove
+        class ParticipantRemoveParams < Sentdm::Models::MutationRequest
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute participant_id
+          #
+          #   @return [String]
+          required :participant_id, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, participant_id:, x_profile_id: nil, request_options: {})
+          #   @param id [String]
+          #   @param participant_id [String]
+          #   @param x_profile_id [String]
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls/participant_update_params.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        # @see Sentdm::Resources::Voice::Calls::Participants#update
+        class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          # @!attribute id
+          #
+          #   @return [String]
+          required :id, String
+
+          # @!attribute participant_id
+          #
+          #   @return [String]
+          required :participant_id, String
+
+          # @!attribute muted
+          #   true to mute the participant, false to unmute them
+          #
+          #   @return [Boolean, nil]
+          optional :muted, Sentdm::Internal::Type::Boolean
+
+          # @!attribute sandbox
+          #   Sandbox flag - when true, the operation is simulated without side effects Useful
+          #   for testing integrations without actual execution
+          #
+          #   @return [Boolean, nil]
+          optional :sandbox, Sentdm::Internal::Type::Boolean
+
+          # @!attribute idempotency_key
+          #
+          #   @return [String, nil]
+          optional :idempotency_key, String
+
+          # @!attribute x_profile_id
+          #
+          #   @return [String, nil]
+          optional :x_profile_id, String
+
+          # @!method initialize(id:, participant_id:, muted: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::Voice::Calls::ParticipantUpdateParams} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param participant_id [String]
+          #
+          #   @param muted [Boolean] true to mute the participant, false to unmute them
+          #
+          #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+          #
+          #   @param idempotency_key [String]
+          #
+          #   @param x_profile_id [String]
+          #
+          #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/calls_list.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class CallsList < Sentdm::Internal::Type::BaseModel
+        # @!attribute calls
+        #   The calls on this page, most recent first
+        #
+        #   @return [Array<Sentdm::Models::Voice::Call>, nil]
+        optional :calls, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::Call] }
+
+        # @!attribute pagination
+        #   Pagination metadata for list responses
+        #
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
+
+        # @!method initialize(calls: nil, pagination: nil)
+        #   Paginated list of calls
+        #
+        #   @param calls [Array<Sentdm::Models::Voice::Call>] The calls on this page, most recent first
+        #
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+      end
+    end
+  end
+end

data/lib/sentdm/models/voice/catalogue_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Catalogue#list
+      class CatalogueListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(x_profile_id: nil, request_options: {})
+        #   @param x_profile_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/{channels/voice_create_token_params.rb → voice/token_create_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Channels
-      # @see Sentdm::Resources::Channels::Voice#create_token
-      class VoiceCreateTokenParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      # @see Sentdm::Resources::Voice::Tokens#create
+      class TokenCreateParams < Sentdm::Internal::Type::BaseModel
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
@@ -48,7 +48,7 @@ module Sentdm
 
         # @!method initialize(identity: nil, number: nil, sandbox: nil, ttl: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
         #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::Channels::VoiceCreateTokenParams} for more details.
+        #   {Sentdm::Models::Voice::TokenCreateParams} for more details.
         #
         #   @param identity [String] Your identifier for the app user, such as an agent or account id. Letters, digit
         #

data/lib/sentdm/models/voice/voice_agent.rb

@@ -0,0 +1,138 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#list
+      class VoiceAgent < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   The agent's id, agent\_ and a UUID. It is also what the agent connects to the
+        #   gateway as.
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute audio
+        #   Audio sessions: the sample rate in use.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentAudio, nil]
+        optional :audio, -> { Sentdm::Voice::VoiceAgentAudio }, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute fallback
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentParty, nil]
+        optional :fallback, -> { Sentdm::Voice::VoiceAgentParty }, nil?: true
+
+        # @!attribute greeting
+        #
+        #   @return [String, nil]
+        optional :greeting, String, nil?: true
+
+        # @!attribute limits
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentLimits, nil]
+        optional :limits, -> { Sentdm::Voice::VoiceAgentLimits }
+
+        # @!attribute name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute session_type
+        #   text or audio.
+        #
+        #   @return [String, nil]
+        optional :session_type, String
+
+        # @!attribute signing_secret
+        #   The whsec\_ secret the gateway signs its handshake to websocket_url with.
+        #   Present on create and after a rotate-secret; absent on every other read. Store
+        #   it now.
+        #
+        #   @return [String, nil]
+        optional :signing_secret, String, nil?: true
+
+        # @!attribute speech
+        #   Text sessions: the speech setting, voice and language in use.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentSpeech, nil]
+        optional :speech, -> { Sentdm::Voice::VoiceAgentSpeech }, nil?: true
+
+        # @!attribute tools
+        #
+        #   @return [Array<String>, nil]
+        optional :tools, Sentdm::Internal::Type::ArrayOf[String]
+
+        # @!attribute transcripts
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentTranscripts, nil]
+        optional :transcripts, -> { Sentdm::Voice::VoiceAgentTranscripts }
+
+        # @!attribute transfer_targets
+        #
+        #   @return [Array<Sentdm::Models::Voice::VoiceAgentParty>, nil]
+        optional :transfer_targets, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::VoiceAgentParty] }
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, nil?: true
+
+        # @!attribute websocket_url
+        #   Where the gateway dials the agent; null when the agent dials in with your API
+        #   key.
+        #
+        #   @return [String, nil]
+        optional :websocket_url, String, nil?: true
+
+        # @!method initialize(id: nil, audio: nil, created_at: nil, fallback: nil, greeting: nil, limits: nil, name: nil, session_type: nil, signing_secret: nil, speech: nil, tools: nil, transcripts: nil, transfer_targets: nil, updated_at: nil, websocket_url: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::VoiceAgent} for more details.
+        #
+        #   A voice agent as stored: what was written with every default filled in, plus the
+        #   signing secret the one time it is shown (on create, and on rotate). The one
+        #   shape every read of an agent answers with, on /v3/voice/agents and on the admin
+        #   API the dashboard uses, so the two cannot drift.
+        #
+        #   @param id [String] The agent's id, agent\_ and a UUID. It is also what the agent connects to the
+        #   gat
+        #
+        #   @param audio [Sentdm::Models::Voice::VoiceAgentAudio, nil] Audio sessions: the sample rate in use.
+        #
+        #   @param created_at [Time]
+        #
+        #   @param fallback [Sentdm::Models::Voice::VoiceAgentParty, nil]
+        #
+        #   @param greeting [String, nil]
+        #
+        #   @param limits [Sentdm::Models::Voice::VoiceAgentLimits]
+        #
+        #   @param name [String]
+        #
+        #   @param session_type [String] text or audio.
+        #
+        #   @param signing_secret [String, nil] The whsec\_ secret the gateway signs its handshake to websocket_url with.
+        #   Present
+        #
+        #   @param speech [Sentdm::Models::Voice::VoiceAgentSpeech, nil] Text sessions: the speech setting, voice and language in use.
+        #
+        #   @param tools [Array<String>]
+        #
+        #   @param transcripts [Sentdm::Models::Voice::VoiceAgentTranscripts]
+        #
+        #   @param transfer_targets [Array<Sentdm::Models::Voice::VoiceAgentParty>]
+        #
+        #   @param updated_at [Time, nil]
+        #
+        #   @param websocket_url [String, nil] Where the gateway dials the agent; null when the agent dials in with your API ke
+      end
+    end
+
+    VoiceAgent = Voice::VoiceAgent
+  end
+end

data/lib/sentdm/models/voice/voice_agent_audio.rb

@@ -0,0 +1,19 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentAudio < Sentdm::Internal::Type::BaseModel
+        # @!attribute sample_rate
+        #
+        #   @return [Integer, nil]
+        optional :sample_rate, Integer
+
+        # @!method initialize(sample_rate: nil)
+        #   @param sample_rate [Integer]
+      end
+    end
+
+    VoiceAgentAudio = Voice::VoiceAgentAudio
+  end
+end

data/lib/sentdm/models/voice/voice_agent_audio_spec.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentAudioSpec < Sentdm::Internal::Type::BaseModel
+        # @!attribute sample_rate
+        #   Samples per second of the audio exchanged: 8000, 16000 or 24000. Default 16000.
+        #
+        #   @return [Integer, nil]
+        optional :sample_rate, Integer, nil?: true
+
+        # @!method initialize(sample_rate: nil)
+        #   @param sample_rate [Integer, nil] Samples per second of the audio exchanged: 8000, 16000 or 24000. Default 16000.
+      end
+    end
+
+    VoiceAgentAudioSpec = Voice::VoiceAgentAudioSpec
+  end
+end