sentdm 0.26.0 → 0.27.0

data/rbi/sentdm/models/template_event_payload.rbi

@@ -0,0 +1,131 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateEventPayload < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::TemplateEventPayload, Sentdm::Internal::AnyHash)
+        end
+
+      # The account the template belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
+      sig { returns(T.nilable(String)) }
+      attr_reader :category
+
+      sig { params(category: String).void }
+      attr_writer :category
+
+      # The channel the template applies to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      # The template's language code, for example en_US.
+      sig { returns(T.nilable(String)) }
+      attr_reader :language
+
+      sig { params(language: String).void }
+      attr_writer :language
+
+      # Why the template reached Status, when a reason was given. Populated on a
+      # rejection.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :reason
+
+      # The review status the template just reached, for example APPROVED or REJECTED.
+      sig { returns(T.nilable(String)) }
+      attr_reader :status
+
+      sig { params(status: String).void }
+      attr_writer :status
+
+      # The template in Sent.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_id
+
+      sig { params(template_id: String).void }
+      attr_writer :template_id
+
+      # The template's display name.
+      sig { returns(T.nilable(String)) }
+      attr_reader :template_name
+
+      sig { params(template_name: String).void }
+      attr_writer :template_name
+
+      # The template's identifier with Meta, assigned when the template is submitted for
+      # review.
+      sig { returns(T.nilable(String)) }
+      attr_reader :whatsapp_template_id
+
+      sig { params(whatsapp_template_id: String).void }
+      attr_writer :whatsapp_template_id
+
+      # Body of a template status event. Delivered when a template's review outcome
+      # changes, so you can react without polling.
+      sig do
+        params(
+          account_id: String,
+          category: String,
+          channel: String,
+          language: String,
+          reason: T.nilable(String),
+          status: String,
+          template_id: String,
+          template_name: String,
+          whatsapp_template_id: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account the template belongs to.
+        account_id: nil,
+        # The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
+        category: nil,
+        # The channel the template applies to.
+        channel: nil,
+        # The template's language code, for example en_US.
+        language: nil,
+        # Why the template reached Status, when a reason was given. Populated on a
+        # rejection.
+        reason: nil,
+        # The review status the template just reached, for example APPROVED or REJECTED.
+        status: nil,
+        # The template in Sent.
+        template_id: nil,
+        # The template's display name.
+        template_name: nil,
+        # The template's identifier with Meta, assigned when the template is submitted for
+        # review.
+        whatsapp_template_id: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            category: String,
+            channel: String,
+            language: String,
+            reason: T.nilable(String),
+            status: String,
+            template_id: String,
+            template_name: String,
+            whatsapp_template_id: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/webhook_list_events_response.rbi

@@ -183,10 +183,29 @@ module Sentdm
           sig { returns(T.nilable(String)) }
           attr_accessor :error_message
 
-          sig { returns(T.nilable(T.anything)) }
+          # The exact event body that was delivered, or attempted, for this record. One of
+          # the three webhook envelopes: a message status change, an inbound message, or a
+          # template status change. Read field and event to tell which, the same way your
+          # endpoint does.
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData::Variants
+              )
+            )
+          end
           attr_reader :event_data
 
-          sig { params(event_data: T.anything).void }
+          sig do
+            params(
+              event_data:
+                T.any(
+                  Sentdm::MessageEvent::OrHash,
+                  Sentdm::InboundMessageEvent::OrHash,
+                  Sentdm::TemplateEvent::OrHash
+                )
+            ).void
+          end
           attr_writer :event_data
 
           sig { returns(T.nilable(String)) }
@@ -214,7 +233,12 @@ module Sentdm
               delivery_attempts: Integer,
               delivery_status: String,
               error_message: T.nilable(String),
-              event_data: T.anything,
+              event_data:
+                T.any(
+                  Sentdm::MessageEvent::OrHash,
+                  Sentdm::InboundMessageEvent::OrHash,
+                  Sentdm::TemplateEvent::OrHash
+                ),
               event_type: String,
               http_status_code: T.nilable(Integer),
               processing_completed_at: T.nilable(Time),
