context.dev 2.16.0 → 2.17.1

data/lib/context_dev/models/industry_retrieve_sic_response.rb

@@ -38,6 +38,13 @@ module ContextDev
       #   @return [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata }
 
+      # @!attribute partial
+      #   True when the timeout ended processing and this response contains only usable
+      #   results completed so far. Unfinished results are omitted.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
       # @!attribute status
       #   Status of the response, e.g., 'ok'
       #
@@ -50,7 +57,7 @@ module ContextDev
       #   @return [String, nil]
       optional :type, String
 
-      # @!method initialize(request_id:, classification: nil, codes: nil, domain: nil, key_metadata: nil, status: nil, type: nil)
+      # @!method initialize(request_id:, classification: nil, codes: nil, domain: nil, key_metadata: nil, partial: nil, status: nil, type: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::IndustryRetrieveSicResponse} for more details.
       #
@@ -64,6 +71,8 @@ module ContextDev
       #
       #   @param key_metadata [ContextDev::Models::IndustryRetrieveSicResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
       #
+      #   @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 type [String] Industry classification type, for sic api it will be `sic`

data/lib/context_dev/models/monitor_create_params.rb

@@ -97,6 +97,25 @@ module ContextDev
           #   @return [String]
           required :url, String
 
+          # @!attribute exclude_selectors
+          #   CSS selectors for HTML regions to remove before text extraction. Applied after
+          #   include_selectors; exclusion takes precedence when an element matches both. Omit
+          #   or pass an empty array to apply no explicit exclusions. Changing these selectors
+          #   creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
+          # @!attribute include_selectors
+          #   CSS selectors defining the HTML regions to monitor. Matching subtrees are
+          #   combined in document order before text extraction, instead of automatic
+          #   main-content selection. Omit or pass an empty array to use automatic
+          #   main-content extraction. If the filtered page has no usable text, the run fails
+          #   without replacing the baseline. Changing these selectors creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
           # @!attribute instructions
           #   Plain-language goal describing which page changes matter. When provided without
           #   change_detection, semantic detection is inferred.
@@ -110,7 +129,7 @@ module ContextDev
           #   @return [Boolean, nil]
           optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
 
-          # @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
+          # @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::MonitorCreateParams::Target::Page} for more details.
           #
@@ -119,6 +138,10 @@ module ContextDev
           #
           #   @param url [String]
           #
+          #   @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
+          #
+          #   @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
+          #
           #   @param instructions [String] Plain-language goal describing which page changes matter. When provided without
           #
           #   @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
@@ -371,7 +394,8 @@ module ContextDev
 
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL events are delivered to.
+        #   Webhook URL events are delivered to. Slack incoming webhook URLs are
+        #   automatically formatted as Slack messages.
         #
         #   @return [String]
         required :url, String
@@ -396,7 +420,7 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::MonitorCreateParams::Webhook} for more details.
         #
-        #   @param url [String] Webhook URL events are delivered to.
+        #   @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
         #
         #   @param events [Array<Symbol, ContextDev::Models::MonitorCreateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
         #

data/lib/context_dev/models/monitor_create_response.rb

@@ -331,6 +331,25 @@ module ContextDev
           #   @return [String]
           required :url, String
 
+          # @!attribute exclude_selectors
+          #   CSS selectors for HTML regions to remove before text extraction. Applied after
+          #   include_selectors; exclusion takes precedence when an element matches both. Omit
+          #   or pass an empty array to apply no explicit exclusions. Changing these selectors
+          #   creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
+          # @!attribute include_selectors
+          #   CSS selectors defining the HTML regions to monitor. Matching subtrees are
+          #   combined in document order before text extraction, instead of automatic
+          #   main-content selection. Omit or pass an empty array to use automatic
+          #   main-content extraction. If the filtered page has no usable text, the run fails
+          #   without replacing the baseline. Changing these selectors creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
           # @!attribute instructions
           #   Plain-language goal describing which page changes matter. When provided without
           #   change_detection, semantic detection is inferred.
@@ -344,7 +363,7 @@ module ContextDev
           #   @return [Boolean, nil]
           optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
 
-          # @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
+          # @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::MonitorCreateResponse::Target::Page} for more details.
           #
@@ -353,6 +372,10 @@ module ContextDev
           #
           #   @param url [String]
           #
