sentdm 0.7.0 → 0.8.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: bff2c5b4e518eeec2d0ab709016c3f835ae425bd86e3c1552e238f1d64419da3
-  data.tar.gz: b5360b4e37cc156800a6f8a90d051ade3078fa10c89c453999a9fdb2a70a8813
+  metadata.gz: 447a045280efe7da83cf429cdcccd358d54cab7bde54b7e017e194b398ed6333
+  data.tar.gz: 6df56b895dfc8b2b118c8bccdabc9b87272a79c80f9f1749d27ff5537d97240a
 SHA512:
-  metadata.gz: bb49d13d9d4c5d4f3eed14a8e2caeb8fe3c2a70214b551408c1cf60b2ae3c2f3497031a77e44a7e558362d7e38fe6076fc774a62946fdb1ae45f88a2215186ff
-  data.tar.gz: 606ca84dfc65bb1b02f08bbf8d2cdad31db141e5e9354c595f95e6127190a0c9a01df1c78f3221804dbe680b0ac09bdb31f313384852ebe11dd0774ec62bf598
+  metadata.gz: '064029446763608a46bdb7e1be08b8075645ea22b42a954a259d9ba0ebdf5aecd39bc8a783d38e745ad41c8e18c018c90439b62ab2d9b750938def30983a6fed'
+  data.tar.gz: 941fd2702a359e4d7ce7eee6b8e868980275fa7270457e3534fd1dfbb385d1b052c235aae138d9e93dcfc428c133960a9b29b47ad45bd257bc5649a6d0d2c94a

data/CHANGELOG.md

@@ -1,5 +1,15 @@
 # Changelog
 
+## 0.8.0 (2026-03-12)
+
+Full Changelog: [v0.7.0...v0.8.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.7.0...v0.8.0)
+
+### Features
+
+* **api:** api update ([f25ebae](https://github.com/sentdm/sent-dm-ruby/commit/f25ebae4c9713c74d6958d1bc3bc83bec52db1a9))
+* **api:** manual updates ([7700a0e](https://github.com/sentdm/sent-dm-ruby/commit/7700a0e6b7a4a8e68a4d4bc7fdad40bc51302fcc))
+* **api:** manual updates ([3101223](https://github.com/sentdm/sent-dm-ruby/commit/3101223023d236a6b3006f4c9847badc5a98dbab))
+
 ## 0.7.0 (2026-03-11)
 
 Full Changelog: [v0.6.0...v0.7.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.6.0...v0.7.0)

data/README.md

@@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.7.0"
+gem "sentdm", "~> 0.8.0"
 ```
 
 <!-- x-release-please-end -->

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

@@ -438,11 +438,11 @@ module Sentdm
         # @return [Hash{Symbol=>Object}]
         #
         # @example
-        #   # `base_dto` is a `Sentdm::BaseDto`
-        #   base_dto => {
-        #     id: id,
-        #     created_at: created_at,
-        #     updated_at: updated_at
+        #   # `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/models/api_response_of_contact.rb

@@ -5,19 +5,19 @@ module Sentdm
     # @see Sentdm::Resources::Contacts#create
     class APIResponseOfContact < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   Contact response for v3 API Uses snake_case for JSON property names
       #
       #   @return [Sentdm::Models::ContactResponse, nil]
       optional :data, -> { Sentdm::ContactResponse }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -29,13 +29,16 @@ module Sentdm
       optional :success, Sentdm::Internal::Type::Boolean
 
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::APIResponseOfContact} for more details.
+      #
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::ContactResponse, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::ContactResponse, nil] Contact response for v3 API
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
     end

data/lib/sentdm/models/api_response_of_profile_detail.rb

@@ -5,19 +5,19 @@ module Sentdm
     # @see Sentdm::Resources::Profiles#create
     class APIResponseOfProfileDetail < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   Detailed profile response for v3 API
       #
       #   @return [Sentdm::Models::ProfileDetail, nil]
       optional :data, -> { Sentdm::ProfileDetail }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
       # @!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 data [Sentdm::Models::ProfileDetail, nil] Detailed profile response for v3 API
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
     end

data/lib/sentdm/models/api_response_of_user.rb

@@ -5,19 +5,19 @@ module Sentdm
     # @see Sentdm::Resources::Users#retrieve
     class APIResponseOfUser < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   User response for v3 API
       #
       #   @return [Sentdm::Models::UserResponse, nil]
       optional :data, -> { Sentdm::UserResponse }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
       # @!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 data [Sentdm::Models::UserResponse, nil] User response for v3 API
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
     end

data/lib/sentdm/models/api_response_template.rb

@@ -5,19 +5,19 @@ module Sentdm
     # @see Sentdm::Resources::Templates#create
     class APIResponseTemplate < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   Template response for v3 API
       #
       #   @return [Sentdm::Models::Template, nil]
       optional :data, -> { Sentdm::Template }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::Template, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::Template, nil] Template response for v3 API
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
     end

data/lib/sentdm/models/api_response_webhook.rb

@@ -11,13 +11,13 @@ module Sentdm
       optional :data, -> { Sentdm::WebhookResponse }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -33,9 +33,9 @@ module Sentdm
       #
       #   @param data [Sentdm::Models::WebhookResponse, nil] The response data (null if error)
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
     end

data/lib/sentdm/models/brands_brand_data.rb

@@ -4,21 +4,21 @@ module Sentdm
   module Models
     class BrandsBrandData < Sentdm::Internal::Type::BaseModel
       # @!attribute compliance
-      #   Compliance and TCR-related information
+      #   Compliance and TCR information for brand registration
       #
       #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo]
       required :compliance,
                -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo }
 
       # @!attribute contact
-      #   Contact information for the brand
+      #   Contact information for brand KYC
       #
       #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo]
       required :contact,
                -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo }
 
       # @!attribute business
-      #   Business details and address information
+      #   Business details and address for brand KYC
       #
       #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil]
       optional :business,
@@ -28,11 +28,11 @@ module Sentdm
       # @!method initialize(compliance:, contact:, business: nil)
       #   Brand and KYC data grouped into contact, business, and compliance sections
       #
-      #   @param compliance [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo] Compliance and TCR-related information
+      #   @param compliance [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo] Compliance and TCR information for brand registration
       #
-      #   @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for the brand
+      #   @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for brand KYC
       #
-      #   @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address information
+      #   @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address for brand KYC
     end
   end
 end

data/lib/sentdm/models/contact_delete_params.rb

@@ -32,7 +32,7 @@ module Sentdm
       #
       #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
 
-      class Body < Sentdm::Models::MutationRequestBase
+      class Body < Sentdm::Models::MutationRequest
         # @!method initialize
         #   Request to delete/dissociate a contact
       end

data/lib/sentdm/models/contact_list_response.rb

@@ -5,19 +5,19 @@ module Sentdm
     # @see Sentdm::Resources::Contacts#list
     class ContactListResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   Paginated list of contacts response
       #
       #   @return [Sentdm::Models::ContactListResponse::Data, nil]
       optional :data, -> { Sentdm::Models::ContactListResponse::Data }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::ContactListResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::ContactListResponse::Data, nil] Paginated list of contacts response
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -48,17 +48,17 @@ module Sentdm
         optional :contacts, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactResponse] }
 
         # @!attribute pagination
