context.dev 2.15.0 → 2.16.0

data/rbi/context_dev/models/batch_delete_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
+
       # ID of the deleted batch.
       sig { returns(T.nilable(String)) }
       attr_reader :id
@@ -41,6 +46,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           id: String,
           deleted: T::Boolean,
           key_metadata:
@@ -48,6 +54,9 @@ 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:,
         # ID of the deleted batch.
         id: nil,
         # Always true on success.
@@ -60,6 +69,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             id: String,
             deleted: T::Boolean,
             key_metadata: ContextDev::Models::BatchDeleteResponse::KeyMetadata

data/rbi/context_dev/models/batch_get_results_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
+
       # Result records on this page.
       sig do
         returns(
@@ -65,6 +70,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           data:
             T::Array[
               T.any(
@@ -79,6 +85,9 @@ 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:,
         # Result records on this page.
         data: nil,
         # Whether another page is available.
@@ -93,6 +102,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             data:
               T::Array[
                 ContextDev::Models::BatchGetResultsResponse::Data::Variants

data/rbi/context_dev/models/batch_list_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
+
       # Batches on this page.
       sig do
         returns(
@@ -53,6 +58,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           data: T::Array[ContextDev::Models::BatchListResponse::Data::OrHash],
           has_more: T::Boolean,
           key_metadata:
@@ -61,6 +67,9 @@ 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:,
         # Batches on this page.
         data: nil,
         # Whether another page is available.
@@ -75,6 +84,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             data: T::Array[ContextDev::Models::BatchListResponse::Data],
             has_more: T::Boolean,
             key_metadata: ContextDev::Models::BatchListResponse::KeyMetadata,

data/rbi/context_dev/models/batch_retrieve_response.rbi

@@ -84,6 +84,11 @@ module ContextDev
       end
       attr_writer :progress
 
+      # 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
+
       # 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.
       sig do
@@ -159,6 +164,7 @@ module ContextDev
           mode: ContextDev::Models::BatchRetrieveResponse::Mode::OrSymbol,
           page_errors: T::Array[ContextDev::PageErrorCount::OrHash],
           progress: ContextDev::Models::BatchRetrieveResponse::Progress::OrHash,
+          request_id: String,
           results:
             T.nilable(
               ContextDev::Models::BatchRetrieveResponse::Results::OrHash
@@ -196,6 +202,9 @@ module ContextDev
         page_errors:,
         # Pages attempted so far. Use `status` to check completion.
         progress:,
+        # 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:,
         # 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.
         results:,
@@ -226,6 +235,7 @@ module ContextDev
             mode: ContextDev::Models::BatchRetrieveResponse::Mode::TaggedSymbol,
             page_errors: T::Array[ContextDev::PageErrorCount],
             progress: ContextDev::Models::BatchRetrieveResponse::Progress,
+            request_id: String,
             results:
               T.nilable(ContextDev::Models::BatchRetrieveResponse::Results),
             status:

data/rbi/context_dev/models/batch_submit_response.rbi

@@ -77,6 +77,11 @@ module ContextDev
       end
       attr_accessor :mode
 
+      # 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
+
       # Always `queued`. An accepted batch has not started yet.
       sig do
         returns(ContextDev::Models::BatchSubmitResponse::Status::TaggedSymbol)
@@ -124,6 +129,7 @@ module ContextDev
               ContextDev::Models::BatchSubmitResponse::InvalidURL::OrHash
             ],
           mode: ContextDev::Models::BatchSubmitResponse::Mode::OrSymbol,
+          request_id: String,
           status: ContextDev::Models::BatchSubmitResponse::Status::OrSymbol,
           tags: T::Array[String],
           key_metadata:
@@ -153,6 +159,9 @@ module ContextDev
         invalid_urls:,
         # How pages will be selected.
         mode:,
+        # 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:,
         # Always `queued`. An accepted batch has not started yet.
         status:,
         # Tags stored on the batch.
@@ -180,6 +189,7 @@ module ContextDev
             invalid_urls:
               T::Array[ContextDev::Models::BatchSubmitResponse::InvalidURL],
             mode: ContextDev::Models::BatchSubmitResponse::Mode::TaggedSymbol,
+            request_id: String,
             status:
               ContextDev::Models::BatchSubmitResponse::Status::TaggedSymbol,
             tags: T::Array[String],

data/rbi/context_dev/models/brand_retrieve_response.rbi

@@ -25,6 +25,11 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # 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
+
       # Detailed brand information
       sig do
         returns(T.nilable(ContextDev::Models::BrandRetrieveResponse::Brand))
@@ -72,6 +77,7 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::BrandRetrieveResponse::CacheMetadata::OrHash,
+          request_id: String,
           brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash,
           code: Integer,
           key_metadata:
@@ -84,6 +90,9 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # 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:,
         # Detailed brand information
         brand: nil,
         # HTTP status code
@@ -100,6 +109,7 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::BrandRetrieveResponse::CacheMetadata,
+            request_id: String,
             brand: ContextDev::Models::BrandRetrieveResponse::Brand,
             code: Integer,
             key_metadata:

data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi

@@ -29,6 +29,11 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # 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
+
       # Simplified brand information
       sig do
         returns(
@@ -81,6 +86,7 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::OrHash,
+          request_id: String,
           brand:
             ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash,
           code: Integer,
@@ -94,6 +100,9 @@ module ContextDev
         # cache-controlled fetch contributing to the output was a hit; age_ms is the
         # oldest contributing hit.
         cache_metadata:,
+        # 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:,
         # Simplified brand information
         brand: nil,
         # HTTP status code of the response
@@ -110,6 +119,7 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata,
+            request_id: String,
             brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
             code: Integer,
             key_metadata:

data/rbi/context_dev/models/brand_search_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
+
       # Up to 10 matching brands, name matches first, then domain matches, most popular
       # first within each group. Empty when nothing matches.
       sig { returns(T::Array[ContextDev::Models::BrandSearchResponse::Result]) }
@@ -32,6 +37,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           results:
             T::Array[ContextDev::Models::BrandSearchResponse::Result::OrHash],
           key_metadata:
@@ -39,6 +45,9 @@ 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:,
         # Up to 10 matching brands, name matches first, then domain matches, most popular
         # first within each group. Empty when nothing matches.
         results:,
@@ -50,6 +59,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             results: T::Array[ContextDev::Models::BrandSearchResponse::Result],
             key_metadata: ContextDev::Models::BrandSearchResponse::KeyMetadata
           }

data/rbi/context_dev/models/industry_retrieve_naics_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
+
       # Array of NAICS codes and titles.
       sig do
         returns(
@@ -72,6 +77,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           codes:
             T::Array[
               ContextDev::Models::IndustryRetrieveNaicsResponse::Code::OrHash
@@ -84,6 +90,9 @@ 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:,
         # Array of NAICS codes and titles.
         codes: nil,
         # Domain found for the brand
@@ -100,6 +109,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             codes:
               T::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code],
             domain: String,

data/rbi/context_dev/models/industry_retrieve_sic_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
+
       # Echoes back which SIC dataset was used to classify the brand.
       sig do
         returns(
@@ -92,6 +97,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           classification:
             ContextDev::Models::IndustryRetrieveSicResponse::Classification::OrSymbol,
           codes:
@@ -106,6 +112,9 @@ 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:,
         # Echoes back which SIC dataset was used to classify the brand.
         classification: nil,
         # Array of SIC codes with confidence scores. Extra fields depend on the requested
@@ -126,6 +135,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             classification:
               ContextDev::Models::IndustryRetrieveSicResponse::Classification::TaggedSymbol,
             codes:

data/rbi/context_dev/models/log_list_params.rbi

@@ -0,0 +1,162 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class LogListParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::LogListParams, ContextDev::Internal::AnyHash)
+        end
+
+      # Filter by the `error_code` returned in the response.
+      sig { returns(T.nilable(String)) }
+      attr_reader :error_code
+
+      sig { params(error_code: String).void }
+      attr_writer :error_code
+
+      # Only include requests that returned a 4xx or 5xx status.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :errors_only
+
+      sig { params(errors_only: T::Boolean).void }
+      attr_writer :errors_only
+
+      # Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
+      # before `to`.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :from
+
+      sig { params(from: Time).void }
+      attr_writer :from
+
+      # Filter by the API key that made the request.
+      sig { returns(T.nilable(String)) }
+      attr_reader :key_id
+
+      sig { params(key_id: String).void }
+      attr_writer :key_id
+
+      # Number of log entries per page.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :limit
+
+      sig { params(limit: Integer).void }
+      attr_writer :limit
+
+      # Page number, starting at 1.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :page
+
+      sig { params(page: Integer).void }
+      attr_writer :page
+
+      # Filter by endpoint path, with or without the /v1 prefix.
+      sig { returns(T.nilable(String)) }
+      attr_reader :path
+
+      sig { params(path: String).void }
+      attr_writer :path
+
+      # Case-insensitive substring match against the request query and body, e.g. a
+      # domain.
+      sig { returns(T.nilable(String)) }
+      attr_reader :search
+
+      sig { params(search: String).void }
+      attr_writer :search
+
+      # Filter by exact HTTP status code.
+      sig { returns(T.nilable(Integer)) }
+      attr_reader :status_code
+
+      sig { params(status_code: Integer).void }
+      attr_writer :status_code
+
+      # Comma-separated request tags. Matches requests carrying any of them. Up to 20
+      # tags, each 1-50 characters.
+      sig { returns(T.nilable(String)) }
+      attr_reader :tags
+
+      sig { params(tags: String).void }
+      attr_writer :tags
+
+      # Only include requests at or before this ISO 8601 timestamp. Defaults to now.
+      sig { returns(T.nilable(Time)) }
+      attr_reader :to
+
+      sig { params(to: Time).void }
+      attr_writer :to
+
+      sig do
+        params(
+          error_code: String,
+          errors_only: T::Boolean,
+          from: Time,
+          key_id: String,
+          limit: Integer,
+          page: Integer,
+          path: String,
+          search: String,
+          status_code: Integer,
+          tags: String,
+          to: Time,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Filter by the `error_code` returned in the response.
+        error_code: nil,
+        # Only include requests that returned a 4xx or 5xx status.
+        errors_only: nil,
+        # Only include requests at or after this ISO 8601 timestamp. Defaults to 24 hours
+        # before `to`.
+        from: nil,
+        # Filter by the API key that made the request.
+        key_id: nil,
+        # Number of log entries per page.
+        limit: nil,
+        # Page number, starting at 1.
+        page: nil,
+        # Filter by endpoint path, with or without the /v1 prefix.
+        path: nil,
+        # Case-insensitive substring match against the request query and body, e.g. a
+        # domain.
+        search: nil,
+        # Filter by exact HTTP status code.
+        status_code: nil,
+        # Comma-separated request tags. Matches requests carrying any of them. Up to 20
+        # tags, each 1-50 characters.
+        tags: nil,
+        # Only include requests at or before this ISO 8601 timestamp. Defaults to now.
+        to: nil,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            error_code: String,
+            errors_only: T::Boolean,
+            from: Time,
+            key_id: String,
+            limit: Integer,
+            page: Integer,
+            path: String,
+            search: String,
+            status_code: Integer,
+            tags: String,
+            to: Time,
+            request_options: ContextDev::RequestOptions
+          }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end