sentdm 0.7.0 → 0.9.0

data/lib/sentdm/resources/profiles.rb

@@ -54,11 +54,11 @@ module Sentdm
       #
       # @param allow_template_sharing [Boolean] Body param: Whether templates are shared across profiles (default: false)
       #
-      # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact for this profile. Required when billing_model is "pr
+      # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact information for a profile.
       #
       # @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (d
       #
-      # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC information for this profile (optional).
+      # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC data grouped into contact, business, and compliance se
       #
       # @param description [String, nil] Body param: Profile description (optional)
       #
@@ -74,13 +74,13 @@ module Sentdm
       #
       # @param name [String] Body param: Profile name (required)
       #
-      # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for this profile (optional).
+      # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for a profile.
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
       # @param short_name [String, nil] Body param: Profile short name/abbreviation (optional). Must be 3–11 characters,
       #
-      # @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Body param: Direct WhatsApp Business Account credentials for this profile.
+      # @param whatsapp_business_account [Sentdm::Models::ProfileCreateParams::WhatsappBusinessAccount, nil] Body param: Direct WhatsApp Business Account credentials for a profile.
       #
       # @param idempotency_key [String] Header param: Unique key to ensure idempotent request processing. Must be 1-255
       #
@@ -165,11 +165,11 @@ module Sentdm
       #
       # @param allow_template_sharing [Boolean, nil] Body param: Whether templates are shared across profiles (optional)
       #
-      # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact for this profile. Required when billing_model is "pr
+      # @param billing_contact [Sentdm::Models::BillingContactInfo, nil] Body param: Billing contact information for a profile.
       #
       # @param billing_model [String, nil] Body param: Billing model: profile, organization, or profile_and_organization (o
       #
-      # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC information for this profile (optional).
+      # @param brand [Sentdm::Models::BrandsBrandData, nil] Body param: Brand and KYC data grouped into contact, business, and compliance se
       #
       # @param description [String, nil] Body param: Profile description (optional)
       #
@@ -185,7 +185,7 @@ module Sentdm
       #
       # @param name [String, nil] Body param: Profile name (optional)
       #
-      # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for this profile (optional).
+      # @param payment_details [Sentdm::Models::PaymentDetails, nil] Body param: Payment card details for a profile.
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
@@ -281,7 +281,7 @@ module Sentdm
       end
 
       # Some parameter documentations has been truncated, see
-      # {Sentdm::Models::ProfileCompleteSetupParams} for more details.
+      # {Sentdm::Models::ProfileCompleteParams} for more details.
       #
       # Final step in profile compliance workflow. Validates all prerequisites (general
       # data, brand, campaigns), connects profile to Telnyx/WhatsApp, and sets status
@@ -302,7 +302,7 @@ module Sentdm
       #                 - If non-TCR with destination country (IsMain=true) → SUBMITTED
       #                 - Otherwise → COMPLETED
       #
-      # @overload complete_setup(profile_id, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
+      # @overload complete(profile_id, web_hook_url:, sandbox: nil, idempotency_key: nil, x_profile_id: nil, request_options: {})
       #
       # @param profile_id [String] Path param: Profile ID from route
       #
@@ -318,9 +318,9 @@ module Sentdm
       #
       # @return [Object]
       #
