context.dev 2.14.0 → 2.15.0

data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi

@@ -0,0 +1,81 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    module Webhooks
+      class DeliveryRetryParams < ContextDev::Internal::Type::BaseModel
+        extend ContextDev::Internal::Type::RequestParameters::Converter
+        include ContextDev::Internal::Type::RequestParameters
+
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Webhooks::DeliveryRetryParams,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Delivery ID.
+        sig { returns(String) }
+        attr_accessor :delivery_id
+
+        # Resend a delivery that already succeeded.
+        sig { returns(T.nilable(T::Boolean)) }
+        attr_reader :force
+
+        sig { params(force: T::Boolean).void }
+        attr_writer :force
+
+        # 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
+
+        # Unique key to prevent duplicate retry requests.
+        sig { returns(T.nilable(String)) }
+        attr_reader :idempotency_key
+
+        sig { params(idempotency_key: String).void }
+        attr_writer :idempotency_key
+
+        sig do
+          params(
+            delivery_id: String,
+            force: T::Boolean,
+            tags: T::Array[String],
+            idempotency_key: String,
+            request_options: ContextDev::RequestOptions::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Delivery ID.
+          delivery_id:,
+          # Resend a delivery that already succeeded.
+          force: nil,
+          # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+          tags: nil,
+          # Unique key to prevent duplicate retry requests.
+          idempotency_key: nil,
+          request_options: {}
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              delivery_id: String,
+              force: T::Boolean,
+              tags: T::Array[String],
+              idempotency_key: String,
+              request_options: ContextDev::RequestOptions
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi

@@ -0,0 +1,107 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    module Webhooks
+      class DeliveryRetryResponse < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::Webhooks::DeliveryRetryResponse,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Delivery ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Credit usage, included whenever a valid API key is provided.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata
+            )
+          )
+        end
+        attr_reader :key_metadata
+
+        sig do
+          params(
+            key_metadata:
+              ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata::OrHash
+          ).void
+        end
+        attr_writer :key_metadata
+
+        sig do
+          params(
+            id: String,
+            key_metadata:
+              ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata::OrHash
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Delivery ID.
+          id:,
+          # Credit usage, included whenever a valid API key is provided.
+          key_metadata: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              key_metadata:
+                ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata
+            }
+          )
+        end
+        def to_hash
+        end
+
+        class KeyMetadata < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Models::Webhooks::DeliveryRetryResponse::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_summary.rbi

