sentdm 0.25.0 → 0.26.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 111f6ce63585f229c84c378ab652335418deb3d223e2277c6eabd45445bec7d0
-  data.tar.gz: 2f01db7d5893dcf369a867ee3d68fe7aa77ad72dc0da847f5fcbeafcd6168dbc
+  metadata.gz: ebdb5fd6a174b30850e1b33607c0c7acaa61fecae6564e0567d1f5ef1e957cc8
+  data.tar.gz: 830ae5cb38a33f35ff78031b19d31dac59f280a5fd48275e660d93fa4f54a457
 SHA512:
-  metadata.gz: 297ffd2f50d965d6dc2455c275dfed75f79ede3b1a85d509b75ff73ebd26e5f8c0bca0ea0facc8f14f5668cd399cf0790c60f874a538dad01f7bbb6a232b5096
-  data.tar.gz: ea87f1e165793385372a35114165a9e9385d2e1396cb61cb5fb04b9b65320c324afbca63b402b1c9a70d313ee146ec141a9ddca9b190b3c2a04acc367e5351e1
+  metadata.gz: 37b4f50c8af9746b8c2c1cd498715ce6f7dce3d765a60926a6cfcff9a43952045cb8c2938d0880968d803709f19751eb4f25baf5c8df83f949b1e56f9222d54e
+  data.tar.gz: 616928315abcb21dfcb69ba3011d1a61b0583982c552d8102d5a0812a0482e6ed75fcd0073586a666ff95fbfd4bba8ad86895766b21c5f2a68208b0b3d37a26a

data/CHANGELOG.md

@@ -1,5 +1,17 @@
 # Changelog
 
