sentdm 0.26.0 → 0.28.0

data/rbi/sentdm/models/message_event.rbi

@@ -0,0 +1,86 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageEvent < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias { T.any(Sentdm::MessageEvent, Sentdm::Internal::AnyHash) }
+
+      # The specific event within the family, for example message.delivered or
+      # message.received. Absent on events that have no subtype, so treat it as
+      # optional.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :event
+
+      # The event family, for example message or templates. Route on this first, then on
+      # event for the specific change.
+      sig { returns(T.nilable(String)) }
+      attr_reader :field
+
+      sig { params(field: String).void }
+      attr_writer :field
+
+      # Body of an outbound message lifecycle event. Delivered once per status change,
+      # so a single message produces several of these as it moves toward a terminal
+      # status.
+      sig { returns(T.nilable(Sentdm::MessageEventPayload)) }
+      attr_reader :payload
+
+      sig do
+        params(payload: T.nilable(Sentdm::MessageEventPayload::OrHash)).void
+      end
+      attr_writer :payload
+
+      # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+      # time, not the time the underlying change happened. Use the timestamp inside the
+      # payload for the latter.
+      sig { returns(T.nilable(String)) }
+      attr_reader :timestamp
+
+      sig { params(timestamp: String).void }
+      attr_writer :timestamp
+
+      # The envelope Sent POSTs to a subscribed webhook endpoint. Every event shares
+      # this shape and varies only in Payload.
+      sig do
+        params(
+          event: T.nilable(String),
+          field: String,
+          payload: T.nilable(Sentdm::MessageEventPayload::OrHash),
+          timestamp: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The specific event within the family, for example message.delivered or
+        # message.received. Absent on events that have no subtype, so treat it as
+        # optional.
+        event: nil,
+        # The event family, for example message or templates. Route on this first, then on
+        # event for the specific change.
+        field: nil,
+        # Body of an outbound message lifecycle event. Delivered once per status change,
+        # so a single message produces several of these as it moves toward a terminal
+        # status.
+        payload: nil,
+        # When Sent emitted the event, in UTC (yyyy-MM-ddTHH:mm:ssZ). This is the emission
+        # time, not the time the underlying change happened. Use the timestamp inside the
+        # payload for the latter.
+        timestamp: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            event: T.nilable(String),
+            field: String,
+            payload: T.nilable(Sentdm::MessageEventPayload),
+            timestamp: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_event_payload.rbi

@@ -0,0 +1,132 @@
+# typed: strong
+
+module Sentdm
+  module Models
+    class MessageEventPayload < Sentdm::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(Sentdm::MessageEventPayload, Sentdm::Internal::AnyHash)
+        end
+
+      # The account the message belongs to.
+      sig { returns(T.nilable(String)) }
+      attr_reader :account_id
+
+      sig { params(account_id: String).void }
+      attr_writer :account_id
+
+      # The agent attributed to the send, when the send was attributed to one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :agent_id
+
+      # The channel the message went out on, for example sms or whatsapp. A message that
+      # falls back to another channel reports the channel actually used.
+      sig { returns(T.nilable(String)) }
+      attr_reader :channel
+
+      sig { params(channel: String).void }
+      attr_writer :channel
+
+      # The message this event describes. Stable across every event in the message's
+      # lifecycle, so use it to correlate them.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_id
+
+      sig { params(message_id: String).void }
+      attr_writer :message_id
+
+      # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+      # Sent means dispatched and delivered means confirmed, so treat them as distinct
+      # outcomes.
+      sig { returns(T.nilable(String)) }
+      attr_reader :message_status
+
+      sig { params(message_status: String).void }
+      attr_writer :message_status
+
+      # The recipient's number in E.164 format.
+      sig { returns(T.nilable(String)) }
+      attr_reader :outbound_number
+
+      sig { params(outbound_number: String).void }
+      attr_writer :outbound_number
+
+      # The template the message was sent from, when it was sent from one.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_id
+
+      # Name of the template the message was sent from. Omitted when the message wasn't
+      # template-based.
+      sig { returns(T.nilable(String)) }
+      attr_accessor :template_name
+
+      # When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+      sig { returns(T.nilable(String)) }
+      attr_reader :updated_at
+
+      sig { params(updated_at: String).void }
+      attr_writer :updated_at
+
+      # Body of an outbound message lifecycle event. Delivered once per status change,
+      # so a single message produces several of these as it moves toward a terminal
+      # status.
+      sig do
+        params(
+          account_id: String,
+          agent_id: T.nilable(String),
+          channel: String,
+          message_id: String,
+          message_status: String,
+          outbound_number: String,
+          template_id: T.nilable(String),
+          template_name: T.nilable(String),
+          updated_at: String
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The account the message belongs to.
+        account_id: nil,
+        # The agent attributed to the send, when the send was attributed to one.
+        agent_id: nil,
+        # The channel the message went out on, for example sms or whatsapp. A message that
+        # falls back to another channel reports the channel actually used.
+        channel: nil,
+        # The message this event describes. Stable across every event in the message's
+        # lifecycle, so use it to correlate them.
+        message_id: nil,
+        # The status the message just reached, for example SENT, DELIVERED, or FAILED.
+        # Sent means dispatched and delivered means confirmed, so treat them as distinct
+        # outcomes.
+        message_status: nil,
+        # The recipient's number in E.164 format.
+        outbound_number: nil,
+        # The template the message was sent from, when it was sent from one.
+        template_id: nil,
+        # Name of the template the message was sent from. Omitted when the message wasn't
+        # template-based.
+        template_name: nil,
+        # When the message reached MessageStatus, in UTC (yyyy-MM-ddTHH:mm:ssZ).
+        updated_at: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            account_id: String,
+            agent_id: T.nilable(String),
+            channel: String,
+            message_id: String,
+            message_status: String,
+            outbound_number: String,
+            template_id: T.nilable(String),
+            template_name: T.nilable(String),
+            updated_at: String
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/sentdm/models/message_retrieve_activities_response.rbi

@@ -30,17 +30,36 @@ module Sentdm
       attr_writer :data
 
       # Error information
-      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      sig do
+        returns(
+          T.nilable(Sentdm::Models::MessageRetrieveActivitiesResponse::Error)
+        )
+      end
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      sig do
+        params(
+          error:
+            T.nilable(
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Error::OrHash
+            )
+        ).void
+      end
       attr_writer :error
 
       # Request and response metadata
-      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      sig do
+        returns(
+          T.nilable(Sentdm::Models::MessageRetrieveActivitiesResponse::Meta)
+        )
+      end
       attr_reader :meta
 
-      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      sig do
+        params(
+          meta: Sentdm::Models::MessageRetrieveActivitiesResponse::Meta::OrHash
+        ).void
+      end
       attr_writer :meta
 
       # Indicates whether the request was successful
@@ -57,8 +76,11 @@ module Sentdm
             T.nilable(
               Sentdm::Models::MessageRetrieveActivitiesResponse::Data::OrHash
             ),
-          error: T.nilable(Sentdm::ErrorDetail::OrHash),
-          meta: Sentdm::APIMeta::OrHash,
+          error:
+            T.nilable(
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Error::OrHash
+            ),
+          meta: Sentdm::Models::MessageRetrieveActivitiesResponse::Meta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
@@ -81,8 +103,11 @@ module Sentdm
               T.nilable(
                 Sentdm::Models::MessageRetrieveActivitiesResponse::Data
               ),
-            error: T.nilable(Sentdm::ErrorDetail),
-            meta: Sentdm::APIMeta,
+            error:
+              T.nilable(
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Error
+              ),
+            meta: Sentdm::Models::MessageRetrieveActivitiesResponse::Meta,
             success: T::Boolean
           }
         )