@@ -228,6 +252,10 @@ module Sentdm
             delivery_attempts: nil,
             delivery_status: nil,
             error_message: nil,
+            # The exact event body that was delivered, or attempted, for this record. One of
+            # the three webhook envelopes: a message status change, an inbound message, or a
+            # template status change. Read field and event to tell which, the same way your
+            # endpoint does.
             event_data: nil,
             event_type: nil,
             http_status_code: nil,
@@ -245,7 +273,8 @@ module Sentdm
                 delivery_attempts: Integer,
                 delivery_status: String,
                 error_message: T.nilable(String),
-                event_data: T.anything,
+                event_data:
+                  Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData::Variants,
                 event_type: String,
                 http_status_code: T.nilable(Integer),
                 processing_completed_at: T.nilable(Time),
@@ -256,6 +285,33 @@ module Sentdm
           end
           def to_hash
           end
+
+          # The exact event body that was delivered, or attempted, for this record. One of
+          # the three webhook envelopes: a message status change, an inbound message, or a
+          # template status change. Read field and event to tell which, the same way your
+          # endpoint does.
+          module EventData
+            extend Sentdm::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  Sentdm::MessageEvent,
+                  Sentdm::InboundMessageEvent,
+                  Sentdm::TemplateEvent
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
         end
       end
     end

data/rbi/sentdm/models.rbi

@@ -59,8 +59,16 @@ module Sentdm
 
   ErrorDetail = Sentdm::Models::ErrorDetail
 
+  InboundMessageEvent = Sentdm::Models::InboundMessageEvent
+
+  InboundMessageEventPayload = Sentdm::Models::InboundMessageEventPayload
+
   MeRetrieveParams = Sentdm::Models::MeRetrieveParams
 
+  MessageEvent = Sentdm::Models::MessageEvent
+
+  MessageEventPayload = Sentdm::Models::MessageEventPayload
+
   MessageRetrieveActivitiesParams =
     Sentdm::Models::MessageRetrieveActivitiesParams
 
@@ -114,6 +122,10 @@ module Sentdm
 
   TemplateDeleteParams = Sentdm::Models::TemplateDeleteParams
 
+  TemplateEvent = Sentdm::Models::TemplateEvent
+
+  TemplateEventPayload = Sentdm::Models::TemplateEventPayload
+
   TemplateFooter = Sentdm::Models::TemplateFooter
 
   TemplateHeader = Sentdm::Models::TemplateHeader

data/rbi/sentdm/resources/messages.rbi

@@ -46,10 +46,12 @@ module Sentdm
       # multi-channel broadcast — when multiple channels are specified (e.g. ["sms",
       # "whatsapp"]), a separate message is created for each (recipient, channel) pair.
       # Returns immediately with per-recipient message IDs for async tracking via
