context.dev 2.21.0 → 2.22.0

data/lib/context_dev/models/webhooks/delivery.rb

@@ -59,7 +59,7 @@ module ContextDev
         required :retry_, -> { ContextDev::RetryConfig }, api_name: :retry
 
         # @!attribute retry_expires_at
-        #   Manual retry deadline, seven days after event creation.
+        #   Last time you can retry manually (7 days after the event).
         #
         #   @return [Time]
         required :retry_expires_at, Time
@@ -71,7 +71,8 @@ module ContextDev
         required :source, union: -> { ContextDev::Webhooks::Delivery::Source }
 
         # @!attribute status
-        #   Current delivery status.
+        #   `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        #   (source or its webhook was removed).
         #
         #   @return [Symbol, ContextDev::Models::Webhooks::Delivery::Status]
         required :status, enum: -> { ContextDev::Webhooks::Delivery::Status }
@@ -83,6 +84,9 @@ module ContextDev
         required :url, String
 
         # @!method initialize(id:, created_at:, delivered_at:, event:, event_id:, last_attempt:, last_error:, next_attempt_at:, retry_:, retry_expires_at:, source:, status:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::Delivery} for more details.
+        #
         #   @param id [String] Delivery ID.
         #
         #   @param created_at [Time] Event creation time.
@@ -101,11 +105,11 @@ module ContextDev
         #
         #   @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
         #
-        #   @param retry_expires_at [Time] Manual retry deadline, seven days after event creation.
+        #   @param retry_expires_at [Time] Last time you can retry manually (7 days after the event).
         #
         #   @param source [ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor] Batch or monitor run that produced the event.
         #
-        #   @param status [Symbol, ContextDev::Models::Webhooks::Delivery::Status] Current delivery status.
+        #   @param status [Symbol, ContextDev::Models::Webhooks::Delivery::Status] `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled` (sour
         #
         #   @param url [String] Webhook destination URL.
 
@@ -165,7 +169,7 @@ module ContextDev
             required :batch_id, String
 
             # @!attribute type
-            #   Delivery source.
+            #   Which deliveries to list: `batch` or `monitor`.
             #
             #   @return [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Batch::Type]
             required :type, enum: -> { ContextDev::Webhooks::Delivery::Source::Batch::Type }
@@ -173,9 +177,9 @@ module ContextDev
             # @!method initialize(batch_id:, type:)
             #   @param batch_id [String] Batch ID.
             #
-            #   @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Batch::Type] Delivery source.
+            #   @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Batch::Type] Which deliveries to list: `batch` or `monitor`.
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             #
             # @see ContextDev::Models::Webhooks::Delivery::Source::Batch#type
             module Type
@@ -202,7 +206,7 @@ module ContextDev
             required :run_id, String
 
             # @!attribute type
-            #   Delivery source.
+            #   Which deliveries to list: `batch` or `monitor`.
             #
             #   @return [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Monitor::Type]
             required :type, enum: -> { ContextDev::Webhooks::Delivery::Source::Monitor::Type }
@@ -212,9 +216,9 @@ module ContextDev
             #
             #   @param run_id [String] Monitor run ID.
             #
-            #   @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Monitor::Type] Delivery source.
+            #   @param type [Symbol, ContextDev::Models::Webhooks::Delivery::Source::Monitor::Type] Which deliveries to list: `batch` or `monitor`.
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             #
             # @see ContextDev::Models::Webhooks::Delivery::Source::Monitor#type
             module Type
@@ -231,7 +235,8 @@ module ContextDev
           #   @return [Array(ContextDev::Models::Webhooks::Delivery::Source::Batch, ContextDev::Models::Webhooks::Delivery::Source::Monitor)]
         end
 
-        # Current delivery status.
+        # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        # (source or its webhook was removed).
         #
         # @see ContextDev::Models::Webhooks::Delivery#status
         module Status

data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb

@@ -27,23 +27,19 @@ module ContextDev
         optional :limit, Integer
 
         # @!attribute tags
-        #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        #   characters.
+        #   Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         #
         #   @return [Array<String>, nil]
         optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
         # @!method initialize(delivery_id:, cursor: nil, limit: nil, tags: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::Webhooks::DeliveryListAttemptsParams} for more details.
-        #
         #   @param delivery_id [String] Delivery ID.
         #
         #   @param cursor [String] The next_cursor from the previous response.
         #
         #   @param limit [Integer] Number of attempts to return.
         #
-        #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+        #   @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         #
         #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb

@@ -24,14 +24,14 @@ module ContextDev
         required :next_cursor, String, nil?: true
 
         # @!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.
