sentdm 0.32.0 → 0.34.0

data/rbi/sentdm/models/webhook_update_params.rbi

@@ -49,6 +49,19 @@ module Sentdm
       sig { params(sandbox: T::Boolean).void }
       attr_writer :sandbox
 
+      # Request-only: the events an organization webhook's sender profile clones
+      # receive, one clone per existing and future profile. Responses never return it.
+      sig { returns(T.nilable(Sentdm::WebhookUpdateParams::SenderProfile)) }
+      attr_reader :sender_profile
+
+      sig do
+        params(
+          sender_profile:
+            T.nilable(Sentdm::WebhookUpdateParams::SenderProfile::OrHash)
+        ).void
+      end
+      attr_writer :sender_profile
+
       sig { returns(T.nilable(Integer)) }
       attr_reader :timeout_seconds
 
@@ -76,6 +89,8 @@ module Sentdm
           event_types: T::Array[String],
           retry_count: Integer,
           sandbox: T::Boolean,
+          sender_profile:
+            T.nilable(Sentdm::WebhookUpdateParams::SenderProfile::OrHash),
           timeout_seconds: Integer,
           idempotency_key: String,
           x_profile_id: String,
@@ -92,6 +107,9 @@ module Sentdm
         # Sandbox flag - when true, the operation is simulated without side effects Useful
         # for testing integrations without actual execution
         sandbox: nil,
+        # Request-only: the events an organization webhook's sender profile clones
+        # receive, one clone per existing and future profile. Responses never return it.
+        sender_profile: nil,
         timeout_seconds: nil,
         idempotency_key: nil,
         x_profile_id: nil,
@@ -109,6 +127,8 @@ module Sentdm
             event_types: T::Array[String],
             retry_count: Integer,
             sandbox: T::Boolean,
+            sender_profile:
+              T.nilable(Sentdm::WebhookUpdateParams::SenderProfile),
             timeout_seconds: Integer,
             idempotency_key: String,
             x_profile_id: String,
@@ -118,6 +138,47 @@ module Sentdm
       end
       def to_hash
       end
+
+      class SenderProfile < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::WebhookUpdateParams::SenderProfile,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :event_filters
+
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :event_types
+
+        sig { params(event_types: T::Array[String]).void }
+        attr_writer :event_types
+
+        # Request-only: the events an organization webhook's sender profile clones
+        # receive, one clone per existing and future profile. Responses never return it.
+        sig do
+          params(
+            event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            event_types: T::Array[String]
+          ).returns(T.attached_class)
+        end
+        def self.new(event_filters: nil, event_types: nil)
+        end
+
+        sig do
+          override.returns(
+            {
+              event_filters: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              event_types: T::Array[String]
+            }
+          )
+        end
+        def to_hash
+        end
+      end
     end
   end
 end

data/rbi/sentdm/resources/me.rbi

@@ -35,6 +35,11 @@ module Sentdm
       # `sending_phone_number_profile_id` names the account that holds that number in
       # inventory — normally this account, and a different one where a number is shared.
       # Both are `null` when the account has no US SMS sender.
+      #
+      # **Template auto-creation:** `enable_template_auto_creation_for_sp` reports
+      # whether this account may mark a template for automatic creation on its sender
+      # profiles. It is granted by Sent and off by default. A `profile` reports `false`,
+      # having no sender profiles of its own to create anything on.
       sig do
         params(
           x_profile_id: String,

data/rbi/sentdm/resources/messages.rbi

@@ -13,9 +13,17 @@ module Sentdm
     # **A message needs a sender.** What you can send, where, and at what cost is
     # decided by the markets under **Channels** — so a recipient in a country you hold
     # no sender for is refused here rather than queued.
+    #
+    # **A message can be resent on its id.** `POST /v3/messages/{id}/resend` puts a
+    # finished message — typically one BLOCKED for insufficient balance — back through
+    # the send pipeline. It is a new attempt, not a free retry: every policy runs
+    # again, the message is billed again, and its status webhooks fire again. A
+    # FILTERED message is never resendable.
     class Messages
       # Retrieves the activity log for a specific message. Activities track the message
-      # lifecycle including acceptance, processing, sending, delivery, and any errors.
+      # lifecycle including acceptance, processing, sending, delivery, and any errors. A
+      # SCHEDULED entry carries scheduled_at, the release instant in UTC as it stood at
+      # that moment. Other entries have no scheduled_at key.
       sig do
         params(
           id: String,
@@ -34,7 +42,11 @@ module Sentdm
       end
 
       # Retrieves the current status and details of a message by ID. Includes delivery
-      # status, timestamps, and error information if applicable.
+      # status, timestamps, and error information if applicable. A message that is or
+      # was held for a later time (a send you scheduled with scheduled_at, or a
+      # quiet-hours hold) is returned as a ScheduledMessageResponse: the same fields
+      # plus scheduled_at, the release instant in UTC. A message sent immediately has no
+      # scheduled_at key.
       sig do
         params(
           id: String,
@@ -61,11 +73,24 @@ module Sentdm
       # insufficient balance, a template not approved for sending, or free-form content
       # with no open conversation with the contact. The send is accepted with 202 and
       # the affected messages are reported as BLOCKED on GET /messages/{id} and the
-      # message.blocked webhook.
+      # message.blocked webhook. To send later, set scheduled_at (ISO-8601 with an
+      # explicit UTC offset; a value without one is rejected) between 1 minute and 30
+      # days ahead: the response is a ScheduledSendMessageResponse (the same fields plus
+      # scheduled_at; status is still QUEUED), each message then moves to SCHEDULED, is
+      # held and released at that time (within a few minutes), and a message.scheduled
+      # webhook fires once it is held. Balance and template approval are evaluated at
+      # release, not at acceptance. Quiet hours are not checked when the request is
+      # accepted: if the time falls inside a legally protected quiet-hours window for a
+      # recipient, that message is moved to the next allowed time at release and a
+      # second message.scheduled webhook reports the new scheduled_at. An account may
+      # hold at most 1,000,000 scheduled messages at once (429 LIMIT_001).
       sig do
         params(
           channel: T.nilable(T::Array[String]),
+          media_urls: T.nilable(T::Array[String]),
           sandbox: T::Boolean,
+          scheduled_at: T.nilable(Time),
+          subject: T.nilable(String),
           template: T.nilable(Sentdm::MessageSendParams::Template::OrHash),
           text: T.nilable(String),
           to: T::Array[String],
@@ -79,9 +104,39 @@ module Sentdm
         # produces a separate message per recipient. "sent" = auto-detect. Defaults to
         # ["sent"] (auto-detect) if omitted.
         channel: nil,
+        # Body param: Attachments for this send, as publicly fetchable https URLs. Used by
+        # the MMS channel and ignored by every other one.
+        #
+        # Supplying these replaces the media on the template's mms body rather than adding
+        # to it, so a template can hold a default creative while a caller still sends
+        # something recipient-specific.
+        #
+        # Their presence is also what makes a message eligible for MMS on an auto-detect
+        # send: a message with nothing attached is delivered as SMS, because an MMS with
+        # no media is a more expensive text message.
+        #
+        # The recipient's carrier fetches each URL after the send is accepted, so it must
+        # stay publicly reachable — a link that expires, or one behind auth, arrives as a
+        # failed message.
+        media_urls: nil,
         # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
         sandbox: nil,
+        # Body param: Optional future send time as an ISO-8601 timestamp with an explicit
+        # UTC offset, e.g. 2026-10-01T09:00:00+02:00 or 2026-10-01T07:00:00Z. A value
+        # without an offset is rejected (400) rather than read in the server's zone. The
+        # offset only fixes the instant: it is stored and echoed in UTC as scheduled_at.
+        # Omit to send now. Must be at least one minute ahead and at most 30 days ahead.
+        # Accepted messages report SCHEDULED and are released for delivery at this time.
+        # Quiet hours, balance and template approval are evaluated at release, not at
+        # acceptance: a message whose time falls inside a recipient's protected
+        # quiet-hours window is moved to the next allowed time and a second
+        # message.scheduled webhook reports the new scheduled_at.
+        scheduled_at: nil,
+        # Body param: Subject line for this send, overriding the template's. MMS only;
+        # ignored on every other channel. Most handsets render it above the body, some
+        # ignore it entirely.
+        subject: nil,
         # Body param: SDK-style template reference: resolve by ID or by name, with
         # optional parameters.
         template: nil,

data/rbi/sentdm/resources/templates.rbi

@@ -17,6 +17,7 @@ module Sentdm
       # `PUT /v3/templates/{id}`.
       sig do
         params(
+          auto_create_for_sp: T::Boolean,
           category: T.nilable(String),
           creation_source: T.nilable(String),
           definition: Sentdm::TemplateDefinition::OrHash,
@@ -29,6 +30,11 @@ module Sentdm
         ).returns(Sentdm::APIResponseTemplate)
       end
       def create(
+        # Body param: Create this template automatically on every sender profile of the
+        # organization, now and in future (default: false). Accepted only from an
+        # organization that has been enabled for it, and only at creation — it cannot be
+        # changed afterwards.
+        auto_create_for_sp: nil,
         # Body param: Template category: MARKETING, UTILITY, AUTHENTICATION (optional,
         # auto-detected if not provided)
         category: nil,

data/rbi/sentdm/resources/webhooks.rbi

@@ -23,6 +23,8 @@ module Sentdm
           event_types: T::Array[String],
           retry_count: Integer,
           sandbox: T::Boolean,
+          sender_profile:
+            T.nilable(Sentdm::WebhookCreateParams::SenderProfile::OrHash),
           timeout_seconds: Integer,
           idempotency_key: String,
           x_profile_id: String,
@@ -43,6 +45,10 @@ module Sentdm
         # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
         sandbox: nil,
+        # Body param: Request-only: the events an organization webhook's sender profile
+        # clones receive, one clone per existing and future profile. Responses never
+        # return it.
+        sender_profile: nil,
         # Body param
         timeout_seconds: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
@@ -84,6 +90,8 @@ module Sentdm
           event_types: T::Array[String],
           retry_count: Integer,
           sandbox: T::Boolean,
+          sender_profile:
+            T.nilable(Sentdm::WebhookUpdateParams::SenderProfile::OrHash),
           timeout_seconds: Integer,
           idempotency_key: String,
           x_profile_id: String,
@@ -106,6 +114,10 @@ module Sentdm
         # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
         sandbox: nil,
+        # Body param: Request-only: the events an organization webhook's sender profile
+        # clones receive, one clone per existing and future profile. Responses never
+        # return it.
+        sender_profile: nil,
         # Body param
         timeout_seconds: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
@@ -180,7 +192,9 @@ module Sentdm
       )
       end
 
-      # Retrieves a paginated list of delivery events for the specified webhook.
+      # Retrieves a paginated list of delivery events for the specified webhook. If the
+      # webhook is cloned onto your sender profiles, the list includes what those clones
+      # received; read payload.account_id to tell whose event it is.
       sig do
         params(
           id: String,

data/sig/sentdm/models/channel_event_payload.rbs

@@ -5,8 +5,10 @@ module Sentdm
         country: String,
         account_id: String,
         channel: String,
+        compliance: Sentdm::ChannelEventPayload::Compliance?,
         number_type: String?,
         reason: String?,
+        reason_code: String?,
         sender_value: String?,
         status: String,
         updated_at: String
@@ -23,10 +25,14 @@ module Sentdm
 
       def channel=: (String) -> String
 
+      attr_accessor compliance: Sentdm::ChannelEventPayload::Compliance?
+
       attr_accessor number_type: String?
 
       attr_accessor reason: String?
 
+      attr_accessor reason_code: String?
+
       attr_accessor sender_value: String?
 
       attr_reader status: String?
@@ -41,8 +47,10 @@ module Sentdm
         country: String,
         ?account_id: String,
         ?channel: String,
+        ?compliance: Sentdm::ChannelEventPayload::Compliance?,
         ?number_type: String?,
         ?reason: String?,
+        ?reason_code: String?,
         ?sender_value: String?,
         ?status: String,
         ?updated_at: String
@@ -52,12 +60,66 @@ module Sentdm
         country: String,
         account_id: String,
         channel: String,
+        compliance: Sentdm::ChannelEventPayload::Compliance?,
         number_type: String?,
         reason: String?,
+        reason_code: String?,
         sender_value: String?,
         status: String,
         updated_at: String
       }
+
+      type compliance =
+        {
+          brand: ::Hash[Symbol, top]?,
+          campaign: ::Hash[Symbol, top]?,
+          documents: ::Array[Sentdm::ChannelEventPayload::Compliance::Document]?
+        }
+
+      class Compliance < Sentdm::Internal::Type::BaseModel
+        attr_accessor brand: ::Hash[Symbol, top]?
+
+        attr_accessor campaign: ::Hash[Symbol, top]?
+
+        attr_accessor documents: ::Array[Sentdm::ChannelEventPayload::Compliance::Document]?
+
+        def initialize: (
+          ?brand: ::Hash[Symbol, top]?,
+          ?campaign: ::Hash[Symbol, top]?,
+          ?documents: ::Array[Sentdm::ChannelEventPayload::Compliance::Document]?
+        ) -> void
+
+        def to_hash: -> {
+          brand: ::Hash[Symbol, top]?,
+          campaign: ::Hash[Symbol, top]?,
+          documents: ::Array[Sentdm::ChannelEventPayload::Compliance::Document]?
+        }
+
+        type document =
+          { document_id: String?, file_name: String?, key: String }
+
+        class Document < Sentdm::Internal::Type::BaseModel
+          attr_accessor document_id: String?
+
+          attr_accessor file_name: String?
+
+          attr_reader key: String?
+
+          def key=: (String) -> String
+
+          def initialize: (
+            ?document_id: String?,
+            ?file_name: String?,
+            ?key: String
+          ) -> void
+
+          def to_hash: -> {
+            document_id: String?,
+            file_name: String?,
+            key: String
+          }
+        end
+      end
     end
   end
 end

data/sig/sentdm/models/contact_event_payload.rbs

@@ -5,11 +5,14 @@ module Sentdm
         opt_out: bool,
         source: String,
         account_id: String,
+        agent_id: String?,
         channel: String,
         contact_id: String,
+        from: String,
         message_id: String?,
-        phone_number: String,
-        text: String?
+        template_id: String?,
+        text: String?,
+        to: String?
       }
 
     class ContactEventPayload < Sentdm::Internal::Type::BaseModel
@@ -21,6 +24,8 @@ module Sentdm
 
       def account_id=: (String) -> String
 
+      attr_accessor agent_id: String?
+
       attr_reader channel: String?
 
       def channel=: (String) -> String
@@ -29,34 +34,44 @@ module Sentdm
 
       def contact_id=: (String) -> String
 
-      attr_accessor message_id: String?
+      attr_reader from: String?
 
-      attr_reader phone_number: String?
+      def from=: (String) -> String
 
-      def phone_number=: (String) -> String
+      attr_accessor message_id: String?
+
+      attr_accessor template_id: String?
 
       attr_accessor text: String?
 
+      attr_accessor to: String?
+
       def initialize: (
         opt_out: bool,
         source: String,
         ?account_id: String,
+        ?agent_id: String?,
         ?channel: String,
         ?contact_id: String,
+        ?from: String,
         ?message_id: String?,
-        ?phone_number: String,
-        ?text: String?
+        ?template_id: String?,
+        ?text: String?,
+        ?to: String?
       ) -> void
 
       def to_hash: -> {
         opt_out: bool,
         source: String,
         account_id: String,
+        agent_id: String?,
         channel: String,
         contact_id: String,
+        from: String,
         message_id: String?,
-        phone_number: String,
-        text: String?
+        template_id: String?,
+        text: String?,
+        to: String?
       }
     end
   end

data/sig/sentdm/models/conversation_messages_list.rbs

@@ -41,6 +41,8 @@ module Sentdm
           phone: String,
           phone_international: String,
           price: Float?,
+          reason: String?,
+          reason_code: String?,
           region_code: String,
           status: String,
           template_category: String?,
@@ -89,6 +91,10 @@ module Sentdm
 
         attr_accessor price: Float?
 
+        attr_accessor reason: String?
+
+        attr_accessor reason_code: String?
+
         attr_reader region_code: String?
 
         def region_code=: (String) -> String
@@ -116,6 +122,8 @@ module Sentdm
           ?phone: String,
           ?phone_international: String,
           ?price: Float?,
+          ?reason: String?,
+          ?reason_code: String?,
           ?region_code: String,
           ?status: String,
           ?template_category: String?,
@@ -136,6 +144,8 @@ module Sentdm
           phone: String,
           phone_international: String,
           price: Float?,
+          reason: String?,
+          reason_code: String?,
           region_code: String,
           status: String,
           template_category: String?,
@@ -143,7 +153,14 @@ module Sentdm
           template_name: String?
         }
 
-        type event = { status: String, timestamp: Time, description: String? }
+        type event =
+          {
+            status: String,
+            timestamp: Time,
+            description: String?,
+            reason: String?,
+            reason_code: String?
+          }
 
         class Event < Sentdm::Internal::Type::BaseModel
           attr_accessor status: String
@@ -152,16 +169,24 @@ module Sentdm
 
           attr_accessor description: String?
 
+          attr_accessor reason: String?
+
+          attr_accessor reason_code: String?
+
           def initialize: (
             status: String,
             timestamp: Time,
-            ?description: String?
+            ?description: String?,
+            ?reason: String?,
+            ?reason_code: String?
           ) -> void
 
           def to_hash: -> {
             status: String,
             timestamp: Time,
-            description: String?
+            description: String?,
+            reason: String?,
+            reason_code: String?
           }
         end
 
@@ -170,7 +195,10 @@ module Sentdm
             buttons: ::Array[Sentdm::ConversationMessagesList::Message::MessageBody::Button]?,
             content: String,
             footer: String?,
-            header: String?
+            header: String?,
+            header_media: Sentdm::ConversationMessagesList::Message::MessageBody::HeaderMedia?,
+            media: ::Array[Sentdm::ConversationMessagesList::Message::MessageBody::Media]?,
+            subject: String?
           }
 
         class MessageBody < Sentdm::Internal::Type::BaseModel
@@ -184,18 +212,30 @@ module Sentdm
 
           attr_accessor header: String?
 
+          attr_accessor header_media: Sentdm::ConversationMessagesList::Message::MessageBody::HeaderMedia?
+
+          attr_accessor media: ::Array[Sentdm::ConversationMessagesList::Message::MessageBody::Media]?
+
+          attr_accessor subject: String?
+
           def initialize: (
             ?buttons: ::Array[Sentdm::ConversationMessagesList::Message::MessageBody::Button]?,
             ?content: String,
             ?footer: String?,
-            ?header: String?
+            ?header: String?,
+            ?header_media: Sentdm::ConversationMessagesList::Message::MessageBody::HeaderMedia?,
+            ?media: ::Array[Sentdm::ConversationMessagesList::Message::MessageBody::Media]?,
+            ?subject: String?
           ) -> void
 
           def to_hash: -> {
             buttons: ::Array[Sentdm::ConversationMessagesList::Message::MessageBody::Button]?,
             content: String,
             footer: String?,
-            header: String?
+            header: String?,
+            header_media: Sentdm::ConversationMessagesList::Message::MessageBody::HeaderMedia?,
+            media: ::Array[Sentdm::ConversationMessagesList::Message::MessageBody::Media]?,
+            subject: String?
           }
 
           type button =
@@ -233,6 +273,59 @@ module Sentdm
               value: String
             }
           end
+
+          type header_media = { type: String, url: String }
+
+          class HeaderMedia < Sentdm::Internal::Type::BaseModel
+            attr_reader type: String?
+
+            def type=: (String) -> String
+
+            attr_reader url: String?
+
+            def url=: (String) -> String
+
+            def initialize: (?type: String, ?url: String) -> void
+
+            def to_hash: -> { type: String, url: String }
+          end
+
+          type media =
+            {
+              media_type: String?,
+              mime_type: String?,
+              size_bytes: Integer?,
+              :source_hash_sha256 => String?,
+              url: String?
+            }
+
+          class Media < Sentdm::Internal::Type::BaseModel
+            attr_accessor media_type: String?
+
+            attr_accessor mime_type: String?
+
+            attr_accessor size_bytes: Integer?
+
+            attr_accessor source_hash_sha256: String?
+
+            attr_accessor url: String?
+
+            def initialize: (
+              ?media_type: String?,
+              ?mime_type: String?,
+              ?size_bytes: Integer?,
+              ?source_hash_sha256: String?,
+              ?url: String?
+            ) -> void
+
+            def to_hash: -> {
+              media_type: String?,
+              mime_type: String?,
+              size_bytes: Integer?,
+              :source_hash_sha256 => String?,
+              url: String?
+            }
+          end
         end
       end
     end