sentdm 0.39.0 → 0.40.0

data/rbi/sentdm/resources/webhooks.rbi

@@ -14,18 +14,28 @@ module Sentdm
     # tried to deliver and what your endpoint answered — which is the first place to
     # look when something appears to be missing.
     class Webhooks
-      # Creates a new webhook endpoint for the authenticated customer.
+      # Creates a new webhook endpoint for the authenticated customer. A webhook is
+      # version 2 unless the request sets webhook_version to 1: Svix delivers it, signed
+      # with the webhook-id, webhook-timestamp and webhook-signature headers, and
+      # retries it on its own schedule, so retry_count and timeout_seconds apply to
+      # version 1 only. sender_profile applies to version 1 only and is ignored on
+      # version 2; is_inheritable applies to version 2 only. A version 1 webhook's
+      # response returns its sender_profile selection, with an empty event_types when it
+      # is not cloned onto sender profiles; a version 2 webhook's response leaves
+      # sender_profile out.
       sig do
         params(
           display_name: String,
           endpoint_url: String,
           event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
           event_types: T::Array[String],
+          is_inheritable: T::Boolean,
           retry_count: Integer,
           sandbox: T::Boolean,
           sender_profile:
             T.nilable(Sentdm::WebhookCreateParams::SenderProfile::OrHash),
           timeout_seconds: Integer,
+          webhook_version: T.nilable(Integer),
           idempotency_key: String,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
@@ -40,17 +50,28 @@ module Sentdm
         event_filters: nil,
         # Body param
         event_types: nil,
-        # Body param
+        # Body param: 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.
+        is_inheritable: nil,
+        # Body param: Delivery retries. Applies to version 1 only: Svix retries a version
+        # 2 webhook on its own schedule.
         retry_count: nil,
         # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
         sandbox: nil,
         # Body param: Request-only: the events an organization webhook's sender profile
-        # clones receive, one clone per existing and future profile. Responses never
-        # return it.
+        # clones receive, one clone per existing and future profile. A version 1 webhook's
+        # responses report it as WebhookSenderProfileV3Response.
         sender_profile: nil,
-        # Body param
+        # Body param: Delivery timeout. Applies to version 1 only.
         timeout_seconds: nil,
+        # Body param: 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.
+        webhook_version: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
@@ -63,7 +84,8 @@ module Sentdm
       )
       end
 
-      # Retrieves a single webhook by ID for the authenticated customer.
+      # Retrieves a single webhook by ID for the authenticated customer. A version 1
+      # webhook includes its sender_profile selection.
       sig do
         params(
           id: String,
@@ -80,7 +102,11 @@ module Sentdm
       )
       end
 
-      # Updates an existing webhook for the authenticated customer.
+      # Updates an existing webhook for the authenticated customer. Its version does not
+      # change. sender_profile applies to a version 1 webhook and is_inheritable to a
+      # version 2 one; retry_count and timeout_seconds apply to version 1 only. A
+      # version 1 webhook's response returns its sender_profile selection as saved; a
+      # version 2 webhook's response leaves sender_profile out.
       sig do
         params(
           id: String,
@@ -88,6 +114,7 @@ module Sentdm
           endpoint_url: String,
           event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
           event_types: T::Array[String],
+          is_inheritable: T.nilable(T::Boolean),
           retry_count: Integer,
           sandbox: T::Boolean,
           sender_profile:
@@ -109,14 +136,18 @@ module Sentdm
         event_filters: nil,
         # Body param
         event_types: nil,
+        # Body param: Makes this webhook inheritable by the organization's sender profiles
+        # (see create), or stops it being inheritable. Omit or pass null to keep it as it
+        # is. Only a version 2 webhook can be inheritable.
+        is_inheritable: nil,
         # Body param
         retry_count: nil,
         # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
         sandbox: nil,
         # Body param: Request-only: the events an organization webhook's sender profile
-        # clones receive, one clone per existing and future profile. Responses never
-        # return it.
+        # clones receive, one clone per existing and future profile. A version 1 webhook's
+        # responses report it as WebhookSenderProfileV3Response.
         sender_profile: nil,
         # Body param
         timeout_seconds: nil,
@@ -132,7 +163,8 @@ module Sentdm
       )
       end
 
-      # Retrieves a paginated list of webhooks for the authenticated customer.
+      # Retrieves a paginated list of webhooks for the authenticated customer. Each
+      # version 1 webhook includes its sender_profile selection.
       sig do
         params(
           is_active: T.nilable(T::Boolean),
@@ -192,9 +224,11 @@ module Sentdm
       )
       end
 