+        #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        #   support.
         #
         #   @return [String]
         required :request_id, String
 
         # @!attribute key_metadata
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata }
@@ -46,14 +46,14 @@ module ContextDev
         #
         #   @param next_cursor [String, nil] Next page cursor, or null on the last page.
         #
-        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
         #
-        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListAttemptsResponse::KeyMetadata] Credits this request used and your remaining balance.
 
         # @see ContextDev::Models::Webhooks::DeliveryListAttemptsResponse#key_metadata
         class KeyMetadata < ContextDev::Internal::Type::BaseModel
           # @!attribute credits_consumed
-          #   Credits used by this request.
+          #   Credits charged for this request.
           #
           #   @return [Integer]
           required :credits_consumed, Integer
@@ -65,9 +65,9 @@ module ContextDev
           required :credits_remaining, Integer
 
           # @!method initialize(credits_consumed:, credits_remaining:)
-          #   Credit usage, included whenever a valid API key is provided.
+          #   Credits this request used and your remaining balance.
           #
-          #   @param credits_consumed [Integer] Credits used by this request.
+          #   @param credits_consumed [Integer] Credits charged for this request.
           #
           #   @param credits_remaining [Integer] Credits remaining for your organization.
         end

data/lib/context_dev/models/webhooks/delivery_list_params.rb

@@ -64,7 +64,7 @@ module ContextDev
             optional :status, enum: -> { ContextDev::Webhooks::DeliveryListParams::Body::Batch::Status }
 
             # @!attribute tags
-            #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #   Labels for filtering usage in the dashboard.
             #
             #   @return [Array<String>, nil]
             optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -80,7 +80,7 @@ module ContextDev
             #
             #   @param status [Symbol, ContextDev::Models::Webhooks::DeliveryListParams::Body::Batch::Status] Filter by delivery status.
             #
-            #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #   @param tags [Array<String>] Labels for filtering usage in the dashboard.
             #
             #   @param type [Symbol, :batch] Delivery source.
 
@@ -146,7 +146,7 @@ module ContextDev
             optional :status, enum: -> { ContextDev::Webhooks::DeliveryListParams::Body::Monitor::Status }
 
             # @!attribute tags
-            #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #   Labels for filtering usage in the dashboard.
             #
             #   @return [Array<String>, nil]
             optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -164,7 +164,7 @@ module ContextDev
             #
             #   @param status [Symbol, ContextDev::Models::Webhooks::DeliveryListParams::Body::Monitor::Status] Filter by delivery status.
             #
-            #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+            #   @param tags [Array<String>] Labels for filtering usage in the dashboard.
             #
             #   @param type [Symbol, :monitor] Delivery source.
 

data/lib/context_dev/models/webhooks/delivery_list_response.rb

@@ -24,14 +24,14 @@ module ContextDev
         required :next_cursor, String, nil?: true
 
         # @!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.
+        #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        #   support.
         #
         #   @return [String]
         required :request_id, String
 
         # @!attribute key_metadata
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata }
@@ -46,14 +46,14 @@ module ContextDev
         #
         #   @param next_cursor [String, nil] Next page cursor, or null on the last page.
         #
-        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
         #
-        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryListResponse::KeyMetadata] Credits this request used and your remaining balance.
 
         # @see ContextDev::Models::Webhooks::DeliveryListResponse#key_metadata
         class KeyMetadata < ContextDev::Internal::Type::BaseModel
           # @!attribute credits_consumed
-          #   Credits used by this request.
+          #   Credits charged for this request.
           #
           #   @return [Integer]
           required :credits_consumed, Integer
@@ -65,9 +65,9 @@ module ContextDev
           required :credits_remaining, Integer
 
           # @!method initialize(credits_consumed:, credits_remaining:)
-          #   Credit usage, included whenever a valid API key is provided.
+          #   Credits this request used and your remaining balance.
           #
-          #   @param credits_consumed [Integer] Credits used by this request.
+          #   @param credits_consumed [Integer] Credits charged for this request.
           #
           #   @param credits_remaining [Integer] Credits remaining for your organization.
         end

data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb

@@ -15,19 +15,15 @@ module ContextDev
         required :delivery_id, String
 
         # @!attribute tags
-        #   Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
-        #   characters.
+        #   Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         #
         #   @return [Array<String>, nil]
         optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
         # @!method initialize(delivery_id:, tags: nil, request_options: {})
-        #   Some parameter documentations has been truncated, see
-        #   {ContextDev::Models::Webhooks::DeliveryRetrieveParams} for more details.
-        #
         #   @param delivery_id [String] Delivery ID.
         #
-        #   @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+        #   @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
         #
         #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
       end

