context.dev 2.15.0 → 2.17.0

data/rbi/context_dev/models/industry_retrieve_sic_params.rbi

@@ -42,14 +42,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::IndustryRetrieveSicParams::TimeoutOpts))
+      end
+      attr_reader :timeout_opts
 
-      sig { params(timeout_ms: Integer).void }
-      attr_writer :timeout_ms
+      sig do
+        params(
+          timeout_opts:
+            ContextDev::IndustryRetrieveSicParams::TimeoutOpts::OrHash
+        ).void
+      end
+      attr_writer :timeout_opts
 
       # Which SIC dataset to classify against. `original_sic` uses the 1987 Standard
       # Industrial Classification system; `latest_sec` uses the current SIC list as
@@ -72,7 +79,8 @@ module ContextDev
           max_results: Integer,
           min_results: Integer,
           tags: T::Array[String],
-          timeout_ms: Integer,
+          timeout_opts:
+            ContextDev::IndustryRetrieveSicParams::TimeoutOpts::OrHash,
           type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
           request_options: ContextDev::RequestOptions::OrHash
         ).returns(T.attached_class)
@@ -89,10 +97,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,
         # 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`.
@@ -108,7 +116,7 @@ module ContextDev
             max_results: Integer,
             min_results: Integer,
             tags: T::Array[String],
-            timeout_ms: Integer,
+            timeout_opts: ContextDev::IndustryRetrieveSicParams::TimeoutOpts,
             type: ContextDev::IndustryRetrieveSicParams::Type::OrSymbol,
             request_options: ContextDev::RequestOptions
           }
