sentdm 0.18.0 → 0.19.0

data/lib/sentdm/models/billing_contact_info.rb

@@ -1,47 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class BillingContactInfo < Sentdm::Internal::Type::BaseModel
-      # @!attribute email
-      #   Email address where invoices will be sent (required)
-      #
-      #   @return [String]
-      required :email, String
-
-      # @!attribute name
-      #   Full name of the billing contact or company (required)
-      #
-      #   @return [String]
-      required :name, String
-
-      # @!attribute address
-      #   Billing address (optional). Free-form text including street, city, state, postal
-      #   code, and country.
-      #
-      #   @return [String, nil]
-      optional :address, String, nil?: true
-
-      # @!attribute phone
-      #   Phone number for the billing contact (optional)
-      #
-      #   @return [String, nil]
-      optional :phone, String, nil?: true
-
-      # @!method initialize(email:, name:, address: nil, phone: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::BillingContactInfo} for more details.
-      #
-      #   Billing contact information for a profile. Required when billing_model is
-      #   "profile" or "profile_and_organization".
-      #
-      #   @param email [String] Email address where invoices will be sent (required)
-      #
-      #   @param name [String] Full name of the billing contact or company (required)
-      #
-      #   @param address [String, nil] Billing address (optional). Free-form text including street, city, state, postal
-      #
-      #   @param phone [String, nil] Phone number for the billing contact (optional)
-    end
-  end
-end

data/lib/sentdm/models/brands_brand_data.rb

@@ -1,38 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class BrandsBrandData < Sentdm::Internal::Type::BaseModel
-      # @!attribute compliance
-      #   Compliance and TCR information for brand registration
-      #
-      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo]
-      required :compliance,
-               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo }
-
-      # @!attribute contact
-      #   Contact information for brand KYC
-      #
-      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo]
-      required :contact,
-               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo }
-
-      # @!attribute business
-      #   Business details and address for brand KYC
-      #
-      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil]
-      optional :business,
-               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo },
-               nil?: true
-
-      # @!method initialize(compliance:, contact:, business: nil)
-      #   Brand and KYC data grouped into contact, business, and compliance sections
-      #
-      #   @param compliance [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo] Compliance and TCR information for brand registration
-      #
-      #   @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for brand KYC
-      #
-      #   @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address for brand KYC
-    end
-  end
-end

data/lib/sentdm/models/contact_response.rb

@@ -1,136 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class ContactResponse < Sentdm::Internal::Type::BaseModel
-      # @!attribute id
-      #   Unique identifier for the contact
-      #
-      #   @return [String, nil]
-      optional :id, String
-
-      # @!attribute available_channels
-      #   Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
-      #
-      #   @return [String, nil]
-      optional :available_channels, String
-
-      # @!attribute channel_consent
-      #   Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in",
-      #   "opted_out". All channels will have the same status because consent is global
-      #   across channels. A STOP on any channel opts out of all channels; a START opts in
-      #   to all.
-      #
-      #   @return [Hash{Symbol=>String}, nil]
-      optional :channel_consent, Sentdm::Internal::Type::HashOf[String], nil?: true
-
-      # @!attribute country_code
-      #   Country calling code (e.g., 1 for US/Canada)
-      #
-      #   @return [String, nil]
-      optional :country_code, String
-
-      # @!attribute created_at
-      #   When the contact was created
-      #
-      #   @return [Time, nil]
-      optional :created_at, Time
-
-      # @!attribute default_channel
-      #   Default messaging channel to use (e.g., "sms" or "whatsapp")
-      #
-      #   @return [String, nil]
-      optional :default_channel, String
-
-      # @!attribute format_e164
-      #   Phone number in E.164 format (e.g., +1234567890)
-      #
-      #   @return [String, nil]
-      optional :format_e164, String
-
-      # @!attribute format_international
-      #   Phone number in international format (e.g., +1 234-567-890)
-      #
-      #   @return [String, nil]
-      optional :format_international, String
-
-      # @!attribute format_national
-      #   Phone number in national format (e.g., (234) 567-890)
-      #
-      #   @return [String, nil]
-      optional :format_national, String
-
-      # @!attribute format_rfc
-      #   Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
-      #
-      #   @return [String, nil]
-      optional :format_rfc, String
-
-      # @!attribute is_inherited
-      #   Whether this is an inherited contact (read-only)
-      #
-      #   @return [Boolean, nil]
-      optional :is_inherited, Sentdm::Internal::Type::Boolean
-
-      # @!attribute opt_out
-      #   Whether the contact has opted out of messaging
-      #
-      #   @return [Boolean, nil]
-      optional :opt_out, Sentdm::Internal::Type::Boolean
-
-      # @!attribute phone_number
-      #   Phone number in original format
-      #
-      #   @return [String, nil]
-      optional :phone_number, String
-
-      # @!attribute region_code
-      #   ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-      #
-      #   @return [String, nil]
-      optional :region_code, String
-
-      # @!attribute updated_at
-      #   When the contact was last updated
-      #
-      #   @return [Time, nil]
-      optional :updated_at, Time, nil?: true
-
-      # @!method initialize(id: nil, available_channels: nil, channel_consent: nil, country_code: nil, created_at: nil, default_channel: nil, format_e164: nil, format_international: nil, format_national: nil, format_rfc: nil, is_inherited: nil, opt_out: nil, phone_number: nil, region_code: nil, updated_at: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::ContactResponse} for more details.
-      #
-      #   Contact response for v3 API Uses snake_case for JSON property names
-      #
-      #   @param id [String] Unique identifier for the contact
-      #
-      #   @param available_channels [String] Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
-      #
-      #   @param channel_consent [Hash{Symbol=>String}, nil] Consent status by channel. Keys: "sms", "whatsapp". Values: "opted_in", "opted_o
-      #
-      #   @param country_code [String] Country calling code (e.g., 1 for US/Canada)
-      #
-      #   @param created_at [Time] When the contact was created
-      #
-      #   @param default_channel [String] Default messaging channel to use (e.g., "sms" or "whatsapp")
-      #
-      #   @param format_e164 [String] Phone number in E.164 format (e.g., +1234567890)
-      #
-      #   @param format_international [String] Phone number in international format (e.g., +1 234-567-890)
-      #
-      #   @param format_national [String] Phone number in national format (e.g., (234) 567-890)
-      #
-      #   @param format_rfc [String] Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
-      #
-      #   @param is_inherited [Boolean] Whether this is an inherited contact (read-only)
-      #
-      #   @param opt_out [Boolean] Whether the contact has opted out of messaging
-      #
-      #   @param phone_number [String] Phone number in original format
-      #
-      #   @param region_code [String] ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
-      #
-      #   @param updated_at [Time, nil] When the contact was last updated
-    end
-  end
-end