data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb

@@ -6,14 +6,14 @@ module ContextDev
       # @see ContextDev::Resources::Webhooks::Deliveries#retrieve
       class DeliveryRetrieveResponse < ContextDev::Models::Webhooks::Delivery
         # @!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.
+        #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        #   support.
         #
         #   @return [String]
         required :request_id, String
 
         # @!attribute key_metadata
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata }
@@ -22,13 +22,13 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::Webhooks::DeliveryRetrieveResponse} for more details.
         #
-        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
         #
-        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetrieveResponse::KeyMetadata] Credits this request used and your remaining balance.
 
         class KeyMetadata < ContextDev::Internal::Type::BaseModel
           # @!attribute credits_consumed
-          #   Credits used by this request.
+          #   Credits charged for this request.
           #
           #   @return [Integer]
           required :credits_consumed, Integer
@@ -40,9 +40,9 @@ module ContextDev
           required :credits_remaining, Integer
 
           # @!method initialize(credits_consumed:, credits_remaining:)
-          #   Credit usage, included whenever a valid API key is provided.
+          #   Credits this request used and your remaining balance.
           #
-          #   @param credits_consumed [Integer] Credits used by this request.
+          #   @param credits_consumed [Integer] Credits charged for this request.
           #
           #   @param credits_remaining [Integer] Credits remaining for your organization.
         end

data/lib/context_dev/models/webhooks/delivery_retry_params.rb

@@ -15,13 +15,13 @@ module ContextDev
         required :delivery_id, String
 
         # @!attribute force
-        #   Resend a delivery that already succeeded.
+        #   Resend even if the delivery already succeeded. Defaults to false.
         #
         #   @return [Boolean, nil]
         optional :force, ContextDev::Internal::Type::Boolean
 
         # @!attribute tags
-        #   Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        #   Labels for filtering usage in the dashboard.
         #
         #   @return [Array<String>, nil]
         optional :tags, ContextDev::Internal::Type::ArrayOf[String]
@@ -35,9 +35,9 @@ module ContextDev
         # @!method initialize(delivery_id:, force: nil, tags: nil, idempotency_key: nil, request_options: {})
         #   @param delivery_id [String] Delivery ID.
         #
-        #   @param force [Boolean] Resend a delivery that already succeeded.
+        #   @param force [Boolean] Resend even if the delivery already succeeded. Defaults to false.
         #
-        #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
+        #   @param tags [Array<String>] Labels for filtering usage in the dashboard.
         #
         #   @param idempotency_key [String] Unique key to prevent duplicate retry requests.
         #

data/lib/context_dev/models/webhooks/delivery_retry_response.rb

@@ -12,14 +12,14 @@ module ContextDev
         required :id, String
 
         # @!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.
+        #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+        #   support.
         #
         #   @return [String]
         required :request_id, String
 
         # @!attribute key_metadata
-        #   Credit usage, included whenever a valid API key is provided.
+        #   Credits this request used and your remaining balance.
         #
         #   @return [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata, nil]
         optional :key_metadata, -> { ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata }
@@ -30,14 +30,14 @@ module ContextDev
         #
         #   @param id [String] Delivery ID.
         #
-        #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
+        #   @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
         #
-        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+        #   @param key_metadata [ContextDev::Models::Webhooks::DeliveryRetryResponse::KeyMetadata] Credits this request used and your remaining balance.
 
         # @see ContextDev::Models::Webhooks::DeliveryRetryResponse#key_metadata
         class KeyMetadata < ContextDev::Internal::Type::BaseModel
           # @!attribute credits_consumed
-          #   Credits used by this request.
+          #   Credits charged for this request.
           #
           #   @return [Integer]
           required :credits_consumed, Integer
@@ -49,9 +49,9 @@ module ContextDev
           required :credits_remaining, Integer
 
           # @!method initialize(credits_consumed:, credits_remaining:)
-          #   Credit usage, included whenever a valid API key is provided.
+          #   Credits this request used and your remaining balance.
           #
-          #   @param credits_consumed [Integer] Credits used by this request.
+          #   @param credits_consumed [Integer] Credits charged for this request.
           #
           #   @param credits_remaining [Integer] Credits remaining for your organization.
         end

data/lib/context_dev/models/webhooks/delivery_summary.rb

@@ -41,7 +41,7 @@ module ContextDev
         required :next_attempt_at, Time, nil?: true
 
         # @!attribute retry_expires_at
-        #   Manual retry deadline, seven days after event creation.
+        #   Last time you can retry manually (7 days after the event).
         #
         #   @return [Time]
         required :retry_expires_at, Time