-        #   Pagination metadata
+        #   Pagination metadata for list responses
         #
         #   @return [Sentdm::Models::PaginationMeta, nil]
         optional :pagination, -> { Sentdm::PaginationMeta }
 
         # @!method initialize(contacts: nil, pagination: nil)
-        #   The response data (null if error)
+        #   Paginated list of contacts response
         #
         #   @param contacts [Array<Sentdm::Models::ContactResponse>] List of contacts
         #
-        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata
+        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
       end
     end
   end

data/lib/sentdm/models/me_retrieve_response.rb

@@ -5,19 +5,21 @@ module Sentdm
     # @see Sentdm::Resources::Me#retrieve
     class MeRetrieveResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   Account response for GET /v3/me endpoint. Returns organization (with profiles),
+      #   user (standalone), or profile (child of an organization) data depending on the
+      #   API key type. Always includes messaging channel configuration.
       #
       #   @return [Sentdm::Models::MeRetrieveResponse::Data, nil]
       optional :data, -> { Sentdm::Models::MeRetrieveResponse::Data }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -29,13 +31,16 @@ module Sentdm
       optional :success, Sentdm::Internal::Type::Boolean
 
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {Sentdm::Models::MeRetrieveResponse} for more details.
+      #
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::MeRetrieveResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::MeRetrieveResponse::Data, nil] Account response for GET /v3/me endpoint.
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -48,7 +53,8 @@ module Sentdm
         optional :id, String
 
         # @!attribute channels
-        #   Messaging channel configuration
+        #   Messaging channel configuration. All three channels are always present. Each
+        #   channel has a "configured" flag; configured channels expose additional details.
         #
         #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels, nil]
         optional :channels, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels }
@@ -98,7 +104,7 @@ module Sentdm
                  -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MeRetrieveResponse::Data::Profile] }
 
         # @!attribute settings
-        #   Profile settings (only for profile type)
+        #   Profile configuration settings
         #
         #   @return [Sentdm::Models::ProfileSettings, nil]
         optional :settings, -> { Sentdm::ProfileSettings }, nil?: true
@@ -127,11 +133,13 @@ module Sentdm
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::MeRetrieveResponse::Data} for more details.
         #
-        #   The response data (null if error)
+        #   Account response for GET /v3/me endpoint. Returns organization (with profiles),
+        #   user (standalone), or profile (child of an organization) data depending on the
+        #   API key type. Always includes messaging channel configuration.
         #
         #   @param id [String] Customer ID (organization, account, or profile)
         #
-        #   @param channels [Sentdm::Models::MeRetrieveResponse::Data::Channels] Messaging channel configuration
+        #   @param channels [Sentdm::Models::MeRetrieveResponse::Data::Channels] Messaging channel configuration. All three channels are always present.
         #
         #   @param created_at [Time] When the account was created
         #
@@ -147,7 +155,7 @@ module Sentdm
         #
         #   @param profiles [Array<Sentdm::Models::MeRetrieveResponse::Data::Profile>] List of profiles (populated for organization type, empty for user and profile ty
         #
-        #   @param settings [Sentdm::Models::ProfileSettings, nil] Profile settings (only for profile type)
+        #   @param settings [Sentdm::Models::ProfileSettings, nil] Profile configuration settings
         #
         #   @param short_name [String, nil] Short name / abbreviation (only for profile type)
         #
@@ -158,31 +166,36 @@ module Sentdm
         # @see Sentdm::Models::MeRetrieveResponse::Data#channels
         class Channels < Sentdm::Internal::Type::BaseModel
           # @!attribute rcs
-          #   RCS channel (provider: vibes)
+          #   RCS channel configuration. When configured, includes the RCS phone number.
           #
           #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs, nil]
           optional :rcs, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs }
 
           # @!attribute sms
-          #   SMS channel (providers: telnyx, sinch)
+          #   SMS channel configuration. When configured, includes the sending phone number.
           #
           #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS, nil]
           optional :sms, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS }
 
           # @!attribute whatsapp
-          #   WhatsApp Business channel (provider: meta)
+          #   WhatsApp Business channel configuration. When configured, includes the WhatsApp
+          #   phone number and business name.
           #
           #   @return [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp, nil]
           optional :whatsapp, -> { Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp }
 
           # @!method initialize(rcs: nil, sms: nil, whatsapp: nil)
-          #   Messaging channel configuration
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::MeRetrieveResponse::Data::Channels} for more details.
+          #
+          #   Messaging channel configuration. All three channels are always present. Each
+          #   channel has a "configured" flag; configured channels expose additional details.
           #
-          #   @param rcs [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs] RCS channel (provider: vibes)
+          #   @param rcs [Sentdm::Models::MeRetrieveResponse::Data::Channels::Rcs] RCS channel configuration. When configured, includes the RCS phone number.
           #
-          #   @param sms [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS] SMS channel (providers: telnyx, sinch)
+          #   @param sms [Sentdm::Models::MeRetrieveResponse::Data::Channels::SMS] SMS channel configuration. When configured, includes the sending phone number.
           #
-          #   @param whatsapp [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp] WhatsApp Business channel (provider: meta)
+          #   @param whatsapp [Sentdm::Models::MeRetrieveResponse::Data::Channels::Whatsapp] WhatsApp Business channel configuration. When configured, includes the WhatsApp
 
           # @see Sentdm::Models::MeRetrieveResponse::Data::Channels#rcs
           class Rcs < Sentdm::Internal::Type::BaseModel
@@ -199,7 +212,7 @@ module Sentdm
             optional :phone_number, String, nil?: true
 
             # @!method initialize(configured: nil, phone_number: nil)
-            #   RCS channel (provider: vibes)
+            #   RCS channel configuration. When configured, includes the RCS phone number.
             #
             #   @param configured [Boolean] Whether RCS is configured for this account
             #
@@ -221,7 +234,7 @@ module Sentdm
             optional :phone_number, String, nil?: true
 
             # @!method initialize(configured: nil, phone_number: nil)
-            #   SMS channel (providers: telnyx, sinch)
+            #   SMS channel configuration. When configured, includes the sending phone number.
             #
             #   @param configured [Boolean] Whether SMS is configured for this account
             #
