@nimble-way/nimble-js 0.5.1

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 (352) hide show
  1. package/CHANGELOG.md +164 -0
  2. package/LICENSE +201 -0
  3. package/README.md +370 -0
  4. package/api-promise.d.mts +2 -0
  5. package/api-promise.d.mts.map +1 -0
  6. package/api-promise.d.ts +2 -0
  7. package/api-promise.d.ts.map +1 -0
  8. package/api-promise.js +6 -0
  9. package/api-promise.js.map +1 -0
  10. package/api-promise.mjs +2 -0
  11. package/api-promise.mjs.map +1 -0
  12. package/client.d.mts +239 -0
  13. package/client.d.mts.map +1 -0
  14. package/client.d.ts +239 -0
  15. package/client.d.ts.map +1 -0
  16. package/client.js +530 -0
  17. package/client.js.map +1 -0
  18. package/client.mjs +526 -0
  19. package/client.mjs.map +1 -0
  20. package/core/api-promise.d.mts +46 -0
  21. package/core/api-promise.d.mts.map +1 -0
  22. package/core/api-promise.d.ts +46 -0
  23. package/core/api-promise.d.ts.map +1 -0
  24. package/core/api-promise.js +74 -0
  25. package/core/api-promise.js.map +1 -0
  26. package/core/api-promise.mjs +70 -0
  27. package/core/api-promise.mjs.map +1 -0
  28. package/core/error.d.mts +46 -0
  29. package/core/error.d.mts.map +1 -0
  30. package/core/error.d.ts +46 -0
  31. package/core/error.d.ts.map +1 -0
  32. package/core/error.js +113 -0
  33. package/core/error.js.map +1 -0
  34. package/core/error.mjs +97 -0
  35. package/core/error.mjs.map +1 -0
  36. package/core/resource.d.mts +6 -0
  37. package/core/resource.d.mts.map +1 -0
  38. package/core/resource.d.ts +6 -0
  39. package/core/resource.d.ts.map +1 -0
  40. package/core/resource.js +11 -0
  41. package/core/resource.js.map +1 -0
  42. package/core/resource.mjs +7 -0
  43. package/core/resource.mjs.map +1 -0
  44. package/core/uploads.d.mts +3 -0
  45. package/core/uploads.d.mts.map +1 -0
  46. package/core/uploads.d.ts +3 -0
  47. package/core/uploads.d.ts.map +1 -0
  48. package/core/uploads.js +6 -0
  49. package/core/uploads.js.map +1 -0
  50. package/core/uploads.mjs +2 -0
  51. package/core/uploads.mjs.map +1 -0
  52. package/error.d.mts +2 -0
  53. package/error.d.mts.map +1 -0
  54. package/error.d.ts +2 -0
  55. package/error.d.ts.map +1 -0
  56. package/error.js +6 -0
  57. package/error.js.map +1 -0
  58. package/error.mjs +2 -0
  59. package/error.mjs.map +1 -0
  60. package/index.d.mts +6 -0
  61. package/index.d.mts.map +1 -0
  62. package/index.d.ts +6 -0
  63. package/index.d.ts.map +1 -0
  64. package/index.js +30 -0
  65. package/index.js.map +1 -0
  66. package/index.mjs +7 -0
  67. package/index.mjs.map +1 -0
  68. package/internal/builtin-types.d.mts +73 -0
  69. package/internal/builtin-types.d.mts.map +1 -0
  70. package/internal/builtin-types.d.ts +73 -0
  71. package/internal/builtin-types.d.ts.map +1 -0
  72. package/internal/builtin-types.js +4 -0
  73. package/internal/builtin-types.js.map +1 -0
  74. package/internal/builtin-types.mjs +3 -0
  75. package/internal/builtin-types.mjs.map +1 -0
  76. package/internal/detect-platform.d.mts +15 -0
  77. package/internal/detect-platform.d.mts.map +1 -0
  78. package/internal/detect-platform.d.ts +15 -0
  79. package/internal/detect-platform.d.ts.map +1 -0
  80. package/internal/detect-platform.js +162 -0
  81. package/internal/detect-platform.js.map +1 -0
  82. package/internal/detect-platform.mjs +157 -0
  83. package/internal/detect-platform.mjs.map +1 -0
  84. package/internal/errors.d.mts +3 -0
  85. package/internal/errors.d.mts.map +1 -0
  86. package/internal/errors.d.ts +3 -0
  87. package/internal/errors.d.ts.map +1 -0
  88. package/internal/errors.js +41 -0
  89. package/internal/errors.js.map +1 -0
  90. package/internal/errors.mjs +36 -0
  91. package/internal/errors.mjs.map +1 -0
  92. package/internal/headers.d.mts +20 -0
  93. package/internal/headers.d.mts.map +1 -0
  94. package/internal/headers.d.ts +20 -0
  95. package/internal/headers.d.ts.map +1 -0
  96. package/internal/headers.js +79 -0
  97. package/internal/headers.js.map +1 -0
  98. package/internal/headers.mjs +74 -0
  99. package/internal/headers.mjs.map +1 -0
  100. package/internal/parse.d.mts +12 -0
  101. package/internal/parse.d.mts.map +1 -0
  102. package/internal/parse.d.ts +12 -0
  103. package/internal/parse.d.ts.map +1 -0
  104. package/internal/parse.js +40 -0
  105. package/internal/parse.js.map +1 -0
  106. package/internal/parse.mjs +37 -0
  107. package/internal/parse.mjs.map +1 -0
  108. package/internal/request-options.d.mts +75 -0
  109. package/internal/request-options.d.mts.map +1 -0
  110. package/internal/request-options.d.ts +75 -0
  111. package/internal/request-options.d.ts.map +1 -0
  112. package/internal/request-options.js +14 -0
  113. package/internal/request-options.js.map +1 -0
  114. package/internal/request-options.mjs +10 -0
  115. package/internal/request-options.mjs.map +1 -0
  116. package/internal/shim-types.d.mts +17 -0
  117. package/internal/shim-types.d.mts.map +1 -0
  118. package/internal/shim-types.d.ts +17 -0
  119. package/internal/shim-types.d.ts.map +1 -0
  120. package/internal/shim-types.js +4 -0
  121. package/internal/shim-types.js.map +1 -0
  122. package/internal/shim-types.mjs +3 -0
  123. package/internal/shim-types.mjs.map +1 -0
  124. package/internal/shims.d.mts +20 -0
  125. package/internal/shims.d.mts.map +1 -0
  126. package/internal/shims.d.ts +20 -0
  127. package/internal/shims.d.ts.map +1 -0
  128. package/internal/shims.js +92 -0
  129. package/internal/shims.js.map +1 -0
  130. package/internal/shims.mjs +85 -0
  131. package/internal/shims.mjs.map +1 -0
  132. package/internal/to-file.d.mts +45 -0
  133. package/internal/to-file.d.mts.map +1 -0
  134. package/internal/to-file.d.ts +45 -0
  135. package/internal/to-file.d.ts.map +1 -0
  136. package/internal/to-file.js +91 -0
  137. package/internal/to-file.js.map +1 -0
  138. package/internal/to-file.mjs +88 -0
  139. package/internal/to-file.mjs.map +1 -0
  140. package/internal/tslib.js +81 -0
  141. package/internal/tslib.mjs +17 -0
  142. package/internal/types.d.mts +69 -0
  143. package/internal/types.d.mts.map +1 -0
  144. package/internal/types.d.ts +69 -0
  145. package/internal/types.d.ts.map +1 -0
  146. package/internal/types.js +4 -0
  147. package/internal/types.js.map +1 -0
  148. package/internal/types.mjs +3 -0
  149. package/internal/types.mjs.map +1 -0
  150. package/internal/uploads.d.mts +42 -0
  151. package/internal/uploads.d.mts.map +1 -0
  152. package/internal/uploads.d.ts +42 -0
  153. package/internal/uploads.d.ts.map +1 -0
  154. package/internal/uploads.js +141 -0
  155. package/internal/uploads.js.map +1 -0
  156. package/internal/uploads.mjs +131 -0
  157. package/internal/uploads.mjs.map +1 -0
  158. package/internal/utils/base64.d.mts +3 -0
  159. package/internal/utils/base64.d.mts.map +1 -0
  160. package/internal/utils/base64.d.ts +3 -0
  161. package/internal/utils/base64.d.ts.map +1 -0
  162. package/internal/utils/base64.js +38 -0
  163. package/internal/utils/base64.js.map +1 -0
  164. package/internal/utils/base64.mjs +33 -0
  165. package/internal/utils/base64.mjs.map +1 -0
  166. package/internal/utils/bytes.d.mts +4 -0
  167. package/internal/utils/bytes.d.mts.map +1 -0
  168. package/internal/utils/bytes.d.ts +4 -0
  169. package/internal/utils/bytes.d.ts.map +1 -0
  170. package/internal/utils/bytes.js +31 -0
  171. package/internal/utils/bytes.js.map +1 -0
  172. package/internal/utils/bytes.mjs +26 -0
  173. package/internal/utils/bytes.mjs.map +1 -0
  174. package/internal/utils/env.d.mts +9 -0
  175. package/internal/utils/env.d.mts.map +1 -0
  176. package/internal/utils/env.d.ts +9 -0
  177. package/internal/utils/env.d.ts.map +1 -0
  178. package/internal/utils/env.js +22 -0
  179. package/internal/utils/env.js.map +1 -0
  180. package/internal/utils/env.mjs +18 -0
  181. package/internal/utils/env.mjs.map +1 -0
  182. package/internal/utils/log.d.mts +37 -0
  183. package/internal/utils/log.d.mts.map +1 -0
  184. package/internal/utils/log.d.ts +37 -0
  185. package/internal/utils/log.d.ts.map +1 -0
  186. package/internal/utils/log.js +85 -0
  187. package/internal/utils/log.js.map +1 -0
  188. package/internal/utils/log.mjs +79 -0
  189. package/internal/utils/log.mjs.map +1 -0
  190. package/internal/utils/path.d.mts +15 -0
  191. package/internal/utils/path.d.mts.map +1 -0
  192. package/internal/utils/path.d.ts +15 -0
  193. package/internal/utils/path.d.ts.map +1 -0
  194. package/internal/utils/path.js +79 -0
  195. package/internal/utils/path.js.map +1 -0
  196. package/internal/utils/path.mjs +74 -0
  197. package/internal/utils/path.mjs.map +1 -0
  198. package/internal/utils/sleep.d.mts +2 -0
  199. package/internal/utils/sleep.d.mts.map +1 -0
  200. package/internal/utils/sleep.d.ts +2 -0
  201. package/internal/utils/sleep.d.ts.map +1 -0
  202. package/internal/utils/sleep.js +7 -0
  203. package/internal/utils/sleep.js.map +1 -0
  204. package/internal/utils/sleep.mjs +3 -0
  205. package/internal/utils/sleep.mjs.map +1 -0
  206. package/internal/utils/uuid.d.mts +5 -0
  207. package/internal/utils/uuid.d.mts.map +1 -0
  208. package/internal/utils/uuid.d.ts +5 -0
  209. package/internal/utils/uuid.d.ts.map +1 -0
  210. package/internal/utils/uuid.js +19 -0
  211. package/internal/utils/uuid.js.map +1 -0
  212. package/internal/utils/uuid.mjs +15 -0
  213. package/internal/utils/uuid.mjs.map +1 -0
  214. package/internal/utils/values.d.mts +18 -0
  215. package/internal/utils/values.d.mts.map +1 -0
  216. package/internal/utils/values.d.ts +18 -0
  217. package/internal/utils/values.d.ts.map +1 -0
  218. package/internal/utils/values.js +112 -0
  219. package/internal/utils/values.js.map +1 -0
  220. package/internal/utils/values.mjs +94 -0
  221. package/internal/utils/values.mjs.map +1 -0
  222. package/internal/utils.d.mts +7 -0
  223. package/internal/utils.d.mts.map +1 -0
  224. package/internal/utils.d.ts +7 -0
  225. package/internal/utils.d.ts.map +1 -0
  226. package/internal/utils.js +11 -0
  227. package/internal/utils.js.map +1 -0
  228. package/internal/utils.mjs +8 -0
  229. package/internal/utils.mjs.map +1 -0
  230. package/package.json +137 -0
  231. package/resource.d.mts +2 -0
  232. package/resource.d.mts.map +1 -0
  233. package/resource.d.ts +2 -0
  234. package/resource.d.ts.map +1 -0
  235. package/resource.js +6 -0
  236. package/resource.js.map +1 -0
  237. package/resource.mjs +2 -0
  238. package/resource.mjs.map +1 -0
  239. package/resources/agent.d.mts +356 -0
  240. package/resources/agent.d.mts.map +1 -0
  241. package/resources/agent.d.ts +356 -0
  242. package/resources/agent.d.ts.map +1 -0
  243. package/resources/agent.js +34 -0
  244. package/resources/agent.js.map +1 -0
  245. package/resources/agent.mjs +30 -0
  246. package/resources/agent.mjs.map +1 -0
  247. package/resources/crawl.d.mts +465 -0
  248. package/resources/crawl.d.mts.map +1 -0
  249. package/resources/crawl.d.ts +465 -0
  250. package/resources/crawl.d.ts.map +1 -0
  251. package/resources/crawl.js +34 -0
  252. package/resources/crawl.js.map +1 -0
  253. package/resources/crawl.mjs +30 -0
  254. package/resources/crawl.mjs.map +1 -0
  255. package/resources/index.d.mts +6 -0
  256. package/resources/index.d.mts.map +1 -0
  257. package/resources/index.d.ts +6 -0
  258. package/resources/index.d.ts.map +1 -0
  259. package/resources/index.js +13 -0
  260. package/resources/index.js.map +1 -0
  261. package/resources/index.mjs +6 -0
  262. package/resources/index.mjs.map +1 -0
  263. package/resources/shared.d.mts +452 -0
  264. package/resources/shared.d.mts.map +1 -0
  265. package/resources/shared.d.ts +452 -0
  266. package/resources/shared.d.ts.map +1 -0
  267. package/resources/shared.js +4 -0
  268. package/resources/shared.js.map +1 -0
  269. package/resources/shared.mjs +3 -0
  270. package/resources/shared.mjs.map +1 -0
  271. package/resources/tasks.d.mts +183 -0
  272. package/resources/tasks.d.mts.map +1 -0
  273. package/resources/tasks.d.ts +183 -0
  274. package/resources/tasks.d.ts.map +1 -0
  275. package/resources/tasks.js +28 -0
  276. package/resources/tasks.js.map +1 -0
  277. package/resources/tasks.mjs +24 -0
  278. package/resources/tasks.mjs.map +1 -0
  279. package/resources/top-level.d.mts +847 -0
  280. package/resources/top-level.d.mts.map +1 -0
  281. package/resources/top-level.d.ts +847 -0
  282. package/resources/top-level.d.ts.map +1 -0
  283. package/resources/top-level.js +4 -0
  284. package/resources/top-level.js.map +1 -0
  285. package/resources/top-level.mjs +3 -0
  286. package/resources/top-level.mjs.map +1 -0
  287. package/resources.d.mts +2 -0
  288. package/resources.d.mts.map +1 -0
  289. package/resources.d.ts +2 -0
  290. package/resources.d.ts.map +1 -0
  291. package/resources.js +5 -0
  292. package/resources.js.map +1 -0
  293. package/resources.mjs +2 -0
  294. package/resources.mjs.map +1 -0
  295. package/src/api-promise.ts +2 -0
  296. package/src/client.ts +893 -0
  297. package/src/core/README.md +3 -0
  298. package/src/core/api-promise.ts +92 -0
  299. package/src/core/error.ts +130 -0
  300. package/src/core/resource.ts +11 -0
  301. package/src/core/uploads.ts +2 -0
  302. package/src/error.ts +2 -0
  303. package/src/index.ts +22 -0
  304. package/src/internal/README.md +3 -0
  305. package/src/internal/builtin-types.ts +93 -0
  306. package/src/internal/detect-platform.ts +196 -0
  307. package/src/internal/errors.ts +33 -0
  308. package/src/internal/headers.ts +97 -0
  309. package/src/internal/parse.ts +56 -0
  310. package/src/internal/request-options.ts +91 -0
  311. package/src/internal/shim-types.ts +26 -0
  312. package/src/internal/shims.ts +107 -0
  313. package/src/internal/to-file.ts +154 -0
  314. package/src/internal/types.ts +95 -0
  315. package/src/internal/uploads.ts +187 -0
  316. package/src/internal/utils/base64.ts +40 -0
  317. package/src/internal/utils/bytes.ts +32 -0
  318. package/src/internal/utils/env.ts +18 -0
  319. package/src/internal/utils/log.ts +126 -0
  320. package/src/internal/utils/path.ts +88 -0
  321. package/src/internal/utils/sleep.ts +3 -0
  322. package/src/internal/utils/uuid.ts +17 -0
  323. package/src/internal/utils/values.ts +105 -0
  324. package/src/internal/utils.ts +8 -0
  325. package/src/lib/.keep +4 -0
  326. package/src/resource.ts +2 -0
  327. package/src/resources/agent.ts +548 -0
  328. package/src/resources/crawl.ts +1493 -0
  329. package/src/resources/index.ts +39 -0
  330. package/src/resources/shared.ts +816 -0
  331. package/src/resources/tasks.ts +240 -0
  332. package/src/resources/top-level.ts +3665 -0
  333. package/src/resources.ts +1 -0
  334. package/src/tsconfig.json +11 -0
  335. package/src/uploads.ts +2 -0
  336. package/src/version.ts +1 -0
  337. package/uploads.d.mts +2 -0
  338. package/uploads.d.mts.map +1 -0
  339. package/uploads.d.ts +2 -0
  340. package/uploads.d.ts.map +1 -0
  341. package/uploads.js +6 -0
  342. package/uploads.js.map +1 -0
  343. package/uploads.mjs +2 -0
  344. package/uploads.mjs.map +1 -0
  345. package/version.d.mts +2 -0
  346. package/version.d.mts.map +1 -0
  347. package/version.d.ts +2 -0
  348. package/version.d.ts.map +1 -0
  349. package/version.js +5 -0
  350. package/version.js.map +1 -0
  351. package/version.mjs +2 -0
  352. package/version.mjs.map +1 -0
