context.dev 2.15.0 → 2.17.0

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))
@@ -61,6 +66,14 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when the timeout ended processing and this response contains the usable
+      # data completed so far. Unfinished fields are omitted.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -72,10 +85,12 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::BrandRetrieveResponse::CacheMetadata::OrHash,
+          request_id: String,
           brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash,
           code: Integer,
           key_metadata:
             ContextDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash,
+          partial: T::Boolean,
           status: String
         ).returns(T.attached_class)
       end
@@ -84,12 +99,18 @@ 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
         code: nil,
         # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
+        # True when the timeout ended processing and this response contains the usable
+        # data completed so far. Unfinished fields are omitted.
+        partial: nil,
         # Status of the response, e.g., 'ok'
         status: nil
       )
@@ -100,10 +121,12 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::BrandRetrieveResponse::CacheMetadata,
+            request_id: String,
             brand: ContextDev::Models::BrandRetrieveResponse::Brand,
             code: Integer,
             key_metadata:
               ContextDev::Models::BrandRetrieveResponse::KeyMetadata,
+            partial: T::Boolean,
             status: String
           }
         )

data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi

@@ -19,9 +19,9 @@ module ContextDev
       attr_accessor :domain
 
       # Maximum age in milliseconds for cached brand data before the API performs a hard
-      # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
-      # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-      # year.
+      # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
+      # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
+      # are clamped to 1 year.
       sig { returns(T.nilable(Integer)) }
       attr_accessor :max_age_ms
 
@@ -48,14 +48,23 @@ module ContextDev
       end
       attr_writer :theme
 
-      # 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).
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :timeout_ms
+      # Optional request deadline and behavior on timeout. For GET requests, use
+      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      # timeoutOpts object.
+      sig do
+        returns(
+          T.nilable(ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts)
+        )
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts:
+            ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
@@ -63,7 +72,8 @@ module ContextDev
           max_age_ms: T.nilable(Integer),
           tags: T::Array[String],
           theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
-          timeout_ms: Integer,
+          timeout_opts:
+            ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -71,19 +81,19 @@ module ContextDev
         # Domain name to retrieve simplified brand data for
         domain:,
         # Maximum age in milliseconds for cached brand data before the API performs a hard
-        # refresh. Defaults to 3 months (7776000000 ms). Values below 1 day (86400000 ms)
-        # are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
-        # year.
+        # refresh. Defaults to 3 months (7776000000 ms). Set to 0 to always perform a hard
+        # refresh. Negative values are clamped to 0; values above 1 year (31536000000 ms)
+        # are clamped to 1 year.
         max_age_ms: nil,
         # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
         # characters.
         tags: nil,
         # Optional theme preference used when selecting brand assets.
         theme: 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
-        # value is 300000ms (5 minutes).
-        timeout_ms: nil,
+        # Optional request deadline and behavior on timeout. For GET requests, use
+        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+        # timeoutOpts object.
+        timeout_opts: nil,
         request_options: {}
       )
       end
@@ -95,7 +105,8 @@ module ContextDev
             max_age_ms: T.nilable(Integer),
             tags: T::Array[String],
             theme: ContextDev::BrandRetrieveSimplifiedParams::Theme::OrSymbol,
-            timeout_ms: Integer,
+            timeout_opts:
+              ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
@@ -134,6 +145,112 @@ module ContextDev
         def self.values
         end
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        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.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior::OrSymbol
+          ).void
+        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.
+        sig do
+          params(
+            milliseconds: Integer,
+            behavior:
+              ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          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.
+          behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              milliseconds: Integer,
+              behavior:
+                ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior::OrSymbol
+            }
+          )
+        end
+        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.
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

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(
@@ -70,6 +75,14 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when the timeout ended processing and only completed brand data is
+      # returned.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -81,11 +94,13 @@ module ContextDev
         params(
           cache_metadata:
             ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::OrHash,
+          request_id: String,
           brand:
             ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash,
           code: Integer,
           key_metadata:
             ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash,
+          partial: T::Boolean,
           status: String
         ).returns(T.attached_class)
       end
@@ -94,12 +109,18 @@ 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
         code: nil,
         # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
+        # True when the timeout ended processing and only completed brand data is
+        # returned.
+        partial: nil,
         # Status of the response, e.g., 'ok'
         status: nil
       )
@@ -110,10 +131,12 @@ module ContextDev
           {
             cache_metadata:
               ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata,
+            request_id: String,
             brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand,
             code: Integer,
             key_metadata:
               ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata,
+            partial: T::Boolean,
             status: String
           }
         )

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_params.rbi

@@ -43,14 +43,21 @@ module ContextDev
       sig { params(tags: T::Array[String]).void }
       attr_writer :tags
 
-      # 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).
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :timeout_ms
+      # Optional request deadline and behavior on timeout. For GET requests, use
+      # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+      # timeoutOpts object.
+      sig do
+        returns(T.nilable(ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts:
+            ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       sig do
         params(
@@ -58,7 +65,8 @@ module ContextDev
           max_results: Integer,
           min_results: Integer,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts:
+            ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::OrHash,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
       end
@@ -75,10 +83,10 @@ module ContextDev
         # 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
-        # value is 300000ms (5 minutes).
-        timeout_ms: nil,
+        # Optional request deadline and behavior on timeout. For GET requests, use
+        # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
+        # timeoutOpts object.
+        timeout_opts: nil,
         request_options: {}
       )
       end
@@ -90,13 +98,119 @@ module ContextDev
             max_results: Integer,
             min_results: Integer,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts,
             request_options: ContextDev::RequestOptions
           }
         )
       end
       def to_hash
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        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.
+        sig do
+          returns(
+            T.nilable(
+              ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior::OrSymbol
+          ).void
+        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.
+        sig do
+          params(
+            milliseconds: Integer,
+            behavior:
+              ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+          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.
+          behavior: nil
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              milliseconds: Integer,
+              behavior:
+                ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior::OrSymbol
+            }
+          )
+        end
+        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.
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
     end
   end
 end

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(
@@ -56,6 +61,14 @@ module ContextDev
       end
       attr_writer :key_metadata
 
+      # True when the timeout ended processing and this response contains only usable
+      # results completed so far. Unfinished results are omitted.
+      sig { returns(T.nilable(T::Boolean)) }
+      attr_reader :partial
+
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
+
       # Status of the response, e.g., 'ok'
       sig { returns(T.nilable(String)) }
       attr_reader :status
@@ -72,6 +85,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           codes:
             T::Array[
               ContextDev::Models::IndustryRetrieveNaicsResponse::Code::OrHash
@@ -79,17 +93,24 @@ module ContextDev
           domain: String,
           key_metadata:
             ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata::OrHash,
+          partial: T::Boolean,
           status: String,
           type: String
         ).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
         domain: nil,
         # Credit usage, included whenever a valid API key is provided.
         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'
         status: nil,
         # Industry classification type, for naics api it will be `naics`
@@ -100,11 +121,13 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             codes:
               T::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code],
             domain: String,
             key_metadata:
               ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata,
+            partial: T::Boolean,
             status: String,
             type: String
           }