context.dev 2.21.0 → 2.22.0

data/rbi/context_dev/models/industry_retrieve_sic_params.rbi

@@ -34,17 +34,14 @@ module ContextDev
       sig { params(min_results: Integer).void }
       attr_writer :min_results
 
-      # 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
 
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # 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.
       sig do
         returns(T.nilable(ContextDev::IndustryRetrieveSicParams::TimeoutOpts))
       end
@@ -58,9 +55,7 @@ module ContextDev
       end
       attr_writer :timeout_opts
 
-      # 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).
       sig do
         returns(
           T.nilable(ContextDev::IndustryRetrieveSicParams::Type::OrSymbol)
@@ -73,11 +68,8 @@ module ContextDev
       end
       attr_writer :type
 
-      # 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.
       sig do
         returns(T.nilable(ContextDev::IndustryRetrieveSicParams::Zdr::OrSymbol))
       end
@@ -110,22 +102,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: {}
       )
@@ -157,14 +141,12 @@ module ContextDev
             )
           end
 
-        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        # Deadline in milliseconds.
         sig { returns(Integer) }
         attr_accessor :milliseconds
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         sig do
           returns(
             T.nilable(
@@ -182,9 +164,7 @@ module ContextDev
         end
         attr_writer :behavior
 
-        # 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.
         sig do
           params(
             milliseconds: Integer,
@@ -193,12 +173,10 @@ module ContextDev
           ).returns(T.attached_class)
         end
         def self.new(
-          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          # Deadline in milliseconds.
           milliseconds:,
-          # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-          # credits. "return-partial" returns usable results collected so far; if none are
-          # available, the request still fails without charging credits. Partial results are
-          # not cached as complete results.
+          # "fail" returns 408 at the deadline. "return-partial" returns available results;
+          # inspect the response’s partial flag.
           behavior: nil
         )
         end
@@ -215,10 +193,8 @@ module ContextDev
         def to_hash
         end
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         module Behavior
           extend ContextDev::Internal::Type::Enum
 
@@ -254,9 +230,7 @@ module ContextDev
         end
       end
 
-      # 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).
       module Type
         extend ContextDev::Internal::Type::Enum
 
@@ -286,11 +260,8 @@ module ContextDev
         end
       end
 
-      # 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.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/rbi/context_dev/models/industry_retrieve_sic_response.rbi

@@ -11,8 +11,8 @@ 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
 
@@ -63,7 +63,7 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
-      # Credit usage, included whenever a valid API key is provided.
+      # Credits this request used and your remaining balance.
       sig do
         returns(
           T.nilable(
@@ -89,7 +89,7 @@ module ContextDev
       sig { params(partial: T::Boolean).void }
       attr_writer :partial
 
-      # Status of the response, e.g., 'ok'
+      # Always `ok` on success.
       sig { returns(T.nilable(String)) }
       attr_reader :status
 
@@ -121,8 +121,8 @@ 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:,
         # Echoes back which SIC dataset was used to classify the brand.
         classification: nil,
@@ -132,12 +132,12 @@ module ContextDev
         codes: nil,
         # Domain found for the brand
         domain: nil,
-        # Credit usage, included whenever a valid API key is provided.
+        # Credits this request used and your remaining balance.
         key_metadata: nil,
         # True when the timeout ended processing and this response contains only usable
         # results completed so far. Unfinished results are omitted.
         partial: nil,
-        # Status of the response, e.g., 'ok'
+        # Always `ok` on success.
         status: nil,
         # Industry classification type, for sic api it will be `sic`
         type: nil
@@ -344,7 +344,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -352,14 +352,14 @@ 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, credits_remaining: Integer).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/intake.rbi

@@ -14,21 +14,15 @@ module ContextDev
       sig { returns(Integer) }
       attr_accessor :duplicates
 
-      # URLs from your list rejected as unusable; the same ones are itemised in
-      # `invalid_urls` at submission. Null for a crawl — a crawl that resolves no usable
-      # page is rejected outright with a 400 rather than accepted with an empty list.
+      # Rejected input URLs; `null` for a crawl.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :invalid
 
-      # Pages credits were reserved for. Everything else — progress, the refund, the
-      # completion percentage — is measured against this.
+      # Pages accepted; progress counts toward this total.
       sig { returns(Integer) }
       attr_accessor :reserved
 
-      # Whether `reserved` is an upper bound the batch may finish under. True only for a
-      # crawl that follows links, whose reachable page count is unknowable until it
-      # runs. False for a scrape and for a sitemap crawl, where `reserved` is an exact
-      # page count.
+      # True when `reserved` is a crawl ceiling; false when it is an exact URL count.
       sig { returns(T::Boolean) }
       attr_accessor :reserved_is_ceiling
 
@@ -37,7 +31,7 @@ module ContextDev
       sig { returns(T.nilable(Integer)) }
       attr_accessor :submitted
 
-      # What submission took in, and what it charged for.
+      # What the submission accepted.
       sig do
         params(
           duplicates: Integer,
@@ -52,17 +46,11 @@ module ContextDev
         # Non-zero for sitemap crawls too, whose sitemaps routinely list a page more than
         # once.
         duplicates:,
-        # URLs from your list rejected as unusable; the same ones are itemised in
-        # `invalid_urls` at submission. Null for a crawl — a crawl that resolves no usable
-        # page is rejected outright with a 400 rather than accepted with an empty list.
+        # Rejected input URLs; `null` for a crawl.
         invalid:,
-        # Pages credits were reserved for. Everything else — progress, the refund, the
-        # completion percentage — is measured against this.
+        # Pages accepted; progress counts toward this total.
         reserved:,
-        # Whether `reserved` is an upper bound the batch may finish under. True only for a
-        # crawl that follows links, whose reachable page count is unknowable until it
-        # runs. False for a scrape and for a sitemap crawl, where `reserved` is an exact
-        # page count.
+        # True when `reserved` is a crawl ceiling; false when it is an exact URL count.
         reserved_is_ceiling:,
         # URLs in the list you sent, before validation and de-duplication. Null for a
         # crawl, which is given a source rather than a list.

data/rbi/context_dev/models/log_list_response.rbi

@@ -27,12 +27,12 @@ module ContextDev
       sig { returns(Integer) }
       attr_accessor :page
 
-      # 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(ContextDev::Models::LogListResponse::KeyMetadata))
       end
@@ -64,10 +64,10 @@ module ContextDev
         limit:,
         # Current page number.
         page:,
-        # 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
@@ -112,7 +112,8 @@ module ContextDev
         sig { returns(Float) }
         attr_accessor :latency_ms
 
-        # HTTP method.
+        # HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement
+        # entries.
         sig { returns(String) }
         attr_accessor :method_
 
@@ -164,7 +165,8 @@ module ContextDev
           key_id:,
           # Server-side processing time in milliseconds.
           latency_ms:,
-          # HTTP method.
+          # HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement
+          # entries.
           method_:,
           # Endpoint path as called.
           path:,
@@ -211,7 +213,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -219,14 +221,14 @@ 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, credits_remaining: Integer).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/log_retrieve_response.rbi

@@ -19,12 +19,12 @@ module ContextDev
       end
       attr_writer :data
 
-      # 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(ContextDev::Models::LogRetrieveResponse::KeyMetadata))
       end
@@ -48,10 +48,10 @@ module ContextDev
       end
       def self.new(
         data:,
-        # 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
@@ -104,7 +104,8 @@ module ContextDev
         sig { returns(Float) }
         attr_accessor :latency_ms
 
-        # HTTP method.
+        # HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement
+        # entries.
         sig { returns(String) }
         attr_accessor :method_
 
@@ -136,24 +137,6 @@ module ContextDev
         sig { returns(T::Boolean) }
         attr_accessor :zdr
 
-        # Credit usage, included whenever a valid API key is provided.
-        sig do
-          returns(
-            T.nilable(
-              ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata
-            )
-          )
-        end
-        attr_reader :key_metadata
-
-        sig do
-          params(
-            key_metadata:
-              ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata::OrHash
-          ).void
-        end
-        attr_writer :key_metadata
-
         # The retained JSON response with credentials redacted, or null when unavailable.
         sig { returns(T.nilable(T.anything)) }
         attr_reader :response
@@ -176,8 +159,6 @@ module ContextDev
             timestamp: Time,
             user_agent: T.nilable(String),
             zdr: T::Boolean,
-            key_metadata:
-              ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata::OrHash,
             response: T.anything
           ).returns(T.attached_class)
         end
@@ -192,7 +173,8 @@ module ContextDev
           key_id:,
           # Server-side processing time in milliseconds.
           latency_ms:,
-          # HTTP method.
+          # HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement
+          # entries.
           method_:,
           # Endpoint path as called.
           path:,
@@ -208,8 +190,6 @@ module ContextDev
           user_agent:,
           # Whether the request was made under zero data retention.
           zdr:,
-          # Credit usage, included whenever a valid API key is provided.
-          key_metadata: nil,
           # The retained JSON response with credentials redacted, or null when unavailable.
           response: nil
         )
@@ -231,8 +211,6 @@ module ContextDev
               timestamp: Time,
               user_agent: T.nilable(String),
               zdr: T::Boolean,
-              key_metadata:
-                ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata,
               response: T.anything
             }
           )
@@ -283,47 +261,6 @@ module ContextDev
           def to_hash
           end
         end
-
-        class KeyMetadata < ContextDev::Internal::Type::BaseModel
-          OrHash =
-            T.type_alias do
-              T.any(
-                ContextDev::Models::LogRetrieveResponse::Data::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
 
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
@@ -335,7 +272,7 @@ module ContextDev
             )
           end
 
-        # Credits used by this request.
+        # Credits charged for this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
@@ -343,14 +280,14 @@ 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, credits_remaining: Integer).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: