sentdm 0.31.0 → 0.33.0

data/rbi/sentdm/resources/templates.rbi

@@ -12,7 +12,9 @@ module Sentdm
     class Templates
       # Creates a new message template with header, body, footer, and buttons. The
       # template can be submitted for review immediately or saved as draft for later
-      # submission.
+      # submission. There is no `name` field on create — the display name is derived
+      # from the template's content and can be changed afterwards with
+      # `PUT /v3/templates/{id}`.
       sig do
         params(
           category: T.nilable(String),
@@ -76,7 +78,31 @@ module Sentdm
       end
 
       # Updates an existing template's name, category, language, definition, or submits
-      # it for review.
+      # it for review. While the template is in review (status PENDING, or any channel
+      # awaiting a verdict) its definition, category and language are frozen and a
+      # resubmission is refused — those requests answer 409 CONFLICT_006. The display
+      # name stays editable throughout.
+      #
+      # `definition`, `category` and `language` are editable only from status DRAFT,
+      # REJECTED or APPROVED. An edit to any of them on a template in another state
+      # (PAUSED, DISABLED or REVOKED) is refused with 400 VALIDATION_001 and the detail
+      # "Template (except display name) cannot be updated unless it is in draft or
+      # rejected status"; `name` stays editable in every state. `submit_for_review` on a
+      # PAUSED, DISABLED or REVOKED template is accepted and answers 200, but opens no
+      # review and does not move the status — only the reviewer can reinstate it.
+      #
+      # Editing an APPROVED template is a live edit: the new content is stored
+      # immediately, and sending `submit_for_review: true` re-opens review, which
+      # returns the affected channels to PENDING so they stop sending until they are
+      # approved again. The previously approved content is never sent during re-review.
+      # Watch the per-channel `templates` webhook events rather than assuming the
+      # template-level status.
+      #
+      # Templates provisioned by Sent (light-onboarding templates, whose names carry the
+      # reserved `sent_` prefix) are read-only: every field is refused with 400
+      # VALIDATION*001 and the detail "This template is read-only. Only 'submit for
+      # review' is allowed.", and only `submit_for_review` is accepted. A `name`
+      # starting with `sent*` is refused for the same reason — the prefix is reserved.
       sig do
         params(
           id: String,

data/sig/sentdm/models/channel_event.rbs

@@ -0,0 +1,44 @@
+module Sentdm
+  module Models
+    type channel_event =
+      {
+        event: String?,
+        field: String,
+        payload: Sentdm::ChannelEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+
+    class ChannelEvent < Sentdm::Internal::Type::BaseModel
+      attr_accessor event: String?
+
+      attr_reader field: String?
+
+      def field=: (String) -> String
+
+      attr_accessor payload: Sentdm::ChannelEventPayload?
+
+      attr_accessor request_id: String?
+
+      attr_reader timestamp: String?
+
+      def timestamp=: (String) -> String
+
+      def initialize: (
+        ?event: String?,
+        ?field: String,
+        ?payload: Sentdm::ChannelEventPayload?,
+        ?request_id: String?,
+        ?timestamp: String
+      ) -> void
+
+      def to_hash: -> {
+        event: String?,
+        field: String,
+        payload: Sentdm::ChannelEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/channel_event_payload.rbs

@@ -0,0 +1,120 @@
+module Sentdm
+  module Models
+    type channel_event_payload =
+      {
+        country: String,
+        account_id: String,
+        channel: String,
+        compliance: Sentdm::ChannelEventPayload::Compliance?,
+        number_type: String?,
+        reason: String?,
+        sender_value: String?,
+        status: String,
+        updated_at: String
+      }
+
+    class ChannelEventPayload < Sentdm::Internal::Type::BaseModel
+      attr_accessor country: String
+
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_reader channel: String?
+
+      def channel=: (String) -> String
+
+      attr_accessor compliance: Sentdm::ChannelEventPayload::Compliance?
+
+      attr_accessor number_type: String?
+
+      attr_accessor reason: String?
+
+      attr_accessor sender_value: String?
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      attr_reader updated_at: String?
+
+      def updated_at=: (String) -> String
+
+      def initialize: (
+        country: String,
+        ?account_id: String,
+        ?channel: String,
+        ?compliance: Sentdm::ChannelEventPayload::Compliance?,
+        ?number_type: String?,
+        ?reason: String?,
+        ?sender_value: String?,
+        ?status: String,
+        ?updated_at: String
+      ) -> void
+
+      def to_hash: -> {
+        country: String,
+        account_id: String,
+        channel: String,
+        compliance: Sentdm::ChannelEventPayload::Compliance?,
+        number_type: String?,
+        reason: 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.rbs

@@ -0,0 +1,44 @@
+module Sentdm
+  module Models
+    type contact_event =
+      {
+        event: String?,
+        field: String,
+        payload: Sentdm::ContactEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+
+    class ContactEvent < Sentdm::Internal::Type::BaseModel
+      attr_accessor event: String?
+
+      attr_reader field: String?
+
+      def field=: (String) -> String
+
+      attr_accessor payload: Sentdm::ContactEventPayload?
+
+      attr_accessor request_id: String?
+
+      attr_reader timestamp: String?
+
+      def timestamp=: (String) -> String
+
+      def initialize: (
+        ?event: String?,
+        ?field: String,
+        ?payload: Sentdm::ContactEventPayload?,
+        ?request_id: String?,
+        ?timestamp: String
+      ) -> void
+
+      def to_hash: -> {
+        event: String?,
+        field: String,
+        payload: Sentdm::ContactEventPayload?,
+        request_id: String?,
+        timestamp: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/contact_event_payload.rbs

@@ -0,0 +1,78 @@
+module Sentdm
+  module Models
+    type contact_event_payload =
+      {
+        opt_out: bool,
+        source: String,
+        account_id: String,
+        agent_id: String?,
+        channel: String,
+        contact_id: String,
+        from: String,
+        message_id: String?,
+        template_id: String?,
+        text: String?,
+        to: String?
+      }
+
+    class ContactEventPayload < Sentdm::Internal::Type::BaseModel
+      attr_accessor opt_out: bool
+
+      attr_accessor source: String
+
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_accessor agent_id: String?
+
+      attr_reader channel: String?
+
+      def channel=: (String) -> String
+
+      attr_reader contact_id: String?
+
+      def contact_id=: (String) -> String
+
+      attr_reader from: String?
+
+      def from=: (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?,
+        ?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?,
+        template_id: String?,
+        text: String?,
+        to: String?
+      }
+    end
+  end
+end

data/sig/sentdm/models/conversation_messages_list.rbs

@@ -170,7 +170,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 +187,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 +248,36 @@ 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?, url: String }
+
+          class Media < Sentdm::Internal::Type::BaseModel
+            attr_accessor media_type: String?
+
+            attr_reader url: String?
+
+            def url=: (String) -> String
+
+            def initialize: (?media_type: String?, ?url: String) -> void
+
+            def to_hash: -> { media_type: String?, url: String }
+          end
         end
       end
     end

data/sig/sentdm/models/inbound_message_event.rbs

@@ -5,6 +5,7 @@ module Sentdm
         event: String?,
         field: String,
         payload: Sentdm::InboundMessageEventPayload?,
+        request_id: String?,
         timestamp: String
       }
 
@@ -17,6 +18,8 @@ module Sentdm
 
       attr_accessor payload: Sentdm::InboundMessageEventPayload?
 
+      attr_accessor request_id: String?
+
       attr_reader timestamp: String?
 
       def timestamp=: (String) -> String
@@ -25,6 +28,7 @@ module Sentdm
         ?event: String?,
         ?field: String,
         ?payload: Sentdm::InboundMessageEventPayload?,
+        ?request_id: String?,
         ?timestamp: String
       ) -> void
 
@@ -32,6 +36,7 @@ module Sentdm
         event: String?,
         field: String,
         payload: Sentdm::InboundMessageEventPayload?,
+        request_id: String?,
         timestamp: String
       }
     end

data/sig/sentdm/models/message_event.rbs

@@ -5,6 +5,7 @@ module Sentdm
         event: String?,
         field: String,
         payload: Sentdm::MessageEventPayload?,
+        request_id: String?,
         timestamp: String
       }
 
@@ -17,6 +18,8 @@ module Sentdm
 
       attr_accessor payload: Sentdm::MessageEventPayload?
 
+      attr_accessor request_id: String?
+
       attr_reader timestamp: String?
 
       def timestamp=: (String) -> String
@@ -25,6 +28,7 @@ module Sentdm
         ?event: String?,
         ?field: String,
         ?payload: Sentdm::MessageEventPayload?,
+        ?request_id: String?,
         ?timestamp: String
       ) -> void
 
@@ -32,6 +36,7 @@ module Sentdm
         event: String?,
         field: String,
         payload: Sentdm::MessageEventPayload?,
+        request_id: String?,
         timestamp: String
       }
     end

