sentdm 0.3.1 → 0.4.0

data/lib/sentdm/resources/contacts.rb

@@ -10,14 +10,16 @@ module Sentdm
       # Creates a new contact by phone number and associates it with the authenticated
       # customer.
       #
-      # @overload create(phone_number: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload create(phone_number: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param phone_number [String] Body param: Phone number of the contact to create
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseContact]
@@ -25,7 +27,7 @@ module Sentdm
       # @see Sentdm::Models::ContactCreateParams
       def create(params = {})
         parsed, options = Sentdm::ContactCreateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: "v3/contacts",
@@ -36,25 +38,32 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ContactRetrieveParams} for more details.
+      #
       # Retrieves a specific contact by their unique identifier. Returns detailed
       # contact information including phone formats, available channels, and opt-out
       # status.
       #
-      # @overload retrieve(id, request_options: {})
+      # @overload retrieve(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Contact ID from route parameter
       #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseContact]
       #
       # @see Sentdm::Models::ContactRetrieveParams
       def retrieve(id, params = {})
+        parsed, options = Sentdm::ContactRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/contacts/%1$s", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::APIResponseContact,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -64,7 +73,7 @@ module Sentdm
       # Updates a contact's default channel and/or opt-out status. Inherited contacts
       # cannot be updated.
       #
-      # @overload update(id, default_channel: nil, opt_out: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload update(id, default_channel: nil, opt_out: nil, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Path param: Contact ID from route parameter
       #
@@ -72,10 +81,12 @@ module Sentdm
       #
       # @param opt_out [Boolean, nil] Body param: Whether the contact has opted out of messaging
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseContact]
@@ -83,7 +94,7 @@ module Sentdm
       # @see Sentdm::Models::ContactUpdateParams
       def update(id, params = {})
         parsed, options = Sentdm::ContactUpdateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :patch,
           path: ["v3/contacts/%1$s", id],
@@ -94,20 +105,25 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ContactListParams} for more details.
+      #
       # Retrieves a paginated list of contacts for the authenticated customer. Supports
       # filtering by search term, channel, or phone number.
       #
-      # @overload list(page:, page_size:, channel: nil, phone: nil, search: nil, request_options: {})
+      # @overload list(page:, page_size:, channel: nil, phone: nil, search: nil, x_profile_id: nil, request_options: {})
+      #
+      # @param page [Integer] Query param: Page number (1-indexed)
       #
-      # @param page [Integer] Page number (1-indexed)
+      # @param page_size [Integer] Query param: Number of items per page
       #
-      # @param page_size [Integer]
+      # @param channel [String, nil] Query param: Optional channel filter (sms, whatsapp)
       #
-      # @param channel [String, nil] Optional channel filter (sms, whatsapp)
+      # @param phone [String, nil] Query param: Optional phone number filter (alternative to list view)
       #
-      # @param phone [String, nil] Optional phone number filter (alternative to list view)
+      # @param search [String, nil] Query param: Optional search term for filtering contacts
       #
-      # @param search [String, nil] Optional search term for filtering contacts
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -115,25 +131,32 @@ module Sentdm
       #
       # @see Sentdm::Models::ContactListParams
       def list(params)
+        query_params = [:page, :page_size, :channel, :phone, :search]
         parsed, options = Sentdm::ContactListParams.dump_request(params)
-        query = Sentdm::Internal::Util.encode_query_params(parsed)
+        query = Sentdm::Internal::Util.encode_query_params(parsed.slice(*query_params))
         @client.request(
           method: :get,
           path: "v3/contacts",
-          query: query.transform_keys(page_size: "pageSize"),
+          query: query,
+          headers: parsed.except(*query_params).transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::ContactListResponse,
           options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ContactDeleteParams} for more details.
+      #
       # Dissociates a contact from the authenticated customer. Inherited contacts cannot
       # be deleted.
       #
-      # @overload delete(id, body:, request_options: {})
+      # @overload delete(id, body:, x_profile_id: nil, request_options: {})
       #
-      # @param id [String] Contact ID from route parameter
+      # @param id [String] Path param: Contact ID from route parameter
+      #
+      # @param body [Sentdm::Models::ContactDeleteParams::Body] Body param: Request to delete/dissociate a contact
       #
-      # @param body [Sentdm::Models::ContactDeleteParams::Body] Request to delete/dissociate a contact
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -145,7 +168,7 @@ module Sentdm
         @client.request(
           method: :delete,
           path: ["v3/contacts/%1$s", id],
-          headers: {"content-type" => "*/*"},
+          headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
           body: parsed[:body],
           model: NilClass,
           options: options

data/lib/sentdm/resources/lookup.rb

@@ -3,27 +3,6 @@
 module Sentdm
   module Resources
     class Lookup
-      # Validates a phone number and retrieves formatting, country, and timezone
-      # information from the internal index. Provider-agnostic and works for all
-      # customers.
-      #
-      # @overload retrieve_phone_info(phone_number, request_options: {})
-      #
-      # @param phone_number [String]
-      # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
-      #
-      # @return [Sentdm::Models::LookupRetrievePhoneInfoResponse]
-      #
-      # @see Sentdm::Models::LookupRetrievePhoneInfoParams
-      def retrieve_phone_info(phone_number, params = {})
-        @client.request(
-          method: :get,
-          path: ["v3/lookup/number/%1$s", phone_number],
-          model: Sentdm::Models::LookupRetrievePhoneInfoResponse,
-          options: params[:request_options]
-        )
-      end
-
       # @api private
       #
       # @param client [Sentdm::Client]

data/lib/sentdm/resources/me.rb

@@ -4,11 +4,28 @@ module Sentdm
   module Resources
     # Retrieve account details
     class Me
-      # Returns the account associated with the API key. For organization API keys,
-      # returns the organization with its profiles. For profile API keys, returns the
-      # profile with its settings.
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::MeRetrieveParams} for more details.
       #
-      # @overload retrieve(request_options: {})
+      # Returns the account associated with the provided API key. The response includes
+      # account identity, contact information, messaging channel configuration, and —
+      # depending on the account type — either a list of child profiles or the profile's
+      # own settings.
+      #
+      # **Account types:**
+      #
+      # - `organization` — Has child profiles. The `profiles` array is populated.
+      # - `user` — Standalone account with no profiles.
+      # - `profile` — Child of an organization. Includes `organization_id`,
+      #   `short_name`, `status`, and `settings`.
+      #
+      # **Channels:** The `channels` object always includes `sms`, `whatsapp`, and
+      # `rcs`. Each channel has a `configured` boolean. Configured channels expose
+      # additional details such as `phone_number`.
+      #
+      # @overload retrieve(x_profile_id: nil, request_options: {})
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -16,11 +33,13 @@ module Sentdm
       #
       # @see Sentdm::Models::MeRetrieveParams
       def retrieve(params = {})
+        parsed, options = Sentdm::MeRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v3/me",
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::MeRetrieveResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 

data/lib/sentdm/resources/messages.rb

@@ -4,45 +4,59 @@ module Sentdm
   module Resources
     # Send and track SMS and WhatsApp messages
     class Messages
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::MessageRetrieveActivitiesParams} for more details.
+      #
       # Retrieves the activity log for a specific message. Activities track the message
       # lifecycle including acceptance, processing, sending, delivery, and any errors.
       #
-      # @overload retrieve_activities(id, request_options: {})
+      # @overload retrieve_activities(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Message ID from route parameter
       #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::MessageRetrieveActivitiesResponse]
       #
       # @see Sentdm::Models::MessageRetrieveActivitiesParams
       def retrieve_activities(id, params = {})
+        parsed, options = Sentdm::MessageRetrieveActivitiesParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/messages/%1$s/activities", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::MessageRetrieveActivitiesResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::MessageRetrieveStatusParams} for more details.
+      #
       # Retrieves the current status and details of a message by ID. Includes delivery
       # status, timestamps, and error information if applicable.
       #
-      # @overload retrieve_status(id, request_options: {})
+      # @overload retrieve_status(id, x_profile_id: nil, request_options: {})
       #
       # @param id [String] Message ID
       #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::MessageRetrieveStatusResponse]
       #
       # @see Sentdm::Models::MessageRetrieveStatusParams
       def retrieve_status(id, params = {})
+        parsed, options = Sentdm::MessageRetrieveStatusParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/messages/%1$s", id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::MessageRetrieveStatusResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -55,18 +69,20 @@ module Sentdm
       # Returns immediately with per-recipient message IDs for async tracking via
       # webhooks or the GET /messages/{id} endpoint.
       #
-      # @overload send_(channel: nil, template: nil, test_mode: nil, to: nil, idempotency_key: nil, request_options: {})
+      # @overload send_(channel: nil, sandbox: nil, template: nil, to: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param channel [Array<String>, nil] Body param: Channels to broadcast on, e.g. ["whatsapp", "sms"].
       #
-      # @param template [Sentdm::Models::MessageSendParams::Template] Body param: Template reference (by id or name, with optional parameters)
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param template [Sentdm::Models::MessageSendParams::Template] Body param: Template reference (by id or name, with optional parameters)
       #
       # @param to [Array<String>] Body param: List of recipient phone numbers in E.164 format (multi-recipient fan
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::MessageSendResponse]
@@ -74,7 +90,7 @@ module Sentdm
       # @see Sentdm::Models::MessageSendParams
       def send_(params = {})
         parsed, options = Sentdm::MessageSendParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: "v3/messages",

