context.dev 2.18.0 → 2.20.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.
Files changed (116) hide show
  1. checksums.yaml +4 -4
  2. data/CHANGELOG.md +220 -0
  3. data/README.md +1 -1
  4. data/lib/context_dev/client.rb +0 -4
  5. data/lib/context_dev/models/monitor_retrieve_run_params.rb +26 -0
  6. data/lib/context_dev/models/monitor_retrieve_run_response.rb +232 -0
  7. data/lib/context_dev/models/monitor_rotate_webhook_secret_params.rb +20 -0
  8. data/lib/context_dev/models/monitor_rotate_webhook_secret_response.rb +765 -0
  9. data/lib/context_dev/models/{web_web_scrape_sitemap_params.rb → web_map_urls_params.rb} +14 -14
  10. data/lib/context_dev/models/web_map_urls_response.rb +123 -0
  11. data/lib/context_dev/models/web_scrape_params.rb +1035 -0
  12. data/lib/context_dev/models/web_scrape_response.rb +974 -0
  13. data/lib/context_dev/models/web_screenshot_params.rb +15 -1
  14. data/lib/context_dev/models/web_screenshot_response.rb +3 -3
  15. data/lib/context_dev/models.rb +8 -22
  16. data/lib/context_dev/resources/brand.rb +0 -36
  17. data/lib/context_dev/resources/monitors.rb +47 -0
  18. data/lib/context_dev/resources/web.rb +118 -486
  19. data/lib/context_dev/version.rb +1 -1
  20. data/lib/context_dev.rb +8 -23
  21. data/rbi/context_dev/client.rbi +0 -3
  22. data/rbi/context_dev/models/monitor_retrieve_run_params.rbi +46 -0
  23. data/rbi/context_dev/models/monitor_retrieve_run_response.rbi +452 -0
  24. data/rbi/context_dev/models/monitor_rotate_webhook_secret_params.rbi +38 -0
  25. data/rbi/context_dev/models/monitor_rotate_webhook_secret_response.rbi +1367 -0
  26. data/rbi/context_dev/models/{web_web_scrape_sitemap_params.rbi → web_map_urls_params.rbi} +23 -45
  27. data/rbi/context_dev/models/web_map_urls_response.rbi +226 -0
  28. data/rbi/context_dev/models/web_scrape_params.rbi +2221 -0
  29. data/rbi/context_dev/models/web_scrape_response.rbi +1874 -0
  30. data/rbi/context_dev/models/web_screenshot_params.rbi +23 -0
  31. data/rbi/context_dev/models/web_screenshot_response.rbi +4 -4
  32. data/rbi/context_dev/models.rbi +9 -24
  33. data/rbi/context_dev/resources/brand.rbi +0 -35
  34. data/rbi/context_dev/resources/monitors.rbi +24 -0
  35. data/rbi/context_dev/resources/web.rbi +152 -654
  36. data/sig/context_dev/client.rbs +0 -2
  37. data/sig/context_dev/models/monitor_retrieve_run_params.rbs +28 -0
  38. data/sig/context_dev/models/monitor_retrieve_run_response.rbs +182 -0
  39. data/sig/context_dev/models/monitor_rotate_webhook_secret_params.rbs +23 -0
  40. data/sig/context_dev/models/monitor_rotate_webhook_secret_response.rbs +545 -0
  41. data/sig/context_dev/models/{web_web_scrape_sitemap_params.rbs → web_map_urls_params.rbs} +22 -22
  42. data/sig/context_dev/models/web_map_urls_response.rbs +125 -0
  43. data/sig/context_dev/models/web_scrape_params.rbs +925 -0
  44. data/sig/context_dev/models/web_scrape_response.rbs +782 -0
  45. data/sig/context_dev/models/web_screenshot_params.rbs +7 -0
  46. data/sig/context_dev/models.rbs +8 -22
  47. data/sig/context_dev/resources/brand.rbs +0 -9
  48. data/sig/context_dev/resources/monitors.rbs +11 -0
  49. data/sig/context_dev/resources/web.rbs +33 -128
  50. metadata +26 -71
  51. data/lib/context_dev/models/ai_extract_product_params.rb +0 -125
  52. data/lib/context_dev/models/ai_extract_product_response.rb +0 -402
  53. data/lib/context_dev/models/ai_extract_products_params.rb +0 -233
  54. data/lib/context_dev/models/ai_extract_products_response.rb +0 -370
  55. data/lib/context_dev/models/brand_retrieve_simplified_params.rb +0 -120
  56. data/lib/context_dev/models/brand_retrieve_simplified_response.rb +0 -441
  57. data/lib/context_dev/models/web_extract_fonts_params.rb +0 -114
  58. data/lib/context_dev/models/web_extract_fonts_response.rb +0 -291
  59. data/lib/context_dev/models/web_extract_params.rb +0 -419
  60. data/lib/context_dev/models/web_extract_response.rb +0 -287
  61. data/lib/context_dev/models/web_web_scrape_bytes_params.rb +0 -346
  62. data/lib/context_dev/models/web_web_scrape_bytes_response.rb +0 -135
  63. data/lib/context_dev/models/web_web_scrape_html_params.rb +0 -812
  64. data/lib/context_dev/models/web_web_scrape_html_response.rb +0 -628
  65. data/lib/context_dev/models/web_web_scrape_images_params.rb +0 -373
  66. data/lib/context_dev/models/web_web_scrape_images_response.rb +0 -409
  67. data/lib/context_dev/models/web_web_scrape_md_params.rb +0 -670
  68. data/lib/context_dev/models/web_web_scrape_md_response.rb +0 -567
  69. data/lib/context_dev/models/web_web_scrape_screenshot_params.rb +0 -471
  70. data/lib/context_dev/models/web_web_scrape_screenshot_response.rb +0 -169
  71. data/lib/context_dev/models/web_web_scrape_sitemap_response.rb +0 -144
  72. data/lib/context_dev/resources/ai.rb +0 -71
  73. data/rbi/context_dev/models/ai_extract_product_params.rbi +0 -253
  74. data/rbi/context_dev/models/ai_extract_product_response.rbi +0 -791
  75. data/rbi/context_dev/models/ai_extract_products_params.rbi +0 -490
  76. data/rbi/context_dev/models/ai_extract_products_response.rbi +0 -718
  77. data/rbi/context_dev/models/brand_retrieve_simplified_params.rbi +0 -256
  78. data/rbi/context_dev/models/brand_retrieve_simplified_response.rbi +0 -1040
  79. data/rbi/context_dev/models/web_extract_fonts_params.rbi +0 -223
  80. data/rbi/context_dev/models/web_extract_fonts_response.rbi +0 -563
  81. data/rbi/context_dev/models/web_extract_params.rbi +0 -781
  82. data/rbi/context_dev/models/web_extract_response.rbi +0 -512
  83. data/rbi/context_dev/models/web_web_scrape_bytes_params.rbi +0 -702
  84. data/rbi/context_dev/models/web_web_scrape_bytes_response.rbi +0 -238
  85. data/rbi/context_dev/models/web_web_scrape_html_params.rbi +0 -1690
  86. data/rbi/context_dev/models/web_web_scrape_html_response.rbi +0 -1287
  87. data/rbi/context_dev/models/web_web_scrape_images_params.rbi +0 -728
  88. data/rbi/context_dev/models/web_web_scrape_images_response.rbi +0 -910
  89. data/rbi/context_dev/models/web_web_scrape_md_params.rbi +0 -1052
  90. data/rbi/context_dev/models/web_web_scrape_md_response.rbi +0 -1088
  91. data/rbi/context_dev/models/web_web_scrape_screenshot_params.rbi +0 -1580
  92. data/rbi/context_dev/models/web_web_scrape_screenshot_response.rbi +0 -332
  93. data/rbi/context_dev/models/web_web_scrape_sitemap_response.rbi +0 -258
  94. data/rbi/context_dev/resources/ai.rbi +0 -63
  95. data/sig/context_dev/models/ai_extract_product_params.rbs +0 -106
  96. data/sig/context_dev/models/ai_extract_product_response.rbs +0 -314
  97. data/sig/context_dev/models/ai_extract_products_params.rbs +0 -202
  98. data/sig/context_dev/models/ai_extract_products_response.rbs +0 -293
  99. data/sig/context_dev/models/brand_retrieve_simplified_params.rbs +0 -104
  100. data/sig/context_dev/models/brand_retrieve_simplified_response.rbs +0 -413
  101. data/sig/context_dev/models/web_extract_fonts_params.rbs +0 -93
  102. data/sig/context_dev/models/web_extract_fonts_response.rbs +0 -230
  103. data/sig/context_dev/models/web_extract_params.rbs +0 -324
  104. data/sig/context_dev/models/web_extract_response.rbs +0 -239
  105. data/sig/context_dev/models/web_web_scrape_bytes_params.rbs +0 -531
  106. data/sig/context_dev/models/web_web_scrape_bytes_response.rbs +0 -108
  107. data/sig/context_dev/models/web_web_scrape_html_params.rbs +0 -878
  108. data/sig/context_dev/models/web_web_scrape_html_response.rbs +0 -525
  109. data/sig/context_dev/models/web_web_scrape_images_params.rbs +0 -281
  110. data/sig/context_dev/models/web_web_scrape_images_response.rbs +0 -371
  111. data/sig/context_dev/models/web_web_scrape_md_params.rbs +0 -758
  112. data/sig/context_dev/models/web_web_scrape_md_response.rbs +0 -465
  113. data/sig/context_dev/models/web_web_scrape_screenshot_params.rbs +0 -619
  114. data/sig/context_dev/models/web_web_scrape_screenshot_response.rbs +0 -127
  115. data/sig/context_dev/models/web_web_scrape_sitemap_response.rbs +0 -117
  116. data/sig/context_dev/resources/ai.rbs +0 -21
