sentdm 0.27.0 → 0.28.0

data/rbi/sentdm/models/profile_create_params.rbi

@@ -11,28 +11,36 @@ module Sentdm
           T.any(Sentdm::ProfileCreateParams, Sentdm::Internal::AnyHash)
         end
 
-      # Whether contacts are shared across profiles (default: false)
+      # Deprecated. Accepted and ignored. Contact and template sharing between sender
+      # profiles is gone — a profile sees only what it owns, and the organization still
+      # sees all of its profiles' contacts and templates through read-time widening. The
+      # four columns behind these flags were dropped by M260720120000.
+      #
+      # Bound rather than dropped so the properties survive on the wire and in a
+      # generated client: an SDK that assigns them keeps compiling, which is the
+      # compatibility this exists for. Deliberately not refused either — a 400 would
+      # break an integration that is otherwise working, and the capability they ask for
+      # is gone either way. Same rule as SendingPhoneNumberProfileId.
+      #
+      # The read is what makes this survivable: every profile reports all four as false,
+      # so a caller that checks its own write can see it did not take. Requests carrying
+      # one are logged, so we can tell when nobody sends them any more and the fields
+      # can go for real.
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :allow_contact_sharing
-
-      sig { params(allow_contact_sharing: T::Boolean).void }
-      attr_writer :allow_contact_sharing
+      attr_accessor :allow_contact_sharing
 
-      # Whether templates are shared across profiles (default: false)
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :allow_template_sharing
-
-      sig { params(allow_template_sharing: T::Boolean).void }
-      attr_writer :allow_template_sharing
+      attr_accessor :allow_template_sharing
 
       # Billing contact information for a profile. Required when billing_model is
       # "profile" or "profile_and_organization".
-      sig { returns(T.nilable(Sentdm::BillingContactInfo)) }
+      sig { returns(T.nilable(Sentdm::ProfileCreateParams::BillingContact)) }
       attr_reader :billing_contact
 
       sig do
         params(
-          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash)
+          billing_contact:
+            T.nilable(Sentdm::ProfileCreateParams::BillingContact::OrHash)
         ).void
       end
       attr_writer :billing_contact
@@ -49,10 +57,14 @@ module Sentdm
       attr_accessor :billing_model
 
       # Brand and KYC data grouped into contact, business, and compliance sections
-      sig { returns(T.nilable(Sentdm::BrandsBrandData)) }
+      sig { returns(T.nilable(Sentdm::ProfileCreateParams::Brand)) }
       attr_reader :brand
 
-      sig { params(brand: T.nilable(Sentdm::BrandsBrandData::OrHash)).void }
+      sig do
+        params(
+          brand: T.nilable(Sentdm::ProfileCreateParams::Brand::OrHash)
+        ).void
+      end
       attr_writer :brand
 
       # Profile description (optional)
@@ -63,19 +75,17 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :icon
 
-      # Whether this profile inherits contacts from organization (default: true)
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :inherit_contacts
 
-      # Whether this profile inherits TCR brand from organization (default: true)
+      # Whether this profile inherits TCR brand from organization (default: false)
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :inherit_tcr_brand
 
-      # Whether this profile inherits TCR campaign from organization (default: true)
+      # Whether this profile inherits TCR campaign from organization (default: false)
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :inherit_tcr_campaign
 
-      # Whether this profile inherits templates from organization (default: true)
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :inherit_templates
 
@@ -86,14 +96,17 @@ module Sentdm
       sig { params(name: String).void }
       attr_writer :name
 
-      # Payment card details for a profile. Accepted when billing_model is "profile" or
-      # "profile_and_organization". These details are not stored on our servers and will
-      # be forwarded to the payment processor.
-      sig { returns(T.nilable(Sentdm::PaymentDetails)) }
+      # 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::ProfileCreateParams::PaymentDetails)) }
       attr_reader :payment_details
 
       sig do
-        params(payment_details: T.nilable(Sentdm::PaymentDetails::OrHash)).void
+        params(
+          payment_details:
+            T.nilable(Sentdm::ProfileCreateParams::PaymentDetails::OrHash)
+        ).void
       end
       attr_writer :payment_details
 
