sentdm 0.2.0 → 0.3.0

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsAuthenticationConfig < Sentdm::Internal::Type::BaseModel
+      # @!attribute add_security_recommendation
+      #   Whether to add the security recommendation text: "For your security, do not
+      #   share this code."
+      #
+      #   @return [Boolean, nil]
+      optional :add_security_recommendation,
+               Sentdm::Internal::Type::Boolean,
+               api_name: :addSecurityRecommendation
+
+      # @!attribute code_expiration_minutes
+      #   Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+      #   in X minutes."
+      #
+      #   @return [Integer, nil]
+      optional :code_expiration_minutes, Integer, api_name: :codeExpirationMinutes, nil?: true
+
+      # @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig} for
+      #   more details.
+      #
+      #   Configuration for AUTHENTICATION category templates
+      #
+      #   @param add_security_recommendation [Boolean] Whether to add the security recommendation text: "For your security, do not shar
+      #
+      #   @param code_expiration_minutes [Integer, nil] Code expiration time in minutes (1-90). If set, adds footer: "This code expires
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_body.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateBody < Sentdm::Internal::Type::BaseModel
+      # @!attribute multi_channel
+      #   Content that will be used for all channels (SMS and WhatsApp) unless
+      #   channel-specific content is provided
+      #
+      #   @return [Sentdm::Models::TemplateBodyContent, nil]
+      optional :multi_channel, -> { Sentdm::TemplateBodyContent }, api_name: :multiChannel, nil?: true
+
+      # @!attribute sms
+      #   SMS-specific content that overrides multi-channel content for SMS messages
+      #
+      #   @return [Sentdm::Models::TemplateBodyContent, nil]
+      optional :sms, -> { Sentdm::TemplateBodyContent }, nil?: true
+
+      # @!attribute whatsapp
+      #   WhatsApp-specific content that overrides multi-channel content for WhatsApp
+      #   messages
+      #
+      #   @return [Sentdm::Models::TemplateBodyContent, nil]
+      optional :whatsapp, -> { Sentdm::TemplateBodyContent }, nil?: true
+
+      # @!method initialize(multi_channel: nil, sms: nil, whatsapp: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody} for more
+      #   details.
+      #
+      #   Body section of a message template with channel-specific content
+      #
+      #   @param multi_channel [Sentdm::Models::TemplateBodyContent, nil] Content that will be used for all channels (SMS and WhatsApp) unless channel-spe
+      #
+      #   @param sms [Sentdm::Models::TemplateBodyContent, nil] SMS-specific content that overrides multi-channel content for SMS messages
+      #
+      #   @param whatsapp [Sentdm::Models::TemplateBodyContent, nil] WhatsApp-specific content that overrides multi-channel content for WhatsApp mess
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButton < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   The unique identifier of the button (1-based index)
+      #
+      #   @return [Integer, nil]
+      optional :id, Integer
+
+      # @!attribute props
+      #   Properties specific to the button type
+      #
+      #   @return [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps, nil]
+      optional :props, -> { Sentdm::SentDmServicesCommonContractsPocOsTemplateButtonProps }
+
+      # @!attribute type
+      #   The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+      #
+      #   @return [String, nil]
+      optional :type, String
+
+      # @!method initialize(id: nil, props: nil, type: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton} for more
+      #   details.
+      #
+      #   Interactive button in a message template
+      #
+      #   @param id [Integer] The unique identifier of the button (1-based index)
+      #
+      #   @param props [Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps] Properties specific to the button type
+      #
+      #   @param type [String] The type of button (e.g., QUICK_REPLY, URL, PHONE_NUMBER, VOICE_CALL, COPY_CODE)
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props.rb

