context.dev 2.14.0 → 2.15.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 +8 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +4 -0
- data/lib/context_dev/models/ai_extract_product_response.rb +7 -9
- data/lib/context_dev/models/ai_extract_products_response.rb +7 -9
- data/lib/context_dev/models/batch_cancel_response.rb +4 -4
- data/lib/context_dev/models/batch_delete_response.rb +7 -12
- data/lib/context_dev/models/batch_get_results_response.rb +7 -12
- data/lib/context_dev/models/batch_list_response.rb +7 -12
- data/lib/context_dev/models/batch_retrieve_response.rb +13 -5
- data/lib/context_dev/models/batch_submit_params.rb +34 -3
- data/lib/context_dev/models/batch_submit_response.rb +4 -4
- data/lib/context_dev/models/brand_retrieve_response.rb +7 -9
- data/lib/context_dev/models/brand_retrieve_simplified_params.rb +3 -4
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +7 -9
- data/lib/context_dev/models/brand_search_params.rb +3 -4
- data/lib/context_dev/models/brand_search_response.rb +7 -9
- data/lib/context_dev/models/industry_retrieve_naics_params.rb +3 -4
- data/lib/context_dev/models/industry_retrieve_naics_response.rb +7 -12
- data/lib/context_dev/models/industry_retrieve_sic_params.rb +3 -4
- data/lib/context_dev/models/industry_retrieve_sic_response.rb +7 -9
- data/lib/context_dev/models/monitor_create_params.rb +9 -1
- data/lib/context_dev/models/monitor_create_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_account_runs_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_response.rb +9 -1
- data/lib/context_dev/models/monitor_list_runs_response.rb +9 -1
- data/lib/context_dev/models/monitor_retrieve_response.rb +9 -1
- data/lib/context_dev/models/monitor_update_params.rb +9 -1
- data/lib/context_dev/models/monitor_update_response.rb +9 -1
- data/lib/context_dev/models/news_search_response.rb +7 -9
- data/lib/context_dev/models/parse_handle_params.rb +3 -4
- data/lib/context_dev/models/parse_handle_response.rb +7 -12
- data/lib/context_dev/models/person_enrich_response.rb +7 -12
- data/lib/context_dev/models/retry_config.rb +22 -0
- data/lib/context_dev/models/utility_prefetch_response.rb +7 -12
- data/lib/context_dev/models/web_extract_competitors_params.rb +3 -4
- data/lib/context_dev/models/web_extract_competitors_response.rb +7 -12
- data/lib/context_dev/models/web_extract_fonts_params.rb +3 -4
- data/lib/context_dev/models/web_extract_fonts_response.rb +7 -9
- data/lib/context_dev/models/web_extract_response.rb +7 -9
- data/lib/context_dev/models/web_extract_styleguide_params.rb +3 -4
- data/lib/context_dev/models/web_extract_styleguide_response.rb +7 -9
- data/lib/context_dev/models/web_screenshot_params.rb +3 -4
- data/lib/context_dev/models/web_screenshot_response.rb +7 -9
- data/lib/context_dev/models/web_search_response.rb +7 -9
- data/lib/context_dev/models/web_web_crawl_md_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_html_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_html_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_images_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_images_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_md_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_md_response.rb +7 -9
- data/lib/context_dev/models/web_web_scrape_sitemap_params.rb +3 -4
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +7 -9
- data/lib/context_dev/models/webhook_delivery.rb +9 -1
- data/lib/context_dev/models/webhooks/attempt.rb +102 -0
- data/lib/context_dev/models/webhooks/delivery.rb +253 -0
- data/lib/context_dev/models/webhooks/delivery_list_attempts_params.rb +52 -0
- data/lib/context_dev/models/webhooks/delivery_list_attempts_response.rb +65 -0
- data/lib/context_dev/models/webhooks/delivery_list_params.rb +195 -0
- data/lib/context_dev/models/webhooks/delivery_list_response.rb +65 -0
- data/lib/context_dev/models/webhooks/delivery_retrieve_params.rb +36 -0
- data/lib/context_dev/models/webhooks/delivery_retrieve_response.rb +40 -0
- data/lib/context_dev/models/webhooks/delivery_retry_params.rb +48 -0
- data/lib/context_dev/models/webhooks/delivery_retry_response.rb +49 -0
- data/lib/context_dev/models/webhooks/delivery_summary.rb +229 -0
- data/lib/context_dev/models.rb +4 -0
- data/lib/context_dev/resources/batch.rb +4 -2
- data/lib/context_dev/resources/brand.rb +2 -2
- data/lib/context_dev/resources/industry.rb +2 -2
- data/lib/context_dev/resources/parse.rb +1 -1
- data/lib/context_dev/resources/web.rb +8 -8
- data/lib/context_dev/resources/webhooks/deliveries.rb +131 -0
- data/lib/context_dev/resources/webhooks.rb +19 -0
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +14 -0
- data/rbi/context_dev/client.rbi +3 -0
- data/rbi/context_dev/models/ai_extract_product_response.rbi +7 -10
- data/rbi/context_dev/models/ai_extract_products_response.rbi +7 -10
- data/rbi/context_dev/models/batch_cancel_response.rbi +4 -4
- data/rbi/context_dev/models/batch_delete_response.rbi +7 -10
- data/rbi/context_dev/models/batch_get_results_response.rbi +7 -10
- data/rbi/context_dev/models/batch_list_response.rbi +7 -10
- data/rbi/context_dev/models/batch_retrieve_response.rbi +19 -7
- data/rbi/context_dev/models/batch_submit_params.rbi +59 -2
- data/rbi/context_dev/models/batch_submit_response.rbi +4 -4
- data/rbi/context_dev/models/brand_retrieve_response.rbi +7 -10
- data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +4 -6
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +7 -10
- data/rbi/context_dev/models/brand_search_params.rbi +4 -6
- data/rbi/context_dev/models/brand_search_response.rbi +7 -10
- data/rbi/context_dev/models/industry_retrieve_naics_params.rbi +4 -6
- data/rbi/context_dev/models/industry_retrieve_naics_response.rbi +7 -10
- data/rbi/context_dev/models/industry_retrieve_sic_params.rbi +4 -6
- data/rbi/context_dev/models/industry_retrieve_sic_response.rbi +7 -10
- data/rbi/context_dev/models/monitor_create_params.rbi +13 -2
- data/rbi/context_dev/models/monitor_create_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_list_account_runs_response.rbi +14 -3
- data/rbi/context_dev/models/monitor_list_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_list_runs_response.rbi +14 -3
- data/rbi/context_dev/models/monitor_retrieve_response.rbi +11 -0
- data/rbi/context_dev/models/monitor_update_params.rbi +13 -2
- data/rbi/context_dev/models/monitor_update_response.rbi +11 -0
- data/rbi/context_dev/models/news_search_response.rbi +7 -10
- data/rbi/context_dev/models/parse_handle_params.rbi +4 -6
- data/rbi/context_dev/models/parse_handle_response.rbi +7 -10
- data/rbi/context_dev/models/person_enrich_response.rbi +7 -10
- data/rbi/context_dev/models/retry_config.rbi +35 -0
- data/rbi/context_dev/models/utility_prefetch_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_competitors_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_competitors_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_fonts_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_fonts_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_response.rbi +7 -10
- data/rbi/context_dev/models/web_extract_styleguide_params.rbi +4 -6
- data/rbi/context_dev/models/web_extract_styleguide_response.rbi +7 -10
- data/rbi/context_dev/models/web_screenshot_params.rbi +4 -6
- data/rbi/context_dev/models/web_screenshot_response.rbi +7 -10
- data/rbi/context_dev/models/web_search_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_crawl_md_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_html_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +7 -10
- data/rbi/context_dev/models/web_web_scrape_sitemap_params.rbi +4 -6
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +7 -10
- data/rbi/context_dev/models/webhook_delivery.rbi +14 -3
- data/rbi/context_dev/models/webhooks/attempt.rbi +160 -0
- data/rbi/context_dev/models/webhooks/delivery.rbi +471 -0
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_params.rbi +83 -0
- data/rbi/context_dev/models/webhooks/delivery_list_attempts_response.rbi +123 -0
- data/rbi/context_dev/models/webhooks/delivery_list_params.rbi +427 -0
- data/rbi/context_dev/models/webhooks/delivery_list_response.rbi +123 -0
- data/rbi/context_dev/models/webhooks/delivery_retrieve_params.rbi +61 -0
- data/rbi/context_dev/models/webhooks/delivery_retrieve_response.rbi +99 -0
- data/rbi/context_dev/models/webhooks/delivery_retry_params.rbi +81 -0
- data/rbi/context_dev/models/webhooks/delivery_retry_response.rbi +107 -0
- data/rbi/context_dev/models/webhooks/delivery_summary.rbi +459 -0
- data/rbi/context_dev/models.rbi +4 -0
- data/rbi/context_dev/resources/batch.rbi +6 -1
- data/rbi/context_dev/resources/brand.rbi +4 -6
- data/rbi/context_dev/resources/industry.rbi +4 -6
- data/rbi/context_dev/resources/parse.rbi +2 -3
- data/rbi/context_dev/resources/web.rbi +16 -24
- data/rbi/context_dev/resources/webhooks/deliveries.rbi +95 -0
- data/rbi/context_dev/resources/webhooks.rbi +16 -0
- data/sig/context_dev/client.rbs +2 -0
- data/sig/context_dev/models/batch_retrieve_response.rbs +10 -3
- data/sig/context_dev/models/batch_submit_params.rbs +23 -0
- data/sig/context_dev/models/monitor_create_params.rbs +8 -1
- data/sig/context_dev/models/monitor_create_response.rbs +7 -0
- data/sig/context_dev/models/monitor_list_account_runs_response.rbs +10 -3
- data/sig/context_dev/models/monitor_list_response.rbs +7 -0
- data/sig/context_dev/models/monitor_list_runs_response.rbs +10 -3
- data/sig/context_dev/models/monitor_retrieve_response.rbs +7 -0
- data/sig/context_dev/models/monitor_update_params.rbs +8 -1
- data/sig/context_dev/models/monitor_update_response.rbs +7 -0
- data/sig/context_dev/models/retry_config.rbs +15 -0
- data/sig/context_dev/models/webhook_delivery.rbs +10 -3
- data/sig/context_dev/models/webhooks/attempt.rbs +76 -0
- data/sig/context_dev/models/webhooks/delivery.rbs +208 -0
- data/sig/context_dev/models/webhooks/delivery_list_attempts_params.rbs +49 -0
- data/sig/context_dev/models/webhooks/delivery_list_attempts_response.rbs +60 -0
- data/sig/context_dev/models/webhooks/delivery_list_params.rbs +207 -0
- data/sig/context_dev/models/webhooks/delivery_list_response.rbs +60 -0
- data/sig/context_dev/models/webhooks/delivery_retrieve_params.rbs +32 -0
- data/sig/context_dev/models/webhooks/delivery_retrieve_response.rbs +45 -0
- data/sig/context_dev/models/webhooks/delivery_retry_params.rbs +49 -0
- data/sig/context_dev/models/webhooks/delivery_retry_response.rbs +50 -0
- data/sig/context_dev/models/webhooks/delivery_summary.rbs +193 -0
- data/sig/context_dev/models.rbs +4 -0
- data/sig/context_dev/resources/batch.rbs +1 -0
- data/sig/context_dev/resources/webhooks/deliveries.rbs +36 -0
- data/sig/context_dev/resources/webhooks.rbs +9 -0
- metadata +44 -2
|
@@ -0,0 +1,35 @@
|
|
|
1
|
+
# typed: strong
|
|
2
|
+
|
|
3
|
+
module ContextDev
|
|
4
|
+
module Models
|
|
5
|
+
class RetryConfig < ContextDev::Internal::Type::BaseModel
|
|
6
|
+
OrHash =
|
|
7
|
+
T.type_alias do
|
|
8
|
+
T.any(ContextDev::RetryConfig, ContextDev::Internal::AnyHash)
|
|
9
|
+
end
|
|
10
|
+
|
|
11
|
+
# Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
|
|
12
|
+
# retries.
|
|
13
|
+
sig { returns(T.nilable(T::Array[Integer])) }
|
|
14
|
+
attr_reader :delays_seconds
|
|
15
|
+
|
|
16
|
+
sig { params(delays_seconds: T::Array[Integer]).void }
|
|
17
|
+
attr_writer :delays_seconds
|
|
18
|
+
|
|
19
|
+
# Webhook retry settings. Use {} for the default schedule.
|
|
20
|
+
sig do
|
|
21
|
+
params(delays_seconds: T::Array[Integer]).returns(T.attached_class)
|
|
22
|
+
end
|
|
23
|
+
def self.new(
|
|
24
|
+
# Retry delays in seconds, totaling at most 72 hours. Use [] to disable automatic
|
|
25
|
+
# retries.
|
|
26
|
+
delays_seconds: nil
|
|
27
|
+
)
|
|
28
|
+
end
|
|
29
|
+
|
|
30
|
+
sig { override.returns({ delays_seconds: T::Array[Integer] }) }
|
|
31
|
+
def to_hash
|
|
32
|
+
end
|
|
33
|
+
end
|
|
34
|
+
end
|
|
35
|
+
end
|
|
@@ -18,8 +18,7 @@ module ContextDev
|
|
|
18
18
|
sig { params(domain: String).void }
|
|
19
19
|
attr_writer :domain
|
|
20
20
|
|
|
21
|
-
#
|
|
22
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
21
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
23
22
|
sig do
|
|
24
23
|
returns(
|
|
25
24
|
T.nilable(ContextDev::Models::UtilityPrefetchResponse::KeyMetadata)
|
|
@@ -79,8 +78,7 @@ module ContextDev
|
|
|
79
78
|
def self.new(
|
|
80
79
|
# The domain that was queued for prefetching
|
|
81
80
|
domain: nil,
|
|
82
|
-
#
|
|
83
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
81
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
84
82
|
key_metadata: nil,
|
|
85
83
|
# Success message
|
|
86
84
|
message: nil,
|
|
@@ -116,25 +114,24 @@ module ContextDev
|
|
|
116
114
|
)
|
|
117
115
|
end
|
|
118
116
|
|
|
119
|
-
#
|
|
117
|
+
# Credits used by this request.
|
|
120
118
|
sig { returns(Integer) }
|
|
121
119
|
attr_accessor :credits_consumed
|
|
122
120
|
|
|
123
|
-
#
|
|
121
|
+
# Credits remaining for your organization.
|
|
124
122
|
sig { returns(Integer) }
|
|
125
123
|
attr_accessor :credits_remaining
|
|
126
124
|
|
|
127
|
-
#
|
|
128
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
125
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
129
126
|
sig do
|
|
130
127
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
131
128
|
T.attached_class
|
|
132
129
|
)
|
|
133
130
|
end
|
|
134
131
|
def self.new(
|
|
135
|
-
#
|
|
132
|
+
# Credits used by this request.
|
|
136
133
|
credits_consumed:,
|
|
137
|
-
#
|
|
134
|
+
# Credits remaining for your organization.
|
|
138
135
|
credits_remaining:
|
|
139
136
|
)
|
|
140
137
|
end
|
|
@@ -26,9 +26,8 @@ module ContextDev
|
|
|
26
26
|
sig { params(num_competitors: Integer).void }
|
|
27
27
|
attr_writer :num_competitors
|
|
28
28
|
|
|
29
|
-
#
|
|
30
|
-
#
|
|
31
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
29
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
30
|
+
# characters.
|
|
32
31
|
sig { returns(T.nilable(T::Array[String])) }
|
|
33
32
|
attr_reader :tags
|
|
34
33
|
|
|
@@ -59,9 +58,8 @@ module ContextDev
|
|
|
59
58
|
domain:,
|
|
60
59
|
# Exact number of direct competitors to return. Defaults to 5.
|
|
61
60
|
num_competitors: nil,
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
61
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
62
|
+
# characters.
|
|
65
63
|
tags: nil,
|
|
66
64
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
67
65
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -45,8 +45,7 @@ module ContextDev
|
|
|
45
45
|
end
|
|
46
46
|
attr_writer :target
|
|
47
47
|
|
|
48
|
-
#
|
|
49
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
48
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
50
49
|
sig do
|
|
51
50
|
returns(
|
|
52
51
|
T.nilable(
|
|
@@ -88,8 +87,7 @@ module ContextDev
|
|
|
88
87
|
status:,
|
|
89
88
|
# Target company profile inferred from the landing page.
|
|
90
89
|
target:,
|
|
91
|
-
#
|
|
92
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
90
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
93
91
|
key_metadata: nil
|
|
94
92
|
)
|
|
95
93
|
end
|
|
@@ -328,25 +326,24 @@ module ContextDev
|
|
|
328
326
|
)
|
|
329
327
|
end
|
|
330
328
|
|
|
331
|
-
#
|
|
329
|
+
# Credits used by this request.
|
|
332
330
|
sig { returns(Integer) }
|
|
333
331
|
attr_accessor :credits_consumed
|
|
334
332
|
|
|
335
|
-
#
|
|
333
|
+
# Credits remaining for your organization.
|
|
336
334
|
sig { returns(Integer) }
|
|
337
335
|
attr_accessor :credits_remaining
|
|
338
336
|
|
|
339
|
-
#
|
|
340
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
337
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
341
338
|
sig do
|
|
342
339
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
343
340
|
T.attached_class
|
|
344
341
|
)
|
|
345
342
|
end
|
|
346
343
|
def self.new(
|
|
347
|
-
#
|
|
344
|
+
# Credits used by this request.
|
|
348
345
|
credits_consumed:,
|
|
349
|
-
#
|
|
346
|
+
# Credits remaining for your organization.
|
|
350
347
|
credits_remaining:
|
|
351
348
|
)
|
|
352
349
|
end
|
|
@@ -39,9 +39,8 @@ module ContextDev
|
|
|
39
39
|
sig { returns(T.nilable(Integer)) }
|
|
40
40
|
attr_accessor :max_age_ms
|
|
41
41
|
|
|
42
|
-
#
|
|
43
|
-
#
|
|
44
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
42
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
43
|
+
# characters.
|
|
45
44
|
sig { returns(T.nilable(T::Array[String])) }
|
|
46
45
|
attr_reader :tags
|
|
47
46
|
|
|
@@ -81,9 +80,8 @@ module ContextDev
|
|
|
81
80
|
# are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
|
|
82
81
|
# year.
|
|
83
82
|
max_age_ms: nil,
|
|
84
|
-
#
|
|
85
|
-
#
|
|
86
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
83
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
84
|
+
# characters.
|
|
87
85
|
tags: nil,
|
|
88
86
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
89
87
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -71,8 +71,7 @@ module ContextDev
|
|
|
71
71
|
end
|
|
72
72
|
attr_writer :font_links
|
|
73
73
|
|
|
74
|
-
#
|
|
75
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
74
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
76
75
|
sig do
|
|
77
76
|
returns(
|
|
78
77
|
T.nilable(ContextDev::Models::WebExtractFontsResponse::KeyMetadata)
|
|
@@ -123,8 +122,7 @@ module ContextDev
|
|
|
123
122
|
# names only). Clients match entries in fonts to pick a file URL from files.
|
|
124
123
|
# Omitted when no families resolve to Google or custom @font-face URLs.
|
|
125
124
|
font_links: nil,
|
|
126
|
-
#
|
|
127
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
125
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
128
126
|
key_metadata: nil
|
|
129
127
|
)
|
|
130
128
|
end
|
|
@@ -449,25 +447,24 @@ module ContextDev
|
|
|
449
447
|
)
|
|
450
448
|
end
|
|
451
449
|
|
|
452
|
-
#
|
|
450
|
+
# Credits used by this request.
|
|
453
451
|
sig { returns(Integer) }
|
|
454
452
|
attr_accessor :credits_consumed
|
|
455
453
|
|
|
456
|
-
#
|
|
454
|
+
# Credits remaining for your organization.
|
|
457
455
|
sig { returns(Integer) }
|
|
458
456
|
attr_accessor :credits_remaining
|
|
459
457
|
|
|
460
|
-
#
|
|
461
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
458
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
462
459
|
sig do
|
|
463
460
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
464
461
|
T.attached_class
|
|
465
462
|
)
|
|
466
463
|
end
|
|
467
464
|
def self.new(
|
|
468
|
-
#
|
|
465
|
+
# Credits used by this request.
|
|
469
466
|
credits_consumed:,
|
|
470
|
-
#
|
|
467
|
+
# Credits remaining for your organization.
|
|
471
468
|
credits_remaining:
|
|
472
469
|
)
|
|
473
470
|
end
|
|
@@ -51,8 +51,7 @@ module ContextDev
|
|
|
51
51
|
sig { returns(T::Array[String]) }
|
|
52
52
|
attr_accessor :urls_analyzed
|
|
53
53
|
|
|
54
|
-
#
|
|
55
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
54
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
56
55
|
sig do
|
|
57
56
|
returns(T.nilable(ContextDev::Models::WebExtractResponse::KeyMetadata))
|
|
58
57
|
end
|
|
@@ -93,8 +92,7 @@ module ContextDev
|
|
|
93
92
|
url:,
|
|
94
93
|
# List of URLs whose Markdown was used for extraction
|
|
95
94
|
urls_analyzed:,
|
|
96
|
-
#
|
|
97
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
95
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
98
96
|
key_metadata: nil
|
|
99
97
|
)
|
|
100
98
|
end
|
|
@@ -456,25 +454,24 @@ module ContextDev
|
|
|
456
454
|
)
|
|
457
455
|
end
|
|
458
456
|
|
|
459
|
-
#
|
|
457
|
+
# Credits used by this request.
|
|
460
458
|
sig { returns(Integer) }
|
|
461
459
|
attr_accessor :credits_consumed
|
|
462
460
|
|
|
463
|
-
#
|
|
461
|
+
# Credits remaining for your organization.
|
|
464
462
|
sig { returns(Integer) }
|
|
465
463
|
attr_accessor :credits_remaining
|
|
466
464
|
|
|
467
|
-
#
|
|
468
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
465
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
469
466
|
sig do
|
|
470
467
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
471
468
|
T.attached_class
|
|
472
469
|
)
|
|
473
470
|
end
|
|
474
471
|
def self.new(
|
|
475
|
-
#
|
|
472
|
+
# Credits used by this request.
|
|
476
473
|
credits_consumed:,
|
|
477
|
-
#
|
|
474
|
+
# Credits remaining for your organization.
|
|
478
475
|
credits_remaining:
|
|
479
476
|
)
|
|
480
477
|
end
|
|
@@ -59,9 +59,8 @@ module ContextDev
|
|
|
59
59
|
sig { returns(T.nilable(Integer)) }
|
|
60
60
|
attr_accessor :max_age_ms
|
|
61
61
|
|
|
62
|
-
#
|
|
63
|
-
#
|
|
64
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
62
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
63
|
+
# characters.
|
|
65
64
|
sig { returns(T.nilable(T::Array[String])) }
|
|
66
65
|
attr_reader :tags
|
|
67
66
|
|
|
@@ -107,9 +106,8 @@ module ContextDev
|
|
|
107
106
|
# are clamped to 1 day; values above 1 year (31536000000 ms) are clamped to 1
|
|
108
107
|
# year.
|
|
109
108
|
max_age_ms: nil,
|
|
110
|
-
#
|
|
111
|
-
#
|
|
112
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
109
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
110
|
+
# characters.
|
|
113
111
|
tags: nil,
|
|
114
112
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
115
113
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -41,8 +41,7 @@ module ContextDev
|
|
|
41
41
|
sig { params(domain: String).void }
|
|
42
42
|
attr_writer :domain
|
|
43
43
|
|
|
44
|
-
#
|
|
45
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
44
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
46
45
|
sig do
|
|
47
46
|
returns(
|
|
48
47
|
T.nilable(
|
|
@@ -107,8 +106,7 @@ module ContextDev
|
|
|
107
106
|
code: nil,
|
|
108
107
|
# The normalized domain that was processed
|
|
109
108
|
domain: nil,
|
|
110
|
-
#
|
|
111
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
109
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
112
110
|
key_metadata: nil,
|
|
113
111
|
# Status of the response, e.g., 'ok'
|
|
114
112
|
status: nil,
|
|
@@ -239,25 +237,24 @@ module ContextDev
|
|
|
239
237
|
)
|
|
240
238
|
end
|
|
241
239
|
|
|
242
|
-
#
|
|
240
|
+
# Credits used by this request.
|
|
243
241
|
sig { returns(Integer) }
|
|
244
242
|
attr_accessor :credits_consumed
|
|
245
243
|
|
|
246
|
-
#
|
|
244
|
+
# Credits remaining for your organization.
|
|
247
245
|
sig { returns(Integer) }
|
|
248
246
|
attr_accessor :credits_remaining
|
|
249
247
|
|
|
250
|
-
#
|
|
251
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
248
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
252
249
|
sig do
|
|
253
250
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
254
251
|
T.attached_class
|
|
255
252
|
)
|
|
256
253
|
end
|
|
257
254
|
def self.new(
|
|
258
|
-
#
|
|
255
|
+
# Credits used by this request.
|
|
259
256
|
credits_consumed:,
|
|
260
|
-
#
|
|
257
|
+
# Credits remaining for your organization.
|
|
261
258
|
credits_remaining:
|
|
262
259
|
)
|
|
263
260
|
end
|
|
@@ -123,9 +123,8 @@ module ContextDev
|
|
|
123
123
|
sig { returns(T.nilable(Integer)) }
|
|
124
124
|
attr_accessor :scroll_offset
|
|
125
125
|
|
|
126
|
-
#
|
|
127
|
-
#
|
|
128
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
126
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
127
|
+
# characters.
|
|
129
128
|
sig { returns(T.nilable(T::Array[String])) }
|
|
130
129
|
attr_reader :tags
|
|
131
130
|
|
|
@@ -233,9 +232,8 @@ module ContextDev
|
|
|
233
232
|
# top to bottom). The final slice may be shorter than the viewport height. Takes
|
|
234
233
|
# precedence over fullScreenshot. Max: 100000.
|
|
235
234
|
scroll_offset: nil,
|
|
236
|
-
#
|
|
237
|
-
#
|
|
238
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
235
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
236
|
+
# characters.
|
|
239
237
|
tags: nil,
|
|
240
238
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
241
239
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -46,8 +46,7 @@ module ContextDev
|
|
|
46
46
|
sig { params(height: Integer).void }
|
|
47
47
|
attr_writer :height
|
|
48
48
|
|
|
49
|
-
#
|
|
50
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
49
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
51
50
|
sig do
|
|
52
51
|
returns(
|
|
53
52
|
T.nilable(ContextDev::Models::WebScreenshotResponse::KeyMetadata)
|
|
@@ -130,8 +129,7 @@ module ContextDev
|
|
|
130
129
|
domain: nil,
|
|
131
130
|
# Height in pixels of the returned screenshot image
|
|
132
131
|
height: nil,
|
|
133
|
-
#
|
|
134
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
132
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
135
133
|
key_metadata: nil,
|
|
136
134
|
# Public image URL for standard requests, or an in-memory data URL when ZDR is
|
|
137
135
|
# enabled.
|
|
@@ -270,25 +268,24 @@ module ContextDev
|
|
|
270
268
|
)
|
|
271
269
|
end
|
|
272
270
|
|
|
273
|
-
#
|
|
271
|
+
# Credits used by this request.
|
|
274
272
|
sig { returns(Integer) }
|
|
275
273
|
attr_accessor :credits_consumed
|
|
276
274
|
|
|
277
|
-
#
|
|
275
|
+
# Credits remaining for your organization.
|
|
278
276
|
sig { returns(Integer) }
|
|
279
277
|
attr_accessor :credits_remaining
|
|
280
278
|
|
|
281
|
-
#
|
|
282
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
279
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
283
280
|
sig do
|
|
284
281
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
285
282
|
T.attached_class
|
|
286
283
|
)
|
|
287
284
|
end
|
|
288
285
|
def self.new(
|
|
289
|
-
#
|
|
286
|
+
# Credits used by this request.
|
|
290
287
|
credits_consumed:,
|
|
291
|
-
#
|
|
288
|
+
# Credits remaining for your organization.
|
|
292
289
|
credits_remaining:
|
|
293
290
|
)
|
|
294
291
|
end
|
|
@@ -32,8 +32,7 @@ module ContextDev
|
|
|
32
32
|
sig { returns(T::Array[ContextDev::Models::WebSearchResponse::Result]) }
|
|
33
33
|
attr_accessor :results
|
|
34
34
|
|
|
35
|
-
#
|
|
36
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
35
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
37
36
|
sig do
|
|
38
37
|
returns(T.nilable(ContextDev::Models::WebSearchResponse::KeyMetadata))
|
|
39
38
|
end
|
|
@@ -66,8 +65,7 @@ module ContextDev
|
|
|
66
65
|
# Echo of the original query (useful when fanout was enabled).
|
|
67
66
|
query:,
|
|
68
67
|
results:,
|
|
69
|
-
#
|
|
70
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
68
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
71
69
|
key_metadata: nil
|
|
72
70
|
)
|
|
73
71
|
end
|
|
@@ -419,25 +417,24 @@ module ContextDev
|
|
|
419
417
|
)
|
|
420
418
|
end
|
|
421
419
|
|
|
422
|
-
#
|
|
420
|
+
# Credits used by this request.
|
|
423
421
|
sig { returns(Integer) }
|
|
424
422
|
attr_accessor :credits_consumed
|
|
425
423
|
|
|
426
|
-
#
|
|
424
|
+
# Credits remaining for your organization.
|
|
427
425
|
sig { returns(Integer) }
|
|
428
426
|
attr_accessor :credits_remaining
|
|
429
427
|
|
|
430
|
-
#
|
|
431
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
428
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
432
429
|
sig do
|
|
433
430
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
434
431
|
T.attached_class
|
|
435
432
|
)
|
|
436
433
|
end
|
|
437
434
|
def self.new(
|
|
438
|
-
#
|
|
435
|
+
# Credits used by this request.
|
|
439
436
|
credits_consumed:,
|
|
440
|
-
#
|
|
437
|
+
# Credits remaining for your organization.
|
|
441
438
|
credits_remaining:
|
|
442
439
|
)
|
|
443
440
|
end
|
|
@@ -40,8 +40,7 @@ module ContextDev
|
|
|
40
40
|
end
|
|
41
41
|
attr_accessor :results
|
|
42
42
|
|
|
43
|
-
#
|
|
44
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
43
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
45
44
|
sig do
|
|
46
45
|
returns(
|
|
47
46
|
T.nilable(ContextDev::Models::WebWebCrawlMdResponse::KeyMetadata)
|
|
@@ -75,8 +74,7 @@ module ContextDev
|
|
|
75
74
|
cache_metadata:,
|
|
76
75
|
metadata:,
|
|
77
76
|
results:,
|
|
78
|
-
#
|
|
79
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
77
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
80
78
|
key_metadata: nil
|
|
81
79
|
)
|
|
82
80
|
end
|
|
@@ -875,25 +873,24 @@ module ContextDev
|
|
|
875
873
|
)
|
|
876
874
|
end
|
|
877
875
|
|
|
878
|
-
#
|
|
876
|
+
# Credits used by this request.
|
|
879
877
|
sig { returns(Integer) }
|
|
880
878
|
attr_accessor :credits_consumed
|
|
881
879
|
|
|
882
|
-
#
|
|
880
|
+
# Credits remaining for your organization.
|
|
883
881
|
sig { returns(Integer) }
|
|
884
882
|
attr_accessor :credits_remaining
|
|
885
883
|
|
|
886
|
-
#
|
|
887
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
884
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
888
885
|
sig do
|
|
889
886
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
890
887
|
T.attached_class
|
|
891
888
|
)
|
|
892
889
|
end
|
|
893
890
|
def self.new(
|
|
894
|
-
#
|
|
891
|
+
# Credits used by this request.
|
|
895
892
|
credits_consumed:,
|
|
896
|
-
#
|
|
893
|
+
# Credits remaining for your organization.
|
|
897
894
|
credits_remaining:
|
|
898
895
|
)
|
|
899
896
|
end
|
|
@@ -103,9 +103,8 @@ module ContextDev
|
|
|
103
103
|
sig { params(settle_animations: T::Boolean).void }
|
|
104
104
|
attr_writer :settle_animations
|
|
105
105
|
|
|
106
|
-
#
|
|
107
|
-
#
|
|
108
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
106
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
107
|
+
# characters.
|
|
109
108
|
sig { returns(T.nilable(T::Array[String])) }
|
|
110
109
|
attr_reader :tags
|
|
111
110
|
|
|
@@ -212,9 +211,8 @@ module ContextDev
|
|
|
212
211
|
# extracting HTML. Defaults to false. This adds a bit of latency in exchange for
|
|
213
212
|
# more stable output on animated pages.
|
|
214
213
|
settle_animations: nil,
|
|
215
|
-
#
|
|
216
|
-
#
|
|
217
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
214
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
215
|
+
# characters.
|
|
218
216
|
tags: nil,
|
|
219
217
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
220
218
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|
|
@@ -98,8 +98,7 @@ module ContextDev
|
|
|
98
98
|
sig { params(actions_html_stale: T::Boolean).void }
|
|
99
99
|
attr_writer :actions_html_stale
|
|
100
100
|
|
|
101
|
-
#
|
|
102
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
101
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
103
102
|
sig do
|
|
104
103
|
returns(
|
|
105
104
|
T.nilable(ContextDev::Models::WebWebScrapeHTMLResponse::KeyMetadata)
|
|
@@ -160,8 +159,7 @@ module ContextDev
|
|
|
160
159
|
# True when an action was applied but the returned content could not be refreshed
|
|
161
160
|
# afterward.
|
|
162
161
|
actions_html_stale: nil,
|
|
163
|
-
#
|
|
164
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
162
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
165
163
|
key_metadata: nil
|
|
166
164
|
)
|
|
167
165
|
end
|
|
@@ -1080,25 +1078,24 @@ module ContextDev
|
|
|
1080
1078
|
)
|
|
1081
1079
|
end
|
|
1082
1080
|
|
|
1083
|
-
#
|
|
1081
|
+
# Credits used by this request.
|
|
1084
1082
|
sig { returns(Integer) }
|
|
1085
1083
|
attr_accessor :credits_consumed
|
|
1086
1084
|
|
|
1087
|
-
#
|
|
1085
|
+
# Credits remaining for your organization.
|
|
1088
1086
|
sig { returns(Integer) }
|
|
1089
1087
|
attr_accessor :credits_remaining
|
|
1090
1088
|
|
|
1091
|
-
#
|
|
1092
|
-
# whenever a valid API key is provided, even when the response status is not 200.
|
|
1089
|
+
# Credit usage, included whenever a valid API key is provided.
|
|
1093
1090
|
sig do
|
|
1094
1091
|
params(credits_consumed: Integer, credits_remaining: Integer).returns(
|
|
1095
1092
|
T.attached_class
|
|
1096
1093
|
)
|
|
1097
1094
|
end
|
|
1098
1095
|
def self.new(
|
|
1099
|
-
#
|
|
1096
|
+
# Credits used by this request.
|
|
1100
1097
|
credits_consumed:,
|
|
1101
|
-
#
|
|
1098
|
+
# Credits remaining for your organization.
|
|
1102
1099
|
credits_remaining:
|
|
1103
1100
|
)
|
|
1104
1101
|
end
|
|
@@ -75,9 +75,8 @@ module ContextDev
|
|
|
75
75
|
sig { returns(T.nilable(Integer)) }
|
|
76
76
|
attr_accessor :max_age_ms
|
|
77
77
|
|
|
78
|
-
#
|
|
79
|
-
#
|
|
80
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
78
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
79
|
+
# characters.
|
|
81
80
|
sig { returns(T.nilable(T::Array[String])) }
|
|
82
81
|
attr_reader :tags
|
|
83
82
|
|
|
@@ -144,9 +143,8 @@ module ContextDev
|
|
|
144
143
|
# Reuse a cached result this many milliseconds old or newer. Default: 86400000 (1
|
|
145
144
|
# day). Set to 0 to bypass cache. Maximum: 2592000000 (30 days).
|
|
146
145
|
max_age_ms: nil,
|
|
147
|
-
#
|
|
148
|
-
#
|
|
149
|
-
# dashboard usage page. Up to 20 tags, each 1-50 characters.
|
|
146
|
+
# Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
|
|
147
|
+
# characters.
|
|
150
148
|
tags: nil,
|
|
151
149
|
# Optional timeout in milliseconds for the request. If the request takes longer
|
|
152
150
|
# than this value, it will be aborted with a 408 status code. Maximum allowed
|