sentdm 0.34.0 → 0.36.0

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

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

@@ -0,0 +1,158 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Channels::VoiceUpdateParams,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(String) }
+        attr_accessor :number
+
+        # 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.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :callback_url
+
+        # true makes this the line app-originated calls are placed from when a voice token
+        # names no number. false is refused: an account with active voice numbers always
+        # has exactly one default, so the default moves by giving it to another number.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :default_for_app_calls
+
+        # 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
+
+        # ACTIVE turns calls on for the number again, INACTIVE turns them off. Matched
+        # ignoring case. Turning the default line off is refused while other active voice
+        # numbers remain.
+        sig do
+          returns(
+            T.nilable(Sentdm::Channels::VoiceUpdateParams::Status::OrSymbol)
+          )
+        end
+        attr_accessor :status
+
+        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,
+            callback_url: T.nilable(String),
+            default_for_app_calls: T.nilable(T::Boolean),
+            sandbox: T::Boolean,
+            status:
+              T.nilable(Sentdm::Channels::VoiceUpdateParams::Status::OrSymbol),
+            idempotency_key: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          number:,
+          # 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.
+          callback_url: nil,
+          # true makes this the line app-originated calls are placed from when a voice token
+          # names no number. false is refused: an account with active voice numbers always
+          # has exactly one default, so the default moves by giving it to another number.
+          default_for_app_calls: nil,
+          # Sandbox flag - when true, the operation is simulated without side effects Useful
+          # for testing integrations without actual execution
+          sandbox: nil,
+          # ACTIVE turns calls on for the number again, INACTIVE turns them off. Matched
+          # ignoring case. Turning the default line off is refused while other active voice
+          # numbers remain.
+          status: nil,
+          idempotency_key: nil,
+          x_profile_id: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              number: String,
+              callback_url: T.nilable(String),
+              default_for_app_calls: T.nilable(T::Boolean),
+              sandbox: T::Boolean,
+              status:
+                T.nilable(
+                  Sentdm::Channels::VoiceUpdateParams::Status::OrSymbol
+                ),
+              idempotency_key: String,
+              x_profile_id: String,
+              request_options: Sentdm::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # ACTIVE turns calls on for the number again, INACTIVE turns them off. Matched
+        # ignoring case. Turning the default line off is refused while other active voice
+        # numbers remain.
+        module Status
+          extend Sentdm::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, Sentdm::Channels::VoiceUpdateParams::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          # Turns calls on for the number again. The callback URL and the signing secret it had are kept; send `callback_url` in the same call to replace the URL.
+          ACTIVE =
+            T.let(
+              :ACTIVE,
+              Sentdm::Channels::VoiceUpdateParams::Status::TaggedSymbol
+            )
+
+          # Turns calls off for the number. Refused while the number is the default line for app calls and other active voice numbers remain; move the default first. The callback URL and the secret stay on the number.
+          INACTIVE =
+            T.let(
+              :INACTIVE,
+              Sentdm::Channels::VoiceUpdateParams::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                Sentdm::Channels::VoiceUpdateParams::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_event_payload.rbi

@@ -70,12 +70,17 @@ module Sentdm
 
       # message.scheduled only: why the message is held, either because you scheduled it
       # or because the recipient is inside a protected quiet-hours window. Omitted on
-      # every other event.
+      # every other event, including message.cancelled — that is a property of the hold,
+      # not of the cancellation, and repeating it there would read as "why was this
+      # cancelled", which it does not answer.
       sig { returns(T.nilable(String)) }
       attr_accessor :schedule_reason
 
-      # message.scheduled only: when the held message will be released for delivery, in
-      # UTC (yyyy-MM-ddTHH:mm:ssZ). Omitted on every other event.
+      # message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
+      # message.scheduled it is when the held message will be released for delivery, on
+      # message.cancelled the release instant that was called off — the same instant,
+      # before and after. A consumer that recorded a future send from the first event
+      # has what it needs to un-record it from the second. Omitted on every other event.
       sig { returns(T.nilable(String)) }
       attr_accessor :scheduled_at
 
@@ -149,10 +154,15 @@ module Sentdm
         reason_code: nil,
         # message.scheduled only: why the message is held, either because you scheduled it
         # or because the recipient is inside a protected quiet-hours window. Omitted on
-        # every other event.
+        # every other event, including message.cancelled — that is a property of the hold,
+        # not of the cancellation, and repeating it there would read as "why was this
+        # cancelled", which it does not answer.
         schedule_reason: nil,
-        # message.scheduled only: when the held message will be released for delivery, in
-        # UTC (yyyy-MM-ddTHH:mm:ssZ). Omitted on every other event.
+        # message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
+        # message.scheduled it is when the held message will be released for delivery, on
+        # message.cancelled the release instant that was called off — the same instant,
+        # before and after. A consumer that recorded a future send from the first event
+        # has what it needs to un-record it from the second. Omitted on every other event.
         scheduled_at: nil,
         # The template the message was sent from, when it was sent from one.
         template_id: nil,

data/rbi/sentdm/models/message_retrieve_activities_response.rbi

@@ -216,10 +216,12 @@ module Sentdm
           sig { returns(T.nilable(String)) }
           attr_accessor :reason_code
 
-          # SCHEDULED activities only: when the held message will be released for delivery,
-          # in UTC. Same wire name as on the send response, the message and the webhook.
-          # Omitted on every other activity. A message that quiet hours moved at release has
-          # two SCHEDULED entries, each carrying the instant as it stood at that moment.
+          # SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+          # held message will be released for delivery; on a CANCELLED entry, the instant
+          # that was called off. Same wire name as on the send response, the message and the
+          # webhook. Omitted on every other activity. A message that quiet hours moved at
+          # release has two SCHEDULED entries, each carrying the instant as it stood at that
+          # moment.
           sig { returns(T.nilable(Time)) }
           attr_accessor :scheduled_at
 
@@ -278,10 +280,12 @@ module Sentdm
             # rather than on reason: the code is stable, the wording may be improved. Same
             # wire name and vocabulary as on the message and the webhook.
             reason_code: nil,
-            # SCHEDULED activities only: when the held message will be released for delivery,
-            # in UTC. Same wire name as on the send response, the message and the webhook.
-            # Omitted on every other activity. A message that quiet hours moved at release has
-            # two SCHEDULED entries, each carrying the instant as it stood at that moment.
+            # SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
+            # held message will be released for delivery; on a CANCELLED entry, the instant
+            # that was called off. Same wire name as on the send response, the message and the
+            # webhook. Omitted on every other activity. A message that quiet hours moved at
+            # release has two SCHEDULED entries, each carrying the instant as it stood at that
+            # moment.
             scheduled_at: nil,
             # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
             # DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).

data/rbi/sentdm/models/webhook_list_events_response.rbi

@@ -74,7 +74,7 @@ module Sentdm
               Sentdm::ChannelEvent::OrHash,
               Sentdm::ContactEvent::OrHash,
               Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::OrHash,
-              Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::OrHash
+              Sentdm::CallEvent::OrHash
             )
         ).void
       end
