sentdm 0.26.0 → 0.28.0

data/lib/sentdm/models/message_retrieve_status_response.rb

@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+      #   @return [Sentdm::Models::MessageRetrieveStatusResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::MessageRetrieveStatusResponse::Error }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
+      #   @return [Sentdm::Models::MessageRetrieveStatusResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::MessageRetrieveStatusResponse::Meta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -33,9 +33,9 @@ module Sentdm
       #
       #   @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::ErrorDetail, nil] Error information
+      #   @param error [Sentdm::Models::MessageRetrieveStatusResponse::Error, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #   @param meta [Sentdm::Models::MessageRetrieveStatusResponse::Meta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -258,6 +258,74 @@ module Sentdm
           end
         end
       end
+
+      # @see Sentdm::Models::MessageRetrieveStatusResponse#error
+      class Error < 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
+
+      # @see Sentdm::Models::MessageRetrieveStatusResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!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, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
+      end
     end
   end
 end

data/lib/sentdm/models/message_send_response.rb

@@ -5,7 +5,16 @@ module Sentdm
     # @see Sentdm::Resources::Messages#send_
     class MessageSendResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   Response for the multi-recipient send message endpoint
+      #   The result of a multi-recipient send.
+      #
+      #   Declared here rather than in the service layer. POST /v3/messages used to
+      #   publish MessageSendResult — a type in Common.Services.Messaging.Contracts — so
+      #   the public contract was whatever the send service happened to return, and
+      #   changing that service for an internal reason changed the API. The service keeps
+      #   its result; this is what a caller sees, and the mapping between them is a
+      #   decision the endpoint makes.
+      #
+      #   The wire is unchanged by the move: same names, same values.
       #
       #   @return [Sentdm::Models::MessageSendResponse::Data, nil]
       optional :data, -> { Sentdm::Models::MessageSendResponse::Data }, nil?: true
@@ -13,14 +22,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+      #   @return [Sentdm::Models::MessageSendResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::MessageSendResponse::Error }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
+      #   @return [Sentdm::Models::MessageSendResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::MessageSendResponse::Meta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -29,77 +38,85 @@ 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::MessageSendResponse} for more details.
+      #
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::MessageSendResponse::Data, nil] Response for the multi-recipient send message endpoint
+      #   @param data [Sentdm::Models::MessageSendResponse::Data, nil] The result of a multi-recipient send.
       #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #   @param error [Sentdm::Models::MessageSendResponse::Error, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #   @param meta [Sentdm::Models::MessageSendResponse::Meta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
       # @see Sentdm::Models::MessageSendResponse#data
       class Data < Sentdm::Internal::Type::BaseModel
         # @!attribute recipients
-        #   Per-recipient message results
         #
         #   @return [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>, nil]
         optional :recipients,
                  -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageSendResponse::Data::Recipient] }
 
         # @!attribute status
-        #   Overall request status: "QUEUED" when the batch has been accepted for delivery.
+        #   Overall status — QUEUED once the batch is accepted for delivery.
         #
         #   @return [String, nil]
         optional :status, String
 
         # @!attribute template_id
-        #   Template ID that was used
         #
         #   @return [String, nil]
         optional :template_id, String
 
         # @!attribute template_name
-        #   Template display name
         #
         #   @return [String, nil]
         optional :template_name, String
 
         # @!method initialize(recipients: nil, status: nil, template_id: nil, template_name: nil)
-        #   Response for the multi-recipient send message endpoint
+        #   The result of a multi-recipient send.
+        #
+        #   Declared here rather than in the service layer. POST /v3/messages used to
+        #   publish MessageSendResult — a type in Common.Services.Messaging.Contracts — so
+        #   the public contract was whatever the send service happened to return, and
+        #   changing that service for an internal reason changed the API. The service keeps
+        #   its result; this is what a caller sees, and the mapping between them is a
+        #   decision the endpoint makes.
+        #
+        #   The wire is unchanged by the move: same names, same values.
         #
-        #   @param recipients [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>] Per-recipient message results
+        #   @param recipients [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>]
         #
-        #   @param status [String] Overall request status: "QUEUED" when the batch has been accepted for delivery.
+        #   @param status [String] Overall status — QUEUED once the batch is accepted for delivery.
         #
