sentdm 0.26.0 → 0.28.0

data/lib/sentdm/models/template_event_payload.rb

@@ -0,0 +1,88 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class TemplateEventPayload < Sentdm::Internal::Type::BaseModel
+      # @!attribute account_id
+      #   The account the template belongs to.
+      #
+      #   @return [String, nil]
+      optional :account_id, String
+
+      # @!attribute category
+      #   The template's category, for example UTILITY, MARKETING, or AUTHENTICATION.
+      #
+      #   @return [String, nil]
+      optional :category, String
+
+      # @!attribute channel
+      #   The channel the template applies to.
+      #
+      #   @return [String, nil]
+      optional :channel, String
+
+      # @!attribute language
+      #   The template's language code, for example en_US.
+      #
+      #   @return [String, nil]
+      optional :language, String
+
+      # @!attribute reason
+      #   Why the template reached Status, when a reason was given. Populated on a
+      #   rejection.
+      #
+      #   @return [String, nil]
+      optional :reason, String, nil?: true
+
+      # @!attribute status
+      #   The review status the template just reached, for example APPROVED or REJECTED.
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!attribute template_id
+      #   The template in Sent.
+      #
+      #   @return [String, nil]
+      optional :template_id, String
+
+      # @!attribute template_name
+      #   The template's display name.
+      #
+      #   @return [String, nil]
+      optional :template_name, String
+
+      # @!attribute whatsapp_template_id
+      #   The template's identifier with Meta, assigned when the template is submitted for
+      #   review.
+      #
+      #   @return [String, nil]
+      optional :whatsapp_template_id, String
+
+      # @!method initialize(account_id: nil, category: nil, channel: nil, language: nil, reason: nil, status: nil, template_id: nil, template_name: nil, whatsapp_template_id: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateEventPayload} for more details.
+      #
+      #   Body of a template status event. Delivered when a template's review outcome
+      #   changes, so you can react without polling.
+      #
+      #   @param account_id [String] The account the template belongs to.
+      #
+      #   @param category [String] The template's category, for example UTILITY, MARKETING, or
+      #
+      #   @param channel [String] The channel the template applies to.
+      #
+      #   @param language [String] The template's language code, for example en_US.
+      #
+      #   @param reason [String, nil] Why the template reached Status, when a reason was given. Populated on a
+      #
+      #   @param status [String] The review status the template just reached, for example APPROVED or
+      #
+      #   @param template_id [String] The template in Sent.
+      #
+      #   @param template_name [String] The template's display name.
+      #
+      #   @param whatsapp_template_id [String] The template's identifier with Meta, assigned when the template is submitted for
+    end
+  end
+end

data/lib/sentdm/models/template_list_params.rb

@@ -26,7 +26,11 @@ module Sentdm
       optional :category, String, nil?: true
 
       # @!attribute is_welcome_playground
-      #   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.
       #
       #   @return [Boolean, nil]
       optional :is_welcome_playground, Sentdm::Internal::Type::Boolean, nil?: true
@@ -49,13 +53,16 @@ module Sentdm
       optional :x_profile_id, String
 
       # @!method initialize(page:, page_size:, category: nil, is_welcome_playground: nil, search: nil, status: nil, x_profile_id: nil, request_options: {})
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::TemplateListParams} for more details.
+      #
       #   @param page [Integer] Page number (1-indexed)
       #
       #   @param page_size [Integer] Number of items per page
       #
       #   @param category [String, nil] Optional category filter: MARKETING, UTILITY, AUTHENTICATION
       #
-      #   @param is_welcome_playground [Boolean, nil] Optional filter by welcome playground flag
+      #   @param is_welcome_playground [Boolean, nil] Accepted and ignored. It used to filter on the welcome-playground marker inside
       #
       #   @param search [String, nil] Optional search term for filtering templates
       #

data/lib/sentdm/models/template_list_response.rb