@@ -249,7 +262,8 @@ module Sentdm
             optional :phone_number, String, nil?: true
 
             # @!method initialize(business_name: nil, configured: nil, phone_number: nil)
-            #   WhatsApp Business channel (provider: meta)
+            #   WhatsApp Business channel configuration. When configured, includes the WhatsApp
+            #   phone number and business name.
             #
             #   @param business_name [String, nil] WhatsApp Business display name
             #

data/lib/sentdm/models/message_retrieve_activities_response.rb

@@ -5,19 +5,19 @@ module Sentdm
     # @see Sentdm::Resources::Messages#retrieve_activities
     class MessageRetrieveActivitiesResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   Response for GET /messages/{id}/activities
       #
       #   @return [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil]
       optional :data, -> { Sentdm::Models::MessageRetrieveActivitiesResponse::Data }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::MessageRetrieveActivitiesResponse::Data, nil] Response for GET /messages/{id}/activities
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -55,7 +55,7 @@ module Sentdm
         optional :message_id, String
 
         # @!method initialize(activities: nil, message_id: nil)
-        #   The response data (null if error)
+        #   Response for GET /messages/{id}/activities
         #
         #   @param activities [Array<Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity>] List of activity events ordered by most recent first
         #

data/lib/sentdm/models/message_retrieve_status_response.rb

@@ -5,19 +5,19 @@ module Sentdm
     # @see Sentdm::Resources::Messages#retrieve_status
     class MessageRetrieveStatusResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   Message response for v3 API — same shape as v2 with snake_case JSON conventions
       #
       #   @return [Sentdm::Models::MessageRetrieveStatusResponse::Data, nil]
       optional :data, -> { Sentdm::Models::MessageRetrieveStatusResponse::Data }, nil?: true
 
       # @!attribute error
-      #   Error details (null if successful)
+      #   Error information
       #
       #   @return [Sentdm::Models::APIError, nil]
       optional :error, -> { Sentdm::APIError }, nil?: true
 
       # @!attribute meta
-      #   Metadata about the request and response
+      #   Request and response metadata
       #
       #   @return [Sentdm::Models::APIMeta, nil]
       optional :meta, -> { Sentdm::APIMeta }
@@ -31,11 +31,11 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::MessageRetrieveStatusResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::MessageRetrieveStatusResponse::Data, nil] Message response for v3 API — same shape as v2 with snake_case JSON conventions
       #
-      #   @param error [Sentdm::Models::APIError, nil] Error details (null if successful)
+      #   @param error [Sentdm::Models::APIError, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Metadata about the request and response
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -131,7 +131,7 @@ module Sentdm
         #   Some parameter documentations has been truncated, see
         #   {Sentdm::Models::MessageRetrieveStatusResponse::Data} for more details.
         #
-        #   The response data (null if error)
+        #   Message response for v3 API — same shape as v2 with snake_case JSON conventions
         #
         #   @param id [String]
         #

data/lib/sentdm/models/message_send_params.rb

@@ -23,7 +23,8 @@ module Sentdm
       optional :sandbox, Sentdm::Internal::Type::Boolean
 
       # @!attribute template
-      #   Template reference (by id or name, with optional parameters)
+      #   SDK-style template reference: resolve by ID or by name, with optional
+      #   parameters.
       #
       #   @return [Sentdm::Models::MessageSendParams::Template, nil]
       optional :template, -> { Sentdm::MessageSendParams::Template }
@@ -52,7 +53,7 @@ module Sentdm
       #
       #   @param sandbox [Boolean] Sandbox flag - when true, the operation is simulated without side effects
       #
-      #   @param template [Sentdm::Models::MessageSendParams::Template] Template reference (by id or name, with optional parameters)
+      #   @param template [Sentdm::Models::MessageSendParams::Template] SDK-style template reference: resolve by ID or by name, with optional parameters
       #
       #   @param to [Array<String>] List of recipient phone numbers in E.164 format (multi-recipient fan-out)
       #
@@ -82,7 +83,8 @@ module Sentdm
         optional :parameters, Sentdm::Internal::Type::HashOf[String], nil?: true
 
         # @!method initialize(id: nil, name: nil, parameters: nil)
-        #   Template reference (by id or name, with optional parameters)
+        #   SDK-style template reference: resolve by ID or by name, with optional
+        #   parameters.
         #
         #   @param id [String, nil] Template ID (mutually exclusive with name)
         #