context.dev 2.14.0 → 2.16.0

data/rbi/context_dev/models/webhooks/delivery_list_params.rbi

@@ -0,0 +1,427 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    module Webhooks
+      class DeliveryListParams < ContextDev::Internal::Type::BaseModel
+        extend ContextDev::Internal::Type::RequestParameters::Converter
+        include ContextDev::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Webhooks::DeliveryListParams,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        sig do
+          returns(
+            T.any(
+              ContextDev::Webhooks::DeliveryListParams::Body::Batch,
+              ContextDev::Webhooks::DeliveryListParams::Body::Monitor
+            )
+          )
+        end
+        attr_accessor :body
+
+        sig do
+          params(
+            body:
+              T.any(
+                ContextDev::Webhooks::DeliveryListParams::Body::Batch::OrHash,
+                ContextDev::Webhooks::DeliveryListParams::Body::Monitor::OrHash
+              ),
+            request_options: ContextDev::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(body:, request_options: {})
+        end
+
+        sig do
+          override.returns(
+            {
+              body:
+                T.any(
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor
+                ),
+              request_options: ContextDev::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+
+        module Body
+          extend ContextDev::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                ContextDev::Webhooks::DeliveryListParams::Body::Batch,
+                ContextDev::Webhooks::DeliveryListParams::Body::Monitor
+              )
+            end
+
+          class Batch < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Delivery source.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Filter by batch ID.
+            sig { returns(T.nilable(String)) }
+            attr_reader :batch_id
+
+            sig { params(batch_id: String).void }
+            attr_writer :batch_id
+
+            # Only include events created after this ISO 8601 timestamp.
+            sig { returns(T.nilable(Time)) }
+            attr_reader :created_after
+
+            sig { params(created_after: Time).void }
+            attr_writer :created_after
+
+            # The next_cursor from the previous response.
+            sig { returns(T.nilable(String)) }
+            attr_reader :cursor
+
+            sig { params(cursor: String).void }
+            attr_writer :cursor
+
+            # Number of deliveries to return.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :limit
+
+            sig { params(limit: Integer).void }
+            attr_writer :limit
+
+            # Filter by delivery status.
+            sig do
+              returns(
+                T.nilable(
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::OrSymbol
+                )
+              )
+            end
+            attr_reader :status
+
+            sig do
+              params(
+                status:
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::OrSymbol
+              ).void
+            end
+            attr_writer :status
+
+            # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :tags
+
+            sig { params(tags: T::Array[String]).void }
+            attr_writer :tags
+
+            sig do
+              params(
+                batch_id: String,
+                created_after: Time,
+                cursor: String,
+                limit: Integer,
+                status:
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::OrSymbol,
+                tags: T::Array[String],
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Filter by batch ID.
+              batch_id: nil,
+              # Only include events created after this ISO 8601 timestamp.
+              created_after: nil,
+              # The next_cursor from the previous response.
+              cursor: nil,
+              # Number of deliveries to return.
+              limit: nil,
+              # Filter by delivery status.
+              status: nil,
+              # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+              tags: nil,
+              # Delivery source.
+              type: :batch
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  type: Symbol,
+                  batch_id: String,
+                  created_after: Time,
+                  cursor: String,
+                  limit: Integer,
+                  status:
+                    ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::OrSymbol,
+                  tags: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Filter by delivery status.
+            module Status
+              extend ContextDev::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PENDING =
+                T.let(
+                  :pending,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::TaggedSymbol
+                )
+              DELIVERING =
+                T.let(
+                  :delivering,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::TaggedSymbol
+                )
+              RETRYING =
+                T.let(
+                  :retrying,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::TaggedSymbol
+                )
+              DELIVERED =
+                T.let(
+                  :delivered,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::TaggedSymbol
+                )
+              FAILED =
+                T.let(
+                  :failed,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::TaggedSymbol
+                )
+              CANCELLED =
+                T.let(
+                  :cancelled,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class Monitor < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Delivery source.
+            sig { returns(Symbol) }
+            attr_accessor :type
+
+            # Only include events created after this ISO 8601 timestamp.
+            sig { returns(T.nilable(Time)) }
+            attr_reader :created_after
+
+            sig { params(created_after: Time).void }
+            attr_writer :created_after
+
+            # The next_cursor from the previous response.
+            sig { returns(T.nilable(String)) }
+            attr_reader :cursor
+
+            sig { params(cursor: String).void }
+            attr_writer :cursor
+
+            # Number of deliveries to return.
+            sig { returns(T.nilable(Integer)) }
+            attr_reader :limit
+
+            sig { params(limit: Integer).void }
+            attr_writer :limit
+
+            # Filter by monitor ID.
+            sig { returns(T.nilable(String)) }
+            attr_reader :monitor_id
+
+            sig { params(monitor_id: String).void }
+            attr_writer :monitor_id
+
+            # Filter by monitor run ID.
+            sig { returns(T.nilable(String)) }
+            attr_reader :run_id
+
+            sig { params(run_id: String).void }
+            attr_writer :run_id
+
+            # Filter by delivery status.
+            sig do
+              returns(
+                T.nilable(
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::OrSymbol
+                )
+              )
+            end
+            attr_reader :status
+
+            sig do
+              params(
+                status:
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::OrSymbol
+              ).void
+            end
+            attr_writer :status
+
+            # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            sig { returns(T.nilable(T::Array[String])) }
+            attr_reader :tags
+
+            sig { params(tags: T::Array[String]).void }
+            attr_writer :tags
+
+            sig do
+              params(
+                created_after: Time,
+                cursor: String,
+                limit: Integer,
+                monitor_id: String,
+                run_id: String,
+                status:
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::OrSymbol,
+                tags: T::Array[String],
+                type: Symbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Only include events created after this ISO 8601 timestamp.
+              created_after: nil,
+              # The next_cursor from the previous response.
+              cursor: nil,
+              # Number of deliveries to return.
+              limit: nil,
+              # Filter by monitor ID.
+              monitor_id: nil,
+              # Filter by monitor run ID.
+              run_id: nil,
+              # Filter by delivery status.
+              status: nil,
+              # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+              tags: nil,
+              # Delivery source.
+              type: :monitor
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  type: Symbol,
+                  created_after: Time,
+                  cursor: String,
+                  limit: Integer,
+                  monitor_id: String,
+                  run_id: String,
+                  status:
+                    ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::OrSymbol,
+                  tags: T::Array[String]
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Filter by delivery status.
+            module Status
+              extend ContextDev::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              PENDING =
+                T.let(
+                  :pending,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::TaggedSymbol
+                )
+              DELIVERING =
+                T.let(
+                  :delivering,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::TaggedSymbol
+                )
+              RETRYING =
+                T.let(
+                  :retrying,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::TaggedSymbol
+                )
+              DELIVERED =
+                T.let(
+                  :delivered,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::TaggedSymbol
+                )
+              FAILED =
+                T.let(
+                  :failed,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::TaggedSymbol
+                )
+              CANCELLED =
+                T.let(
+                  :cancelled,
+                  ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[ContextDev::Webhooks::DeliveryListParams::Body::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/webhooks/delivery_list_response.rbi

@@ -0,0 +1,133 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    module Webhooks
+      class DeliveryListResponse < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::Webhooks::DeliveryListResponse,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Webhook deliveries.
+        sig { returns(T::Array[ContextDev::Webhooks::DeliverySummary]) }
+        attr_accessor :data
+
+        # Whether more deliveries are available.
+        sig { returns(T::Boolean) }
+        attr_accessor :has_more
+
+        # Next page cursor, or null on the last page.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :next_cursor
+
+        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        # it when contacting support about a failed request.
+        sig { returns(String) }
+        attr_accessor :request_id
+
+        # Credit usage, included whenever a valid API key is provided.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata
+            )
+          )
+        end
+        attr_reader :key_metadata
+
+        sig do
+          params(
+            key_metadata:
+              ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata::OrHash
+          ).void
+        end
+        attr_writer :key_metadata
+
+        sig do
+          params(
+            data: T::Array[ContextDev::Webhooks::DeliverySummary::OrHash],
+            has_more: T::Boolean,
+            next_cursor: T.nilable(String),
+            request_id: String,
+            key_metadata:
+              ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Webhook deliveries.
+          data:,
+          # Whether more deliveries are available.
+          has_more:,
+          # Next page cursor, or null on the last page.
+          next_cursor:,
+          # Unique id of this API call, also sent in the X-Request-Id response header. Quote
+          # it when contacting support about a failed request.
+          request_id:,
+          # Credit usage, included whenever a valid API key is provided.
+          key_metadata: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              data: T::Array[ContextDev::Webhooks::DeliverySummary],
+              has_more: T::Boolean,
+              next_cursor: T.nilable(String),
+              request_id: String,
+              key_metadata:
+                ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class KeyMetadata < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Credits used by this request.
+          sig { returns(Integer) }
+          attr_accessor :credits_consumed
+
+          # Credits remaining for your organization.
+          sig { returns(Integer) }
+          attr_accessor :credits_remaining
+
+          # Credit usage, included whenever a valid API key is provided.
+          sig do
+            params(
+              credits_consumed: Integer,
+              credits_remaining: Integer
+            ).returns(T.attached_class)
+          end
+          def self.new(
+            # Credits used by this request.
+            credits_consumed:,
+            # Credits remaining for your organization.
+            credits_remaining:
+          )
+          end
+
+          sig do
+            override.returns(
+              { credits_consumed: Integer, credits_remaining: Integer }
+            )
+          end
+          def to_hash
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi

@@ -0,0 +1,61 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    module Webhooks
+      class DeliveryRetrieveParams < ContextDev::Internal::Type::BaseModel
+        extend ContextDev::Internal::Type::RequestParameters::Converter
+        include ContextDev::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Webhooks::DeliveryRetrieveParams,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Delivery ID.
+        sig { returns(String) }
+        attr_accessor :delivery_id
+
+        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+        # characters.
+        sig { returns(T.nilable(T::Array[String])) }
+        attr_reader :tags
+
+        sig { params(tags: T::Array[String]).void }
+        attr_writer :tags
+
+        sig do
+          params(
+            delivery_id: String,
+            tags: T::Array[String],
+            request_options: ContextDev::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Delivery ID.
+          delivery_id:,
+          # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+          # characters.
+          tags: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              delivery_id: String,
+              tags: T::Array[String],
+              request_options: ContextDev::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end