data/lib/sentdm/models/destination_country.rb

@@ -1,21 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class DestinationCountry < Sentdm::Internal::Type::BaseModel
-      # @!attribute id
-      #
-      #   @return [String, nil]
-      optional :id, String
-
-      # @!attribute is_main
-      #
-      #   @return [Boolean, nil]
-      optional :is_main, Sentdm::Internal::Type::Boolean, api_name: :isMain
-
-      # @!method initialize(id: nil, is_main: nil)
-      #   @param id [String]
-      #   @param is_main [Boolean]
-    end
-  end
-end

data/lib/sentdm/models/error_detail.rb

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

data/lib/sentdm/models/mutation_request.rb

@@ -1,20 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class MutationRequest < Sentdm::Internal::Type::BaseModel
-      # @!attribute sandbox
-      #   Sandbox flag - when true, the operation is simulated without side effects Useful
-      #   for testing integrations without actual execution
-      #
-      #   @return [Boolean, nil]
-      optional :sandbox, Sentdm::Internal::Type::Boolean
-
-      # @!method initialize(sandbox: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::MutationRequest} for more details.
-      #
-      #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
-    end
-  end
-end

data/lib/sentdm/models/pagination_meta.rb

@@ -1,80 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class PaginationMeta < Sentdm::Internal::Type::BaseModel
-      # @!attribute cursors
-      #   Cursor-based pagination pointers
-      #
-      #   @return [Sentdm::Models::PaginationMeta::Cursors, nil]
-      optional :cursors, -> { Sentdm::PaginationMeta::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::PaginationMeta::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::PaginationMeta#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
-  end
-end

data/lib/sentdm/models/payment_details.rb

@@ -1,44 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class PaymentDetails < Sentdm::Internal::Type::BaseModel
-      # @!attribute card_number
-      #   Card number (digits only, 13–19 characters)
-      #
-      #   @return [String]
-      required :card_number, String
-
-      # @!attribute cvc
-      #   Card security code (3–4 digits)
-      #
-      #   @return [String]
-      required :cvc, String
-
-      # @!attribute expiry
-      #   Card expiry date in MM/YY format (e.g. "09/27")
-      #
-      #   @return [String]
-      required :expiry, String
-
-      # @!attribute zip_code
-      #   Billing ZIP / postal code associated with the card
-      #
-      #   @return [String]
-      required :zip_code, String
-
-      # @!method initialize(card_number:, cvc:, expiry:, zip_code:)
-      #   Payment card details for a profile. Accepted when billing_model is "profile" or
-      #   "profile_and_organization". These details are not stored on our servers and will
-      #   be forwarded to the payment processor.
-      #
-      #   @param card_number [String] Card number (digits only, 13–19 characters)
-      #
-      #   @param cvc [String] Card security code (3–4 digits)
-      #
-      #   @param expiry [String] Card expiry date in MM/YY format (e.g. "09/27")
-      #
-      #   @param zip_code [String] Billing ZIP / postal code associated with the card
-    end
-  end
-end