-      # webhooks or the GET /messages/{id} endpoint. Account-level preconditions such as
-      # insufficient balance do not reject the request: the send is accepted with 202
-      # and the affected messages are reported as BLOCKED on GET /messages/{id} and the
-      # message status webhook.
+      # webhooks or the GET /messages/{id} endpoint. Sends gated before any delivery
+      # attempt do not reject the request — an account-level precondition such as
+      # 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.
       sig do
         params(
           channel: T.nilable(T::Array[String]),

data/rbi/sentdm/resources/profiles.rbi

@@ -148,6 +148,7 @@ module Sentdm
         ).returns(Sentdm::APIResponseOfProfileDetail)
       end
       def retrieve(
+        # Profile ID from route parameter
         profile_id,
         # Profile UUID to scope the request to a child profile. Only organization API keys
         # can use this header. The profile must belong to the calling organization.
@@ -203,7 +204,7 @@ module Sentdm
         ).returns(Sentdm::APIResponseOfProfileDetail)
       end
       def update(
-        # Path param
+        # Path param: Profile ID from route parameter
         profile_id,
         # Body param: Whether contacts are shared across profiles (optional)
         allow_contact_sharing: nil,
@@ -302,7 +303,7 @@ module Sentdm
         ).void
       end
       def delete(
-        # Path param
+        # Path param: Profile ID from route parameter
         profile_id,
         # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution

data/rbi/sentdm/resources/users.rbi

@@ -14,6 +14,7 @@ module Sentdm
         ).returns(Sentdm::APIResponseOfUser)
       end
       def retrieve(
+        # User ID from route parameter
         user_id,
         # Profile UUID to scope the request to a child profile. Only organization API keys
         # can use this header. The profile must belong to the calling organization.
@@ -86,7 +87,7 @@ module Sentdm
         ).void
       end
       def remove(
-        # Path param
+        # Path param: User ID from route parameter
         user_id,
         # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
@@ -112,7 +113,7 @@ module Sentdm
         ).returns(Sentdm::APIResponseOfUser)
       end
       def update_role(
-        # Path param
+        # Path param: User ID from route parameter
         user_id,
         # Body param: User role: admin, billing, or developer (required)
         role: nil,

data/sig/sentdm/models/inbound_message_event.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type inbound_message_event =
+      {
+        event: String?,
+        field: String,
+        payload: Sentdm::InboundMessageEventPayload?,
+        timestamp: String
+      }
+
+    class InboundMessageEvent < Sentdm::Internal::Type::BaseModel
+      attr_accessor event: String?
+
+      attr_reader field: String?
+
+      def field=: (String) -> String
+
+      attr_accessor payload: Sentdm::InboundMessageEventPayload?
+
+      attr_reader timestamp: String?
+
+      def timestamp=: (String) -> String
+
+      def initialize: (
+        ?event: String?,
+        ?field: String,
+        ?payload: Sentdm::InboundMessageEventPayload?,
+        ?timestamp: String
+      ) -> void
+
+      def to_hash: -> {
+        event: String?,
+        field: String,
+        payload: Sentdm::InboundMessageEventPayload?,
+        timestamp: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/inbound_message_event_payload.rbs

@@ -0,0 +1,69 @@
+module Sentdm
+  module Models
+    type inbound_message_event_payload =
+      {
+        account_id: String,
+        channel: String,
+        inbound_number: String,
+        message_id: String,
+        outbound_number: String,
+        received_at: String,
+        text: String?,
+        updated_at: String
+      }
+
+    class InboundMessageEventPayload < Sentdm::Internal::Type::BaseModel
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_reader channel: String?
+
+      def channel=: (String) -> String
+
+      attr_reader inbound_number: String?
+
+      def inbound_number=: (String) -> String
+
+      attr_reader message_id: String?
+
+      def message_id=: (String) -> String
+
+      attr_reader outbound_number: String?
+
+      def outbound_number=: (String) -> String
+
+      attr_reader received_at: String?
+
+      def received_at=: (String) -> String
+
+      attr_accessor text: String?
+
+      attr_reader updated_at: String?
+
+      def updated_at=: (String) -> String
+
+      def initialize: (
+        ?account_id: String,
+        ?channel: String,
+        ?inbound_number: String,
+        ?message_id: String,
+        ?outbound_number: String,
+        ?received_at: String,
+        ?text: String?,
+        ?updated_at: String
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        channel: String,
+        inbound_number: String,
+        message_id: String,
+        outbound_number: String,
+        received_at: String,
+        text: String?,
+        updated_at: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/message_event.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type message_event =
+      {
+        event: String?,
+        field: String,
+        payload: Sentdm::MessageEventPayload?,
+        timestamp: String
+      }
+
+    class MessageEvent < Sentdm::Internal::Type::BaseModel
+      attr_accessor event: String?
+
+      attr_reader field: String?
+
+      def field=: (String) -> String
+
+      attr_accessor payload: Sentdm::MessageEventPayload?
+
+      attr_reader timestamp: String?
+
+      def timestamp=: (String) -> String
+
+      def initialize: (
+        ?event: String?,
+        ?field: String,
+        ?payload: Sentdm::MessageEventPayload?,
+        ?timestamp: String
+      ) -> void
+
+      def to_hash: -> {
+        event: String?,
+        field: String,
+        payload: Sentdm::MessageEventPayload?,
+        timestamp: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/message_event_payload.rbs

@@ -0,0 +1,72 @@
+module Sentdm
+  module Models
+    type message_event_payload =
+      {
+        account_id: String,
+        agent_id: String?,
+        channel: String,
+        message_id: String,
+        message_status: String,
+        outbound_number: String,
+        template_id: String?,
+        template_name: String?,
+        updated_at: String
+      }
+
+    class MessageEventPayload < Sentdm::Internal::Type::BaseModel
+      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 message_id: String?
+
+      def message_id=: (String) -> String
+
+      attr_reader message_status: String?
+
+      def message_status=: (String) -> String
+
+      attr_reader outbound_number: String?
+
+      def outbound_number=: (String) -> String
+
+      attr_accessor template_id: String?
+
+      attr_accessor template_name: String?
+
+      attr_reader updated_at: String?
+
+      def updated_at=: (String) -> String
+
+      def initialize: (
+        ?account_id: String,
+        ?agent_id: String?,
+        ?channel: String,
+        ?message_id: String,
+        ?message_status: String,
+        ?outbound_number: String,
+        ?template_id: String?,
+        ?template_name: String?,
+        ?updated_at: String
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        agent_id: String?,
+        channel: String,
+        message_id: String,
+        message_status: String,
+        outbound_number: String,
+        template_id: String?,
+        template_name: String?,
+        updated_at: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/template_event.rbs

@@ -0,0 +1,39 @@
+module Sentdm
+  module Models
+    type template_event =
+      {
+        event: String?,
+        field: String,
+        payload: Sentdm::TemplateEventPayload?,
+        timestamp: String
+      }
+
+    class TemplateEvent < Sentdm::Internal::Type::BaseModel
+      attr_accessor event: String?
+
+      attr_reader field: String?
+
+      def field=: (String) -> String
+
+      attr_accessor payload: Sentdm::TemplateEventPayload?
+
+      attr_reader timestamp: String?
+
+      def timestamp=: (String) -> String
+
+      def initialize: (
+        ?event: String?,
+        ?field: String,
+        ?payload: Sentdm::TemplateEventPayload?,
+        ?timestamp: String
+      ) -> void
+
+      def to_hash: -> {
+        event: String?,
+        field: String,
+        payload: Sentdm::TemplateEventPayload?,
+        timestamp: String
+      }
+    end
+  end
+end

data/sig/sentdm/models/template_event_payload.rbs

@@ -0,0 +1,76 @@
+module Sentdm
+  module Models
+    type template_event_payload =
+      {
+        account_id: String,
+        category: String,
+        channel: String,
+        language: String,
+        reason: String?,
+        status: String,
+        template_id: String,
+        template_name: String,
+        whatsapp_template_id: String
+      }
+
+    class TemplateEventPayload < Sentdm::Internal::Type::BaseModel
+      attr_reader account_id: String?
+
+      def account_id=: (String) -> String
+
+      attr_reader category: String?
+
+      def category=: (String) -> String
+
+      attr_reader channel: String?
+
+      def channel=: (String) -> String
+
+      attr_reader language: String?
+
+      def language=: (String) -> String
+
+      attr_accessor reason: String?
+
+      attr_reader status: String?
+
+      def status=: (String) -> String
+
+      attr_reader template_id: String?
+
+      def template_id=: (String) -> String
+
+      attr_reader template_name: String?
+
+      def template_name=: (String) -> String
+
+      attr_reader whatsapp_template_id: String?
+
+      def whatsapp_template_id=: (String) -> String
+
+      def initialize: (
+        ?account_id: String,
+        ?category: String,
+        ?channel: String,
+        ?language: String,
+        ?reason: String?,
+        ?status: String,
+        ?template_id: String,
+        ?template_name: String,
+        ?whatsapp_template_id: String
+      ) -> void
+
+      def to_hash: -> {
+        account_id: String,
+        category: String,
+        channel: String,
+        language: String,
+        reason: String?,
+        status: String,
+        template_id: String,
+        template_name: String,
+        whatsapp_template_id: String
+      }
+    end
+  end
+end