data/lib/sentdm/resources/profiles.rb

@@ -11,14 +11,51 @@ module Sentdm
       # different brands, departments, or use cases, each with their own messaging
       # configuration and settings. Requires admin role in the organization.
       #
-      # @overload create(allow_contact_sharing: nil, allow_template_sharing: nil, billing_model: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, short_name: nil, test_mode: nil, idempotency_key: nil, request_options: {})
+      # ## 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.
+      #
+      # @overload create(allow_contact_sharing: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, payment_details: nil, sandbox: nil, short_name: nil, whatsapp_business_account: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param allow_contact_sharing [Boolean] Body param: Whether contacts are shared across profiles (default: false)
       #
       # @param allow_template_sharing [Boolean] Body param: Whether templates are shared across profiles (default: false)
       #
+      # @param billing_contact [Sentdm::Models::ProfileCreateParams::BillingContact, nil] Body param: Billing contact for this profile. Required when billing_model is "pr
+      #
       # @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (d
       #
+      # @param brand [Sentdm::Models::BrandData, nil] Body param: Brand and KYC information for this profile (optional).
+      #
       # @param description [String, nil] Body param: Profile description (optional)
       #
       # @param icon [String, nil] Body param: Profile icon URL (optional)
@@ -33,12 +70,18 @@ module Sentdm
       #
       # @param name [String] Body param: Profile name (required)
       #
-      # @param short_name [String, nil] Body param: Profile short name/abbreviation (optional)
+      # @param payment_details [Sentdm::Models::ProfileCreateParams::PaymentDetails, nil] Body param: Payment card details for this profile (optional).
+      #
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param short_name [String, nil] Body param: Profile short name/abbreviation (optional). Must be 3–11 characters,
+      #
+      # @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Body param: Direct WhatsApp Business Account credentials for this profile.
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseOfProfileDetail]
@@ -46,7 +89,7 @@ module Sentdm
       # @see Sentdm::Models::ProfileCreateParams
       def create(params = {})
         parsed, options = Sentdm::ProfileCreateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: "v3/profiles",
@@ -57,23 +100,32 @@ module Sentdm
         )
       end
 
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ProfileRetrieveParams} for more details.
+      #
       # Retrieves detailed information about a specific sender profile within an
-      # organization.
+      # organization, including brand and KYC information if a brand has been
+      # configured.
       #
-      # @overload retrieve(profile_id, request_options: {})
+      # @overload retrieve(profile_id, x_profile_id: nil, request_options: {})
       #
       # @param profile_id [String]
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseOfProfileDetail]
       #
       # @see Sentdm::Models::ProfileRetrieveParams
       def retrieve(profile_id, params = {})
+        parsed, options = Sentdm::ProfileRetrieveParams.dump_request(params)
         @client.request(
           method: :get,
           path: ["v3/profiles/%1$s", profile_id],
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::APIResponseOfProfileDetail,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -83,9 +135,25 @@ module Sentdm
       # Updates a profile's configuration and settings. Requires admin role in the
       # organization. Only provided fields will be updated (partial update).
       #
-      # @overload update(path_profile_id, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_model: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, body_profile_id: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, test_mode: nil, whatsapp_phone_number: nil, idempotency_key: nil, request_options: {})
+      # ## 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.
+      #
+      # @overload update(profile_id, allow_contact_sharing: nil, allow_number_change_during_onboarding: nil, allow_template_sharing: nil, billing_contact: nil, billing_model: nil, brand: nil, description: nil, icon: nil, inherit_contacts: nil, inherit_tcr_brand: nil, inherit_tcr_campaign: nil, inherit_templates: nil, name: nil, payment_details: nil, sandbox: nil, sending_phone_number: nil, sending_phone_number_profile_id: nil, sending_whatsapp_number_profile_id: nil, short_name: nil, whatsapp_phone_number: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
-      # @param path_profile_id [String] Path param
+      # @param profile_id [String] Path param
       #
       # @param allow_contact_sharing [Boolean, nil] Body param: Whether contacts are shared across profiles (optional)
       #
@@ -93,8 +161,12 @@ module Sentdm
       #
       # @param allow_template_sharing [Boolean, nil] Body param: Whether templates are shared across profiles (optional)
       #
+      # @param billing_contact [Sentdm::Models::ProfileUpdateParams::BillingContact, nil] Body param: Billing contact for this profile. Required when billing_model is "pr
+      #
       # @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (o
       #
+      # @param brand [Sentdm::Models::BrandData, nil] Body param: Brand and KYC information for this profile (optional).
+      #
       # @param description [String, nil] Body param: Profile description (optional)
       #
       # @param icon [String, nil] Body param: Profile icon URL (optional)
@@ -109,7 +181,9 @@ module Sentdm
       #
       # @param name [String, nil] Body param: Profile name (optional)
       #
-      # @param body_profile_id [String] Body param: Profile ID from route parameter
+      # @param payment_details [Sentdm::Models::ProfileUpdateParams::PaymentDetails, nil] Body param: Payment card details for this profile (optional).
+      #
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param sending_phone_number [String, nil] Body param: Direct phone number for SMS sending (optional)
       #
@@ -117,25 +191,25 @@ module Sentdm
       #
       # @param sending_whatsapp_number_profile_id [String, nil] Body param: Reference to another profile to use for WhatsApp configuration (opti
       #
-      # @param short_name [String, nil] Body param: Profile short name/abbreviation (optional)
-      #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param short_name [String, nil] Body param: Profile short name/abbreviation (optional). Must be 3–11 characters,
       #
       # @param whatsapp_phone_number [String, nil] Body param: Direct phone number for WhatsApp sending (optional)
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Sentdm::Models::APIResponseOfProfileDetail]
       #
       # @see Sentdm::Models::ProfileUpdateParams
