sentdm 0.29.0 → 0.31.0

data/rbi/sentdm/models/profile_update_params.rbi

@@ -36,13 +36,12 @@ module Sentdm
 
       # Billing contact information for a profile. Required when billing_model is
       # "profile" or "profile_and_organization".
-      sig { returns(T.nilable(Sentdm::ProfileUpdateParams::BillingContact)) }
+      sig { returns(T.nilable(Sentdm::BillingContactInfo)) }
       attr_reader :billing_contact
 
       sig do
         params(
-          billing_contact:
-            T.nilable(Sentdm::ProfileUpdateParams::BillingContact::OrHash)
+          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash)
         ).void
       end
       attr_writer :billing_contact
@@ -58,14 +57,10 @@ module Sentdm
       attr_accessor :billing_model
 
       # Brand and KYC data grouped into contact, business, and compliance sections
-      sig { returns(T.nilable(Sentdm::ProfileUpdateParams::Brand)) }
+      sig { returns(T.nilable(Sentdm::BrandsBrandData)) }
       attr_reader :brand
 
-      sig do
-        params(
-          brand: T.nilable(Sentdm::ProfileUpdateParams::Brand::OrHash)
-        ).void
-      end
+      sig { params(brand: T.nilable(Sentdm::BrandsBrandData::OrHash)).void }
       attr_writer :brand
 
       # Profile description (optional)
@@ -97,14 +92,11 @@ module Sentdm
       # Payment card details for this profile (optional). Accepted when billing_model is
       # "profile" or "profile_and_organization". Not persisted on our servers —
       # forwarded to the payment processor.
-      sig { returns(T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails)) }
+      sig { returns(T.nilable(Sentdm::PaymentDetails)) }
       attr_reader :payment_details
 
       sig do
-        params(
-          payment_details:
-            T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails::OrHash)
-        ).void
+        params(payment_details: T.nilable(Sentdm::PaymentDetails::OrHash)).void
       end
       attr_writer :payment_details
 
@@ -173,10 +165,9 @@ module Sentdm
           allow_contact_sharing: T.nilable(T::Boolean),
           allow_number_change_during_onboarding: T.nilable(T::Boolean),
           allow_template_sharing: T.nilable(T::Boolean),
-          billing_contact:
-            T.nilable(Sentdm::ProfileUpdateParams::BillingContact::OrHash),
+          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash),
           billing_model: T.nilable(String),
-          brand: T.nilable(Sentdm::ProfileUpdateParams::Brand::OrHash),
+          brand: T.nilable(Sentdm::BrandsBrandData::OrHash),
           description: T.nilable(String),
           icon: T.nilable(String),
           inherit_contacts: T.nilable(T::Boolean),
@@ -184,8 +175,7 @@ module Sentdm
           inherit_tcr_campaign: T.nilable(T::Boolean),
           inherit_templates: T.nilable(T::Boolean),
           name: T.nilable(String),
-          payment_details:
-            T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails::OrHash),
+          payment_details: T.nilable(Sentdm::PaymentDetails::OrHash),
           sandbox: T::Boolean,
           sending_phone_number: T.nilable(String),
           sending_phone_number_profile_id: T.nilable(String),
@@ -287,10 +277,9 @@ module Sentdm
             allow_contact_sharing: T.nilable(T::Boolean),
             allow_number_change_during_onboarding: T.nilable(T::Boolean),
             allow_template_sharing: T.nilable(T::Boolean),
-            billing_contact:
-              T.nilable(Sentdm::ProfileUpdateParams::BillingContact),
+            billing_contact: T.nilable(Sentdm::BillingContactInfo),
             billing_model: T.nilable(String),
-            brand: T.nilable(Sentdm::ProfileUpdateParams::Brand),
+            brand: T.nilable(Sentdm::BrandsBrandData),
             description: T.nilable(String),
             icon: T.nilable(String),
             inherit_contacts: T.nilable(T::Boolean),
@@ -298,8 +287,7 @@ module Sentdm
             inherit_tcr_campaign: T.nilable(T::Boolean),
             inherit_templates: T.nilable(T::Boolean),
             name: T.nilable(String),
-            payment_details:
-              T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails),
+            payment_details: T.nilable(Sentdm::PaymentDetails),
             sandbox: T::Boolean,
             sending_phone_number: T.nilable(String),
             sending_phone_number_profile_id: T.nilable(String),
@@ -314,528 +302,6 @@ module Sentdm
       end
       def to_hash
       end