@@ -5,7 +5,7 @@ module Sentdm
     # @see Sentdm::Resources::Templates#list
     class TemplateListResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   Paginated list of templates
+      #   A paginated list of templates.
       #
       #   @return [Sentdm::Models::TemplateListResponse::Data, nil]
       optional :data, -> { Sentdm::Models::TemplateListResponse::Data }, nil?: true
@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+      #   @return [Sentdm::Models::TemplateListResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::TemplateListResponse::Error }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
+      #   @return [Sentdm::Models::TemplateListResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::TemplateListResponse::Meta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -31,11 +31,11 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::TemplateListResponse::Data, nil] Paginated list of templates
+      #   @param data [Sentdm::Models::TemplateListResponse::Data, nil] A paginated list of templates.
       #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #   @param error [Sentdm::Models::TemplateListResponse::Error, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #   @param meta [Sentdm::Models::TemplateListResponse::Meta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -44,21 +44,267 @@ module Sentdm
         # @!attribute pagination
         #   Pagination metadata for list responses
         #
-        #   @return [Sentdm::Models::PaginationMeta, nil]
-        optional :pagination, -> { Sentdm::PaginationMeta }
+        #   @return [Sentdm::Models::TemplateListResponse::Data::Pagination, nil]
+        optional :pagination, -> { Sentdm::Models::TemplateListResponse::Data::Pagination }
 
         # @!attribute templates
-        #   List of templates
+        #   The templates on this page.
         #
-        #   @return [Array<Sentdm::Models::Template>, nil]
-        optional :templates, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Template] }
+        #   @return [Array<Sentdm::Models::TemplateListResponse::Data::Template>, nil]
+        optional :templates,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::TemplateListResponse::Data::Template] }
 
         # @!method initialize(pagination: nil, templates: nil)
-        #   Paginated list of templates
+        #   A paginated list of templates.
         #
-        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+        #   @param pagination [Sentdm::Models::TemplateListResponse::Data::Pagination] Pagination metadata for list responses
         #
