sentdm 0.5.0 → 0.8.0

data/lib/sentdm/models.rb

@@ -53,8 +53,6 @@ module Sentdm
 
   APIResponseWebhook = Sentdm::Models::APIResponseWebhook
 
-  BaseDto = Sentdm::Models::BaseDto
-
   BillingContactInfo = Sentdm::Models::BillingContactInfo
 
   BrandsBrandData = Sentdm::Models::BrandsBrandData
@@ -81,7 +79,7 @@ module Sentdm
 
   MessageSendParams = Sentdm::Models::MessageSendParams
 
-  MutationRequestBase = Sentdm::Models::MutationRequestBase
+  MutationRequest = Sentdm::Models::MutationRequest
 
   NumberLookupParams = Sentdm::Models::NumberLookupParams
 
@@ -89,7 +87,7 @@ module Sentdm
 
   PaymentDetails = Sentdm::Models::PaymentDetails
 
-  ProfileCompleteSetupParams = Sentdm::Models::ProfileCompleteSetupParams
+  ProfileCompleteParams = Sentdm::Models::ProfileCompleteParams
 
   ProfileCreateParams = Sentdm::Models::ProfileCreateParams
 
@@ -107,6 +105,33 @@ module Sentdm
 
   ProfileUpdateParams = Sentdm::Models::ProfileUpdateParams
 
+  SentDmServicesCommonContractsPocOsAuthenticationConfig =
+    Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig
+
+  SentDmServicesCommonContractsPocOsTemplateBody =
+    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateBody
+
+  SentDmServicesCommonContractsPocOsTemplateButton =
+    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButton
+
+  SentDmServicesCommonContractsPocOsTemplateButtonProps =
+    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateButtonProps
+
+  SentDmServicesCommonContractsPocOsTemplateFooter =
+    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateFooter
+
+  SentDmServicesCommonContractsPocOsTemplateHeader =
+    Sentdm::Models::SentDmServicesCommonContractsPocOsTemplateHeader
+
+  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo =
+    Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo
+
+  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo =
+    Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo
+
+  SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo =
+    Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo
+
   TcrBrandRelationship = Sentdm::Models::TcrBrandRelationship
 
   TcrVertical = Sentdm::Models::TcrVertical

data/lib/sentdm/resources/messages.rb

@@ -75,7 +75,7 @@ module Sentdm
       #
       # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
       #
-      # @param template [Sentdm::Models::MessageSendParams::Template] Body param: Template reference (by id or name, with optional parameters)
+      # @param template [Sentdm::Models::MessageSendParams::Template] Body param: SDK-style template reference: resolve by ID or by name, with optiona
       #
       # @param to [Array<String>] Body param: List of recipient phone numbers in E.164 format (multi-recipient fan
       #

data/lib/sentdm/resources/profiles/campaigns.rb

@@ -15,7 +15,7 @@ module Sentdm
         #
         # @param profile_id [String] Path param: Profile ID from route
         #
-        # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data
+        # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data for create or update operation
         #
         # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
         #
@@ -53,7 +53,7 @@ module Sentdm
         #
         # @param profile_id [String] Path param: Profile ID from route
         #
-        # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data
+        # @param campaign [Sentdm::Models::Profiles::CampaignData] Body param: Campaign data for create or update operation
         #
         # @param sandbox [Boolean] Body param: Sandbox flag - when true, the operation is simulated without side ef
         #

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.5.0"
+  VERSION = "0.8.0"
 end

data/lib/sentdm.rb

@@ -52,8 +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/mutation_request"
+require_relative "sentdm/models/profiles/base_dto"
 require_relative "sentdm/models/api_error"
 require_relative "sentdm/models/api_meta"
 require_relative "sentdm/models/api_response_of_contact"
@@ -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"
@@ -99,9 +99,19 @@ require_relative "sentdm/models/profiles/campaign_list_params"
 require_relative "sentdm/models/profiles/campaign_list_response"
 require_relative "sentdm/models/profiles/campaign_update_params"
 require_relative "sentdm/models/profiles/messaging_use_case_us"
+require_relative "sentdm/models/profiles/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_campaigns_campaign_use_case_data"
 require_relative "sentdm/models/profiles/tcr_campaign_with_use_cases"
 require_relative "sentdm/models/profile_settings"
 require_relative "sentdm/models/profile_update_params"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_authentication_config"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_body"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_button"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_button_props"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_footer"
+require_relative "sentdm/models/sent_dm_services_common_contracts_poc_os_template_header"
+require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info"
+require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info"
+require_relative "sentdm/models/sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info"
 require_relative "sentdm/models/tcr_brand_relationship"
 require_relative "sentdm/models/tcr_vertical"
 require_relative "sentdm/models/template"

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)
+      # Error information
       sig { returns(T.nilable(Sentdm::APIError)) }
       attr_reader :error
 
       sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -46,11 +46,11 @@ module Sentdm
         ).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

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)
+      # Error information
       sig { returns(T.nilable(Sentdm::APIError)) }
       attr_reader :error
 
       sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -46,11 +46,11 @@ module Sentdm
         ).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

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)
+      # Error information
       sig { returns(T.nilable(Sentdm::APIError)) }
       attr_reader :error
 
       sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -46,11 +46,11 @@ module Sentdm
         ).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

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)
+      # Error information
       sig { returns(T.nilable(Sentdm::APIError)) }
       attr_reader :error
 
       sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -46,11 +46,11 @@ module Sentdm
         ).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

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)
+      # Error information
       sig { returns(T.nilable(Sentdm::APIError)) }
       attr_reader :error
 
       sig { params(error: T.nilable(Sentdm::APIError::OrHash)).void }
       attr_writer :error
 
-      # Metadata about the request and response
+      # Request and response metadata
       sig { returns(T.nilable(Sentdm::APIMeta)) }
       attr_reader :meta
 
@@ -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