sentdm 0.32.0 → 0.34.0

data/rbi/sentdm/models/inbound_message_event_payload.rbi

@@ -23,13 +23,28 @@ module Sentdm
       sig { params(account_id: String).void }
       attr_writer :account_id
 
-      # The channel the message arrived on, for example sms or whatsapp.
+      # The channel the message arrived on, for example sms or mms.
       sig { returns(T.nilable(String)) }
       attr_reader :channel
 
       sig { params(channel: String).void }
       attr_writer :channel
 
+      # Attachments the contact sent, present only on channels that carry them (mms
+      # today) and omitted entirely otherwise.
+      #
+      # Each url points at the carrier's own copy of the file — sent.dm records where
+      # the attachment is, not the attachment itself. The link is unauthenticated and
+      # expires on the carrier's schedule, which differs between them: assume days, not
+      # months. Download what you need on receipt; re-reading the message through GET
+      # /v3/messages/{id} returns the same stored link, not a fresh one, so once it
+      # lapses the entry remains with whatever the carrier declared about the file but
+      # the file is no longer reachable.
+      sig do
+        returns(T.nilable(T::Array[Sentdm::InboundMessageEventPayload::Media]))
+      end
+      attr_accessor :media
+
       # The inbound message.
       sig { returns(T.nilable(String)) }
       attr_reader :message_id
@@ -66,6 +81,10 @@ module Sentdm
           received_at: String,
           account_id: String,
           channel: String,
+          media:
+            T.nilable(
+              T::Array[Sentdm::InboundMessageEventPayload::Media::OrHash]
+            ),
           message_id: String,
           outbound_number: String,
           text: T.nilable(String),
@@ -79,8 +98,19 @@ module Sentdm
         received_at:,
         # The account the message belongs to.
         account_id: nil,
-        # The channel the message arrived on, for example sms or whatsapp.
+        # The channel the message arrived on, for example sms or mms.
         channel: nil,
+        # Attachments the contact sent, present only on channels that carry them (mms
+        # today) and omitted entirely otherwise.
+        #
+        # Each url points at the carrier's own copy of the file — sent.dm records where
+        # the attachment is, not the attachment itself. The link is unauthenticated and
+        # expires on the carrier's schedule, which differs between them: assume days, not
+        # months. Download what you need on receipt; re-reading the message through GET
+        # /v3/messages/{id} returns the same stored link, not a fresh one, so once it
+        # lapses the entry remains with whatever the carrier declared about the file but
+        # the file is no longer reachable.
+        media: nil,
         # The inbound message.
         message_id: nil,
         # Your number in E.164 format, meaning the number the message was addressed to.
@@ -102,6 +132,8 @@ module Sentdm
             received_at: String,
             account_id: String,
             channel: String,
+            media:
+              T.nilable(T::Array[Sentdm::InboundMessageEventPayload::Media]),
             message_id: String,
             outbound_number: String,
             text: T.nilable(String),
@@ -111,6 +143,82 @@ module Sentdm
       end
       def to_hash
       end