-      # Retrieves a paginated list of delivery events for the specified webhook. If the
-      # webhook is cloned onto your sender profiles, the list includes what those clones
-      # received; read payload.account_id to tell whose event it is.
+      # Retrieves a paginated list of delivery events for the specified webhook, newest
+      # first. If the webhook is cloned onto your sender profiles (version 1) or
+      # inheritable by them (version 2, is_inheritable), the list includes their events;
+      # read payload.account_id to tell whose event it is. A sender profile may read its
+      # organization's inheritable webhook too, and gets the events about itself.
       sig do
         params(
           id: String,
@@ -226,8 +260,11 @@ module Sentdm
       )
       end
 
-      # Generates a new signing secret for the specified webhook. The old secret is
-      # immediately invalidated.
+      # Generates a new signing secret for the specified webhook. A version 1 webhook's
+      # old secret stops verifying at once. A version 2 webhook's deliveries are signed
+      # with the new secret at once, and with the old one as well for the next 24 hours,
+      # so a receiver can switch over without rejecting any; after that the old secret
+      # no longer verifies.
       sig do
         params(
           id: String,
@@ -255,7 +292,10 @@ module Sentdm
       )
       end
 
-      # Sends a test event to the specified webhook endpoint to verify connectivity.
+      # Sends a test event to the specified webhook endpoint to verify connectivity. A
+      # version 1 webhook is tested at once and the answer says whether it was
+      # delivered; a version 2 webhook's test is queued with Svix, which delivers it
+      # right after, and the answer says it was queued.
       sig do
         params(
           id: String,

data/sig/sentdm/internal/voice_agents_page.rbs

@@ -0,0 +1,41 @@
+module Sentdm
+  module Internal
+    class VoiceAgentsPage[Elem]
+      include Sentdm::Internal::Type::BasePage[Elem]
+
+      attr_accessor data: Data
+
+      def inspect: -> String
+
+      type data = { agents: ::Array[top], pagination: Data::Pagination }
+      class Data < Sentdm::Internal::Type::BaseModel
+        attr_reader agents: ::Array[top]?
+
+        def agents=: (::Array[top]) -> ::Array[top]
+
+        attr_reader pagination: Data::Pagination?
+
+        def pagination=: (Data::Pagination) -> Data::Pagination
+
+        def initialize: (
+          ?agents: ::Array[top],
+          ?pagination: Data::Pagination
+        ) -> void
+
+        def to_hash: -> { agents: ::Array[top], pagination: Data::Pagination }
+
+        type pagination = { has_more: bool }
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          attr_reader has_more: bool?
+
+          def has_more=: (bool) -> bool
+
+          def initialize: (?has_more: bool) -> void
+
+          def to_hash: -> { has_more: bool }
+        end
+      end
+    end
+  end
+end

data/sig/sentdm/models/call_event_payload.rbs

@@ -4,8 +4,10 @@ module Sentdm
       {
         call_id: String,
         account_id: String,
+        agent_id: String?,
         channel: String,
         duration_seconds: Integer?,
+        mode: String,
         number: String,
         price: Float?,
         reason: String?,
@@ -20,12 +22,18 @@ module Sentdm
 
       def account_id=: (String) -> String
 
+      attr_accessor agent_id: String?
+
       attr_reader channel: String?
 
       def channel=: (String) -> String
 
       attr_accessor duration_seconds: Integer?
 
+      attr_reader mode: String?
+
+      def mode=: (String) -> String
+
       attr_reader number: String?
 
       def number=: (String) -> String
@@ -43,8 +51,10 @@ module Sentdm
       def initialize: (
         call_id: String,
         ?account_id: String,
+        ?agent_id: String?,
         ?channel: String,
         ?duration_seconds: Integer?,
+        ?mode: String,
         ?number: String,
         ?price: Float?,
         ?reason: String?,
@@ -55,8 +65,10 @@ module Sentdm
       def to_hash: -> {
         call_id: String,
         account_id: String,
+        agent_id: String?,
         channel: String,
         duration_seconds: Integer?,
+        mode: String,
         number: String,
         price: Float?,
         reason: String?,

data/sig/sentdm/models/channels/voice_create_params.rbs

@@ -3,8 +3,9 @@ module Sentdm
     module Channels
       type voice_create_params =
         {
-          callback_url: String,
+          agent_id: String?,
           area_code: String?,
+          callback_url: String?,
           default_for_app_calls: bool?,
           number: String?,
           sandbox: bool,
@@ -17,10 +18,12 @@ module Sentdm
         extend Sentdm::Internal::Type::RequestParameters::Converter
         include Sentdm::Internal::Type::RequestParameters
 
-        attr_accessor callback_url: String
+        attr_accessor agent_id: String?
 
         attr_accessor area_code: String?
 
+        attr_accessor callback_url: String?
+
         attr_accessor default_for_app_calls: bool?
 
         attr_accessor number: String?
@@ -38,8 +41,9 @@ module Sentdm
         def x_profile_id=: (String) -> String
 
         def initialize: (
-          callback_url: String,
+          ?agent_id: String?,
           ?area_code: String?,
+          ?callback_url: String?,
           ?default_for_app_calls: bool?,
           ?number: String?,
           ?sandbox: bool,
@@ -49,8 +53,9 @@ module Sentdm
         ) -> void
 
         def to_hash: -> {
-          callback_url: String,
+          agent_id: String?,
           area_code: String?,
+          callback_url: String?,
           default_for_app_calls: bool?,
           number: String?,
           sandbox: bool,

data/sig/sentdm/models/channels/voice_number.rbs

@@ -3,15 +3,19 @@ module Sentdm
     module Channels
       type voice_number =
         {
+          agent_id: String?,
           callback_url: String?,
           created_at: Time,
           default_for_app_calls: bool,
           number: String,
+          routes_to: String,
           status: String,
           updated_at: Time
         }
 
       class VoiceNumber < Sentdm::Internal::Type::BaseModel
+        attr_accessor agent_id: String?
+
         attr_accessor callback_url: String?
 
         attr_reader created_at: Time?
@@ -26,6 +30,10 @@ module Sentdm
 
         def number=: (String) -> String
 
+        attr_reader routes_to: String?
+
+        def routes_to=: (String) -> String
+
         attr_reader status: String?
 
         def status=: (String) -> String
@@ -35,19 +43,23 @@ module Sentdm
         def updated_at=: (Time) -> Time
 
         def initialize: (
+          ?agent_id: String?,
           ?callback_url: String?,
           ?created_at: Time,
           ?default_for_app_calls: bool,
           ?number: String,
+          ?routes_to: String,
           ?status: String,
           ?updated_at: Time
         ) -> void
 
         def to_hash: -> {
+          agent_id: String?,
           callback_url: String?,
           created_at: Time,
           default_for_app_calls: bool,
           number: String,
+          routes_to: String,
           status: String,
           updated_at: Time
         }

data/sig/sentdm/models/channels/voice_update_params.rbs

@@ -4,6 +4,7 @@ module Sentdm
       type voice_update_params =
         {
           number: String,
+          agent_id: String?,
           callback_url: String?,
           default_for_app_calls: bool?,
           sandbox: bool,
@@ -19,6 +20,8 @@ module Sentdm
 
         attr_accessor number: String
 
+        attr_accessor agent_id: String?
+
         attr_accessor callback_url: String?
 
         attr_accessor default_for_app_calls: bool?
@@ -39,6 +42,7 @@ module Sentdm
 
         def initialize: (
           number: String,
+          ?agent_id: String?,
           ?callback_url: String?,
           ?default_for_app_calls: bool?,
           ?sandbox: bool,
@@ -50,6 +54,7 @@ module Sentdm
 
         def to_hash: -> {
           number: String,
+          agent_id: String?,
           callback_url: String?,
           default_for_app_calls: bool?,
           sandbox: bool,

data/sig/sentdm/models/voice/agent_create_params.rbs

@@ -0,0 +1,99 @@
+module Sentdm
+  module Models
+    module Voice
+      type agent_create_params =
+        {
+          audio: Sentdm::Voice::VoiceAgentAudioSpec?,
+          fallback: Sentdm::Voice::VoiceAgentPartySpec?,
+          greeting: String?,
+          limits: Sentdm::Voice::VoiceAgentLimitsSpec?,
+          name: String?,
+          sandbox: bool,
+          session_type: String?,
+          speech: Sentdm::Voice::VoiceAgentSpeechSpec?,
+          tools: ::Array[String]?,
+          transcripts: Sentdm::Voice::VoiceAgentTranscriptsSpec?,
+          transfer_targets: ::Array[Sentdm::Voice::VoiceAgentPartySpec]?,
+          websocket_url: String?,
+          idempotency_key: String,
+          x_profile_id: String
+        }
+        & Sentdm::Internal::Type::request_parameters
+
+      class AgentCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor audio: Sentdm::Voice::VoiceAgentAudioSpec?
+
+        attr_accessor fallback: Sentdm::Voice::VoiceAgentPartySpec?
+
+        attr_accessor greeting: String?
+
+        attr_accessor limits: Sentdm::Voice::VoiceAgentLimitsSpec?
+
+        attr_accessor name: String?
+
+        attr_reader sandbox: bool?
+
+        def sandbox=: (bool) -> bool
+
+        attr_accessor session_type: String?
+
+        attr_accessor speech: Sentdm::Voice::VoiceAgentSpeechSpec?
+
+        attr_accessor tools: ::Array[String]?
+
+        attr_accessor transcripts: Sentdm::Voice::VoiceAgentTranscriptsSpec?
+
+        attr_accessor transfer_targets: ::Array[Sentdm::Voice::VoiceAgentPartySpec]?
+
+        attr_accessor websocket_url: String?
+
+        attr_reader idempotency_key: String?
+
+        def idempotency_key=: (String) -> String
+
+        attr_reader x_profile_id: String?
+
+        def x_profile_id=: (String) -> String
+
+        def initialize: (
+          ?audio: Sentdm::Voice::VoiceAgentAudioSpec?,
+          ?fallback: Sentdm::Voice::VoiceAgentPartySpec?,
+          ?greeting: String?,
+          ?limits: Sentdm::Voice::VoiceAgentLimitsSpec?,
+          ?name: String?,
+          ?sandbox: bool,
+          ?session_type: String?,
+          ?speech: Sentdm::Voice::VoiceAgentSpeechSpec?,
+          ?tools: ::Array[String]?,
+          ?transcripts: Sentdm::Voice::VoiceAgentTranscriptsSpec?,
+          ?transfer_targets: ::Array[Sentdm::Voice::VoiceAgentPartySpec]?,
+          ?websocket_url: String?,
+          ?idempotency_key: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          audio: Sentdm::Voice::VoiceAgentAudioSpec?,
+          fallback: Sentdm::Voice::VoiceAgentPartySpec?,
+          greeting: String?,
+          limits: Sentdm::Voice::VoiceAgentLimitsSpec?,
+          name: String?,
+          sandbox: bool,
+          session_type: String?,
+          speech: Sentdm::Voice::VoiceAgentSpeechSpec?,
+          tools: ::Array[String]?,
+          transcripts: Sentdm::Voice::VoiceAgentTranscriptsSpec?,
+          transfer_targets: ::Array[Sentdm::Voice::VoiceAgentPartySpec]?,
+          websocket_url: String?,
+          idempotency_key: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/voice/agent_delete_params.rbs

@@ -0,0 +1,34 @@
+module Sentdm
+  module Models
+    module Voice
+      type agent_delete_params =
+        { id: String, x_profile_id: String }
+        & Sentdm::Internal::Type::request_parameters
+
+      class AgentDeleteParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        def id: -> String
+
+        def id=: (String _) -> String
+
+        def x_profile_id: -> String?
+
+        def x_profile_id=: (String _) -> String
+
+        def initialize: (
+          id: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/voice/agent_list_params.rbs

@@ -0,0 +1,40 @@
+module Sentdm
+  module Models
+    module Voice
+      type agent_list_params =
+        { page: Integer, page_size: Integer, x_profile_id: String }
+        & Sentdm::Internal::Type::request_parameters
+
+      class AgentListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_reader page: Integer?
+
+        def page=: (Integer) -> Integer
+
+        attr_reader page_size: Integer?
+
+        def page_size=: (Integer) -> Integer
+
+        attr_reader x_profile_id: String?
+
+        def x_profile_id=: (String) -> String
+
+        def initialize: (
+          ?page: Integer,
+          ?page_size: Integer,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          page: Integer,
+          page_size: Integer,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/voice/agent_retrieve_params.rbs

@@ -0,0 +1,32 @@
+module Sentdm
+  module Models
+    module Voice
+      type agent_retrieve_params =
+        { id: String, x_profile_id: String }
+        & Sentdm::Internal::Type::request_parameters
+
+      class AgentRetrieveParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        attr_accessor id: String
+
+        attr_reader x_profile_id: String?
+
+        def x_profile_id=: (String) -> String
+
+        def initialize: (
+          id: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end

data/sig/sentdm/models/voice/agent_rotate_secret_params.rbs

@@ -0,0 +1,40 @@
+module Sentdm
+  module Models
+    module Voice
+      type agent_rotate_secret_params =
+        { id: String, idempotency_key: String, x_profile_id: String }
+        & Sentdm::Internal::Type::request_parameters
+
+      class AgentRotateSecretParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        def id: -> String
+
+        def id=: (String _) -> String
+
+        def idempotency_key: -> String?
+
+        def idempotency_key=: (String _) -> String
+
+        def x_profile_id: -> String?
+
+        def x_profile_id=: (String _) -> String
+
+        def initialize: (
+          id: String,
+          ?idempotency_key: String,
+          ?x_profile_id: String,
+          ?request_options: Sentdm::request_opts
+        ) -> void
+
+        def to_hash: -> {
+          id: String,
+          idempotency_key: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions
+        }
+      end
+    end
+  end
+end