context.dev 2.21.0 → 2.22.0

data/lib/context_dev/models/news_search_params.rb

@@ -40,7 +40,7 @@ module ContextDev
       optional :sort_by, -> { ContextDev::NewsSearchParams::SortBy }, api_name: :sortBy
 
       # @!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]
@@ -59,7 +59,7 @@ module ContextDev
       #
       #   @param sort_by [ContextDev::Models::NewsSearchParams::SortBy] Result ordering. Defaults to newest.
       #
-      #   @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 request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -111,6 +111,7 @@ module ContextDev
             required :name, String
 
             # @!attribute type
+            #   Use `name` to identify the company by name.
             #
             #   @return [Symbol, :name]
             required :type, const: :name
@@ -120,7 +121,7 @@ module ContextDev
             #
             #   @param name [String] Company name.
             #
-            #   @param type [Symbol, :name]
+            #   @param type [Symbol, :name] Use `name` to identify the company by name.
           end
 
           class Domain < ContextDev::Internal::Type::BaseModel
@@ -131,6 +132,7 @@ module ContextDev
             required :domain, String
 
             # @!attribute type
+            #   Use `domain` to identify the company by website domain.
             #
             #   @return [Symbol, :domain]
             required :type, const: :domain
@@ -140,7 +142,7 @@ module ContextDev
             #
             #   @param domain [String] Company website domain, such as apple.com.
             #
-            #   @param type [Symbol, :domain]
+            #   @param type [Symbol, :domain] Use `domain` to identify the company by website domain.
           end
 
           class Ticker < ContextDev::Internal::Type::BaseModel
@@ -151,6 +153,7 @@ module ContextDev
             required :ticker, String
 
             # @!attribute type
+            #   Use `ticker` to identify a publicly traded company.
             #
             #   @return [Symbol, :ticker]
             required :type, const: :ticker
@@ -173,7 +176,7 @@ module ContextDev
             #
             #   @param exchange [Symbol, ContextDev::Models::NewsSearchParams::SearchBy::Entity::Ticker::Exchange] Stock exchange the ticker trades on, used to disambiguate tickers listed on mult
             #
-            #   @param type [Symbol, :ticker]
+            #   @param type [Symbol, :ticker] Use `ticker` to identify a publicly traded company.
 
             # Stock exchange the ticker trades on, used to disambiguate tickers listed on
             # multiple exchanges.
@@ -268,6 +271,7 @@ module ContextDev
             required :isin, String
 
             # @!attribute type
+            #   Use `isin` to identify the company by its securities identifier.
             #
             #   @return [Symbol, :isin]
             required :type, const: :isin
@@ -277,7 +281,7 @@ module ContextDev
             #
             #   @param isin [String] International Securities Identification Number.
             #
-            #   @param type [Symbol, :isin]
+            #   @param type [Symbol, :isin] Use `isin` to identify the company by its securities identifier.
           end
 
           # @!method self.variants

data/lib/context_dev/models/news_search_response.rb

@@ -30,14 +30,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::NewsSearchResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::NewsSearchResponse::KeyMetadata }
@@ -54,9 +54,9 @@ module ContextDev
       #
       #   @param next_cursor [String, nil] Pass as cursor in the next request to fetch the following page. Null when there
       #
-      #   @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::NewsSearchResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::NewsSearchResponse::KeyMetadata] Credits this request used and your remaining balance.
 
       class Data < ContextDev::Internal::Type::BaseModel
         # @!attribute id
@@ -268,7 +268,7 @@ module ContextDev
       # @see ContextDev::Models::NewsSearchResponse#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
@@ -280,9 +280,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/parse_handle_params.rb

@@ -38,11 +38,7 @@ module ContextDev
       optional :include_links, ContextDev::Internal::Type::Boolean
 
       # @!attribute ocr
-      #   When true for PDF inputs, OCR the selected pages that have no usable text layer
-      #   (scans), replacing each recovered page's text with the OCR result while pages
-      #   with a real text layer keep it. pdf.start/pdf.end limit the inclusive page
-      #   range. Billed at 1 credit per page OCR actually recovered, on top of the base
-      #   request cost. When false, no OCR runs.
+      #   Read text from images and scanned PDF pages. PDF page ranges still apply.
       #
       #   @return [Boolean, nil]
       optional :ocr, ContextDev::Internal::Type::Boolean
@@ -60,8 +56,7 @@ module ContextDev
       optional :shorten_base64_images, ContextDev::Internal::Type::Boolean
 
       # @!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]
@@ -73,11 +68,8 @@ module ContextDev
       optional :use_main_content_only, ContextDev::Internal::Type::Boolean
 
       # @!attribute zdr
