context.dev 2.14.0 → 2.16.0

data/lib/context_dev/models/batch_submit_params.rb

@@ -19,8 +19,16 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
+      # @!attribute webhook
+      #   Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
+      #   preserves legacy delivery; retry: {} opts into durable retries.
+      #
+      #   @return [ContextDev::Models::BatchSubmitParams::Webhook, nil]
+      optional :webhook, -> { ContextDev::BatchSubmitParams::Webhook }
+
       # @!attribute webhook_url
-      #   URL notified when the batch finishes.
+      #   Legacy URL notified when the batch finishes. Preserves one best-effort attempt.
+      #   Cannot be combined with webhook.
       #
       #   @return [String, nil]
       optional :webhook_url, String, api_name: :webhookUrl
@@ -32,7 +40,7 @@ module ContextDev
       #   @return [String, nil]
       optional :idempotency_key, String
 
-      # @!method initialize(input:, tags: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
+      # @!method initialize(input:, tags: nil, webhook: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchSubmitParams} for more details.
       #
@@ -40,7 +48,9 @@ module ContextDev
       #
       #   @param tags [Array<String>] Tags stored on the batch. Filter the batch list by them later.
       #
-      #   @param webhook_url [String] URL notified when the batch finishes.
+      #   @param webhook [ContextDev::Models::BatchSubmitParams::Webhook] Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
+      #
+      #   @param webhook_url [String] Legacy URL notified when the batch finishes. Preserves one best-effort attempt.
       #
       #   @param idempotency_key [String] Any string unique to this submission. Retries with the same key return the origi
       #
@@ -2105,6 +2115,27 @@ module ContextDev
         # @!method self.variants
         #   @return [Array(ContextDev::Models::BatchSubmitParams::Input::Scrape, ContextDev::Models::BatchSubmitParams::Input::Crawl)]
       end
+
+      class Webhook < ContextDev::Internal::Type::BaseModel
+        # @!attribute url
+        #
+        #   @return [String]
+        required :url, String
+
+        # @!attribute retry_
+        #   Webhook retry settings. Use {} for the default schedule.
+        #
+        #   @return [ContextDev::Models::RetryConfig, nil]
+        optional :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
+
+        # @!method initialize(url:, retry_: nil)
+        #   Completion webhook settings. Cannot be combined with webhookUrl. Omitting retry
+        #   preserves legacy delivery; retry: {} opts into durable retries.
+        #
+        #   @param url [String]
+        #
+        #   @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
+      end
     end
   end
 end

data/lib/context_dev/models/batch_submit_response.rb

@@ -62,6 +62,13 @@ module ContextDev
       #   @return [Symbol, ContextDev::Models::BatchSubmitResponse::Mode]
       required :mode, enum: -> { ContextDev::Models::BatchSubmitResponse::Mode }
 
+      # @!attribute request_id
+      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   it when contacting support about a failed request.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute status
       #   Always `queued`. An accepted batch has not started yet.
       #
@@ -87,7 +94,7 @@ module ContextDev
       #   @return [String, nil]
       optional :webhook_secret, String
 
-      # @!method initialize(id:, cache_metadata:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, status:, tags:, key_metadata: nil, webhook_secret: nil)
+      # @!method initialize(id:, cache_metadata:, crawl:, created_at:, credits:, format_:, input:, invalid_urls:, mode:, request_id:, status:, tags:, key_metadata: nil, webhook_secret: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchSubmitResponse} for more details.
       #
@@ -109,6 +116,8 @@ module ContextDev
       #
       #   @param mode [Symbol, ContextDev::Models::BatchSubmitResponse::Mode] How pages will be selected.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param status [Symbol, ContextDev::Models::BatchSubmitResponse::Status] Always `queued`. An accepted batch has not started yet.
       #
       #   @param tags [Array<String>] Tags stored on the batch.