@@ -145,11 +158,12 @@ module Sentdm
 
       sig do
         params(
-          allow_contact_sharing: T::Boolean,
-          allow_template_sharing: T::Boolean,
-          billing_contact: T.nilable(Sentdm::BillingContactInfo::OrHash),
+          allow_contact_sharing: T.nilable(T::Boolean),
+          allow_template_sharing: T.nilable(T::Boolean),
+          billing_contact:
+            T.nilable(Sentdm::ProfileCreateParams::BillingContact::OrHash),
           billing_model: T.nilable(String),
-          brand: T.nilable(Sentdm::BrandsBrandData::OrHash),
+          brand: T.nilable(Sentdm::ProfileCreateParams::Brand::OrHash),
           description: T.nilable(String),
           icon: T.nilable(String),
           inherit_contacts: T.nilable(T::Boolean),
@@ -157,7 +171,8 @@ module Sentdm
           inherit_tcr_campaign: T.nilable(T::Boolean),
           inherit_templates: T.nilable(T::Boolean),
           name: String,
-          payment_details: T.nilable(Sentdm::PaymentDetails::OrHash),
+          payment_details:
+            T.nilable(Sentdm::ProfileCreateParams::PaymentDetails::OrHash),
           sandbox: T::Boolean,
           short_name: T.nilable(String),
           whatsapp_business_account:
@@ -170,9 +185,22 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
-        # Whether contacts are shared across profiles (default: false)
+        # Deprecated. Accepted and ignored. Contact and template sharing between sender
+        # profiles is gone — a profile sees only what it owns, and the organization still
+        # sees all of its profiles' contacts and templates through read-time widening. The
+        # four columns behind these flags were dropped by M260720120000.
+        #
+        # Bound rather than dropped so the properties survive on the wire and in a
+        # generated client: an SDK that assigns them keeps compiling, which is the
+        # compatibility this exists for. Deliberately not refused either — a 400 would
+        # break an integration that is otherwise working, and the capability they ask for
+        # is gone either way. Same rule as SendingPhoneNumberProfileId.
+        #
+        # The read is what makes this survivable: every profile reports all four as false,
+        # so a caller that checks its own write can see it did not take. Requests carrying
+        # one are logged, so we can tell when nobody sends them any more and the fields
+        # can go for real.
         allow_contact_sharing: nil,
-        # Whether templates are shared across profiles (default: false)
         allow_template_sharing: nil,
         # Billing contact information for a profile. Required when billing_model is
         # "profile" or "profile_and_organization".
@@ -192,19 +220,17 @@ module Sentdm
         description: nil,
         # Profile icon URL (optional)
         icon: nil,
-        # Whether this profile inherits contacts from organization (default: true)
         inherit_contacts: nil,
-        # Whether this profile inherits TCR brand from organization (default: true)
+        # Whether this profile inherits TCR brand from organization (default: false)
         inherit_tcr_brand: nil,
-        # Whether this profile inherits TCR campaign from organization (default: true)
+        # Whether this profile inherits TCR campaign from organization (default: false)
         inherit_tcr_campaign: nil,
-        # Whether this profile inherits templates from organization (default: true)
         inherit_templates: nil,
         # Profile name (required)
         name: nil,
-        # Payment card details for a profile. Accepted when billing_model is "profile" or
-        # "profile_and_organization". These details are not stored on our servers and will
-        # be forwarded to the payment processor.
+        # 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.
         payment_details: nil,
         # Sandbox flag - when true, the operation is simulated without side effects Useful
         # for testing integrations without actual execution
@@ -228,11 +254,12 @@ module Sentdm
       sig do
         override.returns(
           {
-            allow_contact_sharing: T::Boolean,
-            allow_template_sharing: T::Boolean,
-            billing_contact: T.nilable(Sentdm::BillingContactInfo),
+            allow_contact_sharing: T.nilable(T::Boolean),
+            allow_template_sharing: T.nilable(T::Boolean),
+            billing_contact:
+              T.nilable(Sentdm::ProfileCreateParams::BillingContact),
             billing_model: T.nilable(String),
-            brand: T.nilable(Sentdm::BrandsBrandData),
+            brand: T.nilable(Sentdm::ProfileCreateParams::Brand),
             description: T.nilable(String),
             icon: T.nilable(String),
             inherit_contacts: T.nilable(T::Boolean),
@@ -240,7 +267,8 @@ module Sentdm
             inherit_tcr_campaign: T.nilable(T::Boolean),
             inherit_templates: T.nilable(T::Boolean),
             name: String,
-            payment_details: T.nilable(Sentdm::PaymentDetails),
+            payment_details:
+              T.nilable(Sentdm::ProfileCreateParams::PaymentDetails),
             sandbox: T::Boolean,
             short_name: T.nilable(String),
             whatsapp_business_account:
@@ -254,6 +282,528 @@ module Sentdm
       def to_hash
       end
 
+      class BillingContact < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::ProfileCreateParams::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::ProfileCreateParams::Brand, Sentdm::Internal::AnyHash)
+          end
+
+        # Compliance and TCR information for brand registration
+        sig { returns(Sentdm::ProfileCreateParams::Brand::Compliance) }
+        attr_reader :compliance
+
+        sig do
+          params(
+            compliance: Sentdm::ProfileCreateParams::Brand::Compliance::OrHash
+          ).void
+        end
+        attr_writer :compliance
+
+        # Contact information for brand KYC
+        sig { returns(Sentdm::ProfileCreateParams::Brand::Contact) }
+        attr_reader :contact
+
+        sig do
+          params(
+            contact: Sentdm::ProfileCreateParams::Brand::Contact::OrHash
+          ).void
+        end
+        attr_writer :contact
+
+        # Business details and address for brand KYC
+        sig { returns(T.nilable(Sentdm::ProfileCreateParams::Brand::Business)) }
+        attr_reader :business
+
+        sig do
+          params(
+            business:
+              T.nilable(Sentdm::ProfileCreateParams::Brand::Business::OrHash)
+          ).void
+        end
+        attr_writer :business
+
+        # Brand and KYC data grouped into contact, business, and compliance sections
+        sig do
+          params(
+            compliance: Sentdm::ProfileCreateParams::Brand::Compliance::OrHash,
+            contact: Sentdm::ProfileCreateParams::Brand::Contact::OrHash,
+            business:
+              T.nilable(Sentdm::ProfileCreateParams::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::ProfileCreateParams::Brand::Compliance,
+              contact: Sentdm::ProfileCreateParams::Brand::Contact,
+              business: T.nilable(Sentdm::ProfileCreateParams::Brand::Business)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Compliance < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::ProfileCreateParams::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::ProfileCreateParams::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::ProfileCreateParams::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::ProfileCreateParams::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::ProfileCreateParams::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::ProfileCreateParams::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::ProfileCreateParams::Brand::Business::EntityType
+                )
+              end
+            OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+            PRIVATE_PROFIT =
+              T.let(
+                :PRIVATE_PROFIT,
+                Sentdm::ProfileCreateParams::Brand::Business::EntityType::TaggedSymbol
+              )
+            PUBLIC_PROFIT =
+              T.let(
+                :PUBLIC_PROFIT,
+                Sentdm::ProfileCreateParams::Brand::Business::EntityType::TaggedSymbol
+              )
+            NON_PROFIT =
+              T.let(
+                :NON_PROFIT,
+                Sentdm::ProfileCreateParams::Brand::Business::EntityType::TaggedSymbol
+              )
+            SOLE_PROPRIETOR =
+              T.let(
+                :SOLE_PROPRIETOR,
+                Sentdm::ProfileCreateParams::Brand::Business::EntityType::TaggedSymbol
+              )
+            GOVERNMENT =
+              T.let(
+                :GOVERNMENT,
+                Sentdm::ProfileCreateParams::Brand::Business::EntityType::TaggedSymbol
+              )
+
+            sig do
+              override.returns(
+                T::Array[
+                  Sentdm::ProfileCreateParams::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::ProfileCreateParams::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
+
       class WhatsappBusinessAccount < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do