sentdm 0.39.0 → 0.40.0

data/rbi/sentdm/models/webhook_response.rbi

@@ -14,6 +14,8 @@ module Sentdm
       sig { params(id: String).void }
       attr_writer :id
 
+      # Failed attempts since the last success. Version 1 only: always 0 on a version 2
+      # webhook, whose deliveries are in its events (GET /v3/webhooks/{id}/events).
       sig { returns(T.nilable(Integer)) }
       attr_reader :consecutive_failures
 
@@ -61,9 +63,22 @@ module Sentdm
       sig { params(is_active: T::Boolean).void }
       attr_writer :is_active
 
+      # Whether the webhook also receives its organization's sender profiles' events,
+      # and each profile sees it and reads the events about itself. Always false on a
+      # version 1 webhook.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :is_inheritable
+
+      sig { params(is_inheritable: T::Boolean).void }
+      attr_writer :is_inheritable
+
+      # When the webhook was last attempted. Version 1 only: always null on a version 2
+      # webhook.
       sig { returns(T.nilable(Time)) }
       attr_accessor :last_delivery_attempt_at
 
+      # When the webhook last received an event. Version 1 only: always null on a
+      # version 2 webhook.
       sig { returns(T.nilable(Time)) }
       attr_accessor :last_successful_delivery_at
 
@@ -73,6 +88,22 @@ module Sentdm
       sig { params(retry_count: Integer).void }
       attr_writer :retry_count
 
+      # The events a version 1 webhook's sender profile clones receive, as a response
+      # reports them.
+      #
+      # Its own type, field for field the same as the request's sender_profile. A
+      # response is not a request, whatever it carries.
+      sig { returns(T.nilable(Sentdm::WebhookResponse::SenderProfile)) }
+      attr_reader :sender_profile
+
+      sig do
+        params(
+          sender_profile:
+            T.nilable(Sentdm::WebhookResponse::SenderProfile::OrHash)
+        ).void
+      end
+      attr_writer :sender_profile
+
       sig { returns(T.nilable(String)) }
       attr_accessor :signing_secret
 
@@ -85,6 +116,14 @@ module Sentdm
       sig { returns(T.nilable(Time)) }
       attr_accessor :updated_at
 
+      # Who delivers the webhook: 1 the older delivery, which will be retired, or 2
+      # Svix. A webhook is created as version 2 unless the request asks for 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :webhook_version
+
+      sig { params(webhook_version: Integer).void }
+      attr_writer :webhook_version
+
       sig do
         params(
           id: String,
@@ -96,16 +135,22 @@ module Sentdm
           event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
           event_types: T::Array[String],
           is_active: T::Boolean,
+          is_inheritable: T::Boolean,
           last_delivery_attempt_at: T.nilable(Time),
           last_successful_delivery_at: T.nilable(Time),
           retry_count: Integer,
+          sender_profile:
+            T.nilable(Sentdm::WebhookResponse::SenderProfile::OrHash),
           signing_secret: T.nilable(String),
           timeout_seconds: Integer,
-          updated_at: T.nilable(Time)
+          updated_at: T.nilable(Time),
+          webhook_version: Integer
         ).returns(T.attached_class)
       end
       def self.new(
         id: nil,
+        # Failed attempts since the last success. Version 1 only: always 0 on a version 2
+        # webhook, whose deliveries are in its events (GET /v3/webhooks/{id}/events).
         consecutive_failures: nil,
         created_at: nil,
         # Which customer owns this — the key's own, or the profile named in x-profile-id.
@@ -116,12 +161,29 @@ module Sentdm
         event_filters: nil,
         event_types: nil,
         is_active: nil,
+        # Whether the webhook also receives its organization's sender profiles' events,
+        # and each profile sees it and reads the events about itself. Always false on a
+        # version 1 webhook.
+        is_inheritable: nil,
+        # When the webhook was last attempted. Version 1 only: always null on a version 2
+        # webhook.
         last_delivery_attempt_at: nil,
+        # When the webhook last received an event. Version 1 only: always null on a
+        # version 2 webhook.
         last_successful_delivery_at: nil,
         retry_count: nil,
+        # The events a version 1 webhook's sender profile clones receive, as a response
+        # reports them.
+        #
+        # Its own type, field for field the same as the request's sender_profile. A
+        # response is not a request, whatever it carries.
+        sender_profile: nil,
         signing_secret: nil,
         timeout_seconds: nil,
-        updated_at: nil
+        updated_at: nil,
+        # Who delivers the webhook: 1 the older delivery, which will be retired, or 2
+        # Svix. A webhook is created as version 2 unless the request asks for 1.
+        webhook_version: nil
       )
       end
 
