context.dev 2.14.0 → 2.15.0

checksums.yaml

@@ -1,7 +1,7 @@
 ---
 SHA256:
-  metadata.gz: ad23a0354a5f9cc6d6ad23a499a78ebe67f48f5e8d45c2660c70f9f6582acf39
-  data.tar.gz: 5b20bcd0881f27b3d5033c7664233cc5638d78358979bbe5b2fd25ae1f7538fd
+  metadata.gz: 515f65691600e29045376881e888810e56f7df8cc0c1a65a9b5077f9c72c1258
+  data.tar.gz: 521f7a02b0d575c2bb3f624b73dbdd8ec3fcd892fd5f6115016e2f751e9ff470
 SHA512:
-  metadata.gz: 7ebed39d39da3add4c5177e25f778c2f1483799859ab776b9db4bb8f3f452059a5b109cee3a4df284d5c1a09abe9c5b777323673c481d9af5e2aebeebbf3b90e
-  data.tar.gz: 4e8e97e0881e10ea884b242681ac561cbf737dfca8b85340e3fda3718ae836b926d9ec4d7eb6d4ed5defa288b83ab432472b7af6dec8f33d59501345c9982179
+  metadata.gz: e1a0aad5bc3dc9521467690dc7c1d2cc8500a4fed431fed65c89fe9443807a97b8e9ce4badc89abd5918d9bbfd8f223306d26438cc579142bb2f0fde4d6a4492
+  data.tar.gz: b9e69f23af6eebf3b8da837b926b6622fa1977afa07b39dac78485e2cb1c798eb5362dca640f5bf9a7f177631ed739944f3ca2837e7e21eb54b316b78977bdef

data/CHANGELOG.md

@@ -1,5 +1,13 @@
 # Changelog
 
