sentdm 0.38.1 → 0.39.0

data/rbi/sentdm/models/voice/calls/participant_update_params.rbi

@@ -0,0 +1,96 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      module Calls
+        class ParticipantUpdateParams < Sentdm::Internal::Type::BaseModel
+          extend Sentdm::Internal::Type::RequestParameters::Converter
+          include Sentdm::Internal::Type::RequestParameters
+
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Voice::Calls::ParticipantUpdateParams,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :id
+
+          sig { returns(String) }
+          attr_accessor :participant_id
+
+          # true to mute the participant, false to unmute them
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :muted
+
+          sig { params(muted: T::Boolean).void }
+          attr_writer :muted
+
+          # 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
+
+          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(
+              id: String,
+              participant_id: String,
+              muted: T::Boolean,
+              sandbox: T::Boolean,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            id:,
+            participant_id:,
+            # true to mute the participant, false to unmute them
+            muted: nil,
+            # Sandbox flag - when true, the operation is simulated without side effects Useful
+            # for testing integrations without actual execution
+            sandbox: nil,
+            idempotency_key: nil,
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                participant_id: String,
+                muted: T::Boolean,
+                sandbox: T::Boolean,
+                idempotency_key: String,
+                x_profile_id: String,
+                request_options: Sentdm::RequestOptions
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/voice/calls_list.rbi

@@ -0,0 +1,54 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Voice
+      class CallsList < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(Sentdm::Voice::CallsList, Sentdm::Internal::AnyHash)
+          end
+
+        # The calls on this page, most recent first
+        sig { returns(T.nilable(T::Array[Sentdm::Voice::Call])) }
+        attr_reader :calls
+
+        sig { params(calls: T::Array[Sentdm::Voice::Call::OrHash]).void }
+        attr_writer :calls
+
+        # Pagination metadata for list responses
+        sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+        attr_reader :pagination
+
+        sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+        attr_writer :pagination
+
+        # Paginated list of calls
+        sig do
+          params(
+            calls: T::Array[Sentdm::Voice::Call::OrHash],
+            pagination: Sentdm::PaginationMeta::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # The calls on this page, most recent first
+          calls: nil,
+          # Pagination metadata for list responses
+          pagination: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              calls: T::Array[Sentdm::Voice::Call],
+              pagination: Sentdm::PaginationMeta
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

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

@@ -2,17 +2,14 @@
 
 module Sentdm
   module Models
-    module Channels
-      class VoiceCreateTokenParams < Sentdm::Internal::Type::BaseModel
+    module Voice
+      class TokenCreateParams < 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
-            )
+            T.any(Sentdm::Voice::TokenCreateParams, Sentdm::Internal::AnyHash)
           end
 
         # Your identifier for the app user, such as an agent or account id. Letters,

data/rbi/sentdm/models/{channels → voice}/voice_token.rbi

@@ -2,14 +2,17 @@
 
 module Sentdm
   module Models
-    module Channels
+    VoiceToken = Voice::VoiceToken
+
+    module Voice
       class VoiceToken < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
-            T.any(Sentdm::Channels::VoiceToken, Sentdm::Internal::AnyHash)
+            T.any(Sentdm::Voice::VoiceToken, Sentdm::Internal::AnyHash)
           end
 
-        # The signed token. Hand it to the client SDK unchanged.
+        # The signed token. Hand it to the client SDK unchanged. Treat it as opaque: read
+        # the identity, number, and expiry from this response, not from the token.
         sig { returns(T.nilable(String)) }
         attr_reader :token
 
@@ -47,7 +50,8 @@ module Sentdm
           ).returns(T.attached_class)
         end
         def self.new(
-          # The signed token. Hand it to the client SDK unchanged.
+          # The signed token. Hand it to the client SDK unchanged. Treat it as opaque: read
+          # the identity, number, and expiry from this response, not from the token.
           token: nil,
           # When the token expires (UTC)
           expires_at: nil,

data/rbi/sentdm/models.rbi

@@ -3,12 +3,6 @@
 module Sentdm
   APIMeta = Sentdm::Models::APIMeta
 
-  APIResponseOfCall = Sentdm::Models::APIResponseOfCall
-
-  APIResponseOfCallRecordings = Sentdm::Models::APIResponseOfCallRecordings
-
-  APIResponseOfCallsList = Sentdm::Models::APIResponseOfCallsList
-
   APIResponseOfContact = Sentdm::Models::APIResponseOfContact
 
   APIResponseOfContactMessageSummary =
@@ -37,34 +31,10 @@ module Sentdm
 
   BrandsBrandData = Sentdm::Models::BrandsBrandData
 
-  Call = Sentdm::Models::Call
-
   CallEvent = Sentdm::Models::CallEvent
 
   CallEventPayload = Sentdm::Models::CallEventPayload
 
-  CallHangupParams = Sentdm::Models::CallHangupParams
-
-  CallListParams = Sentdm::Models::CallListParams
-
-  CallListRecordingsParams = Sentdm::Models::CallListRecordingsParams
-
-  CallParty = Sentdm::Models::CallParty
-
-  CallRecording = Sentdm::Models::CallRecording
-
-  CallRecordings = Sentdm::Models::CallRecordings
-
-  CallRecordParams = Sentdm::Models::CallRecordParams
-
-  CallRetrieveParams = Sentdm::Models::CallRetrieveParams
-
-  Calls = Sentdm::Models::Calls
-
-  CallsList = Sentdm::Models::CallsList
-
-  CallTimelineEntry = Sentdm::Models::CallTimelineEntry
-
   ChannelEvent = Sentdm::Models::ChannelEvent
 
   ChannelEventPayload = Sentdm::Models::ChannelEventPayload
@@ -194,6 +164,8 @@ module Sentdm
 
   UserUpdateRoleParams = Sentdm::Models::UserUpdateRoleParams
 
+  Voice = Sentdm::Models::Voice
+
   WebhookCreateParams = Sentdm::Models::WebhookCreateParams
 
   WebhookDeleteParams = Sentdm::Models::WebhookDeleteParams

data/rbi/sentdm/resources/channels/voice.rbi

@@ -12,8 +12,8 @@ module Sentdm
       # number**: each number you hold can carry phone calls on its own
       # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
       # with its calls, one of them is the default line for calls placed from your app,
-      # and voice tokens are minted under `POST /v3/channels/voice/tokens`. Read your
-      # voice numbers with `GET /v3/channels/voice` and change one with
+      # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+      # numbers with `GET /v3/channels/voice` and change one with
       # `PATCH /v3/channels/voice/{number}`.
       #
       # ## Compliance lives on the market
@@ -134,19 +134,23 @@ module Sentdm
         #
         # ## What it changes
         #
-        # | Body                                          | Effect                                                                                                                                                     |
-        # | --------------------------------------------- | ---------------------------------------------------------------------------------------------------------------------------------------------------------- |
-        # | `"status": "ACTIVE"`                          | turns calls on again for a number you turned off; the callback URL and the secret it had are kept                                                          |
-        # | `"status": "INACTIVE"`                        | turns calls off; the callback URL and the secret stay on the number                                                                                        |
-        # | `"default_for_app_calls": true`               | makes this the line app-originated calls are placed from when a voice token names no number                                                                |
-        # | `"callback_url": "https://example.com/voice"` | replaces where Sent asks what to do with each call on the number; the signing secret is kept, and a number that was waiting for its first URL is turned on |
-        # | key omitted                                   | left exactly as it is                                                                                                                                      |
+        # | Body                                          | Effect                                                                                                       |
+        # | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------ |
+        # | `"status": "ACTIVE"`                          | turns calls on again for a number you turned off; the callback URL and the secret it had are kept            |
+        # | `"status": "INACTIVE"`                        | turns calls off; the callback URL and the secret stay on the number                                          |
+        # | `"default_for_app_calls": true`               | makes this the line app-originated calls are placed from when a voice token names no number                  |
+        # | `"callback_url": "https://example.com/voice"` | replaces where Sent asks what to do with each call on the number; the signing secret and the status are kept |
+        # | key omitted                                   | left exactly as it is                                                                                        |
         #
         # `status` is matched ignoring case. Any combination is accepted:
         # `status: "ACTIVE"` with `default_for_app_calls: true` turns a number on as the
         # new default, and a `callback_url` sent with either status is written too. A body
         # that names none of the three is refused.
         #
+        # A number can be on without a callback URL: calls placed from your app then
+        # connect straight to the number or user they dial, and calls to the number are
+        # declined.
+        #
         # ## What it will refuse
         #
         # **`default_for_app_calls: false` is `400`.** An account with active voice
@@ -160,11 +164,6 @@ module Sentdm
         # **Making an inactive number the default is `400`.** Send `status: "ACTIVE"` in
         # the same call.
         #
-        # A number added without a `callback_url` is `INACTIVE` for that one reason, so
-        # sending it a `callback_url` turns it on by itself, and it becomes your default
-        # line if you have no other active voice number. A number you turned off while it
-        # had a URL stays off.
-        #
         # **A number you never turned voice on for is `404`.** Add it with
         # `POST /v3/channels/voice`.
         #
@@ -242,48 +241,6 @@ module Sentdm
         )
         end
 