+          #   @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
+          #
+          #   @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
+          #
           #   @param instructions [String] Plain-language goal describing which page changes matter. When provided without
           #
           #   @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
@@ -618,7 +641,8 @@ module ContextDev
       # @see ContextDev::Models::MonitorCreateResponse#webhook
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL events are delivered to.
+        #   Webhook URL events are delivered to. Slack incoming webhook URLs are
+        #   automatically formatted as Slack messages.
         #
         #   @return [String]
         required :url, String
@@ -641,7 +665,8 @@ module ContextDev
 
         response_only do
           # @!attribute secret
-          #   Signing secret used to verify webhook authenticity. Each delivery includes an
+          #   Signing secret used to verify webhook authenticity. Omitted unless the API key
+          #   has monitors:write permission or full access. Each delivery includes an
           #   `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
           #   `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
           #   compare and reject stale timestamps to prevent replay. Generated by the API;
@@ -655,13 +680,13 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::MonitorCreateResponse::Webhook} for more details.
         #
-        #   @param url [String] Webhook URL events are delivered to.
+        #   @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
         #
         #   @param events [Array<Symbol, ContextDev::Models::MonitorCreateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
         #
         #   @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
         #
-        #   @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
+        #   @param secret [String] Signing secret used to verify webhook authenticity. Omitted unless the API key h
 
         module Event
           extend ContextDev::Internal::Type::Enum

data/lib/context_dev/models/monitor_list_response.rb

@@ -344,6 +344,25 @@ module ContextDev
             #   @return [String]
             required :url, String
 
+            # @!attribute exclude_selectors
+            #   CSS selectors for HTML regions to remove before text extraction. Applied after
+            #   include_selectors; exclusion takes precedence when an element matches both. Omit
+            #   or pass an empty array to apply no explicit exclusions. Changing these selectors
+            #   creates a new baseline.
+            #
+            #   @return [Array<String>, nil]
+            optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
+            # @!attribute include_selectors
+            #   CSS selectors defining the HTML regions to monitor. Matching subtrees are
+            #   combined in document order before text extraction, instead of automatic
+            #   main-content selection. Omit or pass an empty array to use automatic
+            #   main-content extraction. If the filtered page has no usable text, the run fails
+            #   without replacing the baseline. Changing these selectors creates a new baseline.
+            #
+            #   @return [Array<String>, nil]
+            optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
             # @!attribute instructions
             #   Plain-language goal describing which page changes matter. When provided without
             #   change_detection, semantic detection is inferred.
@@ -357,7 +376,7 @@ module ContextDev
             #   @return [Boolean, nil]
             optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
 
-            # @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
+            # @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
             #   Some parameter documentations has been truncated, see
             #   {ContextDev::Models::MonitorListResponse::Data::Target::Page} for more details.
             #
@@ -366,6 +385,10 @@ module ContextDev
             #
             #   @param url [String]
             #
+            #   @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
+            #
+            #   @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
+            #
             #   @param instructions [String] Plain-language goal describing which page changes matter. When provided without
             #
             #   @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
@@ -632,7 +655,8 @@ module ContextDev
         # @see ContextDev::Models::MonitorListResponse::Data#webhook
         class Webhook < ContextDev::Internal::Type::BaseModel
           # @!attribute url
-          #   Webhook URL events are delivered to.
+          #   Webhook URL events are delivered to. Slack incoming webhook URLs are
+          #   automatically formatted as Slack messages.
           #
           #   @return [String]
           required :url, String
@@ -655,7 +679,8 @@ module ContextDev
 
           response_only do
             # @!attribute secret
-            #   Signing secret used to verify webhook authenticity. Each delivery includes an
+            #   Signing secret used to verify webhook authenticity. Omitted unless the API key
+            #   has monitors:write permission or full access. Each delivery includes an
             #   `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
             #   `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
             #   compare and reject stale timestamps to prevent replay. Generated by the API;
@@ -669,13 +694,13 @@ module ContextDev
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::MonitorListResponse::Data::Webhook} for more details.
           #
-          #   @param url [String] Webhook URL events are delivered to.
+          #   @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
           #
           #   @param events [Array<Symbol, ContextDev::Models::MonitorListResponse::Data::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
           #
           #   @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
           #
-          #   @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
+          #   @param secret [String] Signing secret used to verify webhook authenticity. Omitted unless the API key h
 
           module Event
             extend ContextDev::Internal::Type::Enum