@@ -53,7 +53,8 @@ module ContextDev
         required :source, union: -> { ContextDev::Webhooks::DeliverySummary::Source }
 
         # @!attribute status
-        #   Current delivery status.
+        #   `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        #   (source or its webhook was removed).
         #
         #   @return [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Status]
         required :status, enum: -> { ContextDev::Webhooks::DeliverySummary::Status }
@@ -65,6 +66,9 @@ module ContextDev
         required :url, String
 
         # @!method initialize(id:, created_at:, delivered_at:, event:, last_error:, next_attempt_at:, retry_expires_at:, source:, status:, url:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::Webhooks::DeliverySummary} for more details.
+        #
         #   @param id [String] Delivery ID.
         #
         #   @param created_at [Time] Event creation time.
@@ -77,11 +81,11 @@ module ContextDev
         #
         #   @param next_attempt_at [Time, nil] Next scheduled attempt, or null if none.
         #
-        #   @param retry_expires_at [Time] Manual retry deadline, seven days after event creation.
+        #   @param retry_expires_at [Time] Last time you can retry manually (7 days after the event).
         #
         #   @param source [ContextDev::Models::Webhooks::DeliverySummary::Source::Batch, ContextDev::Models::Webhooks::DeliverySummary::Source::Monitor] Batch or monitor run that produced the event.
         #
-        #   @param status [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Status] Current delivery status.
+        #   @param status [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Status] `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled` (sour
         #
         #   @param url [String] Webhook destination URL.
 
@@ -141,7 +145,7 @@ module ContextDev
             required :batch_id, String
 
             # @!attribute type
-            #   Delivery source.
+            #   Which deliveries to list: `batch` or `monitor`.
             #
             #   @return [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Source::Batch::Type]
             required :type, enum: -> { ContextDev::Webhooks::DeliverySummary::Source::Batch::Type }
@@ -149,9 +153,9 @@ module ContextDev
             # @!method initialize(batch_id:, type:)
             #   @param batch_id [String] Batch ID.
             #
-            #   @param type [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Source::Batch::Type] Delivery source.
+            #   @param type [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Source::Batch::Type] Which deliveries to list: `batch` or `monitor`.
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             #
             # @see ContextDev::Models::Webhooks::DeliverySummary::Source::Batch#type
             module Type
@@ -178,7 +182,7 @@ module ContextDev
             required :run_id, String
 
             # @!attribute type
-            #   Delivery source.
+            #   Which deliveries to list: `batch` or `monitor`.
             #
             #   @return [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Source::Monitor::Type]
             required :type, enum: -> { ContextDev::Webhooks::DeliverySummary::Source::Monitor::Type }
@@ -188,9 +192,9 @@ module ContextDev
             #
             #   @param run_id [String] Monitor run ID.
             #
-            #   @param type [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Source::Monitor::Type] Delivery source.
+            #   @param type [Symbol, ContextDev::Models::Webhooks::DeliverySummary::Source::Monitor::Type] Which deliveries to list: `batch` or `monitor`.
 
-            # Delivery source.
+            # Which deliveries to list: `batch` or `monitor`.
             #
             # @see ContextDev::Models::Webhooks::DeliverySummary::Source::Monitor#type
             module Type
@@ -207,7 +211,8 @@ module ContextDev
           #   @return [Array(ContextDev::Models::Webhooks::DeliverySummary::Source::Batch, ContextDev::Models::Webhooks::DeliverySummary::Source::Monitor)]
         end
 
-        # Current delivery status.
+        # `pending`, `delivering`, `retrying`, `delivered`, `failed`, or `cancelled`
+        # (source or its webhook was removed).
         #
         # @see ContextDev::Models::Webhooks::DeliverySummary#status
         module Status

data/lib/context_dev/resources/batch.rb

@@ -4,11 +4,12 @@ module ContextDev
   module Resources
     # Scrape many pages or crawl a site asynchronously.
     class Batch
-      # Check progress, and get download links once the batch finishes.
+      # Get batch progress and result download links. Result files are deleted 7 days
+      # after the batch finishes.
       #
       # @overload retrieve(batch_id, request_options: {})
       #
-      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      # @param batch_id [String] Batch ID.
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -27,8 +28,7 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BatchListParams} for more details.
       #
-      # List your batches from newest to oldest. Filter by status or continue with a
-      # cursor.
+      # List your batches, newest first, with optional filters.
       #
       # @overload list(cursor: nil, limit: nil, q: nil, search_type: nil, status: nil, tags: nil, request_options: {})
       #
@@ -61,12 +61,12 @@ module ContextDev
         )
       end
 
