sentdm 0.34.0 → 0.36.0

data/lib/sentdm/models/channels/voice_create_token_params.rb

@@ -0,0 +1,69 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#create_token
+      class VoiceCreateTokenParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute identity
+        #   Your identifier for the app user, such as an agent or account id. Letters,
+        #   digits, hyphens and underscores only, up to 200 characters.
+        #
+        #   @return [String, nil]
+        optional :identity, String
+
+        # @!attribute number
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :number, String, nil?: true
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute ttl
+        #   Token lifetime in seconds. Defaults to 600 and cannot exceed 3600.
+        #
+        #   @return [Integer, nil]
+        optional :ttl, Integer, nil?: true
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(identity: nil, number: nil, sandbox: nil, ttl: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceCreateTokenParams} for more details.
+        #
+        #   @param identity [String] Your identifier for the app user, such as an agent or account id. Letters, digit
+        #
+        #   @param number [String, nil] One of your voice-enabled phone numbers in E.164 format. Calls placed by this id
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param ttl [Integer, nil] Token lifetime in seconds. Defaults to 600 and cannot exceed 3600.
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_list_params.rb

@@ -0,0 +1,22 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#list
+      class VoiceListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(x_profile_id: nil, request_options: {})
+        #   @param x_profile_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_number.rb

@@ -0,0 +1,68 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceNumber < Sentdm::Internal::Type::BaseModel
+        # @!attribute callback_url
+        #   Where Sent asks what to do with each call on this number: a signed question is
+        #   POSTed here when a call arrives or a caller presses a key, and the answer
+        #   decides the call. The signing secret is not on this read; it is shown when voice
+        #   is turned on and by the rotate endpoint.
+        #
+        #   @return [String, nil]
+        optional :callback_url, String, nil?: true
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute default_for_app_calls
+        #   Whether this is the line app-originated calls are placed from when a voice token
+        #   names no number. Exactly one active voice number carries it while the profile
+        #   has any.
+        #
+        #   @return [Boolean, nil]
+        optional :default_for_app_calls, Sentdm::Internal::Type::Boolean
+
+        # @!attribute number
+        #   The number, in E.164.
+        #
+        #   @return [String, nil]
+        optional :number, String
+
+        # @!attribute status
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time
+
+        # @!method initialize(callback_url: nil, created_at: nil, default_for_app_calls: nil, number: nil, status: nil, updated_at: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceNumber} for more details.
+        #
+        #   One number the profile carries phone calls on.
+        #
+        #   @param callback_url [String, nil] Where Sent asks what to do with each call on this number: a signed question is P
+        #
+        #   @param created_at [Time]
+        #
+        #   @param default_for_app_calls [Boolean] Whether this is the line app-originated calls are placed from when a voice token
+        #
+        #   @param number [String] The number, in E.164.
+        #
+        #   @param status [String] ACTIVE while the number carries calls, INACTIVE once it was turned off. Nothing
+        #
+        #   @param updated_at [Time]
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_number_created.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceNumberCreated < Sentdm::Models::Channels::VoiceNumber
+        # @!attribute callback_secret
+        #   The whsec\_ secret every question to callback_url is signed with. Shown here and
+        #   by POST /v3/channels/voice/{number}/rotate-secret, nowhere else: store it now.
+        #   Verify a question exactly as you verify a webhook, with X-Webhook-ID,
+        #   X-Webhook-Timestamp and the body.
+        #
+        #   @return [String, nil]
+        optional :callback_secret, String
+
+        # @!method initialize(callback_secret: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceNumberCreated} for more details.
+        #
+        #   One number the profile carries phone calls on.
+        #
+        #   @param callback_secret [String] The whsec\_ secret every question to callback_url is signed with. Shown here and
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_retrieve_params.rb

