sentdm 0.19.0 → 0.20.0

data/lib/sentdm/models/template_definition.rb

@@ -0,0 +1,66 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class TemplateDefinition < Sentdm::Internal::Type::BaseModel
+      # @!attribute body
+      #   Body section of a message template with channel-specific content
+      #
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody]
+      required :body, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateBody }
+
+      # @!attribute authentication_config
+      #   Configuration for AUTHENTICATION category templates
+      #
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil]
+      optional :authentication_config,
+               -> { Sentdm::SentDmServicesCommonContractsPocOsAuthenticationConfig },
+               api_name: :authenticationConfig,
+               nil?: true
+
+      # @!attribute buttons
+      #   Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+      #
+      #   @return [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil]
+      optional :buttons,
+               -> {
+                 Sentdm::Internal::Type::ArrayOf[Sentdm::SentDmServicesCommonContractsPocOsTemplateButton]
+               },
+               nil?: true
+
+      # @!attribute definition_version
+      #   The version of the template definition format
+      #
+      #   @return [String, nil]
+      optional :definition_version, String, api_name: :definitionVersion, nil?: true
+
+      # @!attribute footer
+      #   Footer section of a message template
+      #
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil]
+      optional :footer, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateFooter }, nil?: true
+
+      # @!attribute header
+      #   Header section of a message template
+      #
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil]
+      optional :header, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateHeader }, nil?: true
+
+      # @!method initialize(body:, authentication_config: nil, buttons: nil, definition_version: nil, footer: nil, header: nil)
+      #   Complete definition of a message template including header, body, footer, and
+      #   buttons
+      #
+      #   @param body [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody] Body section of a message template with channel-specific content
+      #
+      #   @param authentication_config [Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig, nil] Configuration for AUTHENTICATION category templates
+      #
+      #   @param buttons [Array<Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton>, nil] Optional list of interactive buttons (e.g., quick replies, URLs, phone numbers)
+      #
+      #   @param definition_version [String, nil] The version of the template definition format
+      #
+      #   @param footer [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter, nil] Footer section of a message template
+      #
+      #   @param header [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader, nil] Header section of a message template
+    end
+  end
+end

data/lib/sentdm/models/template_list_response.rb

@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::TemplateListResponse::Error, nil]
-      optional :error, -> { Sentdm::Models::TemplateListResponse::Error }, nil?: true
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::TemplateListResponse::Meta, nil]
-      optional :meta, -> { Sentdm::Models::TemplateListResponse::Meta }
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -33,9 +33,9 @@ module Sentdm
       #
       #   @param data [Sentdm::Models::TemplateListResponse::Data, nil] Paginated list of templates
       #
-      #   @param error [Sentdm::Models::TemplateListResponse::Error, nil] Error information
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
       #
-      #   @param meta [Sentdm::Models::TemplateListResponse::Meta] Request and response metadata
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -44,251 +44,21 @@ module Sentdm
         # @!attribute pagination
         #   Pagination metadata for list responses
         #
-        #   @return [Sentdm::Models::TemplateListResponse::Data::Pagination, nil]
-        optional :pagination, -> { Sentdm::Models::TemplateListResponse::Data::Pagination }
+        #   @return [Sentdm::Models::PaginationMeta, nil]
+        optional :pagination, -> { Sentdm::PaginationMeta }
 
         # @!attribute templates
         #   List of templates
         #
-        #   @return [Array<Sentdm::Models::TemplateListResponse::Data::Template>, nil]
-        optional :templates,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::TemplateListResponse::Data::Template] }
+        #   @return [Array<Sentdm::Models::Template>, nil]
+        optional :templates, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Template] }
 
         # @!method initialize(pagination: nil, templates: nil)
         #   Paginated list of templates
         #
-        #   @param pagination [Sentdm::Models::TemplateListResponse::Data::Pagination] Pagination metadata for list responses
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
         #
-        #   @param templates [Array<Sentdm::Models::TemplateListResponse::Data::Template>] List of templates
-
-        # @see Sentdm::Models::TemplateListResponse::Data#pagination
-        class Pagination < Sentdm::Internal::Type::BaseModel
-          # @!attribute cursors
-          #   Cursor-based pagination pointers
-          #
-          #   @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 pointers
-          #
-          #   @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
-
-          # @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 pointers
-            #
-            #   @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 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(id: nil, category: nil, channels: nil, created_at: nil, is_published: nil, language: nil, name: nil, status: nil, updated_at: nil, variables: nil)
-          #   Template response for v3 API
-          #
-          #   @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
+        #   @param templates [Array<Sentdm::Models::Template>] List of templates
       end
     end
   end