@@ -0,0 +1,459 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    module Webhooks
+      class DeliverySummary < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Webhooks::DeliverySummary,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Delivery ID.
+        sig { returns(String) }
+        attr_accessor :id
+
+        # Event creation time.
+        sig { returns(Time) }
+        attr_accessor :created_at
+
+        # Last successful delivery time, or null if never delivered.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :delivered_at
+
+        # Webhook event type.
+        sig do
+          returns(ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol)
+        end
+        attr_accessor :event
+
+        # Latest delivery error, or null if none.
+        sig do
+          returns(T.nilable(ContextDev::Webhooks::DeliverySummary::LastError))
+        end
+        attr_reader :last_error
+
+        sig do
+          params(
+            last_error:
+              T.nilable(
+                ContextDev::Webhooks::DeliverySummary::LastError::OrHash
+              )
+          ).void
+        end
+        attr_writer :last_error
+
+        # Next scheduled attempt, or null if none.
+        sig { returns(T.nilable(Time)) }
+        attr_accessor :next_attempt_at
+
+        # Manual retry deadline, seven days after event creation.
+        sig { returns(Time) }
+        attr_accessor :retry_expires_at
+
+        # Batch or monitor run that produced the event.
+        sig { returns(ContextDev::Webhooks::DeliverySummary::Source::Variants) }
+        attr_accessor :source
+
+        # Current delivery status.
+        sig do
+          returns(ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol)
+        end
+        attr_accessor :status
+
+        # Webhook destination URL.
+        sig { returns(String) }
+        attr_accessor :url
+
+        sig do
+          params(
+            id: String,
+            created_at: Time,
+            delivered_at: T.nilable(Time),
+            event: ContextDev::Webhooks::DeliverySummary::Event::OrSymbol,
+            last_error:
+              T.nilable(
+                ContextDev::Webhooks::DeliverySummary::LastError::OrHash
+              ),
+            next_attempt_at: T.nilable(Time),
+            retry_expires_at: Time,
+            source:
+              T.any(
+                ContextDev::Webhooks::DeliverySummary::Source::Batch::OrHash,
+                ContextDev::Webhooks::DeliverySummary::Source::Monitor::OrHash
+              ),
+            status: ContextDev::Webhooks::DeliverySummary::Status::OrSymbol,
+            url: String
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Delivery ID.
+          id:,
+          # Event creation time.
+          created_at:,
+          # Last successful delivery time, or null if never delivered.
+          delivered_at:,
+          # Webhook event type.
+          event:,
+          # Latest delivery error, or null if none.
+          last_error:,
+          # Next scheduled attempt, or null if none.
+          next_attempt_at:,
+          # Manual retry deadline, seven days after event creation.
+          retry_expires_at:,
+          # Batch or monitor run that produced the event.
+          source:,
+          # Current delivery status.
+          status:,
+          # Webhook destination URL.
+          url:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              id: String,
+              created_at: Time,
+              delivered_at: T.nilable(Time),
+              event: ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol,
+              last_error:
+                T.nilable(ContextDev::Webhooks::DeliverySummary::LastError),
+              next_attempt_at: T.nilable(Time),
+              retry_expires_at: Time,
+              source: ContextDev::Webhooks::DeliverySummary::Source::Variants,
+              status:
+                ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol,
+              url: String
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Webhook event type.
+        module Event
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ContextDev::Webhooks::DeliverySummary::Event)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          BATCH_COMPLETED =
+            T.let(
+              :"batch.completed",
+              ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol
+            )
+          BATCH_FAILED =
+            T.let(
+              :"batch.failed",
+              ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol
+            )
+          BATCH_CANCELLED =
+            T.let(
+              :"batch.cancelled",
+              ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol
+            )
+          CHANGE_DETECTED =
+            T.let(
+              :"change.detected",
+              ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol
+            )
+          RUN_COMPLETED =
+            T.let(
+              :"run.completed",
+              ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Webhooks::DeliverySummary::Event::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+
+        class LastError < ContextDev::Internal::Type::BaseModel
+          OrHash =
+            T.type_alias do
+              T.any(
+                ContextDev::Webhooks::DeliverySummary::LastError,
+                ContextDev::Internal::AnyHash
+              )
+            end
+
+          # Error code.
+          sig { returns(String) }
+          attr_accessor :code
+
+          # Error details.
+          sig { returns(String) }
+          attr_accessor :message
+
+          # Latest delivery error, or null if none.
+          sig do
+            params(code: String, message: String).returns(T.attached_class)
+          end
+          def self.new(
+            # Error code.
+            code:,
+            # Error details.
+            message:
+          )
+          end
+
+          sig { override.returns({ code: String, message: String }) }
+          def to_hash
+          end
+        end
+
+        # Batch or monitor run that produced the event.
+        module Source
+          extend ContextDev::Internal::Type::Union
+
+          Variants =
+            T.type_alias do
+              T.any(
+                ContextDev::Webhooks::DeliverySummary::Source::Batch,
+                ContextDev::Webhooks::DeliverySummary::Source::Monitor
+              )
+            end
+
+          class Batch < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Webhooks::DeliverySummary::Source::Batch,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Batch ID.
+            sig { returns(String) }
+            attr_accessor :batch_id
+
+            # Delivery source.
+            sig do
+              returns(
+                ContextDev::Webhooks::DeliverySummary::Source::Batch::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                batch_id: String,
+                type:
+                  ContextDev::Webhooks::DeliverySummary::Source::Batch::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Batch ID.
+              batch_id:,
+              # Delivery source.
+              type:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  batch_id: String,
+                  type:
+                    ContextDev::Webhooks::DeliverySummary::Source::Batch::Type::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Delivery source.
+            module Type
+              extend ContextDev::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    ContextDev::Webhooks::DeliverySummary::Source::Batch::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              BATCH =
+                T.let(
+                  :batch,
+                  ContextDev::Webhooks::DeliverySummary::Source::Batch::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    ContextDev::Webhooks::DeliverySummary::Source::Batch::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          class Monitor < ContextDev::Internal::Type::BaseModel
+            OrHash =
+              T.type_alias do
+                T.any(
+                  ContextDev::Webhooks::DeliverySummary::Source::Monitor,
+                  ContextDev::Internal::AnyHash
+                )
+              end
+
+            # Monitor ID.
+            sig { returns(String) }
+            attr_accessor :monitor_id
+
+            # Monitor run ID.
+            sig { returns(String) }
+            attr_accessor :run_id
+
+            # Delivery source.
+            sig do
+              returns(
+                ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type::TaggedSymbol
+              )
+            end
+            attr_accessor :type
+
+            sig do
+              params(
+                monitor_id: String,
+                run_id: String,
+                type:
+                  ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type::OrSymbol
+              ).returns(T.attached_class)
+            end
+            def self.new(
+              # Monitor ID.
+              monitor_id:,
+              # Monitor run ID.
+              run_id:,
+              # Delivery source.
+              type:
+            )
+            end
+
+            sig do
+              override.returns(
+                {
+                  monitor_id: String,
+                  run_id: String,
+                  type:
+                    ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type::TaggedSymbol
+                }
+              )
+            end
+            def to_hash
+            end
+
+            # Delivery source.
+            module Type
+              extend ContextDev::Internal::Type::Enum
+
+              TaggedSymbol =
+                T.type_alias do
+                  T.all(
+                    Symbol,
+                    ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type
+                  )
+                end
+              OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+              MONITOR =
+                T.let(
+                  :monitor,
+                  ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type::TaggedSymbol
+                )
+
+              sig do
+                override.returns(
+                  T::Array[
+                    ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type::TaggedSymbol
+                  ]
+                )
+              end
+              def self.values
+              end
+            end
+          end
+
+          sig do
+            override.returns(
+              T::Array[ContextDev::Webhooks::DeliverySummary::Source::Variants]
+            )
+          end
+          def self.variants
+          end
+        end
+
+        # Current delivery status.
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(Symbol, ContextDev::Webhooks::DeliverySummary::Status)
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          PENDING =
+            T.let(
+              :pending,
+              ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol
+            )
+          DELIVERING =
+            T.let(
+              :delivering,
+              ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol
+            )
+          RETRYING =
+            T.let(
+              :retrying,
+              ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol
+            )
+          DELIVERED =
+            T.let(
+              :delivered,
+              ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol
+            )
+          FAILED =
+            T.let(
+              :failed,
+              ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol
+            )
+          CANCELLED =
+            T.let(
+              :cancelled,
+              ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models.rbi

@@ -70,6 +70,8 @@ module ContextDev
 
   PersonEnrichParams = ContextDev::Models::PersonEnrichParams
 
+  RetryConfig = ContextDev::Models::RetryConfig
+
   UtilityPrefetchParams = ContextDev::Models::UtilityPrefetchParams
 
   WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
@@ -82,6 +84,8 @@ module ContextDev
 
   WebhookDelivery = ContextDev::Models::WebhookDelivery
 
+  Webhooks = ContextDev::Models::Webhooks
+
   WebScreenshotParams = ContextDev::Models::WebScreenshotParams
 
   WebSearchParams = ContextDev::Models::WebSearchParams

data/rbi/context_dev/resources/batch.rbi

@@ -111,6 +111,7 @@ module ContextDev
               ContextDev::BatchSubmitParams::Input::Crawl::OrHash
             ),
           tags: T::Array[String],
+          webhook: ContextDev::BatchSubmitParams::Webhook::OrHash,
           webhook_url: String,
           idempotency_key: String,
           request_options: ContextDev::RequestOptions::OrHash
@@ -121,7 +122,11 @@ module ContextDev
         input:,
         # Body param: Tags stored on the batch. Filter the batch list by them later.
         tags: nil,
-        # Body param: URL notified when the batch finishes.
+        # Body param: Completion webhook settings. Cannot be combined with webhookUrl.
+        # Omitting retry preserves legacy delivery; retry: {} opts into durable retries.
+        webhook: nil,
+        # Body param: Legacy URL notified when the batch finishes. Preserves one
+        # best-effort attempt. Cannot be combined with webhook.
         webhook_url: nil,
         # Header param: Any string unique to this submission. Retries with the same key
         # return the original batch.

data/rbi/context_dev/resources/brand.rbi

@@ -50,9 +50,8 @@ module ContextDev
         # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
         # year.
         max_age_ms: nil,
-        # Optional comma-separated caller-defined tags for tracking this request. Tags are
-        # recorded on the request's usage log and can be used to filter usage on the
-        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+        # characters.
         tags: nil,
         # Optional theme preference used when selecting brand assets.
         theme: nil,
@@ -85,9 +84,8 @@ module ContextDev
         # Fields to match the search term against, as a comma-separated list or repeated
         # parameter: 'name', 'domain', or both. Defaults to both.
         query_by: nil,
-        # Optional comma-separated caller-defined tags for tracking this request. Tags are
-        # recorded on the request's usage log and can be used to filter usage on the
-        # dashboard usage page. Up to 20 tags, each 1-50 characters.
+        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+        # characters.
         tags: nil,
         # Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
         # typo tolerance).