data/lib/context_dev/models/monitor_retrieve_response.rb

@@ -321,6 +321,25 @@ module ContextDev
           #   @return [String]
           required :url, String
 
+          # @!attribute exclude_selectors
+          #   CSS selectors for HTML regions to remove before text extraction. Applied after
+          #   include_selectors; exclusion takes precedence when an element matches both. Omit
+          #   or pass an empty array to apply no explicit exclusions. Changing these selectors
+          #   creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
+          # @!attribute include_selectors
+          #   CSS selectors defining the HTML regions to monitor. Matching subtrees are
+          #   combined in document order before text extraction, instead of automatic
+          #   main-content selection. Omit or pass an empty array to use automatic
+          #   main-content extraction. If the filtered page has no usable text, the run fails
+          #   without replacing the baseline. Changing these selectors creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
           # @!attribute instructions
           #   Plain-language goal describing which page changes matter. When provided without
           #   change_detection, semantic detection is inferred.
@@ -334,7 +353,7 @@ module ContextDev
           #   @return [Boolean, nil]
           optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
 
-          # @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
+          # @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::MonitorRetrieveResponse::Target::Page} for more details.
           #
@@ -343,6 +362,10 @@ module ContextDev
           #
           #   @param url [String]
           #
+          #   @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
+          #
+          #   @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
+          #
           #   @param instructions [String] Plain-language goal describing which page changes matter. When provided without
           #
           #   @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
@@ -608,7 +631,8 @@ module ContextDev
       # @see ContextDev::Models::MonitorRetrieveResponse#webhook
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL events are delivered to.
+        #   Webhook URL events are delivered to. Slack incoming webhook URLs are
+        #   automatically formatted as Slack messages.
         #
         #   @return [String]
         required :url, String
@@ -631,7 +655,8 @@ module ContextDev
 
         response_only do
           # @!attribute secret
-          #   Signing secret used to verify webhook authenticity. Each delivery includes an
+          #   Signing secret used to verify webhook authenticity. Omitted unless the API key
+          #   has monitors:write permission or full access. Each delivery includes an
           #   `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
           #   `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
           #   compare and reject stale timestamps to prevent replay. Generated by the API;
@@ -645,13 +670,13 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::MonitorRetrieveResponse::Webhook} for more details.
         #
-        #   @param url [String] Webhook URL events are delivered to.
+        #   @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
         #
         #   @param events [Array<Symbol, ContextDev::Models::MonitorRetrieveResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
         #
         #   @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
         #
-        #   @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
+        #   @param secret [String] Signing secret used to verify webhook authenticity. Omitted unless the API key h
 
         module Event
           extend ContextDev::Internal::Type::Enum

data/lib/context_dev/models/monitor_update_params.rb

@@ -219,6 +219,25 @@ module ContextDev
           #   @return [String]
           required :url, String
 
+          # @!attribute exclude_selectors
+          #   CSS selectors for HTML regions to remove before text extraction. Applied after
+          #   include_selectors; exclusion takes precedence when an element matches both. Omit
+          #   or pass an empty array to apply no explicit exclusions. Changing these selectors
+          #   creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
+          # @!attribute include_selectors
+          #   CSS selectors defining the HTML regions to monitor. Matching subtrees are
+          #   combined in document order before text extraction, instead of automatic
+          #   main-content selection. Omit or pass an empty array to use automatic
+          #   main-content extraction. If the filtered page has no usable text, the run fails
+          #   without replacing the baseline. Changing these selectors creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
           # @!attribute instructions
           #   Plain-language goal describing which page changes matter. When provided without
           #   change_detection, semantic detection is inferred.
@@ -232,7 +251,7 @@ module ContextDev
           #   @return [Boolean, nil]
           optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
 
-          # @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
+          # @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::MonitorUpdateParams::Target::Page} for more details.
           #
@@ -241,6 +260,10 @@ module ContextDev
           #
           #   @param url [String]
           #
+          #   @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
+          #
+          #   @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
+          #
           #   @param instructions [String] Plain-language goal describing which page changes matter. When provided without
           #
           #   @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
@@ -376,7 +399,8 @@ module ContextDev
 
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL events are delivered to.
+        #   Webhook URL events are delivered to. Slack incoming webhook URLs are
+        #   automatically formatted as Slack messages.
         #
         #   @return [String]
         required :url, String