+
+      class Media < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::InboundMessageEventPayload::Media,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # SHA-256 of the file as the carrier declared it, when it declares one. Verify
+        # what you download against this — sent.dm never reads the bytes, so it is the
+        # only integrity signal available.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :hash_sha256
+
+        # Content type as the carrier reported it, for example image/jpeg.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :mime_type
+
+        # Size in bytes as the carrier declared it. Absent when it declared none.
+        sig { returns(T.nilable(Integer)) }
+        attr_accessor :size_bytes
+
+        # Where the carrier hosts the attachment.
+        #
+        # This link expires and is not authenticated. sent.dm relays it rather than
+        # copying the file, so how long it stays fetchable is the carrier's decision and
+        # differs between them — assume days, not months. Anyone holding the URL can fetch
+        # it until it lapses. Copy the file on receipt if you need it to outlive that
+        # window; do not store this URL as a permanent reference.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :url
+
+        # One attachment on an inbound message.
+        sig do
+          params(
+            hash_sha256: T.nilable(String),
+            mime_type: T.nilable(String),
+            size_bytes: T.nilable(Integer),
+            url: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # SHA-256 of the file as the carrier declared it, when it declares one. Verify
+          # what you download against this — sent.dm never reads the bytes, so it is the
+          # only integrity signal available.
+          hash_sha256: nil,
+          # Content type as the carrier reported it, for example image/jpeg.
+          mime_type: nil,
+          # Size in bytes as the carrier declared it. Absent when it declared none.
+          size_bytes: nil,
+          # Where the carrier hosts the attachment.
+          #
+          # This link expires and is not authenticated. sent.dm relays it rather than
+          # copying the file, so how long it stays fetchable is the carrier's decision and
+          # differs between them — assume days, not months. Anyone holding the URL can fetch
+          # it until it lapses. Copy the file on receipt if you need it to outlive that
+          # window; do not store this URL as a permanent reference.
+          url: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              hash_sha256: T.nilable(String),
+              mime_type: T.nilable(String),
+              size_bytes: T.nilable(Integer),
+              url: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/sentdm/models/me_retrieve_response.rbi

@@ -123,6 +123,25 @@ module Sentdm
         sig { returns(T.nilable(String)) }
         attr_accessor :email
 
+        # Whether this account may mark a template for automatic creation on its sender
+        # profiles. Granted by Sent per account and off by default, so it is what a
+        # template-create form reads to decide whether to offer the option at all —
+        # marking a template without it does nothing.
+        #
+        # Top-level rather than inside settings, which is written for type: "profile" only
+        # and so would never carry it to the account type that can act on it.
+        #
+        # This is the capability, not the stored flag: a profile reports false whatever
+        # its own row holds. A sender profile owns no sender profiles, so a template it
+        # marked would have nothing to be created on and the fan-out would never read the
+        # flag. The admin GET /customers/{id} reports the stored value instead, because
+        # that is the one an operator granted.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :enable_template_auto_creation_for_sp
+
+        sig { params(enable_template_auto_creation_for_sp: T::Boolean).void }
+        attr_writer :enable_template_auto_creation_for_sp
+
         # Account icon URL
         sig { returns(T.nilable(String)) }
         attr_accessor :icon
@@ -218,6 +237,7 @@ module Sentdm
             created_at: Time,
             description: T.nilable(String),
             email: T.nilable(String),
+            enable_template_auto_creation_for_sp: T::Boolean,
             icon: T.nilable(String),
             name: String,
             organization_id: T.nilable(String),
@@ -245,6 +265,20 @@ module Sentdm
           description: nil,
           # Contact email address
           email: nil,
+          # Whether this account may mark a template for automatic creation on its sender
+          # profiles. Granted by Sent per account and off by default, so it is what a
+          # template-create form reads to decide whether to offer the option at all —
+          # marking a template without it does nothing.
+          #
+          # Top-level rather than inside settings, which is written for type: "profile" only
+          # and so would never carry it to the account type that can act on it.
+          #
+          # This is the capability, not the stored flag: a profile reports false whatever
+          # its own row holds. A sender profile owns no sender profiles, so a template it
+          # marked would have nothing to be created on and the fan-out would never read the
+          # flag. The admin GET /customers/{id} reports the stored value instead, because
+          # that is the one an operator granted.
+          enable_template_auto_creation_for_sp: nil,
           # Account icon URL
           icon: nil,
           # Account name
@@ -293,6 +327,7 @@ module Sentdm
               created_at: Time,
               description: T.nilable(String),
               email: T.nilable(String),
+              enable_template_auto_creation_for_sp: T::Boolean,
               icon: T.nilable(String),
               name: String,
               organization_id: T.nilable(String),

data/rbi/sentdm/models/message_event_payload.rbi

@@ -54,6 +54,31 @@ module Sentdm
       sig { params(outbound_number: String).void }
       attr_writer :outbound_number
 
+      # A human-readable sentence for ReasonCode, for example "The recipient is not
+      # registered on this channel". Omitted whenever reason_code is.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      # Why the message reached this status, as a stable platform code such as
+      # DELIVERY_007 or BUSINESS_003. Present on message.failed, message.filtered and
+      # message.blocked; omitted on every status that needs no explanation. 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 and never a carrier or vendor
+      # code.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason_code
+
+      # 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.
+      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.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :scheduled_at
+
       # The template the message was sent from, when it was sent from one.
       sig { returns(T.nilable(String)) }
       attr_accessor :template_id
@@ -82,6 +107,10 @@ module Sentdm
           channel: String,
           message_id: String,
           outbound_number: String,
+          reason: T.nilable(String),
+          reason_code: T.nilable(String),
+          schedule_reason: T.nilable(String),
+          scheduled_at: T.nilable(String),
           template_id: T.nilable(String),
           template_name: T.nilable(String),
           updated_at: String
@@ -108,6 +137,23 @@ module Sentdm
         message_id: nil,
         # The recipient's number in E.164 format.
         outbound_number: nil,
+        # A human-readable sentence for ReasonCode, for example "The recipient is not
+        # registered on this channel". Omitted whenever reason_code is.
+        reason: nil,
+        # Why the message reached this status, as a stable platform code such as
+        # DELIVERY_007 or BUSINESS_003. Present on message.failed, message.filtered and
+        # message.blocked; omitted on every status that needs no explanation. 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 and never a carrier or vendor
+        # code.
+        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.
+        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.
+        scheduled_at: nil,
         # The template the message was sent from, when it was sent from one.
         template_id: nil,
         # Name of the template the message was sent from. Omitted when the message wasn't
@@ -128,6 +174,10 @@ module Sentdm
             channel: String,
             message_id: String,
             outbound_number: String,
+            reason: T.nilable(String),
+            reason_code: T.nilable(String),
+            schedule_reason: T.nilable(String),
+            scheduled_at: T.nilable(String),
             template_id: T.nilable(String),
             template_name: T.nilable(String),
             updated_at: String

data/rbi/sentdm/models/message_retrieve_activities_response.rbi

@@ -203,8 +203,28 @@ module Sentdm
           sig { returns(T.nilable(String)) }
           attr_accessor :price
 
-          # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SENT, DELIVERED, READ,
-          # FAILED. Inbound (from contact): RECEIVED (terminal).
+          # A human-readable sentence for reason_code, for example "The recipient is not
+          # registered on this channel" Omitted whenever reason_code is.
+          sig { returns(T.nilable(String)) }
+          attr_accessor :reason
+
+          # Why the message reached this status, as a stable platform code such as
+          # DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
+          # activities; omitted on every status that needs no explanation. Switch on this
+          # 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.
+          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.
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :scheduled_at
+
+          # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
+          # DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).
           sig { returns(T.nilable(String)) }
           attr_reader :status
 
@@ -218,13 +238,20 @@ module Sentdm
           sig { params(timestamp: Time).void }
           attr_writer :timestamp
 
-          # A single message activity event for v3 API
+          # A single message activity event for v3 API.
+          #
+          # The activity list mixes statuses, so unlike a message it is one shape rather
+          # than two: a SCHEDULED entry carries scheduled_at, and every other entry has no
+          # such key.
           sig do
             params(
               active_contact_price: T.nilable(String),
               description: String,
               from: T.nilable(String),
               price: T.nilable(String),
+              reason: T.nilable(String),
+              reason_code: T.nilable(String),
+              scheduled_at: T.nilable(Time),
               status: String,
               timestamp: Time
             ).returns(T.attached_class)
@@ -242,8 +269,22 @@ module Sentdm
             # Channel cost for this activity (e.g., SMS/WhatsApp provider cost), formatted to
             # 4 decimal places.
             price: nil,
-            # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SENT, DELIVERED, READ,
-            # FAILED. Inbound (from contact): RECEIVED (terminal).
+            # A human-readable sentence for reason_code, for example "The recipient is not
+            # registered on this channel" Omitted whenever reason_code is.
+            reason: nil,
+            # Why the message reached this status, as a stable platform code such as
+            # DELIVERY_007 or BUSINESS_003. Present on FAILED, FILTERED and BLOCKED
+            # activities; omitted on every status that needs no explanation. Switch on this
+            # 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_at: nil,
+            # Activity status. Outbound: QUEUED, PROCESSED, ROUTED, SCHEDULED, SENT,
+            # DELIVERED, READ, FAILED. Inbound (from contact): RECEIVED (terminal).
             status: nil,
             # When this activity occurred
             timestamp: nil
@@ -257,6 +298,9 @@ module Sentdm
                 description: String,
                 from: T.nilable(String),
                 price: T.nilable(String),
+                reason: T.nilable(String),
+                reason_code: T.nilable(String),
+                scheduled_at: T.nilable(Time),
                 status: String,
                 timestamp: Time
               }