sentdm 0.44.0 → 0.46.0

data/lib/sentdm/models/number_lookup_result.rb

@@ -0,0 +1,63 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class NumberLookupResult < Sentdm::Internal::Type::BaseModel
+      # @!attribute carrier_name
+      #
+      #   @return [String, nil]
+      optional :carrier_name, String, nil?: true
+
+      # @!attribute country_code
+      #
+      #   @return [String, nil]
+      optional :country_code, String, nil?: true
+
+      # @!attribute is_ported
+      #
+      #   @return [Boolean, nil]
+      optional :is_ported, Sentdm::Internal::Type::Boolean, nil?: true
+
+      # @!attribute is_valid
+      #
+      #   @return [Boolean, nil]
+      optional :is_valid, Sentdm::Internal::Type::Boolean
+
+      # @!attribute is_voip
+      #
+      #   @return [Boolean, nil]
+      optional :is_voip, Sentdm::Internal::Type::Boolean, nil?: true
+
+      # @!attribute line_type
+      #
+      #   @return [String, nil]
+      optional :line_type, String, nil?: true
+
+      # @!attribute mobile_country_code
+      #
+      #   @return [String, nil]
+      optional :mobile_country_code, String, nil?: true
+
+      # @!attribute mobile_network_code
+      #
+      #   @return [String, nil]
+      optional :mobile_network_code, String, nil?: true
+
+      # @!attribute phone_number
+      #
+      #   @return [String, nil]
+      optional :phone_number, String
+
+      # @!method initialize(carrier_name: nil, country_code: nil, is_ported: nil, is_valid: nil, is_voip: nil, line_type: nil, mobile_country_code: nil, mobile_network_code: nil, phone_number: nil)
+      #   @param carrier_name [String, nil]
+      #   @param country_code [String, nil]
+      #   @param is_ported [Boolean, nil]
+      #   @param is_valid [Boolean]
+      #   @param is_voip [Boolean, nil]
+      #   @param line_type [String, nil]
+      #   @param mobile_country_code [String, nil]
+      #   @param mobile_network_code [String, nil]
+      #   @param phone_number [String]
+    end
+  end
+end

data/lib/sentdm/models/pagination_cursors.rb

@@ -0,0 +1,27 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @deprecated
+    class PaginationCursors < 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. Never populated — see Cursors.
+      #
+      #   @param after [String, nil] Cursor to fetch the next page.
+      #
+      #   @param before [String, nil] Cursor to fetch the previous page.
+    end
+  end
+end

data/lib/sentdm/models/pagination_meta.rb

@@ -8,8 +8,8 @@ module Sentdm
       #
       #   Cursor-based pagination. Never populated — see Cursors.
       #
-      #   @return [Sentdm::Models::PaginationMeta::Cursors, nil]
-      optional :cursors, -> { Sentdm::PaginationMeta::Cursors }, nil?: true
+      #   @return [Sentdm::Models::PaginationCursors, nil]
+      optional :cursors, -> { Sentdm::PaginationCursors }, nil?: true
 
       # @!attribute has_more
       #   Whether there are more pages after this one
@@ -44,7 +44,7 @@ module Sentdm
       # @!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. Never populated — see Cursors.
+      #   @param cursors [Sentdm::Models::PaginationCursors, nil] Cursor-based pagination. Never populated — see Cursors.
       #
       #   @param has_more [Boolean] Whether there are more pages after this one
       #
@@ -55,30 +55,6 @@ module Sentdm
       #   @param total_count [Integer] Total number of items across all pages
       #
       #   @param total_pages [Integer] Total number of pages
-
-      # @deprecated
-      #
-      # @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. Never populated — see Cursors.
-        #
-        #   @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/profile_completion_accepted.rb

@@ -0,0 +1,20 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ProfileCompletionAccepted < Sentdm::Internal::Type::BaseModel
+      # @!attribute message
+      #   Human-readable message describing the accepted state.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!method initialize(message: nil)
+      #   Response acknowledging that profile completion has been accepted and started in
+      #   the background. The provided webhook URL will be called when processing
+      #   finishes.
+      #
+      #   @param message [String] Human-readable message describing the accepted state.
+    end
+  end
+end

data/lib/sentdm/models/profile_completion_result.rb

@@ -0,0 +1,31 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ProfileCompletionResult < Sentdm::Internal::Type::BaseModel
+      # @!attribute message
+      #   Human-readable message describing the result.
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!attribute status
+      #   Current process status of the profile (e.g., "completed", "submitted",
+      #   "in_progress").
+      #
+      #   @return [String, nil]
+      optional :status, String
+
+      # @!method initialize(message: nil, status: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::ProfileCompletionResult} for more details.
+      #
+      #   Response when a profile is already in the completed state and no further action
+      #   is taken.
+      #
+      #   @param message [String] Human-readable message describing the result.
+      #
+      #   @param status [String] Current process status of the profile (e.g., "completed", "submitted", "in_progr
+    end
+  end
+end

