sentdm 0.3.1 → 0.4.0

data/rbi/sentdm/models/profile_update_params.rbi

@@ -12,7 +12,7 @@ module Sentdm
         end
 
       sig { returns(String) }
-      attr_accessor :path_profile_id
+      attr_accessor :profile_id
 
       # Whether contacts are shared across profiles (optional)
       sig { returns(T.nilable(T::Boolean)) }
@@ -26,10 +26,40 @@ module Sentdm
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :allow_template_sharing
 
-      # Billing model: profile, organization, or profile_and_organization (optional)
+      # Billing contact for this profile. Required when billing_model is "profile" or
+      # "profile_and_organization" and no billing contact has been configured yet.
+      # Identifies who receives invoices and who is responsible for payment.
+      sig { returns(T.nilable(Sentdm::ProfileUpdateParams::BillingContact)) }
+      attr_reader :billing_contact
+
+      sig do
+        params(
+          billing_contact:
+            T.nilable(Sentdm::ProfileUpdateParams::BillingContact::OrHash)
+        ).void
+      end
+      attr_writer :billing_contact
+
+      # Billing model: profile, organization, or profile_and_organization (optional).
+      #
+      # - "organization": the organization's billing details are used; no profile-level
+      #   billing info needed.
+      # - "profile": the profile is billed independently; billing_contact is required.
+      # - "profile_and_organization": the profile is billed first with the organization
+      #   as fallback; billing_contact is required.
       sig { returns(T.nilable(String)) }
       attr_accessor :billing_model
 
+      # Brand and KYC information for this profile (optional). When provided, creates or
+      # updates the brand associated with this profile. Cannot be set when
+      # inherit_tcr_brand is true. Once a brand has been submitted to TCR it cannot be
+      # modified.
+      sig { returns(T.nilable(Sentdm::BrandData)) }
+      attr_reader :brand
+
+      sig { params(brand: T.nilable(Sentdm::BrandData::OrHash)).void }
+      attr_writer :brand
+
       # Profile description (optional)
       sig { returns(T.nilable(String)) }
       attr_accessor :description
@@ -58,12 +88,27 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
-      # Profile ID from route parameter
-      sig { returns(T.nilable(String)) }
-      attr_reader :body_profile_id
+      # 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)) }
+      attr_reader :payment_details
 
-      sig { params(body_profile_id: String).void }
-      attr_writer :body_profile_id
+      sig do
+        params(
+          payment_details:
+            T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails::OrHash)
+        ).void
+      end
+      attr_writer :payment_details
+
+      # Sandbox flag - when true, the operation is simulated without side effects Useful
+      # for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :sandbox
+
+      sig { params(sandbox: T::Boolean).void }
+      attr_writer :sandbox
 
       # Direct phone number for SMS sending (optional)
       sig { returns(T.nilable(String)) }
@@ -77,18 +122,12 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_whatsapp_number_profile_id
 
-      # Profile short name/abbreviation (optional)
+      # Profile short name/abbreviation (optional). Must be 3–11 characters, contain
+      # only letters, numbers, and spaces, and include at least one letter. Example:
+      # "SALES", "Mkt 2", "Support1".
       sig { returns(T.nilable(String)) }
       attr_accessor :short_name
 
-      # Test mode flag - when true, the operation is simulated without side effects
-      # Useful for testing integrations without actual execution
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :test_mode
-
-      sig { params(test_mode: T::Boolean).void }
-      attr_writer :test_mode
-
       # Direct phone number for WhatsApp sending (optional)
       sig { returns(T.nilable(String)) }
       attr_accessor :whatsapp_phone_number