-      #   Set to enabled to bypass shared caches and omit request and response content
-      #   from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      #   omitted. Requires zero data retention to be enabled for your organization
-      #   (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      #   Successful ZDR responses include X-Context-ZDR: true.
+      #   `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      #   your organization has ZDR.
       #
       #   @return [Symbol, ContextDev::Models::ParseHandleParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::ParseHandleParams::Zdr }
@@ -96,17 +88,17 @@ module ContextDev
       #
       #   @param include_links [Boolean] Preserve hyperlinks in Markdown output
       #
-      #   @param ocr [Boolean] When true for PDF inputs, OCR the selected pages that have no usable text layer
+      #   @param ocr [Boolean] Read text from images and scanned PDF pages. PDF page ranges still apply.
       #
       #   @param pdf [ContextDev::Models::ParseHandleParams::Pdf] PDF page-range options as a JSON object, e.g. {"start": 2, "end": 5}.
       #
       #   @param shorten_base64_images [Boolean] Shorten base64-encoded image data in the Markdown output
       #
-      #   @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 use_main_content_only [Boolean] Extract only the main content from HTML-like inputs
       #
-      #   @param zdr [Symbol, ContextDev::Models::ParseHandleParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #   @param zdr [Symbol, ContextDev::Models::ParseHandleParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -215,11 +207,8 @@ module ContextDev
         #   @param start [Integer] First 1-based PDF page to parse. When omitted, parsing starts at the first page.
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/lib/context_dev/models/parse_handle_response.rb

@@ -11,8 +11,8 @@ module ContextDev
       required :markdown, 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
@@ -30,7 +30,7 @@ module ContextDev
       required :type, enum: -> { ContextDev::Models::ParseHandleResponse::Type }
 
       # @!attribute key_metadata
-      #   Credit usage, included whenever a valid API key is provided.
+      #   Credits this request used and your remaining balance.
       #
       #   @return [ContextDev::Models::ParseHandleResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::ParseHandleResponse::KeyMetadata }
@@ -41,13 +41,13 @@ module ContextDev
       #
       #   @param markdown [String] Input bytes converted to GitHub Flavored Markdown
       #
-      #   @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 success [Boolean, ContextDev::Models::ParseHandleResponse::Success] Indicates success
       #
       #   @param type [Symbol, ContextDev::Models::ParseHandleResponse::Type] Detected content type used for parsing
       #
-      #   @param key_metadata [ContextDev::Models::ParseHandleResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::ParseHandleResponse::KeyMetadata] Credits this request used and your remaining balance.
 
       # Indicates success
       #
@@ -116,7 +116,7 @@ module ContextDev
       # @see ContextDev::Models::ParseHandleResponse#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
@@ -128,9 +128,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/person_enrich_params.rb

@@ -8,55 +8,59 @@ module ContextDev
       include ContextDev::Internal::Type::RequestParameters
 
       # @!attribute company
+      #   Company context to help identify the person. Provide a name or domain.
       #
       #   @return [ContextDev::Models::PersonEnrichParams::Company, nil]
       optional :company, -> { ContextDev::PersonEnrichParams::Company }
 
       # @!attribute education
+      #   Education history to help distinguish people with similar names.
       #
       #   @return [Array<ContextDev::Models::PersonEnrichParams::Education>, nil]
       optional :education, -> { ContextDev::Internal::Type::ArrayOf[ContextDev::PersonEnrichParams::Education] }
 
       # @!attribute email
+      #   Email address of the person to find.
       #
       #   @return [String, nil]
       optional :email, String
 
       # @!attribute location
+      #   Location context to help identify the person. Provide a city, region, or
+      #   country.
       #
       #   @return [ContextDev::Models::PersonEnrichParams::Location, nil]
       optional :location, -> { ContextDev::PersonEnrichParams::Location }
 
       # @!attribute name
+      #   Person name. Without an email or person-profile URL, provide both first and last
+      #   name plus company, education, or location.
       #
       #   @return [ContextDev::Models::PersonEnrichParams::Name, nil]
       optional :name, -> { ContextDev::PersonEnrichParams::Name }
 
       # @!attribute social_urls
+      #   Public profile URLs for the person. A person-profile URL can identify the person
+      #   without a name.
       #
       #   @return [Array<String>, nil]
       optional :social_urls, ContextDev::Internal::Type::ArrayOf[String]
 
       # @!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]
 
       # @!attribute timeout_opts
-      #   Optional request deadline and behavior on timeout. For GET requests, use
-      #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-      #   timeoutOpts object.
+      #   Request deadline and what to return when it passes.
       #
       #   @return [ContextDev::Models::PersonEnrichParams::TimeoutOpts, nil]
       optional :timeout_opts, -> { ContextDev::PersonEnrichParams::TimeoutOpts }, api_name: :timeoutOpts
 
       # @!attribute zdr