data/sig/sentdm/models/message_event_payload.rbs

@@ -5,9 +5,12 @@ module Sentdm
         message_status: String,
         account_id: String,
         agent_id: String?,
+        body: String?,
         channel: String,
         message_id: String,
         outbound_number: String,
+        schedule_reason: String?,
+        scheduled_at: String?,
         template_id: String?,
         template_name: String?,
         updated_at: String
@@ -22,6 +25,8 @@ module Sentdm
 
       attr_accessor agent_id: String?
 
+      attr_accessor body: String?
+
       attr_reader channel: String?
 
       def channel=: (String) -> String
@@ -34,6 +39,10 @@ module Sentdm
 
       def outbound_number=: (String) -> String
 
+      attr_accessor schedule_reason: String?
+
+      attr_accessor scheduled_at: String?
+
       attr_accessor template_id: String?
 
       attr_accessor template_name: String?
@@ -46,9 +55,12 @@ module Sentdm
         message_status: String,
         ?account_id: String,
         ?agent_id: String?,
+        ?body: String?,
         ?channel: String,
         ?message_id: String,
         ?outbound_number: String,
+        ?schedule_reason: String?,
+        ?scheduled_at: String?,
         ?template_id: String?,
         ?template_name: String?,
         ?updated_at: String
@@ -58,9 +70,12 @@ module Sentdm
         message_status: String,
         account_id: String,
         agent_id: String?,
