sentdm 0.3.1 → 0.4.0

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,8 +5,6 @@ module Sentdm
 
   APIMeta = Sentdm::Models::APIMeta
 
-  APIResponseBrandWithKYC = Sentdm::Models::APIResponseBrandWithKYC
-
   APIResponseContact = Sentdm::Models::APIResponseContact
 
   APIResponseOfProfileDetail = Sentdm::Models::APIResponseOfProfileDetail
@@ -17,18 +15,10 @@ 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
 
-  BrandUpdateParams = Sentdm::Models::BrandUpdateParams
-
   BrandWithKYC = Sentdm::Models::BrandWithKYC
 
   Contact = Sentdm::Models::Contact
@@ -45,8 +35,6 @@ module Sentdm
 
   DestinationCountry = Sentdm::Models::DestinationCountry
 
-  LookupRetrievePhoneInfoParams = Sentdm::Models::LookupRetrievePhoneInfoParams
-
   MeRetrieveParams = Sentdm::Models::MeRetrieveParams
 
   MessageRetrieveActivitiesParams =

data/rbi/sentdm/resources/brands/campaigns.rbi

@@ -3,102 +3,7 @@
 module Sentdm
   module Resources
     class Brands
-      # Register and manage 10DLC brands for SMS compliance
       class Campaigns
-        # Creates a new campaign scoped under a specific brand. The campaign is linked to
-        # the specified brand. Each campaign must include at least one use case with
-        # sample messages.
-        sig do
-          params(
-            brand_id: String,
-            campaign: Sentdm::Brands::CampaignData::OrHash,
-            test_mode: T::Boolean,
-            idempotency_key: String,
-            request_options: Sentdm::RequestOptions::OrHash
-          ).returns(Sentdm::Brands::APIResponseTcrCampaignWithUseCases)
-        end
-        def create(
-          # Path param: Brand ID from route
-          brand_id,
-          # Body param: Campaign data
-          campaign:,
-          # 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,
-          request_options: {}
-        )
-        end
-
-        # Updates an existing campaign scoped under a specific brand. Cannot update
-        # campaigns that have already been submitted to TCR.
-        sig do
-          params(
-            campaign_id: String,
-            brand_id: String,
-            campaign: Sentdm::Brands::CampaignData::OrHash,
-            test_mode: T::Boolean,
-            idempotency_key: String,
-            request_options: Sentdm::RequestOptions::OrHash
-          ).returns(Sentdm::Brands::APIResponseTcrCampaignWithUseCases)
-        end
-        def update(
-          # Path param: Campaign ID from route
-          campaign_id,
-          # Path param: Brand ID from route
-          brand_id:,
-          # Body param: Campaign data
-          campaign:,
-          # 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,
-          request_options: {}
-        )
-        end
-
-        # Retrieves all campaigns linked to a specific brand, including their use cases
-        # and sample messages.
-        sig do
-          params(
-            brand_id: String,
-            request_options: Sentdm::RequestOptions::OrHash
-          ).returns(Sentdm::Models::Brands::CampaignListResponse)
-        end
-        def list(
-          # Brand ID from route
-          brand_id,
-          request_options: {}
-        )
-        end
-
-        # Deletes a campaign by ID within a specific brand. The brand must belong to the
-        # authenticated customer.
-        sig do
-          params(
-            campaign_id: String,
-            brand_id: String,
-            body: Sentdm::Brands::CampaignDeleteParams::Body::OrHash,
-            request_options: Sentdm::RequestOptions::OrHash
-          ).void
-        end
-        def delete(
-          # Path param: Campaign ID from route parameter
-          campaign_id,
-          # Path param: Brand ID from route parameter
-          brand_id:,
-          # Body param: Request to delete a campaign from a brand
-          body:,
-          request_options: {}
-        )
-        end
-
         # @api private
         sig { params(client: Sentdm::Client).returns(T.attached_class) }
         def self.new(client:)

data/rbi/sentdm/resources/brands.rbi

@@ -2,90 +2,10 @@
 
 module Sentdm
   module Resources
-    # Register and manage 10DLC brands for SMS compliance
     class Brands
-      # Register and manage 10DLC brands for SMS compliance
       sig { returns(Sentdm::Resources::Brands::Campaigns) }
       attr_reader :campaigns
 
-      # Creates a new brand and associated information. This endpoint automatically sets
-      # inheritTcrBrand=false when a brand is created.
-      sig do
-        params(
-          brand: Sentdm::BrandData::OrHash,
-          test_mode: T::Boolean,
-          idempotency_key: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseBrandWithKYC)
-      end
-      def create(
-        # Body param: Brand and KYC information
-        brand:,
-        # 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,
-        request_options: {}
-      )
-      end
-
-      # Updates an existing brand and its associated information. Cannot update brands
-      # that have already been submitted to TCR or inherited brands.
-      sig do
-        params(
-          brand_id: String,
-          brand: Sentdm::BrandData::OrHash,
-          test_mode: T::Boolean,
-          idempotency_key: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::APIResponseBrandWithKYC)
-      end
-      def update(
-        # Path param: Brand ID from route
-        brand_id,
-        # Body param: Brand and KYC information
-        brand:,
-        # 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,
-        request_options: {}
-      )
-      end
-
-      # Retrieves all brands for the authenticated customer with information in a
-      # flattened structure. Includes inherited brands if inheritTcrBrand=true.
-      sig do
-        params(request_options: Sentdm::RequestOptions::OrHash).returns(
-          Sentdm::Models::BrandListResponse
-        )
-      end
-      def list(request_options: {})
-      end
-
-      # Delete a brand by ID. The brand must belong to the authenticated customer.
-      sig do
-        params(
-          brand_id: String,
-          body: Sentdm::BrandDeleteParams::Body::OrHash,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).void
-      end
-      def delete(
-        # Brand ID from route parameter
-        brand_id,
-        # Request to delete a brand
-        body:,
-        request_options: {}
-      )
-      end
-
       # @api private
       sig { params(client: Sentdm::Client).returns(T.attached_class) }
       def self.new(client:)

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)
       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)
       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,8 +60,9 @@ 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)
       end
@@ -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/lookup.rbi

@@ -3,18 +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.
-      sig do
-        params(
-          phone_number: String,
-          request_options: Sentdm::RequestOptions::OrHash
-        ).returns(Sentdm::Models::LookupRetrievePhoneInfoResponse)
-      end
-      def retrieve_phone_info(phone_number, request_options: {})
-      end
-
       # @api private
       sig { params(client: Sentdm::Client).returns(T.attached_class) }
       def self.new(client:)

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