+## [2.15.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.14.0...v2.15.0) (2026-09-08)
+
+
+### Features
+
+* **webhooks:** add configurable retries and manual replay ([00388ec](https://github.com/context-dot-dev/context-ruby-sdk/commit/00388ec76d375d7466c9b0d85dfe983d2a369807))
+* **webhooks:** simplify delivery APIs ([fbd879e](https://github.com/context-dot-dev/context-ruby-sdk/commit/fbd879eaa0c0008cba1c3b19f1fe1accb53d8771))
+
 ## [2.14.0](https://github.com/context-dot-dev/context-ruby-sdk/compare/v2.13.0...v2.14.0) (2026-09-03)
 
 

data/README.md

@@ -17,7 +17,7 @@ To use this gem, install via Bundler by adding the following to your application
 <!-- x-release-please-start-version -->
 
 ```ruby
-gem "context.dev", "~> 2.14.0"
+gem "context.dev", "~> 2.15.0"
 ```
 
 <!-- x-release-please-end -->

data/lib/context_dev/client.rb

@@ -47,6 +47,9 @@ module ContextDev
     # @return [ContextDev::Resources::Batch]
     attr_reader :batch
 
+    # @return [ContextDev::Resources::Webhooks]
+    attr_reader :webhooks
+
     # @return [ContextDev::Resources::People]
     attr_reader :people
 
@@ -123,6 +126,7 @@ module ContextDev
       @utility = ContextDev::Resources::Utility.new(client: self)
       @monitors = ContextDev::Resources::Monitors.new(client: self)
       @batch = ContextDev::Resources::Batch.new(client: self)
+      @webhooks = ContextDev::Resources::Webhooks.new(client: self)
       @people = ContextDev::Resources::People.new(client: self)
       @news = ContextDev::Resources::News.new(client: self)
     end

data/lib/context_dev/models/ai_extract_product_response.rb

@@ -19,8 +19,7 @@ module ContextDev
       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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::AIExtractProductResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::AIExtractProductResponse::KeyMetadata }
@@ -45,7 +44,7 @@ module ContextDev
       #
       #   @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 key_metadata [ContextDev::Models::AIExtractProductResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param platform [Symbol, ContextDev::Models::AIExtractProductResponse::Platform, nil] The detected ecommerce platform, or null if not a product page
       #
@@ -97,24 +96,23 @@ module ContextDev
       # @see ContextDev::Models::AIExtractProductResponse#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
 
       # The detected ecommerce platform, or null if not a product page

data/lib/context_dev/models/ai_extract_products_response.rb

@@ -13,8 +13,7 @@ module ContextDev
       required :cache_metadata, -> { ContextDev::Models::AIExtractProductsResponse::CacheMetadata }
 
       # @!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::AIExtractProductsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::AIExtractProductsResponse::KeyMetadata }
@@ -32,7 +31,7 @@ module ContextDev
       #
       #   @param cache_metadata [ContextDev::Models::AIExtractProductsResponse::CacheMetadata] Cache outcome for this response. Composite responses are hits only when every ca
       #
-      #   @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::AIExtractProductsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param products [Array<ContextDev::Models::AIExtractProductsResponse::Product>] Array of products extracted from the website
 
@@ -82,24 +81,23 @@ module ContextDev
       # @see ContextDev::Models::AIExtractProductsResponse#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
 
       class Product < ContextDev::Internal::Type::BaseModel

data/lib/context_dev/models/batch_cancel_response.rb

@@ -218,13 +218,13 @@ module ContextDev
       # @see ContextDev::Models::BatchCancelResponse#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
@@ -232,9 +232,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/batch_delete_response.rb

@@ -17,43 +17,38 @@ module ContextDev
       optional :deleted, 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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::BatchDeleteResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchDeleteResponse::KeyMetadata }
 
       # @!method initialize(id: nil, deleted: nil, key_metadata: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::BatchDeleteResponse} for more details.
-      #
       #   @param id [String] ID of the deleted batch.
       #
       #   @param deleted [Boolean] Always true on success.
       #
-      #   @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::BatchDeleteResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
 
       # @see ContextDev::Models::BatchDeleteResponse#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/batch_get_results_response.rb

@@ -18,8 +18,7 @@ module ContextDev
       optional :has_more, 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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::BatchGetResultsResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchGetResultsResponse::KeyMetadata }
@@ -31,14 +30,11 @@ module ContextDev
       optional :next_cursor, String, nil?: true
 
       # @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::BatchGetResultsResponse} for more details.
-      #
       #   @param data [Array<ContextDev::Models::BatchGetResultsResponse::Data::Ok, ContextDev::Models::BatchGetResultsResponse::Data::Error>] Result records on this page.
       #
       #   @param has_more [Boolean] Whether another page is available.
       #
-      #   @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::BatchGetResultsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param next_cursor [String, nil] Cursor for the next page.
 
@@ -536,24 +532,23 @@ module ContextDev
       # @see ContextDev::Models::BatchGetResultsResponse#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/batch_list_response.rb

@@ -17,8 +17,7 @@ module ContextDev
       optional :has_more, 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.
+      #   Credit usage, included whenever a valid API key is provided.
       #
       #   @return [ContextDev::Models::BatchListResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchListResponse::KeyMetadata }
@@ -30,14 +29,11 @@ module ContextDev
       optional :next_cursor, String, nil?: true
 
       # @!method initialize(data: nil, has_more: nil, key_metadata: nil, next_cursor: nil)
-      #   Some parameter documentations has been truncated, see
-      #   {ContextDev::Models::BatchListResponse} for more details.
-      #
       #   @param data [Array<ContextDev::Models::BatchListResponse::Data>] Batches on this page.
       #
       #   @param has_more [Boolean] Whether another page is available.
       #
-      #   @param key_metadata [ContextDev::Models::BatchListResponse::KeyMetadata] Metadata about the API key used for the request. Included in every response when
+      #   @param key_metadata [ContextDev::Models::BatchListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
       #   @param next_cursor [String, nil] Cursor for the next page.
 
@@ -364,24 +360,23 @@ module ContextDev
       # @see ContextDev::Models::BatchListResponse#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/batch_retrieve_response.rb

@@ -99,7 +99,13 @@ module ContextDev
       #   @return [ContextDev::Models::BatchRetrieveResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::BatchRetrieveResponse::KeyMetadata }
 
-      # @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, results:, status:, tags:, timing:, key_metadata: nil)
+      # @!attribute webhook_delivery_id
+      #   Batch completion delivery ID, when available.
+      #
+      #   @return [String, nil]
+      optional :webhook_delivery_id, String
+
+      # @!method initialize(id:, crawl:, credits:, failure:, format_:, input:, invalid_urls:, mode:, page_errors:, progress:, results:, status:, tags:, timing:, key_metadata: nil, webhook_delivery_id: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::BatchRetrieveResponse} for more details.
       #
@@ -133,6 +139,8 @@ module ContextDev
       #   @param timing [ContextDev::Models::BatchRetrieveResponse::Timing]
       #
       #   @param key_metadata [ContextDev::Models::BatchRetrieveResponse::KeyMetadata] API key usage for this request.
+      #
+      #   @param webhook_delivery_id [String] Batch completion delivery ID, when available.
 
       # @see ContextDev::Models::BatchRetrieveResponse#credits
       class Credits < ContextDev::Internal::Type::BaseModel
@@ -359,13 +367,13 @@ module ContextDev
       # @see ContextDev::Models::BatchRetrieveResponse#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
@@ -373,9 +381,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/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

@@ -238,13 +238,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 +252,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

@@ -25,8 +25,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 }
@@ -47,7 +46,7 @@ module ContextDev
       #
       #   @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 +1175,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

@@ -25,8 +25,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 }
@@ -47,7 +46,7 @@ module ContextDev
       #
       #   @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 +400,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
       #