sentdm 0.2.0 → 0.3.0

data/lib/sentdm/models/brand_with_kyc.rb

@@ -0,0 +1,335 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class BrandWithKYC < Sentdm::Internal::Type::BaseModel
+      # @!attribute id
+      #   Unique identifier for the brand
+      #
+      #   @return [String, nil]
+      optional :id, String
+
+      # @!attribute brand_relationship
+      #   Brand relationship level with TCR
+      #
+      #   @return [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
+      optional :brand_relationship,
+               enum: -> { Sentdm::TcrBrandRelationship },
+               api_name: :brandRelationship,
+               nil?: true
+
+      # @!attribute business_legal_name
+      #   Legal business name
+      #
+      #   @return [String, nil]
+      optional :business_legal_name, String, api_name: :businessLegalName, nil?: true
+
+      # @!attribute business_name
+      #   Business/brand name
+      #
+      #   @return [String, nil]
+      optional :business_name, String, api_name: :businessName, nil?: true
+
+      # @!attribute business_role
+      #   Contact's role in the business
+      #
+      #   @return [String, nil]
+      optional :business_role, String, api_name: :businessRole, nil?: true
+
+      # @!attribute business_url
+      #   Business website URL
+      #
+      #   @return [String, nil]
+      optional :business_url, String, api_name: :businessUrl, nil?: true
+
+      # @!attribute city
+      #   City
+      #
+      #   @return [String, nil]
+      optional :city, String, nil?: true
+
+      # @!attribute contact_email
+      #   Contact email address
+      #
+      #   @return [String, nil]
+      optional :contact_email, String, api_name: :contactEmail, nil?: true
+
+      # @!attribute contact_name
+      #   Primary contact name
+      #
+      #   @return [String, nil]
+      optional :contact_name, String, api_name: :contactName
+
+      # @!attribute contact_phone
+      #   Contact phone number
+      #
+      #   @return [String, nil]
+      optional :contact_phone, String, api_name: :contactPhone, nil?: true
+
+      # @!attribute contact_phone_country_code
+      #   Contact phone country code
+      #
+      #   @return [String, nil]
+      optional :contact_phone_country_code, String, api_name: :contactPhoneCountryCode, nil?: true
+
+      # @!attribute country
+      #   Country code
+      #
+      #   @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 created_at
+      #   When the brand was created
+      #
+      #   @return [Time, nil]
+      optional :created_at, Time, api_name: :createdAt
+
+      # @!attribute csp_id
+      #   CSP (Campaign Service Provider) ID
+      #
+      #   @return [String, nil]
+      optional :csp_id, String, api_name: :cspId, nil?: true
+
+      # @!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
+
+      # @!attribute entity_type
+      #   Business entity type
+      #
+      #   @return [String, nil]
+      optional :entity_type, String, api_name: :entityType, nil?: true
+
+      # @!attribute expected_messaging_volume
+      #   Expected daily messaging volume
+      #
+      #   @return [String, nil]
+      optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
+
+      # @!attribute identity_status
+      #   TCR brand identity verification status
+      #
+      #   @return [Symbol, Sentdm::Models::BrandWithKYC::IdentityStatus, nil]
+      optional :identity_status,
+               enum: -> { Sentdm::BrandWithKYC::IdentityStatus },
+               api_name: :identityStatus,
+               nil?: true
+
+      # @!attribute is_inherited
+      #   Whether this brand is inherited from parent organization
+      #
+      #   @return [Boolean, nil]
+      optional :is_inherited, Sentdm::Internal::Type::Boolean, api_name: :isInherited
+
+      # @!attribute is_tcr_application
+      #   Whether this is a TCR application
+      #
+      #   @return [Boolean, nil]
+      optional :is_tcr_application, Sentdm::Internal::Type::Boolean, api_name: :isTcrApplication
+
+      # @!attribute notes
+      #   Additional notes
+      #
+      #   @return [String, nil]
+      optional :notes, String, nil?: true
+
+      # @!attribute phone_number_prefix
+      #   Phone number prefix for messaging
+      #
+      #   @return [String, nil]
+      optional :phone_number_prefix, String, api_name: :phoneNumberPrefix, nil?: true
+
+      # @!attribute postal_code
+      #   Postal/ZIP code
+      #
+      #   @return [String, nil]
+      optional :postal_code, String, api_name: :postalCode, nil?: true
+
+      # @!attribute primary_use_case
+      #   Primary messaging use case description
+      #
+      #   @return [String, nil]
+      optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
+
+      # @!attribute state
+      #   State/province code
+      #
+      #   @return [String, nil]
+      optional :state, String, nil?: true
+
+      # @!attribute status
+      #   TCR brand status
+      #
+      #   @return [Symbol, Sentdm::Models::BrandWithKYC::Status, nil]
+      optional :status, enum: -> { Sentdm::BrandWithKYC::Status }, nil?: true
+
+      # @!attribute street
+      #   Street address
+      #
+      #   @return [String, nil]
+      optional :street, String, nil?: true
+
+      # @!attribute submitted_at
+      #   When the brand was submitted to TCR
+      #
+      #   @return [Time, nil]
+      optional :submitted_at, Time, api_name: :submittedAt, nil?: true
+
+      # @!attribute submitted_to_tcr
+      #   Whether this brand was submitted to TCR
+      #
+      #   @return [Boolean, nil]
+      optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean, api_name: :submittedToTCR
+
+      # @!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
+      #
+      #   @return [String, nil]
+      optional :tax_id_type, String, api_name: :taxIdType, nil?: true
+
+      # @!attribute tcr_brand_id
+      #   TCR brand ID (populated after TCR submission)
+      #
+      #   @return [String, nil]
+      optional :tcr_brand_id, String, api_name: :tcrBrandId, nil?: true
+
+      # @!attribute universal_ein
+      #   Universal EIN from TCR
+      #
+      #   @return [String, nil]
+      optional :universal_ein, String, api_name: :universalEin, nil?: true
+
+      # @!attribute updated_at
+      #   When the brand was last updated
+      #
+      #   @return [Time, nil]
+      optional :updated_at, Time, api_name: :updatedAt, nil?: true
+
+      # @!attribute vertical
+      #   Business vertical/industry category
+      #
+      #   @return [Symbol, Sentdm::Models::TcrVertical, nil]
+      optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
+
+      # @!method initialize(id: nil, brand_relationship: nil, business_legal_name: nil, business_name: nil, business_role: nil, business_url: nil, city: nil, contact_email: nil, contact_name: nil, contact_phone: nil, contact_phone_country_code: nil, country: nil, country_of_registration: nil, created_at: nil, csp_id: nil, destination_countries: nil, entity_type: nil, expected_messaging_volume: nil, identity_status: nil, is_inherited: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, postal_code: nil, primary_use_case: nil, state: nil, status: nil, street: nil, submitted_at: nil, submitted_to_tcr: nil, tax_id: nil, tax_id_type: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil, vertical: nil)
+      #   Flattened brand response with embedded KYC information
+      #
+      #   @param id [String] Unique identifier for the brand
+      #
+      #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil] Brand relationship level with TCR
+      #
+      #   @param business_legal_name [String, nil] Legal business name
+      #
+      #   @param business_name [String, nil] Business/brand name
+      #
+      #   @param business_role [String, nil] Contact's role in the business
+      #
+      #   @param business_url [String, nil] Business website URL
+      #
+      #   @param city [String, nil] City
+      #
+      #   @param contact_email [String, nil] Contact email address
+      #
+      #   @param contact_name [String] Primary contact name
+      #
+      #   @param contact_phone [String, nil] Contact phone number
+      #
+      #   @param contact_phone_country_code [String, nil] Contact phone country code
+      #
+      #   @param country [String, nil] Country code
+      #
+      #   @param country_of_registration [String, nil] Country where the business is registered
+      #
+      #   @param created_at [Time] When the brand was created
+      #
+      #   @param csp_id [String, nil] CSP (Campaign Service Provider) ID
+      #
+      #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
+      #
+      #   @param entity_type [String, nil] Business entity type
+      #
+      #   @param expected_messaging_volume [String, nil] Expected daily messaging volume
+      #
+      #   @param identity_status [Symbol, Sentdm::Models::BrandWithKYC::IdentityStatus, nil] TCR brand identity verification status
+      #
+      #   @param is_inherited [Boolean] Whether this brand is inherited from parent organization
+      #
+      #   @param is_tcr_application [Boolean] Whether this is a TCR application
+      #
+      #   @param notes [String, nil] Additional notes
+      #
+      #   @param phone_number_prefix [String, nil] Phone number prefix for messaging
+      #
+      #   @param postal_code [String, nil] Postal/ZIP code
+      #
+      #   @param primary_use_case [String, nil] Primary messaging use case description
+      #
+      #   @param state [String, nil] State/province code
+      #
+      #   @param status [Symbol, Sentdm::Models::BrandWithKYC::Status, nil] TCR brand status
+      #
+      #   @param street [String, nil] Street address
+      #
+      #   @param submitted_at [Time, nil] When the brand was submitted to TCR
+      #
+      #   @param submitted_to_tcr [Boolean] Whether this brand was submitted to TCR
+      #
+      #   @param tax_id [String, nil] Tax ID/EIN number
+      #
+      #   @param tax_id_type [String, nil] Type of tax ID
+      #
+      #   @param tcr_brand_id [String, nil] TCR brand ID (populated after TCR submission)
+      #
+      #   @param universal_ein [String, nil] Universal EIN from TCR
+      #
+      #   @param updated_at [Time, nil] When the brand was last updated
+      #
+      #   @param vertical [Symbol, Sentdm::Models::TcrVertical, nil] Business vertical/industry category
+
+      # TCR brand identity verification status
+      #
+      # @see Sentdm::Models::BrandWithKYC#identity_status
+      module IdentityStatus
+        extend Sentdm::Internal::Type::Enum
+
+        SELF_DECLARED = :SELF_DECLARED
+        UNVERIFIED = :UNVERIFIED
+        VERIFIED = :VERIFIED
+        VETTED_VERIFIED = :VETTED_VERIFIED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+
+      # TCR brand status
+      #
+      # @see Sentdm::Models::BrandWithKYC#status
+      module Status
+        extend Sentdm::Internal::Type::Enum
+
+        ACTIVE = :ACTIVE
+        INACTIVE = :INACTIVE
+        SUSPENDED = :SUSPENDED
+
+        # @!method self.values
+        #   @return [Array<Symbol>]
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/api_response_tcr_campaign_with_use_cases.rb