-
-      class BillingContact < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::ProfileUpdateParams::BillingContact,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        # Email address where invoices will be sent (required)
-        sig { returns(String) }
-        attr_accessor :email
-
-        # Full name of the billing contact or company (required)
-        sig { returns(String) }
-        attr_accessor :name
-
-        # Billing address (optional). Free-form text including street, city, state, postal
-        # code, and country.
-        sig { returns(T.nilable(String)) }
-        attr_accessor :address
-
-        # Phone number for the billing contact (optional)
-        sig { returns(T.nilable(String)) }
-        attr_accessor :phone
-
-        # Billing contact information for a profile. Required when billing_model is
-        # "profile" or "profile_and_organization".
-        sig do
-          params(
-            email: String,
-            name: String,
-            address: T.nilable(String),
-            phone: T.nilable(String)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Email address where invoices will be sent (required)
-          email:,
-          # Full name of the billing contact or company (required)
-          name:,
-          # Billing address (optional). Free-form text including street, city, state, postal
-          # code, and country.
-          address: nil,
-          # Phone number for the billing contact (optional)
-          phone: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              email: String,
-              name: String,
-              address: 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::ProfileUpdateParams::Brand, Sentdm::Internal::AnyHash)
-          end
-
-        # Compliance and TCR information for brand registration
-        sig { returns(Sentdm::ProfileUpdateParams::Brand::Compliance) }
-        attr_reader :compliance
-
-        sig do
-          params(
-            compliance: Sentdm::ProfileUpdateParams::Brand::Compliance::OrHash
-          ).void
-        end
-        attr_writer :compliance
-
-        # Contact information for brand KYC
-        sig { returns(Sentdm::ProfileUpdateParams::Brand::Contact) }
-        attr_reader :contact
-
-        sig do
-          params(
-            contact: Sentdm::ProfileUpdateParams::Brand::Contact::OrHash
-          ).void
-        end
-        attr_writer :contact
-
-        # Business details and address for brand KYC
-        sig { returns(T.nilable(Sentdm::ProfileUpdateParams::Brand::Business)) }
-        attr_reader :business
-
-        sig do
-          params(
-            business:
-              T.nilable(Sentdm::ProfileUpdateParams::Brand::Business::OrHash)
-          ).void
-        end
-        attr_writer :business
-
-        # Brand and KYC data grouped into contact, business, and compliance sections
-        sig do
-          params(
-            compliance: Sentdm::ProfileUpdateParams::Brand::Compliance::OrHash,
-            contact: Sentdm::ProfileUpdateParams::Brand::Contact::OrHash,
-            business:
-              T.nilable(Sentdm::ProfileUpdateParams::Brand::Business::OrHash)
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Compliance and TCR information for brand registration
-          compliance:,
-          # Contact information for brand KYC
-          contact:,
-          # Business details and address for brand KYC
-          business: nil
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              compliance: Sentdm::ProfileUpdateParams::Brand::Compliance,
-              contact: Sentdm::ProfileUpdateParams::Brand::Contact,
-              business: T.nilable(Sentdm::ProfileUpdateParams::Brand::Business)
-            }
-          )
-        end
-        def to_hash
-        end
-
-        class Compliance < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::ProfileUpdateParams::Brand::Compliance,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          sig { returns(Sentdm::TcrBrandRelationship::OrSymbol) }
-          attr_accessor :brand_relationship
-
-          sig { returns(Sentdm::TcrVertical::OrSymbol) }
-          attr_accessor :vertical
-
-          # List of destination countries for messaging
-          sig { returns(T.nilable(T::Array[Sentdm::DestinationCountry])) }
-          attr_accessor :destination_countries
-
-          # Whether this is a TCR (Campaign Registry) application
-          sig { returns(T.nilable(T::Boolean)) }
-          attr_accessor :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
-
-          # Compliance and TCR information for brand registration
-          sig do
-            params(
-              brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
-              vertical: Sentdm::TcrVertical::OrSymbol,
-              destination_countries:
-                T.nilable(T::Array[Sentdm::DestinationCountry::OrHash]),
-              is_tcr_application: T.nilable(T::Boolean),
-              notes: T.nilable(String),
-              phone_number_prefix: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            brand_relationship:,
-            vertical:,
-            # List of destination countries for messaging
-            destination_countries: 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
-          )
-          end
-
-          sig do
-            override.returns(
-              {
-                brand_relationship: Sentdm::TcrBrandRelationship::OrSymbol,
-                vertical: Sentdm::TcrVertical::OrSymbol,
-                destination_countries:
-                  T.nilable(T::Array[Sentdm::DestinationCountry]),
-                is_tcr_application: T.nilable(T::Boolean),
-                notes: T.nilable(String),
-                phone_number_prefix: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        class Contact < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::ProfileUpdateParams::Brand::Contact,
-                Sentdm::Internal::AnyHash
-              )
-            end
-
-          # Primary contact name (required)
-          sig { returns(String) }
-          attr_accessor :name
-
-          # Business/brand name
-          sig { returns(T.nilable(String)) }
-          attr_accessor :business_name
-
-          # Contact email address
-          sig { returns(T.nilable(String)) }
-          attr_accessor :email
-
-          # 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 brand KYC
-          sig do
-            params(
-              name: String,
-              business_name: T.nilable(String),
-              email: T.nilable(String),
-              phone: T.nilable(String),
-              phone_country_code: T.nilable(String),
-              role: T.nilable(String)
-            ).returns(T.attached_class)
-          end
-          def self.new(
-            # Primary contact name (required)
-            name:,
-            # Business/brand name
-            business_name: nil,
-            # Contact email address
-            email: 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(
-              {
-                name: String,
-                business_name: T.nilable(String),
-                email: T.nilable(String),
-                phone: T.nilable(String),
-                phone_country_code: T.nilable(String),
-                role: T.nilable(String)
-              }
-            )
-          end
-          def to_hash
-          end
-        end
-
-        class Business < Sentdm::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                Sentdm::ProfileUpdateParams::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
-
-          sig do
-            returns(
-              T.nilable(
-                Sentdm::ProfileUpdateParams::Brand::Business::EntityType::OrSymbol
-              )
-            )
-          end
-          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 for brand KYC
-          sig do
-            params(
-              city: T.nilable(String),
-              country: T.nilable(String),
-              country_of_registration: T.nilable(String),
-              entity_type:
-                T.nilable(
-                  Sentdm::ProfileUpdateParams::Brand::Business::EntityType::OrSymbol
-                ),
-              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,
-            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(
-                    Sentdm::ProfileUpdateParams::Brand::Business::EntityType::OrSymbol
-                  ),
-                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
-
-          module EntityType
-            extend Sentdm::Internal::Type::Enum
-
-            TaggedSymbol =
-              T.type_alias do
-                T.all(
-                  Symbol,
-                  Sentdm::ProfileUpdateParams::Brand::Business::EntityType
-                )
-              end
-            OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-            PRIVATE_PROFIT =
-              T.let(
-                :PRIVATE_PROFIT,
-                Sentdm::ProfileUpdateParams::Brand::Business::EntityType::TaggedSymbol
-              )
-            PUBLIC_PROFIT =
-              T.let(
-                :PUBLIC_PROFIT,
-                Sentdm::ProfileUpdateParams::Brand::Business::EntityType::TaggedSymbol
-              )
-            NON_PROFIT =
-              T.let(
-                :NON_PROFIT,
-                Sentdm::ProfileUpdateParams::Brand::Business::EntityType::TaggedSymbol
-              )
-            SOLE_PROPRIETOR =
-              T.let(
-                :SOLE_PROPRIETOR,
-                Sentdm::ProfileUpdateParams::Brand::Business::EntityType::TaggedSymbol
-              )
-            GOVERNMENT =
-              T.let(
-                :GOVERNMENT,
-                Sentdm::ProfileUpdateParams::Brand::Business::EntityType::TaggedSymbol
-              )
-
-            sig do
-              override.returns(
-                T::Array[
-                  Sentdm::ProfileUpdateParams::Brand::Business::EntityType::TaggedSymbol
-                ]
-              )
-            end
-            def self.values
-            end
-          end
-        end
-      end
-
-      class PaymentDetails < Sentdm::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              Sentdm::ProfileUpdateParams::PaymentDetails,
-              Sentdm::Internal::AnyHash
-            )
-          end
-
-        # Card number (digits only, 13–19 characters)
-        sig { returns(String) }
-        attr_accessor :card_number
-
-        # Card security code (3–4 digits)
-        sig { returns(String) }
-        attr_accessor :cvc
-
-        # Card expiry date in MM/YY format (e.g. "09/27")
-        sig { returns(String) }
-        attr_accessor :expiry
-
-        # Billing ZIP / postal code associated with the card
-        sig { returns(String) }
-        attr_accessor :zip_code
-
-        # Payment card details for this profile (optional). Accepted when billing_model is
-        # "profile" or "profile_and_organization". Not persisted on our servers —
-        # forwarded to the payment processor.
-        sig do
-          params(
-            card_number: String,
-            cvc: String,
-            expiry: String,
-            zip_code: String
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Card number (digits only, 13–19 characters)
-          card_number:,
-          # Card security code (3–4 digits)
-          cvc:,
-          # Card expiry date in MM/YY format (e.g. "09/27")
-          expiry:,
-          # Billing ZIP / postal code associated with the card
-          zip_code:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              card_number: String,
-              cvc: String,
-              expiry: String,
-              zip_code: String
-            }
-          )
-        end
-        def to_hash
-        end
-      end
     end
   end
 end

data/rbi/sentdm/models/profiles/api_response_of_brand_campaign.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    module Profiles
+      class APIResponseOfBrandCampaign < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Profiles::APIResponseOfBrandCampaign,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # A 10DLC campaign registered for a brand.
+        sig { returns(T.nilable(Sentdm::Profiles::BrandCampaign)) }
+        attr_reader :data
+
+        sig do
+          params(data: T.nilable(Sentdm::Profiles::BrandCampaign::OrHash)).void
+        end
+        attr_writer :data
+
+        # Error information
+        sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+        attr_reader :error
+
+        sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+        attr_writer :error
+
+        # Request and response metadata
+        sig { returns(T.nilable(Sentdm::APIMeta)) }
+        attr_reader :meta
+
+        sig { params(meta: Sentdm::APIMeta::OrHash).void }
+        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::Profiles::BrandCampaign::OrHash),
+            error: T.nilable(Sentdm::ErrorDetail::OrHash),
+            meta: Sentdm::APIMeta::OrHash,
+            success: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # A 10DLC campaign registered for a brand.
+          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::Profiles::BrandCampaign),
+              error: T.nilable(Sentdm::ErrorDetail),
+              meta: Sentdm::APIMeta,
+              success: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end