sentdm 0.26.0 → 0.28.0

data/rbi/sentdm/models/webhook_list_events_response.rbi

@@ -11,7 +11,7 @@ module Sentdm
           )
         end
 
-      # The response data (null if error)
+      # A paginated list of webhook delivery records.
       sig do
         returns(T.nilable(Sentdm::Models::WebhookListEventsResponse::Data))
       end
@@ -26,17 +26,30 @@ module Sentdm
       attr_writer :data
 
       # Error information
-      sig { returns(T.nilable(Sentdm::ErrorDetail)) }
+      sig do
+        returns(T.nilable(Sentdm::Models::WebhookListEventsResponse::Error))
+      end
       attr_reader :error
 
-      sig { params(error: T.nilable(Sentdm::ErrorDetail::OrHash)).void }
+      sig do
+        params(
+          error:
+            T.nilable(Sentdm::Models::WebhookListEventsResponse::Error::OrHash)
+        ).void
+      end
       attr_writer :error
 
       # Request and response metadata
-      sig { returns(T.nilable(Sentdm::APIMeta)) }
+      sig do
+        returns(T.nilable(Sentdm::Models::WebhookListEventsResponse::Meta))
+      end
       attr_reader :meta
 
-      sig { params(meta: Sentdm::APIMeta::OrHash).void }
+      sig do
+        params(
+          meta: Sentdm::Models::WebhookListEventsResponse::Meta::OrHash
+        ).void
+      end
       attr_writer :meta
 
       # Indicates whether the request was successful
@@ -51,13 +64,14 @@ module Sentdm
         params(
           data:
             T.nilable(Sentdm::Models::WebhookListEventsResponse::Data::OrHash),
-          error: T.nilable(Sentdm::ErrorDetail::OrHash),
-          meta: Sentdm::APIMeta::OrHash,
+          error:
+            T.nilable(Sentdm::Models::WebhookListEventsResponse::Error::OrHash),
+          meta: Sentdm::Models::WebhookListEventsResponse::Meta::OrHash,
           success: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
-        # The response data (null if error)
+        # A paginated list of webhook delivery records.
         data: nil,
         # Error information
         error: nil,
@@ -72,8 +86,8 @@ module Sentdm
         override.returns(
           {
             data: T.nilable(Sentdm::Models::WebhookListEventsResponse::Data),
-            error: T.nilable(Sentdm::ErrorDetail),
-            meta: Sentdm::APIMeta,
+            error: T.nilable(Sentdm::Models::WebhookListEventsResponse::Error),
+            meta: Sentdm::Models::WebhookListEventsResponse::Meta,
             success: T::Boolean
           }
         )
@@ -90,6 +104,7 @@ module Sentdm
             )
           end
 
+        # The events on this page.
         sig do
           returns(
             T.nilable(
@@ -110,23 +125,36 @@ module Sentdm
         attr_writer :events
 
         # Pagination metadata for list responses
-        sig { returns(T.nilable(Sentdm::PaginationMeta)) }
+        sig do
+          returns(
+            T.nilable(
+              Sentdm::Models::WebhookListEventsResponse::Data::Pagination
+            )
+          )
+        end
         attr_reader :pagination
 
-        sig { params(pagination: Sentdm::PaginationMeta::OrHash).void }
+        sig do
+          params(
+            pagination:
+              Sentdm::Models::WebhookListEventsResponse::Data::Pagination::OrHash
+          ).void
+        end
         attr_writer :pagination
 
-        # The response data (null if error)
+        # A paginated list of webhook delivery records.
         sig do
           params(
             events:
               T::Array[
                 Sentdm::Models::WebhookListEventsResponse::Data::Event::OrHash
               ],
-            pagination: Sentdm::PaginationMeta::OrHash
+            pagination:
+              Sentdm::Models::WebhookListEventsResponse::Data::Pagination::OrHash
           ).returns(T.attached_class)
         end
         def self.new(
+          # The events on this page.
           events: nil,
           # Pagination metadata for list responses
           pagination: nil
@@ -140,7 +168,8 @@ module Sentdm
                 T::Array[
                   Sentdm::Models::WebhookListEventsResponse::Data::Event
                 ],
-              pagination: Sentdm::PaginationMeta
+              pagination:
+                Sentdm::Models::WebhookListEventsResponse::Data::Pagination
             }
           )
         end
@@ -183,10 +212,29 @@ module Sentdm
           sig { returns(T.nilable(String)) }
           attr_accessor :error_message
 
-          sig { returns(T.nilable(T.anything)) }
+          # The exact event body that was delivered, or attempted, for this record. One of
+          # the three webhook envelopes: a message status change, an inbound message, or a
+          # template status change. Read field and event to tell which, the same way your
+          # endpoint does.
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData::Variants
+              )
+            )
+          end
           attr_reader :event_data
 