@@ -117,6 +125,112 @@ module ContextDev
       def to_hash
       end
 
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::IndustryRetrieveSicParams::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::IndustryRetrieveSicParams::TimeoutOpts::Behavior::OrSymbol
+            )
+          )
+        end
+        attr_reader :behavior
+
+        sig do
+          params(
+            behavior:
+              ContextDev::IndustryRetrieveSicParams::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::IndustryRetrieveSicParams::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::IndustryRetrieveSicParams::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::IndustryRetrieveSicParams::TimeoutOpts::Behavior
+              )
+            end
+          OrSymbol = T.type_alias { T.any(Symbol, String) }
+
+          FAIL =
+            T.let(
+              :fail,
+              ContextDev::IndustryRetrieveSicParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+          RETURN_PARTIAL =
+            T.let(
+              :"return-partial",
+              ContextDev::IndustryRetrieveSicParams::TimeoutOpts::Behavior::TaggedSymbol
+            )
+
+          sig do
+            override.returns(
+              T::Array[
+                ContextDev::IndustryRetrieveSicParams::TimeoutOpts::Behavior::TaggedSymbol
+              ]
+            )
+          end
+          def self.values
+          end
+        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`.

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(
@@ -76,6 +81,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
@@ -92,6 +105,7 @@ module ContextDev
 
       sig do
         params(
+          request_id: String,
           classification:
             ContextDev::Models::IndustryRetrieveSicResponse::Classification::OrSymbol,
           codes:
@@ -101,11 +115,15 @@ module ContextDev
           domain: String,
           key_metadata:
             ContextDev::Models::IndustryRetrieveSicResponse::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:,
         # 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
@@ -116,6 +134,9 @@ module ContextDev
         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 sic api it will be `sic`
@@ -126,6 +147,7 @@ module ContextDev
       sig do
         override.returns(
           {
+            request_id: String,
             classification:
               ContextDev::Models::IndustryRetrieveSicResponse::Classification::TaggedSymbol,
             codes:
@@ -133,6 +155,7 @@ module ContextDev
             domain: String,
             key_metadata:
               ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata,
+            partial: T::Boolean,
             status: String,
             type: String
           }

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

data/rbi/context_dev/models/log_list_response.rbi

@@ -0,0 +1,246 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class LogListResponse < ContextDev::Internal::Type::BaseModel
+      OrHash =
+        T.type_alias do
+          T.any(
+            ContextDev::Models::LogListResponse,
+            ContextDev::Internal::AnyHash
+          )
+        end
+
+      # Log entries, newest first.
+      sig { returns(T::Array[ContextDev::Models::LogListResponse::Data]) }
+      attr_accessor :data
+
+      # Whether a next page exists.
+      sig { returns(T::Boolean) }
+      attr_accessor :has_more
+
+      # Entries per page.
+      sig { returns(Integer) }
+      attr_accessor :limit
+
+      # Current page number.
+      sig { returns(Integer) }
+      attr_accessor :page
+
+      # 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
+
+      # Credit usage, included whenever a valid API key is provided.
+      sig do
+        returns(T.nilable(ContextDev::Models::LogListResponse::KeyMetadata))
+      end
+      attr_reader :key_metadata
+
+      sig do
+        params(
+          key_metadata: ContextDev::Models::LogListResponse::KeyMetadata::OrHash
+        ).void
+      end
+      attr_writer :key_metadata
+
+      sig do
+        params(
+          data: T::Array[ContextDev::Models::LogListResponse::Data::OrHash],
+          has_more: T::Boolean,
+          limit: Integer,
+          page: Integer,
+          request_id: String,
+          key_metadata: ContextDev::Models::LogListResponse::KeyMetadata::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # Log entries, newest first.
+        data:,
+        # Whether a next page exists.
+        has_more:,
+        # Entries per page.
+        limit:,
+        # Current page number.
+        page:,
+        # 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:,
+        # Credit usage, included whenever a valid API key is provided.
+        key_metadata: nil
+      )
+      end
+
+      sig do
+        override.returns(
+          {
+            data: T::Array[ContextDev::Models::LogListResponse::Data],
+            has_more: T::Boolean,
+            limit: Integer,
+            page: Integer,
+            request_id: String,
+            key_metadata: ContextDev::Models::LogListResponse::KeyMetadata
+          }
+        )
+      end
+      def to_hash
+      end
+
+      class Data < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::LogListResponse::Data,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits charged for this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_used
+
+        # The `error_code` from the response, or null on success.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :error_code
+
+        # ID of the API key that made the request.
+        sig { returns(T.nilable(String)) }
+        attr_accessor :key_id
+
+        # Server-side processing time in milliseconds.
+        sig { returns(Float) }
+        attr_accessor :latency_ms
+
+        # HTTP method.
+        sig { returns(String) }
+        attr_accessor :method_
+
+        # Endpoint path as called.
+        sig { returns(String) }
+        attr_accessor :path
+
+        # Request ID of the logged API call.
+        sig { returns(String) }
+        attr_accessor :request_id
+
+        # HTTP status code returned.
+        sig { returns(Integer) }
+        attr_accessor :status_code
+
+        # Request tags supplied by the caller.
+        sig { returns(T::Array[String]) }
+        attr_accessor :tags
+
+        # When the request completed.
+        sig { returns(Time) }
+        attr_accessor :timestamp
+
+        # Whether the request was made under zero data retention.
+        sig { returns(T::Boolean) }
+        attr_accessor :zdr
+
+        sig do
+          params(
+            credits_used: Integer,
+            error_code: T.nilable(String),
+            key_id: T.nilable(String),
+            latency_ms: Float,
+            method_: String,
+            path: String,
+            request_id: String,
+            status_code: Integer,
+            tags: T::Array[String],
+            timestamp: Time,
+            zdr: T::Boolean
+          ).returns(T.attached_class)
+        end
+        def self.new(
+          # Credits charged for this request.
+          credits_used:,
+          # The `error_code` from the response, or null on success.
+          error_code:,
+          # ID of the API key that made the request.
+          key_id:,
+          # Server-side processing time in milliseconds.
+          latency_ms:,
+          # HTTP method.
+          method_:,
+          # Endpoint path as called.
+          path:,
+          # Request ID of the logged API call.
+          request_id:,
+          # HTTP status code returned.
+          status_code:,
+          # Request tags supplied by the caller.
+          tags:,
+          # When the request completed.
+          timestamp:,
+          # Whether the request was made under zero data retention.
+          zdr:
+        )
+        end
+
+        sig do
+          override.returns(
+            {
+              credits_used: Integer,
+              error_code: T.nilable(String),
+              key_id: T.nilable(String),
+              latency_ms: Float,
+              method_: String,
+              path: String,
+              request_id: String,
+              status_code: Integer,
+              tags: T::Array[String],
+              timestamp: Time,
+              zdr: T::Boolean
+            }
+          )
+        end
+        def to_hash
+        end
+      end
+
+      class KeyMetadata < ContextDev::Internal::Type::BaseModel
+        OrHash =
+          T.type_alias do
+            T.any(
+              ContextDev::Models::LogListResponse::KeyMetadata,
+              ContextDev::Internal::AnyHash
+            )
+          end
+
+        # Credits used by this request.
+        sig { returns(Integer) }
+        attr_accessor :credits_consumed
+
+        # Credits remaining for your organization.
+        sig { returns(Integer) }
+        attr_accessor :credits_remaining
+
+        # Credit usage, included whenever a valid API key is provided.
+        sig do
+          params(credits_consumed: Integer, credits_remaining: Integer).returns(
+            T.attached_class
+          )
+        end
+        def self.new(
+          # Credits used by this request.
+          credits_consumed:,
+          # Credits remaining for your organization.
+          credits_remaining:
+        )
+        end
+
+        sig do
+          override.returns(
+            { credits_consumed: Integer, credits_remaining: Integer }
+          )
+        end
+        def to_hash
+        end
+      end
+    end
+  end
+end

data/rbi/context_dev/models/log_retrieve_params.rbi

@@ -0,0 +1,40 @@
+# typed: strong
+
+module ContextDev
+  module Models
+    class LogRetrieveParams < ContextDev::Internal::Type::BaseModel
+      extend ContextDev::Internal::Type::RequestParameters::Converter
+      include ContextDev::Internal::Type::RequestParameters
+
+      OrHash =
+        T.type_alias do
+          T.any(ContextDev::LogRetrieveParams, ContextDev::Internal::AnyHash)
+        end
+
+      # The request ID of the logged API call.
+      sig { returns(String) }
+      attr_accessor :request_id
+
+      sig do
+        params(
+          request_id: String,
+          request_options: ContextDev::RequestOptions::OrHash
+        ).returns(T.attached_class)
+      end
+      def self.new(
+        # The request ID of the logged API call.
+        request_id:,
+        request_options: {}
+      )
+      end
+
+      sig do
+        override.returns(
+          { request_id: String, request_options: ContextDev::RequestOptions }
+        )
+      end
+      def to_hash
+      end
+    end
+  end
+end