context.dev 2.14.0 → 2.16.0

data/rbi/context_dev/models/news_search_response.rbi

@@ -33,8 +33,12 @@ module ContextDev
       sig { returns(T.nilable(String)) }
       attr_accessor :next_cursor
 
-      # Metadata about the API key used for the request. Included in every response
-      # whenever a valid API key is provided, even when the response status is not 200.
+      # 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::NewsSearchResponse::KeyMetadata))
       end
@@ -54,6 +58,7 @@ module ContextDev
           has_more: T::Boolean,
           meta: ContextDev::Models::NewsSearchResponse::Meta::OrHash,
           next_cursor: T.nilable(String),
+          request_id: String,
           key_metadata:
             ContextDev::Models::NewsSearchResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
@@ -68,8 +73,10 @@ module ContextDev
         # Pass as cursor in the next request to fetch the following page. Null when there
         # are no more results.
         next_cursor:,
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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
@@ -81,6 +88,7 @@ module ContextDev
             has_more: T::Boolean,
             meta: ContextDev::Models::NewsSearchResponse::Meta,
             next_cursor: T.nilable(String),
+            request_id: String,
             key_metadata: ContextDev::Models::NewsSearchResponse::KeyMetadata
           }
         )
@@ -453,25 +461,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/parse_handle_params.rbi

@@ -74,9 +74,8 @@ module ContextDev
       sig { params(shorten_base64_images: T::Boolean).void }
       attr_writer :shorten_base64_images
 
-      # 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.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -137,9 +136,8 @@ module ContextDev
         pdf: nil,
         # Shorten base64-encoded image data in the Markdown output
         shorten_base64_images: 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,
         # Extract only the main content from HTML-like inputs
         use_main_content_only: nil,

data/rbi/context_dev/models/parse_handle_response.rbi

@@ -15,6 +15,11 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :markdown
 
+      # 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
+
       # Indicates success
       sig do
         returns(ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean)
@@ -27,8 +32,7 @@ module ContextDev
       end
       attr_accessor :type
 
-      # Metadata about the API key used for the request. Included in every response
-      # whenever a valid API key is provided, even when the response status is not 200.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(T.nilable(ContextDev::Models::ParseHandleResponse::KeyMetadata))
       end
@@ -45,6 +49,7 @@ module ContextDev
       sig do
         params(
           markdown: String,
+          request_id: String,
           success: ContextDev::Models::ParseHandleResponse::Success::OrBoolean,
           type: ContextDev::Models::ParseHandleResponse::Type::OrSymbol,
           key_metadata:
@@ -54,12 +59,14 @@ module ContextDev
       def self.new(
         # Input bytes converted to GitHub Flavored Markdown
         markdown:,
+        # 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:,
         # Indicates success
         success:,
         # Detected content type used for parsing
         type:,
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil
       )
       end
@@ -68,6 +75,7 @@ module ContextDev
         override.returns(
           {
             markdown: String,
+            request_id: String,
             success:
               ContextDev::Models::ParseHandleResponse::Success::TaggedBoolean,
             type: ContextDev::Models::ParseHandleResponse::Type::TaggedSymbol,
@@ -341,25 +349,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/person_enrich_response.rbi

@@ -15,8 +15,12 @@ module ContextDev
       sig { returns(ContextDev::Models::PersonEnrichResponse::Match::Variants) }
       attr_accessor :match
 
-      # Metadata about the API key used for the request. Included in every response
-      # whenever a valid API key is provided, even when the response status is not 200.
+      # 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::PersonEnrichResponse::KeyMetadata)
@@ -39,6 +43,7 @@ module ContextDev
               ContextDev::Models::PersonEnrichResponse::Match::Candidate::OrHash,
               ContextDev::Models::PersonEnrichResponse::Match::NotFound::OrHash
             ),
+          request_id: String,
           key_metadata:
             ContextDev::Models::PersonEnrichResponse::KeyMetadata::OrHash
         ).returns(T.attached_class)
@@ -46,8 +51,10 @@ module ContextDev
       def self.new(
         # The highest-scoring person candidate.
         match:,
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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
@@ -56,6 +63,7 @@ module ContextDev
         override.returns(
           {
             match: ContextDev::Models::PersonEnrichResponse::Match::Variants,
+            request_id: String,
             key_metadata: ContextDev::Models::PersonEnrichResponse::KeyMetadata
           }
         )
@@ -1259,25 +1267,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/retry_config.rbi

@@ -0,0 +1,35 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class RetryConfig < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::RetryConfig, ContextDev::Internal::AnyHash)
+        end
+
+      # Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
+      # retries.
+      sig { returns(T.nilable(T::Array[Integer])) }
+      attr_reader :delays_seconds
+
+      sig { params(delays_seconds: T::Array[Integer]).void }
+      attr_writer :delays_seconds
+
+      # Webhook retry settings. Use {} for the default schedule.
+      sig do
+        params(delays_seconds: T::Array[Integer]).returns(T.attached_class)
+      end
+      def self.new(
+        # Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
+        # retries.
+        delays_seconds: nil
+      )
+      end
+
+      sig { override.returns({ delays_seconds: T::Array[Integer] }) }
+      def to_hash
+      end
+    end
+  end
+end

data/rbi/context_dev/models/utility_prefetch_response.rbi

@@ -11,6 +11,11 @@ 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.
+      sig { returns(String) }
+      attr_accessor :request_id
+
       # The domain that was queued for prefetching
       sig { returns(T.nilable(String)) }
       attr_reader :domain
@@ -18,8 +23,7 @@ module ContextDev
       sig { params(domain: String).void }
       attr_writer :domain
 
-      # Metadata about the API key used for the request. Included in every response
-      # whenever a valid API key is provided, even when the response status is not 200.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(ContextDev::Models::UtilityPrefetchResponse::KeyMetadata)
@@ -68,6 +72,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           domain: String,
           key_metadata:
             ContextDev::Models::UtilityPrefetchResponse::KeyMetadata::OrHash,
@@ -77,10 +82,12 @@ 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.
+        request_id:,
         # The domain that was queued for prefetching
         domain: nil,
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
         # Success message
         message: nil,
@@ -94,6 +101,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             domain: String,
             key_metadata:
               ContextDev::Models::UtilityPrefetchResponse::KeyMetadata,
@@ -116,25 +124,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/web_extract_competitors_params.rbi

@@ -26,9 +26,8 @@ module ContextDev
       sig { params(num_competitors: Integer).void }
       attr_writer :num_competitors
 
-      # 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.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -59,9 +58,8 @@ module ContextDev
         domain:,
         # Exact number of direct competitors to return. Defaults to 5.
         num_competitors: 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 timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed

data/rbi/context_dev/models/web_extract_competitors_response.rbi

@@ -25,6 +25,11 @@ module ContextDev
       sig { returns(String) }
       attr_accessor :domain
 
+      # 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
+
       # Status of the response.
       sig do
         returns(
@@ -45,8 +50,7 @@ module ContextDev
       end
       attr_writer :target
 
-      # Metadata about the API key used for the request. Included in every response
-      # whenever a valid API key is provided, even when the response status is not 200.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(
@@ -71,6 +75,7 @@ module ContextDev
               ContextDev::Models::WebExtractCompetitorsResponse::Competitor::OrHash
             ],
           domain: String,
+          request_id: String,
           status:
             ContextDev::Models::WebExtractCompetitorsResponse::Status::OrSymbol,
           target:
@@ -84,12 +89,14 @@ module ContextDev
         competitors:,
         # Normalized input domain.
         domain:,
+        # 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:,
         # Status of the response.
         status:,
         # Target company profile inferred from the landing page.
         target:,
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil
       )
       end
@@ -102,6 +109,7 @@ module ContextDev
                 ContextDev::Models::WebExtractCompetitorsResponse::Competitor
               ],
             domain: String,
+            request_id: String,
             status:
               ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol,
             target: ContextDev::Models::WebExtractCompetitorsResponse::Target,
@@ -328,25 +336,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end

data/rbi/context_dev/models/web_extract_fonts_params.rbi

@@ -39,9 +39,8 @@ module ContextDev
       sig { returns(T.nilable(Integer)) }
       attr_accessor :max_age_ms
 
-      # 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.
       sig { returns(T.nilable(T::Array[String])) }
       attr_reader :tags
 
@@ -81,9 +80,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 timeout in milliseconds for the request. If the request takes longer
         # than this value, it will be aborted with a 408 status code. Maximum allowed

data/rbi/context_dev/models/web_extract_fonts_response.rbi

@@ -41,6 +41,11 @@ module ContextDev
       end
       attr_accessor :fonts
 
+      # 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
+
       # Status of the response, e.g., 'ok'
       sig { returns(String) }
       attr_accessor :status
@@ -71,8 +76,7 @@ module ContextDev
       end
       attr_writer :font_links
 
-      # Metadata about the API key used for the request. Included in every response
-      # whenever a valid API key is provided, even when the response status is not 200.
+      # Credit usage, included whenever a valid API key is provided.
       sig do
         returns(
           T.nilable(ContextDev::Models::WebExtractFontsResponse::KeyMetadata)
@@ -96,6 +100,7 @@ module ContextDev
           domain: String,
           fonts:
             T::Array[ContextDev::Models::WebExtractFontsResponse::Font::OrHash],
+          request_id: String,
           status: String,
           font_links:
             T::Hash[
@@ -117,14 +122,16 @@ module ContextDev
         domain:,
         # Array of font usage information
         fonts:,
+        # 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:,
         # Status of the response, e.g., 'ok'
         status:,
         # Font assets keyed by family name as it appears in the fonts array (non-generic
         # names only). Clients match entries in fonts to pick a file URL from files.
         # Omitted when no families resolve to Google or custom @font-face URLs.
         font_links: nil,
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil
       )
       end
@@ -137,6 +144,7 @@ module ContextDev
             code: Integer,
             domain: String,
             fonts: T::Array[ContextDev::Models::WebExtractFontsResponse::Font],
+            request_id: String,
             status: String,
             font_links:
               T::Hash[
@@ -449,25 +457,24 @@ module ContextDev
             )
           end
 
-        # The number of credits consumed by this request.
+        # Credits used by this request.
         sig { returns(Integer) }
         attr_accessor :credits_consumed
 
-        # The number of credits remaining for your organization after this request.
+        # Credits remaining for your organization.
         sig { returns(Integer) }
         attr_accessor :credits_remaining
 
-        # Metadata about the API key used for the request. Included in every response
-        # whenever a valid API key is provided, even when the response status is not 200.
+        # 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(
-          # The number of credits consumed by this request.
+          # Credits used by this request.
           credits_consumed:,
-          # The number of credits remaining for your organization after this request.
+          # Credits remaining for your organization.
           credits_remaining:
         )
         end