sentdm 0.33.0 → 0.35.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/conversation_messages_list.rb

@@ -94,6 +94,24 @@ module Sentdm
         #   @return [Float, nil]
         optional :price, Float, nil?: true
 
+        # @!attribute reason
+        #   A human-readable sentence for reason_code, for example "Insufficient balance".
+        #   Omitted whenever reason_code is.
+        #
+        #   @return [String, nil]
+        optional :reason, String, nil?: true
+
+        # @!attribute reason_code
+        #   Why the message is at its current status, as a stable platform code such as
+        #   DELIVERY_007, BUSINESS_003 or DELIVERY_003. Present when the current status is
+        #   FAILED, FILTERED or BLOCKED and the lifecycle was loaded; omitted otherwise.
+        #   Switch on this rather than on reason: the code is stable, the wording may be
+        #   improved. It is the platform's classification of the outcome, never a carrier or
+        #   vendor code.
+        #
+        #   @return [String, nil]
+        optional :reason_code, String, nil?: true
+
         # @!attribute region_code
         #
         #   @return [String, nil]
@@ -119,7 +137,7 @@ module Sentdm
         #   @return [String, nil]
         optional :template_name, String, nil?: true
 
-        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
+        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, reason: nil, reason_code: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::ConversationMessagesList::Message} for more details.
         #
@@ -154,6 +172,10 @@ module Sentdm
         #
         #   @param price [Float, nil]
         #
+        #   @param reason [String, nil] A human-readable sentence for reason_code, for example "Insufficient balance". O
+        #
+        #   @param reason_code [String, nil] Why the message is at its current status, as a stable platform code such as
+        #
         #   @param region_code [String]
         #
         #   @param status [String]
@@ -180,12 +202,37 @@ module Sentdm
           #   @return [String, nil]
           optional :description, String, nil?: true
 
-          # @!method initialize(status:, timestamp:, description: nil)
+          # @!attribute reason
+          #   A human-readable sentence for reason_code. Omitted whenever reason_code is.
+          #
+          #   @return [String, nil]
+          optional :reason, String, nil?: true
+
+          # @!attribute reason_code
+          #   Why the message reached this status, as a stable platform code such as
+          #   DELIVERY_007. Present on FAILED, FILTERED and BLOCKED events; omitted on every
+          #   status that needs no explanation. Same wire name and vocabulary as on the
+          #   activities list and the webhook.
+          #
+          #   @return [String, nil]
+          optional :reason_code, String, nil?: true
+
+          # @!method initialize(status:, timestamp:, description: nil, reason: nil, reason_code: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::ConversationMessagesList::Message::Event} for more details.
+          #
           #   Represents a status change event in a message's lifecycle (v3)
           #
           #   @param status [String]
+          #
           #   @param timestamp [Time]
+          #
           #   @param description [String, nil]
+          #
+          #   @param reason [String, nil] A human-readable sentence for reason_code. Omitted whenever reason_code is.
+          #
+          #   @param reason_code [String, nil] Why the message reached this status, as a stable platform code such as
+          #   DELIVERY\_
         end
 
         # @see Sentdm::Models::ConversationMessagesList::Message#message_body
@@ -332,32 +379,72 @@ module Sentdm
 
           class Media < Sentdm::Internal::Type::BaseModel
             # @!attribute media_type
-            #   One of Constants.MmsMediaTypes when known. Advisory — the carrier reads the
-            #   fetched object's Content-Type, not this.
+            #   One of MmsMediaTypes when the content type is known. Advisory — a reader should
+            #   trust the fetched object's own Content-Type.
             #
             #   @return [String, nil]
             optional :media_type, String, api_name: :mediaType, nil?: true
 
+            # @!attribute mime_type
+            #   Content type as the provider declared it. Null when it declared none.
+            #
+            #   @return [String, nil]
+            optional :mime_type, String, api_name: :mimeType, nil?: true
+
+            # @!attribute size_bytes
+            #   Size as the provider declared it. Never measured here — nothing downloads the
+            #   file.
+            #
+            #   @return [Integer, nil]
+            optional :size_bytes, Integer, api_name: :sizeBytes, nil?: true
+
+            # @!attribute source_hash_sha256
+            #   Inbound only: the SHA-256 the provider declared alongside the attachment, when
+            #   it declared one. Relayed to the customer so they can verify what they fetch
+            #   matches what the carrier said it sent. It is the only integrity signal available
+            #   on an attachment nobody here has read.
+            #
+            #   @return [String, nil]
+            optional :source_hash_sha256, String, api_name: :sourceHashSha256, nil?: true
+
             # @!attribute url
+            #   Where the file lives. Outbound: the URL the customer gave us and the carrier
+            #   fetched. Inbound: the URL the carrier hosts it at, relayed unchanged.
             #
             #   @return [String, nil]
-            optional :url, String
+            optional :url, String, nil?: true
 
-            # @!method initialize(media_type: nil, url: nil)
+            # @!method initialize(media_type: nil, mime_type: nil, size_bytes: nil, source_hash_sha256: nil, url: nil)
             #   Some parameter documentations has been truncated, see
             #   {Sentdm::Models::ConversationMessagesList::Message::MessageBody::Media} for more
             #   details.
             #
-            #   One attachment on a message: a customer-supplied public URL handed to the
-            #   carrier as-is.
+            #   One attachment on a message, in either direction — and in both, a URL somebody
+            #   else hosts.
+            #
+            #   Outbound: the customer supplied a public URL and we handed it to the carrier.
+            #   Inbound: the carrier hosts the file and we record where. sent.dm never holds the
+            #   bytes, so there is no key, no expiry bookkeeping and nothing minted per read —
+            #   what is stored is what is served.
+            #
+            #   An inbound link expires on the carrier's own schedule and is unauthenticated.
+            #   That is the customer's to manage, and it is documented where they will see it
+            #   rather than only here — a recipient who needs an attachment to outlive that
+            #   window copies it on receipt.
+            #
+            #   Storing a presigned URL is the specific mistake this shape still avoids:
+            #   M260826130000 and M260826140000 exist because RCS assets were stored as signed
+            #   URLs and went stale. Nothing here is signed.
+            #
+            #   @param media_type [String, nil] One of MmsMediaTypes when the content type is known. Advisory — a reader should
+            #
+            #   @param mime_type [String, nil] Content type as the provider declared it. Null when it declared none.
             #
-            #                A URL and nothing else. sent.dm never takes custody of MMS media — the customer hosts it and we
-            #                pass the link through at send time — so there is no storage key, size or expiry to record. If we ever
-            #                do host attachments, that belongs with the change that introduces the hosting, not here.
+            #   @param size_bytes [Integer, nil] Size as the provider declared it. Never measured here — nothing downloads the fi
             #
-            #   @param media_type [String, nil] One of Constants.MmsMediaTypes when known. Advisory — the carrier reads the
+            #   @param source_hash_sha256 [String, nil] Inbound only: the SHA-256 the provider declared alongside the attachment, when i
             #
-            #   @param url [String]
+            #   @param url [String, nil] Where the file lives. Outbound: the URL the customer gave us and the carrier fet
           end
         end
       end