@@ -137,17 +199,64 @@ module Sentdm
             event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
             event_types: T::Array[String],
             is_active: T::Boolean,
+            is_inheritable: T::Boolean,
             last_delivery_attempt_at: T.nilable(Time),
             last_successful_delivery_at: T.nilable(Time),
             retry_count: Integer,
+            sender_profile: T.nilable(Sentdm::WebhookResponse::SenderProfile),
             signing_secret: T.nilable(String),
             timeout_seconds: Integer,
-            updated_at: T.nilable(Time)
+            updated_at: T.nilable(Time),
+            webhook_version: Integer
           }
         )
       end
       def to_hash
       end
+
+      class SenderProfile < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::WebhookResponse::SenderProfile,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :event_filters
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :event_types
+
+        sig { params(event_types: T::Array[String]).void }
+        attr_writer :event_types
+
+        # The events a version 1 webhook's sender profile clones receive, as a response
+        # reports them.
+        #
+        # Its own type, field for field the same as the request's sender_profile. A
+        # response is not a request, whatever it carries.
+        sig do
+          params(
+            event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            event_types: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(event_filters: nil, event_types: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              event_types: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/sentdm/models/webhook_update_params.rbi

@@ -35,6 +35,12 @@ module Sentdm
       sig { params(event_types: T::Array[String]).void }
       attr_writer :event_types
 
+      # 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.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_inheritable
+
       sig { returns(T.nilable(Integer)) }
       attr_reader :retry_count
 
@@ -50,7 +56,8 @@ module Sentdm
       attr_writer :sandbox
 
       # Request-only: the events an organization webhook's sender profile clones
-      # receive, one clone per existing and future profile. Responses never return it.
+      # receive, one clone per existing and future profile. A version 1 webhook's
+      # responses report it as WebhookSenderProfileV3Response.
       sig { returns(T.nilable(Sentdm::WebhookUpdateParams::SenderProfile)) }
       attr_reader :sender_profile
 
@@ -87,6 +94,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:
@@ -103,12 +111,17 @@ module Sentdm
         endpoint_url: nil,
         event_filters: nil,
         event_types: nil,
+        # 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,
         retry_count: nil,
         # Sandbox flag - when true, the operation is simulated without side effects Useful
         # for testing integrations without actual execution
         sandbox: nil,
         # Request-only: the events an organization webhook's sender profile clones
-        # receive, one clone per existing and future profile. Responses never return it.
+        # receive, one clone per existing and future profile. A version 1 webhook's
+        # responses report it as WebhookSenderProfileV3Response.
         sender_profile: nil,
         timeout_seconds: nil,
         idempotency_key: nil,
@@ -125,6 +138,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:
@@ -158,7 +172,8 @@ module Sentdm
         attr_writer :event_types
 
         # Request-only: the events an organization webhook's sender profile clones
-        # receive, one clone per existing and future profile. Responses never return it.
+        # receive, one clone per existing and future profile. A version 1 webhook's
+        # responses report it as WebhookSenderProfileV3Response.
         sig do
           params(
             event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),

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

@@ -44,6 +44,16 @@ module Sentdm
         # question the way you verify a webhook. `POST /v3/channels/voice/{number}/test`
         # sends a test question and reports the verdict.
         #
+        # Send `agent_id` instead of `callback_url`, or with it, to have one of your voice
+        # agents (`GET /v3/voice/agents`) answer calls to the number. The agent wins over
+        # the callback URL for calls to the number; calls your app places from it still
+        # follow your app. `routes_to` in the response says which answers, and reads
+        # `agent_pending` while the number is still being moved to the agent. Calls follow
+        # the move within about an hour, as the provider applies it on its own clock.
+        # While numbers cannot be bound to agents, a request with `agent_id` is refused
+        # with `502` before any number is obtained or anything is written; send
+        # `callback_url` instead.
+        #
         # Your first voice number becomes the line app-originated calls are placed from
         # when a voice token names no number; send `default_for_app_calls: true` to give
         # that role to another number. A number you turned off earlier is turned back on,
@@ -57,8 +67,9 @@ module Sentdm
         # with `202`; nothing is written and no number is bought.
         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,
@@ -68,18 +79,24 @@ module Sentdm
           ).returns(Sentdm::Channels::APIResponseOfVoiceNumberCreated)
         end
         def create(
-          # Body param: 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:,
+          # Body param: 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,
           # Body param: 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,
+          # Body param: 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,
           # Body param: 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.
@@ -134,18 +151,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 and the status are kept |
-        # | 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                                                                                                                                                                                                                                                                                               |
+        # | `"agent_id": "agent_…"`                       | one of your voice agents answers calls to the number, within about an hour of the change (the provider applies the move on its own clock, and `routes_to` reads `agent` as soon as it has recorded it); it wins over `callback_url` for calls to the number, and calls your app places from it still follow your app. `routes_to` reads `agent_pending` while the number is still being moved to the agent |
+        # | `"agent_id": null`                            | unbinds the agent, so `callback_url` answers calls to the number again                                                                                                                                                                                                                                                                                                                                     |
+        # | 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.
+        # new default, and a `callback_url` sent with either status is written too.
+        # `agent_id` is applied first, so a refusal to move the number to or from the
+        # agent leaves everything as it was, and the `409` and `400` refusals below are
+        # decided before anything is written, so they leave everything as it was too. A
+        # body that names none of them 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
@@ -164,8 +186,12 @@ module Sentdm
         # **Making an inactive number the default is `400`.** Send `status: "ACTIVE"` in
         # the same call.
         #
-        # **A number you never turned voice on for is `404`.** Add it with
-        # `POST /v3/channels/voice`.
+        # **A number you never turned voice on for is `404`**, and so is an `agent_id`
+        # that is not one of your agents. Add the number with `POST /v3/channels/voice`.
+        #
+        # **`502` means the number could not be moved to or from the agent**, or an
+        # `agent_id` was sent while numbers cannot be bound to agents; nothing was
+        # written.
         #
         # The number is the E.164 value in the path with the plus sign URL-encoded
         # (`%2B`).
@@ -176,6 +202,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,
@@ -190,6 +217,12 @@ module Sentdm
           # Path param: The number in E.164 format with the plus sign URL-encoded, e.g.
           # %2B12125550100
           number,
+          # Body param: 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,
           # Body param: 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.

data/rbi/sentdm/resources/profiles/campaigns.rbi

@@ -55,8 +55,9 @@ module Sentdm
         # which models a profile's markets, compliance, brand, campaigns and billing
         # explicitly.
         #
-        # Updates an existing campaign under the brand of the specified profile. Cannot
-        # update campaigns that have already been submitted to TCR.
+        # Updates an existing campaign under the brand of the specified profile. Once the
+        # campaign has been submitted to TCR its volume can no longer move between low
+        # volume (under 2,000 messages a day) and high volume.
         sig do
           params(
             campaign_id: String,