@onkernel/sdk 0.120.0 → 0.122.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.
- package/CHANGELOG.md +19 -0
- package/client.d.mts +4 -4
- package/client.d.mts.map +1 -1
- package/client.d.ts +4 -4
- package/client.d.ts.map +1 -1
- package/client.js.map +1 -1
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/browser-pools.d.mts +8 -4
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +8 -4
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browsers/browsers.d.mts +47 -18
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +47 -18
- package/resources/browsers/browsers.d.ts.map +1 -1
- package/resources/browsers/browsers.js.map +1 -1
- package/resources/browsers/browsers.mjs.map +1 -1
- package/resources/browsers/index.d.mts +1 -1
- package/resources/browsers/index.d.mts.map +1 -1
- package/resources/browsers/index.d.ts +1 -1
- package/resources/browsers/index.d.ts.map +1 -1
- package/resources/browsers/index.js.map +1 -1
- package/resources/browsers/index.mjs.map +1 -1
- package/resources/browsers/telemetry.d.mts +80 -32
- package/resources/browsers/telemetry.d.mts.map +1 -1
- package/resources/browsers/telemetry.d.ts +80 -32
- package/resources/browsers/telemetry.d.ts.map +1 -1
- package/resources/config-registry/config-registry.d.mts +5 -18
- package/resources/config-registry/config-registry.d.mts.map +1 -1
- package/resources/config-registry/config-registry.d.ts +5 -18
- package/resources/config-registry/config-registry.d.ts.map +1 -1
- package/resources/config-registry/config-registry.js.map +1 -1
- package/resources/config-registry/config-registry.mjs.map +1 -1
- package/resources/index.d.mts +2 -2
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +2 -2
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/proxies.d.mts +45 -125
- package/resources/proxies.d.mts.map +1 -1
- package/resources/proxies.d.ts +45 -125
- package/resources/proxies.d.ts.map +1 -1
- package/resources/proxies.js +6 -8
- package/resources/proxies.js.map +1 -1
- package/resources/proxies.mjs +6 -8
- package/resources/proxies.mjs.map +1 -1
- package/resources/vaults/index.d.mts +1 -1
- package/resources/vaults/index.d.mts.map +1 -1
- package/resources/vaults/index.d.ts +1 -1
- package/resources/vaults/index.d.ts.map +1 -1
- package/resources/vaults/index.js.map +1 -1
- package/resources/vaults/index.mjs.map +1 -1
- package/resources/vaults/items.d.mts +48 -22
- package/resources/vaults/items.d.mts.map +1 -1
- package/resources/vaults/items.d.ts +48 -22
- package/resources/vaults/items.d.ts.map +1 -1
- package/resources/vaults/items.js +2 -2
- package/resources/vaults/items.mjs +2 -2
- package/resources/vaults/vaults.d.mts +62 -1
- package/resources/vaults/vaults.d.mts.map +1 -1
- package/resources/vaults/vaults.d.ts +62 -1
- package/resources/vaults/vaults.d.ts.map +1 -1
- package/resources/vaults/vaults.js +19 -0
- package/resources/vaults/vaults.js.map +1 -1
- package/resources/vaults/vaults.mjs +19 -0
- package/resources/vaults/vaults.mjs.map +1 -1
- package/src/client.ts +4 -0
- package/src/resources/browser-pools.ts +8 -4
- package/src/resources/browsers/browsers.ts +49 -17
- package/src/resources/browsers/index.ts +1 -0
- package/src/resources/browsers/telemetry.ts +111 -32
- package/src/resources/config-registry/config-registry.ts +4 -19
- package/src/resources/index.ts +2 -0
- package/src/resources/proxies.ts +39 -131
- package/src/resources/vaults/index.ts +1 -0
- package/src/resources/vaults/items.ts +50 -25
- package/src/resources/vaults/vaults.ts +73 -0
- package/src/version.ts +1 -1
- package/version.d.mts +1 -1
- package/version.d.ts +1 -1
- package/version.js +1 -1
- package/version.mjs +1 -1
|
@@ -194,15 +194,19 @@ export namespace BrowserCallStack {
|
|
|
194
194
|
}
|
|
195
195
|
|
|
196
196
|
/**
|
|
197
|
-
* A
|
|
197
|
+
* A captcha challenge reached an observed or inferred terminal outcome.
|
|
198
198
|
*/
|
|
199
199
|
export interface BrowserCaptchaChallengeResultEvent {
|
|
200
200
|
category: 'captcha';
|
|
201
201
|
|
|
202
202
|
/**
|
|
203
|
-
*
|
|
204
|
-
*
|
|
205
|
-
*
|
|
203
|
+
* An observed challenge emits one outcome across any number of solver tasks. For
|
|
204
|
+
* eligible providers without a widget observer, each successful token task emits
|
|
205
|
+
* an inferred solved result instead; multiple such results may belong to one
|
|
206
|
+
* challenge. Failed tasks and image_challenge rounds produce no inferred result.
|
|
207
|
+
* Exactly one of challenge_id or task_id is present: challenge_id on an observed
|
|
208
|
+
* result, task_id on an inferred one. A challenge whose tasks all fail produces
|
|
209
|
+
* task events only, so consumers fall back to captcha_solve_result for it.
|
|
206
210
|
*/
|
|
207
211
|
data: BrowserCaptchaChallengeResultEvent.Data;
|
|
208
212
|
|
|
@@ -226,15 +230,17 @@ export interface BrowserCaptchaChallengeResultEvent {
|
|
|
226
230
|
|
|
227
231
|
export namespace BrowserCaptchaChallengeResultEvent {
|
|
228
232
|
/**
|
|
229
|
-
*
|
|
230
|
-
*
|
|
231
|
-
*
|
|
233
|
+
* An observed challenge emits one outcome across any number of solver tasks. For
|
|
234
|
+
* eligible providers without a widget observer, each successful token task emits
|
|
235
|
+
* an inferred solved result instead; multiple such results may belong to one
|
|
236
|
+
* challenge. Failed tasks and image_challenge rounds produce no inferred result.
|
|
237
|
+
* Exactly one of challenge_id or task_id is present: challenge_id on an observed
|
|
238
|
+
* result, task_id on an inferred one. A challenge whose tasks all fail produces
|
|
239
|
+
* task events only, so consumers fall back to captcha_solve_result for it.
|
|
232
240
|
*/
|
|
233
241
|
export interface Data {
|
|
234
242
|
/**
|
|
235
|
-
*
|
|
236
|
-
* bucket (recaptcha_v2 or recaptcha_v3), press-and-hold challenges use
|
|
237
|
-
* press_and_hold, and unlisted kinds use other.
|
|
243
|
+
* @deprecated Deprecated: use captcha_provider.
|
|
238
244
|
*/
|
|
239
245
|
captcha_type:
|
|
240
246
|
| 'hcaptcha'
|
|
@@ -245,34 +251,67 @@ export namespace BrowserCaptchaChallengeResultEvent {
|
|
|
245
251
|
| 'press_and_hold'
|
|
246
252
|
| 'other';
|
|
247
253
|
|
|
254
|
+
/**
|
|
255
|
+
* Wall-clock duration from the challenge appearing to its terminal outcome,
|
|
256
|
+
* covering every solver attempt in between. For an inferred result, the duration
|
|
257
|
+
* of its solver task.
|
|
258
|
+
*/
|
|
259
|
+
duration_ms: number;
|
|
260
|
+
|
|
261
|
+
/**
|
|
262
|
+
* Terminal outcome of a challenge. solved: the page observed the challenge clear
|
|
263
|
+
* after a solver attempt, or an inferred result reports a token for the whole
|
|
264
|
+
* widget without page observation. failure: a terminal solver failure occurred, or
|
|
265
|
+
* all attempts ended while the challenge remained. timeout: the challenge-level
|
|
266
|
+
* wait budget expired while the challenge remained. abandoned: observation ended
|
|
267
|
+
* without an attributable terminal challenge outcome. This includes a dismissed
|
|
268
|
+
* widget or page unload without a solved signal or terminal solver outcome, and a
|
|
269
|
+
* token appearing while multiple same-provider challenges are open, because the
|
|
270
|
+
* producer cannot attribute that token to this visible challenge. A
|
|
271
|
+
* captcha_solve_result with the same challenge_id may therefore report success
|
|
272
|
+
* while the challenge result reports abandoned. A solved challenge does not prove
|
|
273
|
+
* the site accepted the token or that the guarded action succeeded.
|
|
274
|
+
*/
|
|
275
|
+
status: 'solved' | 'failure' | 'timeout' | 'abandoned';
|
|
276
|
+
|
|
277
|
+
/**
|
|
278
|
+
* Captcha product the challenge belongs to, not the service that solved it.
|
|
279
|
+
* Enterprise reCAPTCHA variants are grouped into their version bucket
|
|
280
|
+
* (recaptcha_v2 or recaptcha_v3), FunCaptcha uses arkose, press-and-hold
|
|
281
|
+
* challenges served by HUMAN (formerly PerimeterX) use human, and unlisted
|
|
282
|
+
* products use other.
|
|
283
|
+
*/
|
|
284
|
+
captcha_provider?:
|
|
285
|
+
| 'hcaptcha'
|
|
286
|
+
| 'recaptcha_v2'
|
|
287
|
+
| 'recaptcha_v3'
|
|
288
|
+
| 'turnstile'
|
|
289
|
+
| 'geetest'
|
|
290
|
+
| 'arkose'
|
|
291
|
+
| 'human'
|
|
292
|
+
| 'other';
|
|
293
|
+
|
|
248
294
|
/**
|
|
249
295
|
* Opaque identifier shared by events for one visible challenge. An image-grid
|
|
250
296
|
* captcha may create multiple task_id values for one challenge_id. The same value
|
|
251
297
|
* may continue across a page reload when the challenge episode continues. It does
|
|
252
298
|
* not indicate task ordering or challenge completion.
|
|
253
299
|
*/
|
|
254
|
-
challenge_id
|
|
300
|
+
challenge_id?: string;
|
|
255
301
|
|
|
256
302
|
/**
|
|
257
|
-
*
|
|
258
|
-
*
|
|
303
|
+
* True when the relay derived this result from a successful token task without
|
|
304
|
+
* observing the page. An inferred result has task_id instead of challenge_id.
|
|
305
|
+
* Absent on page-observed results.
|
|
259
306
|
*/
|
|
260
|
-
|
|
307
|
+
inferred?: boolean;
|
|
261
308
|
|
|
262
309
|
/**
|
|
263
|
-
*
|
|
264
|
-
*
|
|
265
|
-
*
|
|
266
|
-
* challenge-level wait budget expired while the challenge remained. abandoned:
|
|
267
|
-
* observation ended without an attributable terminal challenge outcome. This
|
|
268
|
-
* includes a dismissed widget or page unload without a solved signal or terminal
|
|
269
|
-
* solver outcome, and a token appearing while multiple same-provider challenges
|
|
270
|
-
* are open, because the producer cannot attribute that token to this visible
|
|
271
|
-
* challenge. A captcha_solve_result with the same challenge_id may therefore
|
|
272
|
-
* report success while the challenge result reports abandoned. A solved challenge
|
|
273
|
-
* does not prove the site accepted the token or that the guarded action succeeded.
|
|
310
|
+
* The task_id of the solver task an inferred result was derived from. Join on it
|
|
311
|
+
* to pair the result with that task's captcha_solve_started and
|
|
312
|
+
* captcha_solve_result. Present only when inferred is true.
|
|
274
313
|
*/
|
|
275
|
-
|
|
314
|
+
task_id?: string;
|
|
276
315
|
|
|
277
316
|
/**
|
|
278
317
|
* Host of the page where the challenge appeared.
|
|
@@ -315,9 +354,7 @@ export interface BrowserCaptchaSolveResultEvent {
|
|
|
315
354
|
export namespace BrowserCaptchaSolveResultEvent {
|
|
316
355
|
export interface Data {
|
|
317
356
|
/**
|
|
318
|
-
*
|
|
319
|
-
* bucket (recaptcha_v2 or recaptcha_v3), press-and-hold challenges use
|
|
320
|
-
* press_and_hold, and unlisted kinds use other.
|
|
357
|
+
* @deprecated Deprecated: use captcha_provider and task_kind.
|
|
321
358
|
*/
|
|
322
359
|
captcha_type:
|
|
323
360
|
| 'hcaptcha'
|
|
@@ -343,6 +380,23 @@ export namespace BrowserCaptchaSolveResultEvent {
|
|
|
343
380
|
*/
|
|
344
381
|
status: 'success' | 'failure' | 'timeout' | 'abandoned';
|
|
345
382
|
|
|
383
|
+
/**
|
|
384
|
+
* Captcha product the challenge belongs to, not the service that solved it.
|
|
385
|
+
* Enterprise reCAPTCHA variants are grouped into their version bucket
|
|
386
|
+
* (recaptcha_v2 or recaptcha_v3), FunCaptcha uses arkose, press-and-hold
|
|
387
|
+
* challenges served by HUMAN (formerly PerimeterX) use human, and unlisted
|
|
388
|
+
* products use other.
|
|
389
|
+
*/
|
|
390
|
+
captcha_provider?:
|
|
391
|
+
| 'hcaptcha'
|
|
392
|
+
| 'recaptcha_v2'
|
|
393
|
+
| 'recaptcha_v3'
|
|
394
|
+
| 'turnstile'
|
|
395
|
+
| 'geetest'
|
|
396
|
+
| 'arkose'
|
|
397
|
+
| 'human'
|
|
398
|
+
| 'other';
|
|
399
|
+
|
|
346
400
|
/**
|
|
347
401
|
* Opaque identifier shared by events for one visible challenge. An image-grid
|
|
348
402
|
* captcha may create multiple task_id values for one challenge_id. The same value
|
|
@@ -362,6 +416,11 @@ export namespace BrowserCaptchaSolveResultEvent {
|
|
|
362
416
|
*/
|
|
363
417
|
task_id?: string;
|
|
364
418
|
|
|
419
|
+
/**
|
|
420
|
+
* What the solver task produces. Absent when the producer cannot tell.
|
|
421
|
+
*/
|
|
422
|
+
task_kind?: 'token' | 'image_challenge' | 'press_and_hold';
|
|
423
|
+
|
|
365
424
|
/**
|
|
366
425
|
* Host of the page where the captcha was solved.
|
|
367
426
|
*/
|
|
@@ -415,9 +474,7 @@ export namespace BrowserCaptchaSolveStartedEvent {
|
|
|
415
474
|
*/
|
|
416
475
|
export interface Data {
|
|
417
476
|
/**
|
|
418
|
-
*
|
|
419
|
-
* bucket (recaptcha_v2 or recaptcha_v3), press-and-hold challenges use
|
|
420
|
-
* press_and_hold, and unlisted kinds use other.
|
|
477
|
+
* @deprecated Deprecated: use captcha_provider and task_kind.
|
|
421
478
|
*/
|
|
422
479
|
captcha_type:
|
|
423
480
|
| 'hcaptcha'
|
|
@@ -428,6 +485,23 @@ export namespace BrowserCaptchaSolveStartedEvent {
|
|
|
428
485
|
| 'press_and_hold'
|
|
429
486
|
| 'other';
|
|
430
487
|
|
|
488
|
+
/**
|
|
489
|
+
* Captcha product the challenge belongs to, not the service that solved it.
|
|
490
|
+
* Enterprise reCAPTCHA variants are grouped into their version bucket
|
|
491
|
+
* (recaptcha_v2 or recaptcha_v3), FunCaptcha uses arkose, press-and-hold
|
|
492
|
+
* challenges served by HUMAN (formerly PerimeterX) use human, and unlisted
|
|
493
|
+
* products use other.
|
|
494
|
+
*/
|
|
495
|
+
captcha_provider?:
|
|
496
|
+
| 'hcaptcha'
|
|
497
|
+
| 'recaptcha_v2'
|
|
498
|
+
| 'recaptcha_v3'
|
|
499
|
+
| 'turnstile'
|
|
500
|
+
| 'geetest'
|
|
501
|
+
| 'arkose'
|
|
502
|
+
| 'human'
|
|
503
|
+
| 'other';
|
|
504
|
+
|
|
431
505
|
/**
|
|
432
506
|
* Opaque identifier shared by events for one visible challenge. An image-grid
|
|
433
507
|
* captcha may create multiple task_id values for one challenge_id. The same value
|
|
@@ -441,6 +515,11 @@ export namespace BrowserCaptchaSolveStartedEvent {
|
|
|
441
515
|
*/
|
|
442
516
|
task_id?: string;
|
|
443
517
|
|
|
518
|
+
/**
|
|
519
|
+
* What the solver task produces. Absent when the producer cannot tell.
|
|
520
|
+
*/
|
|
521
|
+
task_kind?: 'token' | 'image_challenge' | 'press_and_hold';
|
|
522
|
+
|
|
444
523
|
/**
|
|
445
524
|
* Host of the page where the captcha is being solved. May be empty for solver
|
|
446
525
|
* tasks that carry no page URL.
|
|
@@ -303,11 +303,7 @@ export namespace Proxy {
|
|
|
303
303
|
* Configuration for routing traffic through a proxy.
|
|
304
304
|
*/
|
|
305
305
|
export interface Create {
|
|
306
|
-
|
|
307
|
-
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
308
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
309
|
-
*/
|
|
310
|
-
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
306
|
+
type: 'isp' | 'residential' | 'mobile' | 'custom';
|
|
311
307
|
|
|
312
308
|
/**
|
|
313
309
|
* Hostnames that should bypass the parent proxy and connect directly.
|
|
@@ -315,10 +311,9 @@ export namespace Proxy {
|
|
|
315
311
|
bypass_hosts?: Array<string>;
|
|
316
312
|
|
|
317
313
|
/**
|
|
318
|
-
* Configuration
|
|
314
|
+
* Configuration for an ISP proxy.
|
|
319
315
|
*/
|
|
320
316
|
config?:
|
|
321
|
-
| Create.DatacenterProxyConfig
|
|
322
317
|
| Create.IspProxyConfig
|
|
323
318
|
| Create.ResidentialProxyConfig
|
|
324
319
|
| Create.MobileProxyConfig
|
|
@@ -336,23 +331,13 @@ export namespace Proxy {
|
|
|
336
331
|
}
|
|
337
332
|
|
|
338
333
|
export namespace Create {
|
|
339
|
-
/**
|
|
340
|
-
* Configuration for a datacenter proxy.
|
|
341
|
-
*/
|
|
342
|
-
export interface DatacenterProxyConfig {
|
|
343
|
-
/**
|
|
344
|
-
* ISO 3166 country code. Defaults to US if not provided.
|
|
345
|
-
*/
|
|
346
|
-
country?: string;
|
|
347
|
-
}
|
|
348
|
-
|
|
349
334
|
/**
|
|
350
335
|
* Configuration for an ISP proxy.
|
|
351
336
|
*/
|
|
352
337
|
export interface IspProxyConfig {
|
|
353
338
|
/**
|
|
354
|
-
* ISO 3166 country code. Supported countries are US, GB, FR, DE, and
|
|
355
|
-
* to US if not provided.
|
|
339
|
+
* ISO 3166 country code. Supported countries are US, GB, FR, DE, SG, and KR.
|
|
340
|
+
* Defaults to US if not provided.
|
|
356
341
|
*/
|
|
357
342
|
country?: string;
|
|
358
343
|
}
|
package/src/resources/index.ts
CHANGED
|
@@ -43,6 +43,7 @@ export {
|
|
|
43
43
|
type BrowserMemory,
|
|
44
44
|
type BrowserMemoryRequest,
|
|
45
45
|
type BrowserNetworkConfig,
|
|
46
|
+
type BrowserNetworkUpdate,
|
|
46
47
|
type BrowserPoolRef,
|
|
47
48
|
type BrowserProxy,
|
|
48
49
|
type BrowserProxyConfig,
|
|
@@ -209,6 +210,7 @@ export {
|
|
|
209
210
|
export {
|
|
210
211
|
Vaults,
|
|
211
212
|
type Vault,
|
|
213
|
+
type VaultEncryptionKey,
|
|
212
214
|
type VaultListParams,
|
|
213
215
|
type VaultUpsertParams,
|
|
214
216
|
type VaultsOffsetPagination,
|
package/src/resources/proxies.ts
CHANGED
|
@@ -16,9 +16,7 @@ export class Proxies extends APIResource {
|
|
|
16
16
|
*
|
|
17
17
|
* @example
|
|
18
18
|
* ```ts
|
|
19
|
-
* const proxy = await client.proxies.create({
|
|
20
|
-
* type: 'datacenter',
|
|
21
|
-
* });
|
|
19
|
+
* const proxy = await client.proxies.create({ type: 'isp' });
|
|
22
20
|
* ```
|
|
23
21
|
*/
|
|
24
22
|
create(body: ProxyCreateParams, options?: RequestOptions): APIPromise<ProxyCreateResponse> {
|
|
@@ -92,11 +90,11 @@ export class Proxies extends APIResource {
|
|
|
92
90
|
|
|
93
91
|
/**
|
|
94
92
|
* Run a health check on the proxy to verify it's working. Optionally specify a URL
|
|
95
|
-
* to test reachability against a specific target. For ISP
|
|
96
|
-
*
|
|
97
|
-
*
|
|
98
|
-
*
|
|
99
|
-
*
|
|
93
|
+
* to test reachability against a specific target. For ISP proxies, this reliably
|
|
94
|
+
* tests whether the target site is reachable from the proxy's stable exit IP. For
|
|
95
|
+
* residential and mobile proxies, the exit node varies between requests, so this
|
|
96
|
+
* validates proxy configuration and connectivity rather than guaranteeing
|
|
97
|
+
* site-specific reachability.
|
|
100
98
|
*
|
|
101
99
|
* @example
|
|
102
100
|
* ```ts
|
|
@@ -118,11 +116,7 @@ export type ProxyListResponsesOffsetPagination = OffsetPagination<ProxyListRespo
|
|
|
118
116
|
* Configuration for routing traffic through a proxy.
|
|
119
117
|
*/
|
|
120
118
|
export interface ProxyCreateResponse {
|
|
121
|
-
|
|
122
|
-
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
123
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
124
|
-
*/
|
|
125
|
-
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
119
|
+
type: 'isp' | 'residential' | 'mobile' | 'custom';
|
|
126
120
|
|
|
127
121
|
id?: string;
|
|
128
122
|
|
|
@@ -132,10 +126,9 @@ export interface ProxyCreateResponse {
|
|
|
132
126
|
bypass_hosts?: Array<string>;
|
|
133
127
|
|
|
134
128
|
/**
|
|
135
|
-
* Configuration
|
|
129
|
+
* Configuration for an ISP proxy.
|
|
136
130
|
*/
|
|
137
131
|
config?:
|
|
138
|
-
| ProxyCreateResponse.DatacenterProxyConfig
|
|
139
132
|
| ProxyCreateResponse.IspProxyConfig
|
|
140
133
|
| ProxyCreateResponse.ResidentialProxyConfig
|
|
141
134
|
| ProxyCreateResponse.MobileProxyConfig
|
|
@@ -168,23 +161,13 @@ export interface ProxyCreateResponse {
|
|
|
168
161
|
}
|
|
169
162
|
|
|
170
163
|
export namespace ProxyCreateResponse {
|
|
171
|
-
/**
|
|
172
|
-
* Configuration for a datacenter proxy.
|
|
173
|
-
*/
|
|
174
|
-
export interface DatacenterProxyConfig {
|
|
175
|
-
/**
|
|
176
|
-
* ISO 3166 country code. Defaults to US if not provided.
|
|
177
|
-
*/
|
|
178
|
-
country?: string;
|
|
179
|
-
}
|
|
180
|
-
|
|
181
164
|
/**
|
|
182
165
|
* Configuration for an ISP proxy.
|
|
183
166
|
*/
|
|
184
167
|
export interface IspProxyConfig {
|
|
185
168
|
/**
|
|
186
|
-
* ISO 3166 country code. Supported countries are US, GB, FR, DE, and
|
|
187
|
-
* to US if not provided.
|
|
169
|
+
* ISO 3166 country code. Supported countries are US, GB, FR, DE, SG, and KR.
|
|
170
|
+
* Defaults to US if not provided.
|
|
188
171
|
*/
|
|
189
172
|
country?: string;
|
|
190
173
|
}
|
|
@@ -282,11 +265,7 @@ export namespace ProxyCreateResponse {
|
|
|
282
265
|
* Configuration for routing traffic through a proxy.
|
|
283
266
|
*/
|
|
284
267
|
export interface ProxyRetrieveResponse {
|
|
285
|
-
|
|
286
|
-
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
287
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
288
|
-
*/
|
|
289
|
-
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
268
|
+
type: 'isp' | 'residential' | 'mobile' | 'custom';
|
|
290
269
|
|
|
291
270
|
id?: string;
|
|
292
271
|
|
|
@@ -296,10 +275,9 @@ export interface ProxyRetrieveResponse {
|
|
|
296
275
|
bypass_hosts?: Array<string>;
|
|
297
276
|
|
|
298
277
|
/**
|
|
299
|
-
* Configuration
|
|
278
|
+
* Configuration for an ISP proxy.
|
|
300
279
|
*/
|
|
301
280
|
config?:
|
|
302
|
-
| ProxyRetrieveResponse.DatacenterProxyConfig
|
|
303
281
|
| ProxyRetrieveResponse.IspProxyConfig
|
|
304
282
|
| ProxyRetrieveResponse.ResidentialProxyConfig
|
|
305
283
|
| ProxyRetrieveResponse.MobileProxyConfig
|
|
@@ -332,23 +310,13 @@ export interface ProxyRetrieveResponse {
|
|
|
332
310
|
}
|
|
333
311
|
|
|
334
312
|
export namespace ProxyRetrieveResponse {
|
|
335
|
-
/**
|
|
336
|
-
* Configuration for a datacenter proxy.
|
|
337
|
-
*/
|
|
338
|
-
export interface DatacenterProxyConfig {
|
|
339
|
-
/**
|
|
340
|
-
* ISO 3166 country code. Defaults to US if not provided.
|
|
341
|
-
*/
|
|
342
|
-
country?: string;
|
|
343
|
-
}
|
|
344
|
-
|
|
345
313
|
/**
|
|
346
314
|
* Configuration for an ISP proxy.
|
|
347
315
|
*/
|
|
348
316
|
export interface IspProxyConfig {
|
|
349
317
|
/**
|
|
350
|
-
* ISO 3166 country code. Supported countries are US, GB, FR, DE, and
|
|
351
|
-
* to US if not provided.
|
|
318
|
+
* ISO 3166 country code. Supported countries are US, GB, FR, DE, SG, and KR.
|
|
319
|
+
* Defaults to US if not provided.
|
|
352
320
|
*/
|
|
353
321
|
country?: string;
|
|
354
322
|
}
|
|
@@ -446,11 +414,7 @@ export namespace ProxyRetrieveResponse {
|
|
|
446
414
|
* Configuration for routing traffic through a proxy.
|
|
447
415
|
*/
|
|
448
416
|
export interface ProxyUpdateResponse {
|
|
449
|
-
|
|
450
|
-
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
451
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
452
|
-
*/
|
|
453
|
-
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
417
|
+
type: 'isp' | 'residential' | 'mobile' | 'custom';
|
|
454
418
|
|
|
455
419
|
id?: string;
|
|
456
420
|
|
|
@@ -460,10 +424,9 @@ export interface ProxyUpdateResponse {
|
|
|
460
424
|
bypass_hosts?: Array<string>;
|
|
461
425
|
|
|
462
426
|
/**
|
|
463
|
-
* Configuration
|
|
427
|
+
* Configuration for an ISP proxy.
|
|
464
428
|
*/
|
|
465
429
|
config?:
|
|
466
|
-
| ProxyUpdateResponse.DatacenterProxyConfig
|
|
467
430
|
| ProxyUpdateResponse.IspProxyConfig
|
|
468
431
|
| ProxyUpdateResponse.ResidentialProxyConfig
|
|
469
432
|
| ProxyUpdateResponse.MobileProxyConfig
|
|
@@ -496,23 +459,13 @@ export interface ProxyUpdateResponse {
|
|
|
496
459
|
}
|
|
497
460
|
|
|
498
461
|
export namespace ProxyUpdateResponse {
|
|
499
|
-
/**
|
|
500
|
-
* Configuration for a datacenter proxy.
|
|
501
|
-
*/
|
|
502
|
-
export interface DatacenterProxyConfig {
|
|
503
|
-
/**
|
|
504
|
-
* ISO 3166 country code. Defaults to US if not provided.
|
|
505
|
-
*/
|
|
506
|
-
country?: string;
|
|
507
|
-
}
|
|
508
|
-
|
|
509
462
|
/**
|
|
510
463
|
* Configuration for an ISP proxy.
|
|
511
464
|
*/
|
|
512
465
|
export interface IspProxyConfig {
|
|
513
466
|
/**
|
|
514
|
-
* ISO 3166 country code. Supported countries are US, GB, FR, DE, and
|
|
515
|
-
* to US if not provided.
|
|
467
|
+
* ISO 3166 country code. Supported countries are US, GB, FR, DE, SG, and KR.
|
|
468
|
+
* Defaults to US if not provided.
|
|
516
469
|
*/
|
|
517
470
|
country?: string;
|
|
518
471
|
}
|
|
@@ -610,11 +563,7 @@ export namespace ProxyUpdateResponse {
|
|
|
610
563
|
* Configuration for routing traffic through a proxy.
|
|
611
564
|
*/
|
|
612
565
|
export interface ProxyListResponse {
|
|
613
|
-
|
|
614
|
-
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
615
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
616
|
-
*/
|
|
617
|
-
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
566
|
+
type: 'isp' | 'residential' | 'mobile' | 'custom';
|
|
618
567
|
|
|
619
568
|
id?: string;
|
|
620
569
|
|
|
@@ -624,10 +573,9 @@ export interface ProxyListResponse {
|
|
|
624
573
|
bypass_hosts?: Array<string>;
|
|
625
574
|
|
|
626
575
|
/**
|
|
627
|
-
* Configuration
|
|
576
|
+
* Configuration for an ISP proxy.
|
|
628
577
|
*/
|
|
629
578
|
config?:
|
|
630
|
-
| ProxyListResponse.DatacenterProxyConfig
|
|
631
579
|
| ProxyListResponse.IspProxyConfig
|
|
632
580
|
| ProxyListResponse.ResidentialProxyConfig
|
|
633
581
|
| ProxyListResponse.MobileProxyConfig
|
|
@@ -660,23 +608,13 @@ export interface ProxyListResponse {
|
|
|
660
608
|
}
|
|
661
609
|
|
|
662
610
|
export namespace ProxyListResponse {
|
|
663
|
-
/**
|
|
664
|
-
* Configuration for a datacenter proxy.
|
|
665
|
-
*/
|
|
666
|
-
export interface DatacenterProxyConfig {
|
|
667
|
-
/**
|
|
668
|
-
* ISO 3166 country code. Defaults to US if not provided.
|
|
669
|
-
*/
|
|
670
|
-
country?: string;
|
|
671
|
-
}
|
|
672
|
-
|
|
673
611
|
/**
|
|
674
612
|
* Configuration for an ISP proxy.
|
|
675
613
|
*/
|
|
676
614
|
export interface IspProxyConfig {
|
|
677
615
|
/**
|
|
678
|
-
* ISO 3166 country code. Supported countries are US, GB, FR, DE, and
|
|
679
|
-
* to US if not provided.
|
|
616
|
+
* ISO 3166 country code. Supported countries are US, GB, FR, DE, SG, and KR.
|
|
617
|
+
* Defaults to US if not provided.
|
|
680
618
|
*/
|
|
681
619
|
country?: string;
|
|
682
620
|
}
|
|
@@ -774,11 +712,7 @@ export namespace ProxyListResponse {
|
|
|
774
712
|
* Configuration for routing traffic through a proxy.
|
|
775
713
|
*/
|
|
776
714
|
export interface ProxyCheckResponse {
|
|
777
|
-
|
|
778
|
-
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
779
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
780
|
-
*/
|
|
781
|
-
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
715
|
+
type: 'isp' | 'residential' | 'mobile' | 'custom';
|
|
782
716
|
|
|
783
717
|
id?: string;
|
|
784
718
|
|
|
@@ -788,10 +722,9 @@ export interface ProxyCheckResponse {
|
|
|
788
722
|
bypass_hosts?: Array<string>;
|
|
789
723
|
|
|
790
724
|
/**
|
|
791
|
-
* Configuration
|
|
725
|
+
* Configuration for an ISP proxy.
|
|
792
726
|
*/
|
|
793
727
|
config?:
|
|
794
|
-
| ProxyCheckResponse.DatacenterProxyConfig
|
|
795
728
|
| ProxyCheckResponse.IspProxyConfig
|
|
796
729
|
| ProxyCheckResponse.ResidentialProxyConfig
|
|
797
730
|
| ProxyCheckResponse.MobileProxyConfig
|
|
@@ -824,23 +757,13 @@ export interface ProxyCheckResponse {
|
|
|
824
757
|
}
|
|
825
758
|
|
|
826
759
|
export namespace ProxyCheckResponse {
|
|
827
|
-
/**
|
|
828
|
-
* Configuration for a datacenter proxy.
|
|
829
|
-
*/
|
|
830
|
-
export interface DatacenterProxyConfig {
|
|
831
|
-
/**
|
|
832
|
-
* ISO 3166 country code. Defaults to US if not provided.
|
|
833
|
-
*/
|
|
834
|
-
country?: string;
|
|
835
|
-
}
|
|
836
|
-
|
|
837
760
|
/**
|
|
838
761
|
* Configuration for an ISP proxy.
|
|
839
762
|
*/
|
|
840
763
|
export interface IspProxyConfig {
|
|
841
764
|
/**
|
|
842
|
-
* ISO 3166 country code. Supported countries are US, GB, FR, DE, and
|
|
843
|
-
* to US if not provided.
|
|
765
|
+
* ISO 3166 country code. Supported countries are US, GB, FR, DE, SG, and KR.
|
|
766
|
+
* Defaults to US if not provided.
|
|
844
767
|
*/
|
|
845
768
|
country?: string;
|
|
846
769
|
}
|
|
@@ -935,11 +858,7 @@ export namespace ProxyCheckResponse {
|
|
|
935
858
|
}
|
|
936
859
|
|
|
937
860
|
export interface ProxyCreateParams {
|
|
938
|
-
|
|
939
|
-
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
940
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
941
|
-
*/
|
|
942
|
-
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
861
|
+
type: 'isp' | 'residential' | 'mobile' | 'custom';
|
|
943
862
|
|
|
944
863
|
/**
|
|
945
864
|
* Hostnames that should bypass the parent proxy and connect directly.
|
|
@@ -947,10 +866,9 @@ export interface ProxyCreateParams {
|
|
|
947
866
|
bypass_hosts?: Array<string>;
|
|
948
867
|
|
|
949
868
|
/**
|
|
950
|
-
* Configuration
|
|
869
|
+
* Configuration for an ISP proxy.
|
|
951
870
|
*/
|
|
952
871
|
config?:
|
|
953
|
-
| ProxyCreateParams.DatacenterProxyConfig
|
|
954
872
|
| ProxyCreateParams.IspProxyConfig
|
|
955
873
|
| ProxyCreateParams.ResidentialProxyConfig
|
|
956
874
|
| ProxyCreateParams.MobileProxyConfig
|
|
@@ -968,23 +886,13 @@ export interface ProxyCreateParams {
|
|
|
968
886
|
}
|
|
969
887
|
|
|
970
888
|
export namespace ProxyCreateParams {
|
|
971
|
-
/**
|
|
972
|
-
* Configuration for a datacenter proxy.
|
|
973
|
-
*/
|
|
974
|
-
export interface DatacenterProxyConfig {
|
|
975
|
-
/**
|
|
976
|
-
* ISO 3166 country code. Defaults to US if not provided.
|
|
977
|
-
*/
|
|
978
|
-
country?: string;
|
|
979
|
-
}
|
|
980
|
-
|
|
981
889
|
/**
|
|
982
890
|
* Configuration for an ISP proxy.
|
|
983
891
|
*/
|
|
984
892
|
export interface IspProxyConfig {
|
|
985
893
|
/**
|
|
986
|
-
* ISO 3166 country code. Supported countries are US, GB, FR, DE, and
|
|
987
|
-
* to US if not provided.
|
|
894
|
+
* ISO 3166 country code. Supported countries are US, GB, FR, DE, SG, and KR.
|
|
895
|
+
* Defaults to US if not provided.
|
|
988
896
|
*/
|
|
989
897
|
country?: string;
|
|
990
898
|
}
|
|
@@ -1108,15 +1016,15 @@ export interface ProxyCheckParams {
|
|
|
1108
1016
|
* An optional URL to test reachability against. If provided, the proxy check will
|
|
1109
1017
|
* test connectivity to this URL instead of the default test URLs. Only HTTP and
|
|
1110
1018
|
* HTTPS schemes are allowed, and the URL must resolve to a public IP address. For
|
|
1111
|
-
* ISP
|
|
1112
|
-
*
|
|
1113
|
-
*
|
|
1114
|
-
*
|
|
1115
|
-
*
|
|
1116
|
-
*
|
|
1117
|
-
*
|
|
1118
|
-
*
|
|
1119
|
-
*
|
|
1019
|
+
* ISP proxies, the exit IP is stable, so a successful check reliably indicates
|
|
1020
|
+
* that subsequent browser sessions will reach the target site with the same IP.
|
|
1021
|
+
* For residential and mobile proxies, the exit node changes between requests, so a
|
|
1022
|
+
* successful check validates proxy configuration but does not guarantee that a
|
|
1023
|
+
* subsequent browser session will use the same exit IP or reach the same site — it
|
|
1024
|
+
* is useful for verifying credentials and connectivity, not for predicting
|
|
1025
|
+
* site-specific behavior. When provided, the check result does not update the
|
|
1026
|
+
* proxy's health status, since a failure may indicate a problem with the target
|
|
1027
|
+
* site rather than the proxy itself.
|
|
1120
1028
|
*/
|
|
1121
1029
|
url?: string;
|
|
1122
1030
|
}
|