sentdm 0.34.0 → 0.35.0

data/rbi/sentdm/models/channels/voice_create_token_params.rbi

@@ -0,0 +1,104 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceCreateTokenParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::VoiceCreateTokenParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Your identifier for the app user, such as an agent or account id. Letters,
+        # digits, hyphens and underscores only, up to 200 characters.
+        sig { returns(T.nilable(String)) }
+        attr_reader :identity
+
+        sig { params(identity: String).void }
+        attr_writer :identity
+
+        # One of your voice-enabled phone numbers in E.164 format. Calls placed by this
+        # identity are routed through that number. Omit to use your default app-call
+        # number.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :number
+
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :sandbox
+
+        sig { params(sandbox: T::Boolean).void }
+        attr_writer :sandbox
+
+        # Token lifetime in seconds. Defaults to 600 and cannot exceed 3600.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :ttl
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            identity: String,
+            number: T.nilable(String),
+            sandbox: T::Boolean,
+            ttl: T.nilable(Integer),
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Your identifier for the app user, such as an agent or account id. Letters,
+          # digits, hyphens and underscores only, up to 200 characters.
+          identity: nil,
+          # One of your voice-enabled phone numbers in E.164 format. Calls placed by this
+          # identity are routed through that number. Omit to use your default app-call
+          # number.
+          number: nil,
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sandbox: nil,
+          # Token lifetime in seconds. Defaults to 600 and cannot exceed 3600.
+          ttl: nil,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              identity: String,
+              number: T.nilable(String),
+              sandbox: T::Boolean,
+              ttl: T.nilable(Integer),
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_list_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Channels::VoiceListParams, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(x_profile_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            { x_profile_id: String, request_options: Sentdm::RequestOptions }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_number.rbi

@@ -0,0 +1,105 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceNumber < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Channels::VoiceNumber, Sentdm::Internal::AnyHash)
+          end
+
+        # Where Sent asks what to do with each call on this number: a signed question is
+        # POSTed here when a call arrives or a caller presses a key, and the answer
+        # decides the call. The signing secret is not on this read; it is shown when voice
+        # is turned on and by the rotate endpoint.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :callback_url
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Whether this is the line app-originated calls are placed from when a voice token
+        # names no number. Exactly one active voice number carries it while the profile
+        # has any.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :default_for_app_calls
+
+        sig { params(default_for_app_calls: T::Boolean).void }
+        attr_writer :default_for_app_calls
+
+        # The number, in E.164.
+        sig { returns(T.nilable(String)) }
+        attr_reader :number
+
+        sig { params(number: String).void }
+        attr_writer :number
+
+        # ACTIVE while the number carries calls, INACTIVE once it was turned off. Nothing
+        # provisions: a number the customer holds can carry calls the moment voice is
+        # turned on for it.
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :updated_at
+
+        sig { params(updated_at: Time).void }
+        attr_writer :updated_at
+
+        # One number the profile carries phone calls on.
+        sig do
+          params(
+            callback_url: T.nilable(String),
+            created_at: Time,
+            default_for_app_calls: T::Boolean,
+            number: String,
+            status: String,
+            updated_at: Time
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Where Sent asks what to do with each call on this number: a signed question is
+          # POSTed here when a call arrives or a caller presses a key, and the answer
+          # decides the call. The signing secret is not on this read; it is shown when voice
+          # is turned on and by the rotate endpoint.
+          callback_url: nil,
+          created_at: nil,
+          # Whether this is the line app-originated calls are placed from when a voice token
+          # names no number. Exactly one active voice number carries it while the profile
+          # has any.
+          default_for_app_calls: nil,
+          # The number, in E.164.
+          number: nil,
+          # ACTIVE while the number carries calls, INACTIVE once it was turned off. Nothing
+          # provisions: a number the customer holds can carry calls the moment voice is
+          # turned on for it.
+          status: nil,
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              callback_url: T.nilable(String),
+              created_at: Time,
+              default_for_app_calls: T::Boolean,
+              number: String,
+              status: String,
+              updated_at: Time
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_number_created.rbi

@@ -0,0 +1,42 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceNumberCreated < Sentdm::Models::Channels::VoiceNumber
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::VoiceNumberCreated,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # The whsec\_ secret every question to callback_url is signed with. Shown here and
+        # by POST /v3/channels/voice/{number}/rotate-secret, nowhere else: store it now.
+        # Verify a question exactly as you verify a webhook, with X-Webhook-ID,
+        # X-Webhook-Timestamp and the body.
+        sig { returns(T.nilable(String)) }
+        attr_reader :callback_secret
+
+        sig { params(callback_secret: String).void }
+        attr_writer :callback_secret
+
+        # One number the profile carries phone calls on.
+        sig { params(callback_secret: String).returns(T.attached_class) }
+        def self.new(
+          # The whsec\_ secret every question to callback_url is signed with. Shown here and
+          # by POST /v3/channels/voice/{number}/rotate-secret, nowhere else: store it now.
+          # Verify a question exactly as you verify a webhook, with X-Webhook-ID,
+          # X-Webhook-Timestamp and the body.
+          callback_secret: nil
+        )
+        end
+
+        sig { override.returns({ callback_secret: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_retrieve_params.rbi

@@ -0,0 +1,51 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceRetrieveParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::VoiceRetrieveParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :number
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            number: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(number:, x_profile_id: nil, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              number: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_rotate_secret_params.rbi

@@ -0,0 +1,64 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceRotateSecretParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::VoiceRotateSecretParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :number
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            number: String,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          number:,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              number: String,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_secret.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceSecret < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Channels::VoiceSecret, Sentdm::Internal::AnyHash)
+          end
+
+        # The new whsec\_ secret. The previous one stopped signing the moment this was
+        # returned, so update your backend before the next call reaches it. Shown once.
+        sig { returns(T.nilable(String)) }
+        attr_reader :callback_secret
+
+        sig { params(callback_secret: String).void }
+        attr_writer :callback_secret
+
+        # A freshly rotated callback signing secret
+        sig { params(callback_secret: String).returns(T.attached_class) }
+        def self.new(
+          # The new whsec\_ secret. The previous one stopped signing the moment this was
+          # returned, so update your backend before the next call reaches it. Shown once.
+          callback_secret: nil
+        )
+        end
+
+        sig { override.returns({ callback_secret: String }) }
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_test_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceTestParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Channels::VoiceTestParams, Sentdm::Internal::AnyHash)
+          end
+
+        sig { returns(String) }
+        attr_accessor :number
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :x_profile_id
+
+        sig { params(x_profile_id: String).void }
+        attr_writer :x_profile_id
+
+        sig do
+          params(
+            number: String,
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          number:,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              number: String,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/channels/voice_token.rbi

@@ -0,0 +1,76 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceToken < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Channels::VoiceToken, Sentdm::Internal::AnyHash)
+          end
+
+        # The signed token. Hand it to the client SDK unchanged.
+        sig { returns(T.nilable(String)) }
+        attr_reader :token
+
+        sig { params(token: String).void }
+        attr_writer :token
+
+        # When the token expires (UTC)
+        sig { returns(T.nilable(Time)) }
+        attr_reader :expires_at
+
+        sig { params(expires_at: Time).void }
+        attr_writer :expires_at
+
+        # The identity the token was minted for
+        sig { returns(T.nilable(String)) }
+        attr_reader :identity
+
+        sig { params(identity: String).void }
+        attr_writer :identity
+
+        # The phone number this identity is now bound to, in E.164 format
+        sig { returns(T.nilable(String)) }
+        attr_reader :number
+
+        sig { params(number: String).void }
+        attr_writer :number
+
+        # A short-lived token your app passes to the voice client SDK to register
+        sig do
+          params(
+            token: String,
+            expires_at: Time,
+            identity: String,
+            number: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The signed token. Hand it to the client SDK unchanged.
+          token: nil,
+          # When the token expires (UTC)
+          expires_at: nil,
+          # The identity the token was minted for
+          identity: nil,
+          # The phone number this identity is now bound to, in E.164 format
+          number: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              token: String,
+              expires_at: Time,
+              identity: String,
+              number: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end