sentdm 0.26.0 → 0.28.0

data/lib/sentdm/models/api_response_of_user.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Users#retrieve
-    class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   User response for v3 API
-      #
-      #   @return [Sentdm::Models::UserResponse, nil]
-      optional :data, -> { Sentdm::UserResponse }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @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::UserResponse, nil] User response for v3 API
-      #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-    end
-  end
-end

data/lib/sentdm/models/api_response_template.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Templates#create
-    class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   Template response for v3 API
-      #
-      #   @return [Sentdm::Models::Template, nil]
-      optional :data, -> { Sentdm::Template }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @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::Template, nil] Template response for v3 API
-      #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-    end
-  end
-end

data/lib/sentdm/models/api_response_webhook.rb

@@ -1,43 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    # @see Sentdm::Resources::Webhooks#create
-    class APIResponseWebhook < Sentdm::Internal::Type::BaseModel
-      # @!attribute data
-      #   The response data (null if error)
-      #
-      #   @return [Sentdm::Models::WebhookResponse, nil]
-      optional :data, -> { Sentdm::WebhookResponse }, nil?: true
-
-      # @!attribute error
-      #   Error information
-      #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
-
-      # @!attribute meta
-      #   Request and response metadata
-      #
-      #   @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::WebhookResponse, nil] The response data (null if error)
-      #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
-      #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
-      #
-      #   @param success [Boolean] Indicates whether the request was successful
-    end
-  end
-end

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/brand_business_info.rb

@@ -1,114 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class BrandBusinessInfo < 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::BrandBusinessInfo::EntityType, nil]
-      optional :entity_type,
-               enum: -> { Sentdm::BrandBusinessInfo::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::BrandBusinessInfo::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::BrandBusinessInfo#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/brand_compliance_info.rb

@@ -1,67 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class BrandComplianceInfo < 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 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, 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 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/brand_contact_info.rb

@@ -1,58 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class BrandContactInfo < 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/brands_brand_data.rb

@@ -1,34 +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::BrandComplianceInfo]
-      required :compliance, -> { Sentdm::BrandComplianceInfo }
-
-      # @!attribute contact
-      #   Contact information for brand KYC
-      #
-      #   @return [Sentdm::Models::BrandContactInfo]
-      required :contact, -> { Sentdm::BrandContactInfo }
-
-      # @!attribute business
-      #   Business details and address for brand KYC
-      #
-      #   @return [Sentdm::Models::BrandBusinessInfo, nil]
-      optional :business, -> { Sentdm::BrandBusinessInfo }, nil?: true
-
-      # @!method initialize(compliance:, contact:, business: nil)
-      #   Brand and KYC data grouped into contact, business, and compliance sections
-      #
-      #   @param compliance [Sentdm::Models::BrandComplianceInfo] Compliance and TCR information for brand registration
-      #
-      #   @param contact [Sentdm::Models::BrandContactInfo] Contact information for brand KYC
-      #
-      #   @param business [Sentdm::Models::BrandBusinessInfo, nil] Business details and address for brand KYC
-    end
-  end
-end

data/lib/sentdm/models/contact_message_summary.rb

@@ -1,76 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class ContactMessageSummary < Sentdm::Internal::Type::BaseModel
-      # @!attribute channel_scores
-      #
-      #   @return [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>, nil]
-      optional :channel_scores,
-               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactMessageSummary::ChannelScore] }
-
-      # @!attribute channels_used
-      #
-      #   @return [Array<String>, nil]
-      optional :channels_used, Sentdm::Internal::Type::ArrayOf[String]
-
-      # @!attribute contact_id
-      #
-      #   @return [String, nil]
-      optional :contact_id, String
-
-      # @!attribute first_message_at
-      #
-      #   @return [Time, nil]
-      optional :first_message_at, Time, nil?: true
-
-      # @!attribute last_message_at
-      #
-      #   @return [Time, nil]
-      optional :last_message_at, Time, nil?: true
-
-      # @!attribute message_count
-      #
-      #   @return [Integer, nil]
-      optional :message_count, Integer
-
-      # @!method initialize(channel_scores: nil, channels_used: nil, contact_id: nil, first_message_at: nil, last_message_at: nil, message_count: nil)
-      #   @param channel_scores [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>]
-      #   @param channels_used [Array<String>]
-      #   @param contact_id [String]
-      #   @param first_message_at [Time, nil]
-      #   @param last_message_at [Time, nil]
-      #   @param message_count [Integer]
-
-      class ChannelScore < Sentdm::Internal::Type::BaseModel
-        # @!attribute channel
-        #
-        #   @return [String, nil]
-        optional :channel, String
-
-        # @!attribute fail_score
-        #   Percentage (0-100) of messages on this channel that ended in FAILED.
-        #
-        #   @return [Integer, nil]
-        optional :fail_score, Integer
-
-        # @!attribute success_score
-        #   Percentage (0-100) of messages on this channel that reached a successful
-        #   terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
-        #
-        #   @return [Integer, nil]
-        optional :success_score, Integer
-
-        # @!method initialize(channel: nil, fail_score: nil, success_score: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::ContactMessageSummary::ChannelScore} for more details.
-        #
-        #   @param channel [String]
-        #
-        #   @param fail_score [Integer] Percentage (0-100) of messages on this channel that ended in FAILED.
-        #
-        #   @param success_score [Integer] Percentage (0-100) of messages on this channel that reached a successful termina
-      end
-    end
-  end
-end

data/lib/sentdm/models/contact_response.rb

@@ -1,126 +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 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. Single source of truth — opt-out
-      #   is per-contact, not per-channel.
-      #
-      #   @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, 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 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. Single source of truth — opt-out
-      #
-      #   @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