sentdm 0.30.0 → 0.32.0

data/rbi/sentdm/models/template_list_params.rbi

@@ -11,14 +11,6 @@ module Sentdm
           T.any(Sentdm::TemplateListParams, Sentdm::Internal::AnyHash)
         end
 
-      # Page number (1-indexed)
-      sig { returns(Integer) }
-      attr_accessor :page
-
-      # Number of items per page
-      sig { returns(Integer) }
-      attr_accessor :page_size
-
       # Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       sig { returns(T.nilable(String)) }
       attr_accessor :category
@@ -31,6 +23,20 @@ module Sentdm
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :is_welcome_playground
 
+      # Page number (1-indexed)
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Number of items per page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
       # Optional search term for filtering templates
       sig { returns(T.nilable(String)) }
       attr_accessor :search
@@ -47,10 +53,10 @@ module Sentdm
 
       sig do
         params(
-          page: Integer,
-          page_size: Integer,
           category: T.nilable(String),
           is_welcome_playground: T.nilable(T::Boolean),
+          page: Integer,
+          page_size: Integer,
           search: T.nilable(String),
           status: T.nilable(String),
           x_profile_id: String,
@@ -58,10 +64,6 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
-        # Page number (1-indexed)
-        page:,
-        # Number of items per page
-        page_size:,
         # Optional category filter: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
         # Accepted and ignored. It used to filter on the welcome-playground marker inside
@@ -70,6 +72,10 @@ module Sentdm
         # still passing is_welcome_playground keeps binding instead of the request shape
         # changing under it.
         is_welcome_playground: nil,
+        # Page number (1-indexed)
+        page: nil,
+        # Number of items per page
+        page_size: nil,
         # Optional search term for filtering templates
         search: nil,
         # Optional status filter: APPROVED, PENDING, REJECTED
@@ -82,10 +88,10 @@ module Sentdm
       sig do
         override.returns(
           {
-            page: Integer,
-            page_size: Integer,
             category: T.nilable(String),
             is_welcome_playground: T.nilable(T::Boolean),
+            page: Integer,
+            page_size: Integer,
             search: T.nilable(String),
             status: T.nilable(String),
             x_profile_id: String,

data/rbi/sentdm/models/template_variable.rbi

@@ -8,6 +8,9 @@ module Sentdm
           T.any(Sentdm::TemplateVariable, Sentdm::Internal::AnyHash)
         end
 
+      # The variable's name, and the key callers use for it in a send request's
+      # parameters object. Must start with a letter and hold only letters, digits and
+      # underscores.
       sig { returns(String) }
       attr_accessor :name
 
@@ -17,9 +20,17 @@ module Sentdm
       sig { params(props: Sentdm::TemplateVariable::Props::OrHash).void }
       attr_writer :props
 
+      # One of variable, link or media. Decides which Props fields are required.
       sig { returns(String) }
       attr_accessor :type
 
+      # The variable's index, and the number its {{index:variable}} placeholder refers
+      # to.
+      #
+      # Omitting it is only safe for a section holding a single variable. The field is a
+      # non-nullable int, so every variable that leaves it out defaults to 0, and a
+      # section with two such variables is refused by the unique-id rule ("variables
+      # must have unique IDs"). Number them from 0 in the order they appear.
       sig { returns(T.nilable(Integer)) }
       attr_reader :id
 
@@ -34,7 +45,23 @@ module Sentdm
           id: Integer
         ).returns(T.attached_class)
       end
-      def self.new(name:, props:, type:, id: nil)
+      def self.new(
+        # The variable's name, and the key callers use for it in a send request's
+        # parameters object. Must start with a letter and hold only letters, digits and
+        # underscores.
+        name:,
+        props:,
+        # One of variable, link or media. Decides which Props fields are required.
+        type:,
+        # The variable's index, and the number its {{index:variable}} placeholder refers
+        # to.
+        #
+        # Omitting it is only safe for a section holding a single variable. The field is a
+        # non-nullable int, so every variable that leaves it out defaults to 0, and a
+        # section with two such variables is refused by the unique-id rule ("variables
+        # must have unique IDs"). Number them from 0 in the order they appear.
+        id: nil
+      )
       end
 
       sig do

data/rbi/sentdm/models/webhook_list_events_params.rbi

@@ -14,11 +14,17 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :id
 
-      sig { returns(Integer) }
-      attr_accessor :page
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
 
-      sig { returns(Integer) }
-      attr_accessor :page_size
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
 
       sig { returns(T.nilable(String)) }
       attr_accessor :search
@@ -41,8 +47,8 @@ module Sentdm
       end
       def self.new(
         id:,
-        page:,
-        page_size:,
+        page: nil,
+        page_size: nil,
         search: nil,
         x_profile_id: nil,
         request_options: {}

data/rbi/sentdm/models/webhook_list_events_response.rbi

@@ -11,309 +11,166 @@ module Sentdm
           )
         end
 
-      # A paginated list of webhook delivery records.
+      sig { returns(T.nilable(String)) }
+      attr_reader :id
+
+      sig { params(id: String).void }
+      attr_writer :id
+
+      sig { returns(T.nilable(Time)) }
+      attr_reader :created_at
+
+      sig { params(created_at: Time).void }
+      attr_writer :created_at
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :delivery_attempts
+
+      sig { params(delivery_attempts: Integer).void }
+      attr_writer :delivery_attempts
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :delivery_status
+
+      sig { params(delivery_status: String).void }
+      attr_writer :delivery_status
+
+      sig { returns(T.nilable(String)) }
+      attr_accessor :error_message
+
+      # The exact event body that was delivered, or attempted, for this record. One of
+      # the four webhook envelopes: a message status change, an inbound message, a
+      # template status change, or a contact consent signal. Read field and event to
+      # tell which, the same way your endpoint does.
       sig do
-        returns(T.nilable(Sentdm::Models::WebhookListEventsResponse::Data))
+        returns(
+          T.nilable(
+            Sentdm::Models::WebhookListEventsResponse::EventData::Variants
+          )
+        )
       end
-      attr_reader :data
+      attr_reader :event_data
 
       sig do
         params(
-          data:
-            T.nilable(Sentdm::Models::WebhookListEventsResponse::Data::OrHash)
+          event_data:
+            T.any(
+              Sentdm::MessageEvent::OrHash,
+              Sentdm::InboundMessageEvent::OrHash,
+              Sentdm::TemplateEvent::OrHash,
+              Sentdm::ChannelEvent::OrHash,
+              Sentdm::ContactEvent::OrHash
+            )
         ).void
       end
-      attr_writer :data
+      attr_writer :event_data
 
-      # Error information
-      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
-      attr_reader :error
+      sig { returns(T.nilable(String)) }
+      attr_reader :event_type
 
-      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
-      attr_writer :error
+      sig { params(event_type: String).void }
+      attr_writer :event_type
 
-      # Request and response metadata
-      sig { returns(T.nilable(Sentdm::APIMeta)) }
-      attr_reader :meta
+      sig { returns(T.nilable(Integer)) }
+      attr_accessor :http_status_code
 
-      sig { params(meta: Sentdm::APIMeta::OrHash).void }
-      attr_writer :meta
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :processing_completed_at
 
-      # Indicates whether the request was successful
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :success
+      sig { returns(T.nilable(Time)) }
+      attr_accessor :processing_started_at
 
-      sig { params(success: T::Boolean).void }
-      attr_writer :success
+      sig { returns(T.nilable(String)) }
+      attr_accessor :response_body
 
-      # Standard API response envelope for all v3 endpoints
       sig do
         params(
-          data:
-            T.nilable(Sentdm::Models::WebhookListEventsResponse::Data::OrHash),
-          error: T.nilable(Sentdm::ErrorDetail::OrHash),
-          meta: Sentdm::APIMeta::OrHash,
-          success: T::Boolean
+          id: String,
+          created_at: Time,
+          delivery_attempts: Integer,
+          delivery_status: String,
+          error_message: T.nilable(String),
+          event_data:
+            T.any(
+              Sentdm::MessageEvent::OrHash,
+              Sentdm::InboundMessageEvent::OrHash,
+              Sentdm::TemplateEvent::OrHash,
+              Sentdm::ChannelEvent::OrHash,
+              Sentdm::ContactEvent::OrHash
+            ),
+          event_type: String,
+          http_status_code: T.nilable(Integer),
+          processing_completed_at: T.nilable(Time),
+          processing_started_at: T.nilable(Time),
+          response_body: T.nilable(String)
         ).returns(T.attached_class)
       end
       def self.new(
-        # A paginated list of webhook delivery records.
-        data: nil,
-        # Error information
-        error: nil,
-        # Request and response metadata
-        meta: nil,
-        # Indicates whether the request was successful
-        success: nil
+        id: nil,
+        created_at: nil,
+        delivery_attempts: nil,
+        delivery_status: nil,
+        error_message: nil,
+        # The exact event body that was delivered, or attempted, for this record. One of
+        # the four webhook envelopes: a message status change, an inbound message, a
+        # template status change, or a contact consent signal. Read field and event to
+        # tell which, the same way your endpoint does.
+        event_data: nil,
+        event_type: nil,
+        http_status_code: nil,
+        processing_completed_at: nil,
+        processing_started_at: nil,
+        response_body: nil
       )
       end
 
       sig do
         override.returns(
           {
-            data: T.nilable(Sentdm::Models::WebhookListEventsResponse::Data),
-            error: T.nilable(Sentdm::ErrorDetail),
-            meta: Sentdm::APIMeta,
-            success: T::Boolean
+            id: String,
+            created_at: Time,
+            delivery_attempts: Integer,
+            delivery_status: String,
+            error_message: T.nilable(String),
+            event_data:
+              Sentdm::Models::WebhookListEventsResponse::EventData::Variants,
+            event_type: String,
+            http_status_code: T.nilable(Integer),
+            processing_completed_at: T.nilable(Time),
+            processing_started_at: T.nilable(Time),
+            response_body: T.nilable(String)
           }
         )
       end
       def to_hash
       end
 
-      class Data < Sentdm::Internal::Type::BaseModel
-        OrHash =
+      # The exact event body that was delivered, or attempted, for this record. One of
+      # the four webhook envelopes: a message status change, an inbound message, a
+      # template status change, or a contact consent signal. 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::Models::WebhookListEventsResponse::Data,
-              Sentdm::Internal::AnyHash
+              Sentdm::MessageEvent,
+              Sentdm::InboundMessageEvent,
+              Sentdm::TemplateEvent,
+              Sentdm::ChannelEvent,
+              Sentdm::ContactEvent
             )
           end
 
-        # The events on this page.
-        sig do
-          returns(
-            T.nilable(
-              T::Array[Sentdm::Models::WebhookListEventsResponse::Data::Event]
-            )
-          )
-        end
-        attr_reader :events
-
-        sig do
-          params(
-            events:
-              T::Array[
-                Sentdm::Models::WebhookListEventsResponse::Data::Event::OrHash
-              ]
-          ).void
-        end
-        attr_writer :events
-
-        # Pagination metadata for list responses
-        sig { returns(T.nilable(Sentdm::PaginationMeta)) }
-        attr_reader :pagination
-
-        sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
-        attr_writer :pagination
-
-        # A paginated list of webhook delivery records.
-        sig do
-          params(
-            events:
-              T::Array[
-                Sentdm::Models::WebhookListEventsResponse::Data::Event::OrHash
-              ],
-            pagination: Sentdm::PaginationMeta::OrHash
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # The events on this page.
-          events: nil,
-          # Pagination metadata for list responses
-          pagination: nil
-        )
-        end
-
         sig do
           override.returns(
-            {
-              events:
-                T::Array[
-                  Sentdm::Models::WebhookListEventsResponse::Data::Event
-                ],
-              pagination: Sentdm::PaginationMeta
-            }
+            T::Array[
+              Sentdm::Models::WebhookListEventsResponse::EventData::Variants
+            ]
           )
         end
-        def to_hash
-        end
-
-        class Event < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::Models::WebhookListEventsResponse::Data::Event,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :id
-
-          sig { params(id: String).void }
-          attr_writer :id
-
-          sig { returns(T.nilable(Time)) }
-          attr_reader :created_at
-
-          sig { params(created_at: Time).void }
-          attr_writer :created_at
-
-          sig { returns(T.nilable(Integer)) }
-          attr_reader :delivery_attempts
-
-          sig { params(delivery_attempts: Integer).void }
-          attr_writer :delivery_attempts
-
-          sig { returns(T.nilable(String)) }
-          attr_reader :delivery_status
-
-          sig { params(delivery_status: String).void }
-          attr_writer :delivery_status
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :error_message
-
-          # 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 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)) }
-          attr_reader :event_type
-
-          sig { params(event_type: String).void }
-          attr_writer :event_type
-
-          sig { returns(T.nilable(Integer)) }
-          attr_accessor :http_status_code
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :processing_completed_at
-
-          sig { returns(T.nilable(Time)) }
-          attr_accessor :processing_started_at
-
-          sig { returns(T.nilable(String)) }
-          attr_accessor :response_body
-
-          sig do
-            params(
-              id: String,
-              created_at: Time,
-              delivery_attempts: Integer,
-              delivery_status: String,
-              error_message: T.nilable(String),
-              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),
-              processing_started_at: T.nilable(Time),
-              response_body: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            id: nil,
-            created_at: nil,
-            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,
-            processing_completed_at: nil,
-            processing_started_at: nil,
-            response_body: nil
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                id: String,
-                created_at: Time,
-                delivery_attempts: Integer,
-                delivery_status: String,
-                error_message: T.nilable(String),
-                event_data:
-                  Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData::Variants,
-                event_type: String,
-                http_status_code: T.nilable(Integer),
-                processing_completed_at: T.nilable(Time),
-                processing_started_at: T.nilable(Time),
-                response_body: T.nilable(String)
-              }
-            )
-          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
+        def self.variants
         end
       end
     end

