sentdm 0.18.0 → 0.19.0

data/lib/sentdm/resources/users.rb

@@ -18,7 +18,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::APIResponseOfUser]
+      # @return [Sentdm::Models::UserRetrieveResponse]
       #
       # @see Sentdm::Models::UserRetrieveParams
       def retrieve(user_id, params = {})
@@ -27,7 +27,7 @@ module Sentdm
           method: :get,
           path: ["v3/users/%1$s", user_id],
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::APIResponseOfUser,
+          model: Sentdm::Models::UserRetrieveResponse,
           options: options
         )
       end
@@ -82,7 +82,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::APIResponseOfUser]
+      # @return [Sentdm::Models::UserInviteResponse]
       #
       # @see Sentdm::Models::UserInviteParams
       def invite(params = {})
@@ -93,7 +93,7 @@ module Sentdm
           path: "v3/users",
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::APIResponseOfUser,
+          model: Sentdm::Models::UserInviteResponse,
           options: options
         )
       end
@@ -150,7 +150,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::APIResponseOfUser]
+      # @return [Sentdm::Models::UserUpdateRoleResponse]
       #
       # @see Sentdm::Models::UserUpdateRoleParams
       def update_role(user_id, params = {})
@@ -161,7 +161,7 @@ module Sentdm
           path: ["v3/users/%1$s", user_id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::APIResponseOfUser,
+          model: Sentdm::Models::UserUpdateRoleResponse,
           options: options
         )
       end

data/lib/sentdm/resources/webhooks.rb

@@ -31,7 +31,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::APIResponseWebhook]
+      # @return [Sentdm::Models::WebhookCreateResponse]
       #
       # @see Sentdm::Models::WebhookCreateParams
       def create(params = {})
@@ -42,7 +42,7 @@ module Sentdm
           path: "v3/webhooks",
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::APIResponseWebhook,
+          model: Sentdm::Models::WebhookCreateResponse,
           options: options
         )
       end
@@ -60,7 +60,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::APIResponseWebhook]
+      # @return [Sentdm::Models::WebhookRetrieveResponse]
       #
       # @see Sentdm::Models::WebhookRetrieveParams
       def retrieve(id, params = {})
@@ -69,7 +69,7 @@ module Sentdm
           method: :get,
           path: ["v3/webhooks/%1$s", id],
           headers: parsed.transform_keys(x_profile_id: "x-profile-id"),
-          model: Sentdm::APIResponseWebhook,
+          model: Sentdm::Models::WebhookRetrieveResponse,
           options: options
         )
       end
@@ -103,7 +103,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::APIResponseWebhook]
+      # @return [Sentdm::Models::WebhookUpdateResponse]
       #
       # @see Sentdm::Models::WebhookUpdateParams
       def update(id, params = {})
@@ -114,7 +114,7 @@ module Sentdm
           path: ["v3/webhooks/%1$s", id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::APIResponseWebhook,
+          model: Sentdm::Models::WebhookUpdateResponse,
           options: options
         )
       end
@@ -331,7 +331,7 @@ module Sentdm
       #
       # @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}, nil]
       #
-      # @return [Sentdm::Models::APIResponseWebhook]
+      # @return [Sentdm::Models::WebhookToggleStatusResponse]
       #
       # @see Sentdm::Models::WebhookToggleStatusParams
       def toggle_status(id, params = {})
@@ -342,7 +342,7 @@ module Sentdm
           path: ["v3/webhooks/%1$s/toggle-status", id],
           headers: parsed.slice(*header_params.keys).transform_keys(header_params),
           body: parsed.except(*header_params.keys),
-          model: Sentdm::APIResponseWebhook,
+          model: Sentdm::Models::WebhookToggleStatusResponse,
           options: options
         )
       end

data/lib/sentdm/version.rb

@@ -1,5 +1,5 @@
 # frozen_string_literal: true
 
 module Sentdm
-  VERSION = "0.18.0"
+  VERSION = "0.19.0"
 end

data/lib/sentdm.rb

@@ -52,25 +52,15 @@ require_relative "sentdm/errors"
 require_relative "sentdm/internal/transport/base_client"
 require_relative "sentdm/internal/transport/pooled_net_requester"
 require_relative "sentdm/client"
-require_relative "sentdm/models/mutation_request"
-require_relative "sentdm/models/profiles/base_dto"
-require_relative "sentdm/models/api_meta"
-require_relative "sentdm/models/api_response_of_contact"
-require_relative "sentdm/models/api_response_of_profile_detail"
-require_relative "sentdm/models/api_response_of_user"
-require_relative "sentdm/models/api_response_template"
-require_relative "sentdm/models/api_response_webhook"
-require_relative "sentdm/models/billing_contact_info"
-require_relative "sentdm/models/brands_brand_data"
 require_relative "sentdm/models/contact_create_params"
+require_relative "sentdm/models/contact_create_response"
 require_relative "sentdm/models/contact_delete_params"
 require_relative "sentdm/models/contact_list_params"
 require_relative "sentdm/models/contact_list_response"
-require_relative "sentdm/models/contact_response"
 require_relative "sentdm/models/contact_retrieve_params"
+require_relative "sentdm/models/contact_retrieve_response"
 require_relative "sentdm/models/contact_update_params"
-require_relative "sentdm/models/destination_country"
-require_relative "sentdm/models/error_detail"
+require_relative "sentdm/models/contact_update_response"
 require_relative "sentdm/models/me_retrieve_params"
 require_relative "sentdm/models/me_retrieve_response"
 require_relative "sentdm/models/message_retrieve_activities_params"
@@ -81,73 +71,61 @@ require_relative "sentdm/models/message_send_params"
 require_relative "sentdm/models/message_send_response"
 require_relative "sentdm/models/number_lookup_params"
 require_relative "sentdm/models/number_lookup_response"
-require_relative "sentdm/models/pagination_meta"
-require_relative "sentdm/models/payment_details"
 require_relative "sentdm/models/profile_complete_params"
 require_relative "sentdm/models/profile_complete_response"
 require_relative "sentdm/models/profile_create_params"
+require_relative "sentdm/models/profile_create_response"
 require_relative "sentdm/models/profile_delete_params"
-require_relative "sentdm/models/profile_detail"
 require_relative "sentdm/models/profile_list_params"
 require_relative "sentdm/models/profile_list_response"
 require_relative "sentdm/models/profile_retrieve_params"
-require_relative "sentdm/models/profiles/api_response_of_tcr_campaign_with_use_cases"
+require_relative "sentdm/models/profile_retrieve_response"
 require_relative "sentdm/models/profiles/campaign_create_params"
-require_relative "sentdm/models/profiles/campaign_data"
+require_relative "sentdm/models/profiles/campaign_create_response"
 require_relative "sentdm/models/profiles/campaign_delete_params"
 require_relative "sentdm/models/profiles/campaign_list_params"
 require_relative "sentdm/models/profiles/campaign_list_response"
 require_relative "sentdm/models/profiles/campaign_update_params"
-require_relative "sentdm/models/profiles/messaging_use_case_us"
-require_relative "sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data"
-require_relative "sentdm/models/profiles/tcr_campaign_with_use_cases"
-require_relative "sentdm/models/profile_settings"
+require_relative "sentdm/models/profiles/campaign_update_response"
 require_relative "sentdm/models/profile_update_params"
-require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config"
-require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_body"
-require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_button"
-require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props"
-require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer"
-require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_header"
-require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info"
-require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info"
-require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info"
-require_relative "sentdm/models/tcr_brand_relationship"
-require_relative "sentdm/models/tcr_vertical"
-require_relative "sentdm/models/template"
-require_relative "sentdm/models/template_body_content"
+require_relative "sentdm/models/profile_update_response"
 require_relative "sentdm/models/template_create_params"
