sentdm 0.3.1 → 0.5.0

data/rbi/sentdm/models/webhook_rotate_secret_params.rbi

@@ -26,15 +26,28 @@ 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(
           id: String,
           body: Sentdm::WebhookRotateSecretParams::Body::OrHash,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, body:, idempotency_key: nil, request_options: {})
+      def self.new(
+        id:,
+        body:,
+        idempotency_key: nil,
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       sig do
@@ -43,6 +56,7 @@ module Sentdm
             id: String,
             body: Sentdm::WebhookRotateSecretParams::Body,
             idempotency_key: String,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )
@@ -50,7 +64,7 @@ module Sentdm
       def to_hash
       end
 
-      class Body < Sentdm::Models::MutationRequest
+      class Body < Sentdm::Models::MutationRequestBase
         OrHash =
           T.type_alias do
             T.any(

data/rbi/sentdm/models/webhook_test_params.rbi

@@ -20,13 +20,13 @@ module Sentdm
       sig { params(event_type: String).void }
       attr_writer :event_type
 
-      # 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 :idempotency_key
@@ -34,22 +34,30 @@ 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(
           id: String,
           event_type: String,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
         event_type: 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,
         idempotency_key: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -59,8 +67,9 @@ module Sentdm
           {
             id: String,
             event_type: String,
-            test_mode: T::Boolean,
+            sandbox: T::Boolean,
             idempotency_key: String,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )

data/rbi/sentdm/models/webhook_toggle_status_params.rbi

@@ -20,13 +20,13 @@ module Sentdm
       sig { params(is_active: T::Boolean).void }
       attr_writer :is_active
 
-      # 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 :idempotency_key
@@ -34,22 +34,30 @@ 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(
           id: String,
           is_active: T::Boolean,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
       def self.new(
         id:,
         is_active: 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,
         idempotency_key: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -59,8 +67,9 @@ module Sentdm
           {
             id: String,
             is_active: T::Boolean,
-            test_mode: T::Boolean,
+            sandbox: T::Boolean,
             idempotency_key: String,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )

data/rbi/sentdm/models/webhook_update_params.rbi

@@ -38,13 +38,13 @@ module Sentdm
       sig { params(retry_count: Integer).void }
       attr_writer :retry_count
 
-      # 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(Integer)) }
       attr_reader :timeout_seconds
@@ -58,6 +58,12 @@ 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(
           id: String,
@@ -65,9 +71,10 @@ module Sentdm
           endpoint_url: String,
           event_types: T::Array[String],
           retry_count: Integer,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           timeout_seconds: Integer,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -77,11 +84,12 @@ module Sentdm
         endpoint_url: nil,
         event_types: nil,
         retry_count: 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,
         timeout_seconds: nil,
         idempotency_key: nil,
+        x_profile_id: nil,
         request_options: {}
       )
       end
@@ -94,9 +102,10 @@ module Sentdm
             endpoint_url: String,
             event_types: T::Array[String],
             retry_count: Integer,
-            test_mode: T::Boolean,
+            sandbox: T::Boolean,
             timeout_seconds: Integer,
             idempotency_key: String,
+            x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }
         )

data/rbi/sentdm/models.rbi

@@ -5,9 +5,7 @@ module Sentdm
 
   APIMeta = Sentdm::Models::APIMeta
 
-  APIResponseBrandWithKYC = Sentdm::Models::APIResponseBrandWithKYC
-
-  APIResponseContact = Sentdm::Models::APIResponseContact
+  APIResponseOfContact = Sentdm::Models::APIResponseOfContact
 
   APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
 
@@ -17,21 +15,11 @@ module Sentdm
 
   APIResponseWebhook = Sentdm::Models::APIResponseWebhook
 
-  BrandCreateParams = Sentdm::Models::BrandCreateParams
-
-  BrandData = Sentdm::Models::BrandData
-
-  BrandDeleteParams = Sentdm::Models::BrandDeleteParams
-
-  BrandListParams = Sentdm::Models::BrandListParams
-
-  Brands = Sentdm::Models::Brands
+  BaseDto = Sentdm::Models::BaseDto
 
-  BrandUpdateParams = Sentdm::Models::BrandUpdateParams
+  BillingContactInfo = Sentdm::Models::BillingContactInfo
 
-  BrandWithKYC = Sentdm::Models::BrandWithKYC
-
-  Contact = Sentdm::Models::Contact
+  BrandsBrandData = Sentdm::Models::BrandsBrandData
 
   ContactCreateParams = Sentdm::Models::ContactCreateParams
 
@@ -39,14 +27,14 @@ module Sentdm
 
   ContactListParams = Sentdm::Models::ContactListParams
 
+  ContactResponse = Sentdm::Models::ContactResponse
+
   ContactRetrieveParams = Sentdm::Models::ContactRetrieveParams
 
   ContactUpdateParams = Sentdm::Models::ContactUpdateParams
 
   DestinationCountry = Sentdm::Models::DestinationCountry
 
-  LookupRetrievePhoneInfoParams = Sentdm::Models::LookupRetrievePhoneInfoParams
-
   MeRetrieveParams = Sentdm::Models::MeRetrieveParams
 
   MessageRetrieveActivitiesParams =
@@ -56,11 +44,15 @@ module Sentdm
 
   MessageSendParams = Sentdm::Models::MessageSendParams
 
-  MutationRequest = Sentdm::Models::MutationRequest
+  MutationRequestBase = Sentdm::Models::MutationRequestBase
+
+  NumberLookupParams = Sentdm::Models::NumberLookupParams
 
   PaginationMeta = Sentdm::Models::PaginationMeta
 
-  ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
+  PaymentDetails = Sentdm::Models::PaymentDetails
+
+  ProfileCompleteSetupParams = Sentdm::Models::ProfileCompleteSetupParams
 
   ProfileCreateParams = Sentdm::Models::ProfileCreateParams
 
@@ -72,28 +64,12 @@ module Sentdm
 
   ProfileRetrieveParams = Sentdm::Models::ProfileRetrieveParams
 
+  Profiles = Sentdm::Models::Profiles
+
   ProfileSettings = Sentdm::Models::ProfileSettings
 
   ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
 
-  SentDmServicesCommonContractsPocOsAuthenticationConfig =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig
-
-  SentDmServicesCommonContractsPocOsTemplateBody =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody
-
-  SentDmServicesCommonContractsPocOsTemplateButton =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton
-
-  SentDmServicesCommonContractsPocOsTemplateButtonProps =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps
-
-  SentDmServicesCommonContractsPocOsTemplateFooter =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter
-
-  SentDmServicesCommonContractsPocOsTemplateHeader =
-    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader
-
   TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
 
   TcrVertical = Sentdm::Models::TcrVertical

data/rbi/sentdm/resources/contacts.rbi

@@ -9,21 +9,26 @@ module Sentdm
       sig do
         params(
           phone_number: String,
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseContact)
+        ).returns(Sentdm::APIResponseOfContact)
       end
       def create(
         # Body param: Phone number of the contact to create
         phone_number: nil,
-        # 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
@@ -34,12 +39,16 @@ module Sentdm
       sig do
         params(
           id: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseContact)
+        ).returns(Sentdm::APIResponseOfContact)
       end
       def retrieve(
         # Contact 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
@@ -51,10 +60,11 @@ module Sentdm
           id: String,
           default_channel: T.nilable(String),
           opt_out: T.nilable(T::Boolean),
-          test_mode: T::Boolean,
+          sandbox: T::Boolean,
           idempotency_key: String,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseContact)
+        ).returns(Sentdm::APIResponseOfContact)
       end
       def update(
         # Path param: Contact ID from route parameter
@@ -63,13 +73,17 @@ module Sentdm
         default_channel: nil,
         # Body param: Whether the contact has opted out of messaging
         opt_out: nil,
-        # 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
@@ -83,19 +97,25 @@ module Sentdm
           channel: T.nilable(String),
           phone: T.nilable(String),
           search: T.nilable(String),
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(Sentdm::Models::ContactListResponse)
       end
       def list(
-        # Page number (1-indexed)
+        # Query param: Page number (1-indexed)
         page:,
+        # Query param: Number of items per page
         page_size:,
-        # Optional channel filter (sms, whatsapp)
+        # Query param: Optional channel filter (sms, whatsapp)
         channel: nil,
-        # Optional phone number filter (alternative to list view)
+        # Query param: Optional phone number filter (alternative to list view)
         phone: nil,
-        # Optional search term for filtering contacts
+        # Query param: Optional search term for filtering contacts
         search: 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,14 +126,19 @@ module Sentdm
         params(
           id: String,
           body: Sentdm::ContactDeleteParams::Body::OrHash,
+          x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).void
       end
       def delete(
-        # Contact ID from route parameter
+        # Path param: Contact ID from route parameter
         id,
-        # Request to delete/dissociate a contact
+        # Body param: Request to delete/dissociate a contact
         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

data/rbi/sentdm/resources/me.rbi

@@ -4,15 +4,33 @@ 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.
+      # 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`.
       sig do
-        params(request_options: Sentdm::RequestOptions::OrHash).returns(
-          Sentdm::Models::MeRetrieveResponse
-        )
+        params(
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::MeRetrieveResponse)
       end
-      def retrieve(request_options: {})
+      def retrieve(
+        # 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
 
       # @api private

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/numbers.rbi

@@ -0,0 +1,32 @@
+# typed: strong
+
+module Sentdm
+  module Resources
+    # Manage and lookup phone numbers
+    class Numbers
+      # Retrieves detailed information about a phone number including carrier, line
+      # type, porting status, and VoIP detection. Uses the customer's messaging provider
+      # for rich data, with fallback to the internal index.
+      sig do
+        params(
+          phone_number: String,
+          x_profile_id: String,
+          request_options: Sentdm::RequestOptions::OrHash
+        ).returns(Sentdm::Models::NumberLookupResponse)
+      end
+      def lookup(
+        phone_number,
+        # 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
+
+      # @api private
+      sig { params(client: Sentdm::Client).returns(T.attached_class) }
+      def self.new(client:)
+      end
+    end
+  end
+end