sentdm 0.28.0 → 0.30.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.
+      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.
+        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/error_detail.rbi

@@ -0,0 +1,66 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class ErrorDetail < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::ErrorDetail, Sentdm::Internal::AnyHash) }
+
+      # Machine-readable error code (e.g., "RESOURCE_001")
+      sig { returns(T.nilable(String)) }
+      attr_reader :code
+
+      sig { params(code: String).void }
+      attr_writer :code
+
+      # Additional validation error details (field-level errors)
+      sig { returns(T.nilable(T::Hash[Symbol, T::Array[String]])) }
+      attr_accessor :details
+
+      # URL to documentation about this error
+      sig { returns(T.nilable(String)) }
+      attr_accessor :doc_url
+
+      # Human-readable error message
+      sig { returns(T.nilable(String)) }
+      attr_reader :message
+
+      sig { params(message: String).void }
+      attr_writer :message
+
+      # Error information
+      sig do
+        params(
+          code: String,
+          details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+          doc_url: T.nilable(String),
+          message: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Machine-readable error code (e.g., "RESOURCE_001")
+        code: nil,
+        # Additional validation error details (field-level errors)
+        details: nil,
+        # URL to documentation about this error
+        doc_url: nil,
+        # Human-readable error message
+        message: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            code: String,
+            details: T.nilable(T::Hash[Symbol, T::Array[String]]),
+            doc_url: T.nilable(String),
+            message: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/inbound_message_event_payload.rbi

@@ -8,6 +8,14 @@ module Sentdm
           T.any(Sentdm::InboundMessageEventPayload, Sentdm::Internal::AnyHash)
         end
 
+      # The contact's number in E.164 format, meaning the number the message came from.
+      sig { returns(String) }
+      attr_accessor :inbound_number
+
+      # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      sig { returns(String) }
+      attr_accessor :received_at
+
       # The account the message belongs to.
       sig { returns(T.nilable(String)) }
       attr_reader :account_id
@@ -22,13 +30,6 @@ module Sentdm
       sig { params(channel: String).void }
       attr_writer :channel
 
-      # The contact's number in E.164 format, meaning the number the message came from.
-      sig { returns(T.nilable(String)) }
-      attr_reader :inbound_number
-
-      sig { params(inbound_number: String).void }
-      attr_writer :inbound_number
-
       # The inbound message.
       sig { returns(T.nilable(String)) }
       attr_reader :message_id
@@ -43,13 +44,6 @@ module Sentdm
       sig { params(outbound_number: String).void }
       attr_writer :outbound_number
 
-      # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
-      sig { returns(T.nilable(String)) }
-      attr_reader :received_at
-
-      sig { params(received_at: String).void }
-      attr_writer :received_at
-
       # The message body. Sent as null when the inbound message carried no text, for
       # example a media-only message. The field is always present, so read it and check
       # for null rather than checking whether the key exists.
@@ -68,29 +62,29 @@ module Sentdm
       # numbers.
       sig do
         params(
+          inbound_number: String,
+          received_at: String,
           account_id: String,
           channel: String,
-          inbound_number: String,
           message_id: String,
           outbound_number: String,
-          received_at: String,
           text: T.nilable(String),
           updated_at: String
         ).returns(T.attached_class)
       end
       def self.new(
+        # The contact's number in E.164 format, meaning the number the message came from.
+        inbound_number:,
+        # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+        received_at:,
         # The account the message belongs to.
         account_id: nil,
         # The channel the message arrived on, for example sms or whatsapp.
         channel: nil,
-        # The contact's number in E.164 format, meaning the number the message came from.
-        inbound_number: nil,
         # The inbound message.
         message_id: nil,
         # Your number in E.164 format, meaning the number the message was addressed to.
         outbound_number: nil,
-        # When the message was received, in UTC (yyyy-MM-ddTHH:mm:ssZ).
-        received_at: nil,
         # The message body. Sent as null when the inbound message carried no text, for
         # example a media-only message. The field is always present, so read it and check
         # for null rather than checking whether the key exists.
@@ -104,12 +98,12 @@ module Sentdm
       sig do
         override.returns(
           {
+            inbound_number: String,
+            received_at: String,
             account_id: String,
             channel: String,
-            inbound_number: String,
             message_id: String,
             outbound_number: String,
-            received_at: String,
             text: T.nilable(String),
             updated_at: String
           }