-      #   Set to enabled to bypass shared caches and omit request and response content
-      #   from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      #   omitted. Requires zero data retention to be enabled for your organization
-      #   (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      #   Successful ZDR responses include X-Context-ZDR: true.
+      #   `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      #   your organization has ZDR.
       #
       #   @return [Symbol, ContextDev::Models::PersonEnrichParams::Zdr, nil]
       optional :zdr, enum: -> { ContextDev::PersonEnrichParams::Zdr }
@@ -65,137 +69,166 @@ module ContextDev
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::PersonEnrichParams} for more details.
       #
-      #   @param company [ContextDev::Models::PersonEnrichParams::Company]
+      #   @param company [ContextDev::Models::PersonEnrichParams::Company] Company context to help identify the person. Provide a name or domain.
       #
-      #   @param education [Array<ContextDev::Models::PersonEnrichParams::Education>]
+      #   @param education [Array<ContextDev::Models::PersonEnrichParams::Education>] Education history to help distinguish people with similar names.
       #
-      #   @param email [String]
+      #   @param email [String] Email address of the person to find.
       #
-      #   @param location [ContextDev::Models::PersonEnrichParams::Location]
+      #   @param location [ContextDev::Models::PersonEnrichParams::Location] Location context to help identify the person. Provide a city, region, or country
       #
-      #   @param name [ContextDev::Models::PersonEnrichParams::Name]
+      #   @param name [ContextDev::Models::PersonEnrichParams::Name] Person name. Without an email or person-profile URL, provide both first and last
       #
-      #   @param social_urls [Array<String>]
+      #   @param social_urls [Array<String>] Public profile URLs for the person. A person-profile URL can identify the person
       #
-      #   @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 timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
+      #   @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Request deadline and what to return when it passes.
       #
-      #   @param zdr [Symbol, ContextDev::Models::PersonEnrichParams::Zdr] Set to enabled to bypass shared caches and omit request and response content fro
+      #   @param zdr [Symbol, ContextDev::Models::PersonEnrichParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
       class Company < ContextDev::Internal::Type::BaseModel
         # @!attribute domain
+        #   Website domain of a company associated with the person.
         #
         #   @return [String, nil]
         optional :domain, String
 
         # @!attribute name
+        #   Name of a company associated with the person.
         #
         #   @return [String, nil]
         optional :name, String
 
         # @!method initialize(domain: nil, name: nil)
-        #   @param domain [String]
-        #   @param name [String]
+        #   Company context to help identify the person. Provide a name or domain.
+        #
+        #   @param domain [String] Website domain of a company associated with the person.
+        #
+        #   @param name [String] Name of a company associated with the person.
       end
 
       class Education < ContextDev::Internal::Type::BaseModel
         # @!attribute degree
+        #   Degree or qualification earned.
         #
         #   @return [String, nil]
         optional :degree, String
 
         # @!attribute field_of_study
+        #   Subject or major studied.
         #
         #   @return [String, nil]
         optional :field_of_study, String
 
         # @!attribute graduation_year
+        #   Four-digit graduation year.
         #
         #   @return [Integer, nil]
         optional :graduation_year, Integer
 
         # @!attribute institution
+        #   School or university, identified by name or domain.
         #
         #   @return [ContextDev::Models::PersonEnrichParams::Education::Institution, nil]
         optional :institution, -> { ContextDev::PersonEnrichParams::Education::Institution }
 
         # @!method initialize(degree: nil, field_of_study: nil, graduation_year: nil, institution: nil)
-        #   @param degree [String]
-        #   @param field_of_study [String]
-        #   @param graduation_year [Integer]
-        #   @param institution [ContextDev::Models::PersonEnrichParams::Education::Institution]
+        #   @param degree [String] Degree or qualification earned.
+        #
+        #   @param field_of_study [String] Subject or major studied.
+        #
+        #   @param graduation_year [Integer] Four-digit graduation year.
+        #
+        #   @param institution [ContextDev::Models::PersonEnrichParams::Education::Institution] School or university, identified by name or domain.
 
         # @see ContextDev::Models::PersonEnrichParams::Education#institution
         class Institution < ContextDev::Internal::Type::BaseModel
           # @!attribute domain
+          #   Website domain of the school or university.
           #
           #   @return [String, nil]
           optional :domain, String
 
           # @!attribute name
+          #   Name of the school or university.
           #
           #   @return [String, nil]
           optional :name, String
 
           # @!method initialize(domain: nil, name: nil)
