context.dev 2.21.0 → 2.22.0

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

@@ -123,7 +123,7 @@ module ContextDev
             end
             attr_writer :status
 
-            # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            # Labels for filtering usage in the dashboard.
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :tags
 
@@ -153,7 +153,7 @@ module ContextDev
               limit: nil,
               # Filter by delivery status.
               status: nil,
-              # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+              # Labels for filtering usage in the dashboard.
               tags: nil,
               # Delivery source.
               type: :batch
@@ -299,7 +299,7 @@ module ContextDev
             end
             attr_writer :status
 
-            # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            # Labels for filtering usage in the dashboard.
             sig { returns(T.nilable(T::Array[String])) }
             attr_reader :tags
 
@@ -332,7 +332,7 @@ module ContextDev
               run_id: nil,
               # Filter by delivery status.
               status: nil,
-              # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+              # Labels for filtering usage in the dashboard.
               tags: nil,
               # Delivery source.
               type: :monitor

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

@@ -24,12 +24,12 @@ module ContextDev
         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.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         sig { returns(String) }
         attr_accessor :request_id
 
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         sig do
           returns(
             T.nilable(
@@ -64,10 +64,10 @@ module ContextDev
           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.
+          # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+          # support.
           request_id:,
-          # Credit usage, included whenever a valid API key is provided.
+          # Credits this request used and your remaining balance.
           key_metadata: nil
         )
         end
@@ -96,7 +96,7 @@ module ContextDev
               )
             end
 
-          # Credits used by this request.
+          # Credits charged for this request.
           sig { returns(Integer) }
           attr_accessor :credits_consumed
 
@@ -104,7 +104,7 @@ module ContextDev
           sig { returns(Integer) }
           attr_accessor :credits_remaining
 
-          # Credit usage, included whenever a valid API key is provided.
+          # Credits this request used and your remaining balance.
           sig do
             params(
               credits_consumed: Integer,
@@ -112,7 +112,7 @@ module ContextDev
             ).returns(T.attached_class)
           end
           def self.new(
-            # Credits used by this request.
+            # Credits charged for this request.
             credits_consumed:,
             # Credits remaining for your organization.
             credits_remaining:

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

@@ -19,8 +19,7 @@ module ContextDev
         sig { returns(String) }
         attr_accessor :delivery_id
 
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
+        # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :tags
 
@@ -37,8 +36,7 @@ module ContextDev
         def self.new(
           # Delivery ID.
           delivery_id:,
-          # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-          # characters.
+          # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
           tags: nil,
           request_options: {}
         )

data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi

@@ -12,12 +12,12 @@ module ContextDev
             )
           end
 
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         sig { returns(String) }
         attr_accessor :request_id
 
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         sig do
           returns(
             T.nilable(
@@ -43,10 +43,10 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-          # it when contacting support about a failed request.
+          # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+          # support.
           request_id:,
-          # Credit usage, included whenever a valid API key is provided.
+          # Credits this request used and your remaining balance.
           key_metadata: nil
         )
         end
@@ -72,7 +72,7 @@ module ContextDev
               )
             end
 
-          # Credits used by this request.
+          # Credits charged for this request.
           sig { returns(Integer) }
           attr_accessor :credits_consumed
 
@@ -80,7 +80,7 @@ module ContextDev
           sig { returns(Integer) }
           attr_accessor :credits_remaining
 