@@ -0,0 +1,81 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateButtonProps < Sentdm::Internal::Type::BaseModel
+      # @!attribute active_for
+      #
+      #   @return [Integer, nil]
+      optional :active_for, Integer, api_name: :activeFor, nil?: true
+
+      # @!attribute autofill_text
+      #
+      #   @return [String, nil]
+      optional :autofill_text, String, api_name: :autofillText, nil?: true
+
+      # @!attribute country_code
+      #
+      #   @return [String, nil]
+      optional :country_code, String, api_name: :countryCode, nil?: true
+
+      # @!attribute offer_code
+      #
+      #   @return [String, nil]
+      optional :offer_code, String, api_name: :offerCode, nil?: true
+
+      # @!attribute otp_type
+      #
+      #   @return [String, nil]
+      optional :otp_type, String, api_name: :otpType, nil?: true
+
+      # @!attribute package_name
+      #
+      #   @return [String, nil]
+      optional :package_name, String, api_name: :packageName, nil?: true
+
+      # @!attribute phone_number
+      #
+      #   @return [String, nil]
+      optional :phone_number, String, api_name: :phoneNumber, nil?: true
+
+      # @!attribute quick_reply_type
+      #
+      #   @return [String, nil]
+      optional :quick_reply_type, String, api_name: :quickReplyType, nil?: true
+
+      # @!attribute signature_hash
+      #
+      #   @return [String, nil]
+      optional :signature_hash, String, api_name: :signatureHash, nil?: true
+
+      # @!attribute text
+      #
+      #   @return [String, nil]
+      optional :text, String, nil?: true
+
+      # @!attribute url
+      #
+      #   @return [String, nil]
+      optional :url, String, nil?: true
+
+      # @!attribute url_type
+      #
+      #   @return [String, nil]
+      optional :url_type, String, api_name: :urlType, nil?: true
+
+      # @!method initialize(active_for: nil, autofill_text: nil, country_code: nil, offer_code: nil, otp_type: nil, package_name: nil, phone_number: nil, quick_reply_type: nil, signature_hash: nil, text: nil, url: nil, url_type: nil)
+      #   @param active_for [Integer, nil]
+      #   @param autofill_text [String, nil]
+      #   @param country_code [String, nil]
+      #   @param offer_code [String, nil]
+      #   @param otp_type [String, nil]
+      #   @param package_name [String, nil]
+      #   @param phone_number [String, nil]
+      #   @param quick_reply_type [String, nil]
+      #   @param signature_hash [String, nil]
+      #   @param text [String, nil]
+      #   @param url [String, nil]
+      #   @param url_type [String, nil]
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb

@@ -0,0 +1,34 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateFooter < Sentdm::Internal::Type::BaseModel
+      # @!attribute template
+      #   The footer template text with optional variable placeholders
+      #
+      #   @return [String, nil]
+      optional :template, String
+
+      # @!attribute type
+      #   The type of footer (typically "text")
+      #
+      #   @return [String, nil]
+      optional :type, String, nil?: true
+
+      # @!attribute variables
+      #   List of variables used in the footer template
+      #
+      #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
+      optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
+
+      # @!method initialize(template: nil, type: nil, variables: nil)
+      #   Footer section of a message template
+      #
+      #   @param template [String] The footer template text with optional variable placeholders
+      #
+      #   @param type [String, nil] The type of footer (typically "text")
+      #
+      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the footer template
+    end
+  end
+end

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_header.rb

@@ -0,0 +1,39 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class SentDmServicesCommonContractsPocOsTemplateHeader < Sentdm::Internal::Type::BaseModel
+      # @!attribute template
+      #   The header template text with optional variable placeholders (e.g., "Welcome to
+      #   {{0:variable}}")
+      #
+      #   @return [String, nil]
+      optional :template, String
+
+      # @!attribute type
+      #   The type of header (e.g., "text", "image", "video", "document")
+      #
+      #   @return [String, nil]
+      optional :type, String, nil?: true
+
+      # @!attribute variables
+      #   List of variables used in the header template
+      #
+      #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
+      optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
+
+      # @!method initialize(template: nil, type: nil, variables: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader} for more
+      #   details.
+      #
+      #   Header section of a message template
+      #
+      #   @param template [String] The header template text with optional variable placeholders (e.g., "Welcome to
+      #
+      #   @param type [String, nil] The type of header (e.g., "text", "image", "video", "document")
+      #
+      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil] List of variables used in the header template
+    end
+  end
+end

data/lib/sentdm/models/tcr_brand_relationship.rb

@@ -0,0 +1,18 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module TcrBrandRelationship
+      extend Sentdm::Internal::Type::Enum
+
+      BASIC_ACCOUNT = :BASIC_ACCOUNT
+      MEDIUM_ACCOUNT = :MEDIUM_ACCOUNT
+      LARGE_ACCOUNT = :LARGE_ACCOUNT
+      SMALL_ACCOUNT = :SMALL_ACCOUNT
+      KEY_ACCOUNT = :KEY_ACCOUNT
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/sentdm/models/tcr_vertical.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module TcrVertical
+      extend Sentdm::Internal::Type::Enum
+
+      PROFESSIONAL = :PROFESSIONAL
+      REAL_ESTATE = :REAL_ESTATE
+      HEALTHCARE = :HEALTHCARE
+      HUMAN_RESOURCES = :HUMAN_RESOURCES
+      ENERGY = :ENERGY
+      ENTERTAINMENT = :ENTERTAINMENT
+      RETAIL = :RETAIL
+      TRANSPORTATION = :TRANSPORTATION
+      AGRICULTURE = :AGRICULTURE
+      INSURANCE = :INSURANCE
+      POSTAL = :POSTAL
+      EDUCATION = :EDUCATION
+      HOSPITALITY = :HOSPITALITY
+      FINANCIAL = :FINANCIAL
+      POLITICAL = :POLITICAL
+      GAMBLING = :GAMBLING
+      LEGAL = :LEGAL
+      CONSTRUCTION = :CONSTRUCTION
+      NGO = :NGO
+      MANUFACTURING = :MANUFACTURING
+      GOVERNMENT = :GOVERNMENT
+      TECHNOLOGY = :TECHNOLOGY
+      COMMUNICATION = :COMMUNICATION
+
+      # @!method self.values
+      #   @return [Array<Symbol>]
+    end
+  end
+end