@@ -238,13 +247,13 @@ module ContextDev
       # @see ContextDev::Models::BatchSubmitResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @return [Integer]
         required :credits_remaining, Integer
@@ -252,9 +261,9 @@ module ContextDev
         # @!method initialize(credits_consumed:, credits_remaining:)
         #   API key usage for this request.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/brand_retrieve_response.rb

@@ -12,6 +12,13 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata }
 
+      # @!attribute request_id
+      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   it when contacting support about a failed request.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute brand
       #   Detailed brand information
       #
@@ -25,8 +32,7 @@ module ContextDev
       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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::BrandRetrieveResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BrandRetrieveResponse::KeyMetadata }
@@ -37,17 +43,19 @@ module ContextDev
       #   @return [String, nil]
       optional :status, String
 
-      # @!method initialize(cache_metadata:, brand: nil, code: nil, key_metadata: nil, status: nil)
+      # @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, status: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveResponse} for more details.
       #
       #   @param cache_metadata [ContextDev::Models::BrandRetrieveResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param 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 key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param status [String] Status of the response, e.g., 'ok'
 
@@ -1176,24 +1184,23 @@ module ContextDev
       # @see ContextDev::Models::BrandRetrieveResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/brand_retrieve_simplified_params.rb

@@ -23,9 +23,8 @@ module ContextDev
       optional :max_age_ms, Integer, nil?: true
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -52,7 +51,7 @@ module ContextDev
       #
       #   @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
       #

data/lib/context_dev/models/brand_retrieve_simplified_response.rb

@@ -12,6 +12,13 @@ module ContextDev
       #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata]
       required :cache_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata }
 
+      # @!attribute request_id
+      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   it when contacting support about a failed request.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute brand
       #   Simplified brand information
       #
@@ -25,8 +32,7 @@ module ContextDev
       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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata }
@@ -37,17 +43,19 @@ module ContextDev
       #   @return [String, nil]
       optional :status, String
 
-      # @!method initialize(cache_metadata:, brand: nil, code: nil, key_metadata: nil, status: nil)
+      # @!method initialize(cache_metadata:, request_id:, brand: nil, code: nil, key_metadata: nil, status: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandRetrieveSimplifiedResponse} for more details.
       #
       #   @param cache_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param 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 key_metadata [ContextDev::Models::BrandRetrieveSimplifiedResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param status [String] Status of the response, e.g., 'ok'
 
@@ -401,24 +409,23 @@ module ContextDev
       # @see ContextDev::Models::BrandRetrieveSimplifiedResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/brand_search_params.rb

@@ -30,9 +30,8 @@ module ContextDev
                -> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::BrandSearchParams::QueryBy] }
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -54,7 +53,7 @@ module ContextDev
       #
       #   @param query_by [Array<Symbol, ContextDev::Models::BrandSearchParams::QueryBy>] Fields to match the search term against, as a comma-separated list or repeated p
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param typo_tolerance [Integer] Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
       #

data/lib/context_dev/models/brand_search_response.rb

@@ -4,6 +4,13 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Brand#search
     class BrandSearchResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute request_id
+      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   it when contacting support about a failed request.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute results
       #   Up to 10 matching brands, name matches first, then domain matches, most popular
       #   first within each group. Empty when nothing matches.
@@ -13,19 +20,20 @@ module ContextDev
                -> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandSearchResponse::Result] }
 
       # @!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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::BrandSearchResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BrandSearchResponse::KeyMetadata }
 
-      # @!method initialize(results:, key_metadata: nil)
+      # @!method initialize(request_id:, results:, key_metadata: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BrandSearchResponse} for more details.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param results [Array<ContextDev::Models::BrandSearchResponse::Result>] Up to 10 matching brands, name matches first, then domain matches, most popular
       #
-      #   @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       class Result < ContextDev::Internal::Type::BaseModel
         # @!attribute domain
