context.dev 2.14.0 → 2.15.0

data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#list_attempts
+      class DeliveryListAttemptsResponse < ContextDev::Internal::Type::BaseModel
+        # @!attribute data
+        #   Delivery attempts.
+        #
+        #   @return [Array<ContextDev::Models::Webhooks::Attempt>]
+        required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Webhooks::Attempt] }
+
+        # @!attribute has_more
+        #   Whether more attempts are available.
+        #
+        #   @return [Boolean]
+        required :has_more, ContextDev::Internal::Type::Boolean
+
+        # @!attribute next_cursor
+        #   Next page cursor, or null on the last page.
+        #
+        #   @return [String, nil]
+        required :next_cursor, String, nil?: true
+
+        # @!attribute key_metadata
+        #   Credit usage, included whenever a valid API key is provided.
+        #
+        #   @return [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata, nil]
+        optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata }
+
+        # @!method initialize(data:, has_more:, next_cursor:, key_metadata: nil)
+        #   @param data [Array<ContextDev::Models::Webhooks::Attempt>] Delivery attempts.
+        #
+        #   @param has_more [Boolean] Whether more attempts are available.
+        #
+        #   @param next_cursor [String, nil] Next page cursor, or null on the last page.
+        #
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+
+        # @see ContextDev::Models::Webhooks::DeliveryListAttemptsResponse#key_metadata
+        class KeyMetadata < ContextDev::Internal::Type::BaseModel
+          # @!attribute credits_consumed
+          #   Credits used by this request.
+          #
+          #   @return [Integer]
+          required :credits_consumed, Integer
+
+          # @!attribute credits_remaining
+          #   Credits remaining for your organization.
+          #
+          #   @return [Integer]
+          required :credits_remaining, Integer
+
+          # @!method initialize(credits_consumed:, credits_remaining:)
+          #   Credit usage, included whenever a valid API key is provided.
+          #
+          #   @param credits_consumed [Integer] Credits used by this request.
+          #
+          #   @param credits_remaining [Integer] Credits remaining for your organization.
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery_list_params.rb

