sentdm 0.2.0 → 0.3.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: fab8dc014cdfdffd5db27dfeb306c0202ca83650d6d6e318538907885673f451
-  data.tar.gz: 1a700098dc48f38b8552099ac2927132a0a619ef603d3afacdd7ee4b93fe4d29
+  metadata.gz: 7e9255fd572fb809acadb95d529be7670e1108067cb33622e50169d008fbdef0
+  data.tar.gz: 446bb1258628f0793cf4b657f940661dfb7abc792b4ed11d58ff061deb35c27d
 SHA512:
-  metadata.gz: 64dc4a9f5d777c149fa0d7bc2fd7ecdb22da7d2e5a778717567bc617e201fd5cc275500d1d3a670404fb3e7350a51259774e5f6ad1aea585a0edcd72a3911f2d
-  data.tar.gz: cb1dc7f0eea9e923b18d3ba2267e9d984eb75ed73dbd93bba4c6d2d17bb65f3bba883aeed481c48dfb3e934b7c25f7cc449fbf744a54c004edc5b0756d29c03d
+  metadata.gz: 385856fe59775e07188fb9c1e1b820c24db38858ae29a9899122106a21555da3c583b7c62f58eeaf717fc1bdb8ddeab639980aa96796cfaa11696cafe4d6fc9e
+  data.tar.gz: '083c75a984c27b968a4edadba77fa4014c36650ae056d8c3c2d4cc8e05678ac7aba18548e61ac6923d8856579b0f49b29d17b2f6d187ce6ef5dcd0861ba252a6'

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.3.0 (2026-02-18)
+
+Full Changelog: [v0.2.0...v0.3.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.2.0...v0.3.0)
+
+### Features
+
+* **api:** manual updates ([e674172](https://github.com/sentdm/sent-dm-ruby/commit/e674172971f06d5616165303b01e6c0a24cf3744))
+* **api:** manual updates ([6262e32](https://github.com/sentdm/sent-dm-ruby/commit/6262e327f30368608f29890d469c0352b9da80c8))
+* **api:** manual updates ([33fff26](https://github.com/sentdm/sent-dm-ruby/commit/33fff2647eb26bde013600c8632b160a46f1eb73))
+
 ## 0.2.0 (2026-02-16)
 
 Full Changelog: [v0.1.0...v0.2.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.1.0...v0.2.0)

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.2.0"
+gem "sentdm", "~> 0.3.0"
 ```
 
 <!-- x-release-please-end -->
@@ -29,17 +29,20 @@ require "bundler/setup"
 require "sentdm"
 
 sent_dm = Sentdm::Client.new(
-  api_key: ENV["SENT_DM_API_KEY"], # This is the default and can be omitted
-  sender_id: ENV["SENT_DM_SENDER_ID"] # This is the default and can be omitted
+  api_key: ENV["SENT_DM_API_KEY"] # This is the default and can be omitted
 )
 
-result = sent_dm.messages.send_to_phone(
-  phone_number: "+1234567890",
-  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-  template_variables: {name: "John Doe", order_id: "12345"}
+response = sent_dm.messages.send_(
+  channel: ["sms", "whatsapp"],
+  template: {
+    id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    name: "order_confirmation",
+    parameters: {name: "John Doe", order_id: "12345"}
+  },
+  to: ["+14155551234", "+14155555678"]
 )
 
-puts(result)
+puts(response.data)
 ```
 
 ### Handling errors
@@ -48,10 +51,14 @@ When the library is unable to connect to the API, or if the API returns a non-su
 
 ```ruby
 begin
-  message = sent_dm.messages.send_to_phone(
-    phone_number: "+1234567890",
-    template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-    template_variables: {name: "John Doe", order_id: "12345"}
+  message = sent_dm.messages.send_(
+    channel: ["sms"],
+    template: {
+      id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+      name: "order_confirmation",
+      parameters: {name: "John Doe", order_id: "12345"}
+    },
+    to: ["+14155551234"]
   )
 rescue Sentdm::Errors::APIConnectionError => e
   puts("The server could not be reached")
@@ -95,10 +102,14 @@ sent_dm = Sentdm::Client.new(
 )
 
 # Or, configure per-request:
-sent_dm.messages.send_to_phone(
-  phone_number: "+1234567890",
-  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-  template_variables: {name: "John Doe", order_id: "12345"},
+sent_dm.messages.send_(
+  channel: ["sms"],
+  template: {
+    id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    name: "order_confirmation",
+    parameters: {name: "John Doe", order_id: "12345"}
+  },
+  to: ["+14155551234"],
   request_options: {max_retries: 5}
 )
 ```
@@ -114,10 +125,14 @@ sent_dm = Sentdm::Client.new(
 )
 
 # Or, configure per-request:
-sent_dm.messages.send_to_phone(
-  phone_number: "+1234567890",
-  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-  template_variables: {name: "John Doe", order_id: "12345"},
+sent_dm.messages.send_(
+  channel: ["sms"],
+  template: {
+    id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    name: "order_confirmation",
+    parameters: {name: "John Doe", order_id: "12345"}
+  },
+  to: ["+14155551234"],
   request_options: {timeout: 5}
 )
 ```
@@ -149,11 +164,15 @@ You can send undocumented parameters to any endpoint, and read undocumented resp
 Note: the `extra_` parameters of the same name overrides the documented parameters.
 
 ```ruby
-result =
-  sent_dm.messages.send_to_phone(
-    phone_number: "+1234567890",
-    template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-    template_variables: {name: "John Doe", order_id: "12345"},
+response =
+  sent_dm.messages.send_(
+    channel: ["sms"],
+    template: {
+      id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+      name: "order_confirmation",
+      parameters: {name: "John Doe", order_id: "12345"}
+    },
+    to: ["+14155551234"],
     request_options: {
       extra_query: {my_query_parameter: value},
       extra_body: {my_body_parameter: value},
@@ -161,7 +180,7 @@ result =
     }
   )
 
-puts(result[:my_undocumented_property])
+puts(response[:my_undocumented_property])
 ```
 
 #### Undocumented request params
@@ -199,10 +218,14 @@ This library provides comprehensive [RBI](https://sorbet.org/docs/rbi) definitio
 You can provide typesafe request parameters like so:
 
 ```ruby
-sent_dm.messages.send_to_phone(
-  phone_number: "+1234567890",
-  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-  template_variables: {name: "John Doe", order_id: "12345"}
+sent_dm.messages.send_(
+  channel: ["sms", "whatsapp"],
+  template: Sentdm::MessageSendParams::Template.new(
+    id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    name: "order_confirmation",
+    parameters: {name: "John Doe", order_id: "12345"}
+  ),
+  to: ["+14155551234", "+14155555678"]
 )
 ```
 
@@ -210,19 +233,53 @@ Or, equivalently:
 
 ```ruby
 # Hashes work, but are not typesafe:
-sent_dm.messages.send_to_phone(
-  phone_number: "+1234567890",
-  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-  template_variables: {name: "John Doe", order_id: "12345"}
+sent_dm.messages.send_(
+  channel: ["sms", "whatsapp"],
+  template: {
+    id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    name: "order_confirmation",
+    parameters: {name: "John Doe", order_id: "12345"}
+  },
+  to: ["+14155551234", "+14155555678"]
 )
 
 # You can also splat a full Params class:
-params = Sentdm::MessageSendToPhoneParams.new(
-  phone_number: "+1234567890",
-  template_id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
-  template_variables: {name: "John Doe", order_id: "12345"}
+params = Sentdm::MessageSendParams.new(
+  channel: ["sms", "whatsapp"],
+  template: Sentdm::MessageSendParams::Template.new(
+    id: "7ba7b820-9dad-11d1-80b4-00c04fd430c8",
+    name: "order_confirmation",
+    parameters: {name: "John Doe", order_id: "12345"}
+  ),
+  to: ["+14155551234", "+14155555678"]
+)
+sent_dm.messages.send_(**params)
+```
+
+### Enums
+
+Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::Enum`](https://sorbet.org/docs/tenum) instances. Instead, we provide "tagged symbols" instead, which is always a primitive at runtime:
+
+```ruby
+# :BASIC_ACCOUNT
+puts(Sentdm::TcrBrandRelationship::BASIC_ACCOUNT)
+
+# Revealed type: `T.all(Sentdm::TcrBrandRelationship, Symbol)`
+T.reveal_type(Sentdm::TcrBrandRelationship::BASIC_ACCOUNT)
+```
+
+Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
+
+```ruby
+Sentdm::BrandData.new(
+  brand_relationship: Sentdm::TcrBrandRelationship::BASIC_ACCOUNT,
+  # …
+)
+
+Sentdm::BrandData.new(
+  brand_relationship: :BASIC_ACCOUNT,
+  # …
 )
-sent_dm.messages.send_to_phone(**params)
 ```
 
 ## Versioning

data/lib/sentdm/client.rb

@@ -20,42 +20,38 @@ module Sentdm
     # @return [String]
     attr_reader :api_key
 
-    # Customer sender ID (UUID) identifying the customer account. Obtain this from
-    # your account settings. Pass via the `x-sender-id` header.
-    # @return [String]
-    attr_reader :sender_id
+    # @return [Sentdm::Resources::Webhooks]
+    attr_reader :webhooks
 
-    # @return [Sentdm::Resources::Contacts]
-    attr_reader :contacts
+    # @return [Sentdm::Resources::Users]
+    attr_reader :users
+
+    # @return [Sentdm::Resources::Templates]
+    attr_reader :templates
+
+    # @return [Sentdm::Resources::Profiles]
+    attr_reader :profiles
 
     # @return [Sentdm::Resources::Messages]
     attr_reader :messages
 
-    # @return [Sentdm::Resources::Templates]
-    attr_reader :templates
+    # @return [Sentdm::Resources::Lookup]
+    attr_reader :lookup
 
-    # @return [Sentdm::Resources::NumberLookup]
-    attr_reader :number_lookup
+    # @return [Sentdm::Resources::Contacts]
+    attr_reader :contacts
 
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def auth_headers
-      {**customer_api_key, **customer_sender_id}
-    end
+    # @return [Sentdm::Resources::Brands]
+    attr_reader :brands
 
-    # @api private
-    #
-    # @return [Hash{String=>String}]
-    private def customer_api_key
-      {"x-api-key" => @api_key}
-    end
+    # @return [Sentdm::Resources::Me]
+    attr_reader :me
 
     # @api private
     #
     # @return [Hash{String=>String}]
-    private def customer_sender_id
-      {"x-sender-id" => @sender_id}
+    private def auth_headers
+      {"x-api-key" => @api_key}
     end
 
     # Creates and returns a new client for interacting with the API.
@@ -64,10 +60,6 @@ module Sentdm
     # `sk_test_*` keys for sandbox/testing. Pass via the `x-api-key` header. Defaults
     # to `ENV["SENT_DM_API_KEY"]`
     #
-    # @param sender_id [String, nil] Customer sender ID (UUID) identifying the customer account. Obtain this from
-    # your account settings. Pass via the `x-sender-id` header. Defaults to
-    # `ENV["SENT_DM_SENDER_ID"]`
-    #
     # @param base_url [String, nil] Override the default base URL for the API, e.g.,
     # `"https://api.example.com/v2/"`. Defaults to `ENV["SENT_DM_BASE_URL"]`
     #
@@ -80,7 +72,6 @@ module Sentdm
     # @param max_retry_delay [Float]
     def initialize(
       api_key: ENV["SENT_DM_API_KEY"],
-      sender_id: ENV["SENT_DM_SENDER_ID"],
       base_url: ENV["SENT_DM_BASE_URL"],
       max_retries: self.class::DEFAULT_MAX_RETRIES,
       timeout: self.class::DEFAULT_TIMEOUT_IN_SECONDS,
@@ -92,12 +83,8 @@ module Sentdm
       if api_key.nil?
         raise ArgumentError.new("api_key is required, and can be set via environ: \"SENT_DM_API_KEY\"")
       end
-      if sender_id.nil?
-        raise ArgumentError.new("sender_id is required, and can be set via environ: \"SENT_DM_SENDER_ID\"")
-      end
 
       @api_key = api_key.to_s
-      @sender_id = sender_id.to_s
 
       super(
         base_url: base_url,
@@ -107,10 +94,15 @@ module Sentdm
         max_retry_delay: max_retry_delay
       )
 
-      @contacts = Sentdm::Resources::Contacts.new(client: self)
-      @messages = Sentdm::Resources::Messages.new(client: self)
+      @webhooks = Sentdm::Resources::Webhooks.new(client: self)
+      @users = Sentdm::Resources::Users.new(client: self)
       @templates = Sentdm::Resources::Templates.new(client: self)
-      @number_lookup = Sentdm::Resources::NumberLookup.new(client: self)
+      @profiles = Sentdm::Resources::Profiles.new(client: self)
+      @messages = Sentdm::Resources::Messages.new(client: self)
+      @lookup = Sentdm::Resources::Lookup.new(client: self)
+      @contacts = Sentdm::Resources::Contacts.new(client: self)
+      @brands = Sentdm::Resources::Brands.new(client: self)
+      @me = Sentdm::Resources::Me.new(client: self)
     end
   end
 end

data/lib/sentdm/internal/type/base_model.rb

@@ -438,11 +438,11 @@ module Sentdm
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `contact_list_item` is a `Sentdm::ContactListItem`
-        #   contact_list_item => {
-        #     id: id,
-        #     available_channels: available_channels,
-        #     country_code: country_code
+        #   # `api_error` is a `Sentdm::APIError`
+        #   api_error => {
+        #     code: code,
+        #     details: details,
+        #     doc_url: doc_url
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/sentdm/internal/type/enum.rb

@@ -15,6 +15,31 @@ module Sentdm
       #
       # We can therefore convert string values to Symbols, but can't convert other
       # values safely.
+      #
+      # @example
+      #   # `tcr_brand_relationship` is a `Sentdm::TcrBrandRelationship`
+      #   case tcr_brand_relationship
+      #   when Sentdm::TcrBrandRelationship::BASIC_ACCOUNT
+      #     # ...
+      #   when Sentdm::TcrBrandRelationship::MEDIUM_ACCOUNT
+      #     # ...
+      #   when Sentdm::TcrBrandRelationship::LARGE_ACCOUNT
+      #     # ...
+      #   else
+      #     puts(tcr_brand_relationship)
+      #   end
+      #
+      # @example
+      #   case tcr_brand_relationship
+      #   in :BASIC_ACCOUNT
+      #     # ...
+      #   in :MEDIUM_ACCOUNT
+      #     # ...
+      #   in :LARGE_ACCOUNT
+      #     # ...
+      #   else
+      #     puts(tcr_brand_relationship)
+      #   end
       module Enum
         include Sentdm::Internal::Type::Converter
         include Sentdm::Internal::Util::SorbetRuntimeSupport

data/lib/sentdm/models/api_error.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIError < Sentdm::Internal::Type::BaseModel
+      # @!attribute code
+      #   Machine-readable error code (e.g., "RESOURCE_001")
+      #
+      #   @return [String, nil]
+      optional :code, String
+
+      # @!attribute details
+      #   Additional validation error details (field-level errors)
+      #
+      #   @return [Hash{Symbol=>Array<String>}, nil]
+      optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
+
+      # @!attribute doc_url
+      #   URL to documentation about this error
+      #
+      #   @return [String, nil]
+      optional :doc_url, String, nil?: true
+
+      # @!attribute message
+      #   Human-readable error message
+      #
+      #   @return [String, nil]
+      optional :message, String
+
+      # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
+      #   Error information
+      #
+      #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
+      #
+      #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
+      #
+      #   @param doc_url [String, nil] URL to documentation about this error
+      #
+      #   @param message [String] Human-readable error message
+    end
+  end
+end

data/lib/sentdm/models/api_meta.rb

@@ -0,0 +1,42 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class APIMeta < Sentdm::Internal::Type::BaseModel
+      # @!attribute request_id
+      #   Unique identifier for this request (for tracing and support)
+      #
+      #   @return [String, nil]
+      optional :request_id, String
+
+      # @!attribute response_time_ms
+      #   Response time in milliseconds (optional)
+      #
+      #   @return [Integer, nil]
+      optional :response_time_ms, Integer, nil?: true
+
+      # @!attribute timestamp
+      #   Server timestamp when the response was generated
+      #
+      #   @return [Time, nil]
+      optional :timestamp, Time
+
+      # @!attribute version
+      #   API version used for this request
+      #
+      #   @return [String, nil]
+      optional :version, String
+
+      # @!method initialize(request_id: nil, response_time_ms: nil, timestamp: nil, version: nil)
+      #   Request and response metadata
+      #
+      #   @param request_id [String] Unique identifier for this request (for tracing and support)
+      #
+      #   @param response_time_ms [Integer, nil] Response time in milliseconds (optional)
+      #
+      #   @param timestamp [Time] Server timestamp when the response was generated
+      #
+      #   @param version [String] API version used for this request
+    end
+  end
+end

data/lib/sentdm/models/api_response_brand_with_kyc.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Brands#create
+    class APIResponseBrandWithKYC < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::BrandWithKYC, nil]
+      optional :data, -> { Sentdm::BrandWithKYC }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::BrandWithKYC, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_contact.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#create
+    class APIResponseContact < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::Contact, nil]
+      optional :data, -> { Sentdm::Contact }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::Contact, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_profile_detail.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Profiles#create
+    class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::ProfileDetail, nil]
+      optional :data, -> { Sentdm::ProfileDetail }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ProfileDetail, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/api_response_of_user.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Users#retrieve
+    class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   The response data (null if error)
+      #
+      #   @return [Sentdm::Models::UserResponse, nil]
+      optional :data, -> { Sentdm::UserResponse }, nil?: true
+
+      # @!attribute error
+      #   Error details (null if successful)
+      #
+      #   @return [Sentdm::Models::APIError, nil]
+      optional :error, -> { Sentdm::APIError }, nil?: true
+
+      # @!attribute meta
+      #   Metadata about the request and response
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::UserResponse, nil] The response data (null if error)
+      #
+      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end