-          sig { params(event_data: T.anything).void }
+          sig do
+            params(
+              event_data:
+                T.any(
+                  Sentdm::MessageEvent::OrHash,
+                  Sentdm::InboundMessageEvent::OrHash,
+                  Sentdm::TemplateEvent::OrHash
+                )
+            ).void
+          end
           attr_writer :event_data
 
           sig { returns(T.nilable(String)) }
@@ -214,7 +262,12 @@ module Sentdm
               delivery_attempts: Integer,
               delivery_status: String,
               error_message: T.nilable(String),
-              event_data: T.anything,
+              event_data:
+                T.any(
+                  Sentdm::MessageEvent::OrHash,
+                  Sentdm::InboundMessageEvent::OrHash,
+                  Sentdm::TemplateEvent::OrHash
+                ),
               event_type: String,
               http_status_code: T.nilable(Integer),
               processing_completed_at: T.nilable(Time),
@@ -228,6 +281,10 @@ module Sentdm
             delivery_attempts: nil,
             delivery_status: nil,
             error_message: nil,
+            # The exact event body that was delivered, or attempted, for this record. One of
+            # the three webhook envelopes: a message status change, an inbound message, or a
+            # template status change. Read field and event to tell which, the same way your
+            # endpoint does.
             event_data: nil,
             event_type: nil,
             http_status_code: nil,
@@ -245,7 +302,8 @@ module Sentdm
                 delivery_attempts: Integer,
                 delivery_status: String,
                 error_message: T.nilable(String),
-                event_data: T.anything,
+                event_data:
+                  Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData::Variants,
                 event_type: String,
                 http_status_code: T.nilable(Integer),
                 processing_completed_at: T.nilable(Time),
@@ -256,6 +314,308 @@ module Sentdm
           end
           def to_hash
           end
+
+          # The exact event body that was delivered, or attempted, for this record. One of
+          # the three webhook envelopes: a message status change, an inbound message, or a
+          # template status change. Read field and event to tell which, the same way your
+          # endpoint does.
+          module EventData
+            extend Sentdm::Internal::Type::Union
+
+            Variants =
+              T.type_alias do
+                T.any(
+                  Sentdm::MessageEvent,
+                  Sentdm::InboundMessageEvent,
+                  Sentdm::TemplateEvent
+                )
+              end
+
+            sig do
+              override.returns(
+                T::Array[
+                  Sentdm::Models::WebhookListEventsResponse::Data::Event::EventData::Variants
+                ]
+              )
+            end
+            def self.variants
+            end
+          end
+        end
+
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                Sentdm::Models::WebhookListEventsResponse::Data::Pagination,
+                Sentdm::Internal::AnyHash
+              )
+            end
+
+          # Cursor-based pagination. Never populated — see Cursors.
+          sig do
+            returns(
+              T.nilable(
+                Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors
+              )
+            )
+          end
+          attr_reader :cursors
+
+          sig do
+            params(
+              cursors:
+                T.nilable(
+                  Sentdm::Models::WebhookListEventsResponse::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::WebhookListEventsResponse::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::WebhookListEventsResponse::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::WebhookListEventsResponse::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::WebhookListEventsResponse::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::WebhookListEventsResponse::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