sentdm 0.26.0 → 0.28.0

data/rbi/sentdm/models/template_create_response.rbi

@@ -0,0 +1,349 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateCreateResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::TemplateCreateResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Template response for v3 API
+      sig { returns(T.nilable(Sentdm::Models::TemplateCreateResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::TemplateCreateResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::Models::TemplateCreateResponse::Error)) }
+      attr_reader :error
+
+      sig do
+        params(
+          error:
+            T.nilable(Sentdm::Models::TemplateCreateResponse::Error::OrHash)
+        ).void
+      end
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::Models::TemplateCreateResponse::Meta)) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Sentdm::Models::TemplateCreateResponse::Meta::OrHash).void
+      end
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::TemplateCreateResponse::Data::OrHash),
+          error:
+            T.nilable(Sentdm::Models::TemplateCreateResponse::Error::OrHash),
+          meta: Sentdm::Models::TemplateCreateResponse::Meta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Template response for v3 API
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::TemplateCreateResponse::Data),
+            error: T.nilable(Sentdm::Models::TemplateCreateResponse::Error),
+            meta: Sentdm::Models::TemplateCreateResponse::Meta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::TemplateCreateResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Which customer owns this — the key's own, or the profile named in x-profile-id.
+        # Says whose resource this is, which the resource's own id does not.
+        sig { returns(String) }
+        attr_accessor :customer_id
+
+        # Unique template identifier
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Template category: MARKETING, UTILITY, AUTHENTICATION
+        sig { returns(T.nilable(String)) }
+        attr_reader :category
+
+        sig { params(category: String).void }
+        attr_writer :category
+
+        # Supported channels: sms, whatsapp
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :channels
+
+        # When the template was created
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Whether the template is published and active
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_published
+
+        sig { params(is_published: T::Boolean).void }
+        attr_writer :is_published
+
+        # Template language code (e.g., en_US)
+        sig { returns(T.nilable(String)) }
+        attr_reader :language
+
+        sig { params(language: String).void }
+        attr_writer :language
+
+        # Template display name
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Template status: APPROVED, PENDING, REJECTED
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # When the template was last updated
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # Template variables for personalization
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_accessor :variables
+
+        # Template response for v3 API
+        sig do
+          params(
+            customer_id: String,
+            id: String,
+            category: String,
+            channels: T.nilable(T::Array[String]),
+            created_at: Time,
+            is_published: T::Boolean,
+            language: String,
+            name: String,
+            status: String,
+            updated_at: T.nilable(Time),
+            variables: T.nilable(T::Array[String])
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Which customer owns this — the key's own, or the profile named in x-profile-id.
+          # Says whose resource this is, which the resource's own id does not.
+          customer_id:,
+          # Unique template identifier
+          id: nil,
+          # Template category: MARKETING, UTILITY, AUTHENTICATION
+          category: nil,
+          # Supported channels: sms, whatsapp
+          channels: nil,
+          # When the template was created
+          created_at: nil,
+          # Whether the template is published and active
+          is_published: nil,
+          # Template language code (e.g., en_US)
+          language: nil,
+          # Template display name
+          name: nil,
+          # Template status: APPROVED, PENDING, REJECTED
+          status: nil,
+          # When the template was last updated
+          updated_at: nil,
+          # Template variables for personalization
+          variables: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              customer_id: String,
+              id: String,
+              category: String,
+              channels: T.nilable(T::Array[String]),
+              created_at: Time,
+              is_published: T::Boolean,
+              language: String,
+              name: String,
+              status: String,
+              updated_at: T.nilable(Time),
+              variables: T.nilable(T::Array[String])
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::TemplateCreateResponse::Error,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Machine-readable error code (e.g., "RESOURCE_001")
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Additional validation error details (field-level errors)
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :details
+
+        # URL to documentation about this error
+        sig { returns(T.nilable(String)) }
+        attr_accessor :doc_url
+
+        # Human-readable error message
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Error information
+        sig do
+          params(
+            code: String,
+            details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            doc_url: T.nilable(String),
+            message: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Machine-readable error code (e.g., "RESOURCE_001")
+          code: nil,
+          # Additional validation error details (field-level errors)
+          details: nil,
+          # URL to documentation about this error
+          doc_url: nil,
+          # Human-readable error message
+          message: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              doc_url: T.nilable(String),
+              message: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::TemplateCreateResponse::Meta,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for this request (for tracing and support)
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # Server timestamp when the response was generated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # API version used for this request
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Request and response metadata
+        sig do
+          params(request_id: String, timestamp: Time, version: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for this request (for tracing and support)
+          request_id: nil,
+          # Server timestamp when the response was generated
+          timestamp: nil,
+          # API version used for this request
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { request_id: String, timestamp: Time, version: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/template_event.rbi

@@ -0,0 +1,84 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class TemplateEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::TemplateEvent, Sentdm::Internal::AnyHash) }
+
+      # The specific event within the family, for example message.delivered or
+      # message.received. Absent on events that have no subtype, so treat it as
+      # optional.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :event
+
+      # The event family, for example message or templates. Route on this first, then on
+      # event for the specific change.
+      sig { returns(T.nilable(String)) }
+      attr_reader :field
+
+      sig { params(field: String).void }
+      attr_writer :field
+
+      # Body of a template status event. Delivered when a template's review outcome
+      # changes, so you can react without polling.
+      sig { returns(T.nilable(Sentdm::TemplateEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(payload: T.nilable(Sentdm::TemplateEventPayload::OrHash)).void
+      end
+      attr_writer :payload
+
+      # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+      # time, not the time the underlying change happened. Use the timestamp inside the
+      # payload for the latter.
+      sig { returns(T.nilable(String)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: String).void }
+      attr_writer :timestamp
+
+      # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      # this shape and varies only in Payload.
+      sig do
+        params(
+          event: T.nilable(String),
+          field: String,
+          payload: T.nilable(Sentdm::TemplateEventPayload::OrHash),
+          timestamp: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The specific event within the family, for example message.delivered or
+        # message.received. Absent on events that have no subtype, so treat it as
+        # optional.
+        event: nil,
+        # The event family, for example message or templates. Route on this first, then on
+        # event for the specific change.
+        field: nil,
+        # Body of a template status event. Delivered when a template's review outcome
+        # changes, so you can react without polling.
+        payload: nil,
+        # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+        # time, not the time the underlying change happened. Use the timestamp inside the
+        # payload for the latter.
+        timestamp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event: T.nilable(String),
+            field: String,
+            payload: T.nilable(Sentdm::TemplateEventPayload),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

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/template_list_params.rbi

@@ -23,7 +23,11 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :category
 
-      # Optional filter by welcome playground flag
+      # Accepted and ignored. It used to filter on the welcome-playground marker inside
+      # a template's LOB details; that filter is gone and nothing reads this value, so
+      # sending it neither narrows nor widens the result. Retained only so a client
+      # still passing is_welcome_playground keeps binding instead of the request shape
+      # changing under it.
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :is_welcome_playground
 
@@ -60,7 +64,11 @@ module Sentdm
         page_size:,
         # Optional category filter: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
-        # Optional filter by welcome playground flag
+        # Accepted and ignored. It used to filter on the welcome-playground marker inside
+        # a template's LOB details; that filter is gone and nothing reads this value, so
+        # sending it neither narrows nor widens the result. Retained only so a client
+        # still passing is_welcome_playground keeps binding instead of the request shape
+        # changing under it.
         is_welcome_playground: nil,
         # Optional search term for filtering templates
         search: nil,