-        # Mints a short-lived token for one of your app users. Call this from your backend
-        # and return the token to your app, which passes it to the voice client SDK to
-        # register. The identity is bound to the given number, or to your default app-call
-        # number when omitted, and calls placed by that identity are routed through the
-        # bound number. Minting again re-binds the identity, so an identity can move
-        # between numbers.
-        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(Sentdm::Channels::APIResponseOfVoiceToken)
-        end
-        def create_token(
-          # Body param: 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,
-          # Body param: 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,
-          # Body param: Sandbox flag - when true, the operation is simulated without side
-          # effects Useful for testing integrations without actual execution
-          sandbox: nil,
-          # Body param: Token lifetime in seconds. Defaults to 600 and cannot exceed 3600.
-          ttl: 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.
-          idempotency_key: nil,
-          # Header param: Profile UUID to scope the request to a child profile. Only
-          # organization API keys can use this header. The profile must belong to the
-          # calling organization.
-          x_profile_id: nil,
-          request_options: {}
-        )
-        end
-
         # Generates a new signing secret for the questions Sent sends to this number's
         # callback URL and returns it. The previous secret stops signing immediately, so
         # update your backend before the next call reaches it. The number is the E.164

data/rbi/sentdm/resources/channels.rbi

@@ -12,8 +12,8 @@ module Sentdm
       # number**: each number you hold can carry phone calls on its own
       # (`POST /v3/channels/voice`), each with the callback URL Sent asks what to do
       # with its calls, one of them is the default line for calls placed from your app,