@@ -61,24 +69,23 @@ module ContextDev
       # @see ContextDev::Models::BrandSearchResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/industry_retrieve_naics_params.rb

@@ -29,9 +29,8 @@ module ContextDev
       optional :min_results, Integer
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -54,7 +53,7 @@ module ContextDev
       #
       #   @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/industry_retrieve_naics_response.rb

@@ -4,6 +4,13 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Industry#retrieve_naics
     class IndustryRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute request_id
+      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   it when contacting support about a failed request.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute codes
       #   Array of NAICS codes and titles.
       #
@@ -18,8 +25,7 @@ module ContextDev
       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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata }
@@ -36,15 +42,17 @@ module ContextDev
       #   @return [String, nil]
       optional :type, String
 
-      # @!method initialize(codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
+      # @!method initialize(request_id:, 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 request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param codes [Array<ContextDev::Models::IndustryRetrieveNaicsResponse::Code>] 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 key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
@@ -94,24 +102,23 @@ module ContextDev
       # @see ContextDev::Models::IndustryRetrieveNaicsResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end

data/lib/context_dev/models/industry_retrieve_sic_params.rb

@@ -28,9 +28,8 @@ module ContextDev
       optional :min_results, Integer
 
       # @!attribute tags
-      #   Optional comma-separated caller-defined tags for tracking this request. Tags are
-      #   recorded on the request's usage log and can be used to filter usage on the
-      #   dashboard usage page. Up to 20 tags, each 1-50 characters.
+      #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
+      #   characters.
       #
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -61,7 +60,7 @@ module ContextDev
       #
       #   @param min_results [Integer] Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
       #
-      #   @param tags [Array<String>] Optional comma-separated caller-defined tags for tracking this request. Tags are
+      #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
       #
       #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
       #

data/lib/context_dev/models/industry_retrieve_sic_response.rb

@@ -4,6 +4,13 @@ module ContextDev
   module Models
     # @see ContextDev::Resources::Industry#retrieve_sic
     class IndustryRetrieveSicResponse < ContextDev::Internal::Type::BaseModel
+      # @!attribute request_id
+      #   Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #   it when contacting support about a failed request.
+      #
+      #   @return [String]
+      required :request_id, String
+
       # @!attribute classification
       #   Echoes back which SIC dataset was used to classify the brand.
       #
@@ -26,8 +33,7 @@ module ContextDev
       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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata }
@@ -44,17 +50,19 @@ module ContextDev
       #   @return [String, nil]
       optional :type, String
 
-      # @!method initialize(classification: nil, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
+      # @!method initialize(request_id:, 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.
       #
+      #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+      #
       #   @param classification [Symbol, ContextDev::Models::IndustryRetrieveSicResponse::Classification] Echoes back which SIC dataset was used to classify the brand.
       #
       #   @param codes [Array<ContextDev::Models::IndustryRetrieveSicResponse::Code>] Array of SIC codes with confidence scores. Extra fields depend on the requested
       #
       #   @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 key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param status [String] Status of the response, e.g., 'ok'
       #
@@ -147,24 +155,23 @@ module ContextDev
       # @see ContextDev::Models::IndustryRetrieveSicResponse#key_metadata
       class KeyMetadata < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_consumed
-        #   The number of credits consumed by this request.
+        #   Credits used by this request.
         #
         #   @return [Integer]
         required :credits_consumed, Integer
 
         # @!attribute credits_remaining
-        #   The number of credits remaining for your organization after this request.
+        #   Credits remaining for your organization.
         #
         #   @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.
+        #   Credit usage, included whenever a valid API key is provided.
         #
-        #   @param credits_consumed [Integer] The number of credits consumed by this request.
+        #   @param credits_consumed [Integer] Credits used by this request.
         #
-        #   @param credits_remaining [Integer] The number of credits remaining for your organization after this request.
+        #   @param credits_remaining [Integer] Credits remaining for your organization.
       end
     end
   end