sentdm 0.18.0 → 0.19.0

data/lib/sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer.rb

@@ -1,34 +0,0 @@
-# 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]
-      required :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:, 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

@@ -1,39 +0,0 @@
-# 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]
-      required :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:, 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/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb

@@ -1,116 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo < Sentdm::Internal::Type::BaseModel
-      # @!attribute city
-      #   City
-      #
-      #   @return [String, nil]
-      optional :city, String, nil?: true
-
-      # @!attribute country
-      #   Country code (e.g., US, CA)
-      #
-      #   @return [String, nil]
-      optional :country, String, nil?: true
-
-      # @!attribute country_of_registration
-      #   Country where the business is registered
-      #
-      #   @return [String, nil]
-      optional :country_of_registration, String, api_name: :countryOfRegistration, nil?: true
-
-      # @!attribute entity_type
-      #
-      #   @return [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
-      optional :entity_type,
-               enum: -> {
-                 Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType
-               },
-               api_name: :entityType,
-               nil?: true
-
-      # @!attribute legal_name
-      #   Legal business name
-      #
-      #   @return [String, nil]
-      optional :legal_name, String, api_name: :legalName, nil?: true
-
-      # @!attribute postal_code
-      #   Postal/ZIP code
-      #
-      #   @return [String, nil]
-      optional :postal_code, String, api_name: :postalCode, nil?: true
-
-      # @!attribute state
-      #   State/province code
-      #
-      #   @return [String, nil]
-      optional :state, String, nil?: true
-
-      # @!attribute street
-      #   Street address
-      #
-      #   @return [String, nil]
-      optional :street, String, nil?: true
-
-      # @!attribute tax_id
-      #   Tax ID/EIN number
-      #
-      #   @return [String, nil]
-      optional :tax_id, String, api_name: :taxId, nil?: true
-
-      # @!attribute tax_id_type
-      #   Type of tax ID (e.g., us_ein, ca_bn)
-      #
-      #   @return [String, nil]
-      optional :tax_id_type, String, api_name: :taxIdType, nil?: true
-
-      # @!attribute url
-      #   Business website URL
-      #
-      #   @return [String, nil]
-      optional :url, String, nil?: true
-
-      # @!method initialize(city: nil, country: nil, country_of_registration: nil, entity_type: nil, legal_name: nil, postal_code: nil, state: nil, street: nil, tax_id: nil, tax_id_type: nil, url: nil)
-      #   Business details and address for brand KYC
-      #
-      #   @param city [String, nil] City
-      #
-      #   @param country [String, nil] Country code (e.g., US, CA)
-      #
-      #   @param country_of_registration [String, nil] Country where the business is registered
-      #
-      #   @param entity_type [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
-      #
-      #   @param legal_name [String, nil] Legal business name
-      #
-      #   @param postal_code [String, nil] Postal/ZIP code
-      #
-      #   @param state [String, nil] State/province code
-      #
-      #   @param street [String, nil] Street address
-      #
-      #   @param tax_id [String, nil] Tax ID/EIN number
-      #
-      #   @param tax_id_type [String, nil] Type of tax ID (e.g., us_ein, ca_bn)
-      #
-      #   @param url [String, nil] Business website URL
-
-      # @see Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo#entity_type
-      module EntityType
-        extend Sentdm::Internal::Type::Enum
-
-        PRIVATE_PROFIT = :PRIVATE_PROFIT
-        PUBLIC_PROFIT = :PUBLIC_PROFIT
-        NON_PROFIT = :NON_PROFIT
-        SOLE_PROPRIETOR = :SOLE_PROPRIETOR
-        GOVERNMENT = :GOVERNMENT
-
-        # @!method self.values
-        #   @return [Array<Symbol>]
-      end
-    end
-  end
-end

data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb

@@ -1,75 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo < Sentdm::Internal::Type::BaseModel
-      # @!attribute brand_relationship
-      #
-      #   @return [Symbol, Sentdm::Models::TcrBrandRelationship]
-      required :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, api_name: :brandRelationship
-
-      # @!attribute vertical
-      #
-      #   @return [Symbol, Sentdm::Models::TcrVertical]
-      required :vertical, enum: -> { Sentdm::TcrVertical }
-
-      # @!attribute destination_countries
-      #   List of destination countries for messaging
-      #
-      #   @return [Array<Sentdm::Models::DestinationCountry>, nil]
-      optional :destination_countries,
-               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] },
-               api_name: :destinationCountries,
-               nil?: true
-
-      # @!attribute expected_messaging_volume
-      #   Expected daily messaging volume
-      #
-      #   @return [String, nil]
-      optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
-
-      # @!attribute is_tcr_application
-      #   Whether this is a TCR (Campaign Registry) application
-      #
-      #   @return [Boolean, nil]
-      optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication, nil?: true
-
-      # @!attribute notes
-      #   Additional notes about the business or use case
-      #
-      #   @return [String, nil]
-      optional :notes, String, nil?: true
-
-      # @!attribute phone_number_prefix
-      #   Phone number prefix for messaging (e.g., "+1")
-      #
-      #   @return [String, nil]
-      optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
-
-      # @!attribute primary_use_case
-      #   Primary messaging use case description
-      #
-      #   @return [String, nil]
-      optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
-
-      # @!method initialize(brand_relationship:, vertical:, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil)
-      #   Compliance and TCR information for brand registration
-      #
-      #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship]
-      #
-      #   @param vertical [Symbol, Sentdm::Models::TcrVertical]
-      #
-      #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
-      #
-      #   @param expected_messaging_volume [String, nil] Expected daily messaging volume
-      #
-      #   @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
-      #
-      #   @param notes [String, nil] Additional notes about the business or use case
-      #
-      #   @param phone_number_prefix [String, nil] Phone number prefix for messaging (e.g., "+1")
-      #
-      #   @param primary_use_case [String, nil] Primary messaging use case description
-    end
-  end
-end

