sentdm 0.24.0 → 0.26.0

data/lib/sentdm/models/conversation_messages_list.rb

@@ -0,0 +1,245 @@
+# frozen_string_literal: true
+
+module Sentdm
+  module Models
+    class ConversationMessagesList < Sentdm::Internal::Type::BaseModel
+      # @!attribute messages
+      #   The messages on this page, most recent first.
+      #
+      #   @return [Array<Sentdm::Models::ConversationMessagesList::Message>, nil]
+      optional :messages, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message] }
+
+      # @!attribute pagination
+      #   Pagination metadata for list responses
+      #
+      #   @return [Sentdm::Models::PaginationMeta, nil]
+      optional :pagination, -> { Sentdm::PaginationMeta }
+
+      # @!method initialize(messages: nil, pagination: nil)
+      #   A paginated list of messages — used by both conversation read endpoints.
+      #
+      #   @param messages [Array<Sentdm::Models::ConversationMessagesList::Message>] The messages on this page, most recent first.
+      #
+      #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+
+      class Message < Sentdm::Internal::Type::BaseModel
+        # @!attribute id
+        #
+        #   @return [String, nil]
+        optional :id, String
+
+        # @!attribute active_contact_price
+        #
+        #   @return [Float, nil]
+        optional :active_contact_price, Float, nil?: true
+
+        # @!attribute channel
+        #
+        #   @return [String, nil]
+        optional :channel, String
+
+        # @!attribute contact_id
+        #
+        #   @return [String, nil]
+        optional :contact_id, String
+
+        # @!attribute created_at
+        #
+        #   @return [Time, nil]
+        optional :created_at, Time
+
+        # @!attribute customer_id
+        #
+        #   @return [String, nil]
+        optional :customer_id, String
+
+        # @!attribute direction
+        #
+        #   @return [String, nil]
+        optional :direction, String
+
+        # @!attribute events
+        #
+        #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
+        optional :events,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::Event] },
+                 nil?: true
+
+        # @!attribute message_body
+        #   Structured message body format for database storage. Preserves channel-specific
+        #   components (header, body, footer, buttons).
+        #
+        #   @return [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil]
+        optional :message_body, -> { Sentdm::ConversationMessagesList::Message::MessageBody }, nil?: true
+
+        # @!attribute phone
+        #
+        #   @return [String, nil]
+        optional :phone, String
+
+        # @!attribute phone_international
+        #
+        #   @return [String, nil]
+        optional :phone_international, String
+
+        # @!attribute price
+        #
+        #   @return [Float, nil]
+        optional :price, Float, nil?: true
+
+        # @!attribute region_code
+        #
+        #   @return [String, nil]
+        optional :region_code, String
+
+        # @!attribute status
+        #
+        #   @return [String, nil]
+        optional :status, String
+
+        # @!attribute template_category
+        #
+        #   @return [String, nil]
+        optional :template_category, String, nil?: true
+
+        # @!attribute template_id
+        #
+        #   @return [String, nil]
+        optional :template_id, String, nil?: true
+
+        # @!attribute template_name
+        #
+        #   @return [String, nil]
+        optional :template_name, String, nil?: true
+
+        # @!method initialize(id: nil, active_contact_price: nil, channel: nil, contact_id: nil, created_at: nil, customer_id: nil, direction: nil, events: nil, message_body: nil, phone: nil, phone_international: nil, price: nil, region_code: nil, status: nil, template_category: nil, template_id: nil, template_name: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {Sentdm::Models::ConversationMessagesList::Message} for more details.
+        #
+        #   Message response for v3 API — same shape as v2 with snake_case JSON conventions
+        #
+        #   @param id [String]
+        #
+        #   @param active_contact_price [Float, nil]
+        #
+        #   @param channel [String]
+        #
+        #   @param contact_id [String]
+        #
+        #   @param created_at [Time]
+        #
+        #   @param customer_id [String]
+        #
+        #   @param direction [String]
+        #
+        #   @param events [Array<Sentdm::Models::ConversationMessagesList::Message::Event>, nil]
+        #
+        #   @param message_body [Sentdm::Models::ConversationMessagesList::Message::MessageBody, nil] Structured message body format for database storage.
+        #
+        #   @param phone [String]
+        #
+        #   @param phone_international [String]
+        #
+        #   @param price [Float, nil]
+        #
+        #   @param region_code [String]
+        #
+        #   @param status [String]
+        #
+        #   @param template_category [String, nil]
+        #
+        #   @param template_id [String, nil]
+        #
+        #   @param template_name [String, nil]
+
+        class Event < Sentdm::Internal::Type::BaseModel
+          # @!attribute status
+          #
+          #   @return [String]
+          required :status, String
+
+          # @!attribute timestamp
+          #
+          #   @return [Time]
+          required :timestamp, Time
+
+          # @!attribute description
+          #
+          #   @return [String, nil]
+          optional :description, String, nil?: true
+
+          # @!method initialize(status:, timestamp:, description: nil)
+          #   Represents a status change event in a message's lifecycle (v3)
+          #
+          #   @param status [String]
+          #   @param timestamp [Time]
+          #   @param description [String, nil]
+        end
+
+        # @see Sentdm::Models::ConversationMessagesList::Message#message_body
+        class MessageBody < Sentdm::Internal::Type::BaseModel
+          # @!attribute buttons
+          #
+          #   @return [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
+          optional :buttons,
+                   -> {
+                     Sentdm::Internal::Type::ArrayOf[Sentdm::ConversationMessagesList::Message::MessageBody::Button]
+                   },
+                   nil?: true
+
+          # @!attribute content
+          #
+          #   @return [String, nil]
+          optional :content, String
+
+          # @!attribute footer
+          #
+          #   @return [String, nil]
+          optional :footer, String, nil?: true
+
+          # @!attribute header
+          #
+          #   @return [String, nil]
+          optional :header, String, nil?: true
+
+          # @!method initialize(buttons: nil, content: nil, footer: nil, header: nil)
+          #   Structured message body format for database storage. Preserves channel-specific
+          #   components (header, body, footer, buttons).
+          #
+          #   @param buttons [Array<Sentdm::Models::ConversationMessagesList::Message::MessageBody::Button>, nil]
+          #   @param content [String]
+          #   @param footer [String, nil]
+          #   @param header [String, nil]
+
+          class Button < Sentdm::Internal::Type::BaseModel
+            # @!attribute postback_data
+            #
+            #   @return [String, nil]
+            optional :postback_data, String, api_name: :postbackData, nil?: true
+
+            # @!attribute text
+            #
+            #   @return [String, nil]
+            optional :text, String, nil?: true
+
+            # @!attribute type
+            #
+            #   @return [String, nil]
+            optional :type, String
+
+            # @!attribute value
+            #
+            #   @return [String, nil]
+            optional :value, String
+
+            # @!method initialize(postback_data: nil, text: nil, type: nil, value: nil)
+            #   @param postback_data [String, nil]
+            #   @param text [String, nil]
+            #   @param type [String]
+            #   @param value [String]
+          end
+        end
+      end
+    end
+  end
+end