@@ -0,0 +1,3665 @@
1
+ // File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
2
+
3
+ import * as Shared from './shared';
4
+
5
+ export interface ExtractResponse {
6
+ data: ExtractResponse.Data;
7
+
8
+ metadata: ExtractResponse.Metadata;
9
+
10
+ /**
11
+ * The status of the task.
12
+ */
13
+ status: 'success' | 'skipped' | 'fatal' | 'error' | 'postponed' | 'ignored' | 'rejected' | 'blocked';
14
+
15
+ /**
16
+ * Unique identifier for the task.
17
+ */
18
+ task_id: string;
19
+
20
+ /**
21
+ * The final URL.
22
+ */
23
+ url: string;
24
+
25
+ debug?: ExtractResponse.Debug;
26
+
27
+ /**
28
+ * Pagination information if applicable.
29
+ */
30
+ pagination?: ExtractResponse.NextPageParams | Array<ExtractResponse.UnionMember1>;
31
+
32
+ /**
33
+ * The HTTP status code of the task.
34
+ */
35
+ status_code?: number;
36
+
37
+ /**
38
+ * List of warnings generated during the task.
39
+ */
40
+ warnings?: Array<string>;
41
+ }
42
+
43
+ export namespace ExtractResponse {
44
+ export interface Data {
45
+ /**
46
+ * Browser actions execution results. Present only when browser_actions were
47
+ * specified in the request.
48
+ */
49
+ browser_actions?: Data.BrowserActions;
50
+
51
+ /**
52
+ * The cookies collected from browser actions during the task.
53
+ */
54
+ cookies?: Array<unknown>;
55
+
56
+ /**
57
+ * The evaluation results from browser actions during the task.
58
+ */
59
+ eval?: Array<unknown>;
60
+
61
+ /**
62
+ * The http requests from browser actions made during the task.
63
+ */
64
+ fetch?: Array<unknown>;
65
+
66
+ /**
67
+ * The headers received during the task.
68
+ */
69
+ headers?: { [key: string]: string };
70
+
71
+ /**
72
+ * The HTML content of the page.
73
+ */
74
+ html?: string;
75
+
76
+ /**
77
+ * The Markdown version of the HTML content.
78
+ */
79
+ markdown?: string;
80
+
81
+ /**
82
+ * The network capture data collected during the task.
83
+ */
84
+ network_capture?: Array<Data.NetworkCapture>;
85
+
86
+ /**
87
+ * The parsing results extracted from the HTML & network content.
88
+ */
89
+ parsing?: Data.ParsingSuccessResult | Data.ParsingErrorResult | { [key: string]: unknown };
90
+
91
+ /**
92
+ * The list of redirects that occurred during the task.
93
+ */
94
+ redirects?: Array<Data.Redirect>;
95
+
96
+ /**
97
+ * Screenshots taken during the task, from browser actions, or the screenshot
98
+ * format.
99
+ */
100
+ screenshots?: Array<unknown>;
101
+ }
102
+
103
+ export namespace Data {
104
+ /**
105
+ * Browser actions execution results. Present only when browser_actions were
106
+ * specified in the request.
107
+ */
108
+ export interface BrowserActions {
109
+ results: Array<BrowserActions.Result>;
110
+
111
+ success: boolean;
112
+
113
+ total_duration: number;
114
+ }
115
+
116
+ export namespace BrowserActions {
117
+ export interface Result {
118
+ duration: number;
119
+
120
+ name:
121
+ | 'goto'
122
+ | 'wait'
123
+ | 'wait_for_element'
124
+ | 'wait_for_navigation'
125
+ | 'click'
126
+ | 'fill'
127
+ | 'press'
128
+ | 'scroll'
129
+ | 'auto_scroll'
130
+ | 'screenshot'
131
+ | 'get_cookies'
132
+ | 'eval'
133
+ | 'fetch';
134
+
135
+ status: 'no-run' | 'in-progress' | 'done' | 'error' | 'skipped';
136
+
137
+ error?: string;
138
+
139
+ result?: unknown;
140
+ }
141
+ }
142
+
143
+ export interface NetworkCapture {
144
+ filter: NetworkCapture.Filter;
145
+
146
+ results: Array<NetworkCapture.Result>;
147
+
148
+ errorMessage?: string;
149
+ }
150
+
151
+ export namespace NetworkCapture {
152
+ export interface Filter {
153
+ validation: boolean;
154
+
155
+ wait_for_requests_count: number;
156
+
157
+ method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
158
+
159
+ /**
160
+ * Resource type for network capture filtering
161
+ */
162
+ resource_type?:
163
+ | 'document'
164
+ | 'stylesheet'
165
+ | 'image'
166
+ | 'media'
167
+ | 'font'
168
+ | 'script'
169
+ | 'texttrack'
170
+ | 'xhr'
171
+ | 'fetch'
172
+ | 'prefetch'
173
+ | 'eventsource'
174
+ | 'websocket'
175
+ | 'manifest'
176
+ | 'signedexchange'
177
+ | 'ping'
178
+ | 'cspviolationreport'
179
+ | 'preflight'
180
+ | 'other'
181
+ | 'fedcm'
182
+ | Array<
183
+ | 'document'
184
+ | 'stylesheet'
185
+ | 'image'
186
+ | 'media'
187
+ | 'font'
188
+ | 'script'
189
+ | 'texttrack'
190
+ | 'xhr'
191
+ | 'fetch'
192
+ | 'prefetch'
193
+ | 'eventsource'
194
+ | 'websocket'
195
+ | 'manifest'
196
+ | 'signedexchange'
197
+ | 'ping'
198
+ | 'cspviolationreport'
199
+ | 'preflight'
200
+ | 'other'
201
+ | 'fedcm'
202
+ >;
203
+
204
+ status_code?: number | Array<number>;
205
+
206
+ url?: Filter.URL;
207
+
208
+ wait_for_requests_count_timeout?: number;
209
+ }
210
+
211
+ export namespace Filter {
212
+ export interface URL {
213
+ type: 'exact' | 'contains';
214
+
215
+ value: string;
216
+ }
217
+ }
218
+
219
+ export interface Result {
220
+ request: Result.Request;
221
+
222
+ response: Result.Response;
223
+ }
224
+
225
+ export namespace Result {
226
+ export interface Request {
227
+ headers: { [key: string]: string };
228
+
229
+ method: string;
230
+
231
+ /**
232
+ * Resource type for network capture filtering
233
+ */
234
+ resource_type:
235
+ | 'document'
236
+ | 'stylesheet'
237
+ | 'image'
238
+ | 'media'
239
+ | 'font'
240
+ | 'script'
241
+ | 'texttrack'
242
+ | 'xhr'
243
+ | 'fetch'
244
+ | 'prefetch'
245
+ | 'eventsource'
246
+ | 'websocket'
247
+ | 'manifest'
248
+ | 'signedexchange'
249
+ | 'ping'
250
+ | 'cspviolationreport'
251
+ | 'preflight'
252
+ | 'other'
253
+ | 'fedcm';
254
+
255
+ url: string;
256
+
257
+ body?: string;
258
+ }
259
+
260
+ export interface Response {
261
+ body: string;
262
+
263
+ headers: { [key: string]: string };
264
+
265
+ serialization: 'none' | 'base64';
266
+
267
+ status: number;
268
+
269
+ status_text: string;
270
+ }
271
+ }
272
+ }
273
+
274
+ export interface ParsingSuccessResult {
275
+ entities: { [key: string]: unknown };
276
+
277
+ status: 'success';
278
+ }
279
+
280
+ export interface ParsingErrorResult {
281
+ error: string;
282
+
283
+ status: 'error';
284
+ }
285
+
286
+ export interface Redirect {
287
+ status_code: number;
288
+
289
+ url: string;
290
+ }
291
+ }
292
+
293
+ export interface Metadata {
294
+ /**
295
+ * The name of the agent used for the query.
296
+ */
297
+ agent?: string;
298
+
299
+ /**
300
+ * The driver used for the task.
301
+ */
302
+ driver?: string;
303
+
304
+ /**
305
+ * The localization identifier for the query.
306
+ */
307
+ localization_id?: string;
308
+
309
+ /**
310
+ * The duration in milliseconds of the query processing.
311
+ */
312
+ query_duration?: number;
313
+
314
+ /**
315
+ * The time when the query was received.
316
+ */
317
+ query_time?: string;
318
+
319
+ /**
320
+ * Additional response parameters.
321
+ */
322
+ response_parameters?: unknown;
323
+
324
+ /**
325
+ * A tag associated with the query.
326
+ */
327
+ tag?: string;
328
+ }
329
+
330
+ export interface Debug {
331
+ /**
332
+ * Performance metrics collected during the task.
333
+ */
334
+ performance_metrics?: { [key: string]: number };
335
+
336
+ /**
337
+ * Total bytes used by the proxy during the task.
338
+ */
339
+ proxy_total_bytes_usage?: number;
340
+
341
+ /**
342
+ * The transformed output after applying any transformations.
343
+ */
344
+ transformed_output?: unknown;
345
+
346
+ /**
347
+ * The userbrowser instance using during the task.
348
+ */
349
+ userbrowser?: unknown;
350
+ }
351
+
352
+ export interface NextPageParams {
353
+ next_page_params: { [key: string]: unknown };
354
+ }
355
+
356
+ export interface UnionMember1 {
357
+ next_page_params: { [key: string]: unknown };
358
+ }
359
+ }
360
+
361
+ /**
362
+ * Response when an async extract task is created successfully.
363
+ */
364
+ export interface ExtractAsyncResponse {
365
+ /**
366
+ * Status indicating the async task was created successfully.
367
+ */
368
+ status: 'success';
369
+
370
+ /**
371
+ * The created async task details.
372
+ */
373
+ task: ExtractAsyncResponse.Task;
374
+ }
375
+
376
+ export namespace ExtractAsyncResponse {
377
+ /**
378
+ * The created async task details.
379
+ */
380
+ export interface Task {
381
+ /**
382
+ * Unique task identifier.
383
+ */
384
+ id: string;
385
+
386
+ _query: unknown;
387
+
388
+ /**
389
+ * Timestamp when the task was created.
390
+ */
391
+ created_at: string;
392
+
393
+ /**
394
+ * Original input data for the task.
395
+ */
396
+ input: unknown;
397
+
398
+ /**
399
+ * Current state of the task.
400
+ */
401
+ state: 'pending' | 'success' | 'error';
402
+
403
+ /**
404
+ * URL for checking the task status.
405
+ */
406
+ status_url: string;
407
+
408
+ /**
409
+ * Account name that owns the task.
410
+ */
411
+ account_name?: string;
412
+
413
+ api_type?: 'web' | 'serp' | 'ecommerce' | 'social';
414
+
415
+ /**
416
+ * Batch ID if this task is part of a batch.
417
+ */
418
+ batch_id?: string;
419
+
420
+ /**
421
+ * URL for downloading the task results.
422
+ */
423
+ download_url?: string;
424
+
425
+ /**
426
+ * Error message if the task failed.
427
+ */
428
+ error?: string;
429
+
430
+ /**
431
+ * Classification of the error type.
432
+ */
433
+ error_type?: string;
434
+
435
+ /**
436
+ * Timestamp when the task was last modified.
437
+ */
438
+ modified_at?: string;
439
+
440
+ /**
441
+ * Storage location of the output data.
442
+ */
443
+ output_url?: string;
444
+
445
+ /**
446
+ * HTTP status code from the task execution.
447
+ */
448
+ status_code?: number;
449
+ }
450
+ }
451
+
452
+ /**
453
+ * Response schema for map requests.
454
+ */
455
+ export interface MapResponse {
456
+ /**
457
+ * Array of mapped links with optional titles and descriptions.
458
+ */
459
+ links: Array<MapResponse.Link>;
460
+
461
+ /**
462
+ * Indicates if the map request was successful.
463
+ */
464
+ success: boolean;
465
+
466
+ /**
467
+ * Unique identifier for the map task.
468
+ */
469
+ task_id: string;
470
+ }
471
+
472
+ export namespace MapResponse {
473
+ export interface Link {
474
+ url: string;
475
+
476
+ description?: string;
477
+
478
+ title?: string;
479
+ }
480
+ }
481
+
482
+ /**
483
+ * Response model from SearchService with results and optional LLM answer.
484
+ *
485
+ * Note: request_id is always a valid UUID generated internally by the middleware,
486
+ * so no validation is needed.
487
+ */
488
+ export interface SearchResponse {
489
+ /**
490
+ * Unique identifier for this request (UUID)
491
+ */
492
+ request_id: string;
493
+
494
+ results: Array<SearchResponse.Result>;
495
+
496
+ /**
497
+ * Number of results returned
498
+ */
499
+ total_results: number;
500
+
501
+ answer?: string | null;
502
+
503
+ /**
504
+ * Citations mapping citation markers to result indices
505
+ */
506
+ answer_citations?: Array<SearchResponse.AnswerCitation> | null;
507
+ }
508
+
509
+ export namespace SearchResponse {
510
+ /**
511
+ * Unified result model for all search types (SERP and WSA).
512
+ *
513
+ * This model provides a consistent structure for search results, with
514
+ * platform-specific data in additional_data and typed metadata.
515
+ */
516
+ export interface Result {
517
+ content: string;
518
+
519
+ description: string;
520
+
521
+ /**
522
+ * Metadata for SERP-based search results (general, news, location).
523
+ */
524
+ metadata: Result.SerpMetadata | Result.WsaMetadata;
525
+
526
+ title: string;
527
+
528
+ url: string;
529
+
530
+ /**
531
+ * Platform-specific fields (e.g., price, rating, publish_date). Omitted from
532
+ * response when no extra data.
533
+ */
534
+ additional_data?: { [key: string]: unknown } | null;
535
+ }
536
+
537
+ export namespace Result {
538
+ /**
539
+ * Metadata for SERP-based search results (general, news, location).
540
+ */
541
+ export interface SerpMetadata {
542
+ country: string;
543
+
544
+ entity_type: string;
545
+
546
+ locale: string;
547
+
548
+ position: number;
549
+
550
+ driver?: string | null;
551
+ }
552
+
553
+ /**
554
+ * Metadata for WSA-based search results.
555
+ */
556
+ export interface WsaMetadata {
557
+ agent_name: string;
558
+ }
559
+ }
560
+
561
+ /**
562
+ * Citation model that maps citation markers to result indices.
563
+ */
564
+ export interface AnswerCitation {
565
+ /**
566
+ * Citation marker number (e.g., 1 for [1])
567
+ */
568
+ marker: number;
569
+
570
+ /**
571
+ * Zero-based index into the results array
572
+ */
573
+ result_index: number;
574
+ }
575
+ }
576
+
577
+ export interface ExtractParams {
578
+ /**
579
+ * Target URL to scrape
580
+ */
581
+ url: string;
582
+
583
+ /**
584
+ * Browser type to emulate
585
+ */
586
+ browser?: 'chrome' | 'firefox' | ExtractParams.UnionMember1;
587
+
588
+ /**
589
+ * Array of browser automation actions to execute sequentially
590
+ */
591
+ browser_actions?: Array<
592
+ | Shared.AutoScrollAction
593
+ | Shared.ClickAction
594
+ | Shared.EvalAction
595
+ | Shared.FetchAction
596
+ | Shared.FillAction
597
+ | Shared.GetCookiesAction
598
+ | Shared.GotoAction
599
+ | Shared.PressAction
600
+ | Shared.ScreenshotAction
601
+ | Shared.ScrollAction
602
+ | Shared.WaitAction
603
+ | Shared.WaitForElementAction
604
+ | Shared.WaitForNavigationAction
605
+ >;
606
+
607
+ /**
608
+ * City for geolocation
609
+ */
610
+ city?: string;
611
+
612
+ /**
613
+ * Whether to automatically handle cookie consent headers
614
+ */
615
+ consent_header?: boolean;
616
+
617
+ /**
618
+ * Browser cookies as array of cookie objects
619
+ */
620
+ cookies?: Array<ExtractParams.UnionMember0> | string;
621
+
622
+ /**
623
+ * Country code for geolocation and proxy selection
624
+ */
625
+ country?:
626
+ | 'AD'
627
+ | 'AE'
628
+ | 'AF'
629
+ | 'AG'
630
+ | 'AI'
631
+ | 'AL'
632
+ | 'AM'
633
+ | 'AO'
634
+ | 'AQ'
635
+ | 'AR'
636
+ | 'AS'
637
+ | 'AT'
638
+ | 'AU'
639
+ | 'AW'
640
+ | 'AX'
641
+ | 'AZ'
642
+ | 'BA'
643
+ | 'BB'
644
+ | 'BD'
645
+ | 'BE'
646
+ | 'BF'
647
+ | 'BG'
648
+ | 'BH'
649
+ | 'BI'
650
+ | 'BJ'
651
+ | 'BL'
652
+ | 'BM'
653
+ | 'BN'
654
+ | 'BO'
655
+ | 'BQ'
656
+ | 'BR'
657
+ | 'BS'
658
+ | 'BT'
659
+ | 'BV'
660
+ | 'BW'
661
+ | 'BY'
662
+ | 'BZ'
663
+ | 'CA'
664
+ | 'CC'
665
+ | 'CD'
666
+ | 'CF'
667
+ | 'CG'
668
+ | 'CH'
669
+ | 'CI'
670
+ | 'CK'
671
+ | 'CL'
672
+ | 'CM'
673
+ | 'CN'
674
+ | 'CO'
675
+ | 'CR'
676
+ | 'CU'
677
+ | 'CV'
678
+ | 'CW'
679
+ | 'CX'
680
+ | 'CY'
681
+ | 'CZ'
682
+ | 'DE'
683
+ | 'DJ'
684
+ | 'DK'
685
+ | 'DM'
686
+ | 'DO'
687
+ | 'DZ'
688
+ | 'EC'
689
+ | 'EE'
690
+ | 'EG'
691
+ | 'EH'
692
+ | 'ER'
693
+ | 'ES'
694
+ | 'ET'
695
+ | 'FI'
696
+ | 'FJ'
697
+ | 'FK'
698
+ | 'FM'
699
+ | 'FO'
700
+ | 'FR'
701
+ | 'GA'
702
+ | 'GB'
703
+ | 'GD'
704
+ | 'GE'
705
+ | 'GF'
706
+ | 'GG'
707
+ | 'GH'
708
+ | 'GI'
709
+ | 'GL'
710
+ | 'GM'
711
+ | 'GN'
712
+ | 'GP'
713
+ | 'GQ'
714
+ | 'GR'
715
+ | 'GS'
716
+ | 'GT'
717
+ | 'GU'
718
+ | 'GW'
719
+ | 'GY'
720
+ | 'HK'
721
+ | 'HM'
722
+ | 'HN'
723
+ | 'HR'
724
+ | 'HT'
725
+ | 'HU'
726
+ | 'ID'
727
+ | 'IE'
728
+ | 'IL'
729
+ | 'IM'
730
+ | 'IN'
731
+ | 'IO'
732
+ | 'IQ'
733
+ | 'IR'
734
+ | 'IS'
735
+ | 'IT'
736
+ | 'JE'
737
+ | 'JM'
738
+ | 'JO'
739
+ | 'JP'
740
+ | 'KE'
741
+ | 'KG'
742
+ | 'KH'
743
+ | 'KI'
744
+ | 'KM'
745
+ | 'KN'
746
+ | 'KP'
747
+ | 'KR'
748
+ | 'KW'
749
+ | 'KY'
750
+ | 'KZ'
751
+ | 'LA'
752
+ | 'LB'
753
+ | 'LC'
754
+ | 'LI'
755
+ | 'LK'
756
+ | 'LR'
757
+ | 'LS'
758
+ | 'LT'
759
+ | 'LU'
760
+ | 'LV'
761
+ | 'LY'
762
+ | 'MA'
763
+ | 'MC'
764
+ | 'MD'
765
+ | 'ME'
766
+ | 'MF'
767
+ | 'MG'
768
+ | 'MH'
769
+ | 'MK'
770
+ | 'ML'
771
+ | 'MM'
772
+ | 'MN'
773
+ | 'MO'
774
+ | 'MP'
775
+ | 'MQ'
776
+ | 'MR'
777
+ | 'MS'
778
+ | 'MT'
779
+ | 'MU'
780
+ | 'MV'
781
+ | 'MW'
782
+ | 'MX'
783
+ | 'MY'
784
+ | 'MZ'
785
+ | 'NA'
786
+ | 'NC'
787
+ | 'NE'
788
+ | 'NF'
789
+ | 'NG'
790
+ | 'NI'
791
+ | 'NL'
792
+ | 'NO'
793
+ | 'NP'
794
+ | 'NR'
795
+ | 'NU'
796
+ | 'NZ'
797
+ | 'OM'
798
+ | 'PA'
799
+ | 'PE'
800
+ | 'PF'
801
+ | 'PG'
802
+ | 'PH'
803
+ | 'PK'
804
+ | 'PL'
805
+ | 'PM'
806
+ | 'PN'
807
+ | 'PR'
808
+ | 'PS'
809
+ | 'PT'
810
+ | 'PW'
811
+ | 'PY'
812
+ | 'QA'
813
+ | 'RE'
814
+ | 'RO'
815
+ | 'RS'
816
+ | 'RU'
817
+ | 'RW'
818
+ | 'SA'
819
+ | 'SB'
820
+ | 'SC'
821
+ | 'SD'
822
+ | 'SE'
823
+ | 'SG'
824
+ | 'SH'
825
+ | 'SI'
826
+ | 'SJ'
827
+ | 'SK'
828
+ | 'SL'
829
+ | 'SM'
830
+ | 'SN'
831
+ | 'SO'
832
+ | 'SR'
833
+ | 'SS'
834
+ | 'ST'
835
+ | 'SV'
836
+ | 'SX'
837
+ | 'SY'
838
+ | 'SZ'
839
+ | 'TC'
840
+ | 'TD'
841
+ | 'TF'
842
+ | 'TG'
843
+ | 'TH'
844
+ | 'TJ'
845
+ | 'TK'
846
+ | 'TL'
847
+ | 'TM'
848
+ | 'TN'
849
+ | 'TO'
850
+ | 'TR'
851
+ | 'TT'
852
+ | 'TV'
853
+ | 'TW'
854
+ | 'TZ'
855
+ | 'UA'
856
+ | 'UG'
857
+ | 'UM'
858
+ | 'US'
859
+ | 'UY'
860
+ | 'UZ'
861
+ | 'VA'
862
+ | 'VC'
863
+ | 'VE'
864
+ | 'VG'
865
+ | 'VI'
866
+ | 'VN'
867
+ | 'VU'
868
+ | 'WF'
869
+ | 'WS'
870
+ | 'XK'
871
+ | 'YE'
872
+ | 'YT'
873
+ | 'ZA'
874
+ | 'ZM'
875
+ | 'ZW'
876
+ | 'ALL';
877
+
878
+ /**
879
+ * Device type for browser emulation
880
+ */
881
+ device?: 'desktop' | 'mobile' | 'tablet';
882
+
883
+ /**
884
+ * Browser driver to use
885
+ */
886
+ driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
887
+
888
+ /**
889
+ * Expected HTTP status codes for successful requests
890
+ */
891
+ expected_status_codes?: Array<number>;
892
+
893
+ /**
894
+ * List of acceptable response formats in order of preference
895
+ */
896
+ formats?: Array<'html' | 'markdown' | 'screenshot'>;
897
+
898
+ /**
899
+ * Custom HTTP headers to include in the request
900
+ */
901
+ headers?: { [key: string]: string | Array<string> | null };
902
+
903
+ /**
904
+ * Whether to use HTTP/2 protocol
905
+ */
906
+ http2?: boolean;
907
+
908
+ /**
909
+ * Whether to emulate XMLHttpRequest behavior
910
+ */
911
+ is_xhr?: boolean;
912
+
913
+ /**
914
+ * Locale for browser language and region settings
915
+ */
916
+ locale?:
917
+ | 'aa-DJ'
918
+ | 'aa-ER'
919
+ | 'aa-ET'
920
+ | 'af'
921
+ | 'af-NA'
922
+ | 'af-ZA'
923
+ | 'ak'
924
+ | 'ak-GH'
925
+ | 'am'
926
+ | 'am-ET'
927
+ | 'an-ES'
928
+ | 'ar'
929
+ | 'ar-AE'
930
+ | 'ar-BH'
931
+ | 'ar-DZ'
932
+ | 'ar-EG'
933
+ | 'ar-IN'
934
+ | 'ar-IQ'
935
+ | 'ar-JO'
936
+ | 'ar-KW'
937
+ | 'ar-LB'
938
+ | 'ar-LY'
939
+ | 'ar-MA'
940
+ | 'ar-OM'
941
+ | 'ar-QA'
942
+ | 'ar-SA'
943
+ | 'ar-SD'
944
+ | 'ar-SY'
945
+ | 'ar-TN'
946
+ | 'ar-YE'
947
+ | 'as'
948
+ | 'as-IN'
949
+ | 'asa'
950
+ | 'asa-TZ'
951
+ | 'ast-ES'
952
+ | 'az'
953
+ | 'az-AZ'
954
+ | 'az-Cyrl'
955
+ | 'az-Cyrl-AZ'
956
+ | 'az-Latn'
957
+ | 'az-Latn-AZ'
958
+ | 'be'
959
+ | 'be-BY'
960
+ | 'bem'
961
+ | 'bem-ZM'
962
+ | 'ber-DZ'
963
+ | 'ber-MA'
964
+ | 'bez'
965
+ | 'bez-TZ'
966
+ | 'bg'
967
+ | 'bg-BG'
968
+ | 'bho-IN'
969
+ | 'bm'
970
+ | 'bm-ML'
971
+ | 'bn'
972
+ | 'bn-BD'
973
+ | 'bn-IN'
974
+ | 'bo'
975
+ | 'bo-CN'
976
+ | 'bo-IN'
977
+ | 'br-FR'
978
+ | 'brx-IN'
979
+ | 'bs'
980
+ | 'bs-BA'
981
+ | 'byn-ER'
982
+ | 'ca'
983
+ | 'ca-AD'
984
+ | 'ca-ES'
985
+ | 'ca-FR'
986
+ | 'ca-IT'
987
+ | 'cgg'
988
+ | 'cgg-UG'
989
+ | 'chr'
990
+ | 'chr-US'
991
+ | 'crh-UA'
992
+ | 'cs'
993
+ | 'cs-CZ'
994
+ | 'csb-PL'
995
+ | 'cv-RU'
996
+ | 'cy'
997
+ | 'cy-GB'
998
+ | 'da'
999
+ | 'da-DK'
1000
+ | 'dav'
1001
+ | 'dav-KE'
1002
+ | 'de'
1003
+ | 'de-AT'
1004
+ | 'de-BE'
1005
+ | 'de-CH'
1006
+ | 'de-DE'
1007
+ | 'de-LI'
1008
+ | 'de-LU'
1009
+ | 'dv-MV'
1010
+ | 'dz-BT'
1011
+ | 'ebu'
1012
+ | 'ebu-KE'
1013
+ | 'ee'
1014
+ | 'ee-GH'
1015
+ | 'ee-TG'
1016
+ | 'el'
1017
+ | 'el-CY'
1018
+ | 'el-GR'
1019
+ | 'en'
1020
+ | 'en-AG'
1021
+ | 'en-AS'
1022
+ | 'en-AU'
1023
+ | 'en-BE'
1024
+ | 'en-BW'
1025
+ | 'en-BZ'
1026
+ | 'en-CA'
1027
+ | 'en-DK'
1028
+ | 'en-GB'
1029
+ | 'en-GU'
1030
+ | 'en-HK'
1031
+ | 'en-IE'
1032
+ | 'en-IN'
1033
+ | 'en-JM'
1034
+ | 'en-MH'
1035
+ | 'en-MP'
1036
+ | 'en-MT'
1037
+ | 'en-MU'
1038
+ | 'en-NA'
1039
+ | 'en-NG'
1040
+ | 'en-NZ'
1041
+ | 'en-PH'
1042
+ | 'en-PK'
1043
+ | 'en-SG'
1044
+ | 'en-TT'
1045
+ | 'en-UM'
1046
+ | 'en-US'
1047
+ | 'en-VI'
1048
+ | 'en-ZA'
1049
+ | 'en-ZM'
1050
+ | 'en-ZW'
1051
+ | 'eo'
1052
+ | 'es'
1053
+ | 'es-419'
1054
+ | 'es-AR'
1055
+ | 'es-BO'
1056
+ | 'es-CL'
1057
+ | 'es-CO'
1058
+ | 'es-CR'
1059
+ | 'es-CU'
1060
+ | 'es-DO'
1061
+ | 'es-EC'
1062
+ | 'es-ES'
1063
+ | 'es-GQ'
1064
+ | 'es-GT'
1065
+ | 'es-HN'
1066
+ | 'es-MX'
1067
+ | 'es-NI'
1068
+ | 'es-PA'
1069
+ | 'es-PE'
1070
+ | 'es-PR'
1071
+ | 'es-PY'
1072
+ | 'es-SV'
1073
+ | 'es-US'
1074
+ | 'es-UY'
1075
+ | 'es-VE'
1076
+ | 'et'
1077
+ | 'et-EE'
1078
+ | 'eu'
1079
+ | 'eu-ES'
1080
+ | 'fa'
1081
+ | 'fa-AF'
1082
+ | 'fa-IR'
1083
+ | 'ff'
1084
+ | 'ff-SN'
1085
+ | 'fi'
1086
+ | 'fi-FI'
1087
+ | 'fil'
1088
+ | 'fil-PH'
1089
+ | 'fo'
1090
+ | 'fo-FO'
1091
+ | 'fr'
1092
+ | 'fr-BE'
1093
+ | 'fr-BF'
1094
+ | 'fr-BI'
1095
+ | 'fr-BJ'
1096
+ | 'fr-BL'
1097
+ | 'fr-CA'
1098
+ | 'fr-CD'
1099
+ | 'fr-CF'
1100
+ | 'fr-CG'
1101
+ | 'fr-CH'
1102
+ | 'fr-CI'
1103
+ | 'fr-CM'
1104
+ | 'fr-DJ'
1105
+ | 'fr-FR'
1106
+ | 'fr-GA'
1107
+ | 'fr-GN'
1108
+ | 'fr-GP'
1109
+ | 'fr-GQ'
1110
+ | 'fr-KM'
1111
+ | 'fr-LU'
1112
+ | 'fr-MC'
1113
+ | 'fr-MF'
1114
+ | 'fr-MG'
1115
+ | 'fr-ML'
1116
+ | 'fr-MQ'
1117
+ | 'fr-NE'
1118
+ | 'fr-RE'
1119
+ | 'fr-RW'
1120
+ | 'fr-SN'
1121
+ | 'fr-TD'
1122
+ | 'fr-TG'
1123
+ | 'fur-IT'
1124
+ | 'fy-DE'
1125
+ | 'fy-NL'
1126
+ | 'ga'
1127
+ | 'ga-IE'
1128
+ | 'gd-GB'
1129
+ | 'gez-ER'
1130
+ | 'gez-ET'
1131
+ | 'gl'
1132
+ | 'gl-ES'
1133
+ | 'gsw'
1134
+ | 'gsw-CH'
1135
+ | 'gu'
1136
+ | 'gu-IN'
1137
+ | 'guz'
1138
+ | 'guz-KE'
1139
+ | 'gv'
1140
+ | 'gv-GB'
1141
+ | 'ha'
1142
+ | 'ha-Latn'
1143
+ | 'ha-Latn-GH'
1144
+ | 'ha-Latn-NE'
1145
+ | 'ha-Latn-NG'
1146
+ | 'ha-NG'
1147
+ | 'haw'
1148
+ | 'haw-US'
1149
+ | 'he'
1150
+ | 'he-IL'
1151
+ | 'hi'
1152
+ | 'hi-IN'
1153
+ | 'hne-IN'
1154
+ | 'hr'
1155
+ | 'hr-HR'
1156
+ | 'hsb-DE'
1157
+ | 'ht-HT'
1158
+ | 'hu'
1159
+ | 'hu-HU'
1160
+ | 'hy'
1161
+ | 'hy-AM'
1162
+ | 'id'
1163
+ | 'id-ID'
1164
+ | 'ig'
1165
+ | 'ig-NG'
1166
+ | 'ii'
1167
+ | 'ii-CN'
1168
+ | 'ik-CA'
1169
+ | 'is'
1170
+ | 'is-IS'
1171
+ | 'it'
1172
+ | 'it-CH'
1173
+ | 'it-IT'
1174
+ | 'iu-CA'
1175
+ | 'iw-IL'
1176
+ | 'ja'
1177
+ | 'ja-JP'
1178
+ | 'jmc'
1179
+ | 'jmc-TZ'
1180
+ | 'ka'
1181
+ | 'ka-GE'
1182
+ | 'kab'
1183
+ | 'kab-DZ'
1184
+ | 'kam'
1185
+ | 'kam-KE'
1186
+ | 'kde'
1187
+ | 'kde-TZ'
1188
+ | 'kea'
1189
+ | 'kea-CV'
1190
+ | 'khq'
1191
+ | 'khq-ML'
1192
+ | 'ki'
1193
+ | 'ki-KE'
1194
+ | 'kk'
1195
+ | 'kk-Cyrl'
1196
+ | 'kk-Cyrl-KZ'
1197
+ | 'kk-KZ'
1198
+ | 'kl'
1199
+ | 'kl-GL'
1200
+ | 'kln'
1201
+ | 'kln-KE'
1202
+ | 'km'
1203
+ | 'km-KH'
1204
+ | 'kn'
1205
+ | 'kn-IN'
1206
+ | 'ko'
1207
+ | 'ko-KR'
1208
+ | 'kok'
1209
+ | 'kok-IN'
1210
+ | 'ks-IN'
1211
+ | 'ku-TR'
1212
+ | 'kw'
1213
+ | 'kw-GB'
1214
+ | 'ky-KG'
1215
+ | 'lag'
1216
+ | 'lag-TZ'
1217
+ | 'lb-LU'
1218
+ | 'lg'
1219
+ | 'lg-UG'
1220
+ | 'li-BE'
1221
+ | 'li-NL'
1222
+ | 'lij-IT'
1223
+ | 'lo-LA'
1224
+ | 'lt'
1225
+ | 'lt-LT'
1226
+ | 'luo'
1227
+ | 'luo-KE'
1228
+ | 'luy'
1229
+ | 'luy-KE'
1230
+ | 'lv'
1231
+ | 'lv-LV'
1232
+ | 'mag-IN'
1233
+ | 'mai-IN'
1234
+ | 'mas'
1235
+ | 'mas-KE'
1236
+ | 'mas-TZ'
1237
+ | 'mer'
1238
+ | 'mer-KE'
1239
+ | 'mfe'
1240
+ | 'mfe-MU'
1241
+ | 'mg'
1242
+ | 'mg-MG'
1243
+ | 'mhr-RU'
1244
+ | 'mi-NZ'
1245
+ | 'mk'
1246
+ | 'mk-MK'
1247
+ | 'ml'
1248
+ | 'ml-IN'
1249
+ | 'mn-MN'
1250
+ | 'mr'
1251
+ | 'mr-IN'
1252
+ | 'ms'
1253
+ | 'ms-BN'
1254
+ | 'ms-MY'
1255
+ | 'mt'
1256
+ | 'mt-MT'
1257
+ | 'my'
1258
+ | 'my-MM'
1259
+ | 'nan-TW'
1260
+ | 'naq'
1261
+ | 'naq-NA'
1262
+ | 'nb'
1263
+ | 'nb-NO'
1264
+ | 'nd'
1265
+ | 'nd-ZW'
1266
+ | 'nds-DE'
1267
+ | 'nds-NL'
1268
+ | 'ne'
1269
+ | 'ne-IN'
1270
+ | 'ne-NP'
1271
+ | 'nl'
1272
+ | 'nl-AW'
1273
+ | 'nl-BE'
1274
+ | 'nl-NL'
1275
+ | 'nn'
1276
+ | 'nn-NO'
1277
+ | 'nr-ZA'
1278
+ | 'nso-ZA'
1279
+ | 'nyn'
1280
+ | 'nyn-UG'
1281
+ | 'oc-FR'
1282
+ | 'om'
1283
+ | 'om-ET'
1284
+ | 'om-KE'
1285
+ | 'or'
1286
+ | 'or-IN'
1287
+ | 'os-RU'
1288
+ | 'pa'
1289
+ | 'pa-Arab'
1290
+ | 'pa-Arab-PK'
1291
+ | 'pa-Guru'
1292
+ | 'pa-Guru-IN'
1293
+ | 'pa-IN'
1294
+ | 'pa-PK'
1295
+ | 'pap-AN'
1296
+ | 'pl'
1297
+ | 'pl-PL'
1298
+ | 'ps'
1299
+ | 'ps-AF'
1300
+ | 'pt'
1301
+ | 'pt-BR'
1302
+ | 'pt-GW'
1303
+ | 'pt-MZ'
1304
+ | 'pt-PT'
1305
+ | 'rm'
1306
+ | 'rm-CH'
1307
+ | 'ro'
1308
+ | 'ro-MD'
1309
+ | 'ro-RO'
1310
+ | 'rof'
1311
+ | 'rof-TZ'
1312
+ | 'ru'
1313
+ | 'ru-MD'
1314
+ | 'ru-RU'
1315
+ | 'ru-UA'
1316
+ | 'rw'
1317
+ | 'rw-RW'
1318
+ | 'rwk'
1319
+ | 'rwk-TZ'
1320
+ | 'sa-IN'
1321
+ | 'saq'
1322
+ | 'saq-KE'
1323
+ | 'sc-IT'
1324
+ | 'sd-IN'
1325
+ | 'se-NO'
1326
+ | 'seh'
1327
+ | 'seh-MZ'
1328
+ | 'ses'
1329
+ | 'ses-ML'
1330
+ | 'sg'
1331
+ | 'sg-CF'
1332
+ | 'shi'
1333
+ | 'shi-Latn'
1334
+ | 'shi-Latn-MA'
1335
+ | 'shi-Tfng'
1336
+ | 'shi-Tfng-MA'
1337
+ | 'shs-CA'
1338
+ | 'si'
1339
+ | 'si-LK'
1340
+ | 'sid-ET'
1341
+ | 'sk'
1342
+ | 'sk-SK'
1343
+ | 'sl'
1344
+ | 'sl-SI'
1345
+ | 'sn'
1346
+ | 'sn-ZW'
1347
+ | 'so'
1348
+ | 'so-DJ'
1349
+ | 'so-ET'
1350
+ | 'so-KE'
1351
+ | 'so-SO'
1352
+ | 'sq'
1353
+ | 'sq-AL'
1354
+ | 'sq-MK'
1355
+ | 'sr'
1356
+ | 'sr-Cyrl'
1357
+ | 'sr-Cyrl-BA'
1358
+ | 'sr-Cyrl-ME'
1359
+ | 'sr-Cyrl-RS'
1360
+ | 'sr-Latn'
1361
+ | 'sr-Latn-BA'
1362
+ | 'sr-Latn-ME'
1363
+ | 'sr-Latn-RS'
1364
+ | 'sr-ME'
1365
+ | 'sr-RS'
1366
+ | 'ss-ZA'
1367
+ | 'st-ZA'
1368
+ | 'sv'
1369
+ | 'sv-FI'
1370
+ | 'sv-SE'
1371
+ | 'sw'
1372
+ | 'sw-KE'
1373
+ | 'sw-TZ'
1374
+ | 'ta'
1375
+ | 'ta-IN'
1376
+ | 'ta-LK'
1377
+ | 'te'
1378
+ | 'te-IN'
1379
+ | 'teo'
1380
+ | 'teo-KE'
1381
+ | 'teo-UG'
1382
+ | 'tg-TJ'
1383
+ | 'th'
1384
+ | 'th-TH'
1385
+ | 'ti'
1386
+ | 'ti-ER'
1387
+ | 'ti-ET'
1388
+ | 'tig-ER'
1389
+ | 'tk-TM'
1390
+ | 'tl-PH'
1391
+ | 'tn-ZA'
1392
+ | 'to'
1393
+ | 'to-TO'
1394
+ | 'tr'
1395
+ | 'tr-CY'
1396
+ | 'tr-TR'
1397
+ | 'ts-ZA'
1398
+ | 'tt-RU'
1399
+ | 'tzm'
1400
+ | 'tzm-Latn'
1401
+ | 'tzm-Latn-MA'
1402
+ | 'ug-CN'
1403
+ | 'uk'
1404
+ | 'uk-UA'
1405
+ | 'unm-US'
1406
+ | 'ur'
1407
+ | 'ur-IN'
1408
+ | 'ur-PK'
1409
+ | 'uz'
1410
+ | 'uz-Arab'
1411
+ | 'uz-Arab-AF'
1412
+ | 'uz-Cyrl'
1413
+ | 'uz-Cyrl-UZ'
1414
+ | 'uz-Latn'
1415
+ | 'uz-Latn-UZ'
1416
+ | 'uz-UZ'
1417
+ | 've-ZA'
1418
+ | 'vi'
1419
+ | 'vi-VN'
1420
+ | 'vun'
1421
+ | 'vun-TZ'
1422
+ | 'wa-BE'
1423
+ | 'wae-CH'
1424
+ | 'wal-ET'
1425
+ | 'wo-SN'
1426
+ | 'xh-ZA'
1427
+ | 'xog'
1428
+ | 'xog-UG'
1429
+ | 'yi-US'
1430
+ | 'yo'
1431
+ | 'yo-NG'
1432
+ | 'yue-HK'
1433
+ | 'zh'
1434
+ | 'zh-CN'
1435
+ | 'zh-HK'
1436
+ | 'zh-Hans'
1437
+ | 'zh-Hans-CN'
1438
+ | 'zh-Hans-HK'
1439
+ | 'zh-Hans-MO'
1440
+ | 'zh-Hans-SG'
1441
+ | 'zh-Hant'
1442
+ | 'zh-Hant-HK'
1443
+ | 'zh-Hant-MO'
1444
+ | 'zh-Hant-TW'
1445
+ | 'zh-SG'
1446
+ | 'zh-TW'
1447
+ | 'zu'
1448
+ | 'zu-ZA'
1449
+ | 'auto';
1450
+
1451
+ /**
1452
+ * HTTP method for the request
1453
+ */
1454
+ method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
1455
+
1456
+ /**
1457
+ * Filters for capturing network traffic
1458
+ */
1459
+ network_capture?: Array<ExtractParams.NetworkCapture>;
1460
+
1461
+ /**
1462
+ * Operating system to emulate
1463
+ */
1464
+ os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
1465
+
1466
+ /**
1467
+ * Whether to parse the response content
1468
+ */
1469
+ parse?: boolean;
1470
+
1471
+ /**
1472
+ * Custom parser configuration as a key-value map
1473
+ */
1474
+ parser?: { [key: string]: unknown } | string;
1475
+
1476
+ /**
1477
+ * Referrer policy for the request
1478
+ */
1479
+ referrer_type?:
1480
+ | 'random'
1481
+ | 'no-referer'
1482
+ | 'same-origin'
1483
+ | 'google'
1484
+ | 'bing'
1485
+ | 'facebook'
1486
+ | 'twitter'
1487
+ | 'instagram';
1488
+
1489
+ /**
1490
+ * Whether to render JavaScript content using a browser
1491
+ */
1492
+ render?: boolean;
1493
+
1494
+ /**
1495
+ * Request timeout in milliseconds
1496
+ */
1497
+ request_timeout?: number;
1498
+
1499
+ session?: ExtractParams.Session;
1500
+
1501
+ /**
1502
+ * Skills or capabilities required for the request
1503
+ */
1504
+ skill?: string | Array<string>;
1505
+
1506
+ /**
1507
+ * US state for geolocation (only valid when country is US)
1508
+ */
1509
+ state?:
1510
+ | 'AL'
1511
+ | 'AK'
1512
+ | 'AS'
1513
+ | 'AZ'
1514
+ | 'AR'
1515
+ | 'CA'
1516
+ | 'CO'
1517
+ | 'CT'
1518
+ | 'DE'
1519
+ | 'DC'
1520
+ | 'FL'
1521
+ | 'GA'
1522
+ | 'GU'
1523
+ | 'HI'
1524
+ | 'ID'
1525
+ | 'IL'
1526
+ | 'IN'
1527
+ | 'IA'
1528
+ | 'KS'
1529
+ | 'KY'
1530
+ | 'LA'
1531
+ | 'ME'
1532
+ | 'MD'
1533
+ | 'MA'
1534
+ | 'MI'
1535
+ | 'MN'
1536
+ | 'MS'
1537
+ | 'MO'
1538
+ | 'MT'
1539
+ | 'NE'
1540
+ | 'NV'
1541
+ | 'NH'
1542
+ | 'NJ'
1543
+ | 'NM'
1544
+ | 'NY'
1545
+ | 'NC'
1546
+ | 'ND'
1547
+ | 'MP'
1548
+ | 'OH'
1549
+ | 'OK'
1550
+ | 'OR'
1551
+ | 'PA'
1552
+ | 'PR'
1553
+ | 'RI'
1554
+ | 'SC'
1555
+ | 'SD'
1556
+ | 'TN'
1557
+ | 'TX'
1558
+ | 'UT'
1559
+ | 'VT'
1560
+ | 'VA'
1561
+ | 'VI'
1562
+ | 'WA'
1563
+ | 'WV'
1564
+ | 'WI'
1565
+ | 'WY';
1566
+
1567
+ /**
1568
+ * User-defined tag for request identification
1569
+ */
1570
+ tag?: string;
1571
+ }
1572
+
1573
+ export namespace ExtractParams {
1574
+ export interface UnionMember1 {
1575
+ name: 'chrome' | 'firefox';
1576
+
1577
+ /**
1578
+ * Specific browser version to emulate
1579
+ */
1580
+ version?: string;
1581
+ }
1582
+
1583
+ export interface UnionMember0 {
1584
+ creation?: string | null;
1585
+
1586
+ domain?: string | null;
1587
+
1588
+ expires?: string;
1589
+
1590
+ extensions?: Array<string> | null;
1591
+
1592
+ hostOnly?: boolean | null;
1593
+
1594
+ httpOnly?: boolean | null;
1595
+
1596
+ lastAccessed?: string | null;
1597
+
1598
+ maxAge?: 'Infinity' | '-Infinity' | number | null;
1599
+
1600
+ name?: string;
1601
+
1602
+ path?: string | null;
1603
+
1604
+ pathIsDefault?: boolean | null;
1605
+
1606
+ sameSite?: 'strict' | 'lax' | 'none';
1607
+
1608
+ secure?: boolean;
1609
+
1610
+ value?: string;
1611
+
1612
+ [k: string]: unknown;
1613
+ }
1614
+
1615
+ export interface NetworkCapture {
1616
+ method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
1617
+
1618
+ /**
1619
+ * Resource type for network capture filtering
1620
+ */
1621
+ resource_type?: string | Array<string>;
1622
+
1623
+ status_code?: number | Array<number>;
1624
+
1625
+ url?: NetworkCapture.URL;
1626
+
1627
+ validation?: boolean;
1628
+
1629
+ wait_for_requests_count?: number;
1630
+
1631
+ wait_for_requests_count_timeout?: number;
1632
+ }
1633
+
1634
+ export namespace NetworkCapture {
1635
+ export interface URL {
1636
+ value: string;
1637
+
1638
+ type?: 'exact' | 'contains';
1639
+ }
1640
+ }
1641
+
1642
+ export interface Session {
1643
+ id?: string;
1644
+
1645
+ prefetch_userbrowser?: boolean;
1646
+
1647
+ retry?: boolean;
1648
+
1649
+ timeout?: number;
1650
+ }
1651
+ }
1652
+
1653
+ export interface ExtractAsyncParams {
1654
+ /**
1655
+ * Target URL to scrape
1656
+ */
1657
+ url: string;
1658
+
1659
+ /**
1660
+ * Browser type to emulate
1661
+ */
1662
+ browser?: 'chrome' | 'firefox' | ExtractAsyncParams.UnionMember1;
1663
+
1664
+ /**
1665
+ * Array of browser automation actions to execute sequentially
1666
+ */
1667
+ browser_actions?: Array<
1668
+ | Shared.AutoScrollAction
1669
+ | Shared.ClickAction
1670
+ | Shared.EvalAction
1671
+ | Shared.FetchAction
1672
+ | Shared.FillAction
1673
+ | Shared.GetCookiesAction
1674
+ | Shared.GotoAction
1675
+ | Shared.PressAction
1676
+ | Shared.ScreenshotAction
1677
+ | Shared.ScrollAction
1678
+ | Shared.WaitAction
1679
+ | Shared.WaitForElementAction
1680
+ | Shared.WaitForNavigationAction
1681
+ >;
1682
+
1683
+ /**
1684
+ * URL to call back when async operation completes
1685
+ */
1686
+ callback_url?: string;
1687
+
1688
+ /**
1689
+ * City for geolocation
1690
+ */
1691
+ city?: string;
1692
+
1693
+ /**
1694
+ * Whether to automatically handle cookie consent headers
1695
+ */
1696
+ consent_header?: boolean;
1697
+
1698
+ /**
1699
+ * Browser cookies as array of cookie objects
1700
+ */
1701
+ cookies?: Array<ExtractAsyncParams.UnionMember0> | string;
1702
+
1703
+ /**
1704
+ * Country code for geolocation and proxy selection
1705
+ */
1706
+ country?:
1707
+ | 'AD'
1708
+ | 'AE'
1709
+ | 'AF'
1710
+ | 'AG'
1711
+ | 'AI'
1712
+ | 'AL'
1713
+ | 'AM'
1714
+ | 'AO'
1715
+ | 'AQ'
1716
+ | 'AR'
1717
+ | 'AS'
1718
+ | 'AT'
1719
+ | 'AU'
1720
+ | 'AW'
1721
+ | 'AX'
1722
+ | 'AZ'
1723
+ | 'BA'
1724
+ | 'BB'
1725
+ | 'BD'
1726
+ | 'BE'
1727
+ | 'BF'
1728
+ | 'BG'
1729
+ | 'BH'
1730
+ | 'BI'
1731
+ | 'BJ'
1732
+ | 'BL'
1733
+ | 'BM'
1734
+ | 'BN'
1735
+ | 'BO'
1736
+ | 'BQ'
1737
+ | 'BR'
1738
+ | 'BS'
1739
+ | 'BT'
1740
+ | 'BV'
1741
+ | 'BW'
1742
+ | 'BY'
1743
+ | 'BZ'
1744
+ | 'CA'
1745
+ | 'CC'
1746
+ | 'CD'
1747
+ | 'CF'
1748
+ | 'CG'
1749
+ | 'CH'
1750
+ | 'CI'
1751
+ | 'CK'
1752
+ | 'CL'
1753
+ | 'CM'
1754
+ | 'CN'
1755
+ | 'CO'
1756
+ | 'CR'
1757
+ | 'CU'
1758
+ | 'CV'
1759
+ | 'CW'
1760
+ | 'CX'
1761
+ | 'CY'
1762
+ | 'CZ'
1763
+ | 'DE'
1764
+ | 'DJ'
1765
+ | 'DK'
1766
+ | 'DM'
1767
+ | 'DO'
1768
+ | 'DZ'
1769
+ | 'EC'
1770
+ | 'EE'
1771
+ | 'EG'
1772
+ | 'EH'
1773
+ | 'ER'
1774
+ | 'ES'
1775
+ | 'ET'
1776
+ | 'FI'
1777
+ | 'FJ'
1778
+ | 'FK'
1779
+ | 'FM'
1780
+ | 'FO'
1781
+ | 'FR'
1782
+ | 'GA'
1783
+ | 'GB'
1784
+ | 'GD'
1785
+ | 'GE'
1786
+ | 'GF'
1787
+ | 'GG'
1788
+ | 'GH'
1789
+ | 'GI'
1790
+ | 'GL'
1791
+ | 'GM'
1792
+ | 'GN'
1793
+ | 'GP'
1794
+ | 'GQ'
1795
+ | 'GR'
1796
+ | 'GS'
1797
+ | 'GT'
1798
+ | 'GU'
1799
+ | 'GW'
1800
+ | 'GY'
1801
+ | 'HK'
1802
+ | 'HM'
1803
+ | 'HN'
1804
+ | 'HR'
1805
+ | 'HT'
1806
+ | 'HU'
1807
+ | 'ID'
1808
+ | 'IE'
1809
+ | 'IL'
1810
+ | 'IM'
1811
+ | 'IN'
1812
+ | 'IO'
1813
+ | 'IQ'
1814
+ | 'IR'
1815
+ | 'IS'
1816
+ | 'IT'
1817
+ | 'JE'
1818
+ | 'JM'
1819
+ | 'JO'
1820
+ | 'JP'
1821
+ | 'KE'
1822
+ | 'KG'
1823
+ | 'KH'
1824
+ | 'KI'
1825
+ | 'KM'
1826
+ | 'KN'
1827
+ | 'KP'
1828
+ | 'KR'
1829
+ | 'KW'
1830
+ | 'KY'
1831
+ | 'KZ'
1832
+ | 'LA'
1833
+ | 'LB'
1834
+ | 'LC'
1835
+ | 'LI'
1836
+ | 'LK'
1837
+ | 'LR'
1838
+ | 'LS'
1839
+ | 'LT'
1840
+ | 'LU'
1841
+ | 'LV'
1842
+ | 'LY'
1843
+ | 'MA'
1844
+ | 'MC'
1845
+ | 'MD'
1846
+ | 'ME'
1847
+ | 'MF'
1848
+ | 'MG'
1849
+ | 'MH'
1850
+ | 'MK'
1851
+ | 'ML'
1852
+ | 'MM'
1853
+ | 'MN'
1854
+ | 'MO'
1855
+ | 'MP'
1856
+ | 'MQ'
1857
+ | 'MR'
1858
+ | 'MS'
1859
+ | 'MT'
1860
+ | 'MU'
1861
+ | 'MV'
1862
+ | 'MW'
1863
+ | 'MX'
1864
+ | 'MY'
1865
+ | 'MZ'
1866
+ | 'NA'
1867
+ | 'NC'
1868
+ | 'NE'
1869
+ | 'NF'
1870
+ | 'NG'
1871
+ | 'NI'
1872
+ | 'NL'
1873
+ | 'NO'
1874
+ | 'NP'
1875
+ | 'NR'
1876
+ | 'NU'
1877
+ | 'NZ'
1878
+ | 'OM'
1879
+ | 'PA'
1880
+ | 'PE'
1881
+ | 'PF'
1882
+ | 'PG'
1883
+ | 'PH'
1884
+ | 'PK'
1885
+ | 'PL'
1886
+ | 'PM'
1887
+ | 'PN'
1888
+ | 'PR'
1889
+ | 'PS'
1890
+ | 'PT'
1891
+ | 'PW'
1892
+ | 'PY'
1893
+ | 'QA'
1894
+ | 'RE'
1895
+ | 'RO'
1896
+ | 'RS'
1897
+ | 'RU'
1898
+ | 'RW'
1899
+ | 'SA'
1900
+ | 'SB'
1901
+ | 'SC'
1902
+ | 'SD'
1903
+ | 'SE'
1904
+ | 'SG'
1905
+ | 'SH'
1906
+ | 'SI'
1907
+ | 'SJ'
1908
+ | 'SK'
1909
+ | 'SL'
1910
+ | 'SM'
1911
+ | 'SN'
1912
+ | 'SO'
1913
+ | 'SR'
1914
+ | 'SS'
1915
+ | 'ST'
1916
+ | 'SV'
1917
+ | 'SX'
1918
+ | 'SY'
1919
+ | 'SZ'
1920
+ | 'TC'
1921
+ | 'TD'
1922
+ | 'TF'
1923
+ | 'TG'
1924
+ | 'TH'
1925
+ | 'TJ'
1926
+ | 'TK'
1927
+ | 'TL'
1928
+ | 'TM'
1929
+ | 'TN'
1930
+ | 'TO'
1931
+ | 'TR'
1932
+ | 'TT'
1933
+ | 'TV'
1934
+ | 'TW'
1935
+ | 'TZ'
1936
+ | 'UA'
1937
+ | 'UG'
1938
+ | 'UM'
1939
+ | 'US'
1940
+ | 'UY'
1941
+ | 'UZ'
1942
+ | 'VA'
1943
+ | 'VC'
1944
+ | 'VE'
1945
+ | 'VG'
1946
+ | 'VI'
1947
+ | 'VN'
1948
+ | 'VU'
1949
+ | 'WF'
1950
+ | 'WS'
1951
+ | 'XK'
1952
+ | 'YE'
1953
+ | 'YT'
1954
+ | 'ZA'
1955
+ | 'ZM'
1956
+ | 'ZW'
1957
+ | 'ALL';
1958
+
1959
+ /**
1960
+ * Device type for browser emulation
1961
+ */
1962
+ device?: 'desktop' | 'mobile' | 'tablet';
1963
+
1964
+ /**
1965
+ * Browser driver to use
1966
+ */
1967
+ driver?: 'vx6' | 'vx8' | 'vx8-pro' | 'vx10' | 'vx10-pro' | 'vx12' | 'vx12-pro';
1968
+
1969
+ /**
1970
+ * Expected HTTP status codes for successful requests
1971
+ */
1972
+ expected_status_codes?: Array<number>;
1973
+
1974
+ /**
1975
+ * List of acceptable response formats in order of preference
1976
+ */
1977
+ formats?: Array<'html' | 'markdown' | 'screenshot'>;
1978
+
1979
+ /**
1980
+ * Custom HTTP headers to include in the request
1981
+ */
1982
+ headers?: { [key: string]: string | Array<string> | null };
1983
+
1984
+ /**
1985
+ * Whether to use HTTP/2 protocol
1986
+ */
1987
+ http2?: boolean;
1988
+
1989
+ /**
1990
+ * Whether to emulate XMLHttpRequest behavior
1991
+ */
1992
+ is_xhr?: boolean;
1993
+
1994
+ /**
1995
+ * Locale for browser language and region settings
1996
+ */
1997
+ locale?:
1998
+ | 'aa-DJ'
1999
+ | 'aa-ER'
2000
+ | 'aa-ET'
2001
+ | 'af'
2002
+ | 'af-NA'
2003
+ | 'af-ZA'
2004
+ | 'ak'
2005
+ | 'ak-GH'
2006
+ | 'am'
2007
+ | 'am-ET'
2008
+ | 'an-ES'
2009
+ | 'ar'
2010
+ | 'ar-AE'
2011
+ | 'ar-BH'
2012
+ | 'ar-DZ'
2013
+ | 'ar-EG'
2014
+ | 'ar-IN'
2015
+ | 'ar-IQ'
2016
+ | 'ar-JO'
2017
+ | 'ar-KW'
2018
+ | 'ar-LB'
2019
+ | 'ar-LY'
2020
+ | 'ar-MA'
2021
+ | 'ar-OM'
2022
+ | 'ar-QA'
2023
+ | 'ar-SA'
2024
+ | 'ar-SD'
2025
+ | 'ar-SY'
2026
+ | 'ar-TN'
2027
+ | 'ar-YE'
2028
+ | 'as'
2029
+ | 'as-IN'
2030
+ | 'asa'
2031
+ | 'asa-TZ'
2032
+ | 'ast-ES'
2033
+ | 'az'
2034
+ | 'az-AZ'
2035
+ | 'az-Cyrl'
2036
+ | 'az-Cyrl-AZ'
2037
+ | 'az-Latn'
2038
+ | 'az-Latn-AZ'
2039
+ | 'be'
2040
+ | 'be-BY'
2041
+ | 'bem'
2042
+ | 'bem-ZM'
2043
+ | 'ber-DZ'
2044
+ | 'ber-MA'
2045
+ | 'bez'
2046
+ | 'bez-TZ'
2047
+ | 'bg'
2048
+ | 'bg-BG'
2049
+ | 'bho-IN'
2050
+ | 'bm'
2051
+ | 'bm-ML'
2052
+ | 'bn'
2053
+ | 'bn-BD'
2054
+ | 'bn-IN'
2055
+ | 'bo'
2056
+ | 'bo-CN'
2057
+ | 'bo-IN'
2058
+ | 'br-FR'
2059
+ | 'brx-IN'
2060
+ | 'bs'
2061
+ | 'bs-BA'
2062
+ | 'byn-ER'
2063
+ | 'ca'
2064
+ | 'ca-AD'
2065
+ | 'ca-ES'
2066
+ | 'ca-FR'
2067
+ | 'ca-IT'
2068
+ | 'cgg'
2069
+ | 'cgg-UG'
2070
+ | 'chr'
2071
+ | 'chr-US'
2072
+ | 'crh-UA'
2073
+ | 'cs'
2074
+ | 'cs-CZ'
2075
+ | 'csb-PL'
2076
+ | 'cv-RU'
2077
+ | 'cy'
2078
+ | 'cy-GB'
2079
+ | 'da'
2080
+ | 'da-DK'
2081
+ | 'dav'
2082
+ | 'dav-KE'
2083
+ | 'de'
2084
+ | 'de-AT'
2085
+ | 'de-BE'
2086
+ | 'de-CH'
2087
+ | 'de-DE'
2088
+ | 'de-LI'
2089
+ | 'de-LU'
2090
+ | 'dv-MV'
2091
+ | 'dz-BT'
2092
+ | 'ebu'
2093
+ | 'ebu-KE'
2094
+ | 'ee'
2095
+ | 'ee-GH'
2096
+ | 'ee-TG'
2097
+ | 'el'
2098
+ | 'el-CY'
2099
+ | 'el-GR'
2100
+ | 'en'
2101
+ | 'en-AG'
2102
+ | 'en-AS'
2103
+ | 'en-AU'
2104
+ | 'en-BE'
2105
+ | 'en-BW'
2106
+ | 'en-BZ'
2107
+ | 'en-CA'
2108
+ | 'en-DK'
2109
+ | 'en-GB'
2110
+ | 'en-GU'
2111
+ | 'en-HK'
2112
+ | 'en-IE'
2113
+ | 'en-IN'
2114
+ | 'en-JM'
2115
+ | 'en-MH'
2116
+ | 'en-MP'
2117
+ | 'en-MT'
2118
+ | 'en-MU'
2119
+ | 'en-NA'
2120
+ | 'en-NG'
2121
+ | 'en-NZ'
2122
+ | 'en-PH'
2123
+ | 'en-PK'
2124
+ | 'en-SG'
2125
+ | 'en-TT'
2126
+ | 'en-UM'
2127
+ | 'en-US'
2128
+ | 'en-VI'
2129
+ | 'en-ZA'
2130
+ | 'en-ZM'
2131
+ | 'en-ZW'
2132
+ | 'eo'
2133
+ | 'es'
2134
+ | 'es-419'
2135
+ | 'es-AR'
2136
+ | 'es-BO'
2137
+ | 'es-CL'
2138
+ | 'es-CO'
2139
+ | 'es-CR'
2140
+ | 'es-CU'
2141
+ | 'es-DO'
2142
+ | 'es-EC'
2143
+ | 'es-ES'
2144
+ | 'es-GQ'
2145
+ | 'es-GT'
2146
+ | 'es-HN'
2147
+ | 'es-MX'
2148
+ | 'es-NI'
2149
+ | 'es-PA'
2150
+ | 'es-PE'
2151
+ | 'es-PR'
2152
+ | 'es-PY'
2153
+ | 'es-SV'
2154
+ | 'es-US'
2155
+ | 'es-UY'
2156
+ | 'es-VE'
2157
+ | 'et'
2158
+ | 'et-EE'
2159
+ | 'eu'
2160
+ | 'eu-ES'
2161
+ | 'fa'
2162
+ | 'fa-AF'
2163
+ | 'fa-IR'
2164
+ | 'ff'
2165
+ | 'ff-SN'
2166
+ | 'fi'
2167
+ | 'fi-FI'
2168
+ | 'fil'
2169
+ | 'fil-PH'
2170
+ | 'fo'
2171
+ | 'fo-FO'
2172
+ | 'fr'
2173
+ | 'fr-BE'
2174
+ | 'fr-BF'
2175
+ | 'fr-BI'
2176
+ | 'fr-BJ'
2177
+ | 'fr-BL'
2178
+ | 'fr-CA'
2179
+ | 'fr-CD'
2180
+ | 'fr-CF'
2181
+ | 'fr-CG'
2182
+ | 'fr-CH'
2183
+ | 'fr-CI'
2184
+ | 'fr-CM'
2185
+ | 'fr-DJ'
2186
+ | 'fr-FR'
2187
+ | 'fr-GA'
2188
+ | 'fr-GN'
2189
+ | 'fr-GP'
2190
+ | 'fr-GQ'
2191
+ | 'fr-KM'
2192
+ | 'fr-LU'
2193
+ | 'fr-MC'
2194
+ | 'fr-MF'
2195
+ | 'fr-MG'
2196
+ | 'fr-ML'
2197
+ | 'fr-MQ'
2198
+ | 'fr-NE'
2199
+ | 'fr-RE'
2200
+ | 'fr-RW'
2201
+ | 'fr-SN'
2202
+ | 'fr-TD'
2203
+ | 'fr-TG'
2204
+ | 'fur-IT'
2205
+ | 'fy-DE'
2206
+ | 'fy-NL'
2207
+ | 'ga'
2208
+ | 'ga-IE'
2209
+ | 'gd-GB'
2210
+ | 'gez-ER'
2211
+ | 'gez-ET'
2212
+ | 'gl'
2213
+ | 'gl-ES'
2214
+ | 'gsw'
2215
+ | 'gsw-CH'
2216
+ | 'gu'
2217
+ | 'gu-IN'
2218
+ | 'guz'
2219
+ | 'guz-KE'
2220
+ | 'gv'
2221
+ | 'gv-GB'
2222
+ | 'ha'
2223
+ | 'ha-Latn'
2224
+ | 'ha-Latn-GH'
2225
+ | 'ha-Latn-NE'
2226
+ | 'ha-Latn-NG'
2227
+ | 'ha-NG'
2228
+ | 'haw'
2229
+ | 'haw-US'
2230
+ | 'he'
2231
+ | 'he-IL'
2232
+ | 'hi'
2233
+ | 'hi-IN'
2234
+ | 'hne-IN'
2235
+ | 'hr'
2236
+ | 'hr-HR'
2237
+ | 'hsb-DE'
2238
+ | 'ht-HT'
2239
+ | 'hu'
2240
+ | 'hu-HU'
2241
+ | 'hy'
2242
+ | 'hy-AM'
2243
+ | 'id'
2244
+ | 'id-ID'
2245
+ | 'ig'
2246
+ | 'ig-NG'
2247
+ | 'ii'
2248
+ | 'ii-CN'
2249
+ | 'ik-CA'
2250
+ | 'is'
2251
+ | 'is-IS'
2252
+ | 'it'
2253
+ | 'it-CH'
2254
+ | 'it-IT'
2255
+ | 'iu-CA'
2256
+ | 'iw-IL'
2257
+ | 'ja'
2258
+ | 'ja-JP'
2259
+ | 'jmc'
2260
+ | 'jmc-TZ'
2261
+ | 'ka'
2262
+ | 'ka-GE'
2263
+ | 'kab'
2264
+ | 'kab-DZ'
2265
+ | 'kam'
2266
+ | 'kam-KE'
2267
+ | 'kde'
2268
+ | 'kde-TZ'
2269
+ | 'kea'
2270
+ | 'kea-CV'
2271
+ | 'khq'
2272
+ | 'khq-ML'
2273
+ | 'ki'
2274
+ | 'ki-KE'
2275
+ | 'kk'
2276
+ | 'kk-Cyrl'
2277
+ | 'kk-Cyrl-KZ'
2278
+ | 'kk-KZ'
2279
+ | 'kl'
2280
+ | 'kl-GL'
2281
+ | 'kln'
2282
+ | 'kln-KE'
2283
+ | 'km'
2284
+ | 'km-KH'
2285
+ | 'kn'
2286
+ | 'kn-IN'
2287
+ | 'ko'
2288
+ | 'ko-KR'
2289
+ | 'kok'
2290
+ | 'kok-IN'
2291
+ | 'ks-IN'
2292
+ | 'ku-TR'
2293
+ | 'kw'
2294
+ | 'kw-GB'
2295
+ | 'ky-KG'
2296
+ | 'lag'
2297
+ | 'lag-TZ'
2298
+ | 'lb-LU'
2299
+ | 'lg'
2300
+ | 'lg-UG'
2301
+ | 'li-BE'
2302
+ | 'li-NL'
2303
+ | 'lij-IT'
2304
+ | 'lo-LA'
2305
+ | 'lt'
2306
+ | 'lt-LT'
2307
+ | 'luo'
2308
+ | 'luo-KE'
2309
+ | 'luy'
2310
+ | 'luy-KE'
2311
+ | 'lv'
2312
+ | 'lv-LV'
2313
+ | 'mag-IN'
2314
+ | 'mai-IN'
2315
+ | 'mas'
2316
+ | 'mas-KE'
2317
+ | 'mas-TZ'
2318
+ | 'mer'
2319
+ | 'mer-KE'
2320
+ | 'mfe'
2321
+ | 'mfe-MU'
2322
+ | 'mg'
2323
+ | 'mg-MG'
2324
+ | 'mhr-RU'
2325
+ | 'mi-NZ'
2326
+ | 'mk'
2327
+ | 'mk-MK'
2328
+ | 'ml'
2329
+ | 'ml-IN'
2330
+ | 'mn-MN'
2331
+ | 'mr'
2332
+ | 'mr-IN'
2333
+ | 'ms'
2334
+ | 'ms-BN'
2335
+ | 'ms-MY'
2336
+ | 'mt'
2337
+ | 'mt-MT'
2338
+ | 'my'
2339
+ | 'my-MM'
2340
+ | 'nan-TW'
2341
+ | 'naq'
2342
+ | 'naq-NA'
2343
+ | 'nb'
2344
+ | 'nb-NO'
2345
+ | 'nd'
2346
+ | 'nd-ZW'
2347
+ | 'nds-DE'
2348
+ | 'nds-NL'
2349
+ | 'ne'
2350
+ | 'ne-IN'
2351
+ | 'ne-NP'
2352
+ | 'nl'
2353
+ | 'nl-AW'
2354
+ | 'nl-BE'
2355
+ | 'nl-NL'
2356
+ | 'nn'
2357
+ | 'nn-NO'
2358
+ | 'nr-ZA'
2359
+ | 'nso-ZA'
2360
+ | 'nyn'
2361
+ | 'nyn-UG'
2362
+ | 'oc-FR'
2363
+ | 'om'
2364
+ | 'om-ET'
2365
+ | 'om-KE'
2366
+ | 'or'
2367
+ | 'or-IN'
2368
+ | 'os-RU'
2369
+ | 'pa'
2370
+ | 'pa-Arab'
2371
+ | 'pa-Arab-PK'
2372
+ | 'pa-Guru'
2373
+ | 'pa-Guru-IN'
2374
+ | 'pa-IN'
2375
+ | 'pa-PK'
2376
+ | 'pap-AN'
2377
+ | 'pl'
2378
+ | 'pl-PL'
2379
+ | 'ps'
2380
+ | 'ps-AF'
2381
+ | 'pt'
2382
+ | 'pt-BR'
2383
+ | 'pt-GW'
2384
+ | 'pt-MZ'
2385
+ | 'pt-PT'
2386
+ | 'rm'
2387
+ | 'rm-CH'
2388
+ | 'ro'
2389
+ | 'ro-MD'
2390
+ | 'ro-RO'
2391
+ | 'rof'
2392
+ | 'rof-TZ'
2393
+ | 'ru'
2394
+ | 'ru-MD'
2395
+ | 'ru-RU'
2396
+ | 'ru-UA'
2397
+ | 'rw'
2398
+ | 'rw-RW'
2399
+ | 'rwk'
2400
+ | 'rwk-TZ'
2401
+ | 'sa-IN'
2402
+ | 'saq'
2403
+ | 'saq-KE'
2404
+ | 'sc-IT'
2405
+ | 'sd-IN'
2406
+ | 'se-NO'
2407
+ | 'seh'
2408
+ | 'seh-MZ'
2409
+ | 'ses'
2410
+ | 'ses-ML'
2411
+ | 'sg'
2412
+ | 'sg-CF'
2413
+ | 'shi'
2414
+ | 'shi-Latn'
2415
+ | 'shi-Latn-MA'
2416
+ | 'shi-Tfng'
2417
+ | 'shi-Tfng-MA'
2418
+ | 'shs-CA'
2419
+ | 'si'
2420
+ | 'si-LK'
2421
+ | 'sid-ET'
2422
+ | 'sk'
2423
+ | 'sk-SK'
2424
+ | 'sl'
2425
+ | 'sl-SI'
2426
+ | 'sn'
2427
+ | 'sn-ZW'
2428
+ | 'so'
2429
+ | 'so-DJ'
2430
+ | 'so-ET'
2431
+ | 'so-KE'
2432
+ | 'so-SO'
2433
+ | 'sq'
2434
+ | 'sq-AL'
2435
+ | 'sq-MK'
2436
+ | 'sr'
2437
+ | 'sr-Cyrl'
2438
+ | 'sr-Cyrl-BA'
2439
+ | 'sr-Cyrl-ME'
2440
+ | 'sr-Cyrl-RS'
2441
+ | 'sr-Latn'
2442
+ | 'sr-Latn-BA'
2443
+ | 'sr-Latn-ME'
2444
+ | 'sr-Latn-RS'
2445
+ | 'sr-ME'
2446
+ | 'sr-RS'
2447
+ | 'ss-ZA'
2448
+ | 'st-ZA'
2449
+ | 'sv'
2450
+ | 'sv-FI'
2451
+ | 'sv-SE'
2452
+ | 'sw'
2453
+ | 'sw-KE'
2454
+ | 'sw-TZ'
2455
+ | 'ta'
2456
+ | 'ta-IN'
2457
+ | 'ta-LK'
2458
+ | 'te'
2459
+ | 'te-IN'
2460
+ | 'teo'
2461
+ | 'teo-KE'
2462
+ | 'teo-UG'
2463
+ | 'tg-TJ'
2464
+ | 'th'
2465
+ | 'th-TH'
2466
+ | 'ti'
2467
+ | 'ti-ER'
2468
+ | 'ti-ET'
2469
+ | 'tig-ER'
2470
+ | 'tk-TM'
2471
+ | 'tl-PH'
2472
+ | 'tn-ZA'
2473
+ | 'to'
2474
+ | 'to-TO'
2475
+ | 'tr'
2476
+ | 'tr-CY'
2477
+ | 'tr-TR'
2478
+ | 'ts-ZA'
2479
+ | 'tt-RU'
2480
+ | 'tzm'
2481
+ | 'tzm-Latn'
2482
+ | 'tzm-Latn-MA'
2483
+ | 'ug-CN'
2484
+ | 'uk'
2485
+ | 'uk-UA'
2486
+ | 'unm-US'
2487
+ | 'ur'
2488
+ | 'ur-IN'
2489
+ | 'ur-PK'
2490
+ | 'uz'
2491
+ | 'uz-Arab'
2492
+ | 'uz-Arab-AF'
2493
+ | 'uz-Cyrl'
2494
+ | 'uz-Cyrl-UZ'
2495
+ | 'uz-Latn'
2496
+ | 'uz-Latn-UZ'
2497
+ | 'uz-UZ'
2498
+ | 've-ZA'
2499
+ | 'vi'
2500
+ | 'vi-VN'
2501
+ | 'vun'
2502
+ | 'vun-TZ'
2503
+ | 'wa-BE'
2504
+ | 'wae-CH'
2505
+ | 'wal-ET'
2506
+ | 'wo-SN'
2507
+ | 'xh-ZA'
2508
+ | 'xog'
2509
+ | 'xog-UG'
2510
+ | 'yi-US'
2511
+ | 'yo'
2512
+ | 'yo-NG'
2513
+ | 'yue-HK'
2514
+ | 'zh'
2515
+ | 'zh-CN'
2516
+ | 'zh-HK'
2517
+ | 'zh-Hans'
2518
+ | 'zh-Hans-CN'
2519
+ | 'zh-Hans-HK'
2520
+ | 'zh-Hans-MO'
2521
+ | 'zh-Hans-SG'
2522
+ | 'zh-Hant'
2523
+ | 'zh-Hant-HK'
2524
+ | 'zh-Hant-MO'
2525
+ | 'zh-Hant-TW'
2526
+ | 'zh-SG'
2527
+ | 'zh-TW'
2528
+ | 'zu'
2529
+ | 'zu-ZA'
2530
+ | 'auto';
2531
+
2532
+ /**
2533
+ * HTTP method for the request
2534
+ */
2535
+ method?: 'GET' | 'POST' | 'PUT' | 'PATCH' | 'DELETE';
2536
+
2537
+ /**
2538
+ * Filters for capturing network traffic
2539
+ */
2540
+ network_capture?: Array<ExtractAsyncParams.NetworkCapture>;
2541
+
2542
+ /**
2543
+ * Operating system to emulate
2544
+ */
2545
+ os?: 'windows' | 'mac os' | 'linux' | 'android' | 'ios';
2546
+
2547
+ /**
2548
+ * Whether to parse the response content
2549
+ */
2550
+ parse?: boolean;
2551
+
2552
+ /**
2553
+ * Custom parser configuration as a key-value map
2554
+ */
2555
+ parser?: { [key: string]: unknown } | string;
2556
+
2557
+ /**
2558
+ * Referrer policy for the request
2559
+ */
2560
+ referrer_type?:
2561
+ | 'random'
2562
+ | 'no-referer'
2563
+ | 'same-origin'
2564
+ | 'google'
2565
+ | 'bing'
2566
+ | 'facebook'
2567
+ | 'twitter'
2568
+ | 'instagram';
2569
+
2570
+ /**
2571
+ * Whether to render JavaScript content using a browser
2572
+ */
2573
+ render?: boolean;
2574
+
2575
+ /**
2576
+ * Request timeout in milliseconds
2577
+ */
2578
+ request_timeout?: number;
2579
+
2580
+ session?: ExtractAsyncParams.Session;
2581
+
2582
+ /**
2583
+ * Skills or capabilities required for the request
2584
+ */
2585
+ skill?: string | Array<string>;
2586
+
2587
+ /**
2588
+ * US state for geolocation (only valid when country is US)
2589
+ */
2590
+ state?:
2591
+ | 'AL'
2592
+ | 'AK'
2593
+ | 'AS'
2594
+ | 'AZ'
2595
+ | 'AR'
2596
+ | 'CA'
2597
+ | 'CO'
2598
+ | 'CT'
2599
+ | 'DE'
2600
+ | 'DC'
2601
+ | 'FL'
2602
+ | 'GA'
2603
+ | 'GU'
2604
+ | 'HI'
2605
+ | 'ID'
2606
+ | 'IL'
2607
+ | 'IN'
2608
+ | 'IA'
2609
+ | 'KS'
2610
+ | 'KY'
2611
+ | 'LA'
2612
+ | 'ME'
2613
+ | 'MD'
2614
+ | 'MA'
2615
+ | 'MI'
2616
+ | 'MN'
2617
+ | 'MS'
2618
+ | 'MO'
2619
+ | 'MT'
2620
+ | 'NE'
2621
+ | 'NV'
2622
+ | 'NH'
2623
+ | 'NJ'
2624
+ | 'NM'
2625
+ | 'NY'
2626
+ | 'NC'
2627
+ | 'ND'
2628
+ | 'MP'
2629
+ | 'OH'
2630
+ | 'OK'
2631
+ | 'OR'
2632
+ | 'PA'
2633
+ | 'PR'
2634
+ | 'RI'
2635
+ | 'SC'
2636
+ | 'SD'
2637
+ | 'TN'
2638
+ | 'TX'
2639
+ | 'UT'
2640
+ | 'VT'
2641
+ | 'VA'
2642
+ | 'VI'
2643
+ | 'WA'
2644
+ | 'WV'
2645
+ | 'WI'
2646
+ | 'WY';
2647
+
2648
+ /**
2649
+ * Whether to compress stored data
2650
+ */
2651
+ storage_compress?: boolean;
2652
+
2653
+ /**
2654
+ * Custom name for the stored object
2655
+ */
2656
+ storage_object_name?: string;
2657
+
2658
+ /**
2659
+ * Type of storage to use for results
2660
+ */
2661
+ storage_type?: string;
2662
+
2663
+ /**
2664
+ * URL for storage location
2665
+ */
2666
+ storage_url?: string;
2667
+
2668
+ /**
2669
+ * User-defined tag for request identification
2670
+ */
2671
+ tag?: string;
2672
+ }
2673
+
2674
+ export namespace ExtractAsyncParams {
2675
+ export interface UnionMember1 {
2676
+ name: 'chrome' | 'firefox';
2677
+
2678
+ /**
2679
+ * Specific browser version to emulate
2680
+ */
2681
+ version?: string;
2682
+ }
2683
+
2684
+ export interface UnionMember0 {
2685
+ creation?: string | null;
2686
+
2687
+ domain?: string | null;
2688
+
2689
+ expires?: string;
2690
+
2691
+ extensions?: Array<string> | null;
2692
+
2693
+ hostOnly?: boolean | null;
2694
+
2695
+ httpOnly?: boolean | null;
2696
+
2697
+ lastAccessed?: string | null;
2698
+
2699
+ maxAge?: 'Infinity' | '-Infinity' | number | null;
2700
+
2701
+ name?: string;
2702
+
2703
+ path?: string | null;
2704
+
2705
+ pathIsDefault?: boolean | null;
2706
+
2707
+ sameSite?: 'strict' | 'lax' | 'none';
2708
+
2709
+ secure?: boolean;
2710
+
2711
+ value?: string;
2712
+
2713
+ [k: string]: unknown;
2714
+ }
2715
+
2716
+ export interface NetworkCapture {
2717
+ method?: 'GET' | 'HEAD' | 'POST' | 'PUT' | 'DELETE' | 'CONNECT' | 'OPTIONS' | 'TRACE' | 'PATCH';
2718
+
2719
+ /**
2720
+ * Resource type for network capture filtering
2721
+ */
2722
+ resource_type?: string | Array<string>;
2723
+
2724
+ status_code?: number | Array<number>;
2725
+
2726
+ url?: NetworkCapture.URL;
2727
+
2728
+ validation?: boolean;
2729
+
2730
+ wait_for_requests_count?: number;
2731
+
2732
+ wait_for_requests_count_timeout?: number;
2733
+ }
2734
+
2735
+ export namespace NetworkCapture {
2736
+ export interface URL {
2737
+ value: string;
2738
+
2739
+ type?: 'exact' | 'contains';
2740
+ }
2741
+ }
2742
+
2743
+ export interface Session {
2744
+ id?: string;
2745
+
2746
+ prefetch_userbrowser?: boolean;
2747
+
2748
+ retry?: boolean;
2749
+
2750
+ timeout?: number;
2751
+ }
2752
+ }
2753
+
2754
+ export interface MapParams {
2755
+ /**
2756
+ * Url to map.
2757
+ */
2758
+ url: string;
2759
+
2760
+ /**
2761
+ * Country code for geolocation and proxy selection
2762
+ */
2763
+ country?:
2764
+ | 'AD'
2765
+ | 'AE'
2766
+ | 'AF'
2767
+ | 'AG'
2768
+ | 'AI'
2769
+ | 'AL'
2770
+ | 'AM'
2771
+ | 'AO'
2772
+ | 'AQ'
2773
+ | 'AR'
2774
+ | 'AS'
2775
+ | 'AT'
2776
+ | 'AU'
2777
+ | 'AW'
2778
+ | 'AX'
2779
+ | 'AZ'
2780
+ | 'BA'
2781
+ | 'BB'
2782
+ | 'BD'
2783
+ | 'BE'
2784
+ | 'BF'
2785
+ | 'BG'
2786
+ | 'BH'
2787
+ | 'BI'
2788
+ | 'BJ'
2789
+ | 'BL'
2790
+ | 'BM'
2791
+ | 'BN'
2792
+ | 'BO'
2793
+ | 'BQ'
2794
+ | 'BR'
2795
+ | 'BS'
2796
+ | 'BT'
2797
+ | 'BV'
2798
+ | 'BW'
2799
+ | 'BY'
2800
+ | 'BZ'
2801
+ | 'CA'
2802
+ | 'CC'
2803
+ | 'CD'
2804
+ | 'CF'
2805
+ | 'CG'
2806
+ | 'CH'
2807
+ | 'CI'
2808
+ | 'CK'
2809
+ | 'CL'
2810
+ | 'CM'
2811
+ | 'CN'
2812
+ | 'CO'
2813
+ | 'CR'
2814
+ | 'CU'
2815
+ | 'CV'
2816
+ | 'CW'
2817
+ | 'CX'
2818
+ | 'CY'
2819
+ | 'CZ'
2820
+ | 'DE'
2821
+ | 'DJ'
2822
+ | 'DK'
2823
+ | 'DM'
2824
+ | 'DO'
2825
+ | 'DZ'
2826
+ | 'EC'
2827
+ | 'EE'
2828
+ | 'EG'
2829
+ | 'EH'
2830
+ | 'ER'
2831
+ | 'ES'
2832
+ | 'ET'
2833
+ | 'FI'
2834
+ | 'FJ'
2835
+ | 'FK'
2836
+ | 'FM'
2837
+ | 'FO'
2838
+ | 'FR'
2839
+ | 'GA'
2840
+ | 'GB'
2841
+ | 'GD'
2842
+ | 'GE'
2843
+ | 'GF'
2844
+ | 'GG'
2845
+ | 'GH'
2846
+ | 'GI'
2847
+ | 'GL'
2848
+ | 'GM'
2849
+ | 'GN'
2850
+ | 'GP'
2851
+ | 'GQ'
2852
+ | 'GR'
2853
+ | 'GS'
2854
+ | 'GT'
2855
+ | 'GU'
2856
+ | 'GW'
2857
+ | 'GY'
2858
+ | 'HK'
2859
+ | 'HM'
2860
+ | 'HN'
2861
+ | 'HR'
2862
+ | 'HT'
2863
+ | 'HU'
2864
+ | 'ID'
2865
+ | 'IE'
2866
+ | 'IL'
2867
+ | 'IM'
2868
+ | 'IN'
2869
+ | 'IO'
2870
+ | 'IQ'
2871
+ | 'IR'
2872
+ | 'IS'
2873
+ | 'IT'
2874
+ | 'JE'
2875
+ | 'JM'
2876
+ | 'JO'
2877
+ | 'JP'
2878
+ | 'KE'
2879
+ | 'KG'
2880
+ | 'KH'
2881
+ | 'KI'
2882
+ | 'KM'
2883
+ | 'KN'
2884
+ | 'KP'
2885
+ | 'KR'
2886
+ | 'KW'
2887
+ | 'KY'
2888
+ | 'KZ'
2889
+ | 'LA'
2890
+ | 'LB'
2891
+ | 'LC'
2892
+ | 'LI'
2893
+ | 'LK'
2894
+ | 'LR'
2895
+ | 'LS'
2896
+ | 'LT'
2897
+ | 'LU'
2898
+ | 'LV'
2899
+ | 'LY'
2900
+ | 'MA'
2901
+ | 'MC'
2902
+ | 'MD'
2903
+ | 'ME'
2904
+ | 'MF'
2905
+ | 'MG'
2906
+ | 'MH'
2907
+ | 'MK'
2908
+ | 'ML'
2909
+ | 'MM'
2910
+ | 'MN'
2911
+ | 'MO'
2912
+ | 'MP'
2913
+ | 'MQ'
2914
+ | 'MR'
2915
+ | 'MS'
2916
+ | 'MT'
2917
+ | 'MU'
2918
+ | 'MV'
2919
+ | 'MW'
2920
+ | 'MX'
2921
+ | 'MY'
2922
+ | 'MZ'
2923
+ | 'NA'
2924
+ | 'NC'
2925
+ | 'NE'
2926
+ | 'NF'
2927
+ | 'NG'
2928
+ | 'NI'
2929
+ | 'NL'
2930
+ | 'NO'
2931
+ | 'NP'
2932
+ | 'NR'
2933
+ | 'NU'
2934
+ | 'NZ'
2935
+ | 'OM'
2936
+ | 'PA'
2937
+ | 'PE'
2938
+ | 'PF'
2939
+ | 'PG'
2940
+ | 'PH'
2941
+ | 'PK'
2942
+ | 'PL'
2943
+ | 'PM'
2944
+ | 'PN'
2945
+ | 'PR'
2946
+ | 'PS'
2947
+ | 'PT'
2948
+ | 'PW'
2949
+ | 'PY'
2950
+ | 'QA'
2951
+ | 'RE'
2952
+ | 'RO'
2953
+ | 'RS'
2954
+ | 'RU'
2955
+ | 'RW'
2956
+ | 'SA'
2957
+ | 'SB'
2958
+ | 'SC'
2959
+ | 'SD'
2960
+ | 'SE'
2961
+ | 'SG'
2962
+ | 'SH'
2963
+ | 'SI'
2964
+ | 'SJ'
2965
+ | 'SK'
2966
+ | 'SL'
2967
+ | 'SM'
2968
+ | 'SN'
2969
+ | 'SO'
2970
+ | 'SR'
2971
+ | 'SS'
2972
+ | 'ST'
2973
+ | 'SV'
2974
+ | 'SX'
2975
+ | 'SY'
2976
+ | 'SZ'
2977
+ | 'TC'
2978
+ | 'TD'
2979
+ | 'TF'
2980
+ | 'TG'
2981
+ | 'TH'
2982
+ | 'TJ'
2983
+ | 'TK'
2984
+ | 'TL'
2985
+ | 'TM'
2986
+ | 'TN'
2987
+ | 'TO'
2988
+ | 'TR'
2989
+ | 'TT'
2990
+ | 'TV'
2991
+ | 'TW'
2992
+ | 'TZ'
2993
+ | 'UA'
2994
+ | 'UG'
2995
+ | 'UM'
2996
+ | 'US'
2997
+ | 'UY'
2998
+ | 'UZ'
2999
+ | 'VA'
3000
+ | 'VC'
3001
+ | 'VE'
3002
+ | 'VG'
3003
+ | 'VI'
3004
+ | 'VN'
3005
+ | 'VU'
3006
+ | 'WF'
3007
+ | 'WS'
3008
+ | 'XK'
3009
+ | 'YE'
3010
+ | 'YT'
3011
+ | 'ZA'
3012
+ | 'ZM'
3013
+ | 'ZW';
3014
+
3015
+ /**
3016
+ * Includes subdomains of the main domain in the mapping process.
3017
+ */
3018
+ domain_filter?: 'domain' | 'subdomain' | 'all';
3019
+
3020
+ /**
3021
+ * Maximum number of links to return.
3022
+ */
3023
+ limit?: number;
3024
+
3025
+ /**
3026
+ * Locale for browser language and region settings
3027
+ */
3028
+ locale?:
3029
+ | 'aa-DJ'
3030
+ | 'aa-ER'
3031
+ | 'aa-ET'
3032
+ | 'af'
3033
+ | 'af-NA'
3034
+ | 'af-ZA'
3035
+ | 'ak'
3036
+ | 'ak-GH'
3037
+ | 'am'
3038
+ | 'am-ET'
3039
+ | 'an-ES'
3040
+ | 'ar'
3041
+ | 'ar-AE'
3042
+ | 'ar-BH'
3043
+ | 'ar-DZ'
3044
+ | 'ar-EG'
3045
+ | 'ar-IN'
3046
+ | 'ar-IQ'
3047
+ | 'ar-JO'
3048
+ | 'ar-KW'
3049
+ | 'ar-LB'
3050
+ | 'ar-LY'
3051
+ | 'ar-MA'
3052
+ | 'ar-OM'
3053
+ | 'ar-QA'
3054
+ | 'ar-SA'
3055
+ | 'ar-SD'
3056
+ | 'ar-SY'
3057
+ | 'ar-TN'
3058
+ | 'ar-YE'
3059
+ | 'as'
3060
+ | 'as-IN'
3061
+ | 'asa'
3062
+ | 'asa-TZ'
3063
+ | 'ast-ES'
3064
+ | 'az'
3065
+ | 'az-AZ'
3066
+ | 'az-Cyrl'
3067
+ | 'az-Cyrl-AZ'
3068
+ | 'az-Latn'
3069
+ | 'az-Latn-AZ'
3070
+ | 'be'
3071
+ | 'be-BY'
3072
+ | 'bem'
3073
+ | 'bem-ZM'
3074
+ | 'ber-DZ'
3075
+ | 'ber-MA'
3076
+ | 'bez'
3077
+ | 'bez-TZ'
3078
+ | 'bg'
3079
+ | 'bg-BG'
3080
+ | 'bho-IN'
3081
+ | 'bm'
3082
+ | 'bm-ML'
3083
+ | 'bn'
3084
+ | 'bn-BD'
3085
+ | 'bn-IN'
3086
+ | 'bo'
3087
+ | 'bo-CN'
3088
+ | 'bo-IN'
3089
+ | 'br-FR'
3090
+ | 'brx-IN'
3091
+ | 'bs'
3092
+ | 'bs-BA'
3093
+ | 'byn-ER'
3094
+ | 'ca'
3095
+ | 'ca-AD'
3096
+ | 'ca-ES'
3097
+ | 'ca-FR'
3098
+ | 'ca-IT'
3099
+ | 'cgg'
3100
+ | 'cgg-UG'
3101
+ | 'chr'
3102
+ | 'chr-US'
3103
+ | 'crh-UA'
3104
+ | 'cs'
3105
+ | 'cs-CZ'
3106
+ | 'csb-PL'
3107
+ | 'cv-RU'
3108
+ | 'cy'
3109
+ | 'cy-GB'
3110
+ | 'da'
3111
+ | 'da-DK'
3112
+ | 'dav'
3113
+ | 'dav-KE'
3114
+ | 'de'
3115
+ | 'de-AT'
3116
+ | 'de-BE'
3117
+ | 'de-CH'
3118
+ | 'de-DE'
3119
+ | 'de-LI'
3120
+ | 'de-LU'
3121
+ | 'dv-MV'
3122
+ | 'dz-BT'
3123
+ | 'ebu'
3124
+ | 'ebu-KE'
3125
+ | 'ee'
3126
+ | 'ee-GH'
3127
+ | 'ee-TG'
3128
+ | 'el'
3129
+ | 'el-CY'
3130
+ | 'el-GR'
3131
+ | 'en'
3132
+ | 'en-AG'
3133
+ | 'en-AS'
3134
+ | 'en-AU'
3135
+ | 'en-BE'
3136
+ | 'en-BW'
3137
+ | 'en-BZ'
3138
+ | 'en-CA'
3139
+ | 'en-DK'
3140
+ | 'en-GB'
3141
+ | 'en-GU'
3142
+ | 'en-HK'
3143
+ | 'en-IE'
3144
+ | 'en-IN'
3145
+ | 'en-JM'
3146
+ | 'en-MH'
3147
+ | 'en-MP'
3148
+ | 'en-MT'
3149
+ | 'en-MU'
3150
+ | 'en-NA'
3151
+ | 'en-NG'
3152
+ | 'en-NZ'
3153
+ | 'en-PH'
3154
+ | 'en-PK'
3155
+ | 'en-SG'
3156
+ | 'en-TT'
3157
+ | 'en-UM'
3158
+ | 'en-US'
3159
+ | 'en-VI'
3160
+ | 'en-ZA'
3161
+ | 'en-ZM'
3162
+ | 'en-ZW'
3163
+ | 'eo'
3164
+ | 'es'
3165
+ | 'es-419'
3166
+ | 'es-AR'
3167
+ | 'es-BO'
3168
+ | 'es-CL'
3169
+ | 'es-CO'
3170
+ | 'es-CR'
3171
+ | 'es-CU'
3172
+ | 'es-DO'
3173
+ | 'es-EC'
3174
+ | 'es-ES'
3175
+ | 'es-GQ'
3176
+ | 'es-GT'
3177
+ | 'es-HN'
3178
+ | 'es-MX'
3179
+ | 'es-NI'
3180
+ | 'es-PA'
3181
+ | 'es-PE'
3182
+ | 'es-PR'
3183
+ | 'es-PY'
3184
+ | 'es-SV'
3185
+ | 'es-US'
3186
+ | 'es-UY'
3187
+ | 'es-VE'
3188
+ | 'et'
3189
+ | 'et-EE'
3190
+ | 'eu'
3191
+ | 'eu-ES'
3192
+ | 'fa'
3193
+ | 'fa-AF'
3194
+ | 'fa-IR'
3195
+ | 'ff'
3196
+ | 'ff-SN'
3197
+ | 'fi'
3198
+ | 'fi-FI'
3199
+ | 'fil'
3200
+ | 'fil-PH'
3201
+ | 'fo'
3202
+ | 'fo-FO'
3203
+ | 'fr'
3204
+ | 'fr-BE'
3205
+ | 'fr-BF'
3206
+ | 'fr-BI'
3207
+ | 'fr-BJ'
3208
+ | 'fr-BL'
3209
+ | 'fr-CA'
3210
+ | 'fr-CD'
3211
+ | 'fr-CF'
3212
+ | 'fr-CG'
3213
+ | 'fr-CH'
3214
+ | 'fr-CI'
3215
+ | 'fr-CM'
3216
+ | 'fr-DJ'
3217
+ | 'fr-FR'
3218
+ | 'fr-GA'
3219
+ | 'fr-GN'
3220
+ | 'fr-GP'
3221
+ | 'fr-GQ'
3222
+ | 'fr-KM'
3223
+ | 'fr-LU'
3224
+ | 'fr-MC'
3225
+ | 'fr-MF'
3226
+ | 'fr-MG'
3227
+ | 'fr-ML'
3228
+ | 'fr-MQ'
3229
+ | 'fr-NE'
3230
+ | 'fr-RE'
3231
+ | 'fr-RW'
3232
+ | 'fr-SN'
3233
+ | 'fr-TD'
3234
+ | 'fr-TG'
3235
+ | 'fur-IT'
3236
+ | 'fy-DE'
3237
+ | 'fy-NL'
3238
+ | 'ga'
3239
+ | 'ga-IE'
3240
+ | 'gd-GB'
3241
+ | 'gez-ER'
3242
+ | 'gez-ET'
3243
+ | 'gl'
3244
+ | 'gl-ES'
3245
+ | 'gsw'
3246
+ | 'gsw-CH'
3247
+ | 'gu'
3248
+ | 'gu-IN'
3249
+ | 'guz'
3250
+ | 'guz-KE'
3251
+ | 'gv'
3252
+ | 'gv-GB'
3253
+ | 'ha'
3254
+ | 'ha-Latn'
3255
+ | 'ha-Latn-GH'
3256
+ | 'ha-Latn-NE'
3257
+ | 'ha-Latn-NG'
3258
+ | 'ha-NG'
3259
+ | 'haw'
3260
+ | 'haw-US'
3261
+ | 'he'
3262
+ | 'he-IL'
3263
+ | 'hi'
3264
+ | 'hi-IN'
3265
+ | 'hne-IN'
3266
+ | 'hr'
3267
+ | 'hr-HR'
3268
+ | 'hsb-DE'
3269
+ | 'ht-HT'
3270
+ | 'hu'
3271
+ | 'hu-HU'
3272
+ | 'hy'
3273
+ | 'hy-AM'
3274
+ | 'id'
3275
+ | 'id-ID'
3276
+ | 'ig'
3277
+ | 'ig-NG'
3278
+ | 'ii'
3279
+ | 'ii-CN'
3280
+ | 'ik-CA'
3281
+ | 'is'
3282
+ | 'is-IS'
3283
+ | 'it'
3284
+ | 'it-CH'
3285
+ | 'it-IT'
3286
+ | 'iu-CA'
3287
+ | 'iw-IL'
3288
+ | 'ja'
3289
+ | 'ja-JP'
3290
+ | 'jmc'
3291
+ | 'jmc-TZ'
3292
+ | 'ka'
3293
+ | 'ka-GE'
3294
+ | 'kab'
3295
+ | 'kab-DZ'
3296
+ | 'kam'
3297
+ | 'kam-KE'
3298
+ | 'kde'
3299
+ | 'kde-TZ'
3300
+ | 'kea'
3301
+ | 'kea-CV'
3302
+ | 'khq'
3303
+ | 'khq-ML'
3304
+ | 'ki'
3305
+ | 'ki-KE'
3306
+ | 'kk'
3307
+ | 'kk-Cyrl'
3308
+ | 'kk-Cyrl-KZ'
3309
+ | 'kk-KZ'
3310
+ | 'kl'
3311
+ | 'kl-GL'
3312
+ | 'kln'
3313
+ | 'kln-KE'
3314
+ | 'km'
3315
+ | 'km-KH'
3316
+ | 'kn'
3317
+ | 'kn-IN'
3318
+ | 'ko'
3319
+ | 'ko-KR'
3320
+ | 'kok'
3321
+ | 'kok-IN'
3322
+ | 'ks-IN'
3323
+ | 'ku-TR'
3324
+ | 'kw'
3325
+ | 'kw-GB'
3326
+ | 'ky-KG'
3327
+ | 'lag'
3328
+ | 'lag-TZ'
3329
+ | 'lb-LU'
3330
+ | 'lg'
3331
+ | 'lg-UG'
3332
+ | 'li-BE'
3333
+ | 'li-NL'
3334
+ | 'lij-IT'
3335
+ | 'lo-LA'
3336
+ | 'lt'
3337
+ | 'lt-LT'
3338
+ | 'luo'
3339
+ | 'luo-KE'
3340
+ | 'luy'
3341
+ | 'luy-KE'
3342
+ | 'lv'
3343
+ | 'lv-LV'
3344
+ | 'mag-IN'
3345
+ | 'mai-IN'
3346
+ | 'mas'
3347
+ | 'mas-KE'
3348
+ | 'mas-TZ'
3349
+ | 'mer'
3350
+ | 'mer-KE'
3351
+ | 'mfe'
3352
+ | 'mfe-MU'
3353
+ | 'mg'
3354
+ | 'mg-MG'
3355
+ | 'mhr-RU'
3356
+ | 'mi-NZ'
3357
+ | 'mk'
3358
+ | 'mk-MK'
3359
+ | 'ml'
3360
+ | 'ml-IN'
3361
+ | 'mn-MN'
3362
+ | 'mr'
3363
+ | 'mr-IN'
3364
+ | 'ms'
3365
+ | 'ms-BN'
3366
+ | 'ms-MY'
3367
+ | 'mt'
3368
+ | 'mt-MT'
3369
+ | 'my'
3370
+ | 'my-MM'
3371
+ | 'nan-TW'
3372
+ | 'naq'
3373
+ | 'naq-NA'
3374
+ | 'nb'
3375
+ | 'nb-NO'
3376
+ | 'nd'
3377
+ | 'nd-ZW'
3378
+ | 'nds-DE'
3379
+ | 'nds-NL'
3380
+ | 'ne'
3381
+ | 'ne-IN'
3382
+ | 'ne-NP'
3383
+ | 'nl'
3384
+ | 'nl-AW'
3385
+ | 'nl-BE'
3386
+ | 'nl-NL'
3387
+ | 'nn'
3388
+ | 'nn-NO'
3389
+ | 'nr-ZA'
3390
+ | 'nso-ZA'
3391
+ | 'nyn'
3392
+ | 'nyn-UG'
3393
+ | 'oc-FR'
3394
+ | 'om'
3395
+ | 'om-ET'
3396
+ | 'om-KE'
3397
+ | 'or'
3398
+ | 'or-IN'
3399
+ | 'os-RU'
3400
+ | 'pa'
3401
+ | 'pa-Arab'
3402
+ | 'pa-Arab-PK'
3403
+ | 'pa-Guru'
3404
+ | 'pa-Guru-IN'
3405
+ | 'pa-IN'
3406
+ | 'pa-PK'
3407
+ | 'pap-AN'
3408
+ | 'pl'
3409
+ | 'pl-PL'
3410
+ | 'ps'
3411
+ | 'ps-AF'
3412
+ | 'pt'
3413
+ | 'pt-BR'
3414
+ | 'pt-GW'
3415
+ | 'pt-MZ'
3416
+ | 'pt-PT'
3417
+ | 'rm'
3418
+ | 'rm-CH'
3419
+ | 'ro'
3420
+ | 'ro-MD'
3421
+ | 'ro-RO'
3422
+ | 'rof'
3423
+ | 'rof-TZ'
3424
+ | 'ru'
3425
+ | 'ru-MD'
3426
+ | 'ru-RU'
3427
+ | 'ru-UA'
3428
+ | 'rw'
3429
+ | 'rw-RW'
3430
+ | 'rwk'
3431
+ | 'rwk-TZ'
3432
+ | 'sa-IN'
3433
+ | 'saq'
3434
+ | 'saq-KE'
3435
+ | 'sc-IT'
3436
+ | 'sd-IN'
3437
+ | 'se-NO'
3438
+ | 'seh'
3439
+ | 'seh-MZ'
3440
+ | 'ses'
3441
+ | 'ses-ML'
3442
+ | 'sg'
3443
+ | 'sg-CF'
3444
+ | 'shi'
3445
+ | 'shi-Latn'
3446
+ | 'shi-Latn-MA'
3447
+ | 'shi-Tfng'
3448
+ | 'shi-Tfng-MA'
3449
+ | 'shs-CA'
3450
+ | 'si'
3451
+ | 'si-LK'
3452
+ | 'sid-ET'
3453
+ | 'sk'
3454
+ | 'sk-SK'
3455
+ | 'sl'
3456
+ | 'sl-SI'
3457
+ | 'sn'
3458
+ | 'sn-ZW'
3459
+ | 'so'
3460
+ | 'so-DJ'
3461
+ | 'so-ET'
3462
+ | 'so-KE'
3463
+ | 'so-SO'
3464
+ | 'sq'
3465
+ | 'sq-AL'
3466
+ | 'sq-MK'
3467
+ | 'sr'
3468
+ | 'sr-Cyrl'
3469
+ | 'sr-Cyrl-BA'
3470
+ | 'sr-Cyrl-ME'
3471
+ | 'sr-Cyrl-RS'
3472
+ | 'sr-Latn'
3473
+ | 'sr-Latn-BA'
3474
+ | 'sr-Latn-ME'
3475
+ | 'sr-Latn-RS'
3476
+ | 'sr-ME'
3477
+ | 'sr-RS'
3478
+ | 'ss-ZA'
3479
+ | 'st-ZA'
3480
+ | 'sv'
3481
+ | 'sv-FI'
3482
+ | 'sv-SE'
3483
+ | 'sw'
3484
+ | 'sw-KE'
3485
+ | 'sw-TZ'
3486
+ | 'ta'
3487
+ | 'ta-IN'
3488
+ | 'ta-LK'
3489
+ | 'te'
3490
+ | 'te-IN'
3491
+ | 'teo'
3492
+ | 'teo-KE'
3493
+ | 'teo-UG'
3494
+ | 'tg-TJ'
3495
+ | 'th'
3496
+ | 'th-TH'
3497
+ | 'ti'
3498
+ | 'ti-ER'
3499
+ | 'ti-ET'
3500
+ | 'tig-ER'
3501
+ | 'tk-TM'
3502
+ | 'tl-PH'
3503
+ | 'tn-ZA'
3504
+ | 'to'
3505
+ | 'to-TO'
3506
+ | 'tr'
3507
+ | 'tr-CY'
3508
+ | 'tr-TR'
3509
+ | 'ts-ZA'
3510
+ | 'tt-RU'
3511
+ | 'tzm'
3512
+ | 'tzm-Latn'
3513
+ | 'tzm-Latn-MA'
3514
+ | 'ug-CN'
3515
+ | 'uk'
3516
+ | 'uk-UA'
3517
+ | 'unm-US'
3518
+ | 'ur'
3519
+ | 'ur-IN'
3520
+ | 'ur-PK'
3521
+ | 'uz'
3522
+ | 'uz-Arab'
3523
+ | 'uz-Arab-AF'
3524
+ | 'uz-Cyrl'
3525
+ | 'uz-Cyrl-UZ'
3526
+ | 'uz-Latn'
3527
+ | 'uz-Latn-UZ'
3528
+ | 'uz-UZ'
3529
+ | 've-ZA'
3530
+ | 'vi'
3531
+ | 'vi-VN'
3532
+ | 'vun'
3533
+ | 'vun-TZ'
3534
+ | 'wa-BE'
3535
+ | 'wae-CH'
3536
+ | 'wal-ET'
3537
+ | 'wo-SN'
3538
+ | 'xh-ZA'
3539
+ | 'xog'
3540
+ | 'xog-UG'
3541
+ | 'yi-US'
3542
+ | 'yo'
3543
+ | 'yo-NG'
3544
+ | 'yue-HK'
3545
+ | 'zh'
3546
+ | 'zh-CN'
3547
+ | 'zh-HK'
3548
+ | 'zh-Hans'
3549
+ | 'zh-Hans-CN'
3550
+ | 'zh-Hans-HK'
3551
+ | 'zh-Hans-MO'
3552
+ | 'zh-Hans-SG'
3553
+ | 'zh-Hant'
3554
+ | 'zh-Hant-HK'
3555
+ | 'zh-Hant-MO'
3556
+ | 'zh-Hant-TW'
3557
+ | 'zh-SG'
3558
+ | 'zh-TW'
3559
+ | 'zu'
3560
+ | 'zu-ZA'
3561
+ | 'auto';
3562
+
3563
+ /**
3564
+ * Sitemap and other methods will be used together to find URLs.
3565
+ */
3566
+ sitemap?: 'skip' | 'include' | 'only';
3567
+ }
3568
+
3569
+ export interface SearchParams {
3570
+ /**
3571
+ * Search query string
3572
+ */
3573
+ query: string;
3574
+
3575
+ /**
3576
+ * Filter by content type (only supported with focus=general). Supports semantic
3577
+ * groups ('documents', 'spreadsheets', 'presentations') and specific formats
3578
+ * ('pdf', 'docx', 'xlsx', etc.)
3579
+ */
3580
+ content_type?: Array<string> | null;
3581
+
3582
+ country?: string;
3583
+
3584
+ /**
3585
+ * If True, fetches and extracts full page content for each search result. If
3586
+ * False, returns only metadata (title, snippet, URL)
3587
+ */
3588
+ deep_search?: boolean;
3589
+
3590
+ /**
3591
+ * Filter results before this date (format: YYYY-MM-DD or YYYY)
3592
+ */
3593
+ end_date?: string | null;
3594
+
3595
+ /**
3596
+ * List of domains to exclude from search results. Maximum 50 domains.
3597
+ */
3598
+ exclude_domains?: Array<string> | null;
3599
+
3600
+ /**
3601
+ * Generate LLM answer summary based on search result snippets (works with both
3602
+ * deep_search=True and False)
3603
+ */
3604
+ include_answer?: boolean;
3605
+
3606
+ /**
3607
+ * List of domains to include in search results. Maximum 50 domains.
3608
+ */
3609
+ include_domains?: Array<string> | null;
3610
+
3611
+ locale?: string;
3612
+
3613
+ /**
3614
+ * Maximum number of subagents to execute in parallel for WSA focus modes
3615
+ * (shopping, social, geo). Ignored for traditional SERP focus modes. Default: 3,
3616
+ * Range: 1-10.
3617
+ */
3618
+ max_subagents?: number;
3619
+
3620
+ /**
3621
+ * Maximum number of results to return (actual count may be less)
3622
+ */
3623
+ num_results?: number;
3624
+
3625
+ /**
3626
+ * Output format: plain_text, markdown, or simplified_html
3627
+ */
3628
+ parsing_type?: 'plain_text' | 'markdown' | 'simplified_html';
3629
+
3630
+ /**
3631
+ * Enum representing the search engines supported by Nimble ⚠️ DEPRECATED: This
3632
+ * parameter is ignored. Use 'focus' parameter instead.
3633
+ */
3634
+ search_engine?: 'google_search' | 'google_sge' | 'bing_search' | 'yandex_search' | null;
3635
+
3636
+ /**
3637
+ * Filter results after this date (format: YYYY-MM-DD or YYYY)
3638
+ */
3639
+ start_date?: string | null;
3640
+
3641
+ /**
3642
+ * Time range filters passed to Webit SERP API as 'time' parameter.
3643
+ */
3644
+ time_range?: 'hour' | 'day' | 'week' | 'month' | 'year' | null;
3645
+
3646
+ /**
3647
+ * Search focus/specialization. Can be a single focus mode (e.g., 'shopping',
3648
+ * 'social') or a list of explicit subagent names (e.g., ['amazon_serp',
3649
+ * 'target_serp'])
3650
+ */
3651
+ topic?: string | Array<string>;
3652
+ }
3653
+
3654
+ export declare namespace TopLevel {
3655
+ export {
3656
+ type ExtractResponse as ExtractResponse,
3657
+ type ExtractAsyncResponse as ExtractAsyncResponse,
3658
+ type MapResponse as MapResponse,
3659
+ type SearchResponse as SearchResponse,
3660
+ type ExtractParams as ExtractParams,
3661
+ type ExtractAsyncParams as ExtractAsyncParams,
3662
+ type MapParams as MapParams,
3663
+ type SearchParams as SearchParams,
3664
+ };
3665
+ }