@@ -128,6 +153,24 @@ module Sentdm
         sig { params(message_id: String).void }
         attr_writer :message_id
 
+        # Pagination metadata for list responses
+        sig do
+          returns(
+            T.nilable(
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination
+            )
+          )
+        end
+        attr_reader :pagination
+
+        sig do
+          params(
+            pagination:
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::OrHash
+          ).void
+        end
+        attr_writer :pagination
+
         # Response for GET /messages/{id}/activities
         sig do
           params(
@@ -135,14 +178,18 @@ module Sentdm
               T::Array[
                 Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity::OrHash
               ],
-            message_id: String
+            message_id: String,
+            pagination:
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
           # List of activity events ordered by most recent first
           activities: nil,
           # The message ID these activities belong to
-          message_id: nil
+          message_id: nil,
+          # Pagination metadata for list responses
+          pagination: nil
         )
         end
 
@@ -153,7 +200,9 @@ module Sentdm
                 T::Array[
                   Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Activity
                 ],
-              message_id: String
+              message_id: String,
+              pagination:
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination
             }
           )
         end
@@ -254,6 +303,281 @@ module Sentdm
           def to_hash
           end
         end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Cursor-based pagination. Never populated — see Cursors.
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors
+              )
+            )
+          end
+          attr_reader :cursors
+
+          sig do
+            params(
+              cursors:
+                T.nilable(
+                  Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors::OrHash
+                )
+            ).void
+          end
+          attr_writer :cursors
+
+          # Whether there are more pages after this one
+          sig { returns(T.nilable(T::Boolean)) }
+          attr_reader :has_more
+
+          sig { params(has_more: T::Boolean).void }
+          attr_writer :has_more
+
+          # Current page number (1-indexed)
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page
+
+          sig { params(page: Integer).void }
+          attr_writer :page
+
+          # Number of items per page
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :page_size
+
+          sig { params(page_size: Integer).void }
+          attr_writer :page_size
+
+          # Total number of items across all pages
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :total_count
+
+          sig { params(total_count: Integer).void }
+          attr_writer :total_count
+
+          # Total number of pages
+          sig { returns(T.nilable(Integer)) }
+          attr_reader :total_pages
+
+          sig { params(total_pages: Integer).void }
+          attr_writer :total_pages
+
+          # Pagination metadata for list responses
+          sig do
+            params(
+              cursors:
+                T.nilable(
+                  Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors::OrHash
+                ),
+              has_more: T::Boolean,
+              page: Integer,
+              page_size: Integer,
+              total_count: Integer,
+              total_pages: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Cursor-based pagination. Never populated — see Cursors.
+            cursors: nil,
+            # Whether there are more pages after this one
+            has_more: nil,
+            # Current page number (1-indexed)
+            page: nil,
+            # Number of items per page
+            page_size: nil,
+            # Total number of items across all pages
+            total_count: nil,
+            # Total number of pages
+            total_pages: nil
+          )
+          end
+
+          sig do
+            override.returns(
+              {
+                cursors:
+                  T.nilable(
+                    Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors
+                  ),
+                has_more: T::Boolean,
+                page: Integer,
+                page_size: Integer,
+                total_count: Integer,
+                total_pages: Integer
+              }
+            )
+          end
+          def to_hash
+          end
+
+          class Cursors < Sentdm::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  Sentdm::Models::MessageRetrieveActivitiesResponse::Data::Pagination::Cursors,
+                  Sentdm::Internal::AnyHash
+                )
+              end
+
+            # Cursor to fetch the next page.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :after
+
+            # Cursor to fetch the previous page.
+            sig { returns(T.nilable(String)) }
+            attr_accessor :before
+
+            # Cursor-based pagination. Never populated — see Cursors.
+            sig do
+              params(
+                after: T.nilable(String),
+                before: T.nilable(String)
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Cursor to fetch the next page.
+              after: nil,
+              # Cursor to fetch the previous page.
+              before: nil
+            )
+            end
+
+            sig do
+              override.returns(
+                { after: T.nilable(String), before: T.nilable(String) }
+              )
+            end
+            def to_hash
+            end
+          end
+        end
+      end
+
+      class Error < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Error,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # 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
+
+      class Meta < Sentdm::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              Sentdm::Models::MessageRetrieveActivitiesResponse::Meta,
+              Sentdm::Internal::AnyHash
+            )
+          end
+
+        # Unique identifier for this request (for tracing and support)
+        sig { returns(T.nilable(String)) }
+        attr_reader :request_id
+
+        sig { params(request_id: String).void }
+        attr_writer :request_id
+
+        # Server timestamp when the response was generated
+        sig { returns(T.nilable(Time)) }
+        attr_reader :timestamp
+
+        sig { params(timestamp: Time).void }
+        attr_writer :timestamp
+
+        # API version used for this request
+        sig { returns(T.nilable(String)) }
+        attr_reader :version
+
+        sig { params(version: String).void }
+        attr_writer :version
+
+        # Request and response metadata
+        sig do
+          params(request_id: String, timestamp: Time, version: String).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Unique identifier for this request (for tracing and support)
+          request_id: nil,
+          # Server timestamp when the response was generated
+          timestamp: nil,
+          # API version used for this request
+          version: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            { request_id: String, timestamp: Time, version: String }
+          )
+        end
+        def to_hash
+        end
       end
     end
   end