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