sentdm 0.38.1 → 0.40.0

data/rbi/sentdm/models/call_event_payload.rbi

@@ -20,6 +20,10 @@ module Sentdm
       sig { params(account_id: String).void }
       attr_writer :account_id
 
+      # The voice agent that answers the call, agent\_…. Only on an agent call.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :agent_id
+
       # Always voice.
       sig { returns(T.nilable(String)) }
       attr_reader :channel
@@ -31,6 +35,14 @@ module Sentdm
       sig { returns(T.nilable(Integer)) }
       attr_accessor :duration_seconds
 
+      # inapp, a call routed by the number's callback URL, or agent, a call one of the
+      # account's voice agents answers. The same value GET /v3/voice/calls returns.
+      sig { returns(T.nilable(String)) }
+      attr_reader :mode
+
+      sig { params(mode: String).void }
+      attr_writer :mode
+
       # The customer number that owns the call, in E.164 format.
       sig { returns(T.nilable(String)) }
       attr_reader :number
@@ -48,8 +60,9 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :reason
 
-      # The recording that became available, the same id GET /v3/calls/{id}/recordings
-      # lists it under. Only on call.recording_ready, which is sent once per recording.
+      # The recording that became available, the same id GET
+      # /v3/voice/calls/{id}/recordings lists it under. Only on call.recording_ready,
+      # which is sent once per recording.
       sig { returns(T.nilable(String)) }
       attr_accessor :recording_id
 
@@ -60,15 +73,17 @@ module Sentdm
       sig { params(updated_at: String).void }
       attr_writer :updated_at
 
-      # Body of a call.initiated, call.answered, call.completed, call.failed or
-      # call.recording_ready event. Which of them occurred is the envelope's event.
+      # Body of a call.initiated, call.answered, call.agent_connected, call.completed,
+      # call.failed or call.recording_ready event. Which of them occurred is the
+      # envelope's event.
       #
       # Shaped like the message, inbound, template and channel payloads: account_id
       # names the account the event is about, channel names the channel, and updated_at
       # is when the change happened on the call, in the same yyyy-MM-ddTHH:mm:ssZ form.
-      # duration_seconds and price are added on call.completed, reason on call.failed
-      # and recording_id on call.recording_ready; each is omitted rather than sent as
-      # null when it does not apply.
+      # Every event says how the call is handled in mode, and an agent call names its
+      # agent in agent_id. duration_seconds and price are added on call.completed,
+      # reason on call.failed and recording_id on call.recording_ready; each is omitted
+      # rather than sent as null when it does not apply.
       #
       # Casing is snake_case because these ride the same webhook stream customers
       # already parse message_id from; the question/answer contract is a separate