+        body: String?,
         channel: String,
         message_id: String,
         outbound_number: String,
+        schedule_reason: String?,
+        scheduled_at: String?,
         template_id: String?,
         template_name: String?,
         updated_at: String

data/sig/sentdm/models/message_retrieve_activities_response.rbs

@@ -75,6 +75,7 @@ module Sentdm
             description: String,
             from: String?,
             price: String?,
+            scheduled_at: Time?,
             status: String,
             timestamp: Time
           }
@@ -90,6 +91,8 @@ module Sentdm
 
           attr_accessor price: String?
 
+          attr_accessor scheduled_at: Time?
+
           attr_reader status: String?
 
           def status=: (String) -> String
@@ -103,6 +106,7 @@ module Sentdm
             ?description: String,
             ?from: String?,
             ?price: String?,
+            ?scheduled_at: Time?,
             ?status: String,
             ?timestamp: Time
           ) -> void
@@ -112,6 +116,7 @@ module Sentdm
             description: String,
             from: String?,
             price: String?,
+            scheduled_at: Time?,
             status: String,
             timestamp: Time
           }

data/sig/sentdm/models/message_retrieve_status_response.rbs

@@ -178,7 +178,10 @@ module Sentdm
             buttons: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Button]?,
             content: String,
             footer: String?,
-            header: String?
+            header: String?,
+            header_media: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::HeaderMedia?,
+            media: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Media]?,
+            subject: String?
           }
 
         class MessageBody < Sentdm::Internal::Type::BaseModel
@@ -192,18 +195,30 @@ module Sentdm
 
           attr_accessor header: String?
 
+          attr_accessor header_media: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::HeaderMedia?
+
+          attr_accessor media: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Media]?
+
+          attr_accessor subject: String?
+
           def initialize: (
             ?buttons: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Button]?,
             ?content: String,
             ?footer: String?,
-            ?header: String?
+            ?header: String?,
+            ?header_media: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::HeaderMedia?,
+            ?media: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Media]?,
+            ?subject: String?
           ) -> void
 
           def to_hash: -> {
             buttons: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Button]?,
             content: String,
             footer: String?,
-            header: String?
+            header: String?,
+            header_media: Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::HeaderMedia?,
+            media: ::Array[Sentdm::Models::MessageRetrieveStatusResponse::Data::MessageBody::Media]?,
+            subject: String?
           }
 
           type button =
@@ -241,6 +256,36 @@ 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?, url: String }
+
+          class Media < Sentdm::Internal::Type::BaseModel
+            attr_accessor media_type: String?
+
+            attr_reader url: String?
+
+            def url=: (String) -> String
+
+            def initialize: (?media_type: String?, ?url: String) -> void
+
+            def to_hash: -> { media_type: String?, url: String }
+          end
         end
       end
     end

data/sig/sentdm/models/message_send_params.rbs

@@ -3,7 +3,10 @@ module Sentdm
     type message_send_params =
       {
         channel: ::Array[String]?,
+        media_urls: ::Array[String]?,
         sandbox: bool,
+        scheduled_at: Time?,
+        subject: String?,
         template: Sentdm::MessageSendParams::Template?,
         text: String?,
         to: ::Array[String],
@@ -18,10 +21,16 @@ module Sentdm
 
       attr_accessor channel: ::Array[String]?
 
+      attr_accessor media_urls: ::Array[String]?
+
       attr_reader sandbox: bool?
 
       def sandbox=: (bool) -> bool
 
+      attr_accessor scheduled_at: Time?
+
+      attr_accessor subject: String?
+
       attr_accessor template: Sentdm::MessageSendParams::Template?
 
       attr_accessor text: String?
@@ -40,7 +49,10 @@ module Sentdm
 
       def initialize: (
         ?channel: ::Array[String]?,
+        ?media_urls: ::Array[String]?,
         ?sandbox: bool,
+        ?scheduled_at: Time?,
+        ?subject: String?,
         ?template: Sentdm::MessageSendParams::Template?,
         ?text: String?,
         ?to: ::Array[String],
@@ -51,7 +63,10 @@ module Sentdm
 
       def to_hash: -> {
         channel: ::Array[String]?,
+        media_urls: ::Array[String]?,
         sandbox: bool,
+        scheduled_at: Time?,
+        subject: String?,
         template: Sentdm::MessageSendParams::Template?,
         text: String?,
         to: ::Array[String],