-      # @see Sentdm::Models::ProfileCompleteSetupParams
-      def complete_setup(profile_id, params)
-        parsed, options = Sentdm::ProfileCompleteSetupParams.dump_request(params)
+      # @see Sentdm::Models::ProfileCompleteParams
+      def complete(profile_id, params)
+        parsed, options = Sentdm::ProfileCompleteParams.dump_request(params)
         header_params = {idempotency_key: "idempotency-key", x_profile_id: "x-profile-id"}
         @client.request(
           method: :post,

data/lib/sentdm/resources/templates.rb

@@ -17,7 +17,7 @@ module Sentdm
       #
       # @param creation_source [String, nil] Body param: Source of template creation (default: from-api)
       #
-      # @param definition [Sentdm::Models::TemplateDefinition] Body param: Template definition including header, body, footer, and buttons
+      # @param definition [Sentdm::Models::TemplateDefinition] Body param: Complete definition of a message template including header, body, fo
       #
       # @param language [String, nil] Body param: Template language code (e.g., en_US) (optional, auto-detected if not
       #
@@ -87,7 +87,7 @@ module Sentdm
       #
       # @param category [String, nil] Body param: Template category: MARKETING, UTILITY, AUTHENTICATION
       #
-      # @param definition [Sentdm::Models::TemplateDefinition, nil] Body param: Template definition including header, body, footer, and buttons
+      # @param definition [Sentdm::Models::TemplateDefinition, nil] Body param: Complete definition of a message template including header, body, fo
       #
       # @param language [String, nil] Body param: Template language code (e.g., en_US)
       #

data/lib/sentdm/version.rb

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

data/lib/sentdm.rb

@@ -52,9 +52,8 @@ 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_base"
-require_relative "sentdm/models/base_dto"
-require_relative "sentdm/models/api_error"
+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"
@@ -71,6 +70,7 @@ require_relative "sentdm/models/contact_response"
 require_relative "sentdm/models/contact_retrieve_params"
 require_relative "sentdm/models/contact_update_params"
 require_relative "sentdm/models/destination_country"
+require_relative "sentdm/models/error_detail"
 require_relative "sentdm/models/me_retrieve_params"
 require_relative "sentdm/models/me_retrieve_response"
 require_relative "sentdm/models/message_retrieve_activities_params"
@@ -83,8 +83,8 @@ 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_setup_params"
-require_relative "sentdm/models/profile_complete_setup_response"
+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_delete_params"
 require_relative "sentdm/models/profile_detail"

data/rbi/sentdm/models/api_response_of_contact.rbi

@@ -8,21 +8,21 @@ module Sentdm
           T.any(Sentdm::APIResponseOfContact, Sentdm::Internal::AnyHash)
         end
 
-      # The response data (null if error)
+      # Contact response for v3 API Uses snake_case for JSON property names
       sig { returns(T.nilable(Sentdm::ContactResponse)) }
       attr_reader :data
 
       sig { params(data: T.nilable(Sentdm::ContactResponse::OrHash)).void }
       attr_writer :data
 
-      # Error details (null if successful)
-      sig { returns(T.nilable(Sentdm::APIError)) }
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -40,17 +40,17 @@ module Sentdm
       sig do
         params(
           data: T.nilable(Sentdm::ContactResponse::OrHash),
-          error: T.nilable(Sentdm::APIError::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
           meta: Sentdm::APIMeta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        # The response data (null if error)
+        # Contact response for v3 API Uses snake_case for JSON property names
         data: nil,
-        # Error details (null if successful)
+        # Error information
         error: nil,
-        # Metadata about the request and response
+        # Request and response metadata
         meta: nil,
         # Indicates whether the request was successful
         success: nil
@@ -61,7 +61,7 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::ContactResponse),
-            error: T.nilable(Sentdm::APIError),
+            error: T.nilable(Sentdm::ErrorDetail),
             meta: Sentdm::APIMeta,
             success: T::Boolean
           }

data/rbi/sentdm/models/api_response_of_profile_detail.rbi

@@ -8,21 +8,21 @@ module Sentdm
           T.any(Sentdm::APIResponseOfProfileDetail, Sentdm::Internal::AnyHash)
         end
 
-      # The response data (null if error)
+      # Detailed profile response for v3 API
       sig { returns(T.nilable(Sentdm::ProfileDetail)) }
       attr_reader :data
 
       sig { params(data: T.nilable(Sentdm::ProfileDetail::OrHash)).void }
       attr_writer :data
 
-      # Error details (null if successful)
-      sig { returns(T.nilable(Sentdm::APIError)) }
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -40,17 +40,17 @@ module Sentdm
       sig do
         params(
           data: T.nilable(Sentdm::ProfileDetail::OrHash),
-          error: T.nilable(Sentdm::APIError::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
           meta: Sentdm::APIMeta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        # The response data (null if error)
+        # Detailed profile response for v3 API
         data: nil,
-        # Error details (null if successful)
+        # Error information
         error: nil,
-        # Metadata about the request and response
+        # Request and response metadata
         meta: nil,
         # Indicates whether the request was successful
         success: nil
@@ -61,7 +61,7 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::ProfileDetail),
-            error: T.nilable(Sentdm::APIError),
+            error: T.nilable(Sentdm::ErrorDetail),
             meta: Sentdm::APIMeta,
             success: T::Boolean
           }

data/rbi/sentdm/models/api_response_of_user.rbi

@@ -8,21 +8,21 @@ module Sentdm
           T.any(Sentdm::APIResponseOfUser, Sentdm::Internal::AnyHash)
         end
 
-      # The response data (null if error)
+      # User response for v3 API
       sig { returns(T.nilable(Sentdm::UserResponse)) }
       attr_reader :data
 
       sig { params(data: T.nilable(Sentdm::UserResponse::OrHash)).void }
       attr_writer :data
 
-      # Error details (null if successful)
-      sig { returns(T.nilable(Sentdm::APIError)) }
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -40,17 +40,17 @@ module Sentdm
       sig do
         params(
           data: T.nilable(Sentdm::UserResponse::OrHash),
-          error: T.nilable(Sentdm::APIError::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
           meta: Sentdm::APIMeta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        # The response data (null if error)
+        # User response for v3 API
         data: nil,
-        # Error details (null if successful)
+        # Error information
         error: nil,
-        # Metadata about the request and response
+        # Request and response metadata
         meta: nil,
         # Indicates whether the request was successful
         success: nil
@@ -61,7 +61,7 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::UserResponse),
-            error: T.nilable(Sentdm::APIError),
+            error: T.nilable(Sentdm::ErrorDetail),
             meta: Sentdm::APIMeta,
             success: T::Boolean
           }

data/rbi/sentdm/models/api_response_template.rbi

@@ -8,21 +8,21 @@ module Sentdm
           T.any(Sentdm::APIResponseTemplate, Sentdm::Internal::AnyHash)
         end
 
-      # The response data (null if error)
+      # Template response for v3 API
       sig { returns(T.nilable(Sentdm::Template)) }
       attr_reader :data
 
       sig { params(data: T.nilable(Sentdm::Template::OrHash)).void }
       attr_writer :data
 
-      # Error details (null if successful)
-      sig { returns(T.nilable(Sentdm::APIError)) }
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -40,17 +40,17 @@ module Sentdm
       sig do
         params(
           data: T.nilable(Sentdm::Template::OrHash),
-          error: T.nilable(Sentdm::APIError::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
           meta: Sentdm::APIMeta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        # The response data (null if error)
+        # Template response for v3 API
         data: nil,
-        # Error details (null if successful)
+        # Error information
         error: nil,
-        # Metadata about the request and response
+        # Request and response metadata
         meta: nil,
         # Indicates whether the request was successful
         success: nil
@@ -61,7 +61,7 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::Template),
-            error: T.nilable(Sentdm::APIError),
+            error: T.nilable(Sentdm::ErrorDetail),
             meta: Sentdm::APIMeta,
             success: T::Boolean
           }

data/rbi/sentdm/models/api_response_webhook.rbi

@@ -15,14 +15,14 @@ module Sentdm
       sig { params(data: T.nilable(Sentdm::WebhookResponse::OrHash)).void }
       attr_writer :data
 
-      # Error details (null if successful)
-      sig { returns(T.nilable(Sentdm::APIError)) }
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -40,7 +40,7 @@ module Sentdm
       sig do
         params(
           data: T.nilable(Sentdm::WebhookResponse::OrHash),
-          error: T.nilable(Sentdm::APIError::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
           meta: Sentdm::APIMeta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
@@ -48,9 +48,9 @@ module Sentdm
       def self.new(
         # The response data (null if error)
         data: nil,
-        # Error details (null if successful)
+        # Error information
         error: nil,
-        # Metadata about the request and response
+        # Request and response metadata
         meta: nil,
         # Indicates whether the request was successful
         success: nil
@@ -61,7 +61,7 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::WebhookResponse),
-            error: T.nilable(Sentdm::APIError),
+            error: T.nilable(Sentdm::ErrorDetail),
             meta: Sentdm::APIMeta,
             success: T::Boolean
           }

data/rbi/sentdm/models/brands_brand_data.rbi

@@ -8,7 +8,7 @@ module Sentdm
           T.any(Sentdm::BrandsBrandData, Sentdm::Internal::AnyHash)
         end
 
-      # Compliance and TCR-related information
+      # Compliance and TCR information for brand registration
       sig do
         returns(
           Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo
@@ -24,7 +24,7 @@ module Sentdm
       end
       attr_writer :compliance
 
-      # Contact information for the brand
+      # Contact information for brand KYC
       sig do
         returns(
           Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo
@@ -40,7 +40,7 @@ module Sentdm
       end
       attr_writer :contact
 
-      # Business details and address information
+      # Business details and address for brand KYC
       sig do
         returns(
           T.nilable(
@@ -74,11 +74,11 @@ module Sentdm
         ).returns(T.attached_class)
       end
       def self.new(
-        # Compliance and TCR-related information
+        # Compliance and TCR information for brand registration
         compliance:,
-        # Contact information for the brand
+        # Contact information for brand KYC
         contact:,
-        # Business details and address information
+        # Business details and address for brand KYC
         business: nil
       )
       end

data/rbi/sentdm/models/contact_delete_params.rbi

@@ -57,7 +57,7 @@ module Sentdm
       def to_hash
       end
 
-      class Body < Sentdm::Models::MutationRequestBase
+      class Body < Sentdm::Models::MutationRequest
         OrHash =
           T.type_alias do
             T.any(Sentdm::ContactDeleteParams::Body, Sentdm::Internal::AnyHash)

data/rbi/sentdm/models/contact_list_response.rbi

@@ -8,7 +8,7 @@ module Sentdm
           T.any(Sentdm::Models::ContactListResponse, Sentdm::Internal::AnyHash)
         end
 
-      # The response data (null if error)
+      # Paginated list of contacts response
       sig { returns(T.nilable(Sentdm::Models::ContactListResponse::Data)) }
       attr_reader :data
 
@@ -19,14 +19,14 @@ module Sentdm
       end
       attr_writer :data
 
-      # Error details (null if successful)
-      sig { returns(T.nilable(Sentdm::APIError)) }
+      # Error information
+      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
+      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -44,17 +44,17 @@ module Sentdm
       sig do
         params(
           data: T.nilable(Sentdm::Models::ContactListResponse::Data::OrHash),
-          error: T.nilable(Sentdm::APIError::OrHash),
+          error: T.nilable(Sentdm::ErrorDetail::OrHash),
           meta: Sentdm::APIMeta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        # The response data (null if error)
+        # Paginated list of contacts response
         data: nil,
-        # Error details (null if successful)
+        # Error information
         error: nil,
-        # Metadata about the request and response
+        # Request and response metadata
         meta: nil,
         # Indicates whether the request was successful
         success: nil
@@ -65,7 +65,7 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::Models::ContactListResponse::Data),
-            error: T.nilable(Sentdm::APIError),
+            error: T.nilable(Sentdm::ErrorDetail),
             meta: Sentdm::APIMeta,
             success: T::Boolean
           }
@@ -90,14 +90,14 @@ module Sentdm
         sig { params(contacts: T::Array[Sentdm::ContactResponse::OrHash]).void }
         attr_writer :contacts
 
-        # Pagination metadata
+        # Pagination metadata for list responses
         sig { returns(T.nilable(Sentdm::PaginationMeta)) }
         attr_reader :pagination
 
         sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
         attr_writer :pagination
 
-        # The response data (null if error)
+        # Paginated list of contacts response
         sig do
           params(
             contacts: T::Array[Sentdm::ContactResponse::OrHash],
@@ -107,7 +107,7 @@ module Sentdm
         def self.new(
           # List of contacts
           contacts: nil,
-          # Pagination metadata
+          # Pagination metadata for list responses
           pagination: nil
         )
         end

data/rbi/sentdm/models/{api_error.rbi → error_detail.rbi}

@@ -2,9 +2,9 @@
 
 module Sentdm
   module Models
-    class APIError < Sentdm::Internal::Type::BaseModel
+    class ErrorDetail < Sentdm::Internal::Type::BaseModel
       OrHash =
-        T.type_alias { T.any(Sentdm::APIError, Sentdm::Internal::AnyHash) }
+        T.type_alias { T.any(Sentdm::ErrorDetail, Sentdm::Internal::AnyHash) }
 
       # Machine-readable error code (e.g., "RESOURCE_001")
       sig { returns(T.nilable(String)) }