sentdm 0.18.0 → 0.19.0

data/lib/sentdm/models/profile_detail.rb

@@ -1,605 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class ProfileDetail < Sentdm::Internal::Type::BaseModel
-      # @!attribute id
-      #   Profile unique identifier
-      #
-      #   @return [String, nil]
-      optional :id, String
-
-      # @!attribute allow_contact_sharing
-      #   Whether contacts are shared across profiles in the organization
-      #
-      #   @return [Boolean, nil]
-      optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean
-
-      # @!attribute allow_number_change_during_onboarding
-      #   Whether number changes are allowed during onboarding
-      #
-      #   @return [Boolean, nil]
-      optional :allow_number_change_during_onboarding, Sentdm::Internal::Type::Boolean, nil?: true
-
-      # @!attribute allow_template_sharing
-      #   Whether templates are shared across profiles in the organization
-      #
-      #   @return [Boolean, nil]
-      optional :allow_template_sharing, Sentdm::Internal::Type::Boolean
-
-      # @!attribute billing_contact
-      #   Billing contact info returned in profile responses
-      #
-      #   @return [Sentdm::Models::ProfileDetail::BillingContact, nil]
-      optional :billing_contact, -> { Sentdm::ProfileDetail::BillingContact }, nil?: true
-
-      # @!attribute billing_model
-      #   Billing model: profile, organization, or profile_and_organization
-      #
-      #   @return [String, nil]
-      optional :billing_model, String
-
-      # @!attribute brand
-      #   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
-
-      # @!attribute created_at
-      #   When the profile was created
-      #
-      #   @return [Time, nil]
-      optional :created_at, Time
-
-      # @!attribute description
-      #   Profile description
-      #
-      #   @return [String, nil]
-      optional :description, String, nil?: true
-
-      # @!attribute email
-      #   Profile email (inherited from organization)
-      #
-      #   @return [String, nil]
-      optional :email, String, nil?: true
-
-      # @!attribute icon
-      #   Profile icon URL
-      #
-      #   @return [String, nil]
-      optional :icon, String, nil?: true
-
-      # @!attribute inherit_contacts
-      #   Whether this profile inherits contacts from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_contacts, Sentdm::Internal::Type::Boolean
-
-      # @!attribute inherit_tcr_brand
-      #   Whether this profile inherits TCR brand from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean
-
-      # @!attribute inherit_tcr_campaign
-      #   Whether this profile inherits TCR campaign from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean
-
-      # @!attribute inherit_templates
-      #   Whether this profile inherits templates from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_templates, Sentdm::Internal::Type::Boolean
-
-      # @!attribute name
-      #   Profile name
-      #
-      #   @return [String, nil]
-      optional :name, String
-
-      # @!attribute organization_id
-      #   Parent organization ID
-      #
-      #   @return [String, nil]
-      optional :organization_id, String, nil?: true
-
-      # @!attribute sending_phone_number
-      #   Direct SMS phone number
-      #
-      #   @return [String, nil]
-      optional :sending_phone_number, String, nil?: true
-
-      # @!attribute sending_phone_number_profile_id
-      #   Reference to another profile for SMS/Telnyx configuration
-      #
-      #   @return [String, nil]
-      optional :sending_phone_number_profile_id, String, nil?: true
-
-      # @!attribute sending_whatsapp_number_profile_id
-      #   Reference to another profile for WhatsApp configuration
-      #
-      #   @return [String, nil]
-      optional :sending_whatsapp_number_profile_id, String, nil?: true
-
-      # @!attribute short_name
-      #   Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces
-      #   only, with at least one letter.
-      #
-      #   @return [String, nil]
-      optional :short_name, String, nil?: true
-
-      # @!attribute status
-      #   Profile setup status: incomplete, pending_review, approved, rejected
-      #
-      #   @return [String, nil]
-      optional :status, String
-
-      # @!attribute updated_at
-      #   When the profile was last updated
-      #
-      #   @return [Time, nil]
-      optional :updated_at, Time, nil?: true
-
-      # @!attribute waba_id
-      #   WhatsApp Business Account ID associated with this profile. Present whether the
-      #   WABA is inherited from the organization or configured directly.
-      #
-      #   @return [String, nil]
-      optional :waba_id, String, nil?: true
-
-      # @!attribute whatsapp_phone_number
-      #   Direct WhatsApp phone number
-      #
-      #   @return [String, nil]
-      optional :whatsapp_phone_number, String, nil?: true
-
-      # @!method initialize(id: nil, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, created_at: nil, description: nil, email: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, organization_id: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, status: nil, updated_at: nil, waba_id: nil, whatsapp_phone_number: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::ProfileDetail} for more details.
-      #
-      #   Detailed profile response for v3 API
-      #
-      #   @param id [String] Profile unique identifier
-      #
-      #   @param allow_contact_sharing [Boolean] Whether contacts are shared across profiles in the organization
-      #
-      #   @param allow_number_change_during_onboarding [Boolean, nil] Whether number changes are allowed during onboarding
-      #
-      #   @param allow_template_sharing [Boolean] Whether templates are shared across profiles in the organization
-      #
-      #   @param billing_contact [Sentdm::Models::ProfileDetail::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 created_at [Time] When the profile was created
-      #
-      #   @param description [String, nil] Profile description
-      #
-      #   @param email [String, nil] Profile email (inherited from organization)
-      #
-      #   @param icon [String, nil] Profile icon URL
-      #
-      #   @param inherit_contacts [Boolean] Whether this profile inherits contacts from the organization
-      #
-      #   @param inherit_tcr_brand [Boolean] Whether this profile inherits TCR brand from the organization
-      #
-      #   @param inherit_tcr_campaign [Boolean] Whether this profile inherits TCR campaign from the organization
-      #
-      #   @param inherit_templates [Boolean] Whether this profile inherits templates from the organization
-      #
-      #   @param name [String] Profile name
-      #
-      #   @param organization_id [String, nil] Parent organization ID
-      #
-      #   @param sending_phone_number [String, nil] Direct SMS phone number
-      #
-      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile for SMS/Telnyx configuration
-      #
-      #   @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile for WhatsApp configuration
-      #
-      #   @param short_name [String, nil] Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces o
-      #
-      #   @param status [String] Profile setup status: incomplete, pending_review, approved, rejected
-      #
-      #   @param updated_at [Time, nil] When the profile was last updated
-      #
-      #   @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
-        #   CSP (Campaign Service Provider) ID
-        #
-        #   @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)
-        #   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] CSP (Campaign Service Provider) ID
-        #
-        #   @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 expected_messaging_volume
-          #   Expected daily messaging volume
-          #
-          #   @return [String, nil]
-          optional :expected_messaging_volume, String, 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
-
-          # @!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
-          #   Primary messaging use case description
-          #
-          #   @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, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
-          #   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 expected_messaging_volume [String, nil] Expected daily messaging volume
-          #
-          #   @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] Primary messaging use case description
-          #
-          #   @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/profile_settings.rb