-          #   @param domain [String]
-          #   @param name [String]
+          #   School or university, identified by name or domain.
+          #
+          #   @param domain [String] Website domain of the school or university.
+          #
+          #   @param name [String] Name of the school or university.
         end
       end
 
       class Location < ContextDev::Internal::Type::BaseModel
         # @!attribute city
+        #   City associated with the person.
         #
         #   @return [String, nil]
         optional :city, String
 
         # @!attribute country
+        #   Country associated with the person.
         #
         #   @return [String, nil]
         optional :country, String
 
         # @!attribute region
+        #   State, province, or region associated with the person.
         #
         #   @return [String, nil]
         optional :region, String
 
         # @!method initialize(city: nil, country: nil, region: nil)
-        #   @param city [String]
-        #   @param country [String]
-        #   @param region [String]
+        #   Location context to help identify the person. Provide a city, region, or
+        #   country.
+        #
+        #   @param city [String] City associated with the person.
+        #
+        #   @param country [String] Country associated with the person.
+        #
+        #   @param region [String] State, province, or region associated with the person.
       end
 
       class Name < ContextDev::Internal::Type::BaseModel
         # @!attribute first
+        #   First or given name.
         #
         #   @return [String, nil]
         optional :first, String
 
         # @!attribute last
+        #   Last or family name.
         #
         #   @return [String, nil]
         optional :last, String
 
         # @!method initialize(first: nil, last: nil)
-        #   @param first [String]
-        #   @param last [String]
+        #   Person name. Without an email or person-profile URL, provide both first and last
+        #   name plus company, education, or location.
+        #
+        #   @param first [String] First or given name.
+        #
+        #   @param last [String] Last or family name.
       end
 
       class TimeoutOpts < ContextDev::Internal::Type::BaseModel
         # @!attribute milliseconds
-        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   Deadline in milliseconds.
         #
         #   @return [Integer]
         required :milliseconds, Integer
 
         # @!attribute behavior
-        #   What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        #   credits. "return-partial" returns usable results collected so far; if none are
-        #   available, the request still fails without charging credits. Partial results are
-        #   not cached as complete results.
+        #   "fail" returns 408 at the deadline. "return-partial" returns available results;
+        #   inspect the response’s partial flag.
         #
         #   @return [Symbol, ContextDev::Models::PersonEnrichParams::TimeoutOpts::Behavior, nil]
         optional :behavior, enum: -> { ContextDev::PersonEnrichParams::TimeoutOpts::Behavior }
@@ -204,18 +237,14 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::PersonEnrichParams::TimeoutOpts} for more details.
         #
-        #   Optional request deadline and behavior on timeout. For GET requests, use
-        #   timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
-        #   timeoutOpts object.
+        #   Request deadline and what to return when it passes.
         #
-        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #   @param milliseconds [Integer] Deadline in milliseconds.
         #
-        #   @param behavior [Symbol, ContextDev::Models::PersonEnrichParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+        #   @param behavior [Symbol, ContextDev::Models::PersonEnrichParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
 
-        # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
-        # credits. "return-partial" returns usable results collected so far; if none are
-        # available, the request still fails without charging credits. Partial results are
-        # not cached as complete results.
+        # "fail" returns 408 at the deadline. "return-partial" returns available results;
+        # inspect the response’s partial flag.
         #
         # @see ContextDev::Models::PersonEnrichParams::TimeoutOpts#behavior
         module Behavior
@@ -229,11 +258,8 @@ module ContextDev
         end
       end
 
-      # Set to enabled to bypass shared caches and omit request and response content
-      # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
-      # omitted. Requires zero data retention to be enabled for your organization
-      # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
-      # Successful ZDR responses include X-Context-ZDR: true.
+      # `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
+      # your organization has ZDR.
       module Zdr
         extend ContextDev::Internal::Type::Enum
 

data/lib/context_dev/models/person_enrich_response.rb

@@ -11,14 +11,14 @@ module ContextDev
       required :match, union: -> { ContextDev::Models::PersonEnrichResponse::Match }
 
       # @!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::PersonEnrichResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::PersonEnrichResponse::KeyMetadata }
@@ -36,9 +36,9 @@ module ContextDev
       #
       #   @param match [ContextDev::Models::PersonEnrichResponse::Match::Candidate, ContextDev::Models::PersonEnrichResponse::Match::NotFound] The highest-scoring person candidate.
       #
-      #   @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::PersonEnrichResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #   @param key_metadata [ContextDev::Models::PersonEnrichResponse::KeyMetadata] Credits this request used and your remaining balance.
       #
       #   @param partial [Boolean] True when the timeout ended processing and this response contains the usable dat
 
@@ -634,7 +634,7 @@ module ContextDev
       # @see ContextDev::Models::PersonEnrichResponse#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
@@ -646,9 +646,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