@@ -0,0 +1,45 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      # @see Sentdm::Resources::Brands::Campaigns#create
+      class APIResponseTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The response data (null if error)
+        #
+        #   @return [Sentdm::Models::Brands::TcrCampaignWithUseCases, nil]
+        optional :data, -> { Sentdm::Brands::TcrCampaignWithUseCases }, nil?: true
+
+        # @!attribute error
+        #   Error details (null if successful)
+        #
+        #   @return [Sentdm::Models::APIError, nil]
+        optional :error, -> { Sentdm::APIError }, nil?: true
+
+        # @!attribute meta
+        #   Metadata about the request and response
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!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::Brands::TcrCampaignWithUseCases, nil] The response data (null if error)
+        #
+        #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/base_dto.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      class BaseDto < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #   Unique identifier
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time, api_name: :createdAt
+
+        # @!attribute updated_at
+        #
+        #   @return [Time, nil]
+        optional :updated_at, Time, api_name: :updatedAt, nil?: true
+
+        # @!method initialize(id: nil, created_at: nil, updated_at: nil)
+        #   @param id [String] Unique identifier
+        #
+        #   @param created_at [Time]
+        #
+        #   @param updated_at [Time, nil]
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/campaign_create_params.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      # @see Sentdm::Resources::Brands::Campaigns#create
+      class CampaignCreateParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute campaign
+        #   Campaign data
+        #
+        #   @return [Sentdm::Models::Brands::CampaignData]
+        required :campaign, -> { Sentdm::Brands::CampaignData }
+
+        # @!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(campaign:, test_mode: nil, idempotency_key: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Brands::CampaignCreateParams} for more details.
+        #
+        #   @param campaign [Sentdm::Models::Brands::CampaignData] Campaign data
+        #
+        #   @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+        #
+        #   @param idempotency_key [String]
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/campaign_data.rb