@@ -1,66 +0,0 @@
-# frozen_string_literal: true
-
-module Sentdm
-  module Models
-    class ProfileSettings < Sentdm::Internal::Type::BaseModel
-      # @!attribute allow_contact_sharing
-      #   Whether contacts are shared across profiles in the organization
-      #
-      #   @return [Boolean, nil]
-      optional :allow_contact_sharing, Sentdm::Internal::Type::Boolean, nil?: true
-
-      # @!attribute allow_template_sharing
-      #   Whether templates are shared across profiles in the organization
-      #
-      #   @return [Boolean, nil]
-      optional :allow_template_sharing, Sentdm::Internal::Type::Boolean, nil?: true
-
-      # @!attribute billing_model
-      #   Billing model: profile, organization, or profile_and_organization
-      #
-      #   @return [String, nil]
-      optional :billing_model, String, nil?: true
-
-      # @!attribute inherit_contacts
-      #   Whether this profile inherits contacts from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_contacts, Sentdm::Internal::Type::Boolean, nil?: true
-
-      # @!attribute inherit_tcr_brand
-      #   Whether this profile inherits TCR brand from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_tcr_brand, Sentdm::Internal::Type::Boolean, nil?: true
-
-      # @!attribute inherit_tcr_campaign
-      #   Whether this profile inherits TCR campaign from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_tcr_campaign, Sentdm::Internal::Type::Boolean, nil?: true
-
-      # @!attribute inherit_templates
-      #   Whether this profile inherits templates from the organization
-      #
-      #   @return [Boolean, nil]
-      optional :inherit_templates, Sentdm::Internal::Type::Boolean, nil?: true
-
-      # @!method initialize(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil)
-      #   Profile configuration settings
-      #
-      #   @param allow_contact_sharing [Boolean, nil] Whether contacts are shared across profiles in the organization
-      #
-      #   @param allow_template_sharing [Boolean, nil] Whether templates are shared across profiles in the organization
-      #
-      #   @param billing_model [String, nil] Billing model: profile, organization, or profile_and_organization
-      #
-      #   @param inherit_contacts [Boolean, nil] Whether this profile inherits contacts from the organization
-      #
-      #   @param inherit_tcr_brand [Boolean, nil] Whether this profile inherits TCR brand from the organization
-      #
-      #   @param inherit_tcr_campaign [Boolean, nil] Whether this profile inherits TCR campaign from the organization
-      #
-      #   @param inherit_templates [Boolean, nil] Whether this profile inherits templates from the organization
-    end
-  end
-end