data/lib/sentdm/models/message_send_response.rb

@@ -49,8 +49,7 @@ module Sentdm
                  -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::MessageSendResponse::Data::Recipient] }
 
         # @!attribute status
-        #   Overall request status: "QUEUED" when the batch has been accepted and published
-        #   to Kafka.
+        #   Overall request status: "QUEUED" when the batch has been accepted for delivery.
         #
         #   @return [String, nil]
         optional :status, String
@@ -68,14 +67,11 @@ module Sentdm
         optional :template_name, String
 
         # @!method initialize(recipients: nil, status: nil, template_id: nil, template_name: nil)
-        #   Some parameter documentations has been truncated, see
-        #   {Sentdm::Models::MessageSendResponse::Data} for more details.
-        #
         #   Response for the multi-recipient send message endpoint
         #
         #   @param recipients [Array<Sentdm::Models::MessageSendResponse::Data::Recipient>] Per-recipient message results
         #
-        #   @param status [String] Overall request status: "QUEUED" when the batch has been accepted and published
+        #   @param status [String] Overall request status: "QUEUED" when the batch has been accepted for delivery.
         #
         #   @param template_id [String] Template ID that was used
         #

data/lib/sentdm/models/profile_detail.rb

@@ -113,7 +113,7 @@ module Sentdm
       optional :sending_phone_number, String, nil?: true
 
       # @!attribute sending_phone_number_profile_id
-      #   Reference to another profile for SMS/Telnyx configuration
+      #   Reference to another profile whose SMS configuration this profile uses
       #
       #   @return [String, nil]
       optional :sending_phone_number_profile_id, String, nil?: true
@@ -198,7 +198,7 @@ module Sentdm
       #
       #   @param sending_phone_number [String, nil] Direct SMS phone number
       #
-      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile for SMS/Telnyx configuration
+      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile whose SMS configuration this profile uses
       #
       #   @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile for WhatsApp configuration
       #
@@ -466,12 +466,6 @@ module Sentdm
           #   @return [Array<Sentdm::Models::DestinationCountry>, nil]
           optional :destination_countries, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::DestinationCountry] }
 
-          # @!attribute expected_messaging_volume
-          #   Expected daily messaging volume
-          #
-          #   @return [String, nil]
-          optional :expected_messaging_volume, String, nil?: true
-
           # @!attribute is_tcr_application
           #   Whether this is a TCR (Campaign Registry) application
           #
@@ -501,15 +495,13 @@ module Sentdm
           #   @return [Symbol, Sentdm::Models::TcrVertical, nil]
           optional :vertical, enum: -> { Sentdm::TcrVertical }, nil?: true
 
-          # @!method initialize(brand_relationship: nil, destination_countries: nil, expected_messaging_volume: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
+          # @!method initialize(brand_relationship: nil, destination_countries: nil, is_tcr_application: nil, notes: nil, phone_number_prefix: nil, primary_use_case: nil, vertical: nil)
           #   Compliance and TCR-related information
           #
           #   @param brand_relationship [Symbol, Sentdm::Models::TcrBrandRelationship, nil]
           #
           #   @param destination_countries [Array<Sentdm::Models::DestinationCountry>] List of destination countries for messaging
           #
-          #   @param expected_messaging_volume [String, nil] Expected daily messaging volume
-          #
           #   @param is_tcr_application [Boolean] Whether this is a TCR (Campaign Registry) application
           #
           #   @param notes [String, nil] Additional notes about the business or use case

data/lib/sentdm/models/profile_update_params.rb

@@ -119,7 +119,7 @@ module Sentdm
       optional :sending_phone_number, String, nil?: true
 
       # @!attribute sending_phone_number_profile_id
-      #   Reference to another profile to use for SMS/Telnyx configuration (optional)
+      #   Reference to another profile to use for SMS configuration (optional)
       #
       #   @return [String, nil]
       optional :sending_phone_number_profile_id, String, nil?: true
@@ -192,7 +192,7 @@ module Sentdm
       #
       #   @param sending_phone_number [String, nil] Direct phone number for SMS sending (optional)
       #
-      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile to use for SMS/Telnyx configuration (optional)
+      #   @param sending_phone_number_profile_id [String, nil] Reference to another profile to use for SMS configuration (optional)
       #
       #   @param sending_whatsapp_number_profile_id [String, nil] Reference to another profile to use for WhatsApp configuration (optional)
       #

data/lib/sentdm/models/profiles/{api_response_of_tcr_campaign_with_use_cases.rb → api_response_of_brand_campaign.rb}

@@ -4,12 +4,12 @@ module Sentdm
   module Models
     module Profiles
       # @see Sentdm::Resources::Profiles::Campaigns#create
-      class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
+      class APIResponseOfBrandCampaign < Sentdm::Internal::Type::BaseModel
         # @!attribute data
-        #   The response data (null if error)
+        #   A 10DLC campaign registered for a brand.
         #
-        #   @return [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil]
-        optional :data, -> { Sentdm::Profiles::TcrCampaignWithUseCases }, nil?: true
+        #   @return [Sentdm::Models::Profiles::BrandCampaign, nil]
+        optional :data, -> { Sentdm::Profiles::BrandCampaign }, nil?: true
 
         # @!attribute error
         #   Error information
@@ -32,7 +32,7 @@ module Sentdm
         # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
         #   Standard API response envelope for all v3 endpoints
         #
-        #   @param data [Sentdm::Models::Profiles::TcrCampaignWithUseCases, nil] The response data (null if error)
+        #   @param data [Sentdm::Models::Profiles::BrandCampaign, nil] A 10DLC campaign registered for a brand.
         #
         #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
         #

data/lib/sentdm/models/profiles/{campaign_list_response.rb → api_response_of_list_of_brand_campaign.rb}

@@ -4,14 +4,12 @@ module Sentdm
   module Models
     module Profiles
       # @see Sentdm::Resources::Profiles::Campaigns#list
-      class CampaignListResponse < Sentdm::Internal::Type::BaseModel
+      class APIResponseOfListOfBrandCampaign < Sentdm::Internal::Type::BaseModel
         # @!attribute data
         #   The response data (null if error)
         #
-        #   @return [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases>, nil]
-        optional :data,
-                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::TcrCampaignWithUseCases] },
-                 nil?: true
+        #   @return [Array<Sentdm::Models::Profiles::BrandCampaign>, nil]
+        optional :data, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Profiles::BrandCampaign] }, nil?: true
 
         # @!attribute error
         #   Error information
@@ -34,7 +32,7 @@ module Sentdm
         # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
         #   Standard API response envelope for all v3 endpoints
         #
-        #   @param data [Array<Sentdm::Models::Profiles::TcrCampaignWithUseCases>, nil] The response data (null if error)
+        #   @param data [Array<Sentdm::Models::Profiles::BrandCampaign>, nil] The response data (null if error)
         #
         #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
         #