diff --git a/.release-please-manifest.json b/.release-please-manifest.json index 81d2de2d..592b0e15 100644 --- a/.release-please-manifest.json +++ b/.release-please-manifest.json @@ -1,3 +1,3 @@ { - ".": "1.31.0" + ".": "1.32.0" } \ No newline at end of file diff --git a/.stats.yml b/.stats.yml index 793d9bfe..2a5683fb 100644 --- a/.stats.yml +++ b/.stats.yml @@ -1,4 +1,4 @@ configured_endpoints: 25 -openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-5a8e1f6e16ecdbab4b2ff14701779818fe0328b06a1c7fa44a32da4f4bc87a49.yml -openapi_spec_hash: 4b5407859d1154232189ef440b783b17 +openapi_spec_url: https://storage.googleapis.com/stainless-sdk-openapi-specs/context-dev/context.dev-b84f53b1a92511eff85645f287ec08d43adcdcc589367c015770bde836422a65.yml +openapi_spec_hash: 71e317da7bc58cfc3bc2e4180f5b6267 config_hash: f86a4e06ae5ed725aa79d58d7a8dc27c diff --git a/CHANGELOG.md b/CHANGELOG.md index ca035f87..0c5ce51a 100644 --- a/CHANGELOG.md +++ b/CHANGELOG.md @@ -1,5 +1,14 @@ # Changelog +## 1.32.0 (2026-06-11) + +Full Changelog: [v1.31.0...v1.32.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.31.0...v1.32.0) + +### Features + +* **api:** api update ([67ddd60](https://github.com/context-dot-dev/context-ruby-sdk/commit/67ddd60fffad48a4cc6697fb940f6510bc04d0cb)) +* **api:** api update ([e987167](https://github.com/context-dot-dev/context-ruby-sdk/commit/e9871675c89fd313209d95cd54071fe986dd772a)) + ## 1.31.0 (2026-06-08) Full Changelog: [v1.30.0...v1.31.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v1.30.0...v1.31.0) diff --git a/Gemfile.lock b/Gemfile.lock index 5802cdd9..d7ced154 100644 --- a/Gemfile.lock +++ b/Gemfile.lock @@ -11,7 +11,7 @@ GIT PATH remote: . specs: - context.dev (1.31.0) + context.dev (1.32.0) cgi connection_pool diff --git a/README.md b/README.md index e610276c..6a12a624 100644 --- a/README.md +++ b/README.md @@ -26,7 +26,7 @@ To use this gem, install via Bundler by adding the following to your application ```ruby -gem "context.dev", "~> 1.31.0" +gem "context.dev", "~> 1.32.0" ``` diff --git a/lib/context_dev/models/ai_ai_query_response.rb b/lib/context_dev/models/ai_ai_query_response.rb index fc23b0ef..90ce1a13 100644 --- a/lib/context_dev/models/ai_ai_query_response.rb +++ b/lib/context_dev/models/ai_ai_query_response.rb @@ -17,6 +17,13 @@ class AIAIQueryResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::AIAIQueryResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::AIAIQueryResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # @@ -29,11 +36,16 @@ class AIAIQueryResponse < ContextDev::Internal::Type::BaseModel # @return [Array, nil] optional :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String] - # @!method initialize(data_extracted: nil, domain: nil, status: nil, urls_analyzed: nil) + # @!method initialize(data_extracted: nil, domain: nil, key_metadata: nil, status: nil, urls_analyzed: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::AIAIQueryResponse} for more details. + # # @param data_extracted [Array] Array of extracted data points # # @param domain [String] The domain that was analyzed # + # @param key_metadata [ContextDev::Models::AIAIQueryResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # # @param urls_analyzed [Array] List of URLs that were analyzed @@ -93,6 +105,29 @@ module DatapointValue UnionMember5Array = ContextDev::Internal::Type::ArrayOf[ContextDev::Internal::Type::Unknown] end end + + # @see ContextDev::Models::AIAIQueryResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/ai_extract_product_response.rb b/lib/context_dev/models/ai_extract_product_response.rb index 503e0e69..62fb20bc 100644 --- a/lib/context_dev/models/ai_extract_product_response.rb +++ b/lib/context_dev/models/ai_extract_product_response.rb @@ -10,6 +10,13 @@ class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel # @return [Boolean, nil] optional :is_product_page, ContextDev::Internal::Type::Boolean + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata } + # @!attribute platform # The detected ecommerce platform, or null if not a product page # @@ -22,13 +29,41 @@ class AIExtractProductResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::AIExtractProductResponse::Product, nil] optional :product, -> { ContextDev::Models::AIExtractProductResponse::Product }, nil?: true - # @!method initialize(is_product_page: nil, platform: nil, product: nil) + # @!method initialize(is_product_page: nil, key_metadata: nil, platform: nil, product: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::AIExtractProductResponse} for more details. + # # @param is_product_page [Boolean] Whether the given URL is a product detail page # + # @param key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page # # @param product [ContextDev::Models::AIExtractProductResponse::Product, nil] The extracted product data, or null if not a product page + # @see ContextDev::Models::AIExtractProductResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end + # The detected ecommerce platform, or null if not a product page # # @see ContextDev::Models::AIExtractProductResponse#platform diff --git a/lib/context_dev/models/ai_extract_products_response.rb b/lib/context_dev/models/ai_extract_products_response.rb index 47941dcb..69d207d9 100644 --- a/lib/context_dev/models/ai_extract_products_response.rb +++ b/lib/context_dev/models/ai_extract_products_response.rb @@ -4,6 +4,13 @@ module ContextDev module Models # @see ContextDev::Resources::AI#extract_products class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::AIExtractProductsResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::AIExtractProductsResponse::KeyMetadata } + # @!attribute products # Array of products extracted from the website # @@ -11,9 +18,37 @@ class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel optional :products, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product] } - # @!method initialize(products: nil) + # @!method initialize(key_metadata: nil, products: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::AIExtractProductsResponse} for more details. + # + # @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param products [Array] Array of products extracted from the website + # @see ContextDev::Models::AIExtractProductsResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end + class Product < ContextDev::Internal::Type::BaseModel # @!attribute description # Description of the product diff --git a/lib/context_dev/models/brand_identify_from_transaction_response.rb b/lib/context_dev/models/brand_identify_from_transaction_response.rb index d7edfd5f..8cca129b 100644 --- a/lib/context_dev/models/brand_identify_from_transaction_response.rb +++ b/lib/context_dev/models/brand_identify_from_transaction_response.rb @@ -16,17 +16,29 @@ class BrandIdentifyFromTransactionResponse < ContextDev::Internal::Type::BaseMod # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::BrandIdentifyFromTransactionResponse} for more details. + # # @param brand [ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see ContextDev::Models::BrandIdentifyFromTransactionResponse#brand @@ -1034,6 +1046,29 @@ class Stock < ContextDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see ContextDev::Models::BrandIdentifyFromTransactionResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/brand_retrieve_by_email_response.rb b/lib/context_dev/models/brand_retrieve_by_email_response.rb index 4a5f99f0..00181f2a 100644 --- a/lib/context_dev/models/brand_retrieve_by_email_response.rb +++ b/lib/context_dev/models/brand_retrieve_by_email_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByEmailResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::BrandRetrieveByEmailResponse} for more details. + # # @param brand [ContextDev::Models::BrandRetrieveByEmailResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see ContextDev::Models::BrandRetrieveByEmailResponse#brand @@ -1031,6 +1043,29 @@ class Stock < ContextDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see ContextDev::Models::BrandRetrieveByEmailResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/brand_retrieve_by_isin_response.rb b/lib/context_dev/models/brand_retrieve_by_isin_response.rb index 51c50d74..9838df5c 100644 --- a/lib/context_dev/models/brand_retrieve_by_isin_response.rb +++ b/lib/context_dev/models/brand_retrieve_by_isin_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByIsinResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::BrandRetrieveByIsinResponse} for more details. + # # @param brand [ContextDev::Models::BrandRetrieveByIsinResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see ContextDev::Models::BrandRetrieveByIsinResponse#brand @@ -1030,6 +1042,29 @@ class Stock < ContextDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see ContextDev::Models::BrandRetrieveByIsinResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/brand_retrieve_by_name_response.rb b/lib/context_dev/models/brand_retrieve_by_name_response.rb index 4f17b9b8..d9153858 100644 --- a/lib/context_dev/models/brand_retrieve_by_name_response.rb +++ b/lib/context_dev/models/brand_retrieve_by_name_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByNameResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::BrandRetrieveByNameResponse} for more details. + # # @param brand [ContextDev::Models::BrandRetrieveByNameResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see ContextDev::Models::BrandRetrieveByNameResponse#brand @@ -1030,6 +1042,29 @@ class Stock < ContextDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see ContextDev::Models::BrandRetrieveByNameResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/brand_retrieve_by_ticker_response.rb b/lib/context_dev/models/brand_retrieve_by_ticker_response.rb index afbfe4c0..f39b84c2 100644 --- a/lib/context_dev/models/brand_retrieve_by_ticker_response.rb +++ b/lib/context_dev/models/brand_retrieve_by_ticker_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveByTickerResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::BrandRetrieveByTickerResponse} for more details. + # # @param brand [ContextDev::Models::BrandRetrieveByTickerResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see ContextDev::Models::BrandRetrieveByTickerResponse#brand @@ -1032,6 +1044,29 @@ class Stock < ContextDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see ContextDev::Models::BrandRetrieveByTickerResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/brand_retrieve_response.rb b/lib/context_dev/models/brand_retrieve_response.rb index 06e2c1ae..d3e07497 100644 --- a/lib/context_dev/models/brand_retrieve_response.rb +++ b/lib/context_dev/models/brand_retrieve_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::BrandRetrieveResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::BrandRetrieveResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::BrandRetrieveResponse} for more details. + # # @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information # # @param code [Integer] HTTP status code # + # @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see ContextDev::Models::BrandRetrieveResponse#brand @@ -1030,6 +1042,29 @@ class Stock < ContextDev::Internal::Type::BaseModel # @param ticker [String] Stock ticker symbol end end + + # @see ContextDev::Models::BrandRetrieveResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/brand_retrieve_simplified_response.rb b/lib/context_dev/models/brand_retrieve_simplified_response.rb index 4ca76afc..afd7e0fc 100644 --- a/lib/context_dev/models/brand_retrieve_simplified_response.rb +++ b/lib/context_dev/models/brand_retrieve_simplified_response.rb @@ -16,17 +16,29 @@ class BrandRetrieveSimplifiedResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :code, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # # @return [String, nil] optional :status, String - # @!method initialize(brand: nil, code: nil, status: nil) + # @!method initialize(brand: nil, code: nil, key_metadata: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details. + # # @param brand [ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand] Simplified brand information # # @param code [Integer] HTTP status code of the response # + # @param key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#brand @@ -302,6 +314,29 @@ module Type end end end + + # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/industry_retrieve_naics_response.rb b/lib/context_dev/models/industry_retrieve_naics_response.rb index a41ac3a7..554b72ff 100644 --- a/lib/context_dev/models/industry_retrieve_naics_response.rb +++ b/lib/context_dev/models/industry_retrieve_naics_response.rb @@ -17,6 +17,13 @@ class IndustryRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # @@ -29,11 +36,16 @@ class IndustryRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :type, String - # @!method initialize(codes: nil, domain: nil, status: nil, type: nil) + # @!method initialize(codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::IndustryRetrieveNaicsResponse} for more details. + # # @param codes [Array] Array of NAICS codes and titles. # # @param domain [String] Domain found for the brand # + # @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # # @param type [String] Industry classification type, for naics api it will be `naics` @@ -78,6 +90,29 @@ module Confidence # @return [Array] end end + + # @see ContextDev::Models::IndustryRetrieveNaicsResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/industry_retrieve_sic_response.rb b/lib/context_dev/models/industry_retrieve_sic_response.rb index e7051bb4..8c23edfe 100644 --- a/lib/context_dev/models/industry_retrieve_sic_response.rb +++ b/lib/context_dev/models/industry_retrieve_sic_response.rb @@ -25,6 +25,13 @@ class IndustryRetrieveSicResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # @@ -37,7 +44,7 @@ class IndustryRetrieveSicResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :type, String - # @!method initialize(classification: nil, codes: nil, domain: nil, status: nil, type: nil) + # @!method initialize(classification: nil, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::IndustryRetrieveSicResponse} for more details. # @@ -47,6 +54,8 @@ class IndustryRetrieveSicResponse < ContextDev::Internal::Type::BaseModel # # @param domain [String] Domain found for the brand # + # @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # # @param type [String] Industry classification type, for sic api it will be `sic` @@ -134,6 +143,29 @@ module Confidence # @return [Array] end end + + # @see ContextDev::Models::IndustryRetrieveSicResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/utility_prefetch_by_email_response.rb b/lib/context_dev/models/utility_prefetch_by_email_response.rb index accc0694..419957e9 100644 --- a/lib/context_dev/models/utility_prefetch_by_email_response.rb +++ b/lib/context_dev/models/utility_prefetch_by_email_response.rb @@ -10,6 +10,13 @@ class UtilityPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata } + # @!attribute message # Success message # @@ -22,12 +29,40 @@ class UtilityPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :status, String - # @!method initialize(domain: nil, message: nil, status: nil) + # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::UtilityPrefetchByEmailResponse} for more details. + # # @param domain [String] The domain that was queued for prefetching # + # @param key_metadata [ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param message [String] Success message # # @param status [String] Status of the response, e.g., 'ok' + + # @see ContextDev::Models::UtilityPrefetchByEmailResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/utility_prefetch_response.rb b/lib/context_dev/models/utility_prefetch_response.rb index ec08d18a..92f6b5ae 100644 --- a/lib/context_dev/models/utility_prefetch_response.rb +++ b/lib/context_dev/models/utility_prefetch_response.rb @@ -10,6 +10,13 @@ class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::UtilityPrefetchResponse::KeyMetadata } + # @!attribute message # Success message # @@ -22,12 +29,40 @@ class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :status, String - # @!method initialize(domain: nil, message: nil, status: nil) + # @!method initialize(domain: nil, key_metadata: nil, message: nil, status: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::UtilityPrefetchResponse} for more details. + # # @param domain [String] The domain that was queued for prefetching # + # @param key_metadata [ContextDev::Models::UtilityPrefetchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param message [String] Success message # # @param status [String] Status of the response, e.g., 'ok' + + # @see ContextDev::Models::UtilityPrefetchResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_extract_competitors_response.rb b/lib/context_dev/models/web_extract_competitors_response.rb index 81a13003..3ae9c305 100644 --- a/lib/context_dev/models/web_extract_competitors_response.rb +++ b/lib/context_dev/models/web_extract_competitors_response.rb @@ -29,7 +29,17 @@ class WebExtractCompetitorsResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebExtractCompetitorsResponse::Target] required :target, -> { ContextDev::Models::WebExtractCompetitorsResponse::Target } - # @!method initialize(competitors:, domain:, status:, target:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata } + + # @!method initialize(competitors:, domain:, status:, target:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebExtractCompetitorsResponse} for more details. + # # @param competitors [Array] Direct competitors ordered by relevance and confidence. # # @param domain [String] Normalized input domain. @@ -37,6 +47,8 @@ class WebExtractCompetitorsResponse < ContextDev::Internal::Type::BaseModel # @param status [Symbol, ContextDev::Models::WebExtractCompetitorsResponse::Status] Status of the response. # # @param target [ContextDev::Models::WebExtractCompetitorsResponse::Target] Target company profile inferred from the landing page. + # + # @param key_metadata [ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when class Competitor < ContextDev::Internal::Type::BaseModel # @!attribute confidence @@ -152,6 +164,29 @@ class Target < ContextDev::Internal::Type::BaseModel # # @param website_url [String] Resolved URL used for the landing page analysis. end + + # @see ContextDev::Models::WebExtractCompetitorsResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_extract_fonts_response.rb b/lib/context_dev/models/web_extract_fonts_response.rb index 01465316..66a7bb8d 100644 --- a/lib/context_dev/models/web_extract_fonts_response.rb +++ b/lib/context_dev/models/web_extract_fonts_response.rb @@ -39,7 +39,14 @@ class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel -> { ContextDev::Internal::Type::HashOf[ContextDev::Models::WebExtractFontsResponse::FontLink] }, api_name: :fontLinks - # @!method initialize(code:, domain:, fonts:, status:, font_links: nil) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebExtractFontsResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebExtractFontsResponse::KeyMetadata } + + # @!method initialize(code:, domain:, fonts:, status:, font_links: nil, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebExtractFontsResponse} for more details. # @@ -52,6 +59,8 @@ class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel # @param status [String] Status of the response, e.g., 'ok' # # @param font_links [Hash{Symbol=>ContextDev::Models::WebExtractFontsResponse::FontLink}] Font assets keyed by family name as it appears in the fonts array (non-generic n + # + # @param key_metadata [ContextDev::Models::WebExtractFontsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when class Font < ContextDev::Internal::Type::BaseModel # @!attribute fallbacks @@ -163,6 +172,29 @@ module Type # @return [Array] end end + + # @see ContextDev::Models::WebExtractFontsResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_extract_params.rb b/lib/context_dev/models/web_extract_params.rb index 11a77f6c..02fbfa30 100644 --- a/lib/context_dev/models/web_extract_params.rb +++ b/lib/context_dev/models/web_extract_params.rb @@ -59,6 +59,19 @@ class WebExtractParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :max_age_ms, Integer, api_name: :maxAgeMs + # @!attribute max_depth + # Optional maximum link depth from the starting URL (0 = only the starting page). + # If omitted, there is no crawl depth limit. + # + # @return [Integer, nil] + optional :max_depth, Integer, api_name: :maxDepth + + # @!attribute max_pages + # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5. + # + # @return [Integer, nil] + optional :max_pages, Integer, api_name: :maxPages + # @!attribute pdf # # @return [ContextDev::Models::WebExtractParams::Pdf, nil] @@ -86,7 +99,7 @@ class WebExtractParams < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :wait_for_ms, Integer, api_name: :waitForMs - # @!method initialize(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @!method initialize(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebExtractParams} for more details. # @@ -104,6 +117,10 @@ class WebExtractParams < ContextDev::Internal::Type::BaseModel # # @param max_age_ms [Integer] Return cached scrape results if a prior scrape for the same parameters is younge # + # @param max_depth [Integer] Optional maximum link depth from the starting URL (0 = only the starting page). + # + # @param max_pages [Integer] Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5. + # # @param pdf [ContextDev::Models::WebExtractParams::Pdf] # # @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000 (1 diff --git a/lib/context_dev/models/web_extract_response.rb b/lib/context_dev/models/web_extract_response.rb index 93e1dfe5..015a083a 100644 --- a/lib/context_dev/models/web_extract_response.rb +++ b/lib/context_dev/models/web_extract_response.rb @@ -33,7 +33,17 @@ class WebExtractResponse < ContextDev::Internal::Type::BaseModel # @return [Array] required :urls_analyzed, ContextDev::Internal::Type::ArrayOf[String] - # @!method initialize(data:, metadata:, status:, url:, urls_analyzed:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebExtractResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebExtractResponse::KeyMetadata } + + # @!method initialize(data:, metadata:, status:, url:, urls_analyzed:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebExtractResponse} for more details. + # # @param data [Hash{Symbol=>Object}] Extracted data matching the request schema # # @param metadata [ContextDev::Models::WebExtractResponse::Metadata] @@ -43,6 +53,8 @@ class WebExtractResponse < ContextDev::Internal::Type::BaseModel # @param url [String] The starting URL that was analyzed # # @param urls_analyzed [Array] List of URLs whose Markdown was used for extraction + # + # @param key_metadata [ContextDev::Models::WebExtractResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # @see ContextDev::Models::WebExtractResponse#metadata class Metadata < ContextDev::Internal::Type::BaseModel @@ -78,6 +90,29 @@ class Metadata < ContextDev::Internal::Type::BaseModel # @param num_succeeded [Integer] # @param num_urls [Integer] end + + # @see ContextDev::Models::WebExtractResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_extract_styleguide_response.rb b/lib/context_dev/models/web_extract_styleguide_response.rb index 1752746b..edbcc801 100644 --- a/lib/context_dev/models/web_extract_styleguide_response.rb +++ b/lib/context_dev/models/web_extract_styleguide_response.rb @@ -16,6 +16,13 @@ class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel # @return [String, nil] optional :domain, String + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata } + # @!attribute status # Status of the response, e.g., 'ok' # @@ -28,15 +35,43 @@ class WebExtractStyleguideResponse < ContextDev::Internal::Type::BaseModel # @return [ContextDev::Models::WebExtractStyleguideResponse::Styleguide, nil] optional :styleguide, -> { ContextDev::Models::WebExtractStyleguideResponse::Styleguide } - # @!method initialize(code: nil, domain: nil, status: nil, styleguide: nil) + # @!method initialize(code: nil, domain: nil, key_metadata: nil, status: nil, styleguide: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebExtractStyleguideResponse} for more details. + # # @param code [Integer] HTTP status code # # @param domain [String] The normalized domain that was processed # + # @param key_metadata [ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param status [String] Status of the response, e.g., 'ok' # # @param styleguide [ContextDev::Models::WebExtractStyleguideResponse::Styleguide] Comprehensive styleguide data extracted from the website + # @see ContextDev::Models::WebExtractStyleguideResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end + # @see ContextDev::Models::WebExtractStyleguideResponse#styleguide class Styleguide < ContextDev::Internal::Type::BaseModel # @!attribute colors diff --git a/lib/context_dev/models/web_screenshot_response.rb b/lib/context_dev/models/web_screenshot_response.rb index d4f32197..d446463f 100644 --- a/lib/context_dev/models/web_screenshot_response.rb +++ b/lib/context_dev/models/web_screenshot_response.rb @@ -22,6 +22,13 @@ class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :height, Integer + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebScreenshotResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata } + # @!attribute screenshot # Public URL of the uploaded screenshot image # @@ -48,13 +55,18 @@ class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # @return [Integer, nil] optional :width, Integer - # @!method initialize(code: nil, domain: nil, height: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil) + # @!method initialize(code: nil, domain: nil, height: nil, key_metadata: nil, screenshot: nil, screenshot_type: nil, status: nil, width: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebScreenshotResponse} for more details. + # # @param code [Integer] HTTP status code # # @param domain [String] The normalized domain that was processed # # @param height [Integer] Height in pixels of the returned screenshot image # + # @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when + # # @param screenshot [String] Public URL of the uploaded screenshot image # # @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured @@ -63,6 +75,29 @@ class WebScreenshotResponse < ContextDev::Internal::Type::BaseModel # # @param width [Integer] Width in pixels of the returned screenshot image + # @see ContextDev::Models::WebScreenshotResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end + # Type of screenshot that was captured # # @see ContextDev::Models::WebScreenshotResponse#screenshot_type diff --git a/lib/context_dev/models/web_search_response.rb b/lib/context_dev/models/web_search_response.rb index f762a1d5..a69af7a9 100644 --- a/lib/context_dev/models/web_search_response.rb +++ b/lib/context_dev/models/web_search_response.rb @@ -16,10 +16,22 @@ class WebSearchResponse < ContextDev::Internal::Type::BaseModel required :results, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result] } - # @!method initialize(query:, results:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebSearchResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebSearchResponse::KeyMetadata } + + # @!method initialize(query:, results:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebSearchResponse} for more details. + # # @param query [String] Echo of the original query (useful when fanout was enabled). # # @param results [Array] + # + # @param key_metadata [ContextDev::Models::WebSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when class Result < ContextDev::Internal::Type::BaseModel # @!attribute description @@ -119,6 +131,29 @@ module Relevance # @return [Array] end end + + # @see ContextDev::Models::WebSearchResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_web_crawl_md_response.rb b/lib/context_dev/models/web_web_crawl_md_response.rb index 56d1bf8f..f4b2588c 100644 --- a/lib/context_dev/models/web_web_crawl_md_response.rb +++ b/lib/context_dev/models/web_web_crawl_md_response.rb @@ -15,9 +15,22 @@ class WebWebCrawlMdResponse < ContextDev::Internal::Type::BaseModel required :results, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result] } - # @!method initialize(metadata:, results:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata } + + # @!method initialize(metadata:, results:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebCrawlMdResponse} for more details. + # # @param metadata [ContextDev::Models::WebWebCrawlMdResponse::Metadata] + # # @param results [Array] + # + # @param key_metadata [ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # @see ContextDev::Models::WebWebCrawlMdResponse#metadata class Metadata < ContextDev::Internal::Type::BaseModel @@ -128,6 +141,29 @@ class Metadata < ContextDev::Internal::Type::BaseModel # @param url [String] The URL that was fetched end end + + # @see ContextDev::Models::WebWebCrawlMdResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_web_scrape_html_response.rb b/lib/context_dev/models/web_web_scrape_html_response.rb index 44bf79e8..9e854565 100644 --- a/lib/context_dev/models/web_web_scrape_html_response.rb +++ b/lib/context_dev/models/web_web_scrape_html_response.rb @@ -31,7 +31,14 @@ class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel # @return [String] required :url, String - # @!method initialize(html:, success:, type:, url:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata } + + # @!method initialize(html:, success:, type:, url:, key_metadata: nil) # Some parameter documentations has been truncated, see # {ContextDev::Models::WebWebScrapeHTMLResponse} for more details. # @@ -42,6 +49,8 @@ class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel # @param type [Symbol, ContextDev::Models::WebWebScrapeHTMLResponse::Type] Detected content type of the returned `html` field. Sitemaps and feeds are surfa # # @param url [String] The URL that was scraped + # + # @param key_metadata [ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # Indicates success # @@ -74,6 +83,29 @@ module Type # @!method self.values # @return [Array] end + + # @see ContextDev::Models::WebWebScrapeHTMLResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_web_scrape_images_response.rb b/lib/context_dev/models/web_web_scrape_images_response.rb index a732019c..3ec5e1b9 100644 --- a/lib/context_dev/models/web_web_scrape_images_response.rb +++ b/lib/context_dev/models/web_web_scrape_images_response.rb @@ -23,12 +23,24 @@ class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel # @return [String] required :url, String - # @!method initialize(images:, success:, url:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata } + + # @!method initialize(images:, success:, url:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeImagesResponse} for more details. + # # @param images [Array] Images found on the page. # # @param success [Boolean, ContextDev::Models::WebWebScrapeImagesResponse::Success] Always true on success. # # @param url [String] Page URL that was scraped. + # + # @param key_metadata [ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when class Image < ContextDev::Internal::Type::BaseModel # @!attribute alt @@ -183,6 +195,29 @@ module Success # @!method self.values # @return [Array] end + + # @see ContextDev::Models::WebWebScrapeImagesResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_web_scrape_md_response.rb b/lib/context_dev/models/web_web_scrape_md_response.rb index 27669f06..791958bc 100644 --- a/lib/context_dev/models/web_web_scrape_md_response.rb +++ b/lib/context_dev/models/web_web_scrape_md_response.rb @@ -22,12 +22,24 @@ class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel # @return [String] required :url, String - # @!method initialize(markdown:, success:, url:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata } + + # @!method initialize(markdown:, success:, url:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeMdResponse} for more details. + # # @param markdown [String] Page content converted to GitHub Flavored Markdown # # @param success [Boolean, ContextDev::Models::WebWebScrapeMdResponse::Success] Indicates success # # @param url [String] The URL that was scraped + # + # @param key_metadata [ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # Indicates success # @@ -40,6 +52,29 @@ module Success # @!method self.values # @return [Array] end + + # @see ContextDev::Models::WebWebScrapeMdResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/models/web_web_scrape_sitemap_response.rb b/lib/context_dev/models/web_web_scrape_sitemap_response.rb index ca75c043..463cd3a6 100644 --- a/lib/context_dev/models/web_web_scrape_sitemap_response.rb +++ b/lib/context_dev/models/web_web_scrape_sitemap_response.rb @@ -28,7 +28,17 @@ class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel # @return [Array] required :urls, ContextDev::Internal::Type::ArrayOf[String] - # @!method initialize(domain:, meta:, success:, urls:) + # @!attribute key_metadata + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @return [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, nil] + optional :key_metadata, -> { ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata } + + # @!method initialize(domain:, meta:, success:, urls:, key_metadata: nil) + # Some parameter documentations has been truncated, see + # {ContextDev::Models::WebWebScrapeSitemapResponse} for more details. + # # @param domain [String] The normalized domain that was crawled # # @param meta [ContextDev::Models::WebWebScrapeSitemapResponse::Meta] Metadata about the sitemap crawl operation @@ -36,6 +46,8 @@ class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel # @param success [Boolean, ContextDev::Models::WebWebScrapeSitemapResponse::Success] Indicates success # # @param urls [Array] Array of discovered page URLs from the sitemap (max 500) + # + # @param key_metadata [ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when # @see ContextDev::Models::WebWebScrapeSitemapResponse#meta class Meta < ContextDev::Internal::Type::BaseModel @@ -86,6 +98,29 @@ module Success # @!method self.values # @return [Array] end + + # @see ContextDev::Models::WebWebScrapeSitemapResponse#key_metadata + class KeyMetadata < ContextDev::Internal::Type::BaseModel + # @!attribute credits_consumed + # The number of credits consumed by this request. + # + # @return [Integer] + required :credits_consumed, Integer + + # @!attribute credits_remaining + # The number of credits remaining for your organization after this request. + # + # @return [Integer] + required :credits_remaining, Integer + + # @!method initialize(credits_consumed:, credits_remaining:) + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + # + # @param credits_consumed [Integer] The number of credits consumed by this request. + # + # @param credits_remaining [Integer] The number of credits remaining for your organization after this request. + end end end end diff --git a/lib/context_dev/resources/web.rb b/lib/context_dev/resources/web.rb index 1e6cd2dc..9da91464 100644 --- a/lib/context_dev/resources/web.rb +++ b/lib/context_dev/resources/web.rb @@ -9,7 +9,7 @@ class Web # Crawl a website, use the provided JSON Schema and instructions to prioritize # relevant internal links, and extract structured data from the selected pages. # - # @overload extract(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) + # @overload extract(schema:, url:, fact_check: nil, follow_subdomains: nil, include_frames: nil, instructions: nil, max_age_ms: nil, max_depth: nil, max_pages: nil, pdf: nil, stop_after_ms: nil, timeout_ms: nil, wait_for_ms: nil, request_options: {}) # # @param schema [Hash{Symbol=>Object}] JSON Schema for the returned data object. TypeScript Zod users can pass a JSON S # @@ -25,6 +25,10 @@ class Web # # @param max_age_ms [Integer] Return cached scrape results if a prior scrape for the same parameters is younge # + # @param max_depth [Integer] Optional maximum link depth from the starting URL (0 = only the starting page). + # + # @param max_pages [Integer] Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5. + # # @param pdf [ContextDev::Models::WebExtractParams::Pdf] # # @param stop_after_ms [Integer] Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000 (1 diff --git a/lib/context_dev/version.rb b/lib/context_dev/version.rb index 0286bf6c..867c4307 100644 --- a/lib/context_dev/version.rb +++ b/lib/context_dev/version.rb @@ -1,5 +1,5 @@ # frozen_string_literal: true module ContextDev - VERSION = "1.31.0" + VERSION = "1.32.0" end diff --git a/rbi/context_dev/models/ai_ai_query_response.rbi b/rbi/context_dev/models/ai_ai_query_response.rbi index 09a245f3..1072844c 100644 --- a/rbi/context_dev/models/ai_ai_query_response.rbi +++ b/rbi/context_dev/models/ai_ai_query_response.rbi @@ -38,6 +38,21 @@ module ContextDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns(T.nilable(ContextDev::Models::AIAIQueryResponse::KeyMetadata)) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::AIAIQueryResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -59,6 +74,8 @@ module ContextDev ContextDev::Models::AIAIQueryResponse::DataExtracted::OrHash ], domain: String, + key_metadata: + ContextDev::Models::AIAIQueryResponse::KeyMetadata::OrHash, status: String, urls_analyzed: T::Array[String] ).returns(T.attached_class) @@ -68,6 +85,9 @@ module ContextDev data_extracted: nil, # The domain that was analyzed domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil, # List of URLs that were analyzed @@ -81,6 +101,7 @@ module ContextDev data_extracted: T::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], domain: String, + key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata, status: String, urls_analyzed: T::Array[String] } @@ -200,6 +221,47 @@ module ContextDev ) end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::AIAIQueryResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/ai_extract_product_response.rbi b/rbi/context_dev/models/ai_extract_product_response.rbi index 5ce3fdb2..31365682 100644 --- a/rbi/context_dev/models/ai_extract_product_response.rbi +++ b/rbi/context_dev/models/ai_extract_product_response.rbi @@ -18,6 +18,23 @@ module ContextDev sig { params(is_product_page: T::Boolean).void } attr_writer :is_product_page + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::AIExtractProductResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # The detected ecommerce platform, or null if not a product page sig do returns( @@ -49,6 +66,8 @@ module ContextDev sig do params( is_product_page: T::Boolean, + key_metadata: + ContextDev::Models::AIExtractProductResponse::KeyMetadata::OrHash, platform: T.nilable( ContextDev::Models::AIExtractProductResponse::Platform::OrSymbol @@ -62,6 +81,9 @@ module ContextDev def self.new( # Whether the given URL is a product detail page is_product_page: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # The detected ecommerce platform, or null if not a product page platform: nil, # The extracted product data, or null if not a product page @@ -73,6 +95,8 @@ module ContextDev override.returns( { is_product_page: T::Boolean, + key_metadata: + ContextDev::Models::AIExtractProductResponse::KeyMetadata, platform: T.nilable( ContextDev::Models::AIExtractProductResponse::Platform::TaggedSymbol @@ -85,6 +109,47 @@ module ContextDev def to_hash end + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::AIExtractProductResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end + # The detected ecommerce platform, or null if not a product page module Platform extend ContextDev::Internal::Type::Enum diff --git a/rbi/context_dev/models/ai_extract_products_response.rbi b/rbi/context_dev/models/ai_extract_products_response.rbi index 7a284ef9..576d26ac 100644 --- a/rbi/context_dev/models/ai_extract_products_response.rbi +++ b/rbi/context_dev/models/ai_extract_products_response.rbi @@ -11,6 +11,23 @@ module ContextDev ) end + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::AIExtractProductsResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Array of products extracted from the website sig do returns( @@ -33,6 +50,8 @@ module ContextDev sig do params( + key_metadata: + ContextDev::Models::AIExtractProductsResponse::KeyMetadata::OrHash, products: T::Array[ ContextDev::Models::AIExtractProductsResponse::Product::OrHash @@ -40,6 +59,9 @@ module ContextDev ).returns(T.attached_class) end def self.new( + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Array of products extracted from the website products: nil ) @@ -48,6 +70,8 @@ module ContextDev sig do override.returns( { + key_metadata: + ContextDev::Models::AIExtractProductsResponse::KeyMetadata, products: T::Array[ContextDev::Models::AIExtractProductsResponse::Product] } @@ -56,6 +80,47 @@ module ContextDev def to_hash end + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::AIExtractProductsResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end + class Product < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/brand_identify_from_transaction_response.rbi b/rbi/context_dev/models/brand_identify_from_transaction_response.rbi index 8571cad4..d691769f 100644 --- a/rbi/context_dev/models/brand_identify_from_transaction_response.rbi +++ b/rbi/context_dev/models/brand_identify_from_transaction_response.rbi @@ -36,6 +36,25 @@ module ContextDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -48,6 +67,8 @@ module ContextDev brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand::OrHash, code: Integer, + key_metadata: + ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -56,6 +77,9 @@ module ContextDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -67,6 +91,8 @@ module ContextDev brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand, code: Integer, + key_metadata: + ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, status: String } ) @@ -3443,6 +3469,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/brand_retrieve_by_email_response.rbi b/rbi/context_dev/models/brand_retrieve_by_email_response.rbi index 221d9622..4038beb3 100644 --- a/rbi/context_dev/models/brand_retrieve_by_email_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_email_response.rbi @@ -33,6 +33,25 @@ module ContextDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -45,6 +64,8 @@ module ContextDev brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand::OrHash, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -53,6 +74,9 @@ module ContextDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -63,6 +87,8 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, status: String } ) @@ -3439,6 +3465,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi b/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi index 16276097..93f1941d 100644 --- a/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_isin_response.rbi @@ -33,6 +33,25 @@ module ContextDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -44,6 +63,8 @@ module ContextDev params( brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand::OrHash, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -52,6 +73,9 @@ module ContextDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -62,6 +86,8 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, status: String } ) @@ -3438,6 +3464,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/brand_retrieve_by_name_response.rbi b/rbi/context_dev/models/brand_retrieve_by_name_response.rbi index 087e12cc..39a006cf 100644 --- a/rbi/context_dev/models/brand_retrieve_by_name_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_name_response.rbi @@ -33,6 +33,25 @@ module ContextDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -44,6 +63,8 @@ module ContextDev params( brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand::OrHash, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -52,6 +73,9 @@ module ContextDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -62,6 +86,8 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata, status: String } ) @@ -3438,6 +3464,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi b/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi index 9886281d..8fa30c31 100644 --- a/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_by_ticker_response.rbi @@ -34,6 +34,25 @@ module ContextDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -46,6 +65,8 @@ module ContextDev brand: ContextDev::Models::BrandRetrieveByTickerResponse::Brand::OrHash, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -54,6 +75,9 @@ module ContextDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -64,6 +88,8 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByTickerResponse::Brand, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, status: String } ) @@ -3440,6 +3466,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/brand_retrieve_response.rbi b/rbi/context_dev/models/brand_retrieve_response.rbi index 794d9101..c44d0b76 100644 --- a/rbi/context_dev/models/brand_retrieve_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_response.rbi @@ -31,6 +31,23 @@ module ContextDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::BrandRetrieveResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -42,6 +59,8 @@ module ContextDev params( brand: ContextDev::Models::BrandRetrieveResponse::Brand::OrHash, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -50,6 +69,9 @@ module ContextDev brand: nil, # HTTP status code code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -60,6 +82,8 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveResponse::Brand, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveResponse::KeyMetadata, status: String } ) @@ -3422,6 +3446,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/brand_retrieve_simplified_response.rbi b/rbi/context_dev/models/brand_retrieve_simplified_response.rbi index af5f0e17..50fb35d5 100644 --- a/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +++ b/rbi/context_dev/models/brand_retrieve_simplified_response.rbi @@ -34,6 +34,25 @@ module ContextDev sig { params(code: Integer).void } attr_writer :code + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -46,6 +65,8 @@ module ContextDev brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand::OrHash, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata::OrHash, status: String ).returns(T.attached_class) end @@ -54,6 +75,9 @@ module ContextDev brand: nil, # HTTP status code of the response code: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil ) @@ -64,6 +88,8 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, + key_metadata: + ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, status: String } ) @@ -758,6 +784,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/industry_retrieve_naics_response.rbi b/rbi/context_dev/models/industry_retrieve_naics_response.rbi index 4434e141..94b41a3b 100644 --- a/rbi/context_dev/models/industry_retrieve_naics_response.rbi +++ b/rbi/context_dev/models/industry_retrieve_naics_response.rbi @@ -38,6 +38,25 @@ module ContextDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -59,6 +78,8 @@ module ContextDev ContextDev::Models::IndustryRetrieveNaicsResponse::Code::OrHash ], domain: String, + key_metadata: + ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata::OrHash, status: String, type: String ).returns(T.attached_class) @@ -68,6 +89,9 @@ module ContextDev codes: nil, # Domain found for the brand domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil, # Industry classification type, for naics api it will be `naics` @@ -81,6 +105,8 @@ module ContextDev codes: T::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], domain: String, + key_metadata: + ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, status: String, type: String } @@ -185,6 +211,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/industry_retrieve_sic_response.rbi b/rbi/context_dev/models/industry_retrieve_sic_response.rbi index 77f5cb43..e582907e 100644 --- a/rbi/context_dev/models/industry_retrieve_sic_response.rbi +++ b/rbi/context_dev/models/industry_retrieve_sic_response.rbi @@ -58,6 +58,25 @@ module ContextDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -81,6 +100,8 @@ module ContextDev ContextDev::Models::IndustryRetrieveSicResponse::Code::OrHash ], domain: String, + key_metadata: + ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata::OrHash, status: String, type: String ).returns(T.attached_class) @@ -94,6 +115,9 @@ module ContextDev codes: nil, # Domain found for the brand domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil, # Industry classification type, for sic api it will be `sic` @@ -109,6 +133,8 @@ module ContextDev codes: T::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code], domain: String, + key_metadata: + ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, status: String, type: String } @@ -287,6 +313,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/utility_prefetch_by_email_response.rbi b/rbi/context_dev/models/utility_prefetch_by_email_response.rbi index 6a962cfd..af541bc8 100644 --- a/rbi/context_dev/models/utility_prefetch_by_email_response.rbi +++ b/rbi/context_dev/models/utility_prefetch_by_email_response.rbi @@ -18,6 +18,25 @@ module ContextDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Success message sig { returns(T.nilable(String)) } attr_reader :message @@ -33,13 +52,20 @@ module ContextDev attr_writer :status sig do - params(domain: String, message: String, status: String).returns( - T.attached_class - ) + params( + domain: String, + key_metadata: + ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata::OrHash, + message: String, + status: String + ).returns(T.attached_class) end def self.new( # The domain that was queued for prefetching domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Success message message: nil, # Status of the response, e.g., 'ok' @@ -48,10 +74,59 @@ module ContextDev end sig do - override.returns({ domain: String, message: String, status: String }) + override.returns( + { + domain: String, + key_metadata: + ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, + message: String, + status: String + } + ) end def to_hash end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/utility_prefetch_response.rbi b/rbi/context_dev/models/utility_prefetch_response.rbi index e5589a5d..8d76fc0e 100644 --- a/rbi/context_dev/models/utility_prefetch_response.rbi +++ b/rbi/context_dev/models/utility_prefetch_response.rbi @@ -18,6 +18,23 @@ module ContextDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::UtilityPrefetchResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::UtilityPrefetchResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Success message sig { returns(T.nilable(String)) } attr_reader :message @@ -33,13 +50,20 @@ module ContextDev attr_writer :status sig do - params(domain: String, message: String, status: String).returns( - T.attached_class - ) + params( + domain: String, + key_metadata: + ContextDev::Models::UtilityPrefetchResponse::KeyMetadata::OrHash, + message: String, + status: String + ).returns(T.attached_class) end def self.new( # The domain that was queued for prefetching domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Success message message: nil, # Status of the response, e.g., 'ok' @@ -48,10 +72,59 @@ module ContextDev end sig do - override.returns({ domain: String, message: String, status: String }) + override.returns( + { + domain: String, + key_metadata: + ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, + message: String, + status: String + } + ) end def to_hash end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_extract_competitors_response.rbi b/rbi/context_dev/models/web_extract_competitors_response.rbi index 80837800..c2096d38 100644 --- a/rbi/context_dev/models/web_extract_competitors_response.rbi +++ b/rbi/context_dev/models/web_extract_competitors_response.rbi @@ -45,6 +45,25 @@ module ContextDev end attr_writer :target + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( competitors: @@ -55,7 +74,9 @@ module ContextDev status: ContextDev::Models::WebExtractCompetitorsResponse::Status::OrSymbol, target: - ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash + ContextDev::Models::WebExtractCompetitorsResponse::Target::OrHash, + key_metadata: + ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -66,7 +87,10 @@ module ContextDev # Status of the response. status:, # Target company profile inferred from the landing page. - target: + target:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -80,7 +104,9 @@ module ContextDev domain: String, status: ContextDev::Models::WebExtractCompetitorsResponse::Status::TaggedSymbol, - target: ContextDev::Models::WebExtractCompetitorsResponse::Target + target: ContextDev::Models::WebExtractCompetitorsResponse::Target, + key_metadata: + ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata } ) end @@ -292,6 +318,47 @@ module ContextDev def to_hash end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_extract_fonts_response.rbi b/rbi/context_dev/models/web_extract_fonts_response.rbi index 6d8b0f9a..f733cb52 100644 --- a/rbi/context_dev/models/web_extract_fonts_response.rbi +++ b/rbi/context_dev/models/web_extract_fonts_response.rbi @@ -55,6 +55,23 @@ module ContextDev end attr_writer :font_links + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::WebExtractFontsResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebExtractFontsResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( code: Integer, @@ -66,7 +83,9 @@ module ContextDev T::Hash[ Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink::OrHash - ] + ], + key_metadata: + ContextDev::Models::WebExtractFontsResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -81,7 +100,10 @@ module ContextDev # Font assets keyed by family name as it appears in the fonts array (non-generic # names only). Clients match entries in fonts to pick a file URL from files. # Omitted when no families resolve to Google or custom @font-face URLs. - font_links: nil + font_links: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -96,7 +118,9 @@ module ContextDev T::Hash[ Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink - ] + ], + key_metadata: + ContextDev::Models::WebExtractFontsResponse::KeyMetadata } ) end @@ -296,6 +320,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractFontsResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_extract_params.rbi b/rbi/context_dev/models/web_extract_params.rbi index 1e099a31..eb0a6fc7 100644 --- a/rbi/context_dev/models/web_extract_params.rbi +++ b/rbi/context_dev/models/web_extract_params.rbi @@ -64,6 +64,21 @@ module ContextDev sig { params(max_age_ms: Integer).void } attr_writer :max_age_ms + # Optional maximum link depth from the starting URL (0 = only the starting page). + # If omitted, there is no crawl depth limit. + sig { returns(T.nilable(Integer)) } + attr_reader :max_depth + + sig { params(max_depth: Integer).void } + attr_writer :max_depth + + # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5. + sig { returns(T.nilable(Integer)) } + attr_reader :max_pages + + sig { params(max_pages: Integer).void } + attr_writer :max_pages + sig { returns(T.nilable(ContextDev::WebExtractParams::Pdf)) } attr_reader :pdf @@ -104,6 +119,8 @@ module ContextDev include_frames: T::Boolean, instructions: String, max_age_ms: Integer, + max_depth: Integer, + max_pages: Integer, pdf: ContextDev::WebExtractParams::Pdf::OrHash, stop_after_ms: Integer, timeout_ms: Integer, @@ -136,6 +153,11 @@ module ContextDev # Return cached scrape results if a prior scrape for the same parameters is # younger than this many milliseconds. Defaults to 7 days (604800000 ms). max_age_ms: nil, + # Optional maximum link depth from the starting URL (0 = only the starting page). + # If omitted, there is no crawl depth limit. + max_depth: nil, + # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5. + max_pages: nil, pdf: nil, # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000 # (110s). Default: 80000 (80s). @@ -161,6 +183,8 @@ module ContextDev include_frames: T::Boolean, instructions: String, max_age_ms: Integer, + max_depth: Integer, + max_pages: Integer, pdf: ContextDev::WebExtractParams::Pdf, stop_after_ms: Integer, timeout_ms: Integer, diff --git a/rbi/context_dev/models/web_extract_response.rbi b/rbi/context_dev/models/web_extract_response.rbi index 4b81ac9a..35e563d5 100644 --- a/rbi/context_dev/models/web_extract_response.rbi +++ b/rbi/context_dev/models/web_extract_response.rbi @@ -37,13 +37,30 @@ module ContextDev sig { returns(T::Array[String]) } attr_accessor :urls_analyzed + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns(T.nilable(ContextDev::Models::WebExtractResponse::KeyMetadata)) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( data: T::Hash[Symbol, T.anything], metadata: ContextDev::Models::WebExtractResponse::Metadata::OrHash, status: String, url: String, - urls_analyzed: T::Array[String] + urls_analyzed: T::Array[String], + key_metadata: + ContextDev::Models::WebExtractResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -55,7 +72,10 @@ module ContextDev # The starting URL that was analyzed url:, # List of URLs whose Markdown was used for extraction - urls_analyzed: + urls_analyzed:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -66,7 +86,8 @@ module ContextDev metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, url: String, - urls_analyzed: T::Array[String] + urls_analyzed: T::Array[String], + key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata } ) end @@ -129,6 +150,47 @@ module ContextDev def to_hash end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_extract_styleguide_response.rbi b/rbi/context_dev/models/web_extract_styleguide_response.rbi index 1ef1b2f3..864321d0 100644 --- a/rbi/context_dev/models/web_extract_styleguide_response.rbi +++ b/rbi/context_dev/models/web_extract_styleguide_response.rbi @@ -25,6 +25,25 @@ module ContextDev sig { params(domain: String).void } attr_writer :domain + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Status of the response, e.g., 'ok' sig { returns(T.nilable(String)) } attr_reader :status @@ -54,6 +73,8 @@ module ContextDev params( code: Integer, domain: String, + key_metadata: + ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata::OrHash, status: String, styleguide: ContextDev::Models::WebExtractStyleguideResponse::Styleguide::OrHash @@ -64,6 +85,9 @@ module ContextDev code: nil, # The normalized domain that was processed domain: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Status of the response, e.g., 'ok' status: nil, # Comprehensive styleguide data extracted from the website @@ -76,6 +100,8 @@ module ContextDev { code: Integer, domain: String, + key_metadata: + ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, status: String, styleguide: ContextDev::Models::WebExtractStyleguideResponse::Styleguide @@ -85,6 +111,47 @@ module ContextDev def to_hash end + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end + class Styleguide < ContextDev::Internal::Type::BaseModel OrHash = T.type_alias do diff --git a/rbi/context_dev/models/web_screenshot_response.rbi b/rbi/context_dev/models/web_screenshot_response.rbi index fb7dd0d5..443821b7 100644 --- a/rbi/context_dev/models/web_screenshot_response.rbi +++ b/rbi/context_dev/models/web_screenshot_response.rbi @@ -32,6 +32,23 @@ module ContextDev sig { params(height: Integer).void } attr_writer :height + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::WebScreenshotResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebScreenshotResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + # Public URL of the uploaded screenshot image sig { returns(T.nilable(String)) } attr_reader :screenshot @@ -76,6 +93,8 @@ module ContextDev code: Integer, domain: String, height: Integer, + key_metadata: + ContextDev::Models::WebScreenshotResponse::KeyMetadata::OrHash, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::ScreenshotType::OrSymbol, @@ -90,6 +109,9 @@ module ContextDev domain: nil, # Height in pixels of the returned screenshot image height: nil, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil, # Public URL of the uploaded screenshot image screenshot: nil, # Type of screenshot that was captured @@ -107,6 +129,8 @@ module ContextDev code: Integer, domain: String, height: Integer, + key_metadata: + ContextDev::Models::WebScreenshotResponse::KeyMetadata, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::ScreenshotType::TaggedSymbol, @@ -118,6 +142,47 @@ module ContextDev def to_hash end + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebScreenshotResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end + # Type of screenshot that was captured module ScreenshotType extend ContextDev::Internal::Type::Enum diff --git a/rbi/context_dev/models/web_search_response.rbi b/rbi/context_dev/models/web_search_response.rbi index 8a90fa77..1d3b0812 100644 --- a/rbi/context_dev/models/web_search_response.rbi +++ b/rbi/context_dev/models/web_search_response.rbi @@ -18,17 +18,37 @@ module ContextDev sig { returns(T::Array[ContextDev::Models::WebSearchResponse::Result]) } attr_accessor :results + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns(T.nilable(ContextDev::Models::WebSearchResponse::KeyMetadata)) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( query: String, results: - T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash] + T::Array[ContextDev::Models::WebSearchResponse::Result::OrHash], + key_metadata: + ContextDev::Models::WebSearchResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( # Echo of the original query (useful when fanout was enabled). query:, - results: + results:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -36,7 +56,8 @@ module ContextDev override.returns( { query: String, - results: T::Array[ContextDev::Models::WebSearchResponse::Result] + results: T::Array[ContextDev::Models::WebSearchResponse::Result], + key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata } ) end @@ -266,6 +287,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebSearchResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_web_crawl_md_response.rbi b/rbi/context_dev/models/web_web_crawl_md_response.rbi index a8768a61..7da2dff2 100644 --- a/rbi/context_dev/models/web_web_crawl_md_response.rbi +++ b/rbi/context_dev/models/web_web_crawl_md_response.rbi @@ -26,21 +26,48 @@ module ContextDev end attr_accessor :results + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata::OrHash, results: - T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash] + T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result::OrHash], + key_metadata: + ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata::OrHash ).returns(T.attached_class) end - def self.new(metadata:, results:) + def self.new( + metadata:, + results:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil + ) end sig do override.returns( { metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, - results: T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result] + results: + T::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], + key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata } ) end @@ -235,6 +262,47 @@ module ContextDev end end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_web_scrape_html_response.rbi b/rbi/context_dev/models/web_web_scrape_html_response.rbi index a7e04010..fa481113 100644 --- a/rbi/context_dev/models/web_web_scrape_html_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_html_response.rbi @@ -38,13 +38,32 @@ module ContextDev sig { returns(String) } attr_accessor :url + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( html: String, success: ContextDev::Models::WebWebScrapeHTMLResponse::Success::OrBoolean, type: ContextDev::Models::WebWebScrapeHTMLResponse::Type::OrSymbol, - url: String + url: String, + key_metadata: + ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -58,7 +77,10 @@ module ContextDev # surfaced as `xml`; ordinary pages are `html`. type:, # The URL that was scraped - url: + url:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -70,7 +92,9 @@ module ContextDev ContextDev::Models::WebWebScrapeHTMLResponse::Success::TaggedBoolean, type: ContextDev::Models::WebWebScrapeHTMLResponse::Type::TaggedSymbol, - url: String + url: String, + key_metadata: + ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata } ) end @@ -169,6 +193,47 @@ module ContextDev def self.values end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_web_scrape_images_response.rbi b/rbi/context_dev/models/web_web_scrape_images_response.rbi index 9a427ca6..4bec769e 100644 --- a/rbi/context_dev/models/web_web_scrape_images_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_images_response.rbi @@ -29,6 +29,23 @@ module ContextDev sig { returns(String) } attr_accessor :url + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( images: @@ -37,7 +54,9 @@ module ContextDev ], success: ContextDev::Models::WebWebScrapeImagesResponse::Success::OrBoolean, - url: String + url: String, + key_metadata: + ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -46,7 +65,10 @@ module ContextDev # Always true on success. success:, # Page URL that was scraped. - url: + url:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -57,7 +79,9 @@ module ContextDev T::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: ContextDev::Models::WebWebScrapeImagesResponse::Success::TaggedBoolean, - url: String + url: String, + key_metadata: + ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata } ) end @@ -459,6 +483,47 @@ module ContextDev def self.values end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_web_scrape_md_response.rbi b/rbi/context_dev/models/web_web_scrape_md_response.rbi index ab7326e9..7241472a 100644 --- a/rbi/context_dev/models/web_web_scrape_md_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_md_response.rbi @@ -27,12 +27,31 @@ module ContextDev sig { returns(String) } attr_accessor :url + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable(ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( markdown: String, success: ContextDev::Models::WebWebScrapeMdResponse::Success::OrBoolean, - url: String + url: String, + key_metadata: + ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -41,7 +60,10 @@ module ContextDev # Indicates success success:, # The URL that was scraped - url: + url:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -51,7 +73,9 @@ module ContextDev markdown: String, success: ContextDev::Models::WebWebScrapeMdResponse::Success::TaggedBoolean, - url: String + url: String, + key_metadata: + ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata } ) end @@ -87,6 +111,47 @@ module ContextDev def self.values end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi b/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi index 1bf73fff..8c897e05 100644 --- a/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +++ b/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi @@ -38,13 +38,34 @@ module ContextDev sig { returns(T::Array[String]) } attr_accessor :urls + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + returns( + T.nilable( + ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata + ) + ) + end + attr_reader :key_metadata + + sig do + params( + key_metadata: + ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash + ).void + end + attr_writer :key_metadata + sig do params( domain: String, meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta::OrHash, success: ContextDev::Models::WebWebScrapeSitemapResponse::Success::OrBoolean, - urls: T::Array[String] + urls: T::Array[String], + key_metadata: + ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata::OrHash ).returns(T.attached_class) end def self.new( @@ -55,7 +76,10 @@ module ContextDev # Indicates success success:, # Array of discovered page URLs from the sitemap (max 500) - urls: + urls:, + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + key_metadata: nil ) end @@ -66,7 +90,9 @@ module ContextDev meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, success: ContextDev::Models::WebWebScrapeSitemapResponse::Success::TaggedBoolean, - urls: T::Array[String] + urls: T::Array[String], + key_metadata: + ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata } ) end @@ -162,6 +188,47 @@ module ContextDev def self.values end end + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + OrHash = + T.type_alias do + T.any( + ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata, + ContextDev::Internal::AnyHash + ) + end + + # The number of credits consumed by this request. + sig { returns(Integer) } + attr_accessor :credits_consumed + + # The number of credits remaining for your organization after this request. + sig { returns(Integer) } + attr_accessor :credits_remaining + + # Metadata about the API key used for the request. Included in every response + # whenever a valid API key is provided, even when the response status is not 200. + sig do + params(credits_consumed: Integer, credits_remaining: Integer).returns( + T.attached_class + ) + end + def self.new( + # The number of credits consumed by this request. + credits_consumed:, + # The number of credits remaining for your organization after this request. + credits_remaining: + ) + end + + sig do + override.returns( + { credits_consumed: Integer, credits_remaining: Integer } + ) + end + def to_hash + end + end end end end diff --git a/rbi/context_dev/resources/web.rbi b/rbi/context_dev/resources/web.rbi index 934d592c..5faed177 100644 --- a/rbi/context_dev/resources/web.rbi +++ b/rbi/context_dev/resources/web.rbi @@ -14,6 +14,8 @@ module ContextDev include_frames: T::Boolean, instructions: String, max_age_ms: Integer, + max_depth: Integer, + max_pages: Integer, pdf: ContextDev::WebExtractParams::Pdf::OrHash, stop_after_ms: Integer, timeout_ms: Integer, @@ -46,6 +48,11 @@ module ContextDev # Return cached scrape results if a prior scrape for the same parameters is # younger than this many milliseconds. Defaults to 7 days (604800000 ms). max_age_ms: nil, + # Optional maximum link depth from the starting URL (0 = only the starting page). + # If omitted, there is no crawl depth limit. + max_depth: nil, + # Maximum number of pages to analyze for extraction. Hard cap: 50. Defaults to 5. + max_pages: nil, pdf: nil, # Soft time budget for the crawl in milliseconds. Min: 10000 (10s). Max: 110000 # (110s). Default: 80000 (80s). diff --git a/sig/context_dev/models/ai_ai_query_response.rbs b/sig/context_dev/models/ai_ai_query_response.rbs index 6e982cad..e542c589 100644 --- a/sig/context_dev/models/ai_ai_query_response.rbs +++ b/sig/context_dev/models/ai_ai_query_response.rbs @@ -4,6 +4,7 @@ module ContextDev { data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], domain: String, + key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata, status: String, urls_analyzed: ::Array[String] } @@ -19,6 +20,12 @@ module ContextDev def domain=: (String) -> String + attr_reader key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::AIAIQueryResponse::KeyMetadata + ) -> ContextDev::Models::AIAIQueryResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -30,6 +37,7 @@ module ContextDev def initialize: ( ?data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], ?domain: String, + ?key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata, ?status: String, ?urls_analyzed: ::Array[String] ) -> void @@ -37,6 +45,7 @@ module ContextDev def to_hash: -> { data_extracted: ::Array[ContextDev::Models::AIAIQueryResponse::DataExtracted], domain: String, + key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata, status: String, urls_analyzed: ::Array[String] } @@ -88,6 +97,25 @@ module ContextDev UnionMember5Array: ContextDev::Internal::Type::Converter end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/ai_extract_product_response.rbs b/sig/context_dev/models/ai_extract_product_response.rbs index 7a3aa66f..2853a464 100644 --- a/sig/context_dev/models/ai_extract_product_response.rbs +++ b/sig/context_dev/models/ai_extract_product_response.rbs @@ -3,6 +3,7 @@ module ContextDev type ai_extract_product_response = { is_product_page: bool, + key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata, platform: ContextDev::Models::AIExtractProductResponse::platform?, product: ContextDev::Models::AIExtractProductResponse::Product? } @@ -12,22 +13,49 @@ module ContextDev def is_product_page=: (bool) -> bool + attr_reader key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::AIExtractProductResponse::KeyMetadata + ) -> ContextDev::Models::AIExtractProductResponse::KeyMetadata + attr_accessor platform: ContextDev::Models::AIExtractProductResponse::platform? attr_accessor product: ContextDev::Models::AIExtractProductResponse::Product? def initialize: ( ?is_product_page: bool, + ?key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata, ?platform: ContextDev::Models::AIExtractProductResponse::platform?, ?product: ContextDev::Models::AIExtractProductResponse::Product? ) -> void def to_hash: -> { is_product_page: bool, + key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata, platform: ContextDev::Models::AIExtractProductResponse::platform?, product: ContextDev::Models::AIExtractProductResponse::Product? } + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end + type platform = :amazon | :tiktok_shop | :etsy | :generic module Platform diff --git a/sig/context_dev/models/ai_extract_products_response.rbs b/sig/context_dev/models/ai_extract_products_response.rbs index 2c09a1be..f2d0a529 100644 --- a/sig/context_dev/models/ai_extract_products_response.rbs +++ b/sig/context_dev/models/ai_extract_products_response.rbs @@ -2,10 +2,17 @@ module ContextDev module Models type ai_extract_products_response = { + key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata, products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] } class AIExtractProductsResponse < ContextDev::Internal::Type::BaseModel + attr_reader key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::AIExtractProductsResponse::KeyMetadata + ) -> ContextDev::Models::AIExtractProductsResponse::KeyMetadata + attr_reader products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product]? def products=: ( @@ -13,13 +20,34 @@ module ContextDev ) -> ::Array[ContextDev::Models::AIExtractProductsResponse::Product] def initialize: ( + ?key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata, ?products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] ) -> void def to_hash: -> { + key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata, products: ::Array[ContextDev::Models::AIExtractProductsResponse::Product] } + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end + type product = { description: String, diff --git a/sig/context_dev/models/brand_identify_from_transaction_response.rbs b/sig/context_dev/models/brand_identify_from_transaction_response.rbs index ddd13ec2..a029d3b4 100644 --- a/sig/context_dev/models/brand_identify_from_transaction_response.rbs +++ b/sig/context_dev/models/brand_identify_from_transaction_response.rbs @@ -4,6 +4,7 @@ module ContextDev { brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module ContextDev def code=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata + ) -> ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module ContextDev def initialize: ( ?brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand, ?code: Integer, + ?key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module ContextDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/brand_retrieve_by_email_response.rbs b/sig/context_dev/models/brand_retrieve_by_email_response.rbs index 1946f922..38b13880 100644 --- a/sig/context_dev/models/brand_retrieve_by_email_response.rbs +++ b/sig/context_dev/models/brand_retrieve_by_email_response.rbs @@ -4,6 +4,7 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module ContextDev def code=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata + ) -> ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module ContextDev def initialize: ( ?brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand, ?code: Integer, + ?key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module ContextDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/brand_retrieve_by_isin_response.rbs b/sig/context_dev/models/brand_retrieve_by_isin_response.rbs index b0e7261a..80fcde38 100644 --- a/sig/context_dev/models/brand_retrieve_by_isin_response.rbs +++ b/sig/context_dev/models/brand_retrieve_by_isin_response.rbs @@ -4,6 +4,7 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module ContextDev def code=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata + ) -> ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module ContextDev def initialize: ( ?brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand, ?code: Integer, + ?key_metadata: ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module ContextDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/brand_retrieve_by_name_response.rbs b/sig/context_dev/models/brand_retrieve_by_name_response.rbs index 892ceb18..434ec901 100644 --- a/sig/context_dev/models/brand_retrieve_by_name_response.rbs +++ b/sig/context_dev/models/brand_retrieve_by_name_response.rbs @@ -4,6 +4,7 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module ContextDev def code=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata + ) -> ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module ContextDev def initialize: ( ?brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand, ?code: Integer, + ?key_metadata: ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module ContextDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs b/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs index bce18fde..076fc007 100644 --- a/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs +++ b/sig/context_dev/models/brand_retrieve_by_ticker_response.rbs @@ -4,6 +4,7 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveByTickerResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module ContextDev def code=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata + ) -> ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module ContextDev def initialize: ( ?brand: ContextDev::Models::BrandRetrieveByTickerResponse::Brand, ?code: Integer, + ?key_metadata: ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: ContextDev::Models::BrandRetrieveByTickerResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module ContextDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/brand_retrieve_response.rbs b/sig/context_dev/models/brand_retrieve_response.rbs index 068a16a5..e39f975d 100644 --- a/sig/context_dev/models/brand_retrieve_response.rbs +++ b/sig/context_dev/models/brand_retrieve_response.rbs @@ -4,6 +4,7 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module ContextDev def code=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::BrandRetrieveResponse::KeyMetadata + ) -> ContextDev::Models::BrandRetrieveResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module ContextDev def initialize: ( ?brand: ContextDev::Models::BrandRetrieveResponse::Brand, ?code: Integer, + ?key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: ContextDev::Models::BrandRetrieveResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata, status: String } @@ -1408,6 +1417,25 @@ module ContextDev def to_hash: -> { exchange: String, ticker: String } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/brand_retrieve_simplified_response.rbs b/sig/context_dev/models/brand_retrieve_simplified_response.rbs index 366db608..b97af147 100644 --- a/sig/context_dev/models/brand_retrieve_simplified_response.rbs +++ b/sig/context_dev/models/brand_retrieve_simplified_response.rbs @@ -4,6 +4,7 @@ module ContextDev { brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, status: String } @@ -18,6 +19,12 @@ module ContextDev def code=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata + ) -> ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -25,12 +32,14 @@ module ContextDev def initialize: ( ?brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, ?code: Integer, + ?key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, ?status: String ) -> void def to_hash: -> { brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand, code: Integer, + key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, status: String } @@ -307,6 +316,25 @@ module ContextDev end end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/industry_retrieve_naics_response.rbs b/sig/context_dev/models/industry_retrieve_naics_response.rbs index 3cdc639d..7c7d0cc7 100644 --- a/sig/context_dev/models/industry_retrieve_naics_response.rbs +++ b/sig/context_dev/models/industry_retrieve_naics_response.rbs @@ -4,6 +4,7 @@ module ContextDev { codes: ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], domain: String, + key_metadata: ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, status: String, type: String } @@ -19,6 +20,12 @@ module ContextDev def domain=: (String) -> String + attr_reader key_metadata: ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata + ) -> ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -30,6 +37,7 @@ module ContextDev def initialize: ( ?codes: ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], ?domain: String, + ?key_metadata: ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, ?status: String, ?type: String ) -> void @@ -37,6 +45,7 @@ module ContextDev def to_hash: -> { codes: ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code], domain: String, + key_metadata: ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, status: String, type: String } @@ -79,6 +88,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::IndustryRetrieveNaicsResponse::Code::confidence] end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/industry_retrieve_sic_response.rbs b/sig/context_dev/models/industry_retrieve_sic_response.rbs index d1e6068e..2c885a89 100644 --- a/sig/context_dev/models/industry_retrieve_sic_response.rbs +++ b/sig/context_dev/models/industry_retrieve_sic_response.rbs @@ -5,6 +5,7 @@ module ContextDev classification: ContextDev::Models::IndustryRetrieveSicResponse::classification, codes: ::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code], domain: String, + key_metadata: ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, status: String, type: String } @@ -26,6 +27,12 @@ module ContextDev def domain=: (String) -> String + attr_reader key_metadata: ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata + ) -> ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -38,6 +45,7 @@ module ContextDev ?classification: ContextDev::Models::IndustryRetrieveSicResponse::classification, ?codes: ::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code], ?domain: String, + ?key_metadata: ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, ?status: String, ?type: String ) -> void @@ -46,6 +54,7 @@ module ContextDev classification: ContextDev::Models::IndustryRetrieveSicResponse::classification, codes: ::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code], domain: String, + key_metadata: ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, status: String, type: String } @@ -120,6 +129,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::IndustryRetrieveSicResponse::Code::confidence] end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/utility_prefetch_by_email_response.rbs b/sig/context_dev/models/utility_prefetch_by_email_response.rbs index 7ec243fe..8ac27871 100644 --- a/sig/context_dev/models/utility_prefetch_by_email_response.rbs +++ b/sig/context_dev/models/utility_prefetch_by_email_response.rbs @@ -1,13 +1,24 @@ module ContextDev module Models type utility_prefetch_by_email_response = - { domain: String, message: String, status: String } + { + domain: String, + key_metadata: ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, + message: String, + status: String + } class UtilityPrefetchByEmailResponse < ContextDev::Internal::Type::BaseModel attr_reader domain: String? def domain=: (String) -> String + attr_reader key_metadata: ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata + ) -> ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata + attr_reader message: String? def message=: (String) -> String @@ -18,11 +29,36 @@ module ContextDev def initialize: ( ?domain: String, + ?key_metadata: ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, ?message: String, ?status: String ) -> void - def to_hash: -> { domain: String, message: String, status: String } + def to_hash: -> { + domain: String, + key_metadata: ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata, + message: String, + status: String + } + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/utility_prefetch_response.rbs b/sig/context_dev/models/utility_prefetch_response.rbs index fe435ec4..9b030133 100644 --- a/sig/context_dev/models/utility_prefetch_response.rbs +++ b/sig/context_dev/models/utility_prefetch_response.rbs @@ -1,13 +1,24 @@ module ContextDev module Models type utility_prefetch_response = - { domain: String, message: String, status: String } + { + domain: String, + key_metadata: ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, + message: String, + status: String + } class UtilityPrefetchResponse < ContextDev::Internal::Type::BaseModel attr_reader domain: String? def domain=: (String) -> String + attr_reader key_metadata: ContextDev::Models::UtilityPrefetchResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::UtilityPrefetchResponse::KeyMetadata + ) -> ContextDev::Models::UtilityPrefetchResponse::KeyMetadata + attr_reader message: String? def message=: (String) -> String @@ -18,11 +29,36 @@ module ContextDev def initialize: ( ?domain: String, + ?key_metadata: ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, ?message: String, ?status: String ) -> void - def to_hash: -> { domain: String, message: String, status: String } + def to_hash: -> { + domain: String, + key_metadata: ContextDev::Models::UtilityPrefetchResponse::KeyMetadata, + message: String, + status: String + } + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_extract_competitors_response.rbs b/sig/context_dev/models/web_extract_competitors_response.rbs index 544d68a4..6110357d 100644 --- a/sig/context_dev/models/web_extract_competitors_response.rbs +++ b/sig/context_dev/models/web_extract_competitors_response.rbs @@ -5,7 +5,8 @@ module ContextDev competitors: ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor], domain: String, status: ContextDev::Models::WebExtractCompetitorsResponse::status, - target: ContextDev::Models::WebExtractCompetitorsResponse::Target + target: ContextDev::Models::WebExtractCompetitorsResponse::Target, + key_metadata: ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata } class WebExtractCompetitorsResponse < ContextDev::Internal::Type::BaseModel @@ -17,18 +18,26 @@ module ContextDev attr_accessor target: ContextDev::Models::WebExtractCompetitorsResponse::Target + attr_reader key_metadata: ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata + ) -> ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata + def initialize: ( competitors: ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor], domain: String, status: ContextDev::Models::WebExtractCompetitorsResponse::status, - target: ContextDev::Models::WebExtractCompetitorsResponse::Target + target: ContextDev::Models::WebExtractCompetitorsResponse::Target, + ?key_metadata: ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata ) -> void def to_hash: -> { competitors: ::Array[ContextDev::Models::WebExtractCompetitorsResponse::Competitor], domain: String, status: ContextDev::Models::WebExtractCompetitorsResponse::status, - target: ContextDev::Models::WebExtractCompetitorsResponse::Target + target: ContextDev::Models::WebExtractCompetitorsResponse::Target, + key_metadata: ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata } type competitor = @@ -125,6 +134,25 @@ module ContextDev website_url: String } end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_extract_fonts_response.rbs b/sig/context_dev/models/web_extract_fonts_response.rbs index 01ba26e1..4a2f6d96 100644 --- a/sig/context_dev/models/web_extract_fonts_response.rbs +++ b/sig/context_dev/models/web_extract_fonts_response.rbs @@ -6,7 +6,8 @@ module ContextDev domain: String, fonts: ::Array[ContextDev::Models::WebExtractFontsResponse::Font], status: String, - font_links: ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink] + font_links: ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink], + key_metadata: ContextDev::Models::WebExtractFontsResponse::KeyMetadata } class WebExtractFontsResponse < ContextDev::Internal::Type::BaseModel @@ -24,12 +25,19 @@ module ContextDev ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink] ) -> ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink] + attr_reader key_metadata: ContextDev::Models::WebExtractFontsResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebExtractFontsResponse::KeyMetadata + ) -> ContextDev::Models::WebExtractFontsResponse::KeyMetadata + def initialize: ( code: Integer, domain: String, fonts: ::Array[ContextDev::Models::WebExtractFontsResponse::Font], status: String, - ?font_links: ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink] + ?font_links: ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink], + ?key_metadata: ContextDev::Models::WebExtractFontsResponse::KeyMetadata ) -> void def to_hash: -> { @@ -37,7 +45,8 @@ module ContextDev domain: String, fonts: ::Array[ContextDev::Models::WebExtractFontsResponse::Font], status: String, - font_links: ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink] + font_links: ::Hash[Symbol, ContextDev::Models::WebExtractFontsResponse::FontLink], + key_metadata: ContextDev::Models::WebExtractFontsResponse::KeyMetadata } type font = @@ -133,6 +142,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebExtractFontsResponse::FontLink::type_] end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_extract_params.rbs b/sig/context_dev/models/web_extract_params.rbs index e8561d97..c185d714 100644 --- a/sig/context_dev/models/web_extract_params.rbs +++ b/sig/context_dev/models/web_extract_params.rbs @@ -9,6 +9,8 @@ module ContextDev include_frames: bool, instructions: String, max_age_ms: Integer, + max_depth: Integer, + max_pages: Integer, pdf: ContextDev::WebExtractParams::Pdf, stop_after_ms: Integer, timeout_ms: Integer, @@ -44,6 +46,14 @@ module ContextDev def max_age_ms=: (Integer) -> Integer + attr_reader max_depth: Integer? + + def max_depth=: (Integer) -> Integer + + attr_reader max_pages: Integer? + + def max_pages=: (Integer) -> Integer + attr_reader pdf: ContextDev::WebExtractParams::Pdf? def pdf=: ( @@ -70,6 +80,8 @@ module ContextDev ?include_frames: bool, ?instructions: String, ?max_age_ms: Integer, + ?max_depth: Integer, + ?max_pages: Integer, ?pdf: ContextDev::WebExtractParams::Pdf, ?stop_after_ms: Integer, ?timeout_ms: Integer, @@ -85,6 +97,8 @@ module ContextDev include_frames: bool, instructions: String, max_age_ms: Integer, + max_depth: Integer, + max_pages: Integer, pdf: ContextDev::WebExtractParams::Pdf, stop_after_ms: Integer, timeout_ms: Integer, diff --git a/sig/context_dev/models/web_extract_response.rbs b/sig/context_dev/models/web_extract_response.rbs index 34798d30..a847a4fc 100644 --- a/sig/context_dev/models/web_extract_response.rbs +++ b/sig/context_dev/models/web_extract_response.rbs @@ -6,7 +6,8 @@ module ContextDev metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, url: String, - urls_analyzed: ::Array[String] + urls_analyzed: ::Array[String], + key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata } class WebExtractResponse < ContextDev::Internal::Type::BaseModel @@ -20,12 +21,19 @@ module ContextDev attr_accessor urls_analyzed: ::Array[String] + attr_reader key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebExtractResponse::KeyMetadata + ) -> ContextDev::Models::WebExtractResponse::KeyMetadata + def initialize: ( data: ::Hash[Symbol, top], metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, url: String, - urls_analyzed: ::Array[String] + urls_analyzed: ::Array[String], + ?key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata ) -> void def to_hash: -> { @@ -33,7 +41,8 @@ module ContextDev metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, url: String, - urls_analyzed: ::Array[String] + urls_analyzed: ::Array[String], + key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata } type metadata = @@ -72,6 +81,25 @@ module ContextDev num_urls: Integer } end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_extract_styleguide_response.rbs b/sig/context_dev/models/web_extract_styleguide_response.rbs index c6283013..6d1ae003 100644 --- a/sig/context_dev/models/web_extract_styleguide_response.rbs +++ b/sig/context_dev/models/web_extract_styleguide_response.rbs @@ -4,6 +4,7 @@ module ContextDev { code: Integer, domain: String, + key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, status: String, styleguide: ContextDev::Models::WebExtractStyleguideResponse::Styleguide } @@ -17,6 +18,12 @@ module ContextDev def domain=: (String) -> String + attr_reader key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata + ) -> ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata + attr_reader status: String? def status=: (String) -> String @@ -30,6 +37,7 @@ module ContextDev def initialize: ( ?code: Integer, ?domain: String, + ?key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, ?status: String, ?styleguide: ContextDev::Models::WebExtractStyleguideResponse::Styleguide ) -> void @@ -37,10 +45,30 @@ module ContextDev def to_hash: -> { code: Integer, domain: String, + key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata, status: String, styleguide: ContextDev::Models::WebExtractStyleguideResponse::Styleguide } + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end + type styleguide = { colors: ContextDev::Models::WebExtractStyleguideResponse::Styleguide::Colors, diff --git a/sig/context_dev/models/web_screenshot_response.rbs b/sig/context_dev/models/web_screenshot_response.rbs index 754db149..0e1827e9 100644 --- a/sig/context_dev/models/web_screenshot_response.rbs +++ b/sig/context_dev/models/web_screenshot_response.rbs @@ -5,6 +5,7 @@ module ContextDev code: Integer, domain: String, height: Integer, + key_metadata: ContextDev::Models::WebScreenshotResponse::KeyMetadata, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, status: String, @@ -24,6 +25,12 @@ module ContextDev def height=: (Integer) -> Integer + attr_reader key_metadata: ContextDev::Models::WebScreenshotResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebScreenshotResponse::KeyMetadata + ) -> ContextDev::Models::WebScreenshotResponse::KeyMetadata + attr_reader screenshot: String? def screenshot=: (String) -> String @@ -46,6 +53,7 @@ module ContextDev ?code: Integer, ?domain: String, ?height: Integer, + ?key_metadata: ContextDev::Models::WebScreenshotResponse::KeyMetadata, ?screenshot: String, ?screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, ?status: String, @@ -56,12 +64,32 @@ module ContextDev code: Integer, domain: String, height: Integer, + key_metadata: ContextDev::Models::WebScreenshotResponse::KeyMetadata, screenshot: String, screenshot_type: ContextDev::Models::WebScreenshotResponse::screenshot_type, status: String, width: Integer } + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end + type screenshot_type = :viewport | :fullPage module ScreenshotType diff --git a/sig/context_dev/models/web_search_response.rbs b/sig/context_dev/models/web_search_response.rbs index d6d26e38..f2f5d958 100644 --- a/sig/context_dev/models/web_search_response.rbs +++ b/sig/context_dev/models/web_search_response.rbs @@ -3,7 +3,8 @@ module ContextDev type web_search_response = { query: String, - results: ::Array[ContextDev::Models::WebSearchResponse::Result] + results: ::Array[ContextDev::Models::WebSearchResponse::Result], + key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata } class WebSearchResponse < ContextDev::Internal::Type::BaseModel @@ -11,14 +12,22 @@ module ContextDev attr_accessor results: ::Array[ContextDev::Models::WebSearchResponse::Result] + attr_reader key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebSearchResponse::KeyMetadata + ) -> ContextDev::Models::WebSearchResponse::KeyMetadata + def initialize: ( query: String, - results: ::Array[ContextDev::Models::WebSearchResponse::Result] + results: ::Array[ContextDev::Models::WebSearchResponse::Result], + ?key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata ) -> void def to_hash: -> { query: String, - results: ::Array[ContextDev::Models::WebSearchResponse::Result] + results: ::Array[ContextDev::Models::WebSearchResponse::Result], + key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata } type result = @@ -110,6 +119,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebSearchResponse::Result::relevance] end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_web_crawl_md_response.rbs b/sig/context_dev/models/web_web_crawl_md_response.rbs index e689febc..2d94817c 100644 --- a/sig/context_dev/models/web_web_crawl_md_response.rbs +++ b/sig/context_dev/models/web_web_crawl_md_response.rbs @@ -3,7 +3,8 @@ module ContextDev type web_web_crawl_md_response = { metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, - results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result] + results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], + key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata } class WebWebCrawlMdResponse < ContextDev::Internal::Type::BaseModel @@ -11,14 +12,22 @@ module ContextDev attr_accessor results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result] + attr_reader key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata + ) -> ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata + def initialize: ( metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, - results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result] + results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], + ?key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata ) -> void def to_hash: -> { metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, - results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result] + results: ::Array[ContextDev::Models::WebWebCrawlMdResponse::Result], + key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata } type metadata = @@ -116,6 +125,25 @@ module ContextDev } end end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_web_scrape_html_response.rbs b/sig/context_dev/models/web_web_scrape_html_response.rbs index 25c1d8b4..3521fc30 100644 --- a/sig/context_dev/models/web_web_scrape_html_response.rbs +++ b/sig/context_dev/models/web_web_scrape_html_response.rbs @@ -5,7 +5,8 @@ module ContextDev html: String, success: ContextDev::Models::WebWebScrapeHTMLResponse::success, type: ContextDev::Models::WebWebScrapeHTMLResponse::type_, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata } class WebWebScrapeHTMLResponse < ContextDev::Internal::Type::BaseModel @@ -17,18 +18,26 @@ module ContextDev attr_accessor url: String + attr_reader key_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata + ) -> ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata + def initialize: ( html: String, success: ContextDev::Models::WebWebScrapeHTMLResponse::success, type: ContextDev::Models::WebWebScrapeHTMLResponse::type_, - url: String + url: String, + ?key_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata ) -> void def to_hash: -> { html: String, success: ContextDev::Models::WebWebScrapeHTMLResponse::success, type: ContextDev::Models::WebWebScrapeHTMLResponse::type_, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata } type success = true @@ -57,6 +66,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeHTMLResponse::type_] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_web_scrape_images_response.rbs b/sig/context_dev/models/web_web_scrape_images_response.rbs index d75c586d..fd5aa453 100644 --- a/sig/context_dev/models/web_web_scrape_images_response.rbs +++ b/sig/context_dev/models/web_web_scrape_images_response.rbs @@ -4,7 +4,8 @@ module ContextDev { images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: ContextDev::Models::WebWebScrapeImagesResponse::success, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata } class WebWebScrapeImagesResponse < ContextDev::Internal::Type::BaseModel @@ -14,16 +15,24 @@ module ContextDev attr_accessor url: String + attr_reader key_metadata: ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata + ) -> ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata + def initialize: ( images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: ContextDev::Models::WebWebScrapeImagesResponse::success, - url: String + url: String, + ?key_metadata: ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata ) -> void def to_hash: -> { images: ::Array[ContextDev::Models::WebWebScrapeImagesResponse::Image], success: ContextDev::Models::WebWebScrapeImagesResponse::success, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata } type image = @@ -189,6 +198,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeImagesResponse::success] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_web_scrape_md_response.rbs b/sig/context_dev/models/web_web_scrape_md_response.rbs index 3938531d..4957fe21 100644 --- a/sig/context_dev/models/web_web_scrape_md_response.rbs +++ b/sig/context_dev/models/web_web_scrape_md_response.rbs @@ -4,7 +4,8 @@ module ContextDev { markdown: String, success: ContextDev::Models::WebWebScrapeMdResponse::success, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata } class WebWebScrapeMdResponse < ContextDev::Internal::Type::BaseModel @@ -14,16 +15,24 @@ module ContextDev attr_accessor url: String + attr_reader key_metadata: ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata + ) -> ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata + def initialize: ( markdown: String, success: ContextDev::Models::WebWebScrapeMdResponse::success, - url: String + url: String, + ?key_metadata: ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata ) -> void def to_hash: -> { markdown: String, success: ContextDev::Models::WebWebScrapeMdResponse::success, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata } type success = true @@ -35,6 +44,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeMdResponse::success] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/models/web_web_scrape_sitemap_response.rbs b/sig/context_dev/models/web_web_scrape_sitemap_response.rbs index 7e25dd99..4ccecd51 100644 --- a/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +++ b/sig/context_dev/models/web_web_scrape_sitemap_response.rbs @@ -5,7 +5,8 @@ module ContextDev domain: String, meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, success: ContextDev::Models::WebWebScrapeSitemapResponse::success, - urls: ::Array[String] + urls: ::Array[String], + key_metadata: ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata } class WebWebScrapeSitemapResponse < ContextDev::Internal::Type::BaseModel @@ -17,18 +18,26 @@ module ContextDev attr_accessor urls: ::Array[String] + attr_reader key_metadata: ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata? + + def key_metadata=: ( + ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata + ) -> ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata + def initialize: ( domain: String, meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, success: ContextDev::Models::WebWebScrapeSitemapResponse::success, - urls: ::Array[String] + urls: ::Array[String], + ?key_metadata: ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata ) -> void def to_hash: -> { domain: String, meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, success: ContextDev::Models::WebWebScrapeSitemapResponse::success, - urls: ::Array[String] + urls: ::Array[String], + key_metadata: ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata } type meta = @@ -72,6 +81,25 @@ module ContextDev def self?.values: -> ::Array[ContextDev::Models::WebWebScrapeSitemapResponse::success] end + + type key_metadata = + { credits_consumed: Integer, credits_remaining: Integer } + + class KeyMetadata < ContextDev::Internal::Type::BaseModel + attr_accessor credits_consumed: Integer + + attr_accessor credits_remaining: Integer + + def initialize: ( + credits_consumed: Integer, + credits_remaining: Integer + ) -> void + + def to_hash: -> { + credits_consumed: Integer, + credits_remaining: Integer + } + end end end end diff --git a/sig/context_dev/resources/web.rbs b/sig/context_dev/resources/web.rbs index 87e43195..58cdb12a 100644 --- a/sig/context_dev/resources/web.rbs +++ b/sig/context_dev/resources/web.rbs @@ -9,6 +9,8 @@ module ContextDev ?include_frames: bool, ?instructions: String, ?max_age_ms: Integer, + ?max_depth: Integer, + ?max_pages: Integer, ?pdf: ContextDev::WebExtractParams::Pdf, ?stop_after_ms: Integer, ?timeout_ms: Integer, diff --git a/test/context_dev/resources/ai_test.rb b/test/context_dev/resources/ai_test.rb index 903f499a..419593b1 100644 --- a/test/context_dev/resources/ai_test.rb +++ b/test/context_dev/resources/ai_test.rb @@ -27,6 +27,7 @@ def test_ai_query_required_params response => { data_extracted: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIAIQueryResponse::DataExtracted]) | nil, domain: String | nil, + key_metadata: ContextDev::Models::AIAIQueryResponse::KeyMetadata | nil, status: String | nil, urls_analyzed: ^(ContextDev::Internal::Type::ArrayOf[String]) | nil } @@ -45,6 +46,7 @@ def test_extract_product_required_params assert_pattern do response => { is_product_page: ContextDev::Internal::Type::Boolean | nil, + key_metadata: ContextDev::Models::AIExtractProductResponse::KeyMetadata | nil, platform: ContextDev::Models::AIExtractProductResponse::Platform | nil, product: ContextDev::Models::AIExtractProductResponse::Product | nil } @@ -62,6 +64,7 @@ def test_extract_products_required_params assert_pattern do response => { + key_metadata: ContextDev::Models::AIExtractProductsResponse::KeyMetadata | nil, products: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::AIExtractProductsResponse::Product]) | nil } end diff --git a/test/context_dev/resources/brand_test.rb b/test/context_dev/resources/brand_test.rb index 7d164ccc..5a87c2c6 100644 --- a/test/context_dev/resources/brand_test.rb +++ b/test/context_dev/resources/brand_test.rb @@ -16,6 +16,7 @@ def test_retrieve_required_params response => { brand: ContextDev::Models::BrandRetrieveResponse::Brand | nil, code: Integer | nil, + key_metadata: ContextDev::Models::BrandRetrieveResponse::KeyMetadata | nil, status: String | nil } end @@ -34,6 +35,7 @@ def test_identify_from_transaction_required_params response => { brand: ContextDev::Models::BrandIdentifyFromTransactionResponse::Brand | nil, code: Integer | nil, + key_metadata: ContextDev::Models::BrandIdentifyFromTransactionResponse::KeyMetadata | nil, status: String | nil } end @@ -52,6 +54,7 @@ def test_retrieve_by_email_required_params response => { brand: ContextDev::Models::BrandRetrieveByEmailResponse::Brand | nil, code: Integer | nil, + key_metadata: ContextDev::Models::BrandRetrieveByEmailResponse::KeyMetadata | nil, status: String | nil } end @@ -70,6 +73,7 @@ def test_retrieve_by_isin_required_params response => { brand: ContextDev::Models::BrandRetrieveByIsinResponse::Brand | nil, code: Integer | nil, + key_metadata: ContextDev::Models::BrandRetrieveByIsinResponse::KeyMetadata | nil, status: String | nil } end @@ -88,6 +92,7 @@ def test_retrieve_by_name_required_params response => { brand: ContextDev::Models::BrandRetrieveByNameResponse::Brand | nil, code: Integer | nil, + key_metadata: ContextDev::Models::BrandRetrieveByNameResponse::KeyMetadata | nil, status: String | nil } end @@ -106,6 +111,7 @@ def test_retrieve_by_ticker_required_params response => { brand: ContextDev::Models::BrandRetrieveByTickerResponse::Brand | nil, code: Integer | nil, + key_metadata: ContextDev::Models::BrandRetrieveByTickerResponse::KeyMetadata | nil, status: String | nil } end @@ -124,6 +130,7 @@ def test_retrieve_simplified_required_params response => { brand: ContextDev::Models::BrandRetrieveSimplifiedResponse::Brand | nil, code: Integer | nil, + key_metadata: ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata | nil, status: String | nil } end diff --git a/test/context_dev/resources/industry_test.rb b/test/context_dev/resources/industry_test.rb index 7a7cb7dd..68c71272 100644 --- a/test/context_dev/resources/industry_test.rb +++ b/test/context_dev/resources/industry_test.rb @@ -16,6 +16,7 @@ def test_retrieve_naics_required_params response => { codes: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::IndustryRetrieveNaicsResponse::Code]) | nil, domain: String | nil, + key_metadata: ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata | nil, status: String | nil, type: String | nil } @@ -36,6 +37,7 @@ def test_retrieve_sic_required_params classification: ContextDev::Models::IndustryRetrieveSicResponse::Classification | nil, codes: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::IndustryRetrieveSicResponse::Code]) | nil, domain: String | nil, + key_metadata: ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata | nil, status: String | nil, type: String | nil } diff --git a/test/context_dev/resources/utility_test.rb b/test/context_dev/resources/utility_test.rb index 105ff620..895880c1 100644 --- a/test/context_dev/resources/utility_test.rb +++ b/test/context_dev/resources/utility_test.rb @@ -15,6 +15,7 @@ def test_prefetch_required_params assert_pattern do response => { domain: String | nil, + key_metadata: ContextDev::Models::UtilityPrefetchResponse::KeyMetadata | nil, message: String | nil, status: String | nil } @@ -33,6 +34,7 @@ def test_prefetch_by_email_required_params assert_pattern do response => { domain: String | nil, + key_metadata: ContextDev::Models::UtilityPrefetchByEmailResponse::KeyMetadata | nil, message: String | nil, status: String | nil } diff --git a/test/context_dev/resources/web_test.rb b/test/context_dev/resources/web_test.rb index 947dbbd8..00d46c41 100644 --- a/test/context_dev/resources/web_test.rb +++ b/test/context_dev/resources/web_test.rb @@ -22,7 +22,8 @@ def test_extract_required_params metadata: ContextDev::Models::WebExtractResponse::Metadata, status: String, url: String, - urls_analyzed: ^(ContextDev::Internal::Type::ArrayOf[String]) + urls_analyzed: ^(ContextDev::Internal::Type::ArrayOf[String]), + key_metadata: ContextDev::Models::WebExtractResponse::KeyMetadata | nil } end end @@ -41,7 +42,8 @@ def test_extract_competitors_required_params competitors: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractCompetitorsResponse::Competitor]), domain: String, status: ContextDev::Models::WebExtractCompetitorsResponse::Status, - target: ContextDev::Models::WebExtractCompetitorsResponse::Target + target: ContextDev::Models::WebExtractCompetitorsResponse::Target, + key_metadata: ContextDev::Models::WebExtractCompetitorsResponse::KeyMetadata | nil } end end @@ -61,7 +63,8 @@ def test_extract_fonts domain: String, fonts: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebExtractFontsResponse::Font]), status: String, - font_links: ^(ContextDev::Internal::Type::HashOf[ContextDev::Models::WebExtractFontsResponse::FontLink]) | nil + font_links: ^(ContextDev::Internal::Type::HashOf[ContextDev::Models::WebExtractFontsResponse::FontLink]) | nil, + key_metadata: ContextDev::Models::WebExtractFontsResponse::KeyMetadata | nil } end end @@ -79,6 +82,7 @@ def test_extract_styleguide response => { code: Integer | nil, domain: String | nil, + key_metadata: ContextDev::Models::WebExtractStyleguideResponse::KeyMetadata | nil, status: String | nil, styleguide: ContextDev::Models::WebExtractStyleguideResponse::Styleguide | nil } @@ -99,6 +103,7 @@ def test_screenshot code: Integer | nil, domain: String | nil, height: Integer | nil, + key_metadata: ContextDev::Models::WebScreenshotResponse::KeyMetadata | nil, screenshot: String | nil, screenshot_type: ContextDev::Models::WebScreenshotResponse::ScreenshotType | nil, status: String | nil, @@ -119,7 +124,8 @@ def test_search_required_params assert_pattern do response => { query: String, - results: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result]) + results: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebSearchResponse::Result]), + key_metadata: ContextDev::Models::WebSearchResponse::KeyMetadata | nil } end end @@ -136,7 +142,8 @@ def test_web_crawl_md_required_params assert_pattern do response => { metadata: ContextDev::Models::WebWebCrawlMdResponse::Metadata, - results: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result]) + results: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebCrawlMdResponse::Result]), + key_metadata: ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata | nil } end end @@ -155,7 +162,8 @@ def test_web_scrape_html_required_params html: String, success: ContextDev::Models::WebWebScrapeHTMLResponse::Success, type: ContextDev::Models::WebWebScrapeHTMLResponse::Type, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata | nil } end end @@ -173,7 +181,8 @@ def test_web_scrape_images_required_params response => { images: ^(ContextDev::Internal::Type::ArrayOf[ContextDev::Models::WebWebScrapeImagesResponse::Image]), success: ContextDev::Models::WebWebScrapeImagesResponse::Success, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeImagesResponse::KeyMetadata | nil } end end @@ -191,7 +200,8 @@ def test_web_scrape_md_required_params response => { markdown: String, success: ContextDev::Models::WebWebScrapeMdResponse::Success, - url: String + url: String, + key_metadata: ContextDev::Models::WebWebScrapeMdResponse::KeyMetadata | nil } end end @@ -210,7 +220,8 @@ def test_web_scrape_sitemap_required_params domain: String, meta: ContextDev::Models::WebWebScrapeSitemapResponse::Meta, success: ContextDev::Models::WebWebScrapeSitemapResponse::Success, - urls: ^(ContextDev::Internal::Type::ArrayOf[String]) + urls: ^(ContextDev::Internal::Type::ArrayOf[String]), + key_metadata: ContextDev::Models::WebWebScrapeSitemapResponse::KeyMetadata | nil } end end