@@ -0,0 +1,123 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      class CampaignData < Sentdm::Internal::Type::BaseModel
+        # @!attribute description
+        #   Campaign description
+        #
+        #   @return [String]
+        required :description, String
+
+        # @!attribute name
+        #   Campaign name
+        #
+        #   @return [String]
+        required :name, String
+
+        # @!attribute type
+        #   Campaign type (e.g., "KYC", "App")
+        #
+        #   @return [String]
+        required :type, String
+
+        # @!attribute use_cases
+        #   List of use cases with sample messages
+        #
+        #   @return [Array<Sentdm::Models::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>]
+        required :use_cases,
+                 -> {
+                   Sentdm::Internal::Type::ArrayOf[Sentdm::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData]
+                 },
+                 api_name: :useCases
+
+        # @!attribute help_keywords
+        #   Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+        #
+        #   @return [String, nil]
+        optional :help_keywords, String, api_name: :helpKeywords, nil?: true
+
+        # @!attribute help_message
+        #   Message sent when user requests help
+        #
+        #   @return [String, nil]
+        optional :help_message, String, api_name: :helpMessage, nil?: true
+
+        # @!attribute message_flow
+        #   Description of how messages flow in the campaign
+        #
+        #   @return [String, nil]
+        optional :message_flow, String, api_name: :messageFlow, nil?: true
+
+        # @!attribute optin_keywords
+        #   Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+        #
+        #   @return [String, nil]
+        optional :optin_keywords, String, api_name: :optinKeywords, nil?: true
+
+        # @!attribute optin_message
+        #   Message sent when user opts in
+        #
+        #   @return [String, nil]
+        optional :optin_message, String, api_name: :optinMessage, nil?: true
+
+        # @!attribute optout_keywords
+        #   Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+        #
+        #   @return [String, nil]
+        optional :optout_keywords, String, api_name: :optoutKeywords, nil?: true
+
+        # @!attribute optout_message
+        #   Message sent when user opts out
+        #
+        #   @return [String, nil]
+        optional :optout_message, String, api_name: :optoutMessage, nil?: true
+
+        # @!attribute privacy_policy_link
+        #   URL to privacy policy
+        #
+        #   @return [String, nil]
+        optional :privacy_policy_link, String, api_name: :privacyPolicyLink, nil?: true
+
+        # @!attribute terms_and_conditions_link
+        #   URL to terms and conditions
+        #
+        #   @return [String, nil]
+        optional :terms_and_conditions_link, String, api_name: :termsAndConditionsLink, nil?: true
+
+        # @!method initialize(description:, name:, type:, use_cases:, help_keywords: nil, help_message: nil, message_flow: nil, optin_keywords: nil, optin_message: nil, optout_keywords: nil, optout_message: nil, privacy_policy_link: nil, terms_and_conditions_link: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::Brands::CampaignData} for more details.
+        #
+        #   Campaign data for create or update operation
+        #
+        #   @param description [String] Campaign description
+        #
+        #   @param name [String] Campaign name
+        #
+        #   @param type [String] Campaign type (e.g., "KYC", "App")
+        #
+        #   @param use_cases [Array<Sentdm::Models::Brands::SentDmServicesEndpointsCustomerApIv3ContractsRequestsCampaignsCampaignUseCaseData>] List of use cases with sample messages
+        #
+        #   @param help_keywords [String, nil] Comma-separated keywords that trigger help message (e.g., "HELP, INFO, SUPPORT")
+        #
+        #   @param help_message [String, nil] Message sent when user requests help
+        #
+        #   @param message_flow [String, nil] Description of how messages flow in the campaign
+        #
+        #   @param optin_keywords [String, nil] Comma-separated keywords that trigger opt-in (e.g., "YES, START, SUBSCRIBE")
+        #
+        #   @param optin_message [String, nil] Message sent when user opts in
+        #
+        #   @param optout_keywords [String, nil] Comma-separated keywords that trigger opt-out (e.g., "STOP, UNSUBSCRIBE, END")
+        #
+        #   @param optout_message [String, nil] Message sent when user opts out
+        #
+        #   @param privacy_policy_link [String, nil] URL to privacy policy
+        #
+        #   @param terms_and_conditions_link [String, nil] URL to terms and conditions
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/campaign_delete_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      # @see Sentdm::Resources::Brands::Campaigns#delete
+      class CampaignDeleteParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!attribute brand_id
+        #
+        #   @return [String]
+        required :brand_id, String
+
+        # @!attribute body
+        #   Request to delete a campaign from a brand
+        #
+        #   @return [Sentdm::Models::Brands::CampaignDeleteParams::Body]
+        required :body, -> { Sentdm::Brands::CampaignDeleteParams::Body }
+
+        # @!method initialize(brand_id:, body:, request_options: {})
+        #   @param brand_id [String]
+        #
+        #   @param body [Sentdm::Models::Brands::CampaignDeleteParams::Body] Request to delete a campaign from a brand
+        #
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+
+        class Body < Sentdm::Models::MutationRequest
+          # @!method initialize
+          #   Request to delete a campaign from a brand
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/campaign_list_params.rb

