sentdm 0.27.0 → 0.28.0

data/lib/sentdm/models/webhook_list_events_response.rb

@@ -5,7 +5,7 @@ module Sentdm
     # @see Sentdm::Resources::Webhooks#list_events
     class WebhookListEventsResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   A paginated list of webhook delivery records.
       #
       #   @return [Sentdm::Models::WebhookListEventsResponse::Data, nil]
       optional :data, -> { Sentdm::Models::WebhookListEventsResponse::Data }, nil?: true
@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+      #   @return [Sentdm::Models::WebhookListEventsResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::WebhookListEventsResponse::Error }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
+      #   @return [Sentdm::Models::WebhookListEventsResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::WebhookListEventsResponse::Meta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -31,17 +31,18 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::WebhookListEventsResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::WebhookListEventsResponse::Data, nil] A paginated list of webhook delivery records.
       #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #   @param error [Sentdm::Models::WebhookListEventsResponse::Error, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #   @param meta [Sentdm::Models::WebhookListEventsResponse::Meta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
       # @see Sentdm::Models::WebhookListEventsResponse#data
       class Data < Sentdm::Internal::Type::BaseModel
         # @!attribute events
+        #   The events on this page.
         #
         #   @return [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>, nil]
         optional :events,
@@ -50,15 +51,15 @@ module Sentdm
         # @!attribute pagination
         #   Pagination metadata for list responses
         #
-        #   @return [Sentdm::Models::PaginationMeta, nil]
-        optional :pagination, -> { Sentdm::PaginationMeta }
+        #   @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination, nil]
+        optional :pagination, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination }
 
         # @!method initialize(events: nil, pagination: nil)
-        #   The response data (null if error)
+        #   A paginated list of webhook delivery records.
         #
-        #   @param events [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>]
+        #   @param events [Array<Sentdm::Models::WebhookListEventsResponse::Data::Event>] The events on this page.
         #
-        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+        #   @param pagination [Sentdm::Models::WebhookListEventsResponse::Data::Pagination] Pagination metadata for list responses
 
         class Event < Sentdm::Internal::Type::BaseModel
           # @!attribute id
@@ -171,6 +172,154 @@ module Sentdm
             #   @return [Array(Sentdm::Models::MessageEvent, Sentdm::Models::InboundMessageEvent, Sentdm::Models::TemplateEvent)]
           end
         end
+
+        # @see Sentdm::Models::WebhookListEventsResponse::Data#pagination
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          # @!attribute cursors
+          #   @deprecated
+          #
+          #   Cursor-based pagination. Never populated — see Cursors.
+          #
+          #   @return [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil]
+          optional :cursors, -> { Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors }, nil?: true
+
+          # @!attribute has_more
+          #   Whether there are more pages after this one
+          #
+          #   @return [Boolean, nil]
+          optional :has_more, Sentdm::Internal::Type::Boolean
+
+          # @!attribute page
+          #   Current page number (1-indexed)
+          #
+          #   @return [Integer, nil]
+          optional :page, Integer
+
+          # @!attribute page_size
+          #   Number of items per page
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute total_count
+          #   Total number of items across all pages
+          #
+          #   @return [Integer, nil]
+          optional :total_count, Integer
+
+          # @!attribute total_pages
+          #   Total number of pages
+          #
+          #   @return [Integer, nil]
+          optional :total_pages, Integer
+
+          # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
+          #   Pagination metadata for list responses
+          #
+          #   @param cursors [Sentdm::Models::WebhookListEventsResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
+          #
+          #   @param has_more [Boolean] Whether there are more pages after this one
+          #
+          #   @param page [Integer] Current page number (1-indexed)
+          #
+          #   @param page_size [Integer] Number of items per page
+          #
+          #   @param total_count [Integer] Total number of items across all pages
+          #
+          #   @param total_pages [Integer] Total number of pages
+
+          # @deprecated
+          #
+          # @see Sentdm::Models::WebhookListEventsResponse::Data::Pagination#cursors
+          class Cursors < Sentdm::Internal::Type::BaseModel
+            # @!attribute after
+            #   Cursor to fetch the next page.
+            #
+            #   @return [String, nil]
+            optional :after, String, nil?: true
+
+            # @!attribute before
+            #   Cursor to fetch the previous page.
+            #
+            #   @return [String, nil]
+            optional :before, String, nil?: true
+
+            # @!method initialize(after: nil, before: nil)
+            #   Cursor-based pagination. Never populated — see Cursors.
+            #
+            #   @param after [String, nil] Cursor to fetch the next page.
+            #
+            #   @param before [String, nil] Cursor to fetch the previous page.
+          end
+        end
+      end
+
+      # @see Sentdm::Models::WebhookListEventsResponse#error
+      class Error < Sentdm::Internal::Type::BaseModel
+        # @!attribute code
+        #   Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute details
+        #   Additional validation error details (field-level errors)
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
+
+        # @!attribute doc_url
+        #   URL to documentation about this error
+        #
+        #   @return [String, nil]
+        optional :doc_url, String, nil?: true
+
+        # @!attribute message
+        #   Human-readable error message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
+        #   Error information
+        #
+        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
+        #
+        #   @param doc_url [String, nil] URL to documentation about this error
+        #
+        #   @param message [String] Human-readable error message
+      end
+
+      # @see Sentdm::Models::WebhookListEventsResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute timestamp
+        #   Server timestamp when the response was generated
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!attribute version
+        #   API version used for this request
+        #
+        #   @return [String, nil]
+        optional :version, String
+
+        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
       end
     end
   end

