sentdm 0.39.0 → 0.40.0

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

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentLimits < Sentdm::Internal::Type::BaseModel
+        # @!attribute allowed_countries
+        #
+        #   @return [Array<String>, nil]
+        optional :allowed_countries, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute max_call_seconds
+        #
+        #   @return [Integer, nil]
+        optional :max_call_seconds, Integer
+
+        # @!attribute max_concurrent_calls
+        #
+        #   @return [Integer, nil]
+        optional :max_concurrent_calls, Integer
+
+        # @!method initialize(allowed_countries: nil, max_call_seconds: nil, max_concurrent_calls: nil)
+        #   @param allowed_countries [Array<String>, nil]
+        #   @param max_call_seconds [Integer]
+        #   @param max_concurrent_calls [Integer]
+      end
+    end
+
+    VoiceAgentLimits = Voice::VoiceAgentLimits
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentLimitsSpec < Sentdm::Internal::Type::BaseModel
+        # @!attribute allowed_countries
+        #   ISO 3166-1 alpha-2 codes of the countries the agent may call or transfer to.
+        #   Omit it to allow every country. Stored now, applied when the agent places calls.
+        #
+        #   @return [Array<String>, nil]
+        optional :allowed_countries, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute max_call_seconds
+        #   The longest a call may last, 60 to 14,400 seconds. Default 3,600.
+        #
+        #   @return [Integer, nil]
+        optional :max_call_seconds, Integer, nil?: true
+
+        # @!attribute max_concurrent_calls
+        #   How many calls the agent may have going at once, from 1. Default 10.
+        #
+        #   @return [Integer, nil]
+        optional :max_concurrent_calls, Integer, nil?: true
+
+        # @!method initialize(allowed_countries: nil, max_call_seconds: nil, max_concurrent_calls: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::VoiceAgentLimitsSpec} for more details.
+        #
+        #   @param allowed_countries [Array<String>, nil] ISO 3166-1 alpha-2 codes of the countries the agent may call or transfer to. Omi
+        #
+        #   @param max_call_seconds [Integer, nil] The longest a call may last, 60 to 14,400 seconds. Default 3,600.
+        #
+        #   @param max_concurrent_calls [Integer, nil] How many calls the agent may have going at once, from 1. Default 10.
+      end
+    end
+
+    VoiceAgentLimitsSpec = Voice::VoiceAgentLimitsSpec
+  end
+end

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

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentParty < Sentdm::Internal::Type::BaseModel
+        # @!attribute kind
+        #
+        #   @return [String, nil]
+        optional :kind, String
+
+        # @!attribute value
+        #
+        #   @return [String, nil]
+        optional :value, String
+
+        # @!method initialize(kind: nil, value: nil)
+        #   @param kind [String]
+        #   @param value [String]
+      end
+    end
+
+    VoiceAgentParty = Voice::VoiceAgentParty
+  end
+end

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

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentPartySpec < Sentdm::Internal::Type::BaseModel
+        # @!attribute kind
+        #   number, user or agent.
+        #
+        #   @return [String, nil]
+        optional :kind, String, nil?: true
+
+        # @!attribute value
+        #   The E.164 number, the app user's identity, or the agent id (agent\_…).
+        #
+        #   @return [String, nil]
+        optional :value, String, nil?: true
+
+        # @!method initialize(kind: nil, value: nil)
+        #   @param kind [String, nil] number, user or agent.
+        #
+        #   @param value [String, nil] The E.164 number, the app user's identity, or the agent id (agent\_…).
+      end
+    end
+
+    VoiceAgentPartySpec = Voice::VoiceAgentPartySpec
+  end
+end

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

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentSecret < Sentdm::Internal::Type::BaseModel
+        # @!attribute signing_secret
+        #   The new whsec\_ secret. The previous one stopped signing the moment this was
+        #   returned. Shown once.
+        #
+        #   @return [String, nil]
+        optional :signing_secret, String
+
+        # @!method initialize(signing_secret: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::VoiceAgentSecret} for more details.
+        #
+        #   A freshly rotated signing secret.
+        #
+        #   @param signing_secret [String] The new whsec\_ secret. The previous one stopped signing the moment this was
+        #   retu
+      end
+    end
+
+    VoiceAgentSecret = Voice::VoiceAgentSecret
+  end
+end

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

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentSpeech < Sentdm::Internal::Type::BaseModel
+        # @!attribute language
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute setting
+        #
+        #   @return [String, nil]
+        optional :setting, String
+
+        # @!attribute voice
+        #
+        #   @return [String, nil]
+        optional :voice, String
+
+        # @!method initialize(language: nil, setting: nil, voice: nil)
+        #   @param language [String]
+        #   @param setting [String]
+        #   @param voice [String]
+      end
+    end
+
+    VoiceAgentSpeech = Voice::VoiceAgentSpeech
+  end
+end

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

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentSpeechSpec < Sentdm::Internal::Type::BaseModel
+        # @!attribute language
+        #   The language spoken and listened for, a BCP 47 tag from GET /v3/voice/voices.
+        #   Default en-US.
+        #
+        #   @return [String, nil]
+        optional :language, String, nil?: true
+
+        # @!attribute setting
+        #   standard, Sent's speech. Other settings are not available yet.
+        #
+        #   @return [String, nil]
+        optional :setting, String, nil?: true
+
+        # @!attribute voice
+        #   A voice name from GET /v3/voice/voices. Default: the catalogue's default voice.
+        #
+        #   @return [String, nil]
+        optional :voice, String, nil?: true
+
+        # @!method initialize(language: nil, setting: nil, voice: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::VoiceAgentSpeechSpec} for more details.
+        #
+        #   @param language [String, nil] The language spoken and listened for, a BCP 47 tag from GET /v3/voice/voices. De
+        #
+        #   @param setting [String, nil] standard, Sent's speech. Other settings are not available yet.
+        #
+        #   @param voice [String, nil] A voice name from GET /v3/voice/voices. Default: the catalogue's default voice.
+      end
+    end
+
+    VoiceAgentSpeechSpec = Voice::VoiceAgentSpeechSpec
+  end
+end

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

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

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

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentTranscriptsSpec < Sentdm::Internal::Type::BaseModel
+        # @!attribute retention_days
+        #   How long a stored transcript is kept, 1 to 365 days. Default 30.
+        #
+        #   @return [Integer, nil]
+        optional :retention_days, Integer, nil?: true
+
+        # @!attribute store
+        #   Whether Sent keeps the call's transcript. Default false. Stored now, applied
+        #   when transcripts land.
+        #
+        #   @return [Boolean, nil]
+        optional :store, Sentdm::Internal::Type::Boolean, nil?: true
+
+        # @!method initialize(retention_days: nil, store: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Voice::VoiceAgentTranscriptsSpec} for more details.
+        #
+        #   @param retention_days [Integer, nil] How long a stored transcript is kept, 1 to 365 days. Default 30.
+        #
+        #   @param store [Boolean, nil] Whether Sent keeps the call's transcript. Default false. Stored now, applied whe
+      end
+    end
+
+    VoiceAgentTranscriptsSpec = Voice::VoiceAgentTranscriptsSpec
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceAgentsList < Sentdm::Internal::Type::BaseModel
+        # @!attribute agents
+        #
+        #   @return [Array<Sentdm::Models::Voice::VoiceAgent>, nil]
+        optional :agents, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::VoiceAgent] }
+
+        # @!attribute pagination
+        #   Pagination metadata for list responses
+        #
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
+
+        # @!method initialize(agents: nil, pagination: nil)
+        #   A page of the account's agents. The agent itself is VoiceAgentResponse, shared
+        #   with the admin API.
+        #
+        #   @param agents [Array<Sentdm::Models::Voice::VoiceAgent>]
+        #
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+      end
+    end
+
+    VoiceAgentsList = Voice::VoiceAgentsList
+  end
+end

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