@@ -0,0 +1,16 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      # @see Sentdm::Resources::Brands::Campaigns#list
+      class CampaignListParams < Sentdm::Internal::Type::BaseModel
+        extend Sentdm::Internal::Type::RequestParameters::Converter
+        include Sentdm::Internal::Type::RequestParameters
+
+        # @!method initialize(request_options: {})
+        #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/sentdm/models/brands/campaign_list_response.rb

@@ -0,0 +1,47 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    module Brands
+      # @see Sentdm::Resources::Brands::Campaigns#list
+      class CampaignListResponse < Sentdm::Internal::Type::BaseModel
+        # @!attribute data
+        #   The response data (null if error)
+        #
+        #   @return [Array<Sentdm::Models::Brands::TcrCampaignWithUseCases>, nil]
+        optional :data,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Brands::TcrCampaignWithUseCases] },
+                 nil?: true
+
+        # @!attribute error
+        #   Error details (null if successful)
+        #
+        #   @return [Sentdm::Models::APIError, nil]
+        optional :error, -> { Sentdm::APIError }, nil?: true
+
+        # @!attribute meta
+        #   Metadata about the request and response
+        #
+        #   @return [Sentdm::Models::APIMeta, nil]
+        optional :meta, -> { Sentdm::APIMeta }
+
+        # @!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 [Array<Sentdm::Models::Brands::TcrCampaignWithUseCases>, nil] The response data (null if error)
+        #
+        #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+        #
+        #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+        #
+        #   @param success [Boolean] Indicates whether the request was successful
+      end
+    end
+  end
+end