@@ -113,7 +113,7 @@ module Sentdm
               Sentdm::ChannelEvent::OrHash,
               Sentdm::ContactEvent::OrHash,
               Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload::OrHash,
-              Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::OrHash
+              Sentdm::CallEvent::OrHash
             ),
           event_type: String,
           http_status_code: T.nilable(Integer),
@@ -204,7 +204,7 @@ module Sentdm
               Sentdm::ChannelEvent,
               Sentdm::ContactEvent,
               Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfLinkWebhookPayload,
-              Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload
+              Sentdm::CallEvent
             )
           end
 
@@ -632,272 +632,6 @@ module Sentdm
           end
         end
 
-        class SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          # The specific event within the family, for example message.delivered,
-          # message.received or contact.opt_out. Absent on events that have no subtype, so
-          # treat it as optional.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :event
-
-          # The event family, for example message, templates or contact. Route on this
-          # first, then on event for the specific change.
-          sig { returns(T.nilable(String)) }
-          attr_reader :field
-
-          sig { params(field: String).void }
-          attr_writer :field
-
-          # 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.
-          #
-          # 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.
-          #
-          # Casing is snake_case because these ride the same webhook stream customers
-          # already parse message_id from; the question/answer contract is a separate
-          # surface and stays camelCase. Nothing here is provider-shaped: no provider call
-          # id, no namespaced identity.
-          sig do
-            returns(
-              T.nilable(
-                Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload
-              )
-            )
-          end
-          attr_reader :payload
-
-          sig do
-            params(
-              payload:
-                T.nilable(
-                  Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload::OrHash
-                )
-            ).void
-          end
-          attr_writer :payload
-
-          # The event-specific body.
-          sig { returns(T.nilable(String)) }
-          attr_accessor :request_id
-
-          # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
-          # time, not the time the underlying change happened. Use the timestamp inside the
-          # payload for the latter.
-          sig { returns(T.nilable(String)) }
-          attr_reader :timestamp
-
-          sig { params(timestamp: String).void }
-          attr_writer :timestamp
-
-          # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
-          # this shape and varies only in Payload.
-          sig do
-            params(
-              event: T.nilable(String),
-              field: String,
-              payload:
-                T.nilable(
-                  Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload::OrHash
-                ),
-              request_id: T.nilable(String),
-              timestamp: String
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # The specific event within the family, for example message.delivered,
-            # message.received or contact.opt_out. Absent on events that have no subtype, so
-            # treat it as optional.
-            event: nil,
-            # The event family, for example message, templates or contact. Route on this
-            # first, then on event for the specific change.
-            field: nil,
-            # 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.
-            #
-            # 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.
-            #
-            # Casing is snake_case because these ride the same webhook stream customers
-            # already parse message_id from; the question/answer contract is a separate
-            # surface and stays camelCase. Nothing here is provider-shaped: no provider call
-            # id, no namespaced identity.
-            payload: nil,
-            # The event-specific body.
-            request_id: nil,
-            # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
-            # time, not the time the underlying change happened. Use the timestamp inside the
-            # payload for the latter.
-            timestamp: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                event: T.nilable(String),
-                field: String,
-                payload:
-                  T.nilable(
-                    Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload
-                  ),
-                request_id: T.nilable(String),
-                timestamp: String
-              }
-            )
-          end
-          def to_hash
-          end
-
-          class Payload < Sentdm::Internal::Type::BaseModel
-            OrHash =
-              T.type_alias do
-                T.any(
-                  Sentdm::Models::WebhookListEventsResponse::EventData::SentDmServicesCommonServicesWebhooksContractsWebhookEventOfCallWebhookPayload::Payload,
-                  Sentdm::Internal::AnyHash
-                )
-              end
-
-            # Sent's call id, the same one the customer saw on the first question.
-            sig { returns(String) }
-            attr_accessor :call_id
-
-            # The account the call belongs to: the key's own customer, or the sender profile
-            # it acted as.
-            sig { returns(T.nilable(String)) }
-            attr_reader :account_id
-
-            sig { params(account_id: String).void }
-            attr_writer :account_id
-
-            # Always voice.
-            sig { returns(T.nilable(String)) }
-            attr_reader :channel
-
-            sig { params(channel: String).void }
-            attr_writer :channel
-
-            # How long the call lasted. Only on call.completed.
-            sig { returns(T.nilable(Integer)) }
-            attr_accessor :duration_seconds
-
-            # The customer number that owns the call, in E.164 format.
-            sig { returns(T.nilable(String)) }
-            attr_reader :number
-
-            sig { params(number: String).void }
-            attr_writer :number
-
-            # What the call was charged. Only on call.completed, and omitted there until
-            # billing has recorded the charge.
-            sig { returns(T.nilable(Float)) }
-            attr_accessor :price
-
-            # The machine-readable reason the call did not complete. Only on call.failed, and
-            # omitted when no reason was recorded.
-            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.
-            sig { returns(T.nilable(String)) }
-            attr_accessor :recording_id
-
-            # When the change happened on the call, as opposed to when the event was emitted.
-            sig { returns(T.nilable(String)) }
-            attr_reader :updated_at
-
-            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.
-            #
-            # 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.
-            #
-            # Casing is snake_case because these ride the same webhook stream customers
-            # already parse message_id from; the question/answer contract is a separate
-            # surface and stays camelCase. Nothing here is provider-shaped: no provider call
-            # id, no namespaced identity.
-            sig do
-              params(
-                call_id: String,
-                account_id: String,
-                channel: String,
-                duration_seconds: T.nilable(Integer),
-                number: String,
-                price: T.nilable(Float),
-                reason: T.nilable(String),
-                recording_id: T.nilable(String),
-                updated_at: String
-              ).returns(T.attached_class)
-            end
-            def self.new(
-              # Sent's call id, the same one the customer saw on the first question.
-              call_id:,
-              # The account the call belongs to: the key's own customer, or the sender profile
-              # it acted as.
-              account_id: nil,
-              # Always voice.
-              channel: nil,
-              # How long the call lasted. Only on call.completed.
-              duration_seconds: 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
-              # billing has recorded the charge.
-              price: nil,
-              # 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.
-              recording_id: nil,
-              # When the change happened on the call, as opposed to when the event was emitted.
-              updated_at: nil
-            )
-            end
-
-            sig do
-              override.returns(
-                {
-                  call_id: String,
-                  account_id: String,
-                  channel: String,
-                  duration_seconds: T.nilable(Integer),
-                  number: String,
-                  price: T.nilable(Float),
-                  reason: T.nilable(String),
-                  recording_id: T.nilable(String),
-                  updated_at: String
-                }
-              )
-            end
-            def to_hash
-            end
-          end
-        end
-
         sig do
           override.returns(
             T::Array[