-      # and voice tokens are minted under `POST /v3/channels/voice/tokens`. Read your
-      # voice numbers with `GET /v3/channels/voice` and change one with
+      # and voice tokens are minted with `POST /v3/voice/tokens`. Read your voice
+      # numbers with `GET /v3/channels/voice` and change one with
       # `PATCH /v3/channels/voice/{number}`.
       #
       # ## Compliance lives on the market

data/rbi/sentdm/resources/messages.rbi

@@ -145,6 +145,11 @@ module Sentdm
         # itself is unchanged: the same rules are scored and ranked the same way, with
         # routes pinned to numbers you did not list removed from the running.
         #
+        # Each channel's list is independent: an sms list does not restrict MMS. To choose
+        # the numbers a message may go out from as MMS, name them under mms. MMS sends
+        # from your SMS numbers, so an mms list may name any of your active SMS numbers
+        # whose market carries MMS — the ones listed under mms in your channels.
+        #
         # Every number must be an active sender on your account. The request itself is
         # still accepted (202) if one is not — like every other send-time rule, that is
         # decided per message, so each affected message is recorded BLOCKED with error
@@ -159,7 +164,9 @@ module Sentdm
         #
         # Their presence is also what makes a message eligible for MMS on an auto-detect
         # send: a message with nothing attached is delivered as SMS, because an MMS with
-        # no media is a more expensive text message.
+        # no media is a more expensive text message. For the same reason a send that names
+        # mms in channel with nothing attached, here or on the template, is refused with
+        # a 400.
         #
         # The recipient's carrier fetches each URL after the send is accepted, so it must
         # stay publicly reachable — a link that expires, or one behind auth, arrives as a

data/rbi/sentdm/resources/voice/calls/participants.rbi