-          # Credit usage, included whenever a valid API key is provided.
+          # Credits this request used and your remaining balance.
           sig do
             params(
               credits_consumed: Integer,
@@ -88,7 +88,7 @@ module ContextDev
             ).returns(T.attached_class)
           end
           def self.new(
-            # Credits used by this request.
+            # Credits charged for this request.
             credits_consumed:,
             # Credits remaining for your organization.
             credits_remaining:

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

@@ -19,14 +19,14 @@ module ContextDev
         sig { returns(String) }
         attr_accessor :delivery_id
 
-        # Resend a delivery that already succeeded.
+        # Resend even if the delivery already succeeded. Defaults to false.
         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.
+        # Labels for filtering usage in the dashboard.
         sig { returns(T.nilable(T::Array[String])) }
         attr_reader :tags
 
@@ -52,9 +52,9 @@ module ContextDev
         def self.new(
           # Delivery ID.
           delivery_id:,
-          # Resend a delivery that already succeeded.
+          # Resend even if the delivery already succeeded. Defaults to false.
           force: nil,
-          # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+          # Labels for filtering usage in the dashboard.
           tags: nil,
           # Unique key to prevent duplicate retry requests.
           idempotency_key: nil,

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

@@ -16,12 +16,12 @@ module ContextDev
         sig { returns(String) }
         attr_accessor :id
 
-        # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-        # it when contacting support about a failed request.
+        # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        # support.
         sig { returns(String) }
         attr_accessor :request_id
 
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         sig do
           returns(
             T.nilable(
@@ -50,10 +50,10 @@ module ContextDev
         def self.new(
           # Delivery ID.
           id:,
-          # Unique id of this API call, also sent in the X-Request-Id response header. Quote
-          # it when contacting support about a failed request.
+          # Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+          # support.
           request_id:,
-          # Credit usage, included whenever a valid API key is provided.
+          # Credits this request used and your remaining balance.
           key_metadata: nil
         )
         end
@@ -80,7 +80,7 @@ module ContextDev
               )
             end
 
-          # Credits used by this request.
+          # Credits charged for this request.
           sig { returns(Integer) }
           attr_accessor :credits_consumed
 
@@ -88,7 +88,7 @@ module ContextDev
           sig { returns(Integer) }
           attr_accessor :credits_remaining
 
-          # Credit usage, included whenever a valid API key is provided.
+          # Credits this request used and your remaining balance.
           sig do
             params(
               credits_consumed: Integer,
@@ -96,7 +96,7 @@ module ContextDev
             ).returns(T.attached_class)
           end
           def self.new(
-            # Credits used by this request.
+            # Credits charged for this request.
             credits_consumed:,
             # Credits remaining for your organization.
             credits_remaining:

data/rbi/context_dev/models/webhooks/delivery_summary.rbi

@@ -50,7 +50,7 @@ module ContextDev
         sig { returns(T.nilable(Time)) }
         attr_accessor :next_attempt_at
 
-        # Manual retry deadline, seven days after event creation.
+        # Last time you can retry manually (7 days after the event).
         sig { returns(Time) }
         attr_accessor :retry_expires_at
 
@@ -58,7 +58,8 @@ module ContextDev
         sig { returns(ContextDev::Webhooks::DeliverySummary::Source::Variants) }
         attr_accessor :source
 
-        # Current delivery status.
+        # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        # (source or its webhook was removed).
         sig do
           returns(ContextDev::Webhooks::DeliverySummary::Status::TaggedSymbol)
         end
@@ -102,11 +103,12 @@ module ContextDev
           last_error:,
           # Next scheduled attempt, or null if none.
           next_attempt_at:,
-          # Manual retry deadline, seven days after event creation.
+          # Last time you can retry manually (7 days after the event).
           retry_expires_at:,
           # Batch or monitor run that produced the event.
           source:,
-          # Current delivery status.
+          # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+          # (source or its webhook was removed).
           status:,
           # Webhook destination URL.
           url:
@@ -240,7 +242,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :batch_id
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             sig do
               returns(
                 ContextDev::Webhooks::DeliverySummary::Source::Batch::Type::TaggedSymbol
@@ -258,7 +260,7 @@ module ContextDev
             def self.new(
               # Batch ID.
               batch_id:,
-              # Delivery source.
+              # Which deliveries to list: `batch` or `monitor`.
               type:
             )
             end
@@ -275,7 +277,7 @@ module ContextDev
             def to_hash
             end
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             module Type
               extend ContextDev::Internal::Type::Enum
 
@@ -323,7 +325,7 @@ module ContextDev
             sig { returns(String) }
             attr_accessor :run_id
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             sig do
               returns(
                 ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type::TaggedSymbol
@@ -344,7 +346,7 @@ module ContextDev
               monitor_id:,
               # Monitor run ID.
               run_id:,
-              # Delivery source.
+              # Which deliveries to list: `batch` or `monitor`.
               type:
             )
             end
@@ -362,7 +364,7 @@ module ContextDev
             def to_hash
             end
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             module Type
               extend ContextDev::Internal::Type::Enum
 
@@ -402,7 +404,8 @@ module ContextDev
           end
         end
 
-        # Current delivery status.
+        # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        # (source or its webhook was removed).
         module Status
           extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/resources/batch.rbi

@@ -4,7 +4,8 @@ module ContextDev
   module Resources
     # Scrape many pages or crawl a site asynchronously.
     class Batch
-      # Check progress, and get download links once the batch finishes.
+      # Get batch progress and result download links. Result files are deleted 7 days
+      # after the batch finishes.
       sig do
         params(
           batch_id: String,
@@ -12,14 +13,13 @@ module ContextDev
         ).returns(ContextDev::Models::BatchRetrieveResponse)
       end
       def retrieve(
-        # ID of the batch to retrieve or cancel.
+        # Batch ID.
         batch_id,
         request_options: {}
       )
       end
 
-      # List your batches from newest to oldest. Filter by status or continue with a
-      # cursor.
+      # List your batches, newest first, with optional filters.
       sig do
         params(
           cursor: String,
@@ -50,8 +50,8 @@ module ContextDev
       )
       end
 
-      # Permanently delete a finished batch and its stored results. Active batches must
-      # settle first.
+      # Permanently delete a finished batch and its results. Its webhook deliveries can
+      # no longer be retried.
       sig do
         params(
           batch_id: String,
@@ -59,14 +59,14 @@ module ContextDev
         ).returns(ContextDev::Models::BatchDeleteResponse)
       end
       def delete(
-        # ID of the batch to retrieve or cancel.
+        # Batch ID.
         batch_id,
         request_options: {}
       )
       end
 
-      # Stop a batch from starting new pages. In-progress pages finish, and unused
-      # credits are refunded.
+      # Stop a batch from starting new pages. Pages already in progress finish before
+      # the batch becomes cancelled.
       sig do
         params(
           batch_id: String,
@@ -74,14 +74,14 @@ module ContextDev
         ).returns(ContextDev::Models::BatchCancelResponse)
       end
       def cancel(
-        # ID of the batch to retrieve or cancel.
+        # Batch ID.
         batch_id,
         request_options: {}
       )
       end
 
-      # Page through a finished batch's results as JSON instead of downloading the
-      # NDJSON files.
+      # Page through a finished batch’s results as JSON. Results remain available for 7
+      # days.
       sig do
         params(
           batch_id: String,
@@ -91,7 +91,7 @@ module ContextDev
         ).returns(ContextDev::Models::BatchGetResultsResponse)
       end
       def get_results(
-        # ID of the batch to retrieve or cancel.
+        # Batch ID.
         batch_id,
         # next_cursor from the previous page.
         cursor: nil,
@@ -102,7 +102,8 @@ module ContextDev
       )
       end
 
-      # Scrape 25K URLs or crawl large websites asynchronously.
+      # Scrape up to 25,000 URLs, or crawl a site, asynchronously. Poll the batch ID or
+      # receive a webhook when it finishes.
       sig do
         params(
           input:
@@ -122,14 +123,14 @@ module ContextDev
         input:,
         # Body param: Tags stored on the batch. Filter the batch list by them later.
         tags: nil,
-        # Body param: Completion webhook settings. Cannot be combined with webhookUrl.
-        # Omitting retry preserves legacy delivery; retry: {} opts into durable retries.
+        # Body param: Where to send the batch's final-status event. Omit `retry` for one
+        # attempt; `{}` uses the default retry schedule.
         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.
+        # Header param: Unique key per submission. Retrying with the same key and body
+        # returns the original batch; a different body returns `409`.
         idempotency_key: nil,
         request_options: {}
       )

data/rbi/context_dev/resources/brand.rbi

@@ -3,11 +3,8 @@
 module ContextDev
   module Resources
     class Brand
-      # Retrieve logos, backdrops, colors, industry, description, and more. Provide
-      # exactly one lookup identifier in the request body: a domain, company name, email
-      # address, stock ticker, transaction descriptor, or direct URL. Note:
-      # `by_direct_url` fetches brand data only from the provided URL — not from the
-      # entire internet.
+      # Retrieve logos, colors, company details, and social links using one lookup
+      # identifier. A direct URL limits extraction to that page.
       sig do
         params(
           body:
@@ -23,13 +20,14 @@ module ContextDev
         ).returns(ContextDev::Models::BrandRetrieveResponse)
       end
       def retrieve(
-        # Exactly one lookup type must be provided.
+        # One lookup, chosen by `type`.
         body:,
         request_options: {}
       )
       end
 
-      # Search indexed brands by name or domain
+      # Find up to 10 brands by name or domain, ordered by popularity. Use the returned
+      # domain to retrieve a full brand profile.
       sig do
         params(
           query: String,
@@ -50,8 +48,7 @@ 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,
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
+        # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         tags: nil,
         # Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
         # typo tolerance).

data/rbi/context_dev/resources/feedback.rbi

@@ -2,11 +2,10 @@
 
 module ContextDev
   module Resources
-    # Report bugs, docs mismatches, and friction with any Context.dev API. Submissions
-    # cost no credits and use a separate rate limit.
+    # Report API issues and documentation mismatches.
     class Feedback
-      # Report a problem with a Context.dev API call, docs page, SDK, or CLI. Include
-      # request_id, url, or both.
+      # Report an API issue or documentation mismatch, including request IDs when
+      # available.
       sig do
         params(
           category: ContextDev::FeedbackSubmitParams::Category::OrSymbol,
@@ -25,7 +24,7 @@ module ContextDev
         # The request_id of the API call the feedback is about, from its response body or
         # X-Request-Id header.
         request_id: nil,
-        # Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        # Labels for filtering usage in the dashboard.
         tags: nil,
         # The page the feedback is about, such as one page of a crawl or a docs page.
         url: nil,

data/rbi/context_dev/resources/industry.rbi

@@ -3,7 +3,7 @@
 module ContextDev
   module Resources
     class Industry
-      # Classify any brand into 2022 NAICS industry codes from its domain or name.
+      # Classify a company into NAICS industry codes.
       sig do
         params(
           input: String,
@@ -26,26 +26,18 @@ module ContextDev
         max_results: nil,
         # Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
+        # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         tags: nil,
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         timeout_opts: nil,
-        # Set to enabled to bypass shared caches and omit request and response content
-        # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-        # omitted. Requires zero data retention to be enabled for your organization
-        # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-        # Successful ZDR responses include X-Context-ZDR: true.
+        # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+        # your organization has ZDR.
         zdr: nil,
         request_options: {}
       )
       end
 
-      # Classify any brand into Standard Industrial Classification (SIC) codes from its
-      # domain or name. Choose between the original SIC system (`original_sic`) or the
-      # latest SIC list maintained by the SEC (`latest_sec`).
+      # Classify a company into SIC industry codes.
       sig do
         params(
           input: String,
@@ -68,22 +60,14 @@ module ContextDev
         max_results: nil,
         # Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
         min_results: nil,
-        # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        # characters.
+        # Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         tags: nil,
-        # Optional request deadline and behavior on timeout. For GET requests, use
-        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        # timeoutOpts object.
+        # Request deadline and what to return when it passes.
         timeout_opts: nil,
-        # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
-        # Industrial Classification system; `latest_sec` uses the current SIC list as
-        # published by the SEC. Defaults to `original_sic`.
+        # SIC dataset: `original_sic` (1987) or `latest_sec` (current SEC list).
         type: nil,
-        # Set to enabled to bypass shared caches and omit request and response content
-        # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-        # omitted. Requires zero data retention to be enabled for your organization
-        # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-        # Successful ZDR responses include X-Context-ZDR: true.
+        # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+        # your organization has ZDR.
         zdr: nil,
         request_options: {}
       )

data/rbi/context_dev/resources/logs.rbi

@@ -2,10 +2,9 @@
 
 module ContextDev
   module Resources
-    # Read your organization's API request logs to debug failed calls. These endpoints
-    # cost no credits and use a separate rate limit.
+    # Read your organization's API request logs.
     class Logs
-      # Get one logged API call, including its request input and response body.
+      # Retrieve a request’s metadata, retained input, and response.
       sig do
         params(
           request_id: String,
@@ -19,8 +18,8 @@ module ContextDev
       )
       end
 
-      # List your organization's API requests, newest first. Defaults to the last 24
-      # hours.
+      # List your organization’s request logs with filters and pagination. Logs also
+      # include batch settlements and monitor runs.
       sig do
         params(
           error_code: String,