context.dev 2.21.0 → 2.22.0

data/lib/context_dev/models/industry_retrieve_sic_response.rb

@@ -5,8 +5,8 @@ module ContextDev
     # @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.
+      #   Unique ID of this request, also in `X-Request-Id`. Include it when contacting
+      #   support.
       #
       #   @return [String]
       required :request_id, String
@@ -33,7 +33,7 @@ module ContextDev
       optional :domain, 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::IndustryRetrieveSicResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata }
@@ -46,7 +46,7 @@ module ContextDev
       optional :partial, ContextDev::Internal::Type::Boolean
 
       # @!attribute status
-      #   Status of the response, e.g., 'ok'
+      #   Always `ok` on success.
       #
       #   @return [String, nil]
       optional :status, String
@@ -61,7 +61,7 @@ module ContextDev
       #   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 request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
       #
       #   @param classification [Symbol, ContextDev::Models::IndustryRetrieveSicResponse::Classification] Echoes back which SIC dataset was used to classify the brand.
       #
@@ -69,11 +69,11 @@ module ContextDev
       #
       #   @param domain [String] Domain found for the brand
       #
-      #   @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
       #   @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
       #
-      #   @param status [String] Status of the response, e.g., 'ok'
+      #   @param status [String] Always `ok` on success.
       #
       #   @param type [String] Industry classification type, for sic api it will be `sic`
 
@@ -164,7 +164,7 @@ module ContextDev
       # @see ContextDev::Models::IndustryRetrieveSicResponse#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
@@ -176,9 +176,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/intake.rb

@@ -12,25 +12,19 @@ module ContextDev
       required :duplicates, Integer
 
       # @!attribute invalid
-      #   URLs from your list rejected as unusable; the same ones are itemised in
-      #   `invalid_urls` at submission. Null for a crawl — a crawl that resolves no usable
-      #   page is rejected outright with a 400 rather than accepted with an empty list.
+      #   Rejected input URLs; `null` for a crawl.
       #
       #   @return [Integer, nil]
       required :invalid, Integer, nil?: true
 
       # @!attribute reserved
-      #   Pages credits were reserved for. Everything else — progress, the refund, the
-      #   completion percentage — is measured against this.
+      #   Pages accepted; progress counts toward this total.
       #
       #   @return [Integer]
       required :reserved, Integer
 
       # @!attribute reserved_is_ceiling
-      #   Whether `reserved` is an upper bound the batch may finish under. True only for a
-      #   crawl that follows links, whose reachable page count is unknowable until it
-      #   runs. False for a scrape and for a sitemap crawl, where `reserved` is an exact
-      #   page count.
+      #   True when `reserved` is a crawl ceiling; false when it is an exact URL count.
       #
       #   @return [Boolean]
       required :reserved_is_ceiling, ContextDev::Internal::Type::Boolean
@@ -46,15 +40,15 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::Intake} for more details.
       #
-      #   What submission took in, and what it charged for.
+      #   What the submission accepted.
       #
       #   @param duplicates [Integer] URLs dropped before reserving because another entry resolved to the same page. N
       #
-      #   @param invalid [Integer, nil] URLs from your list rejected as unusable; the same ones are itemised in `invalid
+      #   @param invalid [Integer, nil] Rejected input URLs; `null` for a crawl.
       #
-      #   @param reserved [Integer] Pages credits were reserved for. Everything else — progress, the refund, the com
+      #   @param reserved [Integer] Pages accepted; progress counts toward this total.
       #
-      #   @param reserved_is_ceiling [Boolean] Whether `reserved` is an upper bound the batch may finish under. True only for a
+      #   @param reserved_is_ceiling [Boolean] True when `reserved` is a crawl ceiling; false when it is an exact URL count.
       #
       #   @param submitted [Integer, nil] URLs in the list you sent, before validation and de-duplication. Null for a craw
     end

data/lib/context_dev/models/log_list_response.rb

@@ -29,14 +29,14 @@ module ContextDev
       required :page, Integer
 
       # @!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::LogListResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::LogListResponse::KeyMetadata }
@@ -53,9 +53,9 @@ module ContextDev
       #
       #   @param page [Integer] Current page number.
       #
-      #   @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::LogListResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::LogListResponse::KeyMetadata] Credits this request used and your remaining balance.
 
       class Data < ContextDev::Internal::Type::BaseModel
         # @!attribute credits_used
@@ -83,7 +83,8 @@ module ContextDev
         required :latency_ms, Float
 
         # @!attribute method_
-        #   HTTP method.
+        #   HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement
+        #   entries.
         #
         #   @return [String]
         required :method_, String, api_name: :method