-      def update(path_profile_id, params = {})
+      def update(profile_id, params = {})
         parsed, options = Sentdm::ProfileUpdateParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :patch,
-          path: ["v3/profiles/%1$s", path_profile_id],
+          path: ["v3/profiles/%1$s", profile_id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
           model: Sentdm::APIResponseOfProfileDetail,
@@ -143,11 +217,17 @@ module Sentdm
         )
       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.
+      # Some parameter documentations has been truncated, see
+      # {Sentdm::Models::ProfileListParams} for more details.
+      #
+      # 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.
       #
-      # @overload list(request_options: {})
+      # @overload list(x_profile_id: nil, request_options: {})
+      #
+      # @param x_profile_id [String] Profile UUID to scope the request to a child profile. Only organization API keys
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -155,11 +235,13 @@ module Sentdm
       #
       # @see Sentdm::Models::ProfileListParams
       def list(params = {})
+        parsed, options = Sentdm::ProfileListParams.dump_request(params)
         @client.request(
           method: :get,
           path: "v3/profiles",
+          headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
           model: Sentdm::Models::ProfileListResponse,
-          options: params[:request_options]
+          options: options
         )
       end
 
@@ -169,26 +251,26 @@ module Sentdm
       # Soft deletes a sender profile. The profile will be marked as deleted but data is
       # retained. Requires admin role in the organization.
       #
-      # @overload delete(path_profile_id, body_profile_id: nil, test_mode: nil, request_options: {})
+      # @overload delete(profile_id, body:, x_profile_id: nil, request_options: {})
       #
-      # @param path_profile_id [String]
+      # @param profile_id [String] Path param
       #
-      # @param body_profile_id [String] Profile ID from route parameter
+      # @param body [Sentdm::Models::ProfileDeleteParams::Body] Body param: Request to delete a profile
       #
-      # @param test_mode [Boolean] Test mode flag - when true, the operation is simulated without side effects
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [nil]
       #
       # @see Sentdm::Models::ProfileDeleteParams
-      def delete(path_profile_id, params = {})
+      def delete(profile_id, params)
         parsed, options = Sentdm::ProfileDeleteParams.dump_request(params)
         @client.request(
           method: :delete,
-          path: ["v3/profiles/%1$s", path_profile_id],
-          headers: {"content-type" => "*/*"},
-          body: parsed,
+          path: ["v3/profiles/%1$s", profile_id],
+          headers: parsed.except(:body).transform_keys(x_profile_id: "x-profile-id"),
+          body: parsed[:body],
           model: NilClass,
           options: options
         )
@@ -216,16 +298,18 @@ module Sentdm
       #                 - If non-TCR with destination country (IsMain=true) → SUBMITTED
       #                 - Otherwise → COMPLETED
       #
-      # @overload complete(profile_id, web_hook_url:, test_mode: nil, idempotency_key: nil, request_options: {})
+      # @overload complete(profile_id, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param profile_id [String] Path param: Profile ID from route
       #
       # @param web_hook_url [String] Body param: Webhook URL to call when profile completion finishes (success or fai
       #
-      # @param test_mode [Boolean] Body param: Test mode flag - when true, the operation is simulated without side
+      # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
+      # @param x_profile_id [String] Header param: Profile UUID to scope the request to a child profile. Only organiz
+      #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
       # @return [Object]
@@ -233,7 +317,7 @@ module Sentdm
       # @see Sentdm::Models::ProfileCompleteParams
       def complete(profile_id, params)
         parsed, options = Sentdm::ProfileCompleteParams.dump_request(params)
-        header_params = {idempotency_key: "idempotency-key"}
+        header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,
           path: ["v3/profiles/%1$s/complete", profile_id],