-require_relative "sentdm/models/template_definition"
+require_relative "sentdm/models/template_create_response"
 require_relative "sentdm/models/template_delete_params"
 require_relative "sentdm/models/template_list_params"
 require_relative "sentdm/models/template_list_response"
 require_relative "sentdm/models/template_retrieve_params"
+require_relative "sentdm/models/template_retrieve_response"
 require_relative "sentdm/models/template_update_params"
-require_relative "sentdm/models/template_variable"
+require_relative "sentdm/models/template_update_response"
 require_relative "sentdm/models/user_invite_params"
+require_relative "sentdm/models/user_invite_response"
 require_relative "sentdm/models/user_list_params"
 require_relative "sentdm/models/user_list_response"
 require_relative "sentdm/models/user_remove_params"
-require_relative "sentdm/models/user_response"
 require_relative "sentdm/models/user_retrieve_params"
+require_relative "sentdm/models/user_retrieve_response"
 require_relative "sentdm/models/user_update_role_params"
+require_relative "sentdm/models/user_update_role_response"
 require_relative "sentdm/models/webhook_create_params"
+require_relative "sentdm/models/webhook_create_response"
 require_relative "sentdm/models/webhook_delete_params"
-require_relative "sentdm/models/webhook_event_type"
 require_relative "sentdm/models/webhook_list_events_params"
 require_relative "sentdm/models/webhook_list_events_response"
 require_relative "sentdm/models/webhook_list_event_types_params"
 require_relative "sentdm/models/webhook_list_event_types_response"
 require_relative "sentdm/models/webhook_list_params"
 require_relative "sentdm/models/webhook_list_response"
-require_relative "sentdm/models/webhook_response"
 require_relative "sentdm/models/webhook_retrieve_params"
+require_relative "sentdm/models/webhook_retrieve_response"
 require_relative "sentdm/models/webhook_rotate_secret_params"
 require_relative "sentdm/models/webhook_rotate_secret_response"
 require_relative "sentdm/models/webhook_test_params"
 require_relative "sentdm/models/webhook_test_response"
 require_relative "sentdm/models/webhook_toggle_status_params"
+require_relative "sentdm/models/webhook_toggle_status_response"
 require_relative "sentdm/models/webhook_update_params"
+require_relative "sentdm/models/webhook_update_response"
 require_relative "sentdm/models"
 require_relative "sentdm/resources/contacts"
 require_relative "sentdm/resources/me"

data/rbi/sentdm/models/contact_create_response.rbi