@@ -0,0 +1,201 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    class Voice
+      class Calls
+        # Phone calls from the numbers you hold, driven by your own callback URL.
+        #
+        # `POST /v3/channels/voice` enables a number for calls, with the callback URL Sent
+        # asks what to do with each call on it, and `POST /v3/voice/tokens` mints a
+        # short-lived token that lets a user of your app place and receive calls as that
+        # number. When a call arrives or a caller presses a key, a signed question is
+        # POSTed to the callback URL and the answer decides the call;
+        # `POST /v3/channels/voice/{number}/test` checks the URL answers the way we need
+        # before a real call reaches it, and
+        # `POST /v3/channels/voice/{number}/rotate-secret` replaces the signing secret.
+        # The call events themselves (`call.completed` and the rest) arrive through your
+        # webhooks.
+        #
+        # Every call is a record under `/v3/voice/calls`: read it, list its recordings
+        # once one is ready, hang it up, start or stop recording, and add, mute or remove
+        # conference participants while it is live. A leg to a phone number runs for at
+        # most what your balance affords at the destination's rate.
+        class Participants
+          # Mutes or unmutes one participant of the conference room a live call is in, named
+          # by the participant's own call id from the participants list: send muted true to
+          # silence them, muted false to let them be heard again. Muting a participant who
+          # is already muted succeeds, as does unmuting one who is not. A participant who is
+          # not in this call's room answers 404. A call that has ended answers 409, as does
+          # a call that is not in a conference.
+          sig do
+            params(
+              participant_id: String,
+              id: String,
+              muted: T::Boolean,
+              sandbox: T::Boolean,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).void
+          end
+          def update(
+            # Path param: The participant's own call id from the route, as listed by the
+            # participants endpoint, for example call_9f2ab000-0000-4000-8000-000000000002
+            participant_id,
+            # Path param: The call id from the route, as carried by call webhooks and the
+            # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+            id:,
+            # Body param: true to mute the participant, false to unmute them
+            muted: nil,
+            # Body param: Sandbox flag - when true, the operation is simulated without side
+            # effects Useful for testing integrations without actual execution
+            sandbox: 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.
+            idempotency_key: nil,
+            # Header param: Profile UUID to scope the request to a child profile. Only
+            # organization API keys can use this header. The profile must belong to the
+            # calling organization.
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          # Lists who is in the conference room one of your live calls is in: each
+          # participant's own call id, who they are, whether the room mutes them, and how
+          # long they have been connected. The call itself is one of the participants. Use a
+          # participant's id to mute or remove them; it is also a call id, so GET
+          # /v3/voice/calls/{id} accepts it. A call that has ended answers 409, as does a
+          # call that is not in a conference.
+          sig do
+            params(
+              id: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(Sentdm::Voice::Calls::APIResponseOfListOfCallParticipant)
+          end
+          def list(
+            # The call id from the route, as carried by call webhooks and the calls list, for
+            # example call_9f2ab000-0000-4000-8000-000000000001
+            id,
+            # Profile UUID to scope the request to a child profile. Only organization API keys
+            # can use this header. The profile must belong to the calling organization.
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          # Dials one of your app users or a phone number into a call that is in a
+          # conference room, and answers with the participant's own call record. The
+          # participant is a call of their own: it has its own id, can be looked up and hung
+          # up, and is billed and reported through call.completed and call.failed like any
+          # other call. Every participant needs a positive balance. A phone participant is
+          # called from caller_id, which must be one of your numbers, or from the call's
+          # owning number when omitted, and needs a destination you may call. Only a call
+          # your answer connected to a conference can take participants: a call connected to
+          # a user or a number answers 409.
+          sig do
+            params(
+              id: String,
+              caller_id: T.nilable(String),
+              sandbox: T::Boolean,
+              to: Sentdm::Voice::Calls::CallParticipantTarget::OrHash,
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).returns(Sentdm::Voice::APIResponseOfCall)
+          end
+          def add(
+            # Path param: The call id from the route, as carried by call webhooks and the
+            # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+            id,
+            # Body param: 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
+            caller_id: 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: A participant to add to a call
+            to: 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.
+            idempotency_key: nil,
+            # Header param: Profile UUID to scope the request to a child profile. Only
+            # organization API keys can use this header. The profile must belong to the
+            # calling organization.
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          # Removes one participant from the conference room a live call is in, named by the
+          # participant's own call id from the participants list. Their leg ends and is
+          # reported through call.completed like any other call; everyone else stays
+          # connected. A participant who is not in this call's room answers 404. A call that
+          # has ended answers 409, as does a call that is not in a conference.
+          sig do
+            params(
+              participant_id: String,
+              id: String,
+              sandbox: T::Boolean,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).void
+          end
+          def remove(
+            # Path param: The participant's own call id from the route, as listed by the
+            # participants endpoint, for example call_9f2ab000-0000-4000-8000-000000000002
+            participant_id,
+            # Path param: The call id from the route, as carried by call webhooks and the
+            # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+            id:,
+            # Body param: Sandbox flag - when true, the operation is simulated without side
+            # effects Useful for testing integrations without actual execution
+            sandbox: nil,
+            # Header param: Profile UUID to scope the request to a child profile. Only
+            # organization API keys can use this header. The profile must belong to the
+            # calling organization.
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          # Removes every participant from the conference room a live call is in, the call
+          # itself included. Every leg ends and is reported through call.completed like any
+          # other call. A room that is already empty answers 204 as well. A call that has
+          # ended answers 409, as does a call that is not in a conference.
+          sig do
+            params(
+              id: String,
+              sandbox: T::Boolean,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions::OrHash
+            ).void
+          end
+          def remove_all(
+            # Path param: The call id from the route, as carried by call webhooks and the
+            # calls list, for example call_9f2ab000-0000-4000-8000-000000000001
+            id,
+            # Body param: Sandbox flag - when true, the operation is simulated without side
+            # effects Useful for testing integrations without actual execution
+            sandbox: nil,
+            # Header param: Profile UUID to scope the request to a child profile. Only
+            # organization API keys can use this header. The profile must belong to the
+            # calling organization.
+            x_profile_id: nil,
+            request_options: {}
+          )
+          end
+
+          # @api private
+          sig { params(client: Sentdm::Client).returns(T.attached_class) }
+          def self.new(client:)
+          end
+        end
+      end
+    end
+  end
+end