sentdm 0.38.1 → 0.40.0

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

@@ -0,0 +1,142 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#create
+      class AgentCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute audio
+        #   Audio sessions only: the sound format.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentAudioSpec, nil]
+        optional :audio, -> { Sentdm::Voice::VoiceAgentAudioSpec }, nil?: true
+
+        # @!attribute fallback
+        #   Who takes the call when the agent cannot: a phone number (kind: number). Omit it
+        #   and such a call hangs up.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentPartySpec, nil]
+        optional :fallback, -> { Sentdm::Voice::VoiceAgentPartySpec }, nil?: true
+
+        # @!attribute greeting
+        #   Text sessions only: what the caller hears as soon as the call is answered,
+        #   before the agent's first turn. 1 to 4,096 characters. Omit it and the agent
+        #   speaks first.
+        #
+        #   @return [String, nil]
+        optional :greeting, String, nil?: true
+
+        # @!attribute limits
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentLimitsSpec, nil]
+        optional :limits, -> { Sentdm::Voice::VoiceAgentLimitsSpec }, nil?: true
+
+        # @!attribute name
+        #   A name for your own reference, 1 to 100 characters.
+        #
+        #   @return [String, nil]
+        optional :name, 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 session_type
+        #   text: Sent turns the caller's speech into text and the agent's text into speech,
+        #   so the agent exchanges text frames. audio: the agent receives and sends the
+        #   sound itself.
+        #
+        #   @return [String, nil]
+        optional :session_type, String, nil?: true
+
+        # @!attribute speech
+        #   Text sessions only: how the caller is spoken to and listened to.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentSpeechSpec, nil]
+        optional :speech, -> { Sentdm::Voice::VoiceAgentSpeechSpec }, nil?: true
+
+        # @!attribute tools
+        #   What the agent may do to the call: any of transfer, hangup, send_dtmf and hold.
+        #   Default ["hangup"]. transfer needs at least one transfer_targets entry.
+        #
+        #   @return [Array<String>, nil]
+        optional :tools, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute transcripts
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentTranscriptsSpec, nil]
+        optional :transcripts, -> { Sentdm::Voice::VoiceAgentTranscriptsSpec }, nil?: true
+
+        # @!attribute transfer_targets
+        #   Where the agent may transfer a call to, up to 20 parties: a phone number (kind:
+        #   number, E.164), one of your app users (kind: user, the identity) or another of
+        #   your agents (kind: agent, its id). The agent can only transfer to a party listed
+        #   here.
+        #
+        #   @return [Array<Sentdm::Models::Voice::VoiceAgentPartySpec>, nil]
+        optional :transfer_targets,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::VoiceAgentPartySpec] },
+                 nil?: true
+
+        # @!attribute websocket_url
+        #   Where the gateway connects to the agent for each call: an absolute wss:// URL on
+        #   a public host, at most 2,048 characters. The handshake is signed with the
+        #   agent's signing_secret. Leave it out and the agent dials in instead, connecting
+        #   to the gateway with your API key.
+        #
+        #   @return [String, nil]
+        optional :websocket_url, String, nil?: true
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(audio: nil, fallback: nil, greeting: nil, limits: nil, name: nil, sandbox: nil, session_type: nil, speech: nil, tools: nil, transcripts: nil, transfer_targets: nil, websocket_url: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::AgentCreateParams} for more details.
+        #
+        #   @param audio [Sentdm::Models::Voice::VoiceAgentAudioSpec, nil] Audio sessions only: the sound format.
+        #
+        #   @param fallback [Sentdm::Models::Voice::VoiceAgentPartySpec, nil] Who takes the call when the agent cannot: a phone number (kind: number). Omit it
+        #
+        #   @param greeting [String, nil] Text sessions only: what the caller hears as soon as the call is answered, befor
+        #
+        #   @param limits [Sentdm::Models::Voice::VoiceAgentLimitsSpec, nil]
+        #
+        #   @param name [String, nil] A name for your own reference, 1 to 100 characters.
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param session_type [String, nil] text: Sent turns the caller's speech into text and the agent's text into speech,
+        #
+        #   @param speech [Sentdm::Models::Voice::VoiceAgentSpeechSpec, nil] Text sessions only: how the caller is spoken to and listened to.
+        #
+        #   @param tools [Array<String>, nil] What the agent may do to the call: any of transfer, hangup, send_dtmf and
+        #
+        #   @param transcripts [Sentdm::Models::Voice::VoiceAgentTranscriptsSpec, nil]
+        #
+        #   @param transfer_targets [Array<Sentdm::Models::Voice::VoiceAgentPartySpec>, nil] Where the agent may transfer a call to, up to 20 parties: a phone number (kind:
+        #
+        #   @param websocket_url [String, nil] Where the gateway connects to the agent for each call: an absolute wss:// URL on
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/{calls/participant_list_params.rb → voice/agent_delete_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#list
-      class ParticipantListParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#delete
+      class AgentDeleteParams < Sentdm::Models::MutationRequest
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 

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

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

data/lib/sentdm/models/{calls/participant_remove_all_params.rb → voice/agent_retrieve_params.rb}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#remove_all
-      class ParticipantRemoveAllParams < Sentdm::Models::MutationRequest
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#retrieve
+      class AgentRetrieveParams < Sentdm::Internal::Type::BaseModel
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 

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

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#rotate_secret
+      class AgentRotateSecretParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!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:, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   @param id [String]
+        #   @param idempotency_key [String]
+        #   @param x_profile_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

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

@@ -0,0 +1,141 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#update
+      class AgentUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute id
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute audio
+        #   Audio sessions: { sample_rate }; null restores the default.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentAudioSpec, nil]
+        optional :audio, -> { Sentdm::Voice::VoiceAgentAudioSpec }, nil?: true
+
+        # @!attribute fallback
+        #   A new fallback party, or null for none.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentPartySpec, nil]
+        optional :fallback, -> { Sentdm::Voice::VoiceAgentPartySpec }, nil?: true
+
+        # @!attribute greeting
+        #   A new greeting, or null for none.
+        #
+        #   @return [String, nil]
+        optional :greeting, String, nil?: true
+
+        # @!attribute limits
+        #   The whole limits object; null restores the defaults.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentLimitsSpec, nil]
+        optional :limits, -> { Sentdm::Voice::VoiceAgentLimitsSpec }, nil?: true
+
+        # @!attribute name
+        #   A new name, 1 to 100 characters.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!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 session_type
+        #   text or audio. Changing it drops the settings the other type cannot have
+        #   (speech, audio, greeting) unless the body sends them.
+        #
+        #   @return [String, nil]
+        optional :session_type, String
+
+        # @!attribute speech
+        #   Text sessions: { setting, voice, language }, replaced whole; null restores the
+        #   defaults.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentSpeechSpec, nil]
+        optional :speech, -> { Sentdm::Voice::VoiceAgentSpeechSpec }, nil?: true
+
+        # @!attribute tools
+        #   The whole list of tools; null restores the default.
+        #
+        #   @return [Array<String>, nil]
+        optional :tools, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute transcripts
+        #   The whole transcripts object; null restores the defaults.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentTranscriptsSpec, nil]
+        optional :transcripts, -> { Sentdm::Voice::VoiceAgentTranscriptsSpec }, nil?: true
+
+        # @!attribute transfer_targets
+        #   The whole list of parties; null clears it.
+        #
+        #   @return [Array<Sentdm::Models::Voice::VoiceAgentPartySpec>, nil]
+        optional :transfer_targets,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::VoiceAgentPartySpec] },
+                 nil?: true
+
+        # @!attribute websocket_url
+        #   A new wss:// URL, or null for an agent that dials in.
+        #
+        #   @return [String, nil]
+        optional :websocket_url, String, nil?: true
+
+        # @!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:, audio: nil, fallback: nil, greeting: nil, limits: nil, name: nil, sandbox: nil, session_type: nil, speech: nil, tools: nil, transcripts: nil, transfer_targets: nil, websocket_url: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::AgentUpdateParams} for more details.
+        #
+        #   @param id [String]
+        #
+        #   @param audio [Sentdm::Models::Voice::VoiceAgentAudioSpec, nil] Audio sessions: { sample_rate }; null restores the default.
+        #
+        #   @param fallback [Sentdm::Models::Voice::VoiceAgentPartySpec, nil] A new fallback party, or null for none.
+        #
+        #   @param greeting [String, nil] A new greeting, or null for none.
+        #
+        #   @param limits [Sentdm::Models::Voice::VoiceAgentLimitsSpec, nil] The whole limits object; null restores the defaults.
+        #
+        #   @param name [String] A new name, 1 to 100 characters.
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param session_type [String] text or audio. Changing it drops the settings the other type cannot have (speech
+        #
+        #   @param speech [Sentdm::Models::Voice::VoiceAgentSpeechSpec, nil] Text sessions: { setting, voice, language }, replaced whole; null restores the d
+        #
+        #   @param tools [Array<String>, nil] The whole list of tools; null restores the default.
+        #
+        #   @param transcripts [Sentdm::Models::Voice::VoiceAgentTranscriptsSpec, nil] The whole transcripts object; null restores the defaults.
+        #
+        #   @param transfer_targets [Array<Sentdm::Models::Voice::VoiceAgentPartySpec>, nil] The whole list of parties; null clears it.
+        #
+        #   @param websocket_url [String, nil] A new wss:// URL, or null for an agent that dials in.
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/{calls/api_response_of_list_of_call_participant.rb → voice/api_response_of_call.rb}

@@ -2,14 +2,14 @@
 
 module Sentdm
   module Models
-    module Calls
-      # @see Sentdm::Resources::Calls::Participants#list
-      class APIResponseOfListOfCallParticipant < Sentdm::Internal::Type::BaseModel
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#retrieve
+      class APIResponseOfCall < Sentdm::Internal::Type::BaseModel
         # @!attribute data
-        #   The response data (null if error)
+        #   A call record
         #
-        #   @return [Array<Sentdm::Models::Calls::CallParticipant>, nil]
-        optional :data, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Calls::CallParticipant] }, nil?: true
+        #   @return [Sentdm::Models::Voice::Call, nil]
+        optional :data, -> { Sentdm::Voice::Call }, nil?: true
 
         # @!attribute error
         #   Error information
@@ -32,7 +32,7 @@ module Sentdm
         # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
         #   Standard API response envelope for all v3 endpoints
         #
-        #   @param data [Array<Sentdm::Models::Calls::CallParticipant>, nil] The response data (null if error)
+        #   @param data [Sentdm::Models::Voice::Call, nil] A call record
         #
         #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
         #

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Calls#list_recordings
+      class APIResponseOfCallRecordings < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The recordings of a call, each as a short-lived download link
+        #
+        #   @return [Sentdm::Models::Voice::CallRecordings, nil]
+        optional :data, -> { Sentdm::Voice::CallRecordings }, 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 [Sentdm::Models::Voice::CallRecordings, nil] The recordings of a call, each as a short-lived download link
+        #
+        #   @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

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

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfCallsList < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   Paginated list of calls
+        #
+        #   @return [Sentdm::Models::Voice::CallsList, nil]
+        optional :data, -> { Sentdm::Voice::CallsList }, 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 [Sentdm::Models::Voice::CallsList, nil] Paginated list of calls
+        #
+        #   @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

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

@@ -0,0 +1,51 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#create
+      class APIResponseOfVoiceAgent < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   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.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgent, nil]
+        optional :data, -> { Sentdm::Voice::VoiceAgent }, 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)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::APIResponseOfVoiceAgent} for more details.
+        #
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Voice::VoiceAgent, nil] A voice agent as stored: what was written with every default filled in, plus the
+        #
+        #   @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

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

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      # @see Sentdm::Resources::Voice::Agents#rotate_secret
+      class APIResponseOfVoiceAgentSecret < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   A freshly rotated signing secret.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentSecret, nil]
+        optional :data, -> { Sentdm::Voice::VoiceAgentSecret }, 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 [Sentdm::Models::Voice::VoiceAgentSecret, nil] A freshly rotated signing secret.
+        #
+        #   @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

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

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class APIResponseOfVoiceAgentsList < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   A page of the account's agents. The agent itself is VoiceAgentResponse, shared
+        #   with the admin API.
+        #
+        #   @return [Sentdm::Models::Voice::VoiceAgentsList, nil]
+        optional :data, -> { Sentdm::Voice::VoiceAgentsList }, 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)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::APIResponseOfVoiceAgentsList} for more details.
+        #
+        #   Standard API response envelope for all v3 endpoints
+        #
+        #   @param data [Sentdm::Models::Voice::VoiceAgentsList, nil] A page of the account's agents. The agent itself is VoiceAgentResponse, shared w
+        #
+        #   @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