@@ -0,0 +1,28 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#retrieve
+      class VoiceRetrieveParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute number
+        #
+        #   @return [String]
+        required :number, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(number:, x_profile_id: nil, request_options: {})
+        #   @param number [String]
+        #   @param x_profile_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_rotate_secret_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#rotate_secret
+      class VoiceRotateSecretParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute number
+        #
+        #   @return [String]
+        required :number, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(number:, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   @param number [String]
+        #   @param idempotency_key [String]
+        #   @param x_profile_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_secret.rb

@@ -0,0 +1,25 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceSecret < Sentdm::Internal::Type::BaseModel
+        # @!attribute callback_secret
+        #   The new whsec\_ secret. The previous one stopped signing the moment this was
+        #   returned, so update your backend before the next call reaches it. Shown once.
+        #
+        #   @return [String, nil]
+        optional :callback_secret, String
+
+        # @!method initialize(callback_secret: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceSecret} for more details.
+        #
+        #   A freshly rotated callback signing secret
+        #
+        #   @param callback_secret [String] The new whsec\_ secret. The previous one stopped signing the moment this was
+        #   retu
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_test_params.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#test_
+      class VoiceTestParams < Sentdm::Models::MutationRequest
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute number
+        #
+        #   @return [String]
+        required :number, String
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(number:, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   @param number [String]
+        #   @param idempotency_key [String]
+        #   @param x_profile_id [String]
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_token.rb

@@ -0,0 +1,44 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      class VoiceToken < Sentdm::Internal::Type::BaseModel
+        # @!attribute token
+        #   The signed token. Hand it to the client SDK unchanged.
+        #
+        #   @return [String, nil]
+        optional :token, String
+
+        # @!attribute expires_at
+        #   When the token expires (UTC)
+        #
+        #   @return [Time, nil]
+        optional :expires_at, Time
+
+        # @!attribute identity
+        #   The identity the token was minted for
+        #
+        #   @return [String, nil]
+        optional :identity, String
+
+        # @!attribute number
+        #   The phone number this identity is now bound to, in E.164 format
+        #
+        #   @return [String, nil]
+        optional :number, String
+
+        # @!method initialize(token: nil, expires_at: nil, identity: nil, number: nil)
+        #   A short-lived token your app passes to the voice client SDK to register
+        #
+        #   @param token [String] The signed token. Hand it to the client SDK unchanged.
+        #
+        #   @param expires_at [Time] When the token expires (UTC)
+        #
+        #   @param identity [String] The identity the token was minted for
+        #
+        #   @param number [String] The phone number this identity is now bound to, in E.164 format
+      end
+    end
+  end
+end

data/lib/sentdm/models/channels/voice_update_params.rb

@@ -0,0 +1,95 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Channels
+      # @see Sentdm::Resources::Channels::Voice#update
+      class VoiceUpdateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute number
+        #
+        #   @return [String]
+        required :number, String
+
+        # @!attribute callback_url
+        #   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.
+        #
+        #   @return [String, nil]
+        optional :callback_url, String, nil?: true
+
+        # @!attribute default_for_app_calls
+        #   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.
+        #
+        #   @return [Boolean, nil]
+        optional :default_for_app_calls, Sentdm::Internal::Type::Boolean, nil?: true
+
+        # @!attribute sandbox
+        #   Sandbox flag - when true, the operation is simulated without side effects Useful
+        #   for testing integrations without actual execution
+        #
+        #   @return [Boolean, nil]
+        optional :sandbox, Sentdm::Internal::Type::Boolean
+
+        # @!attribute status
+        #   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.
+        #
+        #   @return [Symbol, Sentdm::Models::Channels::VoiceUpdateParams::Status, nil]
+        optional :status, enum: -> { Sentdm::Channels::VoiceUpdateParams::Status }, nil?: true
+
+        # @!attribute idempotency_key
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!attribute x_profile_id
+        #
+        #   @return [String, nil]
+        optional :x_profile_id, String
+
+        # @!method initialize(number:, callback_url: nil, default_for_app_calls: nil, sandbox: nil, status: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Channels::VoiceUpdateParams} for more details.
+        #
+        #   @param number [String]
+        #
+        #   @param callback_url [String, nil] A new callback URL for the number, active or not: an absolute HTTP or HTTPS URL
+        #
+        #   @param default_for_app_calls [Boolean, nil] true makes this the line app-originated calls are placed from when a voice token
+        #
+        #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
+        #
+        #   @param status [Symbol, Sentdm::Models::Channels::VoiceUpdateParams::Status, nil] ACTIVE turns calls on for the number again, INACTIVE turns them off. Matched
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param x_profile_id [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+        # 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
+
+          # 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 = :ACTIVE
+
+          # 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 = :INACTIVE
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/message_event_payload.rb

@@ -72,14 +72,19 @@ module Sentdm
       # @!attribute schedule_reason
       #   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.
       #
       #   @return [String, nil]
       optional :schedule_reason, String, nil?: true
 
       # @!attribute scheduled_at
-      #   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.
       #
       #   @return [String, nil]
       optional :scheduled_at, String, nil?: true
@@ -131,7 +136,7 @@ module Sentdm
       #
       #   @param schedule_reason [String, nil] message.scheduled only: why the message is held, either because you scheduled it
       #
-      #   @param scheduled_at [String, nil] message.scheduled only: when the held message will be released for delivery, in
+      #   @param scheduled_at [String, nil] message.scheduled and message.cancelled only, in UTC (yyyy-MM-ddTHH:mm:ssZ): on
       #
       #   @param template_id [String, nil] The template the message was sent from, when it was sent from one.
       #

data/lib/sentdm/models/message_retrieve_activities_response.rb

@@ -116,10 +116,12 @@ module Sentdm
           optional :reason_code, String, nil?: true
 
           # @!attribute scheduled_at
-          #   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.
           #
           #   @return [Time, nil]
           optional :scheduled_at, Time, nil?: true
@@ -161,7 +163,7 @@ module Sentdm
           #   @param reason_code [String, nil] Why the message reached this status, as a stable platform code such as
           #   DELIVERY\_
           #
-          #   @param scheduled_at [Time, nil] SCHEDULED activities only: when the held message will be released for delivery,
+          #   @param scheduled_at [Time, nil] SCHEDULED and CANCELLED activities only, in UTC: on a SCHEDULED entry, when the
           #
           #   @param status [String] Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT, DELIVERED
           #