sentdm 0.19.0 → 0.20.0

data/lib/sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb

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

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

@@ -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_body_content.rb

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