context.dev 2.21.0 → 2.22.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- checksums.yaml +4 -4
- data/CHANGELOG.md +24 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +4 -9
- data/lib/context_dev/models/batch_cancel_params.rb +2 -2
- data/lib/context_dev/models/batch_cancel_response.rb +16 -21
- data/lib/context_dev/models/batch_delete_params.rb +2 -2
- data/lib/context_dev/models/batch_delete_response.rb +8 -8
- data/lib/context_dev/models/batch_get_results_params.rb +2 -2
- data/lib/context_dev/models/batch_get_results_response.rb +17 -22
- data/lib/context_dev/models/batch_list_response.rb +38 -47
- data/lib/context_dev/models/batch_retrieve_params.rb +2 -2
- data/lib/context_dev/models/batch_retrieve_response.rb +37 -46
- data/lib/context_dev/models/batch_submit_params.rb +80 -109
- data/lib/context_dev/models/batch_submit_response.rb +18 -28
- data/lib/context_dev/models/brand_retrieve_params.rb +90 -149
- data/lib/context_dev/models/brand_retrieve_response.rb +18 -22
- data/lib/context_dev/models/brand_search_params.rb +2 -3
- data/lib/context_dev/models/brand_search_response.rb +8 -8
- data/lib/context_dev/models/crawl_controls.rb +1 -2
- data/lib/context_dev/models/feedback_submit_params.rb +2 -2
- data/lib/context_dev/models/feedback_submit_response.rb +8 -8
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +17 -32
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +10 -10
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +20 -39
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +10 -10
- data/lib/context_dev/models/intake.rb +7 -13
- data/lib/context_dev/models/log_list_response.rb +14 -10
- data/lib/context_dev/models/log_retrieve_response.rb +15 -41
- data/lib/context_dev/models/monitor_create_params.rb +238 -72
- data/lib/context_dev/models/monitor_create_response.rb +364 -175
- data/lib/context_dev/models/monitor_delete_params.rb +3 -1
- data/lib/context_dev/models/monitor_delete_response.rb +44 -1
- data/lib/context_dev/models/monitor_get_credit_usage_response.rb +43 -1
- data/lib/context_dev/models/monitor_get_limits_response.rb +47 -7
- data/lib/context_dev/models/monitor_list_account_changes_response.rb +143 -20
- data/lib/context_dev/models/monitor_list_account_runs_response.rb +50 -8
- data/lib/context_dev/models/monitor_list_changes_params.rb +2 -1
- data/lib/context_dev/models/monitor_list_changes_response.rb +143 -20
- data/lib/context_dev/models/monitor_list_params.rb +3 -3
- data/lib/context_dev/models/monitor_list_response.rb +304 -106
- data/lib/context_dev/models/monitor_list_runs_params.rb +2 -1
- data/lib/context_dev/models/monitor_list_runs_response.rb +50 -8
- data/lib/context_dev/models/monitor_retrieve_change_params.rb +3 -1
- data/lib/context_dev/models/monitor_retrieve_change_response.rb +45 -15
- data/lib/context_dev/models/monitor_retrieve_params.rb +3 -1
- data/lib/context_dev/models/monitor_retrieve_response.rb +361 -171
- data/lib/context_dev/models/monitor_retrieve_run_params.rb +6 -2
- data/lib/context_dev/models/monitor_retrieve_run_response.rb +45 -8
- data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +3 -1
- data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +364 -172
- data/lib/context_dev/models/monitor_run_params.rb +3 -1
- data/lib/context_dev/models/monitor_run_response.rb +42 -4
- data/lib/context_dev/models/monitor_update_params.rb +239 -71
- data/lib/context_dev/models/monitor_update_response.rb +361 -171
- data/lib/context_dev/models/news_search_params.rb +10 -6
- data/lib/context_dev/models/news_search_response.rb +8 -8
- data/lib/context_dev/models/parse_handle_params.rb +9 -20
- data/lib/context_dev/models/parse_handle_response.rb +8 -8
- data/lib/context_dev/models/person_enrich_params.rb +76 -50
- data/lib/context_dev/models/person_enrich_response.rb +8 -8
- data/lib/context_dev/models/utility_prefetch_params.rb +15 -29
- data/lib/context_dev/models/utility_prefetch_response.rb +10 -10
- data/lib/context_dev/models/web_answers_params.rb +28 -47
- data/lib/context_dev/models/web_answers_response.rb +9 -8
- data/lib/context_dev/models/web_extract_competitors_params.rb +17 -32
- data/lib/context_dev/models/web_extract_competitors_response.rb +8 -8
- data/lib/context_dev/models/web_extract_styleguide_params.rb +22 -44
- data/lib/context_dev/models/web_extract_styleguide_response.rb +34 -44
- data/lib/context_dev/models/web_map_urls_params.rb +30 -51
- data/lib/context_dev/models/web_map_urls_response.rb +8 -8
- data/lib/context_dev/models/web_scrape_params.rb +193 -191
- data/lib/context_dev/models/web_scrape_response.rb +219 -95
- data/lib/context_dev/models/web_screenshot_params.rb +20 -39
- data/lib/context_dev/models/web_screenshot_response.rb +18 -28
- data/lib/context_dev/models/web_search_params.rb +76 -65
- data/lib/context_dev/models/web_search_response.rb +68 -27
- data/lib/context_dev/models/web_web_crawl_md_params.rb +41 -70
- data/lib/context_dev/models/web_web_crawl_md_response.rb +11 -15
- data/lib/context_dev/models/webhook_delivery.rb +3 -7
- data/lib/context_dev/models/webhooks/attempt.rb +3 -3
- data/lib/context_dev/models/webhooks/delivery.rb +16 -11
- data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +2 -6
- data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_list_params.rb +4 -4
- data/lib/context_dev/models/webhooks/delivery_list_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +2 -6
- data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_retry_params.rb +4 -4
- data/lib/context_dev/models/webhooks/delivery_retry_response.rb +8 -8
- data/lib/context_dev/models/webhooks/delivery_summary.rb +16 -11
- data/lib/context_dev/resources/batch.rb +17 -16
- data/lib/context_dev/resources/brand.rb +6 -8
- data/lib/context_dev/resources/feedback.rb +4 -5
- data/lib/context_dev/resources/industry.rb +9 -11
- data/lib/context_dev/resources/logs.rb +4 -5
- data/lib/context_dev/resources/monitors.rb +50 -53
- data/lib/context_dev/resources/news.rb +4 -8
- data/lib/context_dev/resources/parse.rb +4 -5
- data/lib/context_dev/resources/people.rb +11 -13
- data/lib/context_dev/resources/utility.rb +4 -11
- data/lib/context_dev/resources/web.rb +69 -94
- data/lib/context_dev/resources/webhooks/deliveries.rb +10 -18
- data/lib/context_dev/resources/webhooks.rb +1 -1
- data/lib/context_dev/version.rb +1 -1
- data/rbi/context_dev/client.rbi +4 -9
- data/rbi/context_dev/models/batch_cancel_params.rbi +2 -2
- data/rbi/context_dev/models/batch_cancel_response.rbi +17 -21
- data/rbi/context_dev/models/batch_delete_params.rbi +2 -2
- data/rbi/context_dev/models/batch_delete_response.rbi +9 -9
- data/rbi/context_dev/models/batch_get_results_params.rbi +2 -2
- data/rbi/context_dev/models/batch_get_results_response.rbi +18 -26
- data/rbi/context_dev/models/batch_list_response.rbi +41 -53
- data/rbi/context_dev/models/batch_retrieve_params.rbi +2 -2
- data/rbi/context_dev/models/batch_retrieve_response.rbi +40 -52
- data/rbi/context_dev/models/batch_submit_params.rbi +87 -147
- data/rbi/context_dev/models/batch_submit_response.rbi +19 -31
- data/rbi/context_dev/models/brand_retrieve_params.rbi +99 -190
- data/rbi/context_dev/models/brand_retrieve_response.rbi +19 -25
- data/rbi/context_dev/models/brand_search_params.rbi +2 -4
- data/rbi/context_dev/models/brand_search_response.rbi +9 -9
- data/rbi/context_dev/models/crawl_controls.rbi +1 -2
- data/rbi/context_dev/models/feedback_submit_params.rbi +2 -2
- data/rbi/context_dev/models/feedback_submit_response.rbi +9 -9
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +19 -42
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +11 -11
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +22 -51
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +11 -11
- data/rbi/context_dev/models/intake.rbi +7 -19
- data/rbi/context_dev/models/log_list_response.rbi +13 -11
- data/rbi/context_dev/models/log_retrieve_response.rbi +13 -76
- data/rbi/context_dev/models/monitor_create_params.rbi +418 -78
- data/rbi/context_dev/models/monitor_create_response.rbi +654 -287
- data/rbi/context_dev/models/monitor_delete_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_delete_response.rbi +89 -3
- data/rbi/context_dev/models/monitor_get_credit_usage_response.rbi +77 -3
- data/rbi/context_dev/models/monitor_get_limits_response.rbi +83 -10
- data/rbi/context_dev/models/monitor_list_account_changes_response.rbi +236 -24
- data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +86 -12
- data/rbi/context_dev/models/monitor_list_changes_params.rbi +2 -0
- data/rbi/context_dev/models/monitor_list_changes_response.rbi +234 -24
- data/rbi/context_dev/models/monitor_list_params.rbi +4 -4
- data/rbi/context_dev/models/monitor_list_response.rbi +502 -130
- data/rbi/context_dev/models/monitor_list_runs_params.rbi +2 -0
- data/rbi/context_dev/models/monitor_list_runs_response.rbi +84 -12
- data/rbi/context_dev/models/monitor_retrieve_change_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_retrieve_change_response.rbi +79 -15
- data/rbi/context_dev/models/monitor_retrieve_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +654 -283
- data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +9 -1
- data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +77 -9
- data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +659 -288
- data/rbi/context_dev/models/monitor_run_params.rbi +6 -1
- data/rbi/context_dev/models/monitor_run_response.rbi +82 -9
- data/rbi/context_dev/models/monitor_update_params.rbi +420 -75
- data/rbi/context_dev/models/monitor_update_response.rbi +650 -281
- data/rbi/context_dev/models/news_search_params.rbi +10 -2
- data/rbi/context_dev/models/news_search_response.rbi +9 -9
- data/rbi/context_dev/models/parse_handle_params.rbi +10 -29
- data/rbi/context_dev/models/parse_handle_response.rbi +9 -9
- data/rbi/context_dev/models/person_enrich_params.rbi +86 -44
- data/rbi/context_dev/models/person_enrich_response.rbi +9 -9
- data/rbi/context_dev/models/utility_prefetch_params.rbi +15 -27
- data/rbi/context_dev/models/utility_prefetch_response.rbi +11 -11
- data/rbi/context_dev/models/web_answers_params.rbi +33 -63
- data/rbi/context_dev/models/web_answers_response.rbi +11 -9
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +19 -42
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +9 -9
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +25 -61
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +36 -51
- data/rbi/context_dev/models/web_map_urls_params.rbi +33 -68
- data/rbi/context_dev/models/web_map_urls_response.rbi +9 -9
- data/rbi/context_dev/models/web_scrape_params.rbi +212 -206
- data/rbi/context_dev/models/web_scrape_response.rbi +296 -120
- data/rbi/context_dev/models/web_screenshot_params.rbi +22 -51
- data/rbi/context_dev/models/web_screenshot_response.rbi +20 -35
- data/rbi/context_dev/models/web_search_params.rbi +114 -82
- data/rbi/context_dev/models/web_search_response.rbi +145 -33
- data/rbi/context_dev/models/web_web_crawl_md_params.rbi +45 -95
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +12 -18
- data/rbi/context_dev/models/webhook_delivery.rbi +3 -9
- data/rbi/context_dev/models/webhooks/attempt.rbi +3 -3
- data/rbi/context_dev/models/webhooks/delivery.rbi +14 -11
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +2 -4
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +4 -4
- data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +2 -4
- data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +4 -4
- data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +9 -9
- data/rbi/context_dev/models/webhooks/delivery_summary.rbi +14 -11
- data/rbi/context_dev/resources/batch.rbi +19 -18
- data/rbi/context_dev/resources/brand.rbi +6 -9
- data/rbi/context_dev/resources/feedback.rbi +4 -5
- data/rbi/context_dev/resources/industry.rbi +11 -27
- data/rbi/context_dev/resources/logs.rbi +4 -5
- data/rbi/context_dev/resources/monitors.rbi +71 -49
- data/rbi/context_dev/resources/news.rbi +4 -8
- data/rbi/context_dev/resources/parse.rbi +7 -14
- data/rbi/context_dev/resources/people.rbi +15 -13
- data/rbi/context_dev/resources/utility.rbi +4 -11
- data/rbi/context_dev/resources/web.rbi +89 -190
- data/rbi/context_dev/resources/webhooks/deliveries.rbi +10 -12
- data/rbi/context_dev/resources/webhooks.rbi +1 -1
- data/sig/context_dev/models/log_retrieve_response.rbs +0 -28
- data/sig/context_dev/models/monitor_create_params.rbs +113 -0
- data/sig/context_dev/models/monitor_create_response.rbs +203 -53
- data/sig/context_dev/models/monitor_delete_response.rbs +46 -3
- data/sig/context_dev/models/monitor_get_credit_usage_response.rbs +36 -3
- data/sig/context_dev/models/monitor_get_limits_response.rbs +36 -3
- data/sig/context_dev/models/monitor_list_account_changes_response.rbs +111 -8
- data/sig/context_dev/models/monitor_list_account_runs_response.rbs +36 -3
- data/sig/context_dev/models/monitor_list_changes_response.rbs +111 -8
- data/sig/context_dev/models/monitor_list_response.rbs +149 -3
- data/sig/context_dev/models/monitor_list_runs_response.rbs +36 -3
- data/sig/context_dev/models/monitor_retrieve_change_response.rbs +33 -0
- data/sig/context_dev/models/monitor_retrieve_response.rbs +203 -53
- data/sig/context_dev/models/monitor_retrieve_run_response.rbs +33 -0
- data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +203 -53
- data/sig/context_dev/models/monitor_run_response.rbs +48 -3
- data/sig/context_dev/models/monitor_update_params.rbs +113 -0
- data/sig/context_dev/models/monitor_update_response.rbs +203 -53
- data/sig/context_dev/models/web_scrape_response.rbs +204 -27
- data/sig/context_dev/models/web_search_params.rbs +25 -0
- data/sig/context_dev/models/web_search_response.rbs +48 -0
- data/sig/context_dev/resources/web.rbs +1 -0
- metadata +2 -2
|
@@ -11,9 +11,7 @@ module ContextDev
|
|
|
11
11
|
required :brand, -> { ContextDev::Models::BrandRetrieveResponse::Brand }
|
|
12
12
|
|
|
13
13
|
# @!attribute cache_metadata
|
|
14
|
-
#
|
|
15
|
-
# cache-controlled fetch contributing to the output was a hit; age_ms is the
|
|
16
|
-
# oldest contributing hit.
|
|
14
|
+
# Whether this response came from cache.
|
|
17
15
|
#
|
|
18
16
|
# @return [ContextDev::Models::BrandRetrieveResponse::CacheMetadata]
|
|
19
17
|
required :cache_metadata, -> { ContextDev::Models::BrandRetrieveResponse::CacheMetadata }
|
|
@@ -25,20 +23,20 @@ module ContextDev
|
|
|
25
23
|
required :code, Integer
|
|
26
24
|
|
|
27
25
|
# @!attribute request_id
|
|
28
|
-
# Unique
|
|
29
|
-
#
|
|
26
|
+
# Unique ID of this request, also in `X-Request-Id`. Include it when contacting
|
|
27
|
+
# support.
|
|
30
28
|
#
|
|
31
29
|
# @return [String]
|
|
32
30
|
required :request_id, String
|
|
33
31
|
|
|
34
32
|
# @!attribute status
|
|
35
|
-
#
|
|
33
|
+
# Always `ok` on success.
|
|
36
34
|
#
|
|
37
35
|
# @return [String]
|
|
38
36
|
required :status, String
|
|
39
37
|
|
|
40
38
|
# @!attribute key_metadata
|
|
41
|
-
#
|
|
39
|
+
# Credits this request used and your remaining balance.
|
|
42
40
|
#
|
|
43
41
|
# @return [ContextDev::Models::BrandRetrieveResponse::KeyMetadata, nil]
|
|
44
42
|
optional :key_metadata, -> { ContextDev::Models::BrandRetrieveResponse::KeyMetadata }
|
|
@@ -56,15 +54,15 @@ module ContextDev
|
|
|
56
54
|
#
|
|
57
55
|
# @param brand [ContextDev::Models::BrandRetrieveResponse::Brand] Detailed brand information
|
|
58
56
|
#
|
|
59
|
-
# @param cache_metadata [ContextDev::Models::BrandRetrieveResponse::CacheMetadata]
|
|
57
|
+
# @param cache_metadata [ContextDev::Models::BrandRetrieveResponse::CacheMetadata] Whether this response came from cache.
|
|
60
58
|
#
|
|
61
59
|
# @param code [Integer] HTTP status code
|
|
62
60
|
#
|
|
63
|
-
# @param request_id [String] Unique
|
|
61
|
+
# @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
|
|
64
62
|
#
|
|
65
|
-
# @param status [String]
|
|
63
|
+
# @param status [String] Always `ok` on success.
|
|
66
64
|
#
|
|
67
|
-
# @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata]
|
|
65
|
+
# @param key_metadata [ContextDev::Models::BrandRetrieveResponse::KeyMetadata] Credits this request used and your remaining balance.
|
|
68
66
|
#
|
|
69
67
|
# @param partial [Boolean] True when the timeout ended processing and this response contains the usable dat
|
|
70
68
|
|
|
@@ -148,7 +146,7 @@ module ContextDev
|
|
|
148
146
|
optional :phone, String
|
|
149
147
|
|
|
150
148
|
# @!attribute primary_language
|
|
151
|
-
# Language
|
|
149
|
+
# Language, e.g. `english`.
|
|
152
150
|
#
|
|
153
151
|
# @return [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil]
|
|
154
152
|
optional :primary_language,
|
|
@@ -211,7 +209,7 @@ module ContextDev
|
|
|
211
209
|
#
|
|
212
210
|
# @param phone [String] Company phone number
|
|
213
211
|
#
|
|
214
|
-
# @param primary_language [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil] Language
|
|
212
|
+
# @param primary_language [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::PrimaryLanguage, nil] Language, e.g. `english`.
|
|
215
213
|
#
|
|
216
214
|
# @param slogan [String] The brand's slogan
|
|
217
215
|
#
|
|
@@ -833,7 +831,7 @@ module ContextDev
|
|
|
833
831
|
optional :type, enum: -> { ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Type }
|
|
834
832
|
|
|
835
833
|
# @!attribute url
|
|
836
|
-
#
|
|
834
|
+
# Hosted logo URL.
|
|
837
835
|
#
|
|
838
836
|
# @return [String, nil]
|
|
839
837
|
optional :url, String
|
|
@@ -850,7 +848,7 @@ module ContextDev
|
|
|
850
848
|
#
|
|
851
849
|
# @param type [Symbol, ContextDev::Models::BrandRetrieveResponse::Brand::Logo::Type] Type of the logo based on resolution (e.g., 'icon', 'logo')
|
|
852
850
|
#
|
|
853
|
-
# @param url [String]
|
|
851
|
+
# @param url [String] Hosted logo URL.
|
|
854
852
|
|
|
855
853
|
class Color < ContextDev::Internal::Type::BaseModel
|
|
856
854
|
# @!attribute hex
|
|
@@ -931,7 +929,7 @@ module ContextDev
|
|
|
931
929
|
end
|
|
932
930
|
end
|
|
933
931
|
|
|
934
|
-
# Language
|
|
932
|
+
# Language, e.g. `english`.
|
|
935
933
|
#
|
|
936
934
|
# @see ContextDev::Models::BrandRetrieveResponse::Brand#primary_language
|
|
937
935
|
module PrimaryLanguage
|
|
@@ -1166,9 +1164,7 @@ module ContextDev
|
|
|
1166
1164
|
# Some parameter documentations has been truncated, see
|
|
1167
1165
|
# {ContextDev::Models::BrandRetrieveResponse::CacheMetadata} for more details.
|
|
1168
1166
|
#
|
|
1169
|
-
#
|
|
1170
|
-
# cache-controlled fetch contributing to the output was a hit; age_ms is the
|
|
1171
|
-
# oldest contributing hit.
|
|
1167
|
+
# Whether this response came from cache.
|
|
1172
1168
|
#
|
|
1173
1169
|
# @param age_ms [Integer] Age of the cached data in milliseconds. Zero for miss and zdr responses.
|
|
1174
1170
|
#
|
|
@@ -1193,7 +1189,7 @@ module ContextDev
|
|
|
1193
1189
|
# @see ContextDev::Models::BrandRetrieveResponse#key_metadata
|
|
1194
1190
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
1195
1191
|
# @!attribute credits_consumed
|
|
1196
|
-
# Credits
|
|
1192
|
+
# Credits charged for this request.
|
|
1197
1193
|
#
|
|
1198
1194
|
# @return [Integer]
|
|
1199
1195
|
required :credits_consumed, Integer
|
|
@@ -1205,9 +1201,9 @@ module ContextDev
|
|
|
1205
1201
|
required :credits_remaining, Integer
|
|
1206
1202
|
|
|
1207
1203
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
1208
|
-
#
|
|
1204
|
+
# Credits this request used and your remaining balance.
|
|
1209
1205
|
#
|
|
1210
|
-
# @param credits_consumed [Integer] Credits
|
|
1206
|
+
# @param credits_consumed [Integer] Credits charged for this request.
|
|
1211
1207
|
#
|
|
1212
1208
|
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
1213
1209
|
end
|
|
@@ -30,8 +30,7 @@ module ContextDev
|
|
|
30
30
|
-> { ContextDev::Internal::Type::ArrayOf[enum: ContextDev::BrandSearchParams::QueryBy] }
|
|
31
31
|
|
|
32
32
|
# @!attribute tags
|
|
33
|
-
# Comma-separated
|
|
34
|
-
# characters.
|
|
33
|
+
# Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
35
34
|
#
|
|
36
35
|
# @return [Array<String>, nil]
|
|
37
36
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -53,7 +52,7 @@ module ContextDev
|
|
|
53
52
|
#
|
|
54
53
|
# @param query_by [Array<Symbol, ContextDev::Models::BrandSearchParams::QueryBy>] Fields to match the search term against, as a comma-separated list or repeated p
|
|
55
54
|
#
|
|
56
|
-
# @param tags [Array<String>] Comma-separated
|
|
55
|
+
# @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
57
56
|
#
|
|
58
57
|
# @param typo_tolerance [Integer] Maximum number of typos tolerated when matching, from 0 to 2. Defaults to 0 (no
|
|
59
58
|
#
|
|
@@ -5,8 +5,8 @@ module ContextDev
|
|
|
5
5
|
# @see ContextDev::Resources::Brand#search
|
|
6
6
|
class BrandSearchResponse < ContextDev::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute request_id
|
|
8
|
-
# Unique
|
|
9
|
-
#
|
|
8
|
+
# Unique ID of this request, also in `X-Request-Id`. Include it when contacting
|
|
9
|
+
# support.
|
|
10
10
|
#
|
|
11
11
|
# @return [String]
|
|
12
12
|
required :request_id, String
|
|
@@ -20,7 +20,7 @@ module ContextDev
|
|
|
20
20
|
-> { ContextDev::Internal::Type::ArrayOf[ContextDev::Models::BrandSearchResponse::Result] }
|
|
21
21
|
|
|
22
22
|
# @!attribute key_metadata
|
|
23
|
-
#
|
|
23
|
+
# Credits this request used and your remaining balance.
|
|
24
24
|
#
|
|
25
25
|
# @return [ContextDev::Models::BrandSearchResponse::KeyMetadata, nil]
|
|
26
26
|
optional :key_metadata, -> { ContextDev::Models::BrandSearchResponse::KeyMetadata }
|
|
@@ -29,11 +29,11 @@ module ContextDev
|
|
|
29
29
|
# Some parameter documentations has been truncated, see
|
|
30
30
|
# {ContextDev::Models::BrandSearchResponse} for more details.
|
|
31
31
|
#
|
|
32
|
-
# @param request_id [String] Unique
|
|
32
|
+
# @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
|
|
33
33
|
#
|
|
34
34
|
# @param results [Array<ContextDev::Models::BrandSearchResponse::Result>] Up to 10 matching brands, name matches first, then domain matches, most popular
|
|
35
35
|
#
|
|
36
|
-
# @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata]
|
|
36
|
+
# @param key_metadata [ContextDev::Models::BrandSearchResponse::KeyMetadata] Credits this request used and your remaining balance.
|
|
37
37
|
|
|
38
38
|
class Result < ContextDev::Internal::Type::BaseModel
|
|
39
39
|
# @!attribute domain
|
|
@@ -69,7 +69,7 @@ module ContextDev
|
|
|
69
69
|
# @see ContextDev::Models::BrandSearchResponse#key_metadata
|
|
70
70
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
71
71
|
# @!attribute credits_consumed
|
|
72
|
-
# Credits
|
|
72
|
+
# Credits charged for this request.
|
|
73
73
|
#
|
|
74
74
|
# @return [Integer]
|
|
75
75
|
required :credits_consumed, Integer
|
|
@@ -81,9 +81,9 @@ module ContextDev
|
|
|
81
81
|
required :credits_remaining, Integer
|
|
82
82
|
|
|
83
83
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
84
|
-
#
|
|
84
|
+
# Credits this request used and your remaining balance.
|
|
85
85
|
#
|
|
86
|
-
# @param credits_consumed [Integer] Credits
|
|
86
|
+
# @param credits_consumed [Integer] Credits charged for this request.
|
|
87
87
|
#
|
|
88
88
|
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
89
89
|
end
|
|
@@ -39,8 +39,7 @@ module ContextDev
|
|
|
39
39
|
# Some parameter documentations has been truncated, see
|
|
40
40
|
# {ContextDev::Models::CrawlControls} for more details.
|
|
41
41
|
#
|
|
42
|
-
#
|
|
43
|
-
# what the crawl reached.
|
|
42
|
+
# Crawl settings as submitted.
|
|
44
43
|
#
|
|
45
44
|
# @param follow_subdomains [Boolean] Whether links to subdomains were followed. Always false for a sitemap crawl.
|
|
46
45
|
#
|
|
@@ -27,7 +27,7 @@ module ContextDev
|
|
|
27
27
|
optional :request_id, String
|
|
28
28
|
|
|
29
29
|
# @!attribute tags
|
|
30
|
-
#
|
|
30
|
+
# Labels for filtering usage in the dashboard.
|
|
31
31
|
#
|
|
32
32
|
# @return [Array<String>, nil]
|
|
33
33
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
@@ -48,7 +48,7 @@ module ContextDev
|
|
|
48
48
|
#
|
|
49
49
|
# @param request_id [String] The request_id of the API call the feedback is about, from its response body or
|
|
50
50
|
#
|
|
51
|
-
# @param tags [Array<String>]
|
|
51
|
+
# @param tags [Array<String>] Labels for filtering usage in the dashboard.
|
|
52
52
|
#
|
|
53
53
|
# @param url [String] The page the feedback is about, such as one page of a crawl or a docs page.
|
|
54
54
|
#
|
|
@@ -18,14 +18,14 @@ module ContextDev
|
|
|
18
18
|
required :feedback_id, String
|
|
19
19
|
|
|
20
20
|
# @!attribute request_id
|
|
21
|
-
# Unique
|
|
22
|
-
#
|
|
21
|
+
# Unique ID of this request, also in `X-Request-Id`. Include it when contacting
|
|
22
|
+
# support.
|
|
23
23
|
#
|
|
24
24
|
# @return [String]
|
|
25
25
|
required :request_id, String
|
|
26
26
|
|
|
27
27
|
# @!attribute key_metadata
|
|
28
|
-
#
|
|
28
|
+
# Credits this request used and your remaining balance.
|
|
29
29
|
#
|
|
30
30
|
# @return [ContextDev::Models::FeedbackSubmitResponse::KeyMetadata, nil]
|
|
31
31
|
optional :key_metadata, -> { ContextDev::Models::FeedbackSubmitResponse::KeyMetadata }
|
|
@@ -38,14 +38,14 @@ module ContextDev
|
|
|
38
38
|
#
|
|
39
39
|
# @param feedback_id [String] ID of the stored feedback.
|
|
40
40
|
#
|
|
41
|
-
# @param request_id [String] Unique
|
|
41
|
+
# @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
|
|
42
42
|
#
|
|
43
|
-
# @param key_metadata [ContextDev::Models::FeedbackSubmitResponse::KeyMetadata]
|
|
43
|
+
# @param key_metadata [ContextDev::Models::FeedbackSubmitResponse::KeyMetadata] Credits this request used and your remaining balance.
|
|
44
44
|
|
|
45
45
|
# @see ContextDev::Models::FeedbackSubmitResponse#key_metadata
|
|
46
46
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
47
47
|
# @!attribute credits_consumed
|
|
48
|
-
# Credits
|
|
48
|
+
# Credits charged for this request.
|
|
49
49
|
#
|
|
50
50
|
# @return [Integer]
|
|
51
51
|
required :credits_consumed, Integer
|
|
@@ -57,9 +57,9 @@ module ContextDev
|
|
|
57
57
|
required :credits_remaining, Integer
|
|
58
58
|
|
|
59
59
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
60
|
-
#
|
|
60
|
+
# Credits this request used and your remaining balance.
|
|
61
61
|
#
|
|
62
|
-
# @param credits_consumed [Integer] Credits
|
|
62
|
+
# @param credits_consumed [Integer] Credits charged for this request.
|
|
63
63
|
#
|
|
64
64
|
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
65
65
|
end
|
|
@@ -29,26 +29,20 @@ module ContextDev
|
|
|
29
29
|
optional :min_results, Integer
|
|
30
30
|
|
|
31
31
|
# @!attribute tags
|
|
32
|
-
# Comma-separated
|
|
33
|
-
# characters.
|
|
32
|
+
# Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
34
33
|
#
|
|
35
34
|
# @return [Array<String>, nil]
|
|
36
35
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
37
36
|
|
|
38
37
|
# @!attribute timeout_opts
|
|
39
|
-
#
|
|
40
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
41
|
-
# timeoutOpts object.
|
|
38
|
+
# Request deadline and what to return when it passes.
|
|
42
39
|
#
|
|
43
40
|
# @return [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts, nil]
|
|
44
41
|
optional :timeout_opts, -> { ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts }
|
|
45
42
|
|
|
46
43
|
# @!attribute zdr
|
|
47
|
-
#
|
|
48
|
-
#
|
|
49
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
50
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
51
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
44
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
45
|
+
# your organization has ZDR.
|
|
52
46
|
#
|
|
53
47
|
# @return [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr, nil]
|
|
54
48
|
optional :zdr, enum: -> { ContextDev::IndustryRetrieveNaicsParams::Zdr }
|
|
@@ -63,26 +57,24 @@ module ContextDev
|
|
|
63
57
|
#
|
|
64
58
|
# @param min_results [Integer] Minimum number of NAICS codes to return. Must be at least 1. Defaults to 1.
|
|
65
59
|
#
|
|
66
|
-
# @param tags [Array<String>] Comma-separated
|
|
60
|
+
# @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
67
61
|
#
|
|
68
|
-
# @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts]
|
|
62
|
+
# @param timeout_opts [ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts] Request deadline and what to return when it passes.
|
|
69
63
|
#
|
|
70
|
-
# @param zdr [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr]
|
|
64
|
+
# @param zdr [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
|
|
71
65
|
#
|
|
72
66
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
73
67
|
|
|
74
68
|
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
75
69
|
# @!attribute milliseconds
|
|
76
|
-
#
|
|
70
|
+
# Deadline in milliseconds.
|
|
77
71
|
#
|
|
78
72
|
# @return [Integer]
|
|
79
73
|
required :milliseconds, Integer
|
|
80
74
|
|
|
81
75
|
# @!attribute behavior
|
|
82
|
-
#
|
|
83
|
-
#
|
|
84
|
-
# available, the request still fails without charging credits. Partial results are
|
|
85
|
-
# not cached as complete results.
|
|
76
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
77
|
+
# inspect the response’s partial flag.
|
|
86
78
|
#
|
|
87
79
|
# @return [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior, nil]
|
|
88
80
|
optional :behavior, enum: -> { ContextDev::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior }
|
|
@@ -91,18 +83,14 @@ module ContextDev
|
|
|
91
83
|
# Some parameter documentations has been truncated, see
|
|
92
84
|
# {ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts} for more details.
|
|
93
85
|
#
|
|
94
|
-
#
|
|
95
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
96
|
-
# timeoutOpts object.
|
|
86
|
+
# Request deadline and what to return when it passes.
|
|
97
87
|
#
|
|
98
|
-
# @param milliseconds [Integer]
|
|
88
|
+
# @param milliseconds [Integer] Deadline in milliseconds.
|
|
99
89
|
#
|
|
100
|
-
# @param behavior [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior]
|
|
90
|
+
# @param behavior [Symbol, ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
101
91
|
|
|
102
|
-
#
|
|
103
|
-
#
|
|
104
|
-
# available, the request still fails without charging credits. Partial results are
|
|
105
|
-
# not cached as complete results.
|
|
92
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
93
|
+
# inspect the response’s partial flag.
|
|
106
94
|
#
|
|
107
95
|
# @see ContextDev::Models::IndustryRetrieveNaicsParams::TimeoutOpts#behavior
|
|
108
96
|
module Behavior
|
|
@@ -116,11 +104,8 @@ module ContextDev
|
|
|
116
104
|
end
|
|
117
105
|
end
|
|
118
106
|
|
|
119
|
-
#
|
|
120
|
-
#
|
|
121
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
122
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
123
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
107
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
108
|
+
# your organization has ZDR.
|
|
124
109
|
module Zdr
|
|
125
110
|
extend ContextDev::Internal::Type::Enum
|
|
126
111
|
|
|
@@ -5,8 +5,8 @@ module ContextDev
|
|
|
5
5
|
# @see ContextDev::Resources::Industry#retrieve_naics
|
|
6
6
|
class IndustryRetrieveNaicsResponse < ContextDev::Internal::Type::BaseModel
|
|
7
7
|
# @!attribute request_id
|
|
8
|
-
# Unique
|
|
9
|
-
#
|
|
8
|
+
# Unique ID of this request, also in `X-Request-Id`. Include it when contacting
|
|
9
|
+
# support.
|
|
10
10
|
#
|
|
11
11
|
# @return [String]
|
|
12
12
|
required :request_id, String
|
|
@@ -25,7 +25,7 @@ module ContextDev
|
|
|
25
25
|
optional :domain, String
|
|
26
26
|
|
|
27
27
|
# @!attribute key_metadata
|
|
28
|
-
#
|
|
28
|
+
# Credits this request used and your remaining balance.
|
|
29
29
|
#
|
|
30
30
|
# @return [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata, nil]
|
|
31
31
|
optional :key_metadata, -> { ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata }
|
|
@@ -38,7 +38,7 @@ module ContextDev
|
|
|
38
38
|
optional :partial, ContextDev::Internal::Type::Boolean
|
|
39
39
|
|
|
40
40
|
# @!attribute status
|
|
41
|
-
#
|
|
41
|
+
# Always `ok` on success.
|
|
42
42
|
#
|
|
43
43
|
# @return [String, nil]
|
|
44
44
|
optional :status, String
|
|
@@ -53,17 +53,17 @@ module ContextDev
|
|
|
53
53
|
# Some parameter documentations has been truncated, see
|
|
54
54
|
# {ContextDev::Models::IndustryRetrieveNaicsResponse} for more details.
|
|
55
55
|
#
|
|
56
|
-
# @param request_id [String] Unique
|
|
56
|
+
# @param request_id [String] Unique ID of this request, also in `X-Request-Id`. Include it when contacting su
|
|
57
57
|
#
|
|
58
58
|
# @param codes [Array<ContextDev::Models::IndustryRetrieveNaicsResponse::Code>] Array of NAICS codes and titles.
|
|
59
59
|
#
|
|
60
60
|
# @param domain [String] Domain found for the brand
|
|
61
61
|
#
|
|
62
|
-
# @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata]
|
|
62
|
+
# @param key_metadata [ContextDev::Models::IndustryRetrieveNaicsResponse::KeyMetadata] Credits this request used and your remaining balance.
|
|
63
63
|
#
|
|
64
64
|
# @param partial [Boolean] True when the timeout ended processing and this response contains only usable re
|
|
65
65
|
#
|
|
66
|
-
# @param status [String]
|
|
66
|
+
# @param status [String] Always `ok` on success.
|
|
67
67
|
#
|
|
68
68
|
# @param type [String] Industry classification type, for naics api it will be `naics`
|
|
69
69
|
|
|
@@ -111,7 +111,7 @@ module ContextDev
|
|
|
111
111
|
# @see ContextDev::Models::IndustryRetrieveNaicsResponse#key_metadata
|
|
112
112
|
class KeyMetadata < ContextDev::Internal::Type::BaseModel
|
|
113
113
|
# @!attribute credits_consumed
|
|
114
|
-
# Credits
|
|
114
|
+
# Credits charged for this request.
|
|
115
115
|
#
|
|
116
116
|
# @return [Integer]
|
|
117
117
|
required :credits_consumed, Integer
|
|
@@ -123,9 +123,9 @@ module ContextDev
|
|
|
123
123
|
required :credits_remaining, Integer
|
|
124
124
|
|
|
125
125
|
# @!method initialize(credits_consumed:, credits_remaining:)
|
|
126
|
-
#
|
|
126
|
+
# Credits this request used and your remaining balance.
|
|
127
127
|
#
|
|
128
|
-
# @param credits_consumed [Integer] Credits
|
|
128
|
+
# @param credits_consumed [Integer] Credits charged for this request.
|
|
129
129
|
#
|
|
130
130
|
# @param credits_remaining [Integer] Credits remaining for your organization.
|
|
131
131
|
end
|
|
@@ -28,34 +28,26 @@ module ContextDev
|
|
|
28
28
|
optional :min_results, Integer
|
|
29
29
|
|
|
30
30
|
# @!attribute tags
|
|
31
|
-
# Comma-separated
|
|
32
|
-
# characters.
|
|
31
|
+
# Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
33
32
|
#
|
|
34
33
|
# @return [Array<String>, nil]
|
|
35
34
|
optional :tags, ContextDev::Internal::Type::ArrayOf[String]
|
|
36
35
|
|
|
37
36
|
# @!attribute timeout_opts
|
|
38
|
-
#
|
|
39
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
40
|
-
# timeoutOpts object.
|
|
37
|
+
# Request deadline and what to return when it passes.
|
|
41
38
|
#
|
|
42
39
|
# @return [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts, nil]
|
|
43
40
|
optional :timeout_opts, -> { ContextDev::IndustryRetrieveSicParams::TimeoutOpts }
|
|
44
41
|
|
|
45
42
|
# @!attribute type
|
|
46
|
-
#
|
|
47
|
-
# Industrial Classification system; `latest_sec` uses the current SIC list as
|
|
48
|
-
# published by the SEC. Defaults to `original_sic`.
|
|
43
|
+
# SIC dataset: `original_sic` (1987) or `latest_sec` (current SEC list).
|
|
49
44
|
#
|
|
50
45
|
# @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type, nil]
|
|
51
46
|
optional :type, enum: -> { ContextDev::IndustryRetrieveSicParams::Type }
|
|
52
47
|
|
|
53
48
|
# @!attribute zdr
|
|
54
|
-
#
|
|
55
|
-
#
|
|
56
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
57
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
58
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
49
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
50
|
+
# your organization has ZDR.
|
|
59
51
|
#
|
|
60
52
|
# @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr, nil]
|
|
61
53
|
optional :zdr, enum: -> { ContextDev::IndustryRetrieveSicParams::Zdr }
|
|
@@ -70,28 +62,26 @@ module ContextDev
|
|
|
70
62
|
#
|
|
71
63
|
# @param min_results [Integer] Minimum number of SIC codes to return. Must be at least 1. Defaults to 1.
|
|
72
64
|
#
|
|
73
|
-
# @param tags [Array<String>] Comma-separated
|
|
65
|
+
# @param tags [Array<String>] Comma-separated labels for filtering usage, e.g. `production,team-alpha`.
|
|
74
66
|
#
|
|
75
|
-
# @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts]
|
|
67
|
+
# @param timeout_opts [ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts] Request deadline and what to return when it passes.
|
|
76
68
|
#
|
|
77
|
-
# @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type]
|
|
69
|
+
# @param type [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Type] SIC dataset: `original_sic` (1987) or `latest_sec` (current SEC list).
|
|
78
70
|
#
|
|
79
|
-
# @param zdr [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr]
|
|
71
|
+
# @param zdr [Symbol, ContextDev::Models::IndustryRetrieveSicParams::Zdr] `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless you
|
|
80
72
|
#
|
|
81
73
|
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}]
|
|
82
74
|
|
|
83
75
|
class TimeoutOpts < ContextDev::Internal::Type::BaseModel
|
|
84
76
|
# @!attribute milliseconds
|
|
85
|
-
#
|
|
77
|
+
# Deadline in milliseconds.
|
|
86
78
|
#
|
|
87
79
|
# @return [Integer]
|
|
88
80
|
required :milliseconds, Integer
|
|
89
81
|
|
|
90
82
|
# @!attribute behavior
|
|
91
|
-
#
|
|
92
|
-
#
|
|
93
|
-
# available, the request still fails without charging credits. Partial results are
|
|
94
|
-
# not cached as complete results.
|
|
83
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
84
|
+
# inspect the response’s partial flag.
|
|
95
85
|
#
|
|
96
86
|
# @return [Symbol, ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts::Behavior, nil]
|
|
97
87
|
optional :behavior, enum: -> { ContextDev::IndustryRetrieveSicParams::TimeoutOpts::Behavior }
|
|
@@ -100,18 +90,14 @@ module ContextDev
|
|
|
100
90
|
# Some parameter documentations has been truncated, see
|
|
101
91
|
# {ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts} for more details.
|
|
102
92
|
#
|
|
103
|
-
#
|
|
104
|
-
# timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
|
|
105
|
-
# timeoutOpts object.
|
|
93
|
+
# Request deadline and what to return when it passes.
|
|
106
94
|
#
|
|
107
|
-
# @param milliseconds [Integer]
|
|
95
|
+
# @param milliseconds [Integer] Deadline in milliseconds.
|
|
108
96
|
#
|
|
109
|
-
# @param behavior [Symbol, ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts::Behavior]
|
|
97
|
+
# @param behavior [Symbol, ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts::Behavior] "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
110
98
|
|
|
111
|
-
#
|
|
112
|
-
#
|
|
113
|
-
# available, the request still fails without charging credits. Partial results are
|
|
114
|
-
# not cached as complete results.
|
|
99
|
+
# "fail" returns 408 at the deadline. "return-partial" returns available results;
|
|
100
|
+
# inspect the response’s partial flag.
|
|
115
101
|
#
|
|
116
102
|
# @see ContextDev::Models::IndustryRetrieveSicParams::TimeoutOpts#behavior
|
|
117
103
|
module Behavior
|
|
@@ -125,9 +111,7 @@ module ContextDev
|
|
|
125
111
|
end
|
|
126
112
|
end
|
|
127
113
|
|
|
128
|
-
#
|
|
129
|
-
# Industrial Classification system; `latest_sec` uses the current SIC list as
|
|
130
|
-
# published by the SEC. Defaults to `original_sic`.
|
|
114
|
+
# SIC dataset: `original_sic` (1987) or `latest_sec` (current SEC list).
|
|
131
115
|
module Type
|
|
132
116
|
extend ContextDev::Internal::Type::Enum
|
|
133
117
|
|
|
@@ -138,11 +122,8 @@ module ContextDev
|
|
|
138
122
|
# @return [Array<Symbol>]
|
|
139
123
|
end
|
|
140
124
|
|
|
141
|
-
#
|
|
142
|
-
#
|
|
143
|
-
# omitted. Requires zero data retention to be enabled for your organization
|
|
144
|
-
# (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
|
|
145
|
-
# Successful ZDR responses include X-Context-ZDR: true.
|
|
125
|
+
# `enabled` turns on zero data retention. Returns 403 `ZDR_NOT_ENABLED` unless
|
|
126
|
+
# your organization has ZDR.
|
|
146
127
|
module Zdr
|
|
147
128
|
extend ContextDev::Internal::Type::Enum
|
|
148
129
|
|