@@ -125,6 +126,9 @@ module ContextDev
         required :zdr, ContextDev::Internal::Type::Boolean
 
         # @!method initialize(credits_used:, error_code:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, zdr:)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::LogListResponse::Data} for more details.
+        #
         #   @param credits_used [Integer] Credits charged for this request.
         #
         #   @param error_code [String, nil] The `error_code` from the response, or null on success.
@@ -133,7 +137,7 @@ module ContextDev
         #
         #   @param latency_ms [Float] Server-side processing time in milliseconds.
         #
-        #   @param method_ [String] HTTP method.
+        #   @param method_ [String] HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement entries
         #
         #   @param path [String] Endpoint path as called.
         #
@@ -151,7 +155,7 @@ module ContextDev
       # @see ContextDev::Models::LogListResponse#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
@@ -163,9 +167,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/log_retrieve_response.rb

@@ -10,14 +10,14 @@ module ContextDev
       required :data, -> { ContextDev::Models::LogRetrieveResponse::Data }
 
       # @!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::LogRetrieveResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::KeyMetadata }
@@ -28,9 +28,9 @@ module ContextDev
       #
       #   @param data [ContextDev::Models::LogRetrieveResponse::Data]
       #
-      #   @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::LogRetrieveResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::LogRetrieveResponse::KeyMetadata] Credits this request used and your remaining balance.
 
       # @see ContextDev::Models::LogRetrieveResponse#data
       class Data < ContextDev::Internal::Type::BaseModel
@@ -65,7 +65,8 @@ module ContextDev
         required :latency_ms, Float
 
         # @!attribute method_
-        #   HTTP method.
+        #   HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement
+        #   entries.
         #
         #   @return [String]
         required :method_, String, api_name: :method
@@ -112,19 +113,16 @@ module ContextDev
         #   @return [Boolean]
         required :zdr, ContextDev::Internal::Type::Boolean
 
-        # @!attribute key_metadata
-        #   Credit usage, included whenever a valid API key is provided.
-        #
-        #   @return [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata, nil]
-        optional :key_metadata, -> { ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata }
-
         # @!attribute response
         #   The retained JSON response with credentials redacted, or null when unavailable.
         #
         #   @return [Object, nil]
         optional :response, ContextDev::Internal::Type::Unknown
 
-        # @!method initialize(credits_used:, error_code:, input:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, user_agent:, zdr:, key_metadata: nil, response: nil)
+        # @!method initialize(credits_used:, error_code:, input:, key_id:, latency_ms:, method_:, path:, request_id:, status_code:, tags:, timestamp:, user_agent:, zdr:, response: nil)
+        #   Some parameter documentations has been truncated, see
+        #   {ContextDev::Models::LogRetrieveResponse::Data} for more details.
+        #
         #   @param credits_used [Integer] Credits charged for this request.
         #
         #   @param error_code [String, nil] The `error_code` from the response, or null on success.
@@ -135,7 +133,7 @@ module ContextDev
         #
         #   @param latency_ms [Float] Server-side processing time in milliseconds.
         #
-        #   @param method_ [String] HTTP method.
+        #   @param method_ [String] HTTP method, or `MONITOR` / `BATCH` for monitor-run and batch-settlement entries
         #
         #   @param path [String] Endpoint path as called.
         #
@@ -151,8 +149,6 @@ module ContextDev
         #
         #   @param zdr [Boolean] Whether the request was made under zero data retention.
         #
-        #   @param key_metadata [ContextDev::Models::LogRetrieveResponse::Data::KeyMetadata] Credit usage, included whenever a valid API key is provided.
-        #
         #   @param response [Object] The retained JSON response with credentials redacted, or null when unavailable.
 
         # @see ContextDev::Models::LogRetrieveResponse::Data#input
@@ -176,34 +172,12 @@ module ContextDev
           #
           #   @param body [Object] Request body with credentials and uploaded content redacted.
         end
-
-        # @see ContextDev::Models::LogRetrieveResponse::Data#key_metadata
-        class KeyMetadata < ContextDev::Internal::Type::BaseModel
-          # @!attribute credits_consumed
-          #   Credits used by this request.
-          #
-          #   @return [Integer]
-          required :credits_consumed, Integer
-
-          # @!attribute credits_remaining
-          #   Credits remaining for your organization.
-          #
-          #   @return [Integer]
-          required :credits_remaining, Integer
-
-          # @!method initialize(credits_consumed:, credits_remaining:)
-          #   Credit usage, included whenever a valid API key is provided.
-          #
-          #   @param credits_consumed [Integer] Credits used by this request.
-          #
-          #   @param credits_remaining [Integer] Credits remaining for your organization.
-        end
       end
 
       # @see ContextDev::Models::LogRetrieveResponse#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
@@ -215,9 +189,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