-        #   @param template_id [String] Template ID that was used
+        #   @param template_id [String]
         #
-        #   @param template_name [String] Template display name
+        #   @param template_name [String]
 
         class Recipient < Sentdm::Internal::Type::BaseModel
           # @!attribute body
-          #   Resolved template body text for this recipient's channel, or null for
-          #   auto-detect
+          #   Resolved template body for this recipient's channel, or null when the channel is
+          #   auto-detected.
           #
           #   @return [String, nil]
           optional :body, String, nil?: true
 
           # @!attribute channel
-          #   Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for
-          #   auto-detect
+          #   Channel this message will be sent on — sms, whatsapp — or null to auto-detect.
           #
           #   @return [String, nil]
           optional :channel, String, nil?: true
 
           # @!attribute message_id
-          #   Unique message identifier for tracking this recipient's message
+          #   Identifier for tracking this recipient's message.
           #
           #   @return [String, nil]
           optional :message_id, String
 
           # @!attribute to
-          #   Phone number in E.164 format
+          #   Phone number in E.164 format.
           #
           #   @return [String, nil]
           optional :to, String
@@ -108,17 +125,85 @@ module Sentdm
           #   Some parameter documentations has been truncated, see
           #   {Sentdm::Models::MessageSendResponse::Data::Recipient} for more details.
           #
-          #   Per-recipient result in the send message response
+          #   What one recipient of a send got, as the API reports it.
           #
-          #   @param body [String, nil] Resolved template body text for this recipient's channel, or null for auto-detec
+          #   @param body [String, nil] Resolved template body for this recipient's channel, or null when the channel is
           #
-          #   @param channel [String, nil] Channel this message will be sent on (e.g. "sms", "whatsapp"), or null for auto-
+          #   @param channel [String, nil] Channel this message will be sent on — sms, whatsapp — or null to auto-detect.
           #
-          #   @param message_id [String] Unique message identifier for tracking this recipient's message
+          #   @param message_id [String] Identifier for tracking this recipient's message.
           #
-          #   @param to [String] Phone number in E.164 format
+          #   @param to [String] Phone number in E.164 format.
         end
       end
+
+      # @see Sentdm::Models::MessageSendResponse#error
+      class Error < 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
+
+      # @see Sentdm::Models::MessageSendResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!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, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
+      end
     end
   end
 end

data/lib/sentdm/models/number_lookup_response.rb

@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+      #   @return [Sentdm::Models::NumberLookupResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::NumberLookupResponse::Error }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
+      #   @return [Sentdm::Models::NumberLookupResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::NumberLookupResponse::Meta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -33,9 +33,9 @@ module Sentdm
       #
       #   @param data [Sentdm::Models::NumberLookupResponse::Data, nil] The response data (null if error)
       #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #   @param error [Sentdm::Models::NumberLookupResponse::Error, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #   @param meta [Sentdm::Models::NumberLookupResponse::Meta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -99,6 +99,74 @@ module Sentdm
         #   @param mobile_network_code [String, nil]
         #   @param phone_number [String]
       end
+
+      # @see Sentdm::Models::NumberLookupResponse#error
+      class Error < 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
+
+      # @see Sentdm::Models::NumberLookupResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!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, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
+      end
     end
   end
 end

data/lib/sentdm/models/profile_complete_response.rb

@@ -14,14 +14,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+      #   @return [Sentdm::Models::ProfileCompleteResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::ProfileCompleteResponse::Error }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
+      #   @return [Sentdm::Models::ProfileCompleteResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::ProfileCompleteResponse::Meta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -37,9 +37,9 @@ module Sentdm
       #
       #   @param data [Sentdm::Models::ProfileCompleteResponse::Data, nil] Response when a profile is already in the completed state and no further action
       #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #   @param error [Sentdm::Models::ProfileCompleteResponse::Error, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #   @param meta [Sentdm::Models::ProfileCompleteResponse::Meta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -69,6 +69,74 @@ module Sentdm
         #
         #   @param status [String] Current process status of the profile (e.g., "completed", "submitted", "in_progr
       end
+
+      # @see Sentdm::Models::ProfileCompleteResponse#error
+      class Error < 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
+
+      # @see Sentdm::Models::ProfileCompleteResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!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, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
+      end
     end
   end
 end