data/lib/sentdm/models/template.rb

@@ -0,0 +1,90 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    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
+end

data/lib/sentdm/models/template_create_params.rb

@@ -7,45 +7,66 @@ module Sentdm
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
-      # @!attribute definition
-      #   Template definition containing header, body, footer, and buttons
-      #
-      #   @return [Sentdm::Models::TemplateDefinition]
-      required :definition, -> { Sentdm::TemplateDefinition }
-
       # @!attribute category
-      #   The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be
-      #   set when creating a new template. If not provided, will be auto-generated using
-      #   AI.
+      #   Template category: MARKETING, UTILITY, AUTHENTICATION (optional, auto-detected
+      #   if not provided)
       #
       #   @return [String, nil]
       optional :category, String, nil?: true
 
+      # @!attribute creation_source
+      #   Source of template creation (default: from-api)
+      #
+      #   @return [String, nil]
+      optional :creation_source, String, nil?: true
+
+      # @!attribute definition
+      #   Template definition including header, body, footer, and buttons
+      #
+      #   @return [Sentdm::Models::TemplateDefinition, nil]
+      optional :definition, -> { Sentdm::TemplateDefinition }
+
       # @!attribute language
-      #   The template language code (e.g., en_US, es_ES). Can only be set when creating a
-      #   new template. If not provided, will be auto-detected using AI.
+      #   Template language code (e.g., en_US) (optional, auto-detected if not provided)
       #
       #   @return [String, nil]
       optional :language, String, nil?: true
 
       # @!attribute submit_for_review
-      #   When false, the template will be saved as draft. When true, the template will be
-      #   submitted for review.
+      #   Whether to submit the template for review after creation (default: false)
       #
       #   @return [Boolean, nil]
-      optional :submit_for_review, Sentdm::Internal::Type::Boolean, api_name: :submitForReview
+      optional :submit_for_review, Sentdm::Internal::Type::Boolean
 
-      # @!method initialize(definition:, category: nil, language: nil, submit_for_review: nil, request_options: {})
+      # @!attribute test_mode
+      #   Test mode flag - when true, the operation is simulated without side effects
+      #   Useful for testing integrations without actual execution
+      #
+      #   @return [Boolean, nil]
+      optional :test_mode, Sentdm::Internal::Type::Boolean
+
+      # @!attribute idempotency_key
+      #
+      #   @return [String, nil]
+      optional :idempotency_key, String
+
+      # @!method initialize(category: nil, creation_source: nil, definition: nil, language: nil, submit_for_review: nil, test_mode: nil, idempotency_key: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {Sentdm::Models::TemplateCreateParams} for more details.
       #
-      #   @param definition [Sentdm::Models::TemplateDefinition] Template definition containing header, body, footer, and buttons
+      #   @param category [String, nil] Template category: MARKETING, UTILITY, AUTHENTICATION (optional, auto-detected i
+      #
+      #   @param creation_source [String, nil] Source of template creation (default: from-api)
+      #
+      #   @param definition [Sentdm::Models::TemplateDefinition] Template definition including header, body, footer, and buttons
+      #
+      #   @param language [String, nil] Template language code (e.g., en_US) (optional, auto-detected if not provided)
       #
-      #   @param category [String, nil] The template category (e.g., MARKETING, UTILITY, AUTHENTICATION). Can only be se
+      #   @param submit_for_review [Boolean] Whether to submit the template for review after creation (default: false)
       #
-      #   @param language [String, nil] The template language code (e.g., en_US, es_ES). Can only be set when creating a
+      #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
       #
-      #   @param submit_for_review [Boolean] When false, the template will be saved as draft.
+      #   @param idempotency_key [String]
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
     end