@@ -0,0 +1,30 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceCatalogue < Sentdm::Internal::Type::BaseModel
+        # @!attribute languages
+        #   BCP 47 tags accepted as speech.language.
+        #
+        #   @return [Array<String>, nil]
+        optional :languages, Sentdm::Internal::Type::ArrayOf[String]
+
+        # @!attribute voices
+        #
+        #   @return [Array<Sentdm::Models::Voice::VoiceCatalogueVoice>, nil]
+        optional :voices, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Voice::VoiceCatalogueVoice] }
+
+        # @!method initialize(languages: nil, voices: nil)
+        #   The voices and languages a text-session agent may name in its speech settings:
+        #   what GET /v3/voice/voices and the admin GET /voice/voices answer, in one shape.
+        #
+        #   @param languages [Array<String>] BCP 47 tags accepted as speech.language.
+        #
+        #   @param voices [Array<Sentdm::Models::Voice::VoiceCatalogueVoice>]
+      end
+    end
+
+    VoiceCatalogue = Voice::VoiceCatalogue
+  end
+end

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

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Voice
+      class VoiceCatalogueVoice < Sentdm::Internal::Type::BaseModel
+        # @!attribute default
+        #   Whether this is the voice used when an agent names none.
+        #
+        #   @return [Boolean, nil]
+        optional :default, Sentdm::Internal::Type::Boolean
+
+        # @!attribute description
+        #
+        #   @return [String, nil]
+        optional :description, String
+
+        # @!attribute language
+        #   The language the voice speaks.
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute name
+        #   The value to send as speech.voice.
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!method initialize(default: nil, description: nil, language: nil, name: nil)
+        #   @param default [Boolean] Whether this is the voice used when an agent names none.
+        #
+        #   @param description [String]
+        #
+        #   @param language [String] The language the voice speaks.
+        #
+        #   @param name [String] The value to send as speech.voice.
+      end
+    end
+
+    VoiceCatalogueVoice = Voice::VoiceCatalogueVoice
+  end
+end