data/lib/sentdm/models/webhook_list_response.rb

@@ -5,7 +5,7 @@ module Sentdm
     # @see Sentdm::Resources::Webhooks#list
     class WebhookListResponse < Sentdm::Internal::Type::BaseModel
       # @!attribute data
-      #   The response data (null if error)
+      #   A paginated list of webhooks.
       #
       #   @return [Sentdm::Models::WebhookListResponse::Data, nil]
       optional :data, -> { Sentdm::Models::WebhookListResponse::Data }, nil?: true
@@ -13,14 +13,14 @@ module Sentdm
       # @!attribute error
       #   Error information
       #
-      #   @return [Sentdm::Models::ErrorDetail, nil]
-      optional :error, -> { Sentdm::ErrorDetail }, nil?: true
+      #   @return [Sentdm::Models::WebhookListResponse::Error, nil]
+      optional :error, -> { Sentdm::Models::WebhookListResponse::Error }, nil?: true
 
       # @!attribute meta
       #   Request and response metadata
       #
-      #   @return [Sentdm::Models::APIMeta, nil]
-      optional :meta, -> { Sentdm::APIMeta }
+      #   @return [Sentdm::Models::WebhookListResponse::Meta, nil]
+      optional :meta, -> { Sentdm::Models::WebhookListResponse::Meta }
 
       # @!attribute success
       #   Indicates whether the request was successful
@@ -31,11 +31,11 @@ module Sentdm
       # @!method initialize(data: nil, error: nil, meta: nil, success: nil)
       #   Standard API response envelope for all v3 endpoints
       #
-      #   @param data [Sentdm::Models::WebhookListResponse::Data, nil] The response data (null if error)
+      #   @param data [Sentdm::Models::WebhookListResponse::Data, nil] A paginated list of webhooks.
       #
-      #   @param error [Sentdm::Models::ErrorDetail, nil] Error information
+      #   @param error [Sentdm::Models::WebhookListResponse::Error, nil] Error information
       #
-      #   @param meta [Sentdm::Models::APIMeta] Request and response metadata
+      #   @param meta [Sentdm::Models::WebhookListResponse::Meta] Request and response metadata
       #
       #   @param success [Boolean] Indicates whether the request was successful
 
@@ -44,20 +44,285 @@ module Sentdm
         # @!attribute pagination
         #   Pagination metadata for list responses
         #
-        #   @return [Sentdm::Models::PaginationMeta, nil]
-        optional :pagination, -> { Sentdm::PaginationMeta }
+        #   @return [Sentdm::Models::WebhookListResponse::Data::Pagination, nil]
+        optional :pagination, -> { Sentdm::Models::WebhookListResponse::Data::Pagination }
 
         # @!attribute webhooks
+        #   The webhooks on this page.
         #
-        #   @return [Array<Sentdm::Models::WebhookResponse>, nil]
-        optional :webhooks, -> { Sentdm::Internal::Type::ArrayOf[Sentdm::WebhookResponse] }
+        #   @return [Array<Sentdm::Models::WebhookListResponse::Data::Webhook>, nil]
+        optional :webhooks,
+                 -> { Sentdm::Internal::Type::ArrayOf[Sentdm::Models::WebhookListResponse::Data::Webhook] }
 
         # @!method initialize(pagination: nil, webhooks: nil)
-        #   The response data (null if error)
+        #   A paginated list of webhooks.
         #
-        #   @param pagination [Sentdm::Models::PaginationMeta] Pagination metadata for list responses
+        #   @param pagination [Sentdm::Models::WebhookListResponse::Data::Pagination] Pagination metadata for list responses
         #
-        #   @param webhooks [Array<Sentdm::Models::WebhookResponse>]
+        #   @param webhooks [Array<Sentdm::Models::WebhookListResponse::Data::Webhook>] The webhooks on this page.
+
+        # @see Sentdm::Models::WebhookListResponse::Data#pagination
+        class Pagination < Sentdm::Internal::Type::BaseModel
+          # @!attribute cursors
+          #   @deprecated
+          #
+          #   Cursor-based pagination. Never populated — see Cursors.
+          #
+          #   @return [Sentdm::Models::WebhookListResponse::Data::Pagination::Cursors, nil]
+          optional :cursors, -> { Sentdm::Models::WebhookListResponse::Data::Pagination::Cursors }, nil?: true
+
+          # @!attribute has_more
+          #   Whether there are more pages after this one
+          #
+          #   @return [Boolean, nil]
+          optional :has_more, Sentdm::Internal::Type::Boolean
+
+          # @!attribute page
+          #   Current page number (1-indexed)
+          #
+          #   @return [Integer, nil]
+          optional :page, Integer
+
+          # @!attribute page_size
+          #   Number of items per page
+          #
+          #   @return [Integer, nil]
+          optional :page_size, Integer
+
+          # @!attribute total_count
+          #   Total number of items across all pages
+          #
+          #   @return [Integer, nil]
+          optional :total_count, Integer
+
+          # @!attribute total_pages
+          #   Total number of pages
+          #
+          #   @return [Integer, nil]
+          optional :total_pages, Integer
+
+          # @!method initialize(cursors: nil, has_more: nil, page: nil, page_size: nil, total_count: nil, total_pages: nil)
+          #   Pagination metadata for list responses
+          #
+          #   @param cursors [Sentdm::Models::WebhookListResponse::Data::Pagination::Cursors, nil] Cursor-based pagination. Never populated — see Cursors.
+          #
+          #   @param has_more [Boolean] Whether there are more pages after this one
+          #
+          #   @param page [Integer] Current page number (1-indexed)
+          #
+          #   @param page_size [Integer] Number of items per page
+          #
+          #   @param total_count [Integer] Total number of items across all pages
+          #
+          #   @param total_pages [Integer] Total number of pages
+
+          # @deprecated
+          #
+          # @see Sentdm::Models::WebhookListResponse::Data::Pagination#cursors
+          class Cursors < Sentdm::Internal::Type::BaseModel
+            # @!attribute after
+            #   Cursor to fetch the next page.
+            #
+            #   @return [String, nil]
+            optional :after, String, nil?: true
+
+            # @!attribute before
+            #   Cursor to fetch the previous page.
+            #
+            #   @return [String, nil]
+            optional :before, String, nil?: true
+
+            # @!method initialize(after: nil, before: nil)
+            #   Cursor-based pagination. Never populated — see Cursors.
+            #
+            #   @param after [String, nil] Cursor to fetch the next page.
+            #
+            #   @param before [String, nil] Cursor to fetch the previous page.
+          end
+        end
+
+        class Webhook < Sentdm::Internal::Type::BaseModel
+          # @!attribute id
+          #
+          #   @return [String, nil]
+          optional :id, String
+
+          # @!attribute consecutive_failures
+          #
+          #   @return [Integer, nil]
+          optional :consecutive_failures, Integer
+
+          # @!attribute created_at
+          #
+          #   @return [Time, nil]
+          optional :created_at, Time
+
+          # @!attribute customer_id
+          #   Which customer owns this — the key's own, or the profile named in x-profile-id.
+          #   Says whose resource this is, which the resource's own id does not.
+          #
+          #   @return [String, nil]
+          optional :customer_id, String
+
+          # @!attribute display_name
+          #
+          #   @return [String, nil]
+          optional :display_name, String
+
+          # @!attribute endpoint_url
+          #
+          #   @return [String, nil]
+          optional :endpoint_url, String
+
+          # @!attribute event_filters
+          #
+          #   @return [Hash{Symbol=>Array<String>}, nil]
+          optional :event_filters,
+                   Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]],
+                   nil?: true
+
+          # @!attribute event_types
+          #
+          #   @return [Array<String>, nil]
+          optional :event_types, Sentdm::Internal::Type::ArrayOf[String]
+
+          # @!attribute is_active
+          #
+          #   @return [Boolean, nil]
+          optional :is_active, Sentdm::Internal::Type::Boolean
+
+          # @!attribute last_delivery_attempt_at
+          #
+          #   @return [Time, nil]
+          optional :last_delivery_attempt_at, Time, nil?: true
+
+          # @!attribute last_successful_delivery_at
+          #
+          #   @return [Time, nil]
+          optional :last_successful_delivery_at, Time, nil?: true
+
+          # @!attribute retry_count
+          #
+          #   @return [Integer, nil]
+          optional :retry_count, Integer
+
+          # @!attribute signing_secret
+          #
+          #   @return [String, nil]
+          optional :signing_secret, String, nil?: true
+
+          # @!attribute timeout_seconds
+          #
+          #   @return [Integer, nil]
+          optional :timeout_seconds, Integer
+
+          # @!attribute updated_at
+          #
+          #   @return [Time, nil]
+          optional :updated_at, Time, nil?: true
+
+          # @!method initialize(id: nil, consecutive_failures: nil, created_at: nil, customer_id: nil, display_name: nil, endpoint_url: nil, event_filters: nil, event_types: nil, is_active: nil, last_delivery_attempt_at: nil, last_successful_delivery_at: nil, retry_count: nil, signing_secret: nil, timeout_seconds: nil, updated_at: nil)
+          #   Some parameter documentations has been truncated, see
+          #   {Sentdm::Models::WebhookListResponse::Data::Webhook} for more details.
+          #
+          #   @param id [String]
+          #
+          #   @param consecutive_failures [Integer]
+          #
+          #   @param created_at [Time]
+          #
+          #   @param customer_id [String] Which customer owns this — the key's own, or the profile named in x-profile-id.
+          #
+          #   @param display_name [String]
+          #
+          #   @param endpoint_url [String]
+          #
+          #   @param event_filters [Hash{Symbol=>Array<String>}, nil]
+          #
+          #   @param event_types [Array<String>]
+          #
+          #   @param is_active [Boolean]
+          #
+          #   @param last_delivery_attempt_at [Time, nil]
+          #
+          #   @param last_successful_delivery_at [Time, nil]
+          #
+          #   @param retry_count [Integer]
+          #
+          #   @param signing_secret [String, nil]
+          #
+          #   @param timeout_seconds [Integer]
+          #
+          #   @param updated_at [Time, nil]
+        end
+      end
+
+      # @see Sentdm::Models::WebhookListResponse#error
+      class Error < Sentdm::Internal::Type::BaseModel
+        # @!attribute code
+        #   Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @return [String, nil]
+        optional :code, String
+
+        # @!attribute details
+        #   Additional validation error details (field-level errors)
+        #
+        #   @return [Hash{Symbol=>Array<String>}, nil]
+        optional :details, Sentdm::Internal::Type::HashOf[Sentdm::Internal::Type::ArrayOf[String]], nil?: true
+
+        # @!attribute doc_url
+        #   URL to documentation about this error
+        #
+        #   @return [String, nil]
+        optional :doc_url, String, nil?: true
+
+        # @!attribute message
+        #   Human-readable error message
+        #
+        #   @return [String, nil]
+        optional :message, String
+
+        # @!method initialize(code: nil, details: nil, doc_url: nil, message: nil)
+        #   Error information
+        #
+        #   @param code [String] Machine-readable error code (e.g., "RESOURCE_001")
+        #
+        #   @param details [Hash{Symbol=>Array<String>}, nil] Additional validation error details (field-level errors)
+        #
+        #   @param doc_url [String, nil] URL to documentation about this error
+        #
+        #   @param message [String] Human-readable error message
+      end
+
+      # @see Sentdm::Models::WebhookListResponse#meta
+      class Meta < Sentdm::Internal::Type::BaseModel
+        # @!attribute request_id
+        #   Unique identifier for this request (for tracing and support)
+        #
+        #   @return [String, nil]
+        optional :request_id, String
+
+        # @!attribute timestamp
+        #   Server timestamp when the response was generated
+        #
+        #   @return [Time, nil]
+        optional :timestamp, Time
+
+        # @!attribute version
+        #   API version used for this request
+        #
+        #   @return [String, nil]
+        optional :version, String
+
+        # @!method initialize(request_id: nil, timestamp: nil, version: nil)
+        #   Request and response metadata
+        #
+        #   @param request_id [String] Unique identifier for this request (for tracing and support)
+        #
+        #   @param timestamp [Time] Server timestamp when the response was generated
+        #
+        #   @param version [String] API version used for this request
       end
     end
   end