context.dev 2.18.0 → 2.19.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 +18 -0
- data/README.md +1 -1
- data/lib/context_dev/client.rb +0 -4
- data/lib/context_dev/models/monitor_retrieve_run_params.rb +26 -0
- data/lib/context_dev/models/monitor_retrieve_run_response.rb +232 -0
- data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +20 -0
- data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +765 -0
- data/lib/context_dev/models/{web_web_scrape_sitemap_params.rb → web_map_urls_params.rb} +14 -14
- data/lib/context_dev/models/web_map_urls_response.rb +123 -0
- data/lib/context_dev/models/web_scrape_params.rb +906 -0
- data/lib/context_dev/models/web_scrape_response.rb +659 -0
- data/lib/context_dev/models/web_screenshot_params.rb +15 -1
- data/lib/context_dev/models/web_screenshot_response.rb +3 -3
- data/lib/context_dev/models.rb +8 -22
- data/lib/context_dev/resources/brand.rb +0 -36
- data/lib/context_dev/resources/monitors.rb +47 -0
- data/lib/context_dev/resources/web.rb +106 -486
- data/lib/context_dev/version.rb +1 -1
- data/lib/context_dev.rb +8 -23
- data/rbi/context_dev/client.rbi +0 -3
- data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +46 -0
- data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +452 -0
- data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +38 -0
- data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +1367 -0
- data/rbi/context_dev/models/{web_web_scrape_sitemap_params.rbi → web_map_urls_params.rbi} +23 -45
- data/rbi/context_dev/models/web_map_urls_response.rbi +226 -0
- data/rbi/context_dev/models/web_scrape_params.rbi +2000 -0
- data/rbi/context_dev/models/{web_web_scrape_html_response.rbi → web_scrape_response.rbi} +539 -510
- data/rbi/context_dev/models/web_screenshot_params.rbi +23 -0
- data/rbi/context_dev/models/web_screenshot_response.rbi +4 -4
- data/rbi/context_dev/models.rbi +9 -24
- data/rbi/context_dev/resources/brand.rbi +0 -35
- data/rbi/context_dev/resources/monitors.rbi +24 -0
- data/rbi/context_dev/resources/web.rbi +135 -654
- data/sig/context_dev/client.rbs +0 -2
- data/sig/context_dev/models/monitor_retrieve_run_params.rbs +28 -0
- data/sig/context_dev/models/monitor_retrieve_run_response.rbs +182 -0
- data/sig/context_dev/models/monitor_rotate_webhook_secret_params.rbs +23 -0
- data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +545 -0
- data/sig/context_dev/models/{web_web_scrape_sitemap_params.rbs → web_map_urls_params.rbs} +22 -22
- data/sig/context_dev/models/web_map_urls_response.rbs +125 -0
- data/sig/context_dev/models/web_scrape_params.rbs +834 -0
- data/sig/context_dev/models/web_scrape_response.rbs +552 -0
- data/sig/context_dev/models/web_screenshot_params.rbs +7 -0
- data/sig/context_dev/models.rbs +8 -22
- data/sig/context_dev/resources/brand.rbs +0 -9
- data/sig/context_dev/resources/monitors.rbs +11 -0
- data/sig/context_dev/resources/web.rbs +30 -128
- metadata +26 -71
- data/lib/context_dev/models/ai_extract_product_params.rb +0 -125
- data/lib/context_dev/models/ai_extract_product_response.rb +0 -402
- data/lib/context_dev/models/ai_extract_products_params.rb +0 -233
- data/lib/context_dev/models/ai_extract_products_response.rb +0 -370
- data/lib/context_dev/models/brand_retrieve_simplified_params.rb +0 -120
- data/lib/context_dev/models/brand_retrieve_simplified_response.rb +0 -441
- data/lib/context_dev/models/web_extract_fonts_params.rb +0 -114
- data/lib/context_dev/models/web_extract_fonts_response.rb +0 -291
- data/lib/context_dev/models/web_extract_params.rb +0 -419
- data/lib/context_dev/models/web_extract_response.rb +0 -287
- data/lib/context_dev/models/web_web_scrape_bytes_params.rb +0 -346
- data/lib/context_dev/models/web_web_scrape_bytes_response.rb +0 -135
- data/lib/context_dev/models/web_web_scrape_html_params.rb +0 -812
- data/lib/context_dev/models/web_web_scrape_html_response.rb +0 -628
- data/lib/context_dev/models/web_web_scrape_images_params.rb +0 -373
- data/lib/context_dev/models/web_web_scrape_images_response.rb +0 -409
- data/lib/context_dev/models/web_web_scrape_md_params.rb +0 -670
- data/lib/context_dev/models/web_web_scrape_md_response.rb +0 -567
- data/lib/context_dev/models/web_web_scrape_screenshot_params.rb +0 -471
- data/lib/context_dev/models/web_web_scrape_screenshot_response.rb +0 -169
- data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +0 -144
- data/lib/context_dev/resources/ai.rb +0 -71
- data/rbi/context_dev/models/ai_extract_product_params.rbi +0 -253
- data/rbi/context_dev/models/ai_extract_product_response.rbi +0 -791
- data/rbi/context_dev/models/ai_extract_products_params.rbi +0 -490
- data/rbi/context_dev/models/ai_extract_products_response.rbi +0 -718
- data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +0 -256
- data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +0 -1040
- data/rbi/context_dev/models/web_extract_fonts_params.rbi +0 -223
- data/rbi/context_dev/models/web_extract_fonts_response.rbi +0 -563
- data/rbi/context_dev/models/web_extract_params.rbi +0 -781
- data/rbi/context_dev/models/web_extract_response.rbi +0 -512
- data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +0 -702
- data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +0 -238
- data/rbi/context_dev/models/web_web_scrape_html_params.rbi +0 -1690
- data/rbi/context_dev/models/web_web_scrape_images_params.rbi +0 -728
- data/rbi/context_dev/models/web_web_scrape_images_response.rbi +0 -910
- data/rbi/context_dev/models/web_web_scrape_md_params.rbi +0 -1052
- data/rbi/context_dev/models/web_web_scrape_md_response.rbi +0 -1088
- data/rbi/context_dev/models/web_web_scrape_screenshot_params.rbi +0 -1580
- data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi +0 -332
- data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +0 -258
- data/rbi/context_dev/resources/ai.rbi +0 -63
- data/sig/context_dev/models/ai_extract_product_params.rbs +0 -106
- data/sig/context_dev/models/ai_extract_product_response.rbs +0 -314
- data/sig/context_dev/models/ai_extract_products_params.rbs +0 -202
- data/sig/context_dev/models/ai_extract_products_response.rbs +0 -293
- data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +0 -104
- data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +0 -413
- data/sig/context_dev/models/web_extract_fonts_params.rbs +0 -93
- data/sig/context_dev/models/web_extract_fonts_response.rbs +0 -230
- data/sig/context_dev/models/web_extract_params.rbs +0 -324
- data/sig/context_dev/models/web_extract_response.rbs +0 -239
- data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +0 -531
- data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +0 -108
- data/sig/context_dev/models/web_web_scrape_html_params.rbs +0 -878
- data/sig/context_dev/models/web_web_scrape_html_response.rbs +0 -525
- data/sig/context_dev/models/web_web_scrape_images_params.rbs +0 -281
- data/sig/context_dev/models/web_web_scrape_images_response.rbs +0 -371
- data/sig/context_dev/models/web_web_scrape_md_params.rbs +0 -758
- data/sig/context_dev/models/web_web_scrape_md_response.rbs +0 -465
- data/sig/context_dev/models/web_web_scrape_screenshot_params.rbs +0 -619
- data/sig/context_dev/models/web_web_scrape_screenshot_response.rbs +0 -127
- data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +0 -117
- data/sig/context_dev/resources/ai.rbs +0 -21
|
@@ -56,8 +56,8 @@ module ContextDev
|
|
|
56
56
|
optional :key_metadata, -> { ContextDev::Models::WebScreenshotResponse::KeyMetadata }
|
|
57
57
|
|
|
58
58
|
# @!attribute screenshot
|
|
59
|
-
# Public image URL for standard requests, or an in-memory data URL when ZDR
|
|
60
|
-
#
|
|
59
|
+
# Public image URL for standard requests, or an in-memory data URL when ZDR or
|
|
60
|
+
# non-empty custom headers are supplied.
|
|
61
61
|
#
|
|
62
62
|
# @return [String, nil]
|
|
63
63
|
optional :screenshot, String
|
|
@@ -100,7 +100,7 @@ module ContextDev
|
|
|
100
100
|
#
|
|
101
101
|
# @param key_metadata [ContextDev::Models::WebScreenshotResponse::KeyMetadata] Credit usage, included whenever a valid API key is provided.
|
|
102
102
|
#
|
|
103
|
-
# @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR
|
|
103
|
+
# @param screenshot [String] Public image URL for standard requests, or an in-memory data URL when ZDR or non
|
|
104
104
|
#
|
|
105
105
|
# @param screenshot_type [Symbol, ContextDev::Models::WebScreenshotResponse::ScreenshotType] Type of screenshot that was captured
|
|
106
106
|
#
|
data/lib/context_dev/models.rb
CHANGED
|
@@ -39,10 +39,6 @@ module ContextDev
|
|
|
39
39
|
mod.define_sorbet_constant!(const) { T.type_alias { mod.to_sorbet_type } }
|
|
40
40
|
end
|
|
41
41
|
|
|
42
|
-
AIExtractProductParams = ContextDev::Models::AIExtractProductParams
|
|
43
|
-
|
|
44
|
-
AIExtractProductsParams = ContextDev::Models::AIExtractProductsParams
|
|
45
|
-
|
|
46
42
|
BatchCancelParams = ContextDev::Models::BatchCancelParams
|
|
47
43
|
|
|
48
44
|
BatchDeleteParams = ContextDev::Models::BatchDeleteParams
|
|
@@ -57,8 +53,6 @@ module ContextDev
|
|
|
57
53
|
|
|
58
54
|
BrandRetrieveParams = ContextDev::Models::BrandRetrieveParams
|
|
59
55
|
|
|
60
|
-
BrandRetrieveSimplifiedParams = ContextDev::Models::BrandRetrieveSimplifiedParams
|
|
61
|
-
|
|
62
56
|
BrandSearchParams = ContextDev::Models::BrandSearchParams
|
|
63
57
|
|
|
64
58
|
CrawlControls = ContextDev::Models::CrawlControls
|
|
@@ -97,6 +91,10 @@ module ContextDev
|
|
|
97
91
|
|
|
98
92
|
MonitorRetrieveParams = ContextDev::Models::MonitorRetrieveParams
|
|
99
93
|
|
|
94
|
+
MonitorRetrieveRunParams = ContextDev::Models::MonitorRetrieveRunParams
|
|
95
|
+
|
|
96
|
+
MonitorRotateWebhookSecretParams = ContextDev::Models::MonitorRotateWebhookSecretParams
|
|
97
|
+
|
|
100
98
|
MonitorRunParams = ContextDev::Models::MonitorRunParams
|
|
101
99
|
|
|
102
100
|
MonitorUpdateParams = ContextDev::Models::MonitorUpdateParams
|
|
@@ -117,31 +115,19 @@ module ContextDev
|
|
|
117
115
|
|
|
118
116
|
WebExtractCompetitorsParams = ContextDev::Models::WebExtractCompetitorsParams
|
|
119
117
|
|
|
120
|
-
WebExtractFontsParams = ContextDev::Models::WebExtractFontsParams
|
|
121
|
-
|
|
122
|
-
WebExtractParams = ContextDev::Models::WebExtractParams
|
|
123
|
-
|
|
124
118
|
WebExtractStyleguideParams = ContextDev::Models::WebExtractStyleguideParams
|
|
125
119
|
|
|
126
120
|
WebhookDelivery = ContextDev::Models::WebhookDelivery
|
|
127
121
|
|
|
128
122
|
Webhooks = ContextDev::Models::Webhooks
|
|
129
123
|
|
|
124
|
+
WebMapURLsParams = ContextDev::Models::WebMapURLsParams
|
|
125
|
+
|
|
126
|
+
WebScrapeParams = ContextDev::Models::WebScrapeParams
|
|
127
|
+
|
|
130
128
|
WebScreenshotParams = ContextDev::Models::WebScreenshotParams
|
|
131
129
|
|
|
132
130
|
WebSearchParams = ContextDev::Models::WebSearchParams
|
|
133
131
|
|
|
134
132
|
WebWebCrawlMdParams = ContextDev::Models::WebWebCrawlMdParams
|
|
135
|
-
|
|
136
|
-
WebWebScrapeBytesParams = ContextDev::Models::WebWebScrapeBytesParams
|
|
137
|
-
|
|
138
|
-
WebWebScrapeHTMLParams = ContextDev::Models::WebWebScrapeHTMLParams
|
|
139
|
-
|
|
140
|
-
WebWebScrapeImagesParams = ContextDev::Models::WebWebScrapeImagesParams
|
|
141
|
-
|
|
142
|
-
WebWebScrapeMdParams = ContextDev::Models::WebWebScrapeMdParams
|
|
143
|
-
|
|
144
|
-
WebWebScrapeScreenshotParams = ContextDev::Models::WebWebScrapeScreenshotParams
|
|
145
|
-
|
|
146
|
-
WebWebScrapeSitemapParams = ContextDev::Models::WebWebScrapeSitemapParams
|
|
147
133
|
end
|
|
@@ -29,42 +29,6 @@ module ContextDev
|
|
|
29
29
|
)
|
|
30
30
|
end
|
|
31
31
|
|
|
32
|
-
# Some parameter documentations has been truncated, see
|
|
33
|
-
# {ContextDev::Models::BrandRetrieveSimplifiedParams} for more details.
|
|
34
|
-
#
|
|
35
|
-
# Returns a simplified version of brand data containing only essential
|
|
36
|
-
# information: domain, title, colors, logos, and backdrops. Optimized for faster
|
|
37
|
-
# responses and reduced data transfer.
|
|
38
|
-
#
|
|
39
|
-
# @overload retrieve_simplified(domain:, max_age_ms: nil, tags: nil, theme: nil, timeout_opts: nil, request_options: {})
|
|
40
|
-
#
|
|
41
|
-
# @param domain [String] Domain name to retrieve simplified brand data for
|
|
42
|
-
#
|
|
43
|
-
# @param max_age_ms [Integer, nil] Maximum age in milliseconds for cached brand data before the API performs a hard
|
|
44
|
-
#
|
|
45
|
-
# @param tags [Array<String>] Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50 charac
|
|
46
|
-
#
|
|
47
|
-
# @param theme [Symbol, ContextDev::Models::BrandRetrieveSimplifiedParams::Theme] Optional theme preference used when selecting brand assets.
|
|
48
|
-
#
|
|
49
|
-
# @param timeout_opts [ContextDev::Models::BrandRetrieveSimplifiedParams::TimeoutOpts] Optional request deadline and behavior on timeout. For GET requests, use timeout
|
|
50
|
-
#
|
|
51
|
-
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
52
|
-
#
|
|
53
|
-
# @return [ContextDev::Models::BrandRetrieveSimplifiedResponse]
|
|
54
|
-
#
|
|
55
|
-
# @see ContextDev::Models::BrandRetrieveSimplifiedParams
|
|
56
|
-
def retrieve_simplified(params)
|
|
57
|
-
parsed, options = ContextDev::BrandRetrieveSimplifiedParams.dump_request(params)
|
|
58
|
-
query = ContextDev::Internal::Util.encode_query_params(parsed)
|
|
59
|
-
@client.request(
|
|
60
|
-
method: :get,
|
|
61
|
-
path: "brand/retrieve-simplified",
|
|
62
|
-
query: query.transform_keys(max_age_ms: "maxAgeMs", timeout_opts: "timeoutOpts"),
|
|
63
|
-
model: ContextDev::Models::BrandRetrieveSimplifiedResponse,
|
|
64
|
-
options: options
|
|
65
|
-
)
|
|
66
|
-
end
|
|
67
|
-
|
|
68
32
|
# Some parameter documentations has been truncated, see
|
|
69
33
|
# {ContextDev::Models::BrandSearchParams} for more details.
|
|
70
34
|
#
|
|
@@ -360,6 +360,53 @@ module ContextDev
|
|
|
360
360
|
)
|
|
361
361
|
end
|
|
362
362
|
|
|
363
|
+
# Fetches one run for a monitor, including lifecycle status, timing, credits
|
|
364
|
+
# charged, and any detected change.
|
|
365
|
+
#
|
|
366
|
+
# @overload retrieve_run(run_id, monitor_id:, request_options: {})
|
|
367
|
+
#
|
|
368
|
+
# @param run_id [String]
|
|
369
|
+
# @param monitor_id [String]
|
|
370
|
+
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
371
|
+
#
|
|
372
|
+
# @return [ContextDev::Models::MonitorRetrieveRunResponse]
|
|
373
|
+
#
|
|
374
|
+
# @see ContextDev::Models::MonitorRetrieveRunParams
|
|
375
|
+
def retrieve_run(run_id, params)
|
|
376
|
+
parsed, options = ContextDev::MonitorRetrieveRunParams.dump_request(params)
|
|
377
|
+
monitor_id =
|
|
378
|
+
parsed.delete(:monitor_id) do
|
|
379
|
+
raise ArgumentError.new("missing required path argument #{_1}")
|
|
380
|
+
end
|
|
381
|
+
@client.request(
|
|
382
|
+
method: :get,
|
|
383
|
+
path: ["monitors/%1$s/runs/%2$s", monitor_id, run_id],
|
|
384
|
+
model: ContextDev::Models::MonitorRetrieveRunResponse,
|
|
385
|
+
options: options
|
|
386
|
+
)
|
|
387
|
+
end
|
|
388
|
+
|
|
389
|
+
# Generates a new signing secret for the monitor's webhook and returns the updated
|
|
390
|
+
# monitor (including the new `webhook.secret`). The previous secret stops signing
|
|
391
|
+
# deliveries immediately, so update your endpoint before rotating.
|
|
392
|
+
#
|
|
393
|
+
# @overload rotate_webhook_secret(monitor_id, request_options: {})
|
|
394
|
+
#
|
|
395
|
+
# @param monitor_id [String]
|
|
396
|
+
# @param request_options [ContextDev::RequestOptions, Hash{Symbol=>Object}, nil]
|
|
397
|
+
#
|
|
398
|
+
# @return [ContextDev::Models::MonitorRotateWebhookSecretResponse]
|
|
399
|
+
#
|
|
400
|
+
# @see ContextDev::Models::MonitorRotateWebhookSecretParams
|
|
401
|
+
def rotate_webhook_secret(monitor_id, params = {})
|
|
402
|
+
@client.request(
|
|
403
|
+
method: :post,
|
|
404
|
+
path: ["monitors/%1$s/webhook/rotate-secret", monitor_id],
|
|
405
|
+
model: ContextDev::Models::MonitorRotateWebhookSecretResponse,
|
|
406
|
+
options: params[:request_options]
|
|
407
|
+
)
|
|
408
|
+
end
|
|
409
|
+
|
|
363
410
|
# Triggers an immediate run of the monitor outside its normal schedule. The run is
|
|
364
411
|
# queued and processed asynchronously.
|
|
365
412
|
#
|