context.dev 2.16.0 → 2.17.1

data/rbi/context_dev/models/brand_retrieve_response.rbi

@@ -11,6 +11,17 @@ module ContextDev
           )
         end
 
+      # Detailed brand information
+      sig { returns(ContextDev::Models::BrandRetrieveResponse::Brand) }
+      attr_reader :brand
+
+      sig do
+        params(
+          brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash
+        ).void
+      end
+      attr_writer :brand
+
       # 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.
@@ -25,30 +36,18 @@ module ContextDev
       end
       attr_writer :cache_metadata
 
+      # HTTP status code
+      sig { returns(Integer) }
+      attr_accessor :code
+
       # 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))
-      end
-      attr_reader :brand
-
-      sig do
-        params(
-          brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash
-        ).void
-      end
-      attr_writer :brand
-
-      # HTTP status code
-      sig { returns(T.nilable(Integer)) }
-      attr_reader :code
-
-      sig { params(code: Integer).void }
-      attr_writer :code
+      # Status of the response, e.g., 'ok'
+      sig { returns(String) }
+      attr_accessor :status
 
       # Credit usage, included whenever a valid API key is provided.
       sig do
@@ -66,156 +65,67 @@ module ContextDev
       end
       attr_writer :key_metadata
 
-      # Status of the response, e.g., 'ok'
-      sig { returns(T.nilable(String)) }
-      attr_reader :status
+      # 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(status: String).void }
-      attr_writer :status
+      sig { params(partial: T::Boolean).void }
+      attr_writer :partial
 
       sig do
         params(
+          brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash,
           cache_metadata:
             ContextDev::Models::BrandRetrieveResponse::CacheMetadata::OrHash,
-          request_id: String,
-          brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash,
           code: Integer,
+          request_id: String,
+          status: String,
           key_metadata:
             ContextDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash,
-          status: String
+          partial: T::Boolean
         ).returns(T.attached_class)
       end
       def self.new(
+        # Detailed brand information
+        brand:,
         # 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.
         cache_metadata:,
+        # HTTP status code
+        code:,
         # 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,
+        # Status of the response, e.g., 'ok'
+        status:,
         # Credit usage, included whenever a valid API key is provided.
         key_metadata: nil,
-        # Status of the response, e.g., 'ok'
-        status: nil
+        # True when the timeout ended processing and this response contains the usable
+        # data completed so far. Unfinished fields are omitted.
+        partial: nil
       )
       end
 
       sig do
         override.returns(
           {
+            brand: ContextDev::Models::BrandRetrieveResponse::Brand,
             cache_metadata:
               ContextDev::Models::BrandRetrieveResponse::CacheMetadata,
-            request_id: String,
-            brand: ContextDev::Models::BrandRetrieveResponse::Brand,
             code: Integer,
+            request_id: String,
+            status: String,
             key_metadata:
               ContextDev::Models::BrandRetrieveResponse::KeyMetadata,
-            status: String
+            partial: T::Boolean
           }
         )
       end
       def to_hash
       end
 
-      class CacheMetadata < ContextDev::Internal::Type::BaseModel
-        OrHash =
-          T.type_alias do
-            T.any(
-              ContextDev::Models::BrandRetrieveResponse::CacheMetadata,
-              ContextDev::Internal::AnyHash
-            )
-          end
-
-        # Age of the cached data in milliseconds. Zero for miss and zdr responses.
-        sig { returns(Integer) }
-        attr_accessor :age_ms
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        sig do
-          returns(
-            ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
-          )
-        end
-        attr_accessor :status
-
-        # 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.
-        sig do
-          params(
-            age_ms: Integer,
-            status:
-              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::OrSymbol
-          ).returns(T.attached_class)
-        end
-        def self.new(
-          # Age of the cached data in milliseconds. Zero for miss and zdr responses.
-          age_ms:,
-          # Whether the response was served from cache, required fresh work, or honored
-          # zero-data-retention cache bypass.
-          status:
-        )
-        end
-
-        sig do
-          override.returns(
-            {
-              age_ms: Integer,
-              status:
-                ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
-            }
-          )
-        end
-        def to_hash
-        end
-
-        # Whether the response was served from cache, required fresh work, or honored
-        # zero-data-retention cache bypass.
-        module Status
-          extend ContextDev::Internal::Type::Enum
-
-          TaggedSymbol =
-            T.type_alias do
-              T.all(
-                Symbol,
-                ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status
-              )
-            end
-          OrSymbol = T.type_alias { T.any(Symbol, String) }
-
-          HIT =
-            T.let(
-              :hit,
-              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
-            )
-          MISS =
-            T.let(
-              :miss,
-              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
-            )
-          ZDR =
-            T.let(
-              :zdr,
-              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
-            )
-
-          sig do
-            override.returns(
-              T::Array[
-                ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
-              ]
-            )
-          end
-          def self.values
-          end
-        end
-      end
-
       class Brand < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do
@@ -3802,6 +3712,101 @@ module ContextDev
         end
       end
 
+      class CacheMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::BrandRetrieveResponse::CacheMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Age of the cached data in milliseconds. Zero for miss and zdr responses.
+        sig { returns(Integer) }
+        attr_accessor :age_ms
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        sig do
+          returns(
+            ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
+          )
+        end
+        attr_accessor :status
+
+        # 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.
+        sig do
+          params(
+            age_ms: Integer,
+            status:
+              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::OrSymbol
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Age of the cached data in milliseconds. Zero for miss and zdr responses.
+          age_ms:,
+          # Whether the response was served from cache, required fresh work, or honored
+          # zero-data-retention cache bypass.
+          status:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              age_ms: Integer,
+              status:
+                ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
+            }
+          )
+        end
+        def to_hash
+        end
+
+        # Whether the response was served from cache, required fresh work, or honored
+        # zero-data-retention cache bypass.
+        module Status
+          extend ContextDev::Internal::Type::Enum
+
+          TaggedSymbol =
+            T.type_alias do
+              T.all(
+                Symbol,
+                ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          HIT =
+            T.let(
+              :hit,
+              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          MISS =
+            T.let(
+              :miss,
+              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
+            )
+          ZDR =
+            T.let(
+              :zdr,
+              ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::Models::BrandRetrieveResponse::CacheMetadata::Status::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        end
+      end
+
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         OrHash =
           T.type_alias do

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