data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo < Sentdm::Internal::Type::BaseModel
-      # @!attribute name
-      #   Primary contact name (required)
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute business_name
-      #   Business/brand name
-      #
-      #   @return [String, nil]
-      optional :business_name, String, api_name: :businessName, nil?: true
-
-      # @!attribute email
-      #   Contact email address
-      #
-      #   @return [String, nil]
-      optional :email, String, nil?: true
-
-      # @!attribute phone
-      #   Contact phone number in E.164 format
-      #
-      #   @return [String, nil]
-      optional :phone, String, nil?: true
-
-      # @!attribute phone_country_code
-      #   Contact phone country code (e.g., "1" for US)
-      #
-      #   @return [String, nil]
-      optional :phone_country_code, String, api_name: :phoneCountryCode, nil?: true
-
-      # @!attribute role
-      #   Contact's role in the business
-      #
-      #   @return [String, nil]
-      optional :role, String, nil?: true
-
-      # @!method initialize(name:, business_name: nil, email: nil, phone: nil, phone_country_code: nil, role: nil)
-      #   Contact information for brand KYC
-      #
-      #   @param name [String] Primary contact name (required)
-      #
-      #   @param business_name [String, nil] Business/brand name
-      #
-      #   @param email [String, nil] Contact email address
-      #
-      #   @param phone [String, nil] Contact phone number in E.164 format
-      #
-      #   @param phone_country_code [String, nil] Contact phone country code (e.g., "1" for US)
-      #
-      #   @param role [String, nil] Contact's role in the business
-    end
-  end
-end

data/lib/sentdm/models/tcr_brand_relationship.rb

@@ -1,18 +0,0 @@
-# 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

@@ -1,36 +0,0 @@
-# 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

@@ -1,90 +0,0 @@
-# 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_body_content.rb

@@ -1,27 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class TemplateBodyContent < Sentdm::Internal::Type::BaseModel
-      # @!attribute template
-      #
-      #   @return [String]
-      required :template, String
-
-      # @!attribute type
-      #
-      #   @return [String, nil]
-      optional :type, String, nil?: true
-
-      # @!attribute variables
-      #
-      #   @return [Array<Sentdm::Models::TemplateVariable>, nil]
-      optional :variables, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::TemplateVariable] }, nil?: true
-
-      # @!method initialize(template:, type: nil, variables: nil)
-      #   @param template [String]
-      #   @param type [String, nil]
-      #   @param variables [Array<Sentdm::Models::TemplateVariable>, nil]
-    end
-  end
-end

data/lib/sentdm/models/template_definition.rb

@@ -1,66 +0,0 @@
-# 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_variable.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class TemplateVariable < Sentdm::Internal::Type::BaseModel
-      # @!attribute name
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute props
-      #
-      #   @return [Sentdm::Models::TemplateVariable::Props]
-      required :props, -> { Sentdm::TemplateVariable::Props }
-
-      # @!attribute type
-      #
-      #   @return [String]
-      required :type, String
-
-      # @!attribute id
-      #
-      #   @return [Integer, nil]
-      optional :id, Integer
-
-      # @!method initialize(name:, props:, type:, id: nil)
-      #   @param name [String]
-      #   @param props [Sentdm::Models::TemplateVariable::Props]
-      #   @param type [String]
-      #   @param id [Integer]
-
-      # @see Sentdm::Models::TemplateVariable#props
-      class Props < Sentdm::Internal::Type::BaseModel
-        # @!attribute media_type
-        #
-        #   @return [String]
-        required :media_type, String, api_name: :mediaType
-
-        # @!attribute sample
-        #
-        #   @return [String]
-        required :sample, String
-
-        # @!attribute url
-        #
-        #   @return [String]
-        required :url, String
-
-        # @!attribute variable_type
-        #
-        #   @return [String]
-        required :variable_type, String, api_name: :variableType
-
-        # @!attribute alt
-        #
-        #   @return [String, nil]
-        optional :alt, String, nil?: true
-
-        # @!attribute regex
-        #
-        #   @return [String, nil]
-        optional :regex, String, nil?: true
-
-        # @!attribute short_url
-        #
-        #   @return [String, nil]
-        optional :short_url, String, api_name: :shortUrl, nil?: true
-
-        # @!method initialize(media_type:, sample:, url:, variable_type:, alt: nil, regex: nil, short_url: nil)
-        #   @param media_type [String]
-        #   @param sample [String]
-        #   @param url [String]
-        #   @param variable_type [String]
-        #   @param alt [String, nil]
-        #   @param regex [String, nil]
-        #   @param short_url [String, nil]
-      end
-    end
-  end
-end