@@ -1,1052 +0,0 @@
1
- # typed: strong
2
-
3
- module ContextDev
4
- module Models
5
- class WebWebScrapeMdParams < ContextDev::Internal::Type::BaseModel
6
- extend ContextDev::Internal::Type::RequestParameters::Converter
7
- include ContextDev::Internal::Type::RequestParameters
8
-
9
- OrHash =
10
- T.type_alias do
11
- T.any(ContextDev::WebWebScrapeMdParams, ContextDev::Internal::AnyHash)
12
- end
13
-
14
- # Full URL to scrape into LLM usable Markdown (must include http:// or https://
15
- # protocol)
16
- sig { returns(String) }
17
- attr_accessor :url
18
-
19
- # Optional browser actions executed in array order after the page loads and before
20
- # content is captured. Requires a paid plan. Send a JSON array in the query
21
- # parameter. Maximum: 5 actions.
22
- sig do
23
- returns(
24
- T.nilable(
25
- T::Array[
26
- T.any(
27
- ContextDev::WebWebScrapeMdParams::Action::Wait,
28
- ContextDev::WebWebScrapeMdParams::Action::Perform,
29
- ContextDev::WebWebScrapeMdParams::Action::Scroll
30
- )
31
- ]
32
- )
33
- )
34
- end
35
- attr_accessor :actions
36
-
37
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
38
- # alpha-2).
39
- sig do
40
- returns(T.nilable(ContextDev::WebWebScrapeMdParams::Country::OrSymbol))
41
- end
42
- attr_reader :country
43
-
44
- sig do
45
- params(
46
- country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol
47
- ).void
48
- end
49
- attr_writer :country
50
-
51
- # CSS selectors to remove before conversion to Markdown. Applied after
52
- # includeSelectors. Exclusion takes precedence: an element matching both is
53
- # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]".
54
- sig { returns(T.nilable(T::Array[String])) }
55
- attr_accessor :exclude_selectors
56
-
57
- # Optional outbound HTTP headers forwarded only to the target URL, sent as
58
- # deep-object query params such as headers[X-Custom]=value. When provided, caching
59
- # is bypassed: the result is neither read from nor written to cache.
60
- sig { returns(T.nilable(T::Hash[Symbol, String])) }
61
- attr_reader :headers
62
-
63
- sig { params(headers: T::Hash[Symbol, String]).void }
64
- attr_writer :headers
65
-
66
- # When true, the contents of iframes are rendered to Markdown.
67
- sig { returns(T.nilable(T::Boolean)) }
68
- attr_reader :include_frames
69
-
70
- sig { params(include_frames: T::Boolean).void }
71
- attr_writer :include_frames
72
-
73
- # When true, the response also includes an `html` field with the page HTML the
74
- # Markdown was converted from — the same body the Scrape HTML endpoint returns for
75
- # the equivalent request.
76
- sig { returns(T.nilable(T::Boolean)) }
77
- attr_reader :include_html
78
-
79
- sig { params(include_html: T::Boolean).void }
80
- attr_writer :include_html
81
-
82
- # Include image references in Markdown output
83
- sig { returns(T.nilable(T::Boolean)) }
84
- attr_reader :include_images
85
-
86
- sig { params(include_images: T::Boolean).void }
87
- attr_writer :include_images
88
-
89
- # Preserve hyperlinks in Markdown output
90
- sig { returns(T.nilable(T::Boolean)) }
91
- attr_reader :include_links
92
-
93
- sig { params(include_links: T::Boolean).void }
94
- attr_writer :include_links
95
-
96
- # CSS selectors. When provided, only matching HTML subtrees (and their
97
- # descendants) are kept before conversion to Markdown. When omitted, the entire
98
- # document is kept. Examples: "article.main", "#content", "[role=main]".
99
- sig { returns(T.nilable(T::Array[String])) }
100
- attr_accessor :include_selectors
101
-
102
- # Return a cached result if a prior scrape for the same parameters exists and is
103
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
104
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
105
- sig { returns(T.nilable(Integer)) }
106
- attr_accessor :max_age_ms
107
-
108
- # PDF parsing controls. Use start/end to limit text extraction and embedded-image
109
- # detection/OCR to an inclusive 1-based page range.
110
- sig { returns(T.nilable(ContextDev::WebWebScrapeMdParams::Pdf)) }
111
- attr_reader :pdf
112
-
113
- sig { params(pdf: ContextDev::WebWebScrapeMdParams::Pdf::OrHash).void }
114
- attr_writer :pdf
115
-
116
- # When true, waits briefly for CSS and transition animations to settle before
117
- # converting to Markdown. Defaults to false. This adds a bit of latency in
118
- # exchange for more stable output on animated pages.
119
- sig { returns(T.nilable(T::Boolean)) }
120
- attr_reader :settle_animations
121
-
122
- sig { params(settle_animations: T::Boolean).void }
123
- attr_writer :settle_animations
124
-
125
- # Shorten base64-encoded image data in the Markdown output
126
- sig { returns(T.nilable(T::Boolean)) }
127
- attr_reader :shorten_base64_images
128
-
129
- sig { params(shorten_base64_images: T::Boolean).void }
130
- attr_writer :shorten_base64_images
131
-
132
- # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
133
- # characters.
134
- sig { returns(T.nilable(T::Array[String])) }
135
- attr_reader :tags
136
-
137
- sig { params(tags: T::Array[String]).void }
138
- attr_writer :tags
139
-
140
- # Optional request deadline and behavior on timeout. For GET requests, use
141
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
142
- # timeoutOpts object.
143
- sig { returns(T.nilable(ContextDev::WebWebScrapeMdParams::TimeoutOpts)) }
144
- attr_reader :timeout_opts
145
-
146
- sig do
147
- params(
148
- timeout_opts: ContextDev::WebWebScrapeMdParams::TimeoutOpts::OrHash
149
- ).void
150
- end
151
- attr_writer :timeout_opts
152
-
153
- # Extract only the main content of the page, excluding headers, footers, sidebars,
154
- # and navigation
155
- sig { returns(T.nilable(T::Boolean)) }
156
- attr_reader :use_main_content_only
157
-
158
- sig { params(use_main_content_only: T::Boolean).void }
159
- attr_writer :use_main_content_only
160
-
161
- # Optional browser wait time in milliseconds after initial page load before
162
- # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
163
- # with timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000
164
- # ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
165
- sig { returns(T.nilable(Integer)) }
166
- attr_accessor :wait_for_ms
167
-
168
- # Set to enabled to bypass shared caches and omit request and response content
169
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
170
- # omitted. Requires zero data retention to be enabled for your organization
171
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
172
- # Successful ZDR responses include X-Context-ZDR: true.
173
- sig do
174
- returns(T.nilable(ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol))
175
- end
176
- attr_reader :zdr
177
-
178
- sig { params(zdr: ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol).void }
179
- attr_writer :zdr
180
-
181
- sig do
182
- params(
183
- url: String,
184
- actions:
185
- T.nilable(
186
- T::Array[
187
- T.any(
188
- ContextDev::WebWebScrapeMdParams::Action::Wait::OrHash,
189
- ContextDev::WebWebScrapeMdParams::Action::Perform::OrHash,
190
- ContextDev::WebWebScrapeMdParams::Action::Scroll::OrHash
191
- )
192
- ]
193
- ),
194
- country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol,
195
- exclude_selectors: T.nilable(T::Array[String]),
196
- headers: T::Hash[Symbol, String],
197
- include_frames: T::Boolean,
198
- include_html: T::Boolean,
199
- include_images: T::Boolean,
200
- include_links: T::Boolean,
201
- include_selectors: T.nilable(T::Array[String]),
202
- max_age_ms: T.nilable(Integer),
203
- pdf: ContextDev::WebWebScrapeMdParams::Pdf::OrHash,
204
- settle_animations: T::Boolean,
205
- shorten_base64_images: T::Boolean,
206
- tags: T::Array[String],
207
- timeout_opts: ContextDev::WebWebScrapeMdParams::TimeoutOpts::OrHash,
208
- use_main_content_only: T::Boolean,
209
- wait_for_ms: T.nilable(Integer),
210
- zdr: ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol,
211
- request_options: ContextDev::RequestOptions::OrHash
212
- ).returns(T.attached_class)
213
- end
214
- def self.new(
215
- # Full URL to scrape into LLM usable Markdown (must include http:// or https://
216
- # protocol)
217
- url:,
218
- # Optional browser actions executed in array order after the page loads and before
219
- # content is captured. Requires a paid plan. Send a JSON array in the query
220
- # parameter. Maximum: 5 actions.
221
- actions: nil,
222
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
223
- # alpha-2).
224
- country: nil,
225
- # CSS selectors to remove before conversion to Markdown. Applied after
226
- # includeSelectors. Exclusion takes precedence: an element matching both is
227
- # removed. Examples: "nav", "footer", ".ad-banner", "[aria-hidden=true]".
228
- exclude_selectors: nil,
229
- # Optional outbound HTTP headers forwarded only to the target URL, sent as
230
- # deep-object query params such as headers[X-Custom]=value. When provided, caching
231
- # is bypassed: the result is neither read from nor written to cache.
232
- headers: nil,
233
- # When true, the contents of iframes are rendered to Markdown.
234
- include_frames: nil,
235
- # When true, the response also includes an `html` field with the page HTML the
236
- # Markdown was converted from — the same body the Scrape HTML endpoint returns for
237
- # the equivalent request.
238
- include_html: nil,
239
- # Include image references in Markdown output
240
- include_images: nil,
241
- # Preserve hyperlinks in Markdown output
242
- include_links: nil,
243
- # CSS selectors. When provided, only matching HTML subtrees (and their
244
- # descendants) are kept before conversion to Markdown. When omitted, the entire
245
- # document is kept. Examples: "article.main", "#content", "[role=main]".
246
- include_selectors: nil,
247
- # Return a cached result if a prior scrape for the same parameters exists and is
248
- # younger than this many milliseconds. Defaults to 1 day (86400000 ms) when
249
- # omitted. Max is 30 days (2592000000 ms). Set to 0 to always scrape fresh.
250
- max_age_ms: nil,
251
- # PDF parsing controls. Use start/end to limit text extraction and embedded-image
252
- # detection/OCR to an inclusive 1-based page range.
253
- pdf: nil,
254
- # When true, waits briefly for CSS and transition animations to settle before
255
- # converting to Markdown. Defaults to false. This adds a bit of latency in
256
- # exchange for more stable output on animated pages.
257
- settle_animations: nil,
258
- # Shorten base64-encoded image data in the Markdown output
259
- shorten_base64_images: nil,
260
- # Comma-separated tags for tracking request usage. Up to 20 tags, each 1-50
261
- # characters.
262
- tags: nil,
263
- # Optional request deadline and behavior on timeout. For GET requests, use
264
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
265
- # timeoutOpts object.
266
- timeout_opts: nil,
267
- # Extract only the main content of the page, excluding headers, footers, sidebars,
268
- # and navigation
269
- use_main_content_only: nil,
270
- # Optional browser wait time in milliseconds after initial page load before
271
- # converting the page to Markdown. Min: 0. Max: 30000 (30 seconds). When combined
272
- # with timeoutOpts, timeoutOpts.milliseconds must be at least waitForMs + 10000
273
- # ms; a shorter deadline is rejected with 400 TIMEOUT_TOO_SHORT_FOR_WAIT.
274
- wait_for_ms: nil,
275
- # Set to enabled to bypass shared caches and omit request and response content
276
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
277
- # omitted. Requires zero data retention to be enabled for your organization
278
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
279
- # Successful ZDR responses include X-Context-ZDR: true.
280
- zdr: nil,
281
- request_options: {}
282
- )
283
- end
284
-
285
- sig do
286
- override.returns(
287
- {
288
- url: String,
289
- actions:
290
- T.nilable(
291
- T::Array[
292
- T.any(
293
- ContextDev::WebWebScrapeMdParams::Action::Wait,
294
- ContextDev::WebWebScrapeMdParams::Action::Perform,
295
- ContextDev::WebWebScrapeMdParams::Action::Scroll
296
- )
297
- ]
298
- ),
299
- country: ContextDev::WebWebScrapeMdParams::Country::OrSymbol,
300
- exclude_selectors: T.nilable(T::Array[String]),
301
- headers: T::Hash[Symbol, String],
302
- include_frames: T::Boolean,
303
- include_html: T::Boolean,
304
- include_images: T::Boolean,
305
- include_links: T::Boolean,
306
- include_selectors: T.nilable(T::Array[String]),
307
- max_age_ms: T.nilable(Integer),
308
- pdf: ContextDev::WebWebScrapeMdParams::Pdf,
309
- settle_animations: T::Boolean,
310
- shorten_base64_images: T::Boolean,
311
- tags: T::Array[String],
312
- timeout_opts: ContextDev::WebWebScrapeMdParams::TimeoutOpts,
313
- use_main_content_only: T::Boolean,
314
- wait_for_ms: T.nilable(Integer),
315
- zdr: ContextDev::WebWebScrapeMdParams::Zdr::OrSymbol,
316
- request_options: ContextDev::RequestOptions
317
- }
318
- )
319
- end
320
- def to_hash
321
- end
322
-
323
- # Browser action discriminated by `do`. Each variant exposes only its applicable
324
- # fields.
325
- module Action
326
- extend ContextDev::Internal::Type::Union
327
-
328
- Variants =
329
- T.type_alias do
330
- T.any(
331
- ContextDev::WebWebScrapeMdParams::Action::Wait,
332
- ContextDev::WebWebScrapeMdParams::Action::Perform,
333
- ContextDev::WebWebScrapeMdParams::Action::Scroll
334
- )
335
- end
336
-
337
- class Wait < ContextDev::Internal::Type::BaseModel
338
- OrHash =
339
- T.type_alias do
340
- T.any(
341
- ContextDev::WebWebScrapeMdParams::Action::Wait,
342
- ContextDev::Internal::AnyHash
343
- )
344
- end
345
-
346
- sig { returns(Symbol) }
347
- attr_accessor :do_
348
-
349
- sig { returns(Integer) }
350
- attr_accessor :time_ms
351
-
352
- # Pause for a fixed number of milliseconds before continuing to the next action.
353
- sig do
354
- params(time_ms: Integer, do_: Symbol).returns(T.attached_class)
355
- end
356
- def self.new(time_ms:, do_: :wait)
357
- end
358
-
359
- sig { override.returns({ do_: Symbol, time_ms: Integer }) }
360
- def to_hash
361
- end
362
- end
363
-
364
- class Perform < ContextDev::Internal::Type::BaseModel
365
- OrHash =
366
- T.type_alias do
367
- T.any(
368
- ContextDev::WebWebScrapeMdParams::Action::Perform,
369
- ContextDev::Internal::AnyHash
370
- )
371
- end
372
-
373
- sig { returns(String) }
374
- attr_accessor :action
375
-
376
- sig { returns(Symbol) }
377
- attr_accessor :do_
378
-
379
- # Resolve and perform one natural-language browser action.
380
- sig { params(action: String, do_: Symbol).returns(T.attached_class) }
381
- def self.new(action:, do_: :perform)
382
- end
383
-
384
- sig { override.returns({ action: String, do_: Symbol }) }
385
- def to_hash
386
- end
387
- end
388
-
389
- class Scroll < ContextDev::Internal::Type::BaseModel
390
- OrHash =
391
- T.type_alias do
392
- T.any(
393
- ContextDev::WebWebScrapeMdParams::Action::Scroll,
394
- ContextDev::Internal::AnyHash
395
- )
396
- end
397
-
398
- sig { returns(Symbol) }
399
- attr_accessor :do_
400
-
401
- # Pixels per scroll, one visible viewport, or the current scroll boundary.
402
- # Defaults to viewport.
403
- sig do
404
- returns(
405
- T.nilable(
406
- T.any(
407
- Integer,
408
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::OrSymbol
409
- )
410
- )
411
- )
412
- end
413
- attr_reader :amount
414
-
415
- sig do
416
- params(
417
- amount:
418
- T.any(
419
- Integer,
420
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::OrSymbol
421
- )
422
- ).void
423
- end
424
- attr_writer :amount
425
-
426
- # CSS selector for the first matching scroll container. Defaults to the page.
427
- sig { returns(T.nilable(String)) }
428
- attr_reader :container
429
-
430
- sig { params(container: String).void }
431
- attr_writer :container
432
-
433
- # Direction to scroll. Defaults to down.
434
- sig do
435
- returns(
436
- T.nilable(
437
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::OrSymbol
438
- )
439
- )
440
- end
441
- attr_reader :direction
442
-
443
- sig do
444
- params(
445
- direction:
446
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::OrSymbol
447
- ).void
448
- end
449
- attr_writer :direction
450
-
451
- # Maximum scroll iterations. Stops early when scrolling and scrollable extent stop
452
- # changing. Defaults to 1.
453
- sig { returns(T.nilable(Integer)) }
454
- attr_reader :max_scrolls
455
-
456
- sig { params(max_scrolls: Integer).void }
457
- attr_writer :max_scrolls
458
-
459
- # Scroll the page or a selected scrollable container, waiting adaptively for
460
- # content and dimensions to settle after each iteration.
461
- sig do
462
- params(
463
- amount:
464
- T.any(
465
- Integer,
466
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::OrSymbol
467
- ),
468
- container: String,
469
- direction:
470
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::OrSymbol,
471
- max_scrolls: Integer,
472
- do_: Symbol
473
- ).returns(T.attached_class)
474
- end
475
- def self.new(
476
- # Pixels per scroll, one visible viewport, or the current scroll boundary.
477
- # Defaults to viewport.
478
- amount: nil,
479
- # CSS selector for the first matching scroll container. Defaults to the page.
480
- container: nil,
481
- # Direction to scroll. Defaults to down.
482
- direction: nil,
483
- # Maximum scroll iterations. Stops early when scrolling and scrollable extent stop
484
- # changing. Defaults to 1.
485
- max_scrolls: nil,
486
- do_: :scroll
487
- )
488
- end
489
-
490
- sig do
491
- override.returns(
492
- {
493
- do_: Symbol,
494
- amount:
495
- T.any(
496
- Integer,
497
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::OrSymbol
498
- ),
499
- container: String,
500
- direction:
501
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::OrSymbol,
502
- max_scrolls: Integer
503
- }
504
- )
505
- end
506
- def to_hash
507
- end
508
-
509
- # Pixels per scroll, one visible viewport, or the current scroll boundary.
510
- # Defaults to viewport.
511
- module Amount
512
- extend ContextDev::Internal::Type::Union
513
-
514
- Variants =
515
- T.type_alias do
516
- T.any(
517
- Integer,
518
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::TaggedSymbol
519
- )
520
- end
521
-
522
- sig do
523
- override.returns(
524
- T::Array[
525
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::Variants
526
- ]
527
- )
528
- end
529
- def self.variants
530
- end
531
-
532
- TaggedSymbol =
533
- T.type_alias do
534
- T.all(
535
- Symbol,
536
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount
537
- )
538
- end
539
- OrSymbol = T.type_alias { T.any(Symbol, String) }
540
-
541
- VIEWPORT =
542
- T.let(
543
- :viewport,
544
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::TaggedSymbol
545
- )
546
- MAX =
547
- T.let(
548
- :max,
549
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Amount::TaggedSymbol
550
- )
551
- end
552
-
553
- # Direction to scroll. Defaults to down.
554
- module Direction
555
- extend ContextDev::Internal::Type::Enum
556
-
557
- TaggedSymbol =
558
- T.type_alias do
559
- T.all(
560
- Symbol,
561
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction
562
- )
563
- end
564
- OrSymbol = T.type_alias { T.any(Symbol, String) }
565
-
566
- UP =
567
- T.let(
568
- :up,
569
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::TaggedSymbol
570
- )
571
- DOWN =
572
- T.let(
573
- :down,
574
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::TaggedSymbol
575
- )
576
- LEFT =
577
- T.let(
578
- :left,
579
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::TaggedSymbol
580
- )
581
- RIGHT =
582
- T.let(
583
- :right,
584
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::TaggedSymbol
585
- )
586
-
587
- sig do
588
- override.returns(
589
- T::Array[
590
- ContextDev::WebWebScrapeMdParams::Action::Scroll::Direction::TaggedSymbol
591
- ]
592
- )
593
- end
594
- def self.values
595
- end
596
- end
597
- end
598
-
599
- sig do
600
- override.returns(
601
- T::Array[ContextDev::WebWebScrapeMdParams::Action::Variants]
602
- )
603
- end
604
- def self.variants
605
- end
606
- end
607
-
608
- # Fetch the target page through a residential proxy in this country (ISO 3166-1
609
- # alpha-2).
610
- module Country
611
- extend ContextDev::Internal::Type::Enum
612
-
613
- TaggedSymbol =
614
- T.type_alias do
615
- T.all(Symbol, ContextDev::WebWebScrapeMdParams::Country)
616
- end
617
- OrSymbol = T.type_alias { T.any(Symbol, String) }
618
-
619
- AD = T.let(:ad, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
620
- AE = T.let(:ae, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
621
- AF = T.let(:af, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
622
- AG = T.let(:ag, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
623
- AI = T.let(:ai, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
624
- AL = T.let(:al, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
625
- AM = T.let(:am, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
626
- AO = T.let(:ao, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
627
- AR = T.let(:ar, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
628
- AT = T.let(:at, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
629
- AU = T.let(:au, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
630
- AW = T.let(:aw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
631
- AZ = T.let(:az, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
632
- BA = T.let(:ba, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
633
- BB = T.let(:bb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
634
- BD = T.let(:bd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
635
- BE = T.let(:be, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
636
- BF = T.let(:bf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
637
- BG = T.let(:bg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
638
- BH = T.let(:bh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
639
- BI = T.let(:bi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
640
- BJ = T.let(:bj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
641
- BM = T.let(:bm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
642
- BN = T.let(:bn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
643
- BO = T.let(:bo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
644
- BQ = T.let(:bq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
645
- BR = T.let(:br, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
646
- BS = T.let(:bs, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
647
- BW = T.let(:bw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
648
- BY = T.let(:by, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
649
- BZ = T.let(:bz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
650
- CA = T.let(:ca, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
651
- CD = T.let(:cd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
652
- CF = T.let(:cf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
653
- CG = T.let(:cg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
654
- CH = T.let(:ch, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
655
- CI = T.let(:ci, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
656
- CL = T.let(:cl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
657
- CM = T.let(:cm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
658
- CN = T.let(:cn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
659
- CO = T.let(:co, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
660
- CR = T.let(:cr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
661
- CV = T.let(:cv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
662
- CW = T.let(:cw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
663
- CY = T.let(:cy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
664
- CZ = T.let(:cz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
665
- DE = T.let(:de, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
666
- DJ = T.let(:dj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
667
- DK = T.let(:dk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
668
- DM = T.let(:dm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
669
- DO = T.let(:do, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
670
- DZ = T.let(:dz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
671
- EC = T.let(:ec, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
672
- EE = T.let(:ee, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
673
- EG = T.let(:eg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
674
- ES = T.let(:es, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
675
- ET = T.let(:et, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
676
- FI = T.let(:fi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
677
- FJ = T.let(:fj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
678
- FR = T.let(:fr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
679
- GA = T.let(:ga, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
680
- GB = T.let(:gb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
681
- GD = T.let(:gd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
682
- GE = T.let(:ge, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
683
- GF = T.let(:gf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
684
- GG = T.let(:gg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
685
- GH = T.let(:gh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
686
- GM = T.let(:gm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
687
- GN = T.let(:gn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
688
- GP = T.let(:gp, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
689
- GQ = T.let(:gq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
690
- GR = T.let(:gr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
691
- GT = T.let(:gt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
692
- GU = T.let(:gu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
693
- GW = T.let(:gw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
694
- GY = T.let(:gy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
695
- HK = T.let(:hk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
696
- HN = T.let(:hn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
697
- HR = T.let(:hr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
698
- HT = T.let(:ht, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
699
- HU = T.let(:hu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
700
- ID = T.let(:id, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
701
- IE = T.let(:ie, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
702
- IL = T.let(:il, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
703
- IM = T.let(:im, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
704
- IN = T.let(:in, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
705
- IQ = T.let(:iq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
706
- IR = T.let(:ir, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
707
- IS = T.let(:is, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
708
- IT = T.let(:it, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
709
- JE = T.let(:je, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
710
- JM = T.let(:jm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
711
- JO = T.let(:jo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
712
- JP = T.let(:jp, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
713
- KE = T.let(:ke, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
714
- KG = T.let(:kg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
715
- KH = T.let(:kh, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
716
- KN = T.let(:kn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
717
- KR = T.let(:kr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
718
- KW = T.let(:kw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
719
- KY = T.let(:ky, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
720
- KZ = T.let(:kz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
721
- LA = T.let(:la, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
722
- LB = T.let(:lb, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
723
- LC = T.let(:lc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
724
- LK = T.let(:lk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
725
- LR = T.let(:lr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
726
- LS = T.let(:ls, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
727
- LT = T.let(:lt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
728
- LU = T.let(:lu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
729
- LV = T.let(:lv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
730
- LY = T.let(:ly, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
731
- MA = T.let(:ma, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
732
- MC = T.let(:mc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
733
- MD = T.let(:md, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
734
- ME = T.let(:me, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
735
- MF = T.let(:mf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
736
- MG = T.let(:mg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
737
- MK = T.let(:mk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
738
- ML = T.let(:ml, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
739
- MM = T.let(:mm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
740
- MN = T.let(:mn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
741
- MO = T.let(:mo, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
742
- MQ = T.let(:mq, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
743
- MR = T.let(:mr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
744
- MT = T.let(:mt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
745
- MU = T.let(:mu, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
746
- MV = T.let(:mv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
747
- MW = T.let(:mw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
748
- MX = T.let(:mx, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
749
- MY = T.let(:my, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
750
- MZ = T.let(:mz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
751
- NA = T.let(:na, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
752
- NC = T.let(:nc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
753
- NE = T.let(:ne, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
754
- NG = T.let(:ng, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
755
- NI = T.let(:ni, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
756
- NL = T.let(:nl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
757
- NO = T.let(:no, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
758
- NP = T.let(:np, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
759
- NZ = T.let(:nz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
760
- OM = T.let(:om, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
761
- PA = T.let(:pa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
762
- PE = T.let(:pe, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
763
- PF = T.let(:pf, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
764
- PG = T.let(:pg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
765
- PH = T.let(:ph, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
766
- PK = T.let(:pk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
767
- PL = T.let(:pl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
768
- PR = T.let(:pr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
769
- PS = T.let(:ps, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
770
- PT = T.let(:pt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
771
- PY = T.let(:py, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
772
- QA = T.let(:qa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
773
- RE = T.let(:re, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
774
- RO = T.let(:ro, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
775
- RS = T.let(:rs, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
776
- RU = T.let(:ru, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
777
- RW = T.let(:rw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
778
- SA = T.let(:sa, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
779
- SC = T.let(:sc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
780
- SD = T.let(:sd, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
781
- SE = T.let(:se, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
782
- SG = T.let(:sg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
783
- SI = T.let(:si, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
784
- SK = T.let(:sk, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
785
- SL = T.let(:sl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
786
- SM = T.let(:sm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
787
- SN = T.let(:sn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
788
- SO = T.let(:so, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
789
- SR = T.let(:sr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
790
- SS = T.let(:ss, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
791
- ST = T.let(:st, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
792
- SV = T.let(:sv, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
793
- SX = T.let(:sx, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
794
- SY = T.let(:sy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
795
- SZ = T.let(:sz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
796
- TC = T.let(:tc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
797
- TD = T.let(:td, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
798
- TG = T.let(:tg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
799
- TH = T.let(:th, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
800
- TJ = T.let(:tj, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
801
- TL = T.let(:tl, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
802
- TM = T.let(:tm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
803
- TN = T.let(:tn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
804
- TR = T.let(:tr, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
805
- TT = T.let(:tt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
806
- TW = T.let(:tw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
807
- TZ = T.let(:tz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
808
- UA = T.let(:ua, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
809
- UG = T.let(:ug, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
810
- US = T.let(:us, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
811
- UY = T.let(:uy, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
812
- UZ = T.let(:uz, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
813
- VC = T.let(:vc, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
814
- VE = T.let(:ve, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
815
- VG = T.let(:vg, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
816
- VI = T.let(:vi, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
817
- VN = T.let(:vn, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
818
- YE = T.let(:ye, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
819
- YT = T.let(:yt, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
820
- ZA = T.let(:za, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
821
- ZM = T.let(:zm, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
822
- ZW = T.let(:zw, ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol)
823
-
824
- sig do
825
- override.returns(
826
- T::Array[ContextDev::WebWebScrapeMdParams::Country::TaggedSymbol]
827
- )
828
- end
829
- def self.values
830
- end
831
- end
832
-
833
- class Pdf < ContextDev::Internal::Type::BaseModel
834
- OrHash =
835
- T.type_alias do
836
- T.any(
837
- ContextDev::WebWebScrapeMdParams::Pdf,
838
- ContextDev::Internal::AnyHash
839
- )
840
- end
841
-
842
- # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
843
- # Must be greater than or equal to start when both are provided.
844
- sig { returns(T.nilable(Integer)) }
845
- attr_reader :end_
846
-
847
- sig { params(end_: Integer).void }
848
- attr_writer :end_
849
-
850
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
851
- # replacing each recovered page's text with the OCR result while pages with a real
852
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
853
- # of the base request cost. When false, no OCR runs.
854
- sig { returns(T.nilable(T::Boolean)) }
855
- attr_reader :ocr
856
-
857
- sig { params(ocr: T::Boolean).void }
858
- attr_writer :ocr
859
-
860
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
861
- # a 400 PDF_SKIPPED is returned.
862
- sig { returns(T.nilable(T::Boolean)) }
863
- attr_reader :should_parse
864
-
865
- sig { params(should_parse: T::Boolean).void }
866
- attr_writer :should_parse
867
-
868
- # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
869
- sig { returns(T.nilable(Integer)) }
870
- attr_reader :start
871
-
872
- sig { params(start: Integer).void }
873
- attr_writer :start
874
-
875
- # PDF parsing controls. Use start/end to limit text extraction and embedded-image
876
- # detection/OCR to an inclusive 1-based page range.
877
- sig do
878
- params(
879
- end_: Integer,
880
- ocr: T::Boolean,
881
- should_parse: T::Boolean,
882
- start: Integer
883
- ).returns(T.attached_class)
884
- end
885
- def self.new(
886
- # Last 1-based PDF page to parse. When omitted, parsing ends at the last page.
887
- # Must be greater than or equal to start when both are provided.
888
- end_: nil,
889
- # When true, OCR the selected PDF pages that have no usable text layer (scans),
890
- # replacing each recovered page's text with the OCR result while pages with a real
891
- # text layer keep it. Billed at 1 credit per page OCR actually recovered, on top
892
- # of the base request cost. When false, no OCR runs.
893
- ocr: nil,
894
- # When true, PDF URLs are fetched and parsed. When false, PDF URLs are skipped and
895
- # a 400 PDF_SKIPPED is returned.
896
- should_parse: nil,
897
- # First 1-based PDF page to parse. When omitted, parsing starts at the first page.
898
- start: nil
899
- )
900
- end
901
-
902
- sig do
903
- override.returns(
904
- {
905
- end_: Integer,
906
- ocr: T::Boolean,
907
- should_parse: T::Boolean,
908
- start: Integer
909
- }
910
- )
911
- end
912
- def to_hash
913
- end
914
- end
915
-
916
- class TimeoutOpts < ContextDev::Internal::Type::BaseModel
917
- OrHash =
918
- T.type_alias do
919
- T.any(
920
- ContextDev::WebWebScrapeMdParams::TimeoutOpts,
921
- ContextDev::Internal::AnyHash
922
- )
923
- end
924
-
925
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
926
- sig { returns(Integer) }
927
- attr_accessor :milliseconds
928
-
929
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
930
- # credits. "return-partial" returns usable results collected so far; if none are
931
- # available, the request still fails without charging credits. Partial results are
932
- # not cached as complete results. "return-partial" requires milliseconds of at
933
- # least 5000.
934
- sig do
935
- returns(
936
- T.nilable(
937
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
938
- )
939
- )
940
- end
941
- attr_reader :behavior
942
-
943
- sig do
944
- params(
945
- behavior:
946
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
947
- ).void
948
- end
949
- attr_writer :behavior
950
-
951
- # Optional request deadline and behavior on timeout. For GET requests, use
952
- # timeoutOpts[milliseconds]=30000&timeoutOpts[behavior]=fail or a JSON-encoded
953
- # timeoutOpts object.
954
- sig do
955
- params(
956
- milliseconds: Integer,
957
- behavior:
958
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
959
- ).returns(T.attached_class)
960
- end
961
- def self.new(
962
- # Request deadline in milliseconds. Maximum: 300000 (5 minutes).
963
- milliseconds:,
964
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
965
- # credits. "return-partial" returns usable results collected so far; if none are
966
- # available, the request still fails without charging credits. Partial results are
967
- # not cached as complete results. "return-partial" requires milliseconds of at
968
- # least 5000.
969
- behavior: nil
970
- )
971
- end
972
-
973
- sig do
974
- override.returns(
975
- {
976
- milliseconds: Integer,
977
- behavior:
978
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::OrSymbol
979
- }
980
- )
981
- end
982
- def to_hash
983
- end
984
-
985
- # What to do at the deadline. "fail" returns 408 REQUEST_TIMEOUT without charging
986
- # credits. "return-partial" returns usable results collected so far; if none are
987
- # available, the request still fails without charging credits. Partial results are
988
- # not cached as complete results. "return-partial" requires milliseconds of at
989
- # least 5000.
990
- module Behavior
991
- extend ContextDev::Internal::Type::Enum
992
-
993
- TaggedSymbol =
994
- T.type_alias do
995
- T.all(
996
- Symbol,
997
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior
998
- )
999
- end
1000
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1001
-
1002
- FAIL =
1003
- T.let(
1004
- :fail,
1005
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::TaggedSymbol
1006
- )
1007
- RETURN_PARTIAL =
1008
- T.let(
1009
- :"return-partial",
1010
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::TaggedSymbol
1011
- )
1012
-
1013
- sig do
1014
- override.returns(
1015
- T::Array[
1016
- ContextDev::WebWebScrapeMdParams::TimeoutOpts::Behavior::TaggedSymbol
1017
- ]
1018
- )
1019
- end
1020
- def self.values
1021
- end
1022
- end
1023
- end
1024
-
1025
- # Set to enabled to bypass shared caches and omit request and response content
1026
- # from retained usage logs. Asset uploads are skipped, so hosted image URLs are
1027
- # omitted. Requires zero data retention to be enabled for your organization
1028
- # (contact support@context.dev), otherwise the request fails with ZDR_NOT_ENABLED.
1029
- # Successful ZDR responses include X-Context-ZDR: true.
1030
- module Zdr
1031
- extend ContextDev::Internal::Type::Enum
1032
-
1033
- TaggedSymbol =
1034
- T.type_alias { T.all(Symbol, ContextDev::WebWebScrapeMdParams::Zdr) }
1035
- OrSymbol = T.type_alias { T.any(Symbol, String) }
1036
-
1037
- ENABLED =
1038
- T.let(:enabled, ContextDev::WebWebScrapeMdParams::Zdr::TaggedSymbol)
1039
- DISABLED =
1040
- T.let(:disabled, ContextDev::WebWebScrapeMdParams::Zdr::TaggedSymbol)
1041
-
1042
- sig do
1043
- override.returns(
1044
- T::Array[ContextDev::WebWebScrapeMdParams::Zdr::TaggedSymbol]
1045
- )
1046
- end
1047
- def self.values
1048
- end
1049
- end
1050
- end
1051
- end
1052
- end