data/rbi/sentdm/models/webhook_list_params.rbi

@@ -11,15 +11,21 @@ module Sentdm
           T.any(Sentdm::WebhookListParams, Sentdm::Internal::AnyHash)
         end
 
-      sig { returns(Integer) }
-      attr_accessor :page
-
-      sig { returns(Integer) }
-      attr_accessor :page_size
-
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :is_active
 
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page_size
+
+      sig { params(page_size: Integer).void }
+      attr_writer :page_size
+
       sig { returns(T.nilable(String)) }
       attr_accessor :search
 
@@ -31,18 +37,18 @@ module Sentdm
 
       sig do
         params(
+          is_active: T.nilable(T::Boolean),
           page: Integer,
           page_size: Integer,
-          is_active: T.nilable(T::Boolean),
           search: T.nilable(String),
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        page:,
-        page_size:,
         is_active: nil,
+        page: nil,
+        page_size: nil,
         search: nil,
         x_profile_id: nil,
         request_options: {}
@@ -52,9 +58,9 @@ module Sentdm
       sig do
         override.returns(
           {
+            is_active: T.nilable(T::Boolean),
             page: Integer,
             page_size: Integer,
-            is_active: T.nilable(T::Boolean),
             search: T.nilable(String),
             x_profile_id: String,
             request_options: Sentdm::RequestOptions

data/rbi/sentdm/models.rbi

@@ -31,10 +31,18 @@ module Sentdm
 
   BrandsBrandData = Sentdm::Models::BrandsBrandData
 
+  ChannelEvent = Sentdm::Models::ChannelEvent
+
+  ChannelEventPayload = Sentdm::Models::ChannelEventPayload
+
   ContactCreateParams = Sentdm::Models::ContactCreateParams
 
   ContactDeleteParams = Sentdm::Models::ContactDeleteParams
 
+  ContactEvent = Sentdm::Models::ContactEvent
+
+  ContactEventPayload = Sentdm::Models::ContactEventPayload
+
   ContactListParams = Sentdm::Models::ContactListParams
 
   ContactMessageSummary = Sentdm::Models::ContactMessageSummary