@@ -403,7 +427,7 @@ module ContextDev
         #
         #   Set to null to remove the webhook.
         #
-        #   @param url [String] Webhook URL events are delivered to.
+        #   @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
         #
         #   @param events [Array<Symbol, ContextDev::Models::MonitorUpdateParams::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
         #

data/lib/context_dev/models/monitor_update_response.rb

@@ -321,6 +321,25 @@ module ContextDev
           #   @return [String]
           required :url, String
 
+          # @!attribute exclude_selectors
+          #   CSS selectors for HTML regions to remove before text extraction. Applied after
+          #   include_selectors; exclusion takes precedence when an element matches both. Omit
+          #   or pass an empty array to apply no explicit exclusions. Changing these selectors
+          #   creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :exclude_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
+          # @!attribute include_selectors
+          #   CSS selectors defining the HTML regions to monitor. Matching subtrees are
+          #   combined in document order before text extraction, instead of automatic
+          #   main-content selection. Omit or pass an empty array to use automatic
+          #   main-content extraction. If the filtered page has no usable text, the run fails
+          #   without replacing the baseline. Changing these selectors creates a new baseline.
+          #
+          #   @return [Array<String>, nil]
+          optional :include_selectors, ContextDev::Internal::Type::ArrayOf[String]
+
           # @!attribute instructions
           #   Plain-language goal describing which page changes matter. When provided without
           #   change_detection, semantic detection is inferred.
@@ -334,7 +353,7 @@ module ContextDev
           #   @return [Boolean, nil]
           optional :normalize_whitespace, ContextDev::Internal::Type::Boolean
 
-          # @!method initialize(url:, instructions: nil, normalize_whitespace: nil, type: :page)
+          # @!method initialize(url:, exclude_selectors: nil, include_selectors: nil, instructions: nil, normalize_whitespace: nil, type: :page)
           #   Some parameter documentations has been truncated, see
           #   {ContextDev::Models::MonitorUpdateResponse::Target::Page} for more details.
           #
@@ -343,6 +362,10 @@ module ContextDev
           #
           #   @param url [String]
           #
+          #   @param exclude_selectors [Array<String>] CSS selectors for HTML regions to remove before text extraction. Applied after i
+          #
+          #   @param include_selectors [Array<String>] CSS selectors defining the HTML regions to monitor. Matching subtrees are combin
+          #
           #   @param instructions [String] Plain-language goal describing which page changes matter. When provided without
           #
           #   @param normalize_whitespace [Boolean] Normalize whitespace before comparing or analyzing text.
@@ -608,7 +631,8 @@ module ContextDev
       # @see ContextDev::Models::MonitorUpdateResponse#webhook
       class Webhook < ContextDev::Internal::Type::BaseModel
         # @!attribute url
-        #   Webhook URL events are delivered to.
+        #   Webhook URL events are delivered to. Slack incoming webhook URLs are
+        #   automatically formatted as Slack messages.
         #
         #   @return [String]
         required :url, String
@@ -631,7 +655,8 @@ module ContextDev
 
         response_only do
           # @!attribute secret
-          #   Signing secret used to verify webhook authenticity. Each delivery includes an
+          #   Signing secret used to verify webhook authenticity. Omitted unless the API key
+          #   has monitors:write permission or full access. Each delivery includes an
           #   `X-Context-Signature: t=<unix>,v1=<hmac>` header, where the HMAC is SHA-256 over
           #   `"{t}.{rawRequestBody}"` keyed by this secret. Recompute it with a constant-time
           #   compare and reject stale timestamps to prevent replay. Generated by the API;
@@ -645,13 +670,13 @@ module ContextDev
         #   Some parameter documentations has been truncated, see
         #   {ContextDev::Models::MonitorUpdateResponse::Webhook} for more details.
         #
-        #   @param url [String] Webhook URL events are delivered to.
+        #   @param url [String] Webhook URL events are delivered to. Slack incoming webhook URLs are automatical
         #
         #   @param events [Array<Symbol, ContextDev::Models::MonitorUpdateResponse::Webhook::Event>] Events delivered to this endpoint. `change.detected` fires only when a run detec
         #
         #   @param retry_ [ContextDev::Models::RetryConfig] Webhook retry settings. Use {} for the default schedule.
         #
