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