-      # Permanently delete a finished batch and its stored results. Active batches must
-      # settle first.
+      # Permanently delete a finished batch and its results. Its webhook deliveries can
+      # no longer be retried.
       #
       # @overload delete(batch_id, request_options: {})
       #
-      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      # @param batch_id [String] Batch ID.
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -82,12 +82,12 @@ module ContextDev
         )
       end
 
-      # Stop a batch from starting new pages. In-progress pages finish, and unused
-      # credits are refunded.
+      # Stop a batch from starting new pages. Pages already in progress finish before
+      # the batch becomes cancelled.
       #
       # @overload cancel(batch_id, request_options: {})
       #
-      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      # @param batch_id [String] Batch ID.
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -106,12 +106,12 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BatchGetResultsParams} for more details.
       #
-      # Page through a finished batch's results as JSON instead of downloading the
-      # NDJSON files.
+      # Page through a finished batch’s results as JSON. Results remain available for 7
+      # days.
       #
       # @overload get_results(batch_id, cursor: nil, limit: nil, request_options: {})
       #
-      # @param batch_id [String] ID of the batch to retrieve or cancel.
+      # @param batch_id [String] Batch ID.
       #
       # @param cursor [String] next_cursor from the previous page.
       #
@@ -137,7 +137,8 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BatchSubmitParams} for more details.
       #
-      # Scrape 25K URLs or crawl large websites asynchronously.
+      # Scrape up to 25,000 URLs, or crawl a site, asynchronously. Poll the batch ID or
+      # receive a webhook when it finishes.
       #
       # @overload submit(input:, tags: nil, webhook: nil, webhook_url: nil, idempotency_key: nil, request_options: {})
       #
@@ -145,11 +146,11 @@ module ContextDev
       #
       # @param tags [Array<String>] Body param: Tags stored on the batch. Filter the batch list by them later.
       #
-      # @param webhook [ContextDev::Models::BatchSubmitParams::Webhook] Body param: Completion webhook settings. Cannot be combined with webhookUrl. Omi
+      # @param webhook [ContextDev::Models::BatchSubmitParams::Webhook] Body param: Where to send the batch's final-status event. Omit `retry` for one a
       #
       # @param webhook_url [String] Body param: Legacy URL notified when the batch finishes. Preserves one best-effo
       #
-      # @param idempotency_key [String] Header param: Any string unique to this submission. Retries with the same key re
+      # @param idempotency_key [String] Header param: Unique key per submission. Retrying with the same key and body ret
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #

data/lib/context_dev/resources/brand.rb

@@ -3,15 +3,12 @@
 module ContextDev
   module Resources
     class Brand
-      # Retrieve logos, backdrops, colors, industry, description, and more. Provide
-      # exactly one lookup identifier in the request body: a domain, company name, email
-      # address, stock ticker, transaction descriptor, or direct URL. Note:
-      # `by_direct_url` fetches brand data only from the provided URL — not from the
-      # entire internet.
+      # Retrieve logos, colors, company details, and social links using one lookup
+      # identifier. A direct URL limits extraction to that page.
       #
       # @overload retrieve(body:, request_options: {})
       #
-      # @param body [ContextDev::Models::BrandRetrieveParams::Body::ByDomain, ContextDev::Models::BrandRetrieveParams::Body::ByName, ContextDev::Models::BrandRetrieveParams::Body::ByEmail, ContextDev::Models::BrandRetrieveParams::Body::ByTicker, ContextDev::Models::BrandRetrieveParams::Body::ByDirectURL, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction] Exactly one lookup type must be provided.
+      # @param body [ContextDev::Models::BrandRetrieveParams::Body::ByDomain, ContextDev::Models::BrandRetrieveParams::Body::ByName, ContextDev::Models::BrandRetrieveParams::Body::ByEmail, ContextDev::Models::BrandRetrieveParams::Body::ByTicker, ContextDev::Models::BrandRetrieveParams::Body::ByDirectURL, ContextDev::Models::BrandRetrieveParams::Body::ByTransaction] One lookup, chosen by `type`.
       #
       # @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
       #
@@ -32,7 +29,8 @@ module ContextDev
       # Some parameter documentations has been truncated, see
       # {ContextDev::Models::BrandSearchParams} for more details.
       #
-      # Search indexed brands by name or domain
+      # Find up to 10 brands by name or domain, ordered by popularity. Use the returned
+      # domain to retrieve a full brand profile.
       #
       # @overload search(query:, autocomplete: nil, query_by: nil, tags: nil, typo_tolerance: nil, request_options: {})
       #
@@ -42,7 +40,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>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
+      # @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
       #
       # @param typo_tolerance [Integer] Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
       #