-        #   @param secret [String] Signing secret used to verify webhook authenticity. Each delivery includes an `X
+        #   @param secret [String] Signing secret used to verify webhook authenticity. Omitted unless the API key h
 
         module Event
           extend ContextDev::Internal::Type::Enum

data/lib/context_dev/models/person_enrich_params.rb

@@ -43,15 +43,15 @@ module ContextDev
       #   @return [Array<String>, nil]
       optional :tags, ContextDev::Internal::Type::ArrayOf[String]
 
-      # @!attribute timeout_ms
-      #   Optional timeout in milliseconds for the request. If the request takes longer
-      #   than this value, it will be aborted with a 408 status code. Maximum allowed
-      #   value is 300000ms (5 minutes).
+      # @!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.
       #
-      #   @return [Integer, nil]
-      optional :timeout_ms, Integer, api_name: :timeoutMS
+      #   @return [ContextDev::Models::PersonEnrichParams::TimeoutOpts, nil]
+      optional :timeout_opts, -> { ContextDev::PersonEnrichParams::TimeoutOpts }, api_name: :timeoutOpts
 
-      # @!method initialize(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_ms: nil, request_options: {})
+      # @!method initialize(company: nil, education: nil, email: nil, location: nil, name: nil, social_urls: nil, tags: nil, timeout_opts: nil, request_options: {})
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::PersonEnrichParams} for more details.
       #
@@ -69,7 +69,7 @@ module ContextDev
       #
       #   @param tags [Array<String>] Optional tags for tracking usage. Up to 20 tags, each 1 to 50 characters.
       #
-      #   @param timeout_ms [Integer] Optional timeout in milliseconds for the request. If the request takes longer th
+      #   @param timeout_opts [ContextDev::Models::PersonEnrichParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
       #
       #   @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
 
@@ -171,6 +171,51 @@ module ContextDev
         #   @param first [String]
         #   @param last [String]
       end
+
+      class TimeoutOpts < ContextDev::Internal::Type::BaseModel
+        # @!attribute milliseconds
+        #   Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @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.
+        #
+        #   @return [Symbol, ContextDev::Models::PersonEnrichParams::TimeoutOpts::Behavior, nil]
+        optional :behavior, enum: -> { ContextDev::PersonEnrichParams::TimeoutOpts::Behavior }
+
+        # @!method initialize(milliseconds:, behavior: nil)
+        #   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.
+        #
+        #   @param milliseconds [Integer] Request deadline in milliseconds. Maximum: 300000 (5 minutes).
+        #
+        #   @param behavior [Symbol, ContextDev::Models::PersonEnrichParams::TimeoutOpts::Behavior] What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
+
+        # 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.
+        #
+        # @see ContextDev::Models::PersonEnrichParams::TimeoutOpts#behavior
+        module Behavior
+          extend ContextDev::Internal::Type::Enum
+
+          FAIL = :fail
+          RETURN_PARTIAL = :"return-partial"
+
+          # @!method self.values
+          #   @return [Array<Symbol>]
+        end
+      end
     end
   end
 end

data/lib/context_dev/models/person_enrich_response.rb

@@ -23,7 +23,14 @@ module ContextDev
       #   @return [ContextDev::Models::PersonEnrichResponse::KeyMetadata, nil]
       optional :key_metadata, -> { ContextDev::Models::PersonEnrichResponse::KeyMetadata }
 
-      # @!method initialize(match:, request_id:, key_metadata: nil)
+      # @!attribute partial
+      #   True when the timeout ended processing and this response contains the usable
+      #   data completed so far. Unfinished fields are omitted.
+      #
+      #   @return [Boolean, nil]
+      optional :partial, ContextDev::Internal::Type::Boolean
+
+      # @!method initialize(match:, request_id:, key_metadata: nil, partial: nil)
       #   Some parameter documentations has been truncated, see
       #   {ContextDev::Models::PersonEnrichResponse} for more details.
       #
@@ -32,6 +39,8 @@ module ContextDev
       #   @param request_id [String] Unique id of this API call, also sent in the X-Request-Id response header. Quote
       #
       #   @param key_metadata [ContextDev::Models::PersonEnrichResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
+      #
+      #   @param partial [Boolean] True when the timeout ended processing and this response contains the usable dat
 
       # The highest-scoring person candidate.
       #