-        #   @param templates [Array<Sentdm::Models::Template>] List of templates
+        #   @param templates [Array<Sentdm::Models::TemplateListResponse::Data::Template>] The templates on this page.
+
+        # @see Sentdm::Models::TemplateListResponse::Data#pagination
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          # @!attribute cursors
+          #   @deprecated
+          #
+          #   Cursor-based pagination. Never populated — see Cursors.
+          #
+          #   @return [Sentdm::Models::TemplateListResponse::Data::Pagination::Cursors, nil]
+          optional :cursors, -> { Sentdm::Models::TemplateListResponse::Data::Pagination::Cursors }, nil?: true
+
+          # @!attribute has_more
+          #   Whether there are more pages after this one
+          #
+          #   @return [Boolean, nil]
+          optional :has_more, Sentdm::Internal::Type::Boolean
+
+          # @!attribute page
+          #   Current page number (1-indexed)
+          #
+          #   @return [Integer, nil]
+          optional :page, Integer
+
+          # @!attribute page_size
+          #   Number of items per page
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute total_count
+          #   Total number of items across all pages
+          #
+          #   @return [Integer, nil]
+          optional :total_count, Integer
+
+          # @!attribute total_pages
+          #   Total number of pages
+          #
+          #   @return [Integer, nil]
+          optional :total_pages, Integer
+
+          # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
+          #   Pagination metadata for list responses
+          #
+          #   @param cursors [Sentdm::Models::TemplateListResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
+          #
+          #   @param has_more [Boolean] Whether there are more pages after this one
+          #
+          #   @param page [Integer] Current page number (1-indexed)
+          #
+          #   @param page_size [Integer] Number of items per page
+          #
+          #   @param total_count [Integer] Total number of items across all pages
+          #
+          #   @param total_pages [Integer] Total number of pages
+
+          # @deprecated
+          #
+          # @see Sentdm::Models::TemplateListResponse::Data::Pagination#cursors
+          class Cursors < Sentdm::Internal::Type::BaseModel
+            # @!attribute after
+            #   Cursor to fetch the next page.
+            #
+            #   @return [String, nil]
+            optional :after, String, nil?: true
+
+            # @!attribute before
+            #   Cursor to fetch the previous page.
+            #
+            #   @return [String, nil]
+            optional :before, String, nil?: true
+
+            # @!method initialize(after: nil, before: nil)
+            #   Cursor-based pagination. Never populated — see Cursors.
+            #
+            #   @param after [String, nil] Cursor to fetch the next page.
+            #
+            #   @param before [String, nil] Cursor to fetch the previous page.
+          end
+        end
+
+        class Template < Sentdm::Internal::Type::BaseModel
+          # @!attribute customer_id
+          #   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.
+          #
+          #   @return [String]
+          required :customer_id, String
+
+          # @!attribute id
+          #   Unique template identifier
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute category
+          #   Template category: MARKETING, UTILITY, AUTHENTICATION
+          #
+          #   @return [String, nil]
+          optional :category, String
+
+          # @!attribute channels
+          #   Supported channels: sms, whatsapp
+          #
+          #   @return [Array<String>, nil]
+          optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!attribute created_at
+          #   When the template was created
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute is_published
+          #   Whether the template is published and active
+          #
+          #   @return [Boolean, nil]
+          optional :is_published, Sentdm::Internal::Type::Boolean
+
+          # @!attribute language
+          #   Template language code (e.g., en_US)
+          #
+          #   @return [String, nil]
+          optional :language, String
+
+          # @!attribute name
+          #   Template display name
+          #
+          #   @return [String, nil]
+          optional :name, String
+
+          # @!attribute status
+          #   Template status: APPROVED, PENDING, REJECTED
+          #
+          #   @return [String, nil]
+          optional :status, String
+
+          # @!attribute updated_at
+          #   When the template was last updated
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time, nil?: true
+
+          # @!attribute variables
+          #   Template variables for personalization
+          #
+          #   @return [Array<String>, nil]
+          optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+          # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::TemplateListResponse::Data::Template} for more details.
+          #
+          #   Template response for v3 API
+          #
+          #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
+          #
+          #   @param id [String] Unique template identifier
+          #
+          #   @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
+          #
+          #   @param channels [Array<String>, nil] Supported channels: sms, whatsapp
+          #
+          #   @param created_at [Time] When the template was created
+          #
+          #   @param is_published [Boolean] Whether the template is published and active
+          #
+          #   @param language [String] Template language code (e.g., en_US)
+          #
+          #   @param name [String] Template display name
+          #
+          #   @param status [String] Template status: APPROVED, PENDING, REJECTED
+          #
+          #   @param updated_at [Time, nil] When the template was last updated
+          #
+          #   @param variables [Array<String>, nil] Template variables for personalization
+        end
+      end
+
+      # @see Sentdm::Models::TemplateListResponse#error
+      class Error < Sentdm::Internal::Type::BaseModel
+        # @!attribute code
+        #   Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute details
+        #   Additional validation error details (field-level errors)
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
+
+        # @!attribute doc_url
+        #   URL to documentation about this error
+        #
+        #   @return [String, nil]
+        optional :doc_url, String, nil?: true
+
+        # @!attribute message
+        #   Human-readable error message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
+        #   Error information
+        #
+        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
+        #
+        #   @param doc_url [String, nil] URL to documentation about this error
+        #
+        #   @param message [String] Human-readable error message
+      end
+
+      # @see Sentdm::Models::TemplateListResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute timestamp
+        #   Server timestamp when the response was generated
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!attribute version
+        #   API version used for this request
+        #
+        #   @return [String, nil]
+        optional :version, String
+
+        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
       end
     end
   end

data/lib/sentdm/models/template_retrieve_response.rb