data/lib/sentdm/models/profile_detail.rb

@@ -38,8 +38,8 @@ module Sentdm
       # @!attribute billing_contact
       #   Billing contact info returned in profile responses
       #
-      #   @return [Sentdm::Models::ProfileDetail::BillingContact, nil]
-      optional :billing_contact, -> { Sentdm::ProfileDetail::BillingContact }, nil?: true
+      #   @return [Sentdm::Models::BillingContact, nil]
+      optional :billing_contact, -> { Sentdm::BillingContact }, nil?: true
 
       # @!attribute billing_model
       #   Billing model: profile, organization, or profile_and_organization
@@ -51,8 +51,8 @@ module Sentdm
       #   Brand response with nested contact, business, and compliance sections — mirrors
       #   the request structure.
       #
-      #   @return [Sentdm::Models::ProfileDetail::Brand, nil]
-      optional :brand, -> { Sentdm::ProfileDetail::Brand }, nil?: true
+      #   @return [Sentdm::Models::BrandWithKYC, nil]
+      optional :brand, -> { Sentdm::BrandWithKYC }, nil?: true
 
       # @!attribute created_at
       #   When the profile was created
@@ -202,11 +202,11 @@ module Sentdm
       #
       #   @param allow_template_sharing [Boolean, nil] Always false. A profile no longer shares templates with sibling profiles. Retain
       #
-      #   @param billing_contact [Sentdm::Models::ProfileDetail::BillingContact, nil] Billing contact info returned in profile responses
+      #   @param billing_contact [Sentdm::Models::BillingContact, nil] Billing contact info returned in profile responses
       #
       #   @param billing_model [String] Billing model: profile, organization, or profile_and_organization
       #
-      #   @param brand [Sentdm::Models::ProfileDetail::Brand, nil] Brand response with nested contact, business, and compliance sections — mirrors
+      #   @param brand [Sentdm::Models::BrandWithKYC, nil] Brand response with nested contact, business, and compliance sections — mirrors
       #
       #   @param created_at [Time] When the profile was created
       #
@@ -243,408 +243,6 @@ module Sentdm
       #   @param waba_id [String, nil] WhatsApp Business Account ID associated with this profile.
       #
       #   @param whatsapp_phone_number [String, nil] Direct WhatsApp phone number