@@ -0,0 +1,195 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#list
+      class DeliveryListParams < ContextDev::Internal::Type::BaseModel
+        extend ContextDev::Internal::Type::RequestParameters::Converter
+        include ContextDev::Internal::Type::RequestParameters
+
+        # @!attribute body
+        #
+        #   @return [ContextDev::Models::Webhooks::DeliveryListParams::Body::Batch, ContextDev::Models::Webhooks::DeliveryListParams::Body::Monitor]
+        required :body, union: -> { ContextDev::Webhooks::DeliveryListParams::Body }
+
+        # @!method initialize(body:, request_options: {})
+        #   @param body [ContextDev::Models::Webhooks::DeliveryListParams::Body::Batch, ContextDev::Models::Webhooks::DeliveryListParams::Body::Monitor]
+        #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+        module Body
+          extend ContextDev::Internal::Type::Union
+
+          discriminator :type
+
+          variant :batch, -> { ContextDev::Webhooks::DeliveryListParams::Body::Batch }
+
+          variant :monitor, -> { ContextDev::Webhooks::DeliveryListParams::Body::Monitor }
+
+          class Batch < ContextDev::Internal::Type::BaseModel
+            # @!attribute type
+            #   Delivery source.
+            #
+            #   @return [Symbol, :batch]
+            required :type, const: :batch
+
+            # @!attribute batch_id
+            #   Filter by batch ID.
+            #
+            #   @return [String, nil]
+            optional :batch_id, String
+
+            # @!attribute created_after
+            #   Only include events created after this ISO 8601 timestamp.
+            #
+            #   @return [Time, nil]
+            optional :created_after, Time
+
+            # @!attribute cursor
+            #   The next_cursor from the previous response.
+            #
+            #   @return [String, nil]
+            optional :cursor, String
+
+            # @!attribute limit
+            #   Number of deliveries to return.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute status
+            #   Filter by delivery status.
+            #
+            #   @return [Symbol, ContextDev::Models::Webhooks::DeliveryListParams::Body::Batch::Status, nil]
+            optional :status, enum: -> { ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status }
+
+            # @!attribute tags
+            #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #
+            #   @return [Array<String>, nil]
+            optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(batch_id: nil, created_after: nil, cursor: nil, limit: nil, status: nil, tags: nil, type: :batch)
+            #   @param batch_id [String] Filter by batch ID.
+            #
+            #   @param created_after [Time] Only include events created after this ISO 8601 timestamp.
+            #
+            #   @param cursor [String] The next_cursor from the previous response.
+            #
+            #   @param limit [Integer] Number of deliveries to return.
+            #
+            #   @param status [Symbol, ContextDev::Models::Webhooks::DeliveryListParams::Body::Batch::Status] Filter by delivery status.
+            #
+            #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #
+            #   @param type [Symbol, :batch] Delivery source.
+
+            # Filter by delivery status.
+            #
+            # @see ContextDev::Models::Webhooks::DeliveryListParams::Body::Batch#status
+            module Status
+              extend ContextDev::Internal::Type::Enum
+
+              PENDING = :pending
+              DELIVERING = :delivering
+              RETRYING = :retrying
+              DELIVERED = :delivered
+              FAILED = :failed
+              CANCELLED = :cancelled
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          class Monitor < ContextDev::Internal::Type::BaseModel
+            # @!attribute type
+            #   Delivery source.
+            #
+            #   @return [Symbol, :monitor]
+            required :type, const: :monitor
+
+            # @!attribute created_after
+            #   Only include events created after this ISO 8601 timestamp.
+            #
+            #   @return [Time, nil]
+            optional :created_after, Time
+
+            # @!attribute cursor
+            #   The next_cursor from the previous response.
+            #
+            #   @return [String, nil]
+            optional :cursor, String
+
+            # @!attribute limit
+            #   Number of deliveries to return.
+            #
+            #   @return [Integer, nil]
+            optional :limit, Integer
+
+            # @!attribute monitor_id
+            #   Filter by monitor ID.
+            #
+            #   @return [String, nil]
+            optional :monitor_id, String
+
+            # @!attribute run_id
+            #   Filter by monitor run ID.
+            #
+            #   @return [String, nil]
+            optional :run_id, String
+
+            # @!attribute status
+            #   Filter by delivery status.
+            #
+            #   @return [Symbol, ContextDev::Models::Webhooks::DeliveryListParams::Body::Monitor::Status, nil]
+            optional :status, enum: -> { ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status }
+
+            # @!attribute tags
+            #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #
+            #   @return [Array<String>, nil]
+            optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+            # @!method initialize(created_after: nil, cursor: nil, limit: nil, monitor_id: nil, run_id: nil, status: nil, tags: nil, type: :monitor)
+            #   @param created_after [Time] Only include events created after this ISO 8601 timestamp.
+            #
+            #   @param cursor [String] The next_cursor from the previous response.
+            #
+            #   @param limit [Integer] Number of deliveries to return.
+            #
+            #   @param monitor_id [String] Filter by monitor ID.
+            #
+            #   @param run_id [String] Filter by monitor run ID.
+            #
+            #   @param status [Symbol, ContextDev::Models::Webhooks::DeliveryListParams::Body::Monitor::Status] Filter by delivery status.
+            #
+            #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #
+            #   @param type [Symbol, :monitor] Delivery source.
+
+            # Filter by delivery status.
+            #
+            # @see ContextDev::Models::Webhooks::DeliveryListParams::Body::Monitor#status
+            module Status
+              extend ContextDev::Internal::Type::Enum
+
+              PENDING = :pending
+              DELIVERING = :delivering
+              RETRYING = :retrying
+              DELIVERED = :delivered
+              FAILED = :failed
+              CANCELLED = :cancelled
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
+
+          # @!method self.variants
+          #   @return [Array(ContextDev::Models::Webhooks::DeliveryListParams::Body::Batch, ContextDev::Models::Webhooks::DeliveryListParams::Body::Monitor)]
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery_list_response.rb

@@ -0,0 +1,65 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#list
+      class DeliveryListResponse < ContextDev::Internal::Type::BaseModel
+        # @!attribute data
+        #   Webhook deliveries.
+        #
+        #   @return [Array<ContextDev::Models::Webhooks::DeliverySummary>]
+        required :data, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Webhooks::DeliverySummary] }
+
+        # @!attribute has_more
+        #   Whether more deliveries are available.
+        #
+        #   @return [Boolean]
+        required :has_more, ContextDev::Internal::Type::Boolean
+
+        # @!attribute next_cursor
+        #   Next page cursor, or null on the last page.
+        #
+        #   @return [String, nil]
+        required :next_cursor, String, nil?: true
+
+        # @!attribute key_metadata
+        #   Credit usage, included whenever a valid API key is provided.
+        #
+        #   @return [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata, nil]
+        optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata }
+
+        # @!method initialize(data:, has_more:, next_cursor:, key_metadata: nil)
+        #   @param data [Array<ContextDev::Models::Webhooks::DeliverySummary>] Webhook deliveries.
+        #
+        #   @param has_more [Boolean] Whether more deliveries are available.
+        #
+        #   @param next_cursor [String, nil] Next page cursor, or null on the last page.
+        #
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+
+        # @see ContextDev::Models::Webhooks::DeliveryListResponse#key_metadata
+        class KeyMetadata < ContextDev::Internal::Type::BaseModel
+          # @!attribute credits_consumed
+          #   Credits used by this request.
+          #
+          #   @return [Integer]
+          required :credits_consumed, Integer
+
+          # @!attribute credits_remaining
+          #   Credits remaining for your organization.
+          #
+          #   @return [Integer]
+          required :credits_remaining, Integer
+
+          # @!method initialize(credits_consumed:, credits_remaining:)
+          #   Credit usage, included whenever a valid API key is provided.
+          #
+          #   @param credits_consumed [Integer] Credits used by this request.
+          #
+          #   @param credits_remaining [Integer] Credits remaining for your organization.
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb

@@ -0,0 +1,36 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#retrieve
+      class DeliveryRetrieveParams < ContextDev::Internal::Type::BaseModel
+        extend ContextDev::Internal::Type::RequestParameters::Converter
+        include ContextDev::Internal::Type::RequestParameters
+
+        # @!attribute delivery_id
+        #   Delivery ID.
+        #
+        #   @return [String]
+        required :delivery_id, String
+
+        # @!attribute tags
+        #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+        #   characters.
+        #
+        #   @return [Array<String>, nil]
+        optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+        # @!method initialize(delivery_id:, tags: nil, request_options: {})
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::DeliveryRetrieveParams} for more details.
+        #
+        #   @param delivery_id [String] Delivery ID.
+        #
+        #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+        #
+        #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb

@@ -0,0 +1,40 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#retrieve
+      class DeliveryRetrieveResponse < ContextDev::Models::Webhooks::Delivery
+        # @!attribute key_metadata
+        #   Credit usage, included whenever a valid API key is provided.
+        #
+        #   @return [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata, nil]
+        optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata }
+
+        # @!method initialize(key_metadata: nil)
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+
+        class KeyMetadata < ContextDev::Internal::Type::BaseModel
+          # @!attribute credits_consumed
+          #   Credits used by this request.
+          #
+          #   @return [Integer]
+          required :credits_consumed, Integer
+
+          # @!attribute credits_remaining
+          #   Credits remaining for your organization.
+          #
+          #   @return [Integer]
+          required :credits_remaining, Integer
+
+          # @!method initialize(credits_consumed:, credits_remaining:)
+          #   Credit usage, included whenever a valid API key is provided.
+          #
+          #   @param credits_consumed [Integer] Credits used by this request.
+          #
+          #   @param credits_remaining [Integer] Credits remaining for your organization.
+        end
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery_retry_params.rb

@@ -0,0 +1,48 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#retry_
+      class DeliveryRetryParams < ContextDev::Internal::Type::BaseModel
+        extend ContextDev::Internal::Type::RequestParameters::Converter
+        include ContextDev::Internal::Type::RequestParameters
+
+        # @!attribute delivery_id
+        #   Delivery ID.
+        #
+        #   @return [String]
+        required :delivery_id, String
+
+        # @!attribute force
+        #   Resend a delivery that already succeeded.
+        #
+        #   @return [Boolean, nil]
+        optional :force, ContextDev::Internal::Type::Boolean
+
+        # @!attribute tags
+        #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        #
+        #   @return [Array<String>, nil]
+        optional :tags, ContextDev::Internal::Type::ArrayOf[String]
+
+        # @!attribute idempotency_key
+        #   Unique key to prevent duplicate retry requests.
+        #
+        #   @return [String, nil]
+        optional :idempotency_key, String
+
+        # @!method initialize(delivery_id:, force: nil, tags: nil, idempotency_key: nil, request_options: {})
+        #   @param delivery_id [String] Delivery ID.
+        #
+        #   @param force [Boolean] Resend a delivery that already succeeded.
+        #
+        #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        #
+        #   @param idempotency_key [String] Unique key to prevent duplicate retry requests.
+        #
+        #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+      end
+    end
+  end
+end

data/lib/context_dev/models/webhooks/delivery_retry_response.rb

@@ -0,0 +1,49 @@
+# frozen_string_literal: true
+
+module ContextDev
+  module Models
+    module Webhooks
+      # @see ContextDev::Resources::Webhooks::Deliveries#retry_
+      class DeliveryRetryResponse < ContextDev::Internal::Type::BaseModel
+        # @!attribute id
+        #   Delivery ID.
+        #
+        #   @return [String]
+        required :id, String
+
+        # @!attribute key_metadata
+        #   Credit usage, included whenever a valid API key is provided.
+        #
+        #   @return [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata, nil]
+        optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata }
+
+        # @!method initialize(id:, key_metadata: nil)
+        #   @param id [String] Delivery ID.
+        #
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+
+        # @see ContextDev::Models::Webhooks::DeliveryRetryResponse#key_metadata
+        class KeyMetadata < ContextDev::Internal::Type::BaseModel
+          # @!attribute credits_consumed
+          #   Credits used by this request.
+          #
+          #   @return [Integer]
+          required :credits_consumed, Integer
+
+          # @!attribute credits_remaining
+          #   Credits remaining for your organization.
+          #
+          #   @return [Integer]
+          required :credits_remaining, Integer
+
+          # @!method initialize(credits_consumed:, credits_remaining:)
+          #   Credit usage, included whenever a valid API key is provided.
+          #
+          #   @param credits_consumed [Integer] Credits used by this request.
+          #
+          #   @param credits_remaining [Integer] Credits remaining for your organization.
+        end
+      end
+    end
+  end
+end