context.dev 2.15.0 → 2.17.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: 515f65691600e29045376881e888810e56f7df8cc0c1a65a9b5077f9c72c1258
-  data.tar.gz: 521f7a02b0d575c2bb3f624b73dbdd8ec3fcd892fd5f6115016e2f751e9ff470
+  metadata.gz: 7ef06287736220b8406602722c6d4bff1c2301a6224c88308a687b5fe3a0c43b
+  data.tar.gz: dea8f15506d185c74514659325d1c30d7860b81a0d771b821429502b132096b9
 SHA512:
-  metadata.gz: e1a0aad5bc3dc9521467690dc7c1d2cc8500a4fed431fed65c89fe9443807a97b8e9ce4badc89abd5918d9bbfd8f223306d26438cc579142bb2f0fde4d6a4492
-  data.tar.gz: b9e69f23af6eebf3b8da837b926b6622fa1977afa07b39dac78485e2cb1c798eb5362dca640f5bf9a7f177631ed739944f3ca2837e7e21eb54b316b78977bdef
+  metadata.gz: 7a1f4701bf53c53328c5271646e57e81cbd93e0f4f7d909a6d4a7cbc3d21087ebe8b77f2dcfe83b2b8186cf3cce5990cf944aa54b28f44392a6dc32fec078049
+  data.tar.gz: 7a6ff355e62a1cf5f37f70edc73d86f22d430253e82a0668f82c7162a48d804f20ed4d15e78b21d534e6f9523b1040f4a5135f56991b1bf82c8e74121b2734e2

data/CHANGELOG.md

@@ -1,5 +1,35 @@
 # Changelog
 
+## [2.17.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.16.0...v2.17.0) (2026-09-15)
+
+
+### Features
+
+* **answers:** add live web research with fast and ultra modes ([#954](https://github.com/context-dot-dev/context-ruby-sdk/issues/954)) ([838e943](https://github.com/context-dot-dev/context-ruby-sdk/commit/838e943b1fe34aeaf6f804ff534c22f62b4900fe))
+* **api-keys:** enforce scoped API key permissions ([#1038](https://github.com/context-dot-dev/context-ruby-sdk/issues/1038)) ([7f87431](https://github.com/context-dot-dev/context-ruby-sdk/commit/7f874312c42b5c12020d71251f8bfc6eaa8ab2aa))
+* **api:** unify timeout configuration and return partial results ([#1030](https://github.com/context-dot-dev/context-ruby-sdk/issues/1030)) ([7c0fa1f](https://github.com/context-dot-dev/context-ruby-sdk/commit/7c0fa1f308fc51885405c065aef2fd4ab8fe5725))
+* **monitors:** add page selector filters ([#1037](https://github.com/context-dot-dev/context-ruby-sdk/issues/1037)) ([1f3a748](https://github.com/context-dot-dev/context-ruby-sdk/commit/1f3a74858133f69ea52c3a189f9ed8c80b80c0c6))
+* **web:** add raw bytes scraping endpoint ([#1081](https://github.com/context-dot-dev/context-ruby-sdk/issues/1081)) ([e4b2347](https://github.com/context-dot-dev/context-ruby-sdk/commit/e4b23477deab52f1822eb2e3e2bbbca6b9cf9c07))
+
+
+### Bug Fixes
+
+* **api:** honour maxAgeMs=0 on brand retrieve, styleguide and fonts endpoints ([#998](https://github.com/context-dot-dev/context-ruby-sdk/issues/998)) ([78491ef](https://github.com/context-dot-dev/context-ruby-sdk/commit/78491ef8e43ab49074d011ce8c10e3cda5cb27db))
+* **webhooks:** format Slack webhook notifications ([#1045](https://github.com/context-dot-dev/context-ruby-sdk/issues/1045)) ([4bd0df1](https://github.com/context-dot-dev/context-ruby-sdk/commit/4bd0df1c614713a46e366ca1320942fa777452fc))
+
+## [2.16.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.15.0...v2.16.0) (2026-09-11)
+
+
+### Features
+
+* **api:** return request_id on every response ([012ba65](https://github.com/context-dot-dev/context-ruby-sdk/commit/012ba65ea7648ebd7b18fa7ad00955a13b8394b9))
+* **logs:** expose request log endpoints in SDKs ([#1025](https://github.com/context-dot-dev/context-ruby-sdk/issues/1025)) ([5b22be7](https://github.com/context-dot-dev/context-ruby-sdk/commit/5b22be7bd1cb6401b8260b5a756b6ec040cbc6a8))
+
+
+### Bug Fixes
+
+* **api:** reject timeoutMS too short for waitForMs ([e8a6725](https://github.com/context-dot-dev/context-ruby-sdk/commit/e8a67255c9354f69d632697179a4d6270a4677ee))
+
 ## [2.15.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.14.0...v2.15.0) (2026-09-08)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "context.dev", "~> 2.15.0"
+gem "context.dev", "~> 2.17.0"
 ```
 
 <!-- x-release-please-end -->
@@ -34,7 +34,7 @@ context_dev = ContextDev::Client.new(
 
 brand = context_dev.brand.retrieve(body: {domain: "stripe.com", type: "by_domain"})
 
-puts(brand.cache_metadata)
+puts(brand.request_id)
 ```
 
 ### Handling errors

data/lib/context_dev/client.rb

@@ -57,6 +57,11 @@ module ContextDev
     # @return [ContextDev::Resources::News]
     attr_reader :news
 
+    # Read your organization's API request logs to debug failed calls. These endpoints
+    # cost no credits and use a separate rate limit.
+    # @return [ContextDev::Resources::Logs]
+    attr_reader :logs
+
     # @api private
     #
     # @return [Hash{String=>String}]
@@ -129,6 +134,7 @@ module ContextDev
       @webhooks = ContextDev::Resources::Webhooks.new(client: self)
       @people = ContextDev::Resources::People.new(client: self)
       @news = ContextDev::Resources::News.new(client: self)
+      @logs = ContextDev::Resources::Logs.new(client: self)
     end
   end
 end

data/lib/context_dev/internal/type/base_model.rb

@@ -441,8 +441,8 @@ module ContextDev
         #   # `parse_handle_response` is a `ContextDev::Models::ParseHandleResponse`
         #   parse_handle_response => {
         #     markdown: markdown,
-        #     success: success,
-        #     type: type
+        #     request_id: request_id,
+        #     success: success
         #   }
         def deconstruct_keys(keys)
           (keys || self.class.known_fields.keys)

data/lib/context_dev/models/ai_extract_product_params.rb

@@ -27,15 +27,15 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!attribute timeout_ms
-      #   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
-      #   value is 300000ms (5 minutes).
+      # @!attribute timeout_opts
+      #   Optional request deadline and behavior on timeout. For GET requests, use
+      #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      #   timeoutOpts object.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer, api_name: :timeoutMS
+      #   @return [ContextDev::Models::AIExtractProductParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::AIExtractProductParams::TimeoutOpts }, api_name: :timeoutOpts
 
-      # @!method initialize(url:, max_age_ms: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(url:, max_age_ms: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductParams} for more details.
       #
@@ -45,9 +45,54 @@ module ContextDev
       #
       #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::AIExtractProductParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @return [Integer]
+        required :milliseconds, Integer
+
+        # @!attribute behavior
+        #   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.
+        #
+        #   @return [Symbol, ContextDev::Models::AIExtractProductParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::AIExtractProductParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::AIExtractProductParams::TimeoutOpts} for more details.
+        #
+        #   Optional request deadline and behavior on timeout. For GET requests, use
+        #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+        #   timeoutOpts object.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::AIExtractProductParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # 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.
+        #
+        # @see ContextDev::Models::AIExtractProductParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/context_dev/models/ai_extract_product_response.rb

@@ -12,6 +12,13 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::AIExtractProductResponse::CacheMetadata }
 
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute is_product_page
       #   Whether the given URL is a product detail page
       #
@@ -24,6 +31,13 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata }
 
+      # @!attribute partial
+      #   True when the timeout ended processing and this response contains only usable
+      #   results completed so far. Unfinished results are omitted.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
       # @!attribute platform
       #   The detected ecommerce platform, or null if not a product page
       #
@@ -36,16 +50,20 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductResponse::Product, nil]
       optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true
 
-      # @!method initialize(cache_metadata:, is_product_page: nil, key_metadata: nil, platform: nil, product: nil)
+      # @!method initialize(cache_metadata:, request_id:, is_product_page: nil, key_metadata: nil, partial: nil, platform: nil, product: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductResponse} for more details.
       #
       #   @param cache_metadata [ContextDev::Models::AIExtractProductResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param is_product_page [Boolean] Whether the given URL is a product detail page
       #
       #   @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
+      #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
+      #
       #   @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
       #
       #   @param product [ContextDev::Models::AIExtractProductResponse::Product, nil] The extracted product data, or null if not a product page

data/lib/context_dev/models/ai_extract_products_params.rb

@@ -50,15 +50,17 @@ module ContextDev
           #   @return [Array<String>, nil]
           optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-          # @!attribute timeout_ms
-          #   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
-          #   value is 300000ms (5 minutes).
+          # @!attribute timeout_opts
+          #   Optional request deadline and behavior on timeout. For GET requests, use
+          #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+          #   timeoutOpts object.
           #
-          #   @return [Integer, nil]
-          optional :timeout_ms, Integer, api_name: :timeoutMS
+          #   @return [ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts, nil]
+          optional :timeout_opts,
+                   -> { ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts },
+                   api_name: :timeoutOpts
 
-          # @!method initialize(domain:, max_age_ms: nil, max_products: nil, tags: nil, timeout_ms: nil)
+          # @!method initialize(domain:, max_age_ms: nil, max_products: nil, tags: nil, timeout_opts: nil)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::AIExtractProductsParams::Body::ByDomain} for more details.
           #
@@ -70,7 +72,55 @@ module ContextDev
           #
           #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
           #
-          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+          #   @param timeout_opts [ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+
+          # @see ContextDev::Models::AIExtractProductsParams::Body::ByDomain#timeout_opts
+          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+            # @!attribute milliseconds
+            #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @return [Integer]
+            required :milliseconds, Integer
+
+            # @!attribute behavior
+            #   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.
+            #
+            #   @return [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior, nil]
+            optional :behavior,
+                     enum: -> { ContextDev::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior }
+
+            # @!method initialize(milliseconds:, behavior: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts} for
+            #   more details.
+            #
+            #   Optional request deadline and behavior on timeout. For GET requests, use
+            #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            #   timeoutOpts object.
+            #
+            #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @param behavior [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+            # 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.
+            #
+            # @see ContextDev::Models::AIExtractProductsParams::Body::ByDomain::TimeoutOpts#behavior
+            module Behavior
+              extend ContextDev::Internal::Type::Enum
+
+              FAIL = :fail
+              RETURN_PARTIAL = :"return-partial"
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         class ByDirectURL < ContextDev::Internal::Type::BaseModel
@@ -101,15 +151,17 @@ module ContextDev
           #   @return [Array<String>, nil]
           optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-          # @!attribute timeout_ms
-          #   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
-          #   value is 300000ms (5 minutes).
+          # @!attribute timeout_opts
+          #   Optional request deadline and behavior on timeout. For GET requests, use
+          #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+          #   timeoutOpts object.
           #
-          #   @return [Integer, nil]
-          optional :timeout_ms, Integer, api_name: :timeoutMS
+          #   @return [ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts, nil]
+          optional :timeout_opts,
+                   -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts },
+                   api_name: :timeoutOpts
 
-          # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, tags: nil, timeout_ms: nil)
+          # @!method initialize(direct_url:, max_age_ms: nil, max_products: nil, tags: nil, timeout_opts: nil)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL} for more
           #   details.
@@ -122,7 +174,55 @@ module ContextDev
           #
           #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
           #
-          #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+          #   @param timeout_opts [ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+
+          # @see ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL#timeout_opts
+          class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+            # @!attribute milliseconds
+            #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @return [Integer]
+            required :milliseconds, Integer
+
+            # @!attribute behavior
+            #   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.
+            #
+            #   @return [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior, nil]
+            optional :behavior,
+                     enum: -> { ContextDev::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior }
+
+            # @!method initialize(milliseconds:, behavior: nil)
+            #   Some parameter documentations has been truncated, see
+            #   {ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts}
+            #   for more details.
+            #
+            #   Optional request deadline and behavior on timeout. For GET requests, use
+            #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+            #   timeoutOpts object.
+            #
+            #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+            #
+            #   @param behavior [Symbol, ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+            # 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.
+            #
+            # @see ContextDev::Models::AIExtractProductsParams::Body::ByDirectURL::TimeoutOpts#behavior
+            module Behavior
+              extend ContextDev::Internal::Type::Enum
+
+              FAIL = :fail
+              RETURN_PARTIAL = :"return-partial"
+
+              # @!method self.values
+              #   @return [Array<Symbol>]
+            end
+          end
         end
 
         # @!method self.variants

data/lib/context_dev/models/ai_extract_products_response.rb

@@ -12,12 +12,27 @@ module ContextDev
       #   @return [ContextDev::Models::AIExtractProductsResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::AIExtractProductsResponse::CacheMetadata }
 
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute key_metadata
       #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::AIExtractProductsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::AIExtractProductsResponse::KeyMetadata }
 
+      # @!attribute partial
+      #   True when timeoutOpts.behavior=return-partial returned the usable results
+      #   collected before the deadline. Partial collections are not cached as complete
+      #   results.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
       # @!attribute products
       #   Array of products extracted from the website
       #
@@ -25,14 +40,18 @@ module ContextDev
       optional :products,
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] }
 
-      # @!method initialize(cache_metadata:, key_metadata: nil, products: nil)
+      # @!method initialize(cache_metadata:, request_id:, key_metadata: nil, partial: nil, products: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::AIExtractProductsResponse} for more details.
       #
       #   @param cache_metadata [ContextDev::Models::AIExtractProductsResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
+      #   @param partial [Boolean] True when timeoutOpts.behavior=return-partial returned the usable results collec
+      #
       #   @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
 
       # @see ContextDev::Models::AIExtractProductsResponse#cache_metadata

data/lib/context_dev/models/batch_cancel_response.rb

@@ -53,6 +53,13 @@ module ContextDev
       #   @return [ContextDev::Models::BatchCancelResponse::Progress]
       required :progress, -> { ContextDev::Models::BatchCancelResponse::Progress }
 
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute status
       #   Always `cancelling`. Work already in flight finishes; the batch reaches
       #   `cancelled` shortly after.
@@ -78,7 +85,7 @@ module ContextDev
       #   @return [ContextDev::Models::BatchCancelResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchCancelResponse::KeyMetadata }
 
-      # @!method initialize(id:, crawl:, credits:, format_:, input:, mode:, page_errors:, progress:, status:, tags:, timing:, key_metadata: nil)
+      # @!method initialize(id:, crawl:, credits:, format_:, input:, mode:, page_errors:, progress:, request_id:, status:, tags:, timing:, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchCancelResponse} for more details.
       #
@@ -98,6 +105,8 @@ module ContextDev
       #
       #   @param progress [ContextDev::Models::BatchCancelResponse::Progress] How far the batch got before cancellation.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param status [Symbol, ContextDev::Models::BatchCancelResponse::Status] Always `cancelling`. Work already in flight finishes; the batch reaches `cancell
       #
       #   @param tags [Array<String>] Tags stored on the batch at submission.

data/lib/context_dev/models/batch_delete_response.rb

@@ -4,6 +4,13 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Batch#delete
     class BatchDeleteResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute id
       #   ID of the deleted batch.
       #
@@ -22,7 +29,12 @@ module ContextDev
       #   @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
 
-      # @!method initialize(id: nil, deleted: nil, key_metadata: nil)
+      # @!method initialize(request_id:, id: nil, deleted: nil, key_metadata: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BatchDeleteResponse} for more details.
+      #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param id [String] ID of the deleted batch.
       #
       #   @param deleted [Boolean] Always true on success.

data/lib/context_dev/models/batch_get_results_response.rb

@@ -4,6 +4,13 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Batch#get_results
     class BatchGetResultsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute data
       #   Result records on this page.
       #
@@ -29,7 +36,12 @@ module ContextDev
       #   @return [String, nil]
       optional :next_cursor, String, nil?: true
 
-      # @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
+      # @!method initialize(request_id:, data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BatchGetResultsResponse} for more details.
+      #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param data [Array<ContextDev::Models::BatchGetResultsResponse::Data::Ok, ContextDev::Models::BatchGetResultsResponse::Data::Error>] Result records on this page.
       #
       #   @param has_more [Boolean] Whether another page is available.

data/lib/context_dev/models/batch_list_response.rb

@@ -4,6 +4,13 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Batch#list
     class BatchListResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute data
       #   Batches on this page.
       #
@@ -28,7 +35,12 @@ module ContextDev
       #   @return [String, nil]
       optional :next_cursor, String, nil?: true
 
-      # @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
+      # @!method initialize(request_id:, data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
+      #   Some parameter documentations has been truncated, see
+      #   {ContextDev::Models::BatchListResponse} for more details.
+      #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param data [Array<ContextDev::Models::BatchListResponse::Data>] Batches on this page.
       #
       #   @param has_more [Boolean] Whether another page is available.

data/lib/context_dev/models/batch_retrieve_response.rb

@@ -69,6 +69,13 @@ module ContextDev
       #   @return [ContextDev::Models::BatchRetrieveResponse::Progress]
       required :progress, -> { ContextDev::Models::BatchRetrieveResponse::Progress }
 
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute results
       #   Download links, available once the batch reaches a final status and null before
       #   then. GET /batch/{batch_id}/results serves the same records as paginated JSON.
@@ -105,7 +112,7 @@ module ContextDev
       #   @return [String, nil]
       optional :webhook_delivery_id, String
 
-      # @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, results:, status:, tags:, timing:, key_metadata: nil, webhook_delivery_id: nil)
+      # @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, request_id:, results:, status:, tags:, timing:, key_metadata: nil, webhook_delivery_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchRetrieveResponse} for more details.
       #
@@ -130,6 +137,8 @@ module ContextDev
       #
       #   @param progress [ContextDev::Models::BatchRetrieveResponse::Progress] Pages attempted so far. Use `status` to check completion.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param results [ContextDev::Models::BatchRetrieveResponse::Results, nil] Download links, available once the batch reaches a final status and null before
       #
       #   @param status [Symbol, ContextDev::Models::BatchRetrieveResponse::Status] Current state. `completed`, `cancelled`, and `failed` are final.

data/lib/context_dev/models/batch_submit_response.rb

@@ -62,6 +62,13 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BatchSubmitResponse::Mode]
       required :mode, enum: -> { ContextDev::Models::BatchSubmitResponse::Mode }
 
+      # @!attribute request_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.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute status
       #   Always `queued`. An accepted batch has not started yet.
       #
@@ -87,7 +94,7 @@ module ContextDev
       #   @return [String, nil]
       optional :webhook_secret, String
 
-      # @!method initialize(id:, cache_metadata:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, status:, tags:, key_metadata: nil, webhook_secret: nil)
+      # @!method initialize(id:, cache_metadata:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, request_id:, status:, tags:, key_metadata: nil, webhook_secret: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchSubmitResponse} for more details.
       #
@@ -109,6 +116,8 @@ module ContextDev
       #
       #   @param mode [Symbol, ContextDev::Models::BatchSubmitResponse::Mode] How pages will be selected.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param status [Symbol, ContextDev::Models::BatchSubmitResponse::Status] Always `queued`. An accepted batch has not started yet.
       #
       #   @param tags [Array<String>] Tags stored on the batch.