sentdm 0.25.0 → 0.26.0

data/rbi/sentdm/models/conversation_messages_list.rbi

@@ -0,0 +1,419 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ConversationMessagesList < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::ConversationMessagesList, Sentdm::Internal::AnyHash)
+        end
+
+      # The messages on this page, most recent first.
+      sig do
+        returns(T.nilable(T::Array[Sentdm::ConversationMessagesList::Message]))
+      end
+      attr_reader :messages
+
+      sig do
+        params(
+          messages: T::Array[Sentdm::ConversationMessagesList::Message::OrHash]
+        ).void
+      end
+      attr_writer :messages
+
+      # Pagination metadata for list responses
+      sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+      attr_reader :pagination
+
+      sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+      attr_writer :pagination
+
+      # A paginated list of messages — used by both conversation read endpoints.
+      sig do
+        params(
+          messages: T::Array[Sentdm::ConversationMessagesList::Message::OrHash],
+          pagination: Sentdm::PaginationMeta::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The messages on this page, most recent first.
+        messages: nil,
+        # Pagination metadata for list responses
+        pagination: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            messages: T::Array[Sentdm::ConversationMessagesList::Message],
+            pagination: Sentdm::PaginationMeta
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Message < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::ConversationMessagesList::Message,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :id
+
+        sig { params(id: String).void }
+        attr_writer :id
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :active_contact_price
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :channel
+
+        sig { params(channel: String).void }
+        attr_writer :channel
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :contact_id
+
+        sig { params(contact_id: String).void }
+        attr_writer :contact_id
+
+        sig { returns(T.nilable(Time)) }
+        attr_reader :created_at
+
+        sig { params(created_at: Time).void }
+        attr_writer :created_at
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :customer_id
+
+        sig { params(customer_id: String).void }
+        attr_writer :customer_id
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :direction
+
+        sig { params(direction: String).void }
+        attr_writer :direction
+
+        sig do
+          returns(
+            T.nilable(
+              T::Array[Sentdm::ConversationMessagesList::Message::Event]
+            )
+          )
+        end
+        attr_accessor :events
+
+        # Structured message body format for database storage. Preserves channel-specific
+        # components (header, body, footer, buttons).
+        sig do
+          returns(
+            T.nilable(Sentdm::ConversationMessagesList::Message::MessageBody)
+          )
+        end
+        attr_reader :message_body
+
+        sig do
+          params(
+            message_body:
+              T.nilable(
+                Sentdm::ConversationMessagesList::Message::MessageBody::OrHash
+              )
+          ).void
+        end
+        attr_writer :message_body
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone
+
+        sig { params(phone: String).void }
+        attr_writer :phone
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :phone_international
+
+        sig { params(phone_international: String).void }
+        attr_writer :phone_international
+
+        sig { returns(T.nilable(Float)) }
+        attr_accessor :price
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :region_code
+
+        sig { params(region_code: String).void }
+        attr_writer :region_code
+
+        sig { returns(T.nilable(String)) }
+        attr_reader :status
+
+        sig { params(status: String).void }
+        attr_writer :status
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :template_category
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :template_id
+
+        sig { returns(T.nilable(String)) }
+        attr_accessor :template_name
+
+        # Message response for v3 API — same shape as v2 with snake_case JSON conventions
+        sig do
+          params(
+            id: String,
+            active_contact_price: T.nilable(Float),
+            channel: String,
+            contact_id: String,
+            created_at: Time,
+            customer_id: String,
+            direction: String,
+            events:
+              T.nilable(
+                T::Array[
+                  Sentdm::ConversationMessagesList::Message::Event::OrHash
+                ]
+              ),
+            message_body:
+              T.nilable(
+                Sentdm::ConversationMessagesList::Message::MessageBody::OrHash
+              ),
+            phone: String,
+            phone_international: String,
+            price: T.nilable(Float),
+            region_code: String,
+            status: String,
+            template_category: T.nilable(String),
+            template_id: T.nilable(String),
+            template_name: T.nilable(String)
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          id: nil,
+          active_contact_price: nil,
+          channel: nil,
+          contact_id: nil,
+          created_at: nil,
+          customer_id: nil,
+          direction: nil,
+          events: nil,
+          # Structured message body format for database storage. Preserves channel-specific
+          # components (header, body, footer, buttons).
+          message_body: nil,
+          phone: nil,
+          phone_international: nil,
+          price: nil,
+          region_code: nil,
+          status: nil,
+          template_category: nil,
+          template_id: nil,
+          template_name: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              active_contact_price: T.nilable(Float),
+              channel: String,
+              contact_id: String,
+              created_at: Time,
+              customer_id: String,
+              direction: String,
+              events:
+                T.nilable(
+                  T::Array[Sentdm::ConversationMessagesList::Message::Event]
+                ),
+              message_body:
+                T.nilable(
+                  Sentdm::ConversationMessagesList::Message::MessageBody
+                ),
+              phone: String,
+              phone_international: String,
+              price: T.nilable(Float),
+              region_code: String,
+              status: String,
+              template_category: T.nilable(String),
+              template_id: T.nilable(String),
+              template_name: T.nilable(String)
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class Event < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::ConversationMessagesList::Message::Event,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig { returns(String) }
+          attr_accessor :status
+
+          sig { returns(Time) }
+          attr_accessor :timestamp
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :description
+
+          # Represents a status change event in a message's lifecycle (v3)
+          sig do
+            params(
+              status: String,
+              timestamp: Time,
+              description: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(status:, timestamp:, description: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                status: String,
+                timestamp: Time,
+                description: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+        end
+
+        class MessageBody < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::ConversationMessagesList::Message::MessageBody,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          sig do
+            returns(
+              T.nilable(
+                T::Array[
+                  Sentdm::ConversationMessagesList::Message::MessageBody::Button
+                ]
+              )
+            )
+          end
+          attr_accessor :buttons
+
+          sig { returns(T.nilable(String)) }
+          attr_reader :content
+
+          sig { params(content: String).void }
+          attr_writer :content
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :footer
+
+          sig { returns(T.nilable(String)) }
+          attr_accessor :header
+
+          # Structured message body format for database storage. Preserves channel-specific
+          # components (header, body, footer, buttons).
+          sig do
+            params(
+              buttons:
+                T.nilable(
+                  T::Array[
+                    Sentdm::ConversationMessagesList::Message::MessageBody::Button::OrHash
+                  ]
+                ),
+              content: String,
+              footer: T.nilable(String),
+              header: T.nilable(String)
+            ).returns(T.attached_class)
+          end
+          def self.new(buttons: nil, content: nil, footer: nil, header: nil)
+          end
+
+          sig do
+            override.returns(
+              {
+                buttons:
+                  T.nilable(
+                    T::Array[
+                      Sentdm::ConversationMessagesList::Message::MessageBody::Button
+                    ]
+                  ),
+                content: String,
+                footer: T.nilable(String),
+                header: T.nilable(String)
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Button < Sentdm::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Sentdm::ConversationMessagesList::Message::MessageBody::Button,
+                  Sentdm::Internal::AnyHash
+                )
+              end
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :postback_data
+
+            sig { returns(T.nilable(String)) }
+            attr_accessor :text
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :type
+
+            sig { params(type: String).void }
+            attr_writer :type
+
+            sig { returns(T.nilable(String)) }
+            attr_reader :value
+
+            sig { params(value: String).void }
+            attr_writer :value
+
+            sig do
+              params(
+                postback_data: T.nilable(String),
+                text: T.nilable(String),
+                type: String,
+                value: String
+              ).returns(T.attached_class)
+            end
+            def self.new(postback_data: nil, text: nil, type: nil, value: nil)
+            end
+
+            sig do
+              override.returns(
+                {
+                  postback_data: T.nilable(String),
+                  text: T.nilable(String),
+                  type: String,
+                  value: String
+                }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_send_response.rbi

@@ -103,8 +103,7 @@ module Sentdm
         end
         attr_writer :recipients
 
-        # 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.
         sig { returns(T.nilable(String)) }
         attr_reader :status
 
@@ -140,8 +139,7 @@ module Sentdm
         def self.new(
           # Per-recipient message results
           recipients: nil,
-          # 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.
           status: nil,
           # Template ID that was used
           template_id: nil,

data/rbi/sentdm/models/profile_detail.rbi

@@ -122,7 +122,7 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number
 
-      # Reference to another profile for SMS/Telnyx configuration
+      # Reference to another profile whose SMS configuration this profile uses
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number_profile_id
 
@@ -224,7 +224,7 @@ module Sentdm
         organization_id: nil,
         # Direct SMS phone number
         sending_phone_number: nil,
-        # Reference to another profile for SMS/Telnyx configuration
+        # Reference to another profile whose SMS configuration this profile uses
         sending_phone_number_profile_id: nil,
         # Reference to another profile for WhatsApp configuration
         sending_whatsapp_number_profile_id: nil,
@@ -645,10 +645,6 @@ module Sentdm
           end
           attr_writer :destination_countries
 
-          # Expected daily messaging volume
-          sig { returns(T.nilable(String)) }
-          attr_accessor :expected_messaging_volume
-
           # Whether this is a TCR (Campaign Registry) application
           sig { returns(T.nilable(T::Boolean)) }
           attr_reader :is_tcr_application
@@ -678,7 +674,6 @@ module Sentdm
                 T.nilable(Sentdm::TcrBrandRelationship::OrSymbol),
               destination_countries:
                 T::Array[Sentdm::DestinationCountry::OrHash],
-              expected_messaging_volume: T.nilable(String),
               is_tcr_application: T::Boolean,
               notes: T.nilable(String),
               phone_number_prefix: T.nilable(String),
@@ -690,8 +685,6 @@ module Sentdm
             brand_relationship: nil,
             # List of destination countries for messaging
             destination_countries: nil,
-            # Expected daily messaging volume
-            expected_messaging_volume: nil,
             # Whether this is a TCR (Campaign Registry) application
             is_tcr_application: nil,
             # Additional notes about the business or use case
@@ -710,7 +703,6 @@ module Sentdm
                 brand_relationship:
                   T.nilable(Sentdm::TcrBrandRelationship::TaggedSymbol),
                 destination_countries: T::Array[Sentdm::DestinationCountry],
-                expected_messaging_volume: T.nilable(String),
                 is_tcr_application: T::Boolean,
                 notes: T.nilable(String),
                 phone_number_prefix: T.nilable(String),

data/rbi/sentdm/models/profile_update_params.rbi

@@ -106,7 +106,7 @@ module Sentdm
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number
 
-      # Reference to another profile to use for SMS/Telnyx configuration (optional)
+      # Reference to another profile to use for SMS configuration (optional)
       sig { returns(T.nilable(String)) }
       attr_accessor :sending_phone_number_profile_id
 
@@ -208,7 +208,7 @@ module Sentdm
         sandbox: nil,
         # Direct phone number for SMS sending (optional)
         sending_phone_number: nil,
-        # Reference to another profile to use for SMS/Telnyx configuration (optional)
+        # Reference to another profile to use for SMS configuration (optional)
         sending_phone_number_profile_id: nil,
         # Reference to another profile to use for WhatsApp configuration (optional)
         sending_whatsapp_number_profile_id: nil,

data/rbi/sentdm/models/profiles/{api_response_of_tcr_campaign_with_use_cases.rbi → api_response_of_brand_campaign.rbi}

@@ -3,23 +3,21 @@
 module Sentdm
   module Models
     module Profiles
-      class APIResponseOfTcrCampaignWithUseCases < Sentdm::Internal::Type::BaseModel
+      class APIResponseOfBrandCampaign < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Profiles::APIResponseOfTcrCampaignWithUseCases,
+              Sentdm::Profiles::APIResponseOfBrandCampaign,
               Sentdm::Internal::AnyHash
             )
           end
 
-        # The response data (null if error)
-        sig { returns(T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases)) }
+        # A 10DLC campaign registered for a brand.
+        sig { returns(T.nilable(Sentdm::Profiles::BrandCampaign)) }
         attr_reader :data
 
         sig do
-          params(
-            data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases::OrHash)
-          ).void
+          params(data: T.nilable(Sentdm::Profiles::BrandCampaign::OrHash)).void
         end
         attr_writer :data
 
@@ -47,14 +45,14 @@ module Sentdm
         # Standard API response envelope for all v3 endpoints
         sig do
           params(
-            data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases::OrHash),
+            data: T.nilable(Sentdm::Profiles::BrandCampaign::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)
+          # A 10DLC campaign registered for a brand.
           data: nil,
           # Error information
           error: nil,
@@ -68,7 +66,7 @@ module Sentdm
         sig do
           override.returns(
             {
-              data: T.nilable(Sentdm::Profiles::TcrCampaignWithUseCases),
+              data: T.nilable(Sentdm::Profiles::BrandCampaign),
               error: T.nilable(Sentdm::ErrorDetail),
               meta: Sentdm::APIMeta,
               success: T::Boolean

data/rbi/sentdm/models/profiles/{campaign_list_response.rbi → api_response_of_list_of_brand_campaign.rbi}

@@ -3,21 +3,17 @@
 module Sentdm
   module Models
     module Profiles
-      class CampaignListResponse < Sentdm::Internal::Type::BaseModel
+      class APIResponseOfListOfBrandCampaign < Sentdm::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
             T.any(
-              Sentdm::Models::Profiles::CampaignListResponse,
+              Sentdm::Profiles::APIResponseOfListOfBrandCampaign,
               Sentdm::Internal::AnyHash
             )
           end
 
         # The response data (null if error)
-        sig do
-          returns(
-            T.nilable(T::Array[Sentdm::Profiles::TcrCampaignWithUseCases])
-          )
-        end
+        sig { returns(T.nilable(T::Array[Sentdm::Profiles::BrandCampaign])) }
         attr_accessor :data
 
         # Error information
@@ -44,10 +40,7 @@ module Sentdm
         # Standard API response envelope for all v3 endpoints
         sig do
           params(
-            data:
-              T.nilable(
-                T::Array[Sentdm::Profiles::TcrCampaignWithUseCases::OrHash]
-              ),
+            data: T.nilable(T::Array[Sentdm::Profiles::BrandCampaign::OrHash]),
             error: T.nilable(Sentdm::ErrorDetail::OrHash),
             meta: Sentdm::APIMeta::OrHash,
             success: T::Boolean
@@ -68,8 +61,7 @@ module Sentdm
         sig do
           override.returns(
             {
-              data:
-                T.nilable(T::Array[Sentdm::Profiles::TcrCampaignWithUseCases]),
+              data: T.nilable(T::Array[Sentdm::Profiles::BrandCampaign]),
               error: T.nilable(Sentdm::ErrorDetail),
               meta: Sentdm::APIMeta,
               success: T::Boolean