+## [0.26.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.25.0...v0.26.0) (2026-08-08)
+
+
+### Features
+
+* **api:** sync OpenAPI spec from production ([2a92d9a](https://github.com/sentdm/sent-dm-ruby/commit/2a92d9a1b29d11d5e4bc57e8119a50b9710a90fe))
+
+
+### Chores
+
+* mark GitHub Releases as stable releases (prerelease: false) ([153cbe6](https://github.com/sentdm/sent-dm-ruby/commit/153cbe6938b8bc6ad8f593b43103982ffa716148))
+
 ## [0.25.0](https://github.com/sentdm/sent-dm-ruby/compare/v0.24.0...v0.25.0) (2026-07-07)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "sentdm", "~> 0.24.0"
+gem "sentdm", "~> 0.26.0"
 ```
 
 <!-- x-release-please-end -->
@@ -262,25 +262,21 @@ Since this library does not depend on `sorbet-runtime`, it cannot provide [`T::E
 
 ```ruby
 # :PRIVATE_PROFIT
-puts(
-  Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT
-)
+puts(Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT)
 
-# Revealed type: `T.all(Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, Symbol)`
-T.reveal_type(
-  Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT
-)
+# Revealed type: `T.all(Sentdm::BrandBusinessInfo::EntityType, Symbol)`
+T.reveal_type(Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT)
 ```
 
 Enum parameters have a "relaxed" type, so you can either pass in enum constants or their literal value:
 
 ```ruby
-Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo.new(
-  entity_type: Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType::PRIVATE_PROFIT,
+Sentdm::BrandBusinessInfo.new(
+  entity_type: Sentdm::BrandBusinessInfo::EntityType::PRIVATE_PROFIT,
   # …
 )
 
-Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo.new(
+Sentdm::BrandBusinessInfo.new(
   entity_type: :PRIVATE_PROFIT,
   # …
 )

data/lib/sentdm/client.rb

@@ -48,6 +48,9 @@ module Sentdm
     # @return [Sentdm::Resources::Contacts]
     attr_reader :contacts
 
+    # @return [Sentdm::Resources::Conversations]
+    attr_reader :conversations
+
     # Retrieve account details
     # @return [Sentdm::Resources::Me]
     attr_reader :me
@@ -120,6 +123,7 @@ module Sentdm
       @numbers = Sentdm::Resources::Numbers.new(client: self)
       @messages = Sentdm::Resources::Messages.new(client: self)
       @contacts = Sentdm::Resources::Contacts.new(client: self)
+      @conversations = Sentdm::Resources::Conversations.new(client: self)
       @me = Sentdm::Resources::Me.new(client: self)
     end
   end

data/lib/sentdm/models/api_response_of_contact_message_summary.rb

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

data/lib/sentdm/models/api_response_of_conversation_messages_list.rb

@@ -0,0 +1,43 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Conversations#list
+    class APIResponseOfConversationMessagesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute data
+      #   A paginated list of messages — used by both conversation read endpoints.
+      #
+      #   @return [Sentdm::Models::ConversationMessagesList, nil]
+      optional :data, -> { Sentdm::ConversationMessagesList }, nil?: true
+
+      # @!attribute error
+      #   Error information
+      #
+      #   @return [Sentdm::Models::ErrorDetail, nil]
+      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+
+      # @!attribute meta
+      #   Request and response metadata
+      #
+      #   @return [Sentdm::Models::APIMeta, nil]
+      optional :meta, -> { Sentdm::APIMeta }
+
+      # @!attribute success
+      #   Indicates whether the request was successful
+      #
+      #   @return [Boolean, nil]
+      optional :success, Sentdm::Internal::Type::Boolean
+
+      # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
+      #   Standard API response envelope for all v3 endpoints
+      #
+      #   @param data [Sentdm::Models::ConversationMessagesList, nil] A paginated list of messages — used by both conversation read endpoints.
+      #
+      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #
+      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #
+      #   @param success [Boolean] Indicates whether the request was successful
+    end
+  end
+end

data/lib/sentdm/models/{sent_dm_services_common_contracts_poc_os_authentication_config.rb → authentication_config.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class SentDmServicesCommonContractsPocOsAuthenticationConfig < Sentdm::Internal::Type::BaseModel
+    class AuthenticationConfig < Sentdm::Internal::Type::BaseModel
       # @!attribute add_security_recommendation
       #   Whether to add the security recommendation text: "For your security, do not
       #   share this code."
@@ -21,8 +21,7 @@ module Sentdm
 
       # @!method initialize(add_security_recommendation: nil, code_expiration_minutes: nil)
       #   Some parameter documentations has been truncated, see
-      #   {Sentdm::Models::SentDmServicesCommonContractsPocOsAuthenticationConfig} for
-      #   more details.
+      #   {Sentdm::Models::AuthenticationConfig} for more details.
       #
       #   Configuration for AUTHENTICATION category templates
       #

data/lib/sentdm/models/{sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_business_info.rb → brand_business_info.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo < Sentdm::Internal::Type::BaseModel
+    class BrandBusinessInfo < Sentdm::Internal::Type::BaseModel
       # @!attribute city
       #   City
       #
@@ -23,11 +23,9 @@ module Sentdm
 
       # @!attribute entity_type
       #
-      #   @return [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
+      #   @return [Symbol, Sentdm::Models::BrandBusinessInfo::EntityType, nil]
       optional :entity_type,
-               enum: -> {
-                 Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType
-               },
+               enum: -> { Sentdm::BrandBusinessInfo::EntityType },
                api_name: :entityType,
                nil?: true
 
@@ -82,7 +80,7 @@ module Sentdm
       #
       #   @param country_of_registration [String, nil] Country where the business is registered
       #
-      #   @param entity_type [Symbol, Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo::EntityType, nil]
+      #   @param entity_type [Symbol, Sentdm::Models::BrandBusinessInfo::EntityType, nil]
       #
       #   @param legal_name [String, nil] Legal business name
       #
@@ -98,7 +96,7 @@ module Sentdm
       #
       #   @param url [String, nil] Business website URL
 
-      # @see Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo#entity_type
+      # @see Sentdm::Models::BrandBusinessInfo#entity_type
       module EntityType
         extend Sentdm::Internal::Type::Enum
 

data/lib/sentdm/models/{sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_compliance_info.rb → brand_compliance_info.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo < Sentdm::Internal::Type::BaseModel
+    class BrandComplianceInfo < Sentdm::Internal::Type::BaseModel
       # @!attribute brand_relationship
       #
       #   @return [Symbol, Sentdm::Models::TcrBrandRelationship]
@@ -22,12 +22,6 @@ module Sentdm
                api_name: :destinationCountries,
                nil?: true
 
-      # @!attribute expected_messaging_volume
-      #   Expected daily messaging volume
-      #
-      #   @return [String, nil]
-      optional :expected_messaging_volume, String, api_name: :expectedMessagingVolume, nil?: true
-
       # @!attribute is_tcr_application
       #   Whether this is a TCR (Campaign Registry) application
       #
@@ -52,7 +46,7 @@ module Sentdm
       #   @return [String, nil]
       optional :primary_use_case, String, api_name: :primaryUseCase, nil?: true
 
-      # @!method initialize(brand_relationship:, vertical:, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil)
+      # @!method initialize(brand_relationship:, vertical:, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil)
       #   Compliance and TCR information for brand registration
       #
       #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship]
@@ -61,8 +55,6 @@ module Sentdm
       #
       #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>, nil] List of destination countries for messaging
       #
-      #   @param expected_messaging_volume [String, nil] Expected daily messaging volume
-      #
       #   @param is_tcr_application [Boolean, nil] Whether this is a TCR (Campaign Registry) application
       #
       #   @param notes [String, nil] Additional notes about the business or use case

data/lib/sentdm/models/{sent_dm_services_endpoints_customer_ap_iv3_contracts_requests_brands_brand_contact_info.rb → brand_contact_info.rb}

@@ -2,7 +2,7 @@
 
 module Sentdm
   module Models
-    class SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo < Sentdm::Internal::Type::BaseModel
+    class BrandContactInfo < Sentdm::Internal::Type::BaseModel
       # @!attribute name
       #   Primary contact name (required)
       #

data/lib/sentdm/models/brands_brand_data.rb

@@ -6,33 +6,29 @@ module Sentdm
       # @!attribute compliance
       #   Compliance and TCR information for brand registration
       #
-      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo]
-      required :compliance,
-               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandComplianceInfo }
+      #   @return [Sentdm::Models::BrandComplianceInfo]
+      required :compliance, -> { Sentdm::BrandComplianceInfo }
 
       # @!attribute contact
       #   Contact information for brand KYC
       #
-      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo]
-      required :contact,
-               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo }
+      #   @return [Sentdm::Models::BrandContactInfo]
+      required :contact, -> { Sentdm::BrandContactInfo }
 
       # @!attribute business
       #   Business details and address for brand KYC
       #
-      #   @return [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil]
-      optional :business,
-               -> { Sentdm::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo },
-               nil?: true
+      #   @return [Sentdm::Models::BrandBusinessInfo, nil]
+      optional :business, -> { Sentdm::BrandBusinessInfo }, nil?: true
 
       # @!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 information for brand registration
+      #   @param compliance [Sentdm::Models::BrandComplianceInfo] Compliance and TCR information for brand registration
       #
-      #   @param contact [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandContactInfo] Contact information for brand KYC
+      #   @param contact [Sentdm::Models::BrandContactInfo] Contact information for brand KYC
       #
-      #   @param business [Sentdm::Models::SentDmServicesEndpointsCustomerApIv3ContractsRequestsBrandsBrandBusinessInfo, nil] Business details and address for brand KYC
+      #   @param business [Sentdm::Models::BrandBusinessInfo, nil] Business details and address for brand KYC
     end
   end
 end

data/lib/sentdm/models/contact_message_summary.rb

@@ -0,0 +1,76 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ContactMessageSummary < Sentdm::Internal::Type::BaseModel
+      # @!attribute channel_scores
+      #
+      #   @return [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>, nil]
+      optional :channel_scores,
+               -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ContactMessageSummary::ChannelScore] }
+
+      # @!attribute channels_used
+      #
+      #   @return [Array<String>, nil]
+      optional :channels_used, Sentdm::Internal::Type::ArrayOf[String]
+
+      # @!attribute contact_id
+      #
+      #   @return [String, nil]
+      optional :contact_id, String
+
+      # @!attribute first_message_at
+      #
+      #   @return [Time, nil]
+      optional :first_message_at, Time, nil?: true
+
+      # @!attribute last_message_at
+      #
+      #   @return [Time, nil]
+      optional :last_message_at, Time, nil?: true
+
+      # @!attribute message_count
+      #
+      #   @return [Integer, nil]
+      optional :message_count, Integer
+
+      # @!method initialize(channel_scores: nil, channels_used: nil, contact_id: nil, first_message_at: nil, last_message_at: nil, message_count: nil)
+      #   @param channel_scores [Array<Sentdm::Models::ContactMessageSummary::ChannelScore>]
+      #   @param channels_used [Array<String>]
+      #   @param contact_id [String]
+      #   @param first_message_at [Time, nil]
+      #   @param last_message_at [Time, nil]
+      #   @param message_count [Integer]
+
+      class ChannelScore < Sentdm::Internal::Type::BaseModel
+        # @!attribute channel
+        #
+        #   @return [String, nil]
+        optional :channel, String
+
+        # @!attribute fail_score
+        #   Percentage (0-100) of messages on this channel that ended in FAILED.
+        #
+        #   @return [Integer, nil]
+        optional :fail_score, Integer
+
+        # @!attribute success_score
+        #   Percentage (0-100) of messages on this channel that reached a successful
+        #   terminal state: SENT/DELIVERED/READ for outbound, RECEIVED for inbound.
+        #
+        #   @return [Integer, nil]
+        optional :success_score, Integer
+
+        # @!method initialize(channel: nil, fail_score: nil, success_score: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ContactMessageSummary::ChannelScore} for more details.
+        #
+        #   @param channel [String]
+        #
+        #   @param fail_score [Integer] Percentage (0-100) of messages on this channel that ended in FAILED.
+        #
+        #   @param success_score [Integer] Percentage (0-100) of messages on this channel that reached a successful termina
+      end
+    end
+  end
+end

data/lib/sentdm/models/contact_retrieve_message_summary_params.rb

@@ -0,0 +1,26 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Contacts#retrieve_message_summary
+    class ContactRetrieveMessageSummaryParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute contact_id
+      #
+      #   @return [String]
+      required :contact_id, String
+
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(contact_id:, x_profile_id: nil, request_options: {})
+      #   @param contact_id [String]
+      #   @param x_profile_id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/conversation_list_messages_params.rb

@@ -0,0 +1,38 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Conversations#list_messages
+    class ConversationListMessagesParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute id
+      #
+      #   @return [String]
+      required :id, String
+
+      # @!attribute page
+      #
+      #   @return [Integer]
+      required :page, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(id:, page:, page_size:, x_profile_id: nil, request_options: {})
+      #   @param id [String]
+      #   @param page [Integer]
+      #   @param page_size [Integer]
+      #   @param x_profile_id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end

data/lib/sentdm/models/conversation_list_params.rb

@@ -0,0 +1,32 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    # @see Sentdm::Resources::Conversations#list
+    class ConversationListParams < Sentdm::Internal::Type::BaseModel
+      extend Sentdm::Internal::Type::RequestParameters::Converter
+      include Sentdm::Internal::Type::RequestParameters
+
+      # @!attribute page
+      #
+      #   @return [Integer]
+      required :page, Integer
+
+      # @!attribute page_size
+      #
+      #   @return [Integer]
+      required :page_size, Integer
+
+      # @!attribute x_profile_id
+      #
+      #   @return [String, nil]
+      optional :x_profile_id, String
+
+      # @!method initialize(page:, page_size:, x_profile_id: nil, request_options: {})
+      #   @param page [Integer]
+      #   @param page_size [Integer]
+      #   @param x_profile_id [String]
+      #   @param request_options [Sentdm::RequestOptions, Hash{Symbol=>Object}]
+    end
+  end
+end