@@ -0,0 +1,390 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ContactCreateResponse < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            Sentdm::Models::ContactCreateResponse,
+            Sentdm::Internal::AnyHash
+          )
+        end
+
+      # Contact response for v3 API Uses snake_case for JSON property names
+      sig { returns(T.nilable(Sentdm::Models::ContactCreateResponse::Data)) }
+      attr_reader :data
+
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ContactCreateResponse::Data::OrHash)
+        ).void
+      end
+      attr_writer :data
+
+      # Error information
+      sig { returns(T.nilable(Sentdm::Models::ContactCreateResponse::Error)) }
+      attr_reader :error
+
+      sig do
+        params(
+          error: T.nilable(Sentdm::Models::ContactCreateResponse::Error::OrHash)
+        ).void
+      end
+      attr_writer :error
+
+      # Request and response metadata
+      sig { returns(T.nilable(Sentdm::Models::ContactCreateResponse::Meta)) }
+      attr_reader :meta
+
+      sig do
+        params(meta: Sentdm::Models::ContactCreateResponse::Meta::OrHash).void
+      end
+      attr_writer :meta
+
+      # Indicates whether the request was successful
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :success
+
+      sig { params(success: T::Boolean).void }
+      attr_writer :success
+
+      # Standard API response envelope for all v3 endpoints
+      sig do
+        params(
+          data: T.nilable(Sentdm::Models::ContactCreateResponse::Data::OrHash),
+          error:
+            T.nilable(Sentdm::Models::ContactCreateResponse::Error::OrHash),
+          meta: Sentdm::Models::ContactCreateResponse::Meta::OrHash,
+          success: T::Boolean
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Contact response for v3 API Uses snake_case for JSON property names
+        data: nil,
+        # Error information
+        error: nil,
+        # Request and response metadata
+        meta: nil,
+        # Indicates whether the request was successful
+        success: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T.nilable(Sentdm::Models::ContactCreateResponse::Data),
+            error: T.nilable(Sentdm::Models::ContactCreateResponse::Error),
+            meta: Sentdm::Models::ContactCreateResponse::Meta,
+            success: T::Boolean
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactCreateResponse::Data,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for the contact
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+        sig { returns(T.nilable(String)) }
+        attr_reader :available_channels
+
+        sig { params(available_channels: String).void }
+        attr_writer :available_channels
+
+        # Country calling code (e.g., 1 for US/Canada)
+        sig { returns(T.nilable(String)) }
+        attr_reader :country_code
+
+        sig { params(country_code: String).void }
+        attr_writer :country_code
+
+        # When the contact was created
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        # Default messaging channel to use (e.g., "sms" or "whatsapp")
+        sig { returns(T.nilable(String)) }
+        attr_reader :default_channel
+
+        sig { params(default_channel: String).void }
+        attr_writer :default_channel
+
+        # Phone number in E.164 format (e.g., +1234567890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_e164
+
+        sig { params(format_e164: String).void }
+        attr_writer :format_e164
+
+        # Phone number in international format (e.g., +1 234-567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_international
+
+        sig { params(format_international: String).void }
+        attr_writer :format_international
+
+        # Phone number in national format (e.g., (234) 567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_national
+
+        sig { params(format_national: String).void }
+        attr_writer :format_national
+
+        # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+        sig { returns(T.nilable(String)) }
+        attr_reader :format_rfc
+
+        sig { params(format_rfc: String).void }
+        attr_writer :format_rfc
+
+        # Whether this is an inherited contact (read-only)
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :is_inherited
+
+        sig { params(is_inherited: T::Boolean).void }
+        attr_writer :is_inherited
+
+        # Whether the contact has opted out of messaging. Single source of truth — opt-out
+        # is per-contact, not per-channel.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :opt_out
+
+        sig { params(opt_out: T::Boolean).void }
+        attr_writer :opt_out
+
+        # Phone number in original format
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_number
+
+        sig { params(phone_number: String).void }
+        attr_writer :phone_number
+
+        # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+        sig { returns(T.nilable(String)) }
+        attr_reader :region_code
+
+        sig { params(region_code: String).void }
+        attr_writer :region_code
+
+        # When the contact was last updated
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :updated_at
+
+        # Contact response for v3 API Uses snake_case for JSON property names
+        sig do
+          params(
+            id: String,
+            available_channels: String,
+            country_code: String,
+            created_at: Time,
+            default_channel: String,
+            format_e164: String,
+            format_international: String,
+            format_national: String,
+            format_rfc: String,
+            is_inherited: T::Boolean,
+            opt_out: T::Boolean,
+            phone_number: String,
+            region_code: String,
+            updated_at: T.nilable(Time)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Unique identifier for the contact
+          id: nil,
+          # Comma-separated list of available messaging channels (e.g., "sms,whatsapp")
+          available_channels: nil,
+          # Country calling code (e.g., 1 for US/Canada)
+          country_code: nil,
+          # When the contact was created
+          created_at: nil,
+          # Default messaging channel to use (e.g., "sms" or "whatsapp")
+          default_channel: nil,
+          # Phone number in E.164 format (e.g., +1234567890)
+          format_e164: nil,
+          # Phone number in international format (e.g., +1 234-567-890)
+          format_international: nil,
+          # Phone number in national format (e.g., (234) 567-890)
+          format_national: nil,
+          # Phone number in RFC 3966 format (e.g., tel:+1-234-567-890)
+          format_rfc: nil,
+          # Whether this is an inherited contact (read-only)
+          is_inherited: nil,
+          # Whether the contact has opted out of messaging. Single source of truth — opt-out
+          # is per-contact, not per-channel.
+          opt_out: nil,
+          # Phone number in original format
+          phone_number: nil,
+          # ISO 3166-1 alpha-2 country code (e.g., US, CA, GB)
+          region_code: nil,
+          # When the contact was last updated
+          updated_at: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              available_channels: String,
+              country_code: String,
+              created_at: Time,
+              default_channel: String,
+              format_e164: String,
+              format_international: String,
+              format_national: String,
+              format_rfc: String,
+              is_inherited: T::Boolean,
+              opt_out: T::Boolean,
+              phone_number: String,
+              region_code: String,
+              updated_at: T.nilable(Time)
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactCreateResponse::Error,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Machine-readable error code (e.g., "RESOURCE_001")
+        sig { returns(T.nilable(String)) }
+        attr_reader :code
+
+        sig { params(code: String).void }
+        attr_writer :code
+
+        # Additional validation error details (field-level errors)
+        sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+        attr_accessor :details
+
+        # URL to documentation about this error
+        sig { returns(T.nilable(String)) }
+        attr_accessor :doc_url
+
+        # Human-readable error message
+        sig { returns(T.nilable(String)) }
+        attr_reader :message
+
+        sig { params(message: String).void }
+        attr_writer :message
+
+        # Error information
+        sig do
+          params(
+            code: String,
+            details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            doc_url: T.nilable(String),
+            message: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Machine-readable error code (e.g., "RESOURCE_001")
+          code: nil,
+          # Additional validation error details (field-level errors)
+          details: nil,
+          # URL to documentation about this error
+          doc_url: nil,
+          # Human-readable error message
+          message: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              code: String,
+              details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+              doc_url: T.nilable(String),
+              message: String
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::ContactCreateResponse::Meta,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for this request (for tracing and support)
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # Server timestamp when the response was generated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # API version used for this request
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Request and response metadata
+        sig do
+          params(request_id: String, timestamp: Time, version: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for this request (for tracing and support)
+          request_id: nil,
+          # Server timestamp when the response was generated
+          timestamp: nil,
+          # API version used for this request
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { request_id: String, timestamp: Time, version: String }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/contact_delete_params.rbi

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class ContactDeleteParams < Sentdm::Models::MutationRequest
+    class ContactDeleteParams < Sentdm::Internal::Type::BaseModel
       extend Sentdm::Internal::Type::RequestParameters::Converter
       include Sentdm::Internal::Type::RequestParameters
 
@@ -14,6 +14,14 @@ module Sentdm
       sig { returns(String) }
       attr_accessor :id
 
+      # Sandbox flag - when true, the operation is simulated without side effects Useful
+      # for testing integrations without actual execution
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :sandbox
+
+      sig { params(sandbox: T::Boolean).void }
+      attr_writer :sandbox
+
       sig { returns(T.nilable(String)) }
       attr_reader :x_profile_id
 
@@ -23,17 +31,26 @@ module Sentdm
       sig do
         params(
           id: String,
+          sandbox: T::Boolean,
           x_profile_id: String,
           request_options: Sentdm::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
-      def self.new(id:, x_profile_id: nil, request_options: {})
+      def self.new(
+        id:,
+        # Sandbox flag - when true, the operation is simulated without side effects Useful
+        # for testing integrations without actual execution
+        sandbox: nil,
+        x_profile_id: nil,
+        request_options: {}
+      )
       end
 
       sig do
         override.returns(
           {
             id: String,
+            sandbox: T::Boolean,
             x_profile_id: String,
             request_options: Sentdm::RequestOptions
           }