@@ -99,13 +138,22 @@ module Sentdm
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_profile_id
+
+      sig { params(x_profile_id: String).void }
+      attr_writer :x_profile_id
+
       sig do
         params(
-          path_profile_id: String,
+          profile_id: String,
           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_model: T.nilable(String),
+          brand: T.nilable(Sentdm::BrandData::OrHash),
           description: T.nilable(String),
           icon: T.nilable(String),
           inherit_contacts: T.nilable(T::Boolean),
@@ -113,27 +161,44 @@ module Sentdm
           inherit_tcr_campaign: T.nilable(T::Boolean),
           inherit_templates: T.nilable(T::Boolean),
           name: T.nilable(String),
-          body_profile_id: String,
+          payment_details:
+            T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails::OrHash),
+          sandbox: T::Boolean,
           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),
-          test_mode: T::Boolean,
           whatsapp_phone_number: T.nilable(String),
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
-        path_profile_id:,
+        profile_id:,
         # Whether contacts are shared across profiles (optional)
         allow_contact_sharing: nil,
         # Whether number changes are allowed during onboarding (optional)
         allow_number_change_during_onboarding: nil,
         # Whether templates are shared across profiles (optional)
         allow_template_sharing: nil,
-        # Billing model: profile, organization, or profile_and_organization (optional)
+        # Billing contact for this profile. Required when billing_model is "profile" or
+        # "profile_and_organization" and no billing contact has been configured yet.
+        # Identifies who receives invoices and who is responsible for payment.
+        billing_contact: nil,
+        # Billing model: profile, organization, or profile_and_organization (optional).
+        #
+        # - "organization": the organization's billing details are used; no profile-level
+        #   billing info needed.
+        # - "profile": the profile is billed independently; billing_contact is required.
+        # - "profile_and_organization": the profile is billed first with the organization
+        #   as fallback; billing_contact is required.
         billing_model: nil,
+        # Brand and KYC information for this profile (optional). When provided, creates or
+        # updates the brand associated with this profile. Cannot be set when
+        # inherit_tcr_brand is true. Once a brand has been submitted to TCR it cannot be
+        # modified.
+        brand: nil,
         # Profile description (optional)
         description: nil,
         # Profile icon URL (optional)
@@ -148,22 +213,27 @@ module Sentdm
         inherit_templates: nil,
         # Profile name (optional)
         name: nil,
-        # Profile ID from route parameter
-        body_profile_id: nil,
+        # 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
+        sandbox: nil,
         # Direct phone number for SMS sending (optional)
         sending_phone_number: nil,
         # Reference to another profile to use for SMS/Telnyx configuration (optional)
         sending_phone_number_profile_id: nil,
         # Reference to another profile to use for WhatsApp configuration (optional)
         sending_whatsapp_number_profile_id: nil,
-        # Profile short name/abbreviation (optional)
+        # Profile short name/abbreviation (optional). Must be 3–11 characters, contain
+        # only letters, numbers, and spaces, and include at least one letter. Example:
+        # "SALES", "Mkt 2", "Support1".
         short_name: nil,
-        # Test mode flag - when true, the operation is simulated without side effects
-        # Useful for testing integrations without actual execution
-        test_mode: nil,
         # Direct phone number for WhatsApp sending (optional)
         whatsapp_phone_number: nil,
         idempotency_key: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -171,11 +241,14 @@ module Sentdm
       sig do
         override.returns(
           {
-            path_profile_id: String,
+            profile_id: String,
             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_model: T.nilable(String),
+            brand: T.nilable(Sentdm::BrandData),
             description: T.nilable(String),
             icon: T.nilable(String),
             inherit_contacts: T.nilable(T::Boolean),
@@ -183,20 +256,148 @@ module Sentdm
             inherit_tcr_campaign: T.nilable(T::Boolean),
             inherit_templates: T.nilable(T::Boolean),
             name: T.nilable(String),
-            body_profile_id: String,
+            payment_details:
+              T.nilable(Sentdm::ProfileUpdateParams::PaymentDetails),
+            sandbox: T::Boolean,
             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),
-            test_mode: T::Boolean,
             whatsapp_phone_number: T.nilable(String),
             idempotency_key: String,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )
       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 for this profile. Required when billing_model is "profile" or