@@ -0,0 +1,209 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Templates#retrieve
+    class TemplateRetrieveResponse < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   Template response for v3 API
+      #
+      #   @return [Sentdm::Models::TemplateRetrieveResponse::Data, nil]
+      optional :data, -> { Sentdm::Models::TemplateRetrieveResponse::Data }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::TemplateRetrieveResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::TemplateRetrieveResponse::Error }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @return [Sentdm::Models::TemplateRetrieveResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::TemplateRetrieveResponse::Meta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::TemplateRetrieveResponse::Data, nil] Template response for v3 API
+      #
+      #   @param error [Sentdm::Models::TemplateRetrieveResponse::Error, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::TemplateRetrieveResponse::Meta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+
+      # @see Sentdm::Models::TemplateRetrieveResponse#data
+      class Data < Sentdm::Internal::Type::BaseModel
+        # @!attribute customer_id
+        #   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.
+        #
+        #   @return [String]
+        required :customer_id, String
+
+        # @!attribute id
+        #   Unique template identifier
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute category
+        #   Template category: MARKETING, UTILITY, AUTHENTICATION
+        #
+        #   @return [String, nil]
+        optional :category, String
+
+        # @!attribute channels
+        #   Supported channels: sms, whatsapp
+        #
+        #   @return [Array<String>, nil]
+        optional :channels, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!attribute created_at
+        #   When the template was created
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute is_published
+        #   Whether the template is published and active
+        #
+        #   @return [Boolean, nil]
+        optional :is_published, Sentdm::Internal::Type::Boolean
+
+        # @!attribute language
+        #   Template language code (e.g., en_US)
+        #
+        #   @return [String, nil]
+        optional :language, String
+
+        # @!attribute name
+        #   Template display name
+        #
+        #   @return [String, nil]
+        optional :name, String
+
+        # @!attribute status
+        #   Template status: APPROVED, PENDING, REJECTED
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute updated_at
+        #   When the template was last updated
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, nil?: true
+
+        # @!attribute variables
+        #   Template variables for personalization
+        #
+        #   @return [Array<String>, nil]
+        optional :variables, Sentdm::Internal::Type::ArrayOf[String], nil?: true
+
+        # @!method initialize(customer_id:, id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::TemplateRetrieveResponse::Data} for more details.
+        #
+        #   Template response for v3 API
+        #
+        #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
+        #
+        #   @param id [String] Unique template identifier
+        #
+        #   @param category [String] Template category: MARKETING, UTILITY, AUTHENTICATION
+        #
+        #   @param channels [Array<String>, nil] Supported channels: sms, whatsapp
+        #
+        #   @param created_at [Time] When the template was created
+        #
+        #   @param is_published [Boolean] Whether the template is published and active
+        #
+        #   @param language [String] Template language code (e.g., en_US)
+        #
+        #   @param name [String] Template display name
+        #
+        #   @param status [String] Template status: APPROVED, PENDING, REJECTED
+        #
+        #   @param updated_at [Time, nil] When the template was last updated
+        #
+        #   @param variables [Array<String>, nil] Template variables for personalization
+      end
+
+      # @see Sentdm::Models::TemplateRetrieveResponse#error
+      class Error < Sentdm::Internal::Type::BaseModel
+        # @!attribute code
+        #   Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute details
+        #   Additional validation error details (field-level errors)
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
+
+        # @!attribute doc_url
+        #   URL to documentation about this error
+        #
+        #   @return [String, nil]
+        optional :doc_url, String, nil?: true
+
+        # @!attribute message
+        #   Human-readable error message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
+        #   Error information
+        #
+        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
+        #
+        #   @param doc_url [String, nil] URL to documentation about this error
+        #
+        #   @param message [String] Human-readable error message
+      end
+
+      # @see Sentdm::Models::TemplateRetrieveResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute timestamp
+        #   Server timestamp when the response was generated
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!attribute version
+        #   API version used for this request
+        #
+        #   @return [String, nil]
+        optional :version, String
+
+        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
+      end
+    end
+  end
+end