sentdm 0.3.1 → 0.4.0

data/rbi/sentdm/resources/messages.rbi

@@ -9,12 +9,16 @@ module Sentdm
       sig do
         params(
           id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::MessageRetrieveActivitiesResponse)
       end
       def retrieve_activities(
         # Message ID from route parameter
         id,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -24,12 +28,16 @@ module Sentdm
       sig do
         params(
           id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::MessageRetrieveStatusResponse)
       end
       def retrieve_status(
         # Message ID
         id,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -42,10 +50,11 @@ module Sentdm
       sig do
         params(
           channel: T.nilable(T::Array[String]),
+          sandbox: T::Boolean,
           template: Sentdm::MessageSendParams::Template::OrHash,
-          test_mode: T::Boolean,
           to: T::Array[String],
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::MessageSendResponse)
       end
@@ -54,11 +63,11 @@ module Sentdm
         # produces a separate message per recipient. "sent" = auto-detect, "rcs" =
         # reserved (skipped). Defaults to ["sent"] (auto-detect) if omitted.
         channel: nil,
+        # Body param: Sandbox flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        sandbox: nil,
         # Body param: Template reference (by id or name, with optional parameters)
         template: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
-        # effects Useful for testing integrations without actual execution
-        test_mode: nil,
         # Body param: List of recipient phone numbers in E.164 format (multi-recipient
         # fan-out)
         to: nil,
@@ -66,6 +75,10 @@ module Sentdm
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
         idempotency_key: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end

data/rbi/sentdm/resources/profiles.rbi

@@ -7,11 +7,47 @@ module Sentdm
       # Creates a new sender profile within an organization. Profiles represent
       # different brands, departments, or use cases, each with their own messaging
       # configuration and settings. Requires admin role in the organization.
+      #
+      # ## WhatsApp Business Account
+      #
+      # Every profile must be linked to a WhatsApp Business Account. There are two ways
+      # to do this:
+      #
+      # **1. Inherit from organization (default)** — Omit the
+      # `whatsapp_business_account` field. The profile will share the organization's
+      # WhatsApp Business Account, which must have been set up via WhatsApp Embedded
+      # Signup. This is the recommended path for most use cases.
+      #
+      # **2. Direct credentials** — Provide a `whatsapp_business_account` object with
+      # `waba_id`, `phone_number_id`, and `access_token`. Use this when the profile
+      # needs its own independent WhatsApp Business Account. Obtain these from Meta
+      # Business Manager by creating a System User with `whatsapp_business_messaging`
+      # and `whatsapp_business_management` permissions.
+      #
+      # If the `whatsapp_business_account` field is omitted and the organization has no
+      # WhatsApp Business Account configured, the request will be rejected with
+      # HTTP 422.
+      #
+      # ## Brand
+      #
+      # Include the optional `brand` field to create the brand for this profile at the
+      # same time. Cannot be used when `inherit_tcr_brand` is `true`.
+      #
+      # ## Payment Details
+      #
+      # When `billing_model` is `"profile"` or `"profile_and_organization"` you may
+      # include a `payment_details` object containing the card number, expiry (MM/YY),
+      # CVC, and billing ZIP code. Payment details are **never stored** on our servers
+      # and are forwarded directly to the payment processor. Providing `payment_details`
+      # when `billing_model` is `"organization"` is not allowed.
       sig do
         params(
           allow_contact_sharing: T::Boolean,
           allow_template_sharing: T::Boolean,
+          billing_contact:
+            T.nilable(Sentdm::ProfileCreateParams::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),
@@ -19,9 +55,16 @@ module Sentdm
           inherit_tcr_campaign: T.nilable(T::Boolean),
           inherit_templates: T.nilable(T::Boolean),
           name: String,
+          payment_details:
+            T.nilable(Sentdm::ProfileCreateParams::PaymentDetails::OrHash),
+          sandbox: T::Boolean,
           short_name: T.nilable(String),
-          test_mode: T::Boolean,
+          whatsapp_business_account:
+            T.nilable(
+              Sentdm::ProfileCreateParams::WhatsappBusinessAccount::OrHash
+            ),
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseOfProfileDetail)
       end
@@ -30,9 +73,23 @@ module Sentdm
         allow_contact_sharing: nil,
         # Body param: Whether templates are shared across profiles (default: false)
         allow_template_sharing: nil,
+        # Body param: Billing contact for this profile. Required when billing_model is
+        # "profile" or "profile_and_organization". Identifies who receives invoices and
+        # who is responsible for payment.
+        billing_contact: nil,
         # Body param: Billing model: profile, organization, or profile_and_organization
-        # (default: profile)
+        # (default: profile).
+        #
+        # - "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,
+        # Body param: Brand and KYC information for this profile (optional). When
+        # provided, creates the brand associated with this profile. Cannot be set when
+        # inherit_tcr_brand is true.
+        brand: nil,
         # Body param: Profile description (optional)
         description: nil,
         # Body param: Profile icon URL (optional)
@@ -51,39 +108,82 @@ module Sentdm
         inherit_templates: nil,
         # Body param: Profile name (required)
         name: nil,
-        # Body param: Profile short name/abbreviation (optional)
-        short_name: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
+        # Body param: 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,
+        # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
-        test_mode: nil,
+        sandbox: nil,
+        # Body param: 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,
+        # Body param: Direct WhatsApp Business Account credentials for this profile. When
+        # provided, the profile uses its own WhatsApp Business Account instead of
+        # inheriting from the organization. When omitted, the profile inherits the
+        # organization's WhatsApp Business Account (requires the organization to have
+        # completed WhatsApp Embedded Signup).
+        whatsapp_business_account: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
         idempotency_key: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
 
       # Retrieves detailed information about a specific sender profile within an
-      # organization.
+      # organization, including brand and KYC information if a brand has been
+      # configured.
       sig do
         params(
           profile_id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseOfProfileDetail)
       end
-      def retrieve(profile_id, request_options: {})
+      def retrieve(
+        profile_id,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       # Updates a profile's configuration and settings. Requires admin role in the
       # organization. Only provided fields will be updated (partial update).
+      #
+      # ## Brand Management
+      #
+      # Include the optional `brand` field to create or update the brand associated with
+      # this profile. The brand holds KYC and TCR compliance data (legal business info,
+      # contact details, messaging vertical). Once a brand has been submitted to TCR it
+      # cannot be modified. Setting `inherit_tcr_brand: true` and providing `brand` in
+      # the same request is not allowed.
+      #
+      # ## Payment Details
+      #
+      # When `billing_model` is `"profile"` or `"profile_and_organization"` you may
+      # include a `payment_details` object containing the card number, expiry (MM/YY),
+      # CVC, and billing ZIP code. Payment details are **never stored** on our servers
+      # and are forwarded directly to the payment processor. Providing `payment_details`
+      # when `billing_model` is `"organization"` is not allowed.
       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),
@@ -91,29 +191,47 @@ 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(Sentdm::APIResponseOfProfileDetail)
       end
       def update(
         # Path param
-        path_profile_id,
+        profile_id,
         # Body param: Whether contacts are shared across profiles (optional)
         allow_contact_sharing: nil,
         # Body param: Whether number changes are allowed during onboarding (optional)
         allow_number_change_during_onboarding: nil,
         # Body param: Whether templates are shared across profiles (optional)
         allow_template_sharing: nil,
+        # Body param: 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,
         # Body param: Billing model: profile, organization, or profile_and_organization
-        # (optional)
+        # (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,
+        # Body param: 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,
         # Body param: Profile description (optional)
         description: nil,
         # Body param: Profile icon URL (optional)
@@ -129,8 +247,13 @@ module Sentdm
         inherit_templates: nil,
         # Body param: Profile name (optional)
         name: nil,
-        # Body param: Profile ID from route parameter
-        body_profile_id: nil,
+        # Body param: 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,
+        # Body param: Sandbox flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        sandbox: nil,
         # Body param: Direct phone number for SMS sending (optional)
         sending_phone_number: nil,
         # Body param: Reference to another profile to use for SMS/Telnyx configuration
@@ -139,49 +262,61 @@ module Sentdm
         # Body param: Reference to another profile to use for WhatsApp configuration
         # (optional)
         sending_whatsapp_number_profile_id: nil,
-        # Body param: Profile short name/abbreviation (optional)
+        # Body param: 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,
-        # Body param: Test mode flag - when true, the operation is simulated without side
-        # effects Useful for testing integrations without actual execution
-        test_mode: nil,
         # Body param: Direct phone number for WhatsApp sending (optional)
         whatsapp_phone_number: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
         idempotency_key: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
 
-      # Retrieves all sender profiles within an organization. Profiles represent
-      # different brands, departments, or use cases within an organization, each with
-      # their own messaging configuration.
+      # Retrieves all sender profiles within an organization, including brand
+      # information for each profile. Profiles represent different brands, departments,
+      # or use cases within an organization, each with their own messaging
+      # configuration.
       sig do
-        params(request_options: Sentdm::RequestOptions::OrHash).returns(
-          Sentdm::Models::ProfileListResponse
-        )
+        params(
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::ProfileListResponse)
       end
-      def list(request_options: {})
+      def list(
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       # Soft deletes a sender profile. The profile will be marked as deleted but data is
       # retained. Requires admin role in the organization.
       sig do
         params(
-          path_profile_id: String,
-          body_profile_id: String,
-          test_mode: T::Boolean,
+          profile_id: String,
+          body: Sentdm::ProfileDeleteParams::Body::OrHash,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).void
       end
       def delete(
-        path_profile_id,
-        # Profile ID from route parameter
-        body_profile_id: nil,
-        # Test mode flag - when true, the operation is simulated without side effects
-        # Useful for testing integrations without actual execution
-        test_mode: nil,
+        # Path param
+        profile_id,
+        # Body param: Request to delete a profile
+        body:,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -208,8 +343,9 @@ module Sentdm
         params(
           profile_id: String,
           web_hook_url: String,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.anything)
       end
@@ -219,13 +355,17 @@ module Sentdm
         # Body param: Webhook URL to call when profile completion finishes (success or
         # failure)
         web_hook_url:,
-        # Body param: Test mode flag - when true, the operation is simulated without side
+        # Body param: Sandbox flag - when true, the operation is simulated without side
         # effects Useful for testing integrations without actual execution
-        test_mode: nil,
+        sandbox: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
         idempotency_key: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end

data/rbi/sentdm/resources/templates.rbi

@@ -13,9 +13,10 @@ module Sentdm
           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(Sentdm::APIResponseTemplate)
       end
@@ -30,16 +31,20 @@ module Sentdm
         # Body param: Template language code (e.g., en_US) (optional, auto-detected if not
         # provided)
         language: nil,
+        # Body param: Sandbox flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        sandbox: nil,
         # Body param: Whether to submit the template for review after creation (default:
         # false)
         submit_for_review: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
-        # effects Useful for testing integrations without actual execution
-        test_mode: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
         idempotency_key: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -49,12 +54,16 @@ module Sentdm
       sig do
         params(
           id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::APIResponseTemplate)
       end
       def retrieve(
         # Template ID from route parameter
         id,
+        # Profile UUID to scope the request to a child profile. Only organization API keys
+        # can use this header. The profile must belong to the calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -68,9 +77,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(Sentdm::APIResponseTemplate)
       end
@@ -85,16 +95,20 @@ module Sentdm
         language: nil,
         # Body param: Template display name
         name: nil,
+        # Body param: Sandbox flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        sandbox: nil,
         # Body param: Whether to submit the template for review after updating (default:
         # false)
         submit_for_review: nil,
-        # Body param: Test mode flag - when true, the operation is simulated without side
-        # effects Useful for testing integrations without actual execution
-        test_mode: nil,
         # Header param: Unique key to ensure idempotent request processing. Must be 1-255
         # alphanumeric characters, hyphens, or underscores. Responses are cached for 24
         # hours per key per customer.
         idempotency_key: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -106,21 +120,30 @@ 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::OrHash
         ).returns(Sentdm::Models::TemplateListResponse)
       end
       def list(
-        # Page number (1-indexed)
+        # Query param: Page number (1-indexed)
         page:,
+        # Query param: Number of items per page
         page_size:,
-        # Optional category filter: MARKETING, UTILITY, AUTHENTICATION
+        # Query param: Optional category filter: MARKETING, UTILITY, AUTHENTICATION
         category: nil,
-        # Optional search term for filtering templates
+        # Query param: Optional filter by welcome playground flag
+        is_welcome_playground: nil,
+        # Query param: Optional search term for filtering templates
         search: nil,
-        # Optional status filter: APPROVED, PENDING, REJECTED
+        # Query param: Optional status filter: APPROVED, PENDING, REJECTED
         status: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -131,19 +154,24 @@ module Sentdm
         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
         ).void
       end
       def delete(
-        # Template ID from route parameter
+        # Path param: Template ID from route parameter
         id,
-        # Whether to also delete the template from WhatsApp/Meta (optional, defaults to
-        # false)
+        # Body param: 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,
+        # Body param: Sandbox flag - when true, the operation is simulated without side
+        # effects Useful for testing integrations without actual execution
+        sandbox: nil,
+        # Header param: Profile UUID to scope the request to a child profile. Only
+        # organization API keys can use this header. The profile must belong to the
+        # calling organization.
+        x_profile_id: nil,
         request_options: {}
       )
       end