+        # "profile_and_organization" and no billing contact has been configured yet.
+        # Identifies who receives invoices and who is responsible for payment.
+        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 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/template_create_params.rbi

@@ -31,6 +31,14 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :language
 
+      # Sandbox flag - when true, the operation is simulated without side effects Useful
+      # for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :sandbox
+
+      sig { params(sandbox: T::Boolean).void }
+      attr_writer :sandbox
+
       # Whether to submit the template for review after creation (default: false)
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :submit_for_review
@@ -38,29 +46,28 @@ module Sentdm
       sig { params(submit_for_review: T::Boolean).void }
       attr_writer :submit_for_review
 
-      # Test mode flag - when true, the operation is simulated without side effects
-      # Useful for testing integrations without actual execution
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :test_mode
-
-      sig { params(test_mode: T::Boolean).void }
-      attr_writer :test_mode
-
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_profile_id
+
+      sig { params(x_profile_id: String).void }
+      attr_writer :x_profile_id
+
       sig do
         params(
           category: T.nilable(String),
           creation_source: T.nilable(String),
           definition: Sentdm::TemplateDefinition::OrHash,
           language: T.nilable(String),
+          sandbox: T::Boolean,
           submit_for_review: T::Boolean,
-          test_mode: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -74,12 +81,13 @@ module Sentdm
         definition: nil,
         # Template language code (e.g., en_US) (optional, auto-detected if not provided)
         language: nil,
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sandbox: nil,
         # Whether to submit the template for review after creation (default: false)
         submit_for_review: nil,
-        # Test mode flag - when true, the operation is simulated without side effects
-        # Useful for testing integrations without actual execution
-        test_mode: nil,
         idempotency_key: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -91,9 +99,10 @@ module Sentdm
             creation_source: T.nilable(String),
             definition: Sentdm::TemplateDefinition,
             language: T.nilable(String),
+            sandbox: T::Boolean,
             submit_for_review: T::Boolean,
-            test_mode: T::Boolean,
             idempotency_key: String,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )

data/rbi/sentdm/models/template_delete_params.rbi

@@ -19,19 +19,26 @@ module Sentdm
       sig { returns(T.nilable(T::Boolean)) }
       attr_accessor :delete_from_meta
 
-      # Test mode flag - when true, the operation is simulated without side effects
-      # Useful for testing integrations without actual execution
+      # Sandbox flag - when true, the operation is simulated without side effects Useful
+      # for testing integrations without actual execution
       sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :test_mode
+      attr_reader :sandbox
 
