sentdm 0.18.0 → 0.19.0

data/rbi/sentdm/models/profile_retrieve_response.rbi

@@ -0,0 +1,1443 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ProfileRetrieveResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::ProfileRetrieveResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Detailed profile response for v3 API
+      sig { returns(T.nilable(Sentdm::Models::ProfileRetrieveResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ProfileRetrieveResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::Models::ProfileRetrieveResponse::Error)) }
+      attr_reader :error
+
+      sig do
+        params(
+          error:
+            T.nilable(Sentdm::Models::ProfileRetrieveResponse::Error::OrHash)
+        ).void
+      end
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::Models::ProfileRetrieveResponse::Meta)) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Sentdm::Models::ProfileRetrieveResponse::Meta::OrHash).void
+      end
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data:
+            T.nilable(Sentdm::Models::ProfileRetrieveResponse::Data::OrHash),
+          error:
+            T.nilable(Sentdm::Models::ProfileRetrieveResponse::Error::OrHash),
+          meta: Sentdm::Models::ProfileRetrieveResponse::Meta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Detailed profile response for v3 API
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::ProfileRetrieveResponse::Data),
+            error: T.nilable(Sentdm::Models::ProfileRetrieveResponse::Error),
+            meta: Sentdm::Models::ProfileRetrieveResponse::Meta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ProfileRetrieveResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Profile unique identifier
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Whether contacts are shared across profiles in the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :allow_contact_sharing
+
+        sig { params(allow_contact_sharing: T::Boolean).void }
+        attr_writer :allow_contact_sharing
+
+        # Whether number changes are allowed during onboarding
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_accessor :allow_number_change_during_onboarding
+
+        # Whether templates are shared across profiles in the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :allow_template_sharing
+
+        sig { params(allow_template_sharing: T::Boolean).void }
+        attr_writer :allow_template_sharing
+
+        # Billing contact info returned in profile responses
+        sig do
+          returns(
+            T.nilable(
+              Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact
+            )
+          )
+        end
+        attr_reader :billing_contact
+
+        sig do
+          params(
+            billing_contact:
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact::OrHash
+              )
+          ).void
+        end
+        attr_writer :billing_contact
+
+        # Billing model: profile, organization, or profile_and_organization
+        sig { returns(T.nilable(String)) }
+        attr_reader :billing_model
+
+        sig { params(billing_model: String).void }
+        attr_writer :billing_model
+
+        # Brand response with nested contact, business, and compliance sections — mirrors
+        # the request structure.
+        sig do
+          returns(
+            T.nilable(Sentdm::Models::ProfileRetrieveResponse::Data::Brand)
+          )
+        end
+        attr_reader :brand
+
+        sig do
+          params(
+            brand:
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::OrHash
+              )
+          ).void
+        end
+        attr_writer :brand
+
+        # When the profile was created
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Profile description
+        sig { returns(T.nilable(String)) }
+        attr_accessor :description
+
+        # Profile email (inherited from organization)
+        sig { returns(T.nilable(String)) }
+        attr_accessor :email
+
+        # Profile icon URL
+        sig { returns(T.nilable(String)) }
+        attr_accessor :icon
+
+        # Whether this profile inherits contacts from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_contacts
+
+        sig { params(inherit_contacts: T::Boolean).void }
+        attr_writer :inherit_contacts
+
+        # Whether this profile inherits TCR brand from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_tcr_brand
+
+        sig { params(inherit_tcr_brand: T::Boolean).void }
+        attr_writer :inherit_tcr_brand
+
+        # Whether this profile inherits TCR campaign from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_tcr_campaign
+
+        sig { params(inherit_tcr_campaign: T::Boolean).void }
+        attr_writer :inherit_tcr_campaign
+
+        # Whether this profile inherits templates from the organization
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :inherit_templates
+
+        sig { params(inherit_templates: T::Boolean).void }
+        attr_writer :inherit_templates
+
+        # Profile name
+        sig { returns(T.nilable(String)) }
+        attr_reader :name
+
+        sig { params(name: String).void }
+        attr_writer :name
+
+        # Parent organization ID
+        sig { returns(T.nilable(String)) }
+        attr_accessor :organization_id
+
+        # Direct SMS phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_phone_number
+
+        # Reference to another profile for SMS/Telnyx configuration
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_phone_number_profile_id
+
+        # Reference to another profile for WhatsApp configuration
+        sig { returns(T.nilable(String)) }
+        attr_accessor :sending_whatsapp_number_profile_id
+
+        # Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces
+        # only, with at least one letter.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :short_name
+
+        # Profile setup status: incomplete, pending_review, approved, rejected
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        # When the profile was last updated
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # WhatsApp Business Account ID associated with this profile. Present whether the
+        # WABA is inherited from the organization or configured directly.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :waba_id
+
+        # Direct WhatsApp phone number
+        sig { returns(T.nilable(String)) }
+        attr_accessor :whatsapp_phone_number
+
+        # Detailed profile response for v3 API
+        sig do
+          params(
+            id: String,
+            allow_contact_sharing: T::Boolean,
+            allow_number_change_during_onboarding: T.nilable(T::Boolean),
+            allow_template_sharing: T::Boolean,
+            billing_contact:
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact::OrHash
+              ),
+            billing_model: String,
+            brand:
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::OrHash
+              ),
+            created_at: Time,
+            description: T.nilable(String),
+            email: T.nilable(String),
+            icon: T.nilable(String),
+            inherit_contacts: T::Boolean,
+            inherit_tcr_brand: T::Boolean,
+            inherit_tcr_campaign: T::Boolean,
+            inherit_templates: T::Boolean,
+            name: String,
+            organization_id: T.nilable(String),
+            sending_phone_number: T.nilable(String),
+            sending_phone_number_profile_id: T.nilable(String),
+            sending_whatsapp_number_profile_id: T.nilable(String),
+            short_name: T.nilable(String),
+            status: String,
+            updated_at: T.nilable(Time),
+            waba_id: T.nilable(String),
+            whatsapp_phone_number: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Profile unique identifier
+          id: nil,
+          # Whether contacts are shared across profiles in the organization
+          allow_contact_sharing: nil,
+          # Whether number changes are allowed during onboarding
+          allow_number_change_during_onboarding: nil,
+          # Whether templates are shared across profiles in the organization
+          allow_template_sharing: nil,
+          # Billing contact info returned in profile responses
+          billing_contact: nil,
+          # Billing model: profile, organization, or profile_and_organization
+          billing_model: nil,
+          # Brand response with nested contact, business, and compliance sections — mirrors
+          # the request structure.
+          brand: nil,
+          # When the profile was created
+          created_at: nil,
+          # Profile description
+          description: nil,
+          # Profile email (inherited from organization)
+          email: nil,
+          # Profile icon URL
+          icon: nil,
+          # Whether this profile inherits contacts from the organization
+          inherit_contacts: nil,
+          # Whether this profile inherits TCR brand from the organization
+          inherit_tcr_brand: nil,
+          # Whether this profile inherits TCR campaign from the organization
+          inherit_tcr_campaign: nil,
+          # Whether this profile inherits templates from the organization
+          inherit_templates: nil,
+          # Profile name
+          name: nil,
+          # Parent organization ID
+          organization_id: nil,
+          # Direct SMS phone number
+          sending_phone_number: nil,
+          # Reference to another profile for SMS/Telnyx configuration
+          sending_phone_number_profile_id: nil,
+          # Reference to another profile for WhatsApp configuration
+          sending_whatsapp_number_profile_id: nil,
+          # Profile short name/abbreviation. 3–11 characters: letters, numbers, and spaces
+          # only, with at least one letter.
+          short_name: nil,
+          # Profile setup status: incomplete, pending_review, approved, rejected
+          status: nil,
+          # When the profile was last updated
+          updated_at: nil,
+          # WhatsApp Business Account ID associated with this profile. Present whether the
+          # WABA is inherited from the organization or configured directly.
+          waba_id: nil,
+          # Direct WhatsApp phone number
+          whatsapp_phone_number: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              allow_contact_sharing: T::Boolean,
+              allow_number_change_during_onboarding: T.nilable(T::Boolean),
+              allow_template_sharing: T::Boolean,
+              billing_contact:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact
+                ),
+              billing_model: String,
+              brand:
+                T.nilable(Sentdm::Models::ProfileRetrieveResponse::Data::Brand),
+              created_at: Time,
+              description: T.nilable(String),
+              email: T.nilable(String),
+              icon: T.nilable(String),
+              inherit_contacts: T::Boolean,
+              inherit_tcr_brand: T::Boolean,
+              inherit_tcr_campaign: T::Boolean,
+              inherit_templates: T::Boolean,
+              name: String,
+              organization_id: T.nilable(String),
+              sending_phone_number: T.nilable(String),
+              sending_phone_number_profile_id: T.nilable(String),
+              sending_whatsapp_number_profile_id: T.nilable(String),
+              short_name: T.nilable(String),
+              status: String,
+              updated_at: T.nilable(Time),
+              waba_id: T.nilable(String),
+              whatsapp_phone_number: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class BillingContact < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::ProfileRetrieveResponse::Data::BillingContact,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :address
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :email
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :name
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :phone
+
+          # Billing contact info returned in profile responses
+          sig do
+            params(
+              address: T.nilable(String),
+              email: T.nilable(String),
+              name: T.nilable(String),
+              phone: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(address: nil, email: nil, name: nil, phone: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                address: T.nilable(String),
+                email: T.nilable(String),
+                name: T.nilable(String),
+                phone: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class Brand < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Unique identifier for the brand
+          sig { returns(T.nilable(String)) }
+          attr_reader :id
+
+          sig { params(id: String).void }
+          attr_writer :id
+
+          # Business details and address information
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business
+              )
+            )
+          end
+          attr_reader :business
+
+          sig do
+            params(
+              business:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business::OrHash
+                )
+            ).void
+          end
+          attr_writer :business
+
+          # Compliance and TCR-related information
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance
+              )
+            )
+          end
+          attr_reader :compliance
+
+          sig do
+            params(
+              compliance:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::OrHash
+                )
+            ).void
+          end
+          attr_writer :compliance
+
+          # Contact information for the brand
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact
+              )
+            )
+          end
+          attr_reader :contact
+
+          sig do
+            params(
+              contact:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact::OrHash
+                )
+            ).void
+          end
+          attr_writer :contact
+
+          # When the brand was created
+          sig { returns(T.nilable(Time)) }
+          attr_reader :created_at
+
+          sig { params(created_at: Time).void }
+          attr_writer :created_at
+
+          # CSP (Campaign Service Provider) ID
+          sig { returns(T.nilable(String)) }
+          attr_accessor :csp_id
+
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :identity_status
+
+          # Whether this brand is inherited from the parent organization
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :is_inherited
+
+          sig { params(is_inherited: T::Boolean).void }
+          attr_writer :is_inherited
+
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status::TaggedSymbol
+              )
+            )
+          end
+          attr_accessor :status
+
+          # When the brand was submitted to TCR
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :submitted_at
+
+          # Whether this brand has been submitted to TCR
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :submitted_to_tcr
+
+          sig { params(submitted_to_tcr: T::Boolean).void }
+          attr_writer :submitted_to_tcr
+
+          # TCR brand ID (populated after TCR submission)
+          sig { returns(T.nilable(String)) }
+          attr_accessor :tcr_brand_id
+
+          # Universal EIN from TCR
+          sig { returns(T.nilable(String)) }
+          attr_accessor :universal_ein
+
+          # When the brand was last updated
+          sig { returns(T.nilable(Time)) }
+          attr_accessor :updated_at
+
+          # Brand response with nested contact, business, and compliance sections — mirrors
+          # the request structure.
+          sig do
+            params(
+              id: String,
+              business:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business::OrHash
+                ),
+              compliance:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::OrHash
+                ),
+              contact:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact::OrHash
+                ),
+              created_at: Time,
+              csp_id: T.nilable(String),
+              identity_status:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::OrSymbol
+                ),
+              is_inherited: T::Boolean,
+              status:
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status::OrSymbol
+                ),
+              submitted_at: T.nilable(Time),
+              submitted_to_tcr: T::Boolean,
+              tcr_brand_id: T.nilable(String),
+              universal_ein: T.nilable(String),
+              updated_at: T.nilable(Time)
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Unique identifier for the brand
+            id: nil,
+            # Business details and address information
+            business: nil,
+            # Compliance and TCR-related information
+            compliance: nil,
+            # Contact information for the brand
+            contact: nil,
+            # When the brand was created
+            created_at: nil,
+            # CSP (Campaign Service Provider) ID
+            csp_id: nil,
+            identity_status: nil,
+            # Whether this brand is inherited from the parent organization
+            is_inherited: nil,
+            status: nil,
+            # When the brand was submitted to TCR
+            submitted_at: nil,
+            # Whether this brand has been submitted to TCR
+            submitted_to_tcr: nil,
+            # TCR brand ID (populated after TCR submission)
+            tcr_brand_id: nil,
+            # Universal EIN from TCR
+            universal_ein: nil,
+            # When the brand was last updated
+            updated_at: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                id: String,
+                business:
+                  T.nilable(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business
+                  ),
+                compliance:
+                  T.nilable(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance
+                  ),
+                contact:
+                  T.nilable(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact
+                  ),
+                created_at: Time,
+                csp_id: T.nilable(String),
+                identity_status:
+                  T.nilable(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::TaggedSymbol
+                  ),
+                is_inherited: T::Boolean,
+                status:
+                  T.nilable(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status::TaggedSymbol
+                  ),
+                submitted_at: T.nilable(Time),
+                submitted_to_tcr: T::Boolean,
+                tcr_brand_id: T.nilable(String),
+                universal_ein: T.nilable(String),
+                updated_at: T.nilable(Time)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Business < Sentdm::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Business,
+                  Sentdm::Internal::AnyHash
+                )
+              end
+
+            # City
+            sig { returns(T.nilable(String)) }
+            attr_accessor :city
+
+            # Country code (e.g., US, CA)
+            sig { returns(T.nilable(String)) }
+            attr_accessor :country
+
+            # Country where the business is registered
+            sig { returns(T.nilable(String)) }
+            attr_accessor :country_of_registration
+
+            # Business entity type
+            sig { returns(T.nilable(String)) }
+            attr_accessor :entity_type
+
+            # Legal business name
+            sig { returns(T.nilable(String)) }
+            attr_accessor :legal_name
+
+            # Postal/ZIP code
+            sig { returns(T.nilable(String)) }
+            attr_accessor :postal_code
+
+            # State/province code
+            sig { returns(T.nilable(String)) }
+            attr_accessor :state
+
+            # Street address
+            sig { returns(T.nilable(String)) }
+            attr_accessor :street
+
+            # Tax ID/EIN number
+            sig { returns(T.nilable(String)) }
+            attr_accessor :tax_id
+
+            # Type of tax ID (e.g., us_ein, ca_bn)
+            sig { returns(T.nilable(String)) }
+            attr_accessor :tax_id_type
+
+            # Business website URL
+            sig { returns(T.nilable(String)) }
+            attr_accessor :url
+
+            # Business details and address information
+            sig do
+              params(
+                city: T.nilable(String),
+                country: T.nilable(String),
+                country_of_registration: T.nilable(String),
+                entity_type: T.nilable(String),
+                legal_name: T.nilable(String),
+                postal_code: T.nilable(String),
+                state: T.nilable(String),
+                street: T.nilable(String),
+                tax_id: T.nilable(String),
+                tax_id_type: T.nilable(String),
+                url: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # City
+              city: nil,
+              # Country code (e.g., US, CA)
+              country: nil,
+              # Country where the business is registered
+              country_of_registration: nil,
+              # Business entity type
+              entity_type: nil,
+              # Legal business name
+              legal_name: nil,
+              # Postal/ZIP code
+              postal_code: nil,
+              # State/province code
+              state: nil,
+              # Street address
+              street: nil,
+              # Tax ID/EIN number
+              tax_id: nil,
+              # Type of tax ID (e.g., us_ein, ca_bn)
+              tax_id_type: nil,
+              # Business website URL
+              url: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  city: T.nilable(String),
+                  country: T.nilable(String),
+                  country_of_registration: T.nilable(String),
+                  entity_type: T.nilable(String),
+                  legal_name: T.nilable(String),
+                  postal_code: T.nilable(String),
+                  state: T.nilable(String),
+                  street: T.nilable(String),
+                  tax_id: T.nilable(String),
+                  tax_id_type: T.nilable(String),
+                  url: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          class Compliance < Sentdm::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance,
+                  Sentdm::Internal::AnyHash
+                )
+              end
+
+            sig do
+              returns(
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                )
+              )
+            end
+            attr_accessor :brand_relationship
+
+            # List of destination countries for messaging
+            sig do
+              returns(
+                T.nilable(
+                  T::Array[
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry
+                  ]
+                )
+              )
+            end
+            attr_reader :destination_countries
+
+            sig do
+              params(
+                destination_countries:
+                  T::Array[
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry::OrHash
+                  ]
+              ).void
+            end
+            attr_writer :destination_countries
+
+            # Expected daily messaging volume
+            sig { returns(T.nilable(String)) }
+            attr_accessor :expected_messaging_volume
+
+            # Whether this is a TCR (Campaign Registry) application
+            sig { returns(T.nilable(T::Boolean)) }
+            attr_reader :is_tcr_application
+
+            sig { params(is_tcr_application: T::Boolean).void }
+            attr_writer :is_tcr_application
+
+            # Additional notes about the business or use case
+            sig { returns(T.nilable(String)) }
+            attr_accessor :notes
+
+            # Phone number prefix for messaging (e.g., "+1")
+            sig { returns(T.nilable(String)) }
+            attr_accessor :phone_number_prefix
+
+            # Primary messaging use case description
+            sig { returns(T.nilable(String)) }
+            attr_accessor :primary_use_case
+
+            sig do
+              returns(
+                T.nilable(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              )
+            end
+            attr_accessor :vertical
+
+            # Compliance and TCR-related information
+            sig do
+              params(
+                brand_relationship:
+                  T.nilable(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::OrSymbol
+                  ),
+                destination_countries:
+                  T::Array[
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry::OrHash
+                  ],
+                expected_messaging_volume: T.nilable(String),
+                is_tcr_application: T::Boolean,
+                notes: T.nilable(String),
+                phone_number_prefix: T.nilable(String),
+                primary_use_case: T.nilable(String),
+                vertical:
+                  T.nilable(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::OrSymbol
+                  )
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              brand_relationship: nil,
+              # List of destination countries for messaging
+              destination_countries: nil,
+              # Expected daily messaging volume
+              expected_messaging_volume: nil,
+              # Whether this is a TCR (Campaign Registry) application
+              is_tcr_application: nil,
+              # Additional notes about the business or use case
+              notes: nil,
+              # Phone number prefix for messaging (e.g., "+1")
+              phone_number_prefix: nil,
+              # Primary messaging use case description
+              primary_use_case: nil,
+              vertical: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  brand_relationship:
+                    T.nilable(
+                      Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                    ),
+                  destination_countries:
+                    T::Array[
+                      Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry
+                    ],
+                  expected_messaging_volume: T.nilable(String),
+                  is_tcr_application: T::Boolean,
+                  notes: T.nilable(String),
+                  phone_number_prefix: T.nilable(String),
+                  primary_use_case: T.nilable(String),
+                  vertical:
+                    T.nilable(
+                      Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                    )
+                }
+              )
+            end
+            def to_hash
+            end
+
+            module BrandRelationship
+              extend Sentdm::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              BASIC_ACCOUNT =
+                T.let(
+                  :BASIC_ACCOUNT,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                )
+              MEDIUM_ACCOUNT =
+                T.let(
+                  :MEDIUM_ACCOUNT,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                )
+              LARGE_ACCOUNT =
+                T.let(
+                  :LARGE_ACCOUNT,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                )
+              SMALL_ACCOUNT =
+                T.let(
+                  :SMALL_ACCOUNT,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                )
+              KEY_ACCOUNT =
+                T.let(
+                  :KEY_ACCOUNT,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::BrandRelationship::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+
+            class DestinationCountry < Sentdm::Internal::Type::BaseModel
+              OrHash =
+                T.type_alias do
+                  T.any(
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::DestinationCountry,
+                    Sentdm::Internal::AnyHash
+                  )
+                end
+
+              sig { returns(T.nilable(String)) }
+              attr_reader :id
+
+              sig { params(id: String).void }
+              attr_writer :id
+
+              sig { returns(T.nilable(T::Boolean)) }
+              attr_reader :is_main
+
+              sig { params(is_main: T::Boolean).void }
+              attr_writer :is_main
+
+              sig do
+                params(id: String, is_main: T::Boolean).returns(
+                  T.attached_class
+                )
+              end
+              def self.new(id: nil, is_main: nil)
+              end
+
+              sig { override.returns({ id: String, is_main: T::Boolean }) }
+              def to_hash
+              end
+            end
+
+            module Vertical
+              extend Sentdm::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PROFESSIONAL =
+                T.let(
+                  :PROFESSIONAL,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              REAL_ESTATE =
+                T.let(
+                  :REAL_ESTATE,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              HEALTHCARE =
+                T.let(
+                  :HEALTHCARE,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              HUMAN_RESOURCES =
+                T.let(
+                  :HUMAN_RESOURCES,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              ENERGY =
+                T.let(
+                  :ENERGY,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              ENTERTAINMENT =
+                T.let(
+                  :ENTERTAINMENT,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              RETAIL =
+                T.let(
+                  :RETAIL,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              TRANSPORTATION =
+                T.let(
+                  :TRANSPORTATION,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              AGRICULTURE =
+                T.let(
+                  :AGRICULTURE,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              INSURANCE =
+                T.let(
+                  :INSURANCE,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              POSTAL =
+                T.let(
+                  :POSTAL,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              EDUCATION =
+                T.let(
+                  :EDUCATION,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              HOSPITALITY =
+                T.let(
+                  :HOSPITALITY,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              FINANCIAL =
+                T.let(
+                  :FINANCIAL,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              POLITICAL =
+                T.let(
+                  :POLITICAL,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              GAMBLING =
+                T.let(
+                  :GAMBLING,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              LEGAL =
+                T.let(
+                  :LEGAL,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              CONSTRUCTION =
+                T.let(
+                  :CONSTRUCTION,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              NGO =
+                T.let(
+                  :NGO,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              MANUFACTURING =
+                T.let(
+                  :MANUFACTURING,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              GOVERNMENT =
+                T.let(
+                  :GOVERNMENT,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              TECHNOLOGY =
+                T.let(
+                  :TECHNOLOGY,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+              COMMUNICATION =
+                T.let(
+                  :COMMUNICATION,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Compliance::Vertical::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class Contact < Sentdm::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Contact,
+                  Sentdm::Internal::AnyHash
+                )
+              end
+
+            # Business/brand name
+            sig { returns(T.nilable(String)) }
+            attr_accessor :business_name
+
+            # Contact email address
+            sig { returns(T.nilable(String)) }
+            attr_accessor :email
+
+            # Primary contact name
+            sig { returns(T.nilable(String)) }
+            attr_reader :name
+
+            sig { params(name: String).void }
+            attr_writer :name
+
+            # Contact phone number in E.164 format
+            sig { returns(T.nilable(String)) }
+            attr_accessor :phone
+
+            # Contact phone country code (e.g., "1" for US)
+            sig { returns(T.nilable(String)) }
+            attr_accessor :phone_country_code
+
+            # Contact's role in the business
+            sig { returns(T.nilable(String)) }
+            attr_accessor :role
+
+            # Contact information for the brand
+            sig do
+              params(
+                business_name: T.nilable(String),
+                email: T.nilable(String),
+                name: String,
+                phone: T.nilable(String),
+                phone_country_code: T.nilable(String),
+                role: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Business/brand name
+              business_name: nil,
+              # Contact email address
+              email: nil,
+              # Primary contact name
+              name: nil,
+              # Contact phone number in E.164 format
+              phone: nil,
+              # Contact phone country code (e.g., "1" for US)
+              phone_country_code: nil,
+              # Contact's role in the business
+              role: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  business_name: T.nilable(String),
+                  email: T.nilable(String),
+                  name: String,
+                  phone: T.nilable(String),
+                  phone_country_code: T.nilable(String),
+                  role: T.nilable(String)
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+
+          module IdentityStatus
+            extend Sentdm::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            SELF_DECLARED =
+              T.let(
+                :SELF_DECLARED,
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::TaggedSymbol
+              )
+            UNVERIFIED =
+              T.let(
+                :UNVERIFIED,
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::TaggedSymbol
+              )
+            VERIFIED =
+              T.let(
+                :VERIFIED,
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::TaggedSymbol
+              )
+            VETTED_VERIFIED =
+              T.let(
+                :VETTED_VERIFIED,
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::IdentityStatus::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+
+          module Status
+            extend Sentdm::Internal::Type::Enum
+
+            TaggedSymbol =
+              T.type_alias do
+                T.all(
+                  Symbol,
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            ACTIVE =
+              T.let(
+                :ACTIVE,
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status::TaggedSymbol
+              )
+            INACTIVE =
+              T.let(
+                :INACTIVE,
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status::TaggedSymbol
+              )
+            SUSPENDED =
+              T.let(
+                :SUSPENDED,
+                Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Sentdm::Models::ProfileRetrieveResponse::Data::Brand::Status::TaggedSymbol
+                ]
+              )
+            end
+            def self.values
+            end
+          end
+        end
+      end
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ProfileRetrieveResponse::Error,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Machine-readable error code (e.g., "RESOURCE_001")
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Additional validation error details (field-level errors)
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :details
+
+        # URL to documentation about this error
+        sig { returns(T.nilable(String)) }
+        attr_accessor :doc_url
+
+        # Human-readable error message
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Error information
+        sig do
+          params(
+            code: String,
+            details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            doc_url: T.nilable(String),
+            message: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Machine-readable error code (e.g., "RESOURCE_001")
+          code: nil,
+          # Additional validation error details (field-level errors)
+          details: nil,
+          # URL to documentation about this error
+          doc_url: nil,
+          # Human-readable error message
+          message: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              doc_url: T.nilable(String),
+              message: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ProfileRetrieveResponse::Meta,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for this request (for tracing and support)
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # Server timestamp when the response was generated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # API version used for this request
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Request and response metadata
+        sig do
+          params(request_id: String, timestamp: Time, version: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for this request (for tracing and support)
+          request_id: nil,
+          # Server timestamp when the response was generated
+          timestamp: nil,
+          # API version used for this request
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { request_id: String, timestamp: Time, version: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end