-
-      # @see Sentdm::Models::ProfileDetail#billing_contact
-      class BillingContact < Sentdm::Internal::Type::BaseModel
-        # @!attribute address
-        #
-        #   @return [String, nil]
-        optional :address, String, nil?: true
-
-        # @!attribute email
-        #
-        #   @return [String, nil]
-        optional :email, String, nil?: true
-
-        # @!attribute name
-        #
-        #   @return [String, nil]
-        optional :name, String, nil?: true
-
-        # @!attribute phone
-        #
-        #   @return [String, nil]
-        optional :phone, String, nil?: true
-
-        # @!method initialize(address: nil, email: nil, name: nil, phone: nil)
-        #   Billing contact info returned in profile responses
-        #
-        #   @param address [String, nil]
-        #   @param email [String, nil]
-        #   @param name [String, nil]
-        #   @param phone [String, nil]
-      end
-
-      # @see Sentdm::Models::ProfileDetail#brand
-      class Brand < Sentdm::Internal::Type::BaseModel
-        # @!attribute id
-        #   Unique identifier for the brand
-        #
-        #   @return [String, nil]
-        optional :id, String
-
-        # @!attribute business
-        #   Business details and address information
-        #
-        #   @return [Sentdm::Models::ProfileDetail::Brand::Business, nil]
-        optional :business, -> { Sentdm::ProfileDetail::Brand::Business }, nil?: true
-
-        # @!attribute compliance
-        #   Compliance and TCR-related information
-        #
-        #   @return [Sentdm::Models::ProfileDetail::Brand::Compliance, nil]
-        optional :compliance, -> { Sentdm::ProfileDetail::Brand::Compliance }, nil?: true
-
-        # @!attribute contact
-        #   Contact information for the brand
-        #
-        #   @return [Sentdm::Models::ProfileDetail::Brand::Contact, nil]
-        optional :contact, -> { Sentdm::ProfileDetail::Brand::Contact }, nil?: true
-
-        # @!attribute created_at
-        #   When the brand was created
-        #
-        #   @return [Time, nil]
-        optional :created_at, Time
-
-        # @!attribute csp_id
-        #   @deprecated
-        #
-        #   Deprecated and scheduled for removal. Identifies the Campaign Service Provider
-        #   that registered the brand, which is Sent, so the value is the same for every
-        #   brand and every account. Nothing on your side can act on it and there is no
-        #   replacement. Stop reading it.
-        #
-        #   @return [String, nil]
-        optional :csp_id, String, nil?: true
-
-        # @!attribute identity_status
-        #
-        #   @return [Symbol, Sentdm::Models::ProfileDetail::Brand::IdentityStatus, nil]
-        optional :identity_status, enum: -> { Sentdm::ProfileDetail::Brand::IdentityStatus }, nil?: true
-
-        # @!attribute is_inherited
-        #   Whether this brand is inherited from the parent organization
-        #
-        #   @return [Boolean, nil]
-        optional :is_inherited, Sentdm::Internal::Type::Boolean
-
-        # @!attribute status
-        #
-        #   @return [Symbol, Sentdm::Models::ProfileDetail::Brand::Status, nil]
-        optional :status, enum: -> { Sentdm::ProfileDetail::Brand::Status }, nil?: true
-
-        # @!attribute submitted_at
-        #   When the brand was submitted to TCR
-        #
-        #   @return [Time, nil]
-        optional :submitted_at, Time, nil?: true
-
-        # @!attribute submitted_to_tcr
-        #   Whether this brand has been submitted to TCR
-        #
-        #   @return [Boolean, nil]
-        optional :submitted_to_tcr, Sentdm::Internal::Type::Boolean
-
-        # @!attribute tcr_brand_id
-        #   TCR brand ID (populated after TCR submission)
-        #
-        #   @return [String, nil]
-        optional :tcr_brand_id, String, nil?: true
-
-        # @!attribute universal_ein
-        #   Universal EIN from TCR
-        #
-        #   @return [String, nil]
-        optional :universal_ein, String, nil?: true
-
-        # @!attribute updated_at
-        #   When the brand was last updated
-        #
-        #   @return [Time, nil]
-        optional :updated_at, Time, nil?: true
-
-        # @!method initialize(id: nil, business: nil, compliance: nil, contact: nil, created_at: nil, csp_id: nil, identity_status: nil, is_inherited: nil, status: nil, submitted_at: nil, submitted_to_tcr: nil, tcr_brand_id: nil, universal_ein: nil, updated_at: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::ProfileDetail::Brand} for more details.
-        #
-        #   Brand response with nested contact, business, and compliance sections — mirrors
-        #   the request structure.
-        #
-        #   @param id [String] Unique identifier for the brand
-        #
-        #   @param business [Sentdm::Models::ProfileDetail::Brand::Business, nil] Business details and address information
-        #
-        #   @param compliance [Sentdm::Models::ProfileDetail::Brand::Compliance, nil] Compliance and TCR-related information
-        #
-        #   @param contact [Sentdm::Models::ProfileDetail::Brand::Contact, nil] Contact information for the brand
-        #
-        #   @param created_at [Time] When the brand was created
-        #
-        #   @param csp_id [String, nil] Deprecated and scheduled for removal. Identifies the Campaign Service Provider t
-        #
-        #   @param identity_status [Symbol, Sentdm::Models::ProfileDetail::Brand::IdentityStatus, nil]
-        #
-        #   @param is_inherited [Boolean] Whether this brand is inherited from the parent organization
-        #
-        #   @param status [Symbol, Sentdm::Models::ProfileDetail::Brand::Status, nil]
-        #
-        #   @param submitted_at [Time, nil] When the brand was submitted to TCR
-        #
-        #   @param submitted_to_tcr [Boolean] Whether this brand has been submitted to TCR
-        #
-        #   @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
-
-        # @see Sentdm::Models::ProfileDetail::Brand#business
-        class Business < 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, nil?: true
-
-          # @!attribute entity_type
-          #   Business entity type
-          #
-          #   @return [String, nil]
-          optional :entity_type, String, nil?: true
-
-          # @!attribute legal_name
-          #   Legal business name
-          #
-          #   @return [String, nil]
-          optional :legal_name, String, nil?: true
-
-          # @!attribute postal_code
-          #   Postal/ZIP code
-          #
-          #   @return [String, nil]
-          optional :postal_code, String, 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, nil?: true
-
-          # @!attribute tax_id_type
-          #   Type of tax ID (e.g., us_ein, ca_bn)
-          #
-          #   @return [String, nil]
-          optional :tax_id_type, String, 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 information
-          #
-          #   @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 [String, nil] Business entity type
-          #
-          #   @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
-        end
-
-        # @see Sentdm::Models::ProfileDetail::Brand#compliance
-        class Compliance < Sentdm::Internal::Type::BaseModel
-          # @!attribute brand_relationship
-          #
-          #   @return [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
-          optional :brand_relationship, enum: -> { Sentdm::TcrBrandRelationship }, 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] }
-
-          # @!attribute is_tcr_application
-          #   Whether this is a TCR (Campaign Registry) application
-          #
-          #   @return [Boolean, nil]
-          optional :is_tcr_application, Sentdm::Internal::Type::Boolean
-
-          # @!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, nil?: true
-
-          # @!attribute primary_use_case
-          #   @deprecated
-          #
-          #   Always null. The brand's free-text primary use case is no longer stored: it
-          #   reached neither TCR nor any decision, and its column is dropped with no
-          #   backfill, because the values were prose and the typed equivalent is the
-          #   campaign's MessagingUseCaseUS.
-          #
-          #   Retained so existing v3 clients reading primary_use_case keep deserializing.
-          #   Unlike the profile sharing flags, which can answer false truthfully, there is no
-          #   value to report here — the field is present and empty rather than present and
-          #   wrong.
-          #
-          #   @return [String, nil]
-          optional :primary_use_case, String, nil?: true
-
-          # @!attribute vertical
-          #
-          #   @return [Symbol, Sentdm::Models::TcrVertical, nil]
-          optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
-
-          # @!method initialize(brand_relationship: nil, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
-          #   Some parameter documentations has been truncated, see
-          #   {Sentdm::Models::ProfileDetail::Brand::Compliance} for more details.
-          #
-          #   Compliance and TCR-related information
-          #
-          #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
-          #
-          #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
-          #
-          #   @param is_tcr_application [Boolean] 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] Always null. The brand's free-text primary use case is no longer stored: it reac
-          #
-          #   @param vertical [Symbol, Sentdm::Models::TcrVertical, nil]
-        end
-
-        # @see Sentdm::Models::ProfileDetail::Brand#contact
-        class Contact < Sentdm::Internal::Type::BaseModel
-          # @!attribute business_name
-          #   Business/brand name
-          #
-          #   @return [String, nil]
-          optional :business_name, String, nil?: true
-
-          # @!attribute email
-          #   Contact email address
-          #
-          #   @return [String, nil]
-          optional :email, String, nil?: true
-
-          # @!attribute name
-          #   Primary contact name
-          #
-          #   @return [String, nil]
-          optional :name, String
-
-          # @!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, nil?: true
-
-          # @!attribute role
-          #   Contact's role in the business
-          #
-          #   @return [String, nil]
-          optional :role, String, nil?: true
-
-          # @!method initialize(business_name: nil, email: nil, name: nil, phone: nil, phone_country_code: nil, role: nil)
-          #   Contact information for the brand
-          #
-          #   @param business_name [String, nil] Business/brand name
-          #
-          #   @param email [String, nil] Contact email address
-          #
-          #   @param name [String] Primary contact name
-          #
-          #   @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
-
-        # @see Sentdm::Models::ProfileDetail::Brand#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
-
-        # @see Sentdm::Models::ProfileDetail::Brand#status
-        module Status
-          extend Sentdm::Internal::Type::Enum
-
-          ACTIVE = :ACTIVE
-          INACTIVE = :INACTIVE
-          SUSPENDED = :SUSPENDED
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
     end
   end
 end

data/lib/sentdm/models/profiles/brand_campaign.rb

@@ -109,8 +109,8 @@ module Sentdm
 
         # @!attribute status
         #
-        #   @return [Symbol, Sentdm::Models::Profiles::BrandCampaign::Status, nil]
-        optional :status, enum: -> { Sentdm::Profiles::BrandCampaign::Status }, nil?: true
+        #   @return [Symbol, Sentdm::Models::TcrCampaignStatus, nil]
+        optional :status, enum: -> { Sentdm::TcrCampaignStatus }, nil?: true
 
         # @!attribute submitted_at
         #
@@ -210,7 +210,7 @@ module Sentdm
         #
         #   @param privacy_policy_link [String, nil]
         #
-        #   @param status [Symbol, Sentdm::Models::Profiles::BrandCampaign::Status, nil]
+        #   @param status [Symbol, Sentdm::Models::TcrCampaignStatus, nil]
         #
         #   @param submitted_at [Time, nil]
         #
@@ -229,18 +229,6 @@ module Sentdm
         #   @param use_cases [Array<Sentdm::Models::Profiles::CampaignUseCase>]
         #
         #   @param volume [String, nil] Expected messaging volume for this campaign — customer-supplied on create/update
-
-        # @see Sentdm::Models::Profiles::BrandCampaign#status
-        module Status
-          extend Sentdm::Internal::Type::Enum
-
-          SENT_CREATED = :SENT_CREATED
-          ACTIVE = :ACTIVE
-          EXPIRED = :EXPIRED
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
       end
     end
   end