-      sig { params(test_mode: T::Boolean).void }
-      attr_writer :test_mode
+      sig { params(sandbox: T::Boolean).void }
+      attr_writer :sandbox
+
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_profile_id
+
+      sig { params(x_profile_id: String).void }
+      attr_writer :x_profile_id
 
       sig do
         params(
           id: String,
           delete_from_meta: T.nilable(T::Boolean),
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -40,9 +47,10 @@ module Sentdm
         # Whether to also delete the template from WhatsApp/Meta (optional, defaults to
         # false)
         delete_from_meta: nil,
-        # Test mode flag - when true, the operation is simulated without side effects
-        # Useful for testing integrations without actual execution
-        test_mode: nil,
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sandbox: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -52,7 +60,8 @@ module Sentdm
           {
             id: String,
             delete_from_meta: T.nilable(T::Boolean),
-            test_mode: T::Boolean,
+            sandbox: T::Boolean,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )

data/rbi/sentdm/models/template_list_params.rbi

@@ -15,6 +15,7 @@ module Sentdm
       sig { returns(Integer) }
       attr_accessor :page
 
+      # Number of items per page
       sig { returns(Integer) }
       attr_accessor :page_size
 
@@ -22,6 +23,10 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :category
 
+      # Optional filter by welcome playground flag
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_accessor :is_welcome_playground
+
       # Optional search term for filtering templates
       sig { returns(T.nilable(String)) }
       attr_accessor :search
@@ -30,26 +35,38 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :status
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_profile_id
+
+      sig { params(x_profile_id: String).void }
+      attr_writer :x_profile_id
+
       sig do
         params(
           page: Integer,
           page_size: Integer,
           category: T.nilable(String),
+          is_welcome_playground: T.nilable(T::Boolean),
           search: T.nilable(String),
           status: T.nilable(String),
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         # Page number (1-indexed)
         page:,
+        # Number of items per page
         page_size:,
         # Optional category filter: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
+        # Optional filter by welcome playground flag
+        is_welcome_playground: nil,
         # Optional search term for filtering templates
         search: nil,
         # Optional status filter: APPROVED, PENDING, REJECTED
         status: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -60,8 +77,10 @@ module Sentdm
             page: Integer,
             page_size: Integer,
             category: T.nilable(String),
+            is_welcome_playground: T.nilable(T::Boolean),
             search: T.nilable(String),
             status: T.nilable(String),
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )

data/rbi/sentdm/models/template_retrieve_params.rbi

@@ -14,18 +14,29 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :id
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_profile_id
+
+      sig { params(x_profile_id: String).void }
+      attr_writer :x_profile_id
+
       sig do
         params(
           id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, request_options: {})
+      def self.new(id:, x_profile_id: nil, request_options: {})
       end
 
       sig do
         override.returns(
-          { id: String, request_options: Sentdm::RequestOptions }
+          {
+            id: String,
+            x_profile_id: String,
+            request_options: Sentdm::RequestOptions
+          }
         )
       end
       def to_hash

data/rbi/sentdm/models/template_update_params.rbi

@@ -35,6 +35,14 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :name
 
+      # Sandbox flag - when true, the operation is simulated without side effects Useful
+      # for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :sandbox
+
+      sig { params(sandbox: T::Boolean).void }
+      attr_writer :sandbox
+
       # Whether to submit the template for review after updating (default: false)
       sig { returns(T.nilable(T::Boolean)) }
       attr_reader :submit_for_review
@@ -42,20 +50,18 @@ module Sentdm
       sig { params(submit_for_review: T::Boolean).void }
       attr_writer :submit_for_review
 
-      # Test mode flag - when true, the operation is simulated without side effects
-      # Useful for testing integrations without actual execution
-      sig { returns(T.nilable(T::Boolean)) }
-      attr_reader :test_mode
-
-      sig { params(test_mode: T::Boolean).void }
-      attr_writer :test_mode
-
       sig { returns(T.nilable(String)) }
       attr_reader :idempotency_key
 
       sig { params(idempotency_key: String).void }
       attr_writer :idempotency_key
 
+      sig { returns(T.nilable(String)) }
+      attr_reader :x_profile_id
+
+      sig { params(x_profile_id: String).void }
+      attr_writer :x_profile_id
+
       sig do
         params(
           id: String,
@@ -63,9 +69,10 @@ module Sentdm
           definition: T.nilable(Sentdm::TemplateDefinition::OrHash),
           language: T.nilable(String),
           name: T.nilable(String),
+          sandbox: T::Boolean,
           submit_for_review: T::Boolean,
-          test_mode: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -79,12 +86,13 @@ module Sentdm
         language: nil,
         # Template display name
         name: nil,
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sandbox: nil,
         # Whether to submit the template for review after updating (default: false)
         submit_for_review: nil,
-        # Test mode flag - when true, the operation is simulated without side effects
-        # Useful for testing integrations without actual execution
-        test_mode: nil,
         idempotency_key: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -97,9 +105,10 @@ module Sentdm
             definition: T.nilable(Sentdm::TemplateDefinition),
             language: T.nilable(String),
             name: T.nilable(String),
+            sandbox: T::Boolean,
             submit_for_review: T::Boolean,
-            test_mode: T::Boolean,
             idempotency_key: String,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )