context.dev 2.16.0 → 2.17.1

data/lib/context_dev/models/brand_retrieve_response.rb

@@ -4,6 +4,12 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Brand#retrieve
     class BrandRetrieveResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Detailed brand information
+      #
+      #   @return [ContextDev::Models::BrandRetrieveResponse::Brand]
+      required :brand, -> { ContextDev::Models::BrandRetrieveResponse::Brand }
+
       # @!attribute cache_metadata
       #   Cache outcome for this response. Composite responses are hits only when every
       #   cache-controlled fetch contributing to the output was a hit; age_ms is the
@@ -12,6 +18,12 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata }
 
+      # @!attribute code
+      #   HTTP status code
+      #
+      #   @return [Integer]
+      required :code, Integer
+
       # @!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.
@@ -19,17 +31,11 @@ module ContextDev
       #   @return [String]
       required :request_id, String
 
-      # @!attribute brand
-      #   Detailed brand information
-      #
-      #   @return [ContextDev::Models::BrandRetrieveResponse::Brand, nil]
-      optional :brand, -> { ContextDev::Models::BrandRetrieveResponse::Brand }
-
-      # @!attribute code
-      #   HTTP status code
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
       #
-      #   @return [Integer, nil]
-      optional :code, Integer
+      #   @return [String]
+      required :status, String
 
       # @!attribute key_metadata
       #   Credit usage, included whenever a valid API key is provided.
@@ -37,70 +43,30 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BrandRetrieveResponse::KeyMetadata }
 
-      # @!attribute status
-      #   Status of the response, e.g., 'ok'
+      # @!attribute partial
+      #   True when the timeout ended processing and this response contains the usable
+      #   data completed so far. Unfinished fields are omitted.
       #
-      #   @return [String, nil]
-      optional :status, String
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
 
-      # @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, status: nil)
+      # @!method initialize(brand:, cache_metadata:, code:, request_id:, status:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveResponse} for more details.
       #
+      #   @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
+      #
       #   @param cache_metadata [ContextDev::Models::BrandRetrieveResponse::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 code [Integer] HTTP status code
       #
-      #   @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #
-      #   @param code [Integer] HTTP status code
+      #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
-      #   @param status [String] Status of the response, e.g., 'ok'
-
-      # @see ContextDev::Models::BrandRetrieveResponse#cache_metadata
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute age_ms
-        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @return [Integer]
-        required :age_ms, Integer
-
-        # @!attribute status
-        #   Whether the response was served from cache, required fresh work, or honored
-        #   zero-data-retention cache bypass.
-        #
-        #   @return [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::BrandRetrieveResponse::CacheMetadata} for more details.
-        #
-        #   Cache outcome for this response. Composite responses are hits only when every
-        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-        #   oldest contributing hit.
-        #
-        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @param status [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        #
-        # @see ContextDev::Models::BrandRetrieveResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
+      #   @param partial [Boolean] True when the timeout ended processing and this response contains the usable dat
 
       # @see ContextDev::Models::BrandRetrieveResponse#brand
       class Brand < ContextDev::Internal::Type::BaseModel
@@ -1181,6 +1147,49 @@ module ContextDev
         end
       end
 
+      # @see ContextDev::Models::BrandRetrieveResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandRetrieveResponse::CacheMetadata} for more details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::BrandRetrieveResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::BrandRetrieveResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/brand_retrieve_simplified_params.rb

@@ -15,9 +15,9 @@ module ContextDev
 
       # @!attribute max_age_ms
       #   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.
       #
       #   @return [Integer, nil]
       optional :max_age_ms, Integer, nil?: true
@@ -35,15 +35,15 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme, nil]
       optional :theme, enum: -> { ContextDev::BrandRetrieveSimplifiedParams::Theme }
 
-      # @!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
+      #   @return [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts }
 
-      # @!method initialize(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
       #
@@ -55,7 +55,7 @@ module ContextDev
       #
       #   @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -69,6 +69,52 @@ module ContextDev
         # @!method self.values
         #   @return [Array<Symbol>]
       end
+
+      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::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::BrandRetrieveSimplifiedParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandRetrieveSimplifiedParams::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::BrandRetrieveSimplifiedParams::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::BrandRetrieveSimplifiedParams::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/brand_retrieve_simplified_response.rb

@@ -4,6 +4,12 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Brand#retrieve_simplified
     class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute brand
+      #   Simplified brand information
+      #
+      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand]
+      required :brand, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand }
+
       # @!attribute cache_metadata
       #   Cache outcome for this response. Composite responses are hits only when every
       #   cache-controlled fetch contributing to the output was a hit; age_ms is the
@@ -12,6 +18,12 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata }
 
+      # @!attribute code
+      #   HTTP status code of the response
+      #
+      #   @return [Integer]
+      required :code, Integer
+
       # @!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.
@@ -19,17 +31,11 @@ module ContextDev
       #   @return [String]
       required :request_id, String
 
-      # @!attribute brand
-      #   Simplified brand information
-      #
-      #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, nil]
-      optional :brand, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand }
-
-      # @!attribute code
-      #   HTTP status code of the response
+      # @!attribute status
+      #   Status of the response, e.g., 'ok'
       #
-      #   @return [Integer, nil]
-      optional :code, Integer
+      #   @return [String]
+      required :status, String
 
       # @!attribute key_metadata
       #   Credit usage, included whenever a valid API key is provided.
@@ -37,71 +43,30 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata }
 
-      # @!attribute status
-      #   Status of the response, e.g., 'ok'
+      # @!attribute partial
+      #   True when the timeout ended processing and only completed brand data is
+      #   returned.
       #
-      #   @return [String, nil]
-      optional :status, String
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
 
-      # @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, status: nil)
+      # @!method initialize(brand:, cache_metadata:, code:, request_id:, status:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
       #
+      #   @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
+      #
       #   @param cache_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::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 code [Integer] HTTP status code of the response
       #
-      #   @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #
-      #   @param code [Integer] HTTP status code of the response
+      #   @param status [String] Status of the response, e.g., 'ok'
       #
       #   @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
-      #   @param status [String] Status of the response, e.g., 'ok'
-
-      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#cache_metadata
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        # @!attribute age_ms
-        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @return [Integer]
-        required :age_ms, Integer
-
-        # @!attribute status
-        #   Whether the response was served from cache, required fresh work, or honored
-        #   zero-data-retention cache bypass.
-        #
-        #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status]
-        required :status, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status }
-
-        # @!method initialize(age_ms:, status:)
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata} for more
-        #   details.
-        #
-        #   Cache outcome for this response. Composite responses are hits only when every
-        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
-        #   oldest contributing hit.
-        #
-        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        #
-        #   @param status [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        #
-        # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata#status
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          HIT = :hit
-          MISS = :miss
-          ZDR = :zdr
-
-          # @!method self.values
-          #   @return [Array<Symbol>]
-        end
-      end
+      #   @param partial [Boolean] True when the timeout ended processing and only completed brand data is returned
 
       # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#brand
       class Brand < ContextDev::Internal::Type::BaseModel
@@ -406,6 +371,50 @@ module ContextDev
         end
       end
 
+      # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#cache_metadata
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        # @!attribute age_ms
+        #   Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @return [Integer]
+        required :age_ms, Integer
+
+        # @!attribute status
+        #   Whether the response was served from cache, required fresh work, or honored
+        #   zero-data-retention cache bypass.
+        #
+        #   @return [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status]
+        required :status, enum: -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status }
+
+        # @!method initialize(age_ms:, status:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata} for more
+        #   details.
+        #
+        #   Cache outcome for this response. Composite responses are hits only when every
+        #   cache-controlled fetch contributing to the output was a hit; age_ms is the
+        #   oldest contributing hit.
+        #
+        #   @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        #
+        #   @param status [Symbol, ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata::Status] Whether the response was served from cache, required fresh work, or honored zero
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        #
+        # @see ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata#status
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          HIT = :hit
+          MISS = :miss
+          ZDR = :zdr
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed

data/lib/context_dev/models/industry_retrieve_naics_params.rb

@@ -35,15 +35,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
+      #   @return [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts }
 
-      # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::IndustryRetrieveNaicsParams} for more details.
       #
@@ -55,9 +55,54 @@ module ContextDev
       #
       #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::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::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::IndustryRetrieveNaicsParams::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::IndustryRetrieveNaicsParams::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::IndustryRetrieveNaicsParams::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/industry_retrieve_naics_response.rb

@@ -30,6 +30,13 @@ module ContextDev
       #   @return [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveNaicsResponse::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 status
       #   Status of the response, e.g., 'ok'
       #
@@ -42,7 +49,7 @@ module ContextDev
       #   @return [String, nil]
       optional :type, String
 
-      # @!method initialize(request_id:, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
+      # @!method initialize(request_id:, codes: nil, domain: nil, key_metadata: nil, partial: nil, status: nil, type: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::IndustryRetrieveNaicsResponse} for more details.
       #
@@ -54,6 +61,8 @@ module ContextDev
       #
       #   @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::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 status [String] Status of the response, e.g., 'ok'
       #
       #   @param type [String] Industry classification type, for naics api it will be `naics`

data/lib/context_dev/models/industry_retrieve_sic_params.rb

@@ -34,13 +34,13 @@ 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
+      #   @return [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::IndustryRetrieveSicParams::TimeoutOpts }
 
       # @!attribute type
       #   Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
@@ -50,7 +50,7 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil]
       optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }
 
-      # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_ms: nil, type: nil, request_options: {})
+      # @!method initialize(input:, max_results: nil, min_results: nil, tags: nil, timeout_opts: nil, type: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::IndustryRetrieveSicParams} for more details.
       #
@@ -62,12 +62,57 @@ module ContextDev
       #
       #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] Which SIC dataset to classify against. `original_sic` uses the 1987 Standard Ind
       #
       #   @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::IndustryRetrieveSicParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::IndustryRetrieveSicParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::IndustryRetrieveSicParams::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::IndustryRetrieveSicParams::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::IndustryRetrieveSicParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
+
       # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
       # Industrial Classification system; `latest_sec` uses the current SIC list as
       # published by the SEC. Defaults to `original_sic`.