data/lib/sentdm/models/webhook_create_params.rb

@@ -29,7 +29,18 @@ module Sentdm
       #   @return [Array<String>, nil]
       optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
 
+      # @!attribute is_inheritable
+      #   Also delivers every sender profile's events to this webhook, at the same URL and
+      #   with the same signing secret, and lets each profile see the webhook and read the
+      #   events about itself. Off by default: the organization's own events only. Only an
+      #   organization's version 2 webhook can set it.
+      #
+      #   @return [Boolean, nil]
+      optional :is_inheritable, Sentdm::Internal::Type::Boolean
+
       # @!attribute retry_count
+      #   Delivery retries. Applies to version 1 only: Svix retries a version 2 webhook on
+      #   its own schedule.
       #
       #   @return [Integer, nil]
       optional :retry_count, Integer
@@ -43,16 +54,26 @@ module Sentdm
 
       # @!attribute sender_profile
       #   Request-only: the events an organization webhook's sender profile clones
-      #   receive, one clone per existing and future profile. Responses never return it.
+      #   receive, one clone per existing and future profile. A version 1 webhook's
+      #   responses report it as WebhookSenderProfileV3Response.
       #
       #   @return [Sentdm::Models::WebhookCreateParams::SenderProfile, nil]
       optional :sender_profile, -> { Sentdm::WebhookCreateParams::SenderProfile }, nil?: true
 
       # @!attribute timeout_seconds
+      #   Delivery timeout. Applies to version 1 only.
       #
       #   @return [Integer, nil]
       optional :timeout_seconds, Integer
 
+      # @!attribute webhook_version
+      #   Who delivers the webhook: 2, the default, is delivered by Svix and signed with
+      #   the webhook-id, webhook-timestamp and webhook-signature headers; 1 is the older
+      #   delivery, signed with the X-Webhook-\* headers, which will be retired.
+      #
+      #   @return [Integer, nil]
+      optional :webhook_version, Integer, nil?: true
+
       # @!attribute idempotency_key
       #
       #   @return [String, nil]
@@ -63,7 +84,7 @@ module Sentdm
       #   @return [String, nil]
       optional :x_profile_id, String
 
-      # @!method initialize(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, retry_count: nil, sandbox: nil, sender_profile: nil, timeout_seconds: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @!method initialize(display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, is_inheritable: nil, retry_count: nil, sandbox: nil, sender_profile: nil, timeout_seconds: nil, webhook_version: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::WebhookCreateParams} for more details.
       #
@@ -75,13 +96,17 @@ module Sentdm
       #
       #   @param event_types [Array<String>]
       #
-      #   @param retry_count [Integer]
+      #   @param is_inheritable [Boolean] Also delivers every sender profile's events to this webhook, at the same URL and
+      #
+      #   @param retry_count [Integer] Delivery retries. Applies to version 1 only: Svix retries a version 2 webhook on
       #
       #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
       #   @param sender_profile [Sentdm::Models::WebhookCreateParams::SenderProfile, nil] Request-only: the events an organization webhook's sender profile clones receive
       #
-      #   @param timeout_seconds [Integer]
+      #   @param timeout_seconds [Integer] Delivery timeout. Applies to version 1 only.
+      #
+      #   @param webhook_version [Integer, nil] Who delivers the webhook: 2, the default, is delivered by Svix and signed with t
       #
       #   @param idempotency_key [String]
       #
@@ -104,7 +129,8 @@ module Sentdm
 
         # @!method initialize(event_filters: nil, event_types: nil)
         #   Request-only: the events an organization webhook's sender profile clones
-        #   receive, one clone per existing and future profile. Responses never return it.
+        #   receive, one clone per existing and future profile. A version 1 webhook's
+        #   responses report it as WebhookSenderProfileV3Response.
         #
         #   @param event_filters [Hash{Symbol=>Array<String>}, nil]
         #   @param event_types [Array<String>]