@@ -78,8 +93,10 @@ module Sentdm
         params(
           call_id: String,
           account_id: String,
+          agent_id: T.nilable(String),
           channel: String,
           duration_seconds: T.nilable(Integer),
+          mode: String,
           number: String,
           price: T.nilable(Float),
           reason: T.nilable(String),
@@ -93,10 +110,15 @@ module Sentdm
         # The account the call belongs to: the key's own customer, or the sender profile
         # it acted as.
         account_id: nil,
+        # The voice agent that answers the call, agent\_…. Only on an agent call.
+        agent_id: nil,
         # Always voice.
         channel: nil,
         # How long the call lasted. Only on call.completed.
         duration_seconds: nil,
+        # inapp, a call routed by the number's callback URL, or agent, a call one of the
+        # account's voice agents answers. The same value GET /v3/voice/calls returns.
+        mode: nil,
         # The customer number that owns the call, in E.164 format.
         number: nil,
         # What the call was charged. Only on call.completed, and omitted there until
@@ -105,8 +127,9 @@ module Sentdm
         # The machine-readable reason the call did not complete. Only on call.failed, and
         # omitted when no reason was recorded.
         reason: nil,
-        # The recording that became available, the same id GET /v3/calls/{id}/recordings
-        # lists it under. Only on call.recording_ready, which is sent once per recording.
+        # The recording that became available, the same id GET
+        # /v3/voice/calls/{id}/recordings lists it under. Only on call.recording_ready,
+        # which is sent once per recording.
         recording_id: nil,
         # When the change happened on the call, as opposed to when the event was emitted.
         updated_at: nil
@@ -118,8 +141,10 @@ module Sentdm
           {
             call_id: String,
             account_id: String,
+            agent_id: T.nilable(String),
             channel: String,
             duration_seconds: T.nilable(Integer),
+            mode: String,
             number: String,
             price: T.nilable(Float),
             reason: T.nilable(String),

data/rbi/sentdm/models/channels/voice_create_params.rbi

@@ -15,14 +15,13 @@ module Sentdm
             )
           end
 
-        # Where Sent asks what to do with each call on this number: an absolute HTTP or
-        # HTTPS URL on a public host. A signed question is POSTed here when a call arrives
-        # or a caller presses a key, and the answer decides the call. Every question is
-        # signed with the callback_secret the response returns, the same way your webhooks
-        # are signed. Turning the number on again with a different URL replaces it and
-        # keeps the secret.
-        sig { returns(String) }
-        attr_accessor :callback_url
+        # One of your voice agents (GET /v3/voice/agents), such as
+        # agent_9f2ab000-0000-4000-8000-000000000001, to answer calls to this number. It
+        # wins over callback_url for calls to the number, and both may be sent; calls your
+        # app places from the number still follow your app. Send it instead of
+        # callback_url for a number only an agent answers.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :agent_id
 
         # The US area code a new number should be in, as 212. Only for a request that
         # leaves number out — sending both says two different things about which number to
@@ -31,6 +30,15 @@ module Sentdm
         sig { returns(T.nilable(String)) }
         attr_accessor :area_code
 
+        # Where Sent asks what to do with each call on this number: an absolute HTTP or
+        # HTTPS URL on a public host. A signed question is POSTed here when a call arrives
+        # or a caller presses a key, and the answer decides the call. Every question is
+        # signed with the callback_secret the response returns, the same way your webhooks
+        # are signed. Turning the number on again with a different URL replaces it and
+        # keeps the secret. Required unless agent_id is sent.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :callback_url
+
         # Make this the line app-originated calls are placed from when a voice token names
         # no number. Omit it and your first voice number takes that role; a later one
         # leaves it where it is.
@@ -65,8 +73,9 @@ module Sentdm
 
         sig do
           params(
-            callback_url: String,
+            agent_id: T.nilable(String),
             area_code: T.nilable(String),
+            callback_url: T.nilable(String),
             default_for_app_calls: T.nilable(T::Boolean),
             number: T.nilable(String),
             sandbox: T::Boolean,
@@ -76,18 +85,24 @@ module Sentdm
           ).returns(T.attached_class)
         end
         def self.new(
-          # Where Sent asks what to do with each call on this number: an absolute HTTP or
-          # HTTPS URL on a public host. A signed question is POSTed here when a call arrives
-          # or a caller presses a key, and the answer decides the call. Every question is
-          # signed with the callback_secret the response returns, the same way your webhooks
-          # are signed. Turning the number on again with a different URL replaces it and
-          # keeps the secret.
-          callback_url:,
+          # One of your voice agents (GET /v3/voice/agents), such as
+          # agent_9f2ab000-0000-4000-8000-000000000001, to answer calls to this number. It
+          # wins over callback_url for calls to the number, and both may be sent; calls your
+          # app places from the number still follow your app. Send it instead of
+          # callback_url for a number only an agent answers.
+          agent_id: nil,
           # The US area code a new number should be in, as 212. Only for a request that
           # leaves number out — sending both says two different things about which number to
           # use, and is refused. Omit it too and the number comes from anywhere in the
           # country.
           area_code: nil,
+          # Where Sent asks what to do with each call on this number: an absolute HTTP or
+          # HTTPS URL on a public host. A signed question is POSTed here when a call arrives
+          # or a caller presses a key, and the answer decides the call. Every question is
+          # signed with the callback_secret the response returns, the same way your webhooks
+          # are signed. Turning the number on again with a different URL replaces it and
+          # keeps the secret. Required unless agent_id is sent.
+          callback_url: nil,
           # Make this the line app-originated calls are placed from when a voice token names
           # no number. Omit it and your first voice number takes that role; a later one
           # leaves it where it is.
@@ -108,8 +123,9 @@ module Sentdm
         sig do
           override.returns(
             {
-              callback_url: String,
+              agent_id: T.nilable(String),
               area_code: T.nilable(String),
+              callback_url: T.nilable(String),
               default_for_app_calls: T.nilable(T::Boolean),
               number: T.nilable(String),
               sandbox: T::Boolean,

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

@@ -9,6 +9,13 @@ module Sentdm
             T.any(Sentdm::Channels::VoiceNumber, Sentdm::Internal::AnyHash)
           end
 
+        # The voice agent calls to this number go to, such as
+        # agent_9f2ab000-0000-4000-8000-000000000001. It wins over callback_url for calls
+        # to the number; calls your app places from the number still follow your app. Null
+        # when no agent answers the number.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :agent_id
+
         # 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
@@ -38,6 +45,16 @@ module Sentdm
         sig { params(number: String).void }
         attr_writer :number
 
+        # Who answers calls to this number: agent, the voice agent in agent_id;
+        # agent_pending, that agent once the number has finished moving to it, with calls
+        # possibly unanswered until then; callback, your callback_url; or none, in which
+        # case calls to it are declined.
+        sig { returns(T.nilable(String)) }
+        attr_reader :routes_to
+
+        sig { params(routes_to: String).void }
+        attr_writer :routes_to
+
         # 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.
@@ -56,15 +73,22 @@ module Sentdm
         # One number the profile carries phone calls on.
         sig do
           params(
+            agent_id: T.nilable(String),
             callback_url: T.nilable(String),
             created_at: Time,
             default_for_app_calls: T::Boolean,
             number: String,
+            routes_to: String,
             status: String,
             updated_at: Time
           ).returns(T.attached_class)
         end
         def self.new(
+          # The voice agent calls to this number go to, such as
+          # agent_9f2ab000-0000-4000-8000-000000000001. It wins over callback_url for calls
+          # to the number; calls your app places from the number still follow your app. Null
+          # when no agent answers the number.
+          agent_id: nil,
           # 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
@@ -77,6 +101,11 @@ module Sentdm
           default_for_app_calls: nil,
           # The number, in E.164.
           number: nil,
+          # Who answers calls to this number: agent, the voice agent in agent_id;
+          # agent_pending, that agent once the number has finished moving to it, with calls
+          # possibly unanswered until then; callback, your callback_url; or none, in which
+          # case calls to it are declined.
+          routes_to: 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.
@@ -88,10 +117,12 @@ module Sentdm
         sig do
           override.returns(
             {
+              agent_id: T.nilable(String),
               callback_url: T.nilable(String),
               created_at: Time,
               default_for_app_calls: T::Boolean,
               number: String,
+              routes_to: String,
               status: String,
               updated_at: Time
             }

data/rbi/sentdm/models/channels/voice_update_params.rbi

@@ -18,6 +18,13 @@ module Sentdm
         sig { returns(String) }
         attr_accessor :number
 
+        # One of your voice agents, such as agent_9f2ab000-0000-4000-8000-000000000001, to
+        # answer calls to the number, or null to unbind it so the callback URL answers
+        # them again. The agent wins over callback_url for calls to the number; calls your
+        # app places from it still follow your app.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :agent_id
+
         # A new callback URL for the number, active or not: an absolute HTTP or HTTPS URL
         # on a public host, where Sent asks what to do with each call. The signing secret
         # is kept.
@@ -63,6 +70,7 @@ module Sentdm
         sig do
           params(
             number: String,
+            agent_id: T.nilable(String),
             callback_url: T.nilable(String),
             default_for_app_calls: T.nilable(T::Boolean),
             sandbox: T::Boolean,
@@ -75,6 +83,11 @@ module Sentdm
         end
         def self.new(
           number:,
+          # One of your voice agents, such as agent_9f2ab000-0000-4000-8000-000000000001, to
+          # answer calls to the number, or null to unbind it so the callback URL answers
+          # them again. The agent wins over callback_url for calls to the number; calls your
+          # app places from it still follow your app.
+          agent_id: nil,
           # A new callback URL for the number, active or not: an absolute HTTP or HTTPS URL
           # on a public host, where Sent asks what to do with each call. The signing secret
           # is kept.
@@ -100,6 +113,7 @@ module Sentdm
           override.returns(
             {
               number: String,
+              agent_id: T.nilable(String),
               callback_url: T.nilable(String),
               default_for_app_calls: T.nilable(T::Boolean),
               sandbox: T::Boolean,

data/rbi/sentdm/models/message_send_params.rbi

@@ -31,6 +31,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
@@ -53,7 +58,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
@@ -164,6 +171,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
@@ -178,7 +190,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/models/template.rbi

@@ -41,17 +41,18 @@ module Sentdm
       attr_writer :category
 
       # The channels this template's definition can render on, in canonical order: sms,
-      # whatsapp, rcs.
+      # whatsapp, rcs, mms.
       #
       # Derived from the definition's body, mirroring each channel's send-time fallback
       # chain, so a channel is listed only when a real body would be produced for it:
       # SMS reads sms ?? multiChannel, WhatsApp reads whatsapp ?? multiChannel, and RCS
-      # reads rcs ?? multiChannel ?? sms. A multiChannel body therefore reports all
-      # three, and the extra SMS fallback on RCS is why an sms/whatsapp pair reports RCS
-      # too.
+      # and MMS read rcs ?? multiChannel ?? sms and mms ?? multiChannel ?? sms. A
+      # multiChannel body therefore reports all four, and the extra SMS fallback is why
+      # an sms/whatsapp pair reports RCS and MMS too.
       #
       # This says what the content can render on, not what may be sent: sending also
-      # needs the template approved for that channel.
+      # needs the template approved for that channel, and MMS needs an attachment, from
+      # media_urls or the template's mms body.
       sig { returns(T.nilable(T::Array[String])) }
       attr_accessor :channels
 
@@ -138,17 +139,18 @@ module Sentdm
         # Template category: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
         # The channels this template's definition can render on, in canonical order: sms,
-        # whatsapp, rcs.
+        # whatsapp, rcs, mms.
         #
         # Derived from the definition's body, mirroring each channel's send-time fallback
         # chain, so a channel is listed only when a real body would be produced for it:
         # SMS reads sms ?? multiChannel, WhatsApp reads whatsapp ?? multiChannel, and RCS
-        # reads rcs ?? multiChannel ?? sms. A multiChannel body therefore reports all
-        # three, and the extra SMS fallback on RCS is why an sms/whatsapp pair reports RCS
-        # too.
+        # and MMS read rcs ?? multiChannel ?? sms and mms ?? multiChannel ?? sms. A
+        # multiChannel body therefore reports all four, and the extra SMS fallback is why
+        # an sms/whatsapp pair reports RCS and MMS too.
         #
         # This says what the content can render on, not what may be sent: sending also
-        # needs the template approved for that channel.
+        # needs the template approved for that channel, and MMS needs an attachment, from
+        # media_urls or the template's mms body.
         channels: nil,
         # When the template was created
         created_at: nil,

data/rbi/sentdm/models/template_body.rbi

@@ -9,10 +9,10 @@ module Sentdm
       # MMS-specific content — subject, text and attachments.
       #
       # Like Rcs, an override that cannot stand on its own: a template still needs a
-      # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Unlike
-      # Rcs, it has no fallback at send time — MMS with no media is a more expensive
-      # SMS, so a template without this slot is deliberately not MMS-capable and never
-      # produces an MMS route candidate.
+      # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Without
+      # this slot MMS renders the shared or SMS body, so it is only needed for
+      # MMS-specific copy, a subject or attachments. When present it replaces that body
+      # on MMS rather than adding to it.
       sig { returns(T.nilable(Sentdm::TemplateBody::Mms)) }
       attr_reader :mms
 
@@ -78,10 +78,10 @@ module Sentdm
         # MMS-specific content — subject, text and attachments.
         #
         # Like Rcs, an override that cannot stand on its own: a template still needs a
-        # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Unlike
-        # Rcs, it has no fallback at send time — MMS with no media is a more expensive
-        # SMS, so a template without this slot is deliberately not MMS-capable and never
-        # produces an MMS route candidate.
+        # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Without
+        # this slot MMS renders the shared or SMS body, so it is only needed for
+        # MMS-specific copy, a subject or attachments. When present it replaces that body
+        # on MMS rather than adding to it.
         mms: nil,
         # The shared body, used for every channel. One half of the choice described above.
         multi_channel: nil,
@@ -134,10 +134,10 @@ module Sentdm
         # MMS-specific content — subject, text and attachments.
         #
         # Like Rcs, an override that cannot stand on its own: a template still needs a
-        # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Unlike
-        # Rcs, it has no fallback at send time — MMS with no media is a more expensive
-        # SMS, so a template without this slot is deliberately not MMS-capable and never
-        # produces an MMS route candidate.
+        # MultiChannel body or the Sms + Whatsapp pair to be deliverable at all. Without
+        # this slot MMS renders the shared or SMS body, so it is only needed for
+        # MMS-specific copy, a subject or attachments. When present it replaces that body
+        # on MMS rather than adding to it.
         sig do
           params(
             media: