@onkernel/sdk 0.61.0 → 0.63.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 +25 -0
- package/client.d.mts +10 -13
- package/client.d.mts.map +1 -1
- package/client.d.ts +10 -13
- package/client.d.ts.map +1 -1
- package/client.js +0 -3
- package/client.js.map +1 -1
- package/client.mjs +0 -3
- package/client.mjs.map +1 -1
- package/internal/qs/formats.d.mts +7 -0
- package/internal/qs/formats.d.mts.map +1 -0
- package/internal/qs/formats.d.ts +7 -0
- package/internal/qs/formats.d.ts.map +1 -0
- package/internal/qs/formats.js +13 -0
- package/internal/qs/formats.js.map +1 -0
- package/internal/qs/formats.mjs +9 -0
- package/internal/qs/formats.mjs.map +1 -0
- package/internal/qs/index.d.mts +10 -0
- package/internal/qs/index.d.mts.map +1 -0
- package/internal/qs/index.d.ts +10 -0
- package/internal/qs/index.d.ts.map +1 -0
- package/internal/qs/index.js +14 -0
- package/internal/qs/index.js.map +1 -0
- package/internal/qs/index.mjs +10 -0
- package/internal/qs/index.mjs.map +1 -0
- package/internal/qs/stringify.d.mts +3 -0
- package/internal/qs/stringify.d.mts.map +1 -0
- package/internal/qs/stringify.d.ts +3 -0
- package/internal/qs/stringify.d.ts.map +1 -0
- package/internal/qs/stringify.js +277 -0
- package/internal/qs/stringify.js.map +1 -0
- package/internal/qs/stringify.mjs +274 -0
- package/internal/qs/stringify.mjs.map +1 -0
- package/internal/qs/types.d.mts +57 -0
- package/internal/qs/types.d.mts.map +1 -0
- package/internal/qs/types.d.ts +57 -0
- package/internal/qs/types.d.ts.map +1 -0
- package/internal/qs/types.js +3 -0
- package/internal/qs/types.js.map +1 -0
- package/internal/qs/types.mjs +2 -0
- package/internal/qs/types.mjs.map +1 -0
- package/internal/qs/utils.d.mts +15 -0
- package/internal/qs/utils.d.mts.map +1 -0
- package/internal/qs/utils.d.ts +15 -0
- package/internal/qs/utils.d.ts.map +1 -0
- package/internal/qs/utils.js +230 -0
- package/internal/qs/utils.js.map +1 -0
- package/internal/qs/utils.mjs +217 -0
- package/internal/qs/utils.mjs.map +1 -0
- package/internal/utils/query.d.mts +0 -3
- package/internal/utils/query.d.mts.map +1 -1
- package/internal/utils/query.d.ts +0 -3
- package/internal/utils/query.d.ts.map +1 -1
- package/internal/utils/query.js +3 -16
- package/internal/utils/query.js.map +1 -1
- package/internal/utils/query.mjs +2 -16
- package/internal/utils/query.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/browser-pools.d.mts +19 -4
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +19 -4
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browser-pools.js +7 -3
- package/resources/browser-pools.js.map +1 -1
- package/resources/browser-pools.mjs +7 -3
- package/resources/browser-pools.mjs.map +1 -1
- package/resources/browsers/browsers.d.mts +63 -2
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +63 -2
- 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/credential-providers.d.mts +10 -5
- package/resources/credential-providers.d.mts.map +1 -1
- package/resources/credential-providers.d.ts +10 -5
- package/resources/credential-providers.d.ts.map +1 -1
- package/resources/credential-providers.js +10 -4
- package/resources/credential-providers.js.map +1 -1
- package/resources/credential-providers.mjs +10 -4
- package/resources/credential-providers.mjs.map +1 -1
- package/resources/extensions.d.mts +35 -31
- package/resources/extensions.d.mts.map +1 -1
- package/resources/extensions.d.ts +35 -31
- package/resources/extensions.d.ts.map +1 -1
- package/resources/extensions.js +10 -3
- package/resources/extensions.js.map +1 -1
- package/resources/extensions.mjs +10 -3
- package/resources/extensions.mjs.map +1 -1
- package/resources/index.d.mts +5 -5
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +5 -5
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/invocations.d.mts +9 -0
- package/resources/invocations.d.mts.map +1 -1
- package/resources/invocations.d.ts +9 -0
- package/resources/invocations.d.ts.map +1 -1
- package/resources/proxies.d.mts +111 -110
- package/resources/proxies.d.mts.map +1 -1
- package/resources/proxies.d.ts +111 -110
- package/resources/proxies.d.ts.map +1 -1
- package/resources/proxies.js +3 -2
- package/resources/proxies.js.map +1 -1
- package/resources/proxies.mjs +3 -2
- package/resources/proxies.mjs.map +1 -1
- package/src/client.ts +18 -7
- package/src/internal/qs/LICENSE.md +13 -0
- package/src/internal/qs/README.md +3 -0
- package/src/internal/qs/formats.ts +10 -0
- package/src/internal/qs/index.ts +13 -0
- package/src/internal/qs/stringify.ts +385 -0
- package/src/internal/qs/types.ts +71 -0
- package/src/internal/qs/utils.ts +265 -0
- package/src/internal/utils/query.ts +2 -18
- package/src/resources/browser-pools.ts +27 -6
- package/src/resources/browsers/browsers.ts +71 -1
- package/src/resources/browsers/index.ts +1 -0
- package/src/resources/credential-providers.ts +19 -7
- package/src/resources/extensions.ts +41 -29
- package/src/resources/index.ts +9 -2
- package/src/resources/invocations.ts +11 -0
- package/src/resources/proxies.ts +120 -114
- 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
|
@@ -374,6 +374,10 @@ export declare namespace InvocationListBrowsersResponse {
|
|
|
374
374
|
* Whether the browser session is running in kiosk mode.
|
|
375
375
|
*/
|
|
376
376
|
kiosk_mode?: boolean;
|
|
377
|
+
/**
|
|
378
|
+
* Human-readable name of the browser session, if one was set at creation.
|
|
379
|
+
*/
|
|
380
|
+
name?: string;
|
|
377
381
|
/**
|
|
378
382
|
* Browser pool this session was acquired from, if any.
|
|
379
383
|
*/
|
|
@@ -394,6 +398,11 @@ export declare namespace InvocationListBrowsersResponse {
|
|
|
394
398
|
* actually loaded.
|
|
395
399
|
*/
|
|
396
400
|
start_url?: string;
|
|
401
|
+
/**
|
|
402
|
+
* User-defined key-value tags that were set on this browser session, if any.
|
|
403
|
+
* Echoed back when present.
|
|
404
|
+
*/
|
|
405
|
+
tags?: BrowsersAPI.Tags;
|
|
397
406
|
/**
|
|
398
407
|
* Active telemetry configuration for the session, if any.
|
|
399
408
|
*/
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"invocations.d.ts","sourceRoot":"","sources":["../src/resources/invocations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,KAAK,WAAW,+BAA4B;AACnD,OAAO,KAAK,YAAY,gCAA6B;AACrD,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,8BAA2B;AAChG,OAAO,EAAE,MAAM,EAAE,6BAA0B;AAE3C,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItF;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,sBAAsB,CAAC;IAO/E;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;IAS/C;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;CAG/F;AAED,MAAM,MAAM,uCAAuC,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;IAE1B,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC;IAE5C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;QAEtD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,MAAM,CAAC,QAAQ,GACf,oBAAoB,GACpB,MAAM,CAAC,UAAU,GACjB,MAAM,CAAC,cAAc,CAAC;AAE1B,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;CACzD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAE/B;;;;WAIG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,GAAG,CAAC,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;QAElC;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;QAE9B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,SAAS,CAAC,EAAE,YAAY,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC;QAEjC;;;;;;;;;;;;;WAaG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC;KACnC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,QAAQ,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
|
1
|
+
{"version":3,"file":"invocations.d.ts","sourceRoot":"","sources":["../src/resources/invocations.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,4BAAyB;AAC/C,OAAO,KAAK,MAAM,oBAAiB;AACnC,OAAO,KAAK,WAAW,+BAA4B;AACnD,OAAO,KAAK,YAAY,gCAA6B;AACrD,OAAO,EAAE,UAAU,EAAE,+BAA4B;AACjD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,8BAA2B;AAChG,OAAO,EAAE,MAAM,EAAE,6BAA0B;AAE3C,OAAO,EAAE,cAAc,EAAE,uCAAoC;AAG7D;;GAEG;AACH,qBAAa,WAAY,SAAQ,WAAW;IAC1C;;;;;;;;;;;OAWG;IACH,MAAM,CAAC,IAAI,EAAE,sBAAsB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,wBAAwB,CAAC;IAIpG;;;;;;;;;OASG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,0BAA0B,CAAC;IAItF;;;;;;;;;;OAUG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,IAAI,EAAE,sBAAsB,EAC5B,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,wBAAwB,CAAC;IAIvC;;;;;;;;;;;OAWG;IACH,IAAI,CACF,KAAK,GAAE,oBAAoB,GAAG,IAAI,GAAG,SAAc,EACnD,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,uCAAuC,EAAE,sBAAsB,CAAC;IAO/E;;;;;;;OAOG;IACH,cAAc,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAOtE;;;;;;;;;OASG;IACH,MAAM,CACJ,EAAE,EAAE,MAAM,EACV,KAAK,GAAE,sBAAsB,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,MAAM,CAAC,wBAAwB,CAAC,CAAC;IAS/C;;;;;;;;;OASG;IACH,YAAY,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,8BAA8B,CAAC;CAG/F;AAED,MAAM,MAAM,uCAAuC,GAAG,gBAAgB,CAAC,sBAAsB,CAAC,CAAC;AAE/F;;GAEG;AACH,MAAM,WAAW,oBAAoB;IACnC;;OAEG;IACH,KAAK,EAAE,kBAAkB,CAAC;IAE1B,UAAU,EAAE,oBAAoB,CAAC,UAAU,CAAC;IAE5C;;OAEG;IACH,SAAS,EAAE,MAAM,CAAC;CACnB;AAED,yBAAiB,oBAAoB,CAAC;IACpC,UAAiB,UAAU;QACzB;;WAEG;QACH,EAAE,EAAE,MAAM,CAAC;QAEX;;WAEG;QACH,WAAW,EAAE,MAAM,CAAC;QAEpB;;WAEG;QACH,QAAQ,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;QAEtD;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;QAEhB;;;WAGG;QACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;QAE5B;;;WAGG;QACH,MAAM,CAAC,EAAE,MAAM,CAAC;QAEhB;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,aAAa,CAAC,EAAE,MAAM,CAAC;KACxB;CACF;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,0BAA0B;IACzC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,wBAAwB;IACvC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,EAAE,EAAE,MAAM,CAAC;IAEX;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,UAAU,EAAE,MAAM,CAAC;IAEnB;;OAEG;IACH,MAAM,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEtD;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,WAAW,CAAC,EAAE,MAAM,GAAG,IAAI,CAAC;IAE5B;;;OAGG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;IAEhB;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;CACxB;AAED;;GAEG;AACH,MAAM,MAAM,wBAAwB,GAChC,MAAM,CAAC,QAAQ,GACf,oBAAoB,GACpB,MAAM,CAAC,UAAU,GACjB,MAAM,CAAC,cAAc,CAAC;AAE1B,MAAM,WAAW,8BAA8B;IAC7C,QAAQ,EAAE,KAAK,CAAC,8BAA8B,CAAC,OAAO,CAAC,CAAC;CACzD;AAED,yBAAiB,8BAA8B,CAAC;IAC9C,UAAiB,OAAO;QACtB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,QAAQ,EAAE,OAAO,CAAC;QAElB;;WAEG;QACH,UAAU,EAAE,MAAM,CAAC;QAEnB;;WAEG;QACH,OAAO,EAAE,OAAO,CAAC;QAEjB;;WAEG;QACH,eAAe,EAAE,MAAM,CAAC;QAExB;;WAEG;QACH,gBAAgB,EAAE,MAAM,CAAC;QAEzB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;WAGG;QACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;QAE/B;;;;WAIG;QACH,aAAa,CAAC,EAAE;YAAE,CAAC,GAAG,EAAE,MAAM,GAAG,OAAO,CAAA;SAAE,CAAC;QAE3C;;WAEG;QACH,UAAU,CAAC,EAAE,MAAM,CAAC;QAEpB;;;WAGG;QACH,GAAG,CAAC,EAAE,OAAO,CAAC;QAEd;;WAEG;QACH,UAAU,CAAC,EAAE,OAAO,CAAC;QAErB;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,cAAc,CAAC;QAElC;;WAEG;QACH,OAAO,CAAC,EAAE,WAAW,CAAC,OAAO,CAAC;QAE9B;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;;;;;WAMG;QACH,SAAS,CAAC,EAAE,MAAM,CAAC;QAEnB;;;WAGG;QACH,IAAI,CAAC,EAAE,WAAW,CAAC,IAAI,CAAC;QAExB;;WAEG;QACH,SAAS,CAAC,EAAE,YAAY,CAAC,sBAAsB,GAAG,IAAI,CAAC;QAEvD;;WAEG;QACH,KAAK,CAAC,EAAE,WAAW,CAAC,YAAY,CAAC;QAEjC;;;;;;;;;;;;;WAaG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC,eAAe,CAAC;KACnC;CACF;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,WAAW,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,QAAQ,EAAE,MAAM,CAAC;IAEjB;;OAEG;IACH,OAAO,EAAE,MAAM,CAAC;IAEhB;;;OAGG;IACH,KAAK,CAAC,EAAE,OAAO,CAAC;IAEhB;;;OAGG;IACH,qBAAqB,CAAC,EAAE,MAAM,CAAC;IAE/B;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,MAAM,EAAE,WAAW,GAAG,QAAQ,CAAC;IAE/B;;OAEG;IACH,MAAM,CAAC,EAAE,MAAM,CAAC;CACjB;AAED,MAAM,WAAW,oBAAqB,SAAQ,sBAAsB;IAClE;;OAEG;IACH,WAAW,CAAC,EAAE,MAAM,CAAC;IAErB;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,CAAC;IAElB;;OAEG;IACH,aAAa,CAAC,EAAE,MAAM,CAAC;IAEvB;;;OAGG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;IAEf;;OAEG;IACH,MAAM,CAAC,EAAE,QAAQ,GAAG,SAAS,GAAG,WAAW,GAAG,QAAQ,CAAC;IAEvD;;OAEG;IACH,OAAO,CAAC,EAAE,MAAM,CAAC;CAClB;AAED,MAAM,WAAW,sBAAsB;IACrC;;OAEG;IACH,KAAK,CAAC,EAAE,MAAM,CAAC;CAChB;AAED,MAAM,CAAC,OAAO,WAAW,WAAW,CAAC;IACnC,OAAO,EACL,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,0BAA0B,IAAI,0BAA0B,EAC7D,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,wBAAwB,IAAI,wBAAwB,EACzD,KAAK,8BAA8B,IAAI,8BAA8B,EACrE,KAAK,uCAAuC,IAAI,uCAAuC,EACvF,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,sBAAsB,IAAI,sBAAsB,EACrD,KAAK,oBAAoB,IAAI,oBAAoB,EACjD,KAAK,sBAAsB,IAAI,sBAAsB,GACtD,CAAC;CACH"}
|
package/resources/proxies.d.mts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.mjs";
|
|
2
2
|
import { APIPromise } from "../core/api-promise.mjs";
|
|
3
|
+
import { OffsetPagination, type OffsetPaginationParams, PagePromise } from "../core/pagination.mjs";
|
|
3
4
|
import { RequestOptions } from "../internal/request-options.mjs";
|
|
4
5
|
/**
|
|
5
6
|
* Create and manage proxy configurations for routing browser traffic.
|
|
@@ -16,7 +17,7 @@ export declare class Proxies extends APIResource {
|
|
|
16
17
|
/**
|
|
17
18
|
* List proxies owned by the caller's organization.
|
|
18
19
|
*/
|
|
19
|
-
list(options?: RequestOptions):
|
|
20
|
+
list(query?: ProxyListParams | null | undefined, options?: RequestOptions): PagePromise<ProxyListResponsesOffsetPagination, ProxyListResponse>;
|
|
20
21
|
/**
|
|
21
22
|
* Soft delete a proxy. Sessions referencing it are not modified.
|
|
22
23
|
*/
|
|
@@ -31,6 +32,7 @@ export declare class Proxies extends APIResource {
|
|
|
31
32
|
*/
|
|
32
33
|
check(id: string, body?: ProxyCheckParams | null | undefined, options?: RequestOptions): APIPromise<ProxyCheckResponse>;
|
|
33
34
|
}
|
|
35
|
+
export type ProxyListResponsesOffsetPagination = OffsetPagination<ProxyListResponse>;
|
|
34
36
|
/**
|
|
35
37
|
* Configuration for routing traffic through a proxy.
|
|
36
38
|
*/
|
|
@@ -285,134 +287,131 @@ export declare namespace ProxyRetrieveResponse {
|
|
|
285
287
|
username?: string;
|
|
286
288
|
}
|
|
287
289
|
}
|
|
288
|
-
|
|
290
|
+
/**
|
|
291
|
+
* Configuration for routing traffic through a proxy.
|
|
292
|
+
*/
|
|
293
|
+
export interface ProxyListResponse {
|
|
294
|
+
/**
|
|
295
|
+
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
296
|
+
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
297
|
+
*/
|
|
298
|
+
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
299
|
+
id?: string;
|
|
300
|
+
/**
|
|
301
|
+
* Hostnames that should bypass the parent proxy and connect directly.
|
|
302
|
+
*/
|
|
303
|
+
bypass_hosts?: Array<string>;
|
|
304
|
+
/**
|
|
305
|
+
* Configuration specific to the selected proxy `type`.
|
|
306
|
+
*/
|
|
307
|
+
config?: ProxyListResponse.DatacenterProxyConfig | ProxyListResponse.IspProxyConfig | ProxyListResponse.ResidentialProxyConfig | ProxyListResponse.MobileProxyConfig | ProxyListResponse.CustomProxyConfig;
|
|
308
|
+
/**
|
|
309
|
+
* IP address that the proxy uses when making requests.
|
|
310
|
+
*/
|
|
311
|
+
ip_address?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Timestamp of the last health check performed on this proxy.
|
|
314
|
+
*/
|
|
315
|
+
last_checked?: string;
|
|
316
|
+
/**
|
|
317
|
+
* Readable name of the proxy.
|
|
318
|
+
*/
|
|
319
|
+
name?: string;
|
|
320
|
+
/**
|
|
321
|
+
* Protocol to use for the proxy connection.
|
|
322
|
+
*/
|
|
323
|
+
protocol?: 'http' | 'https';
|
|
324
|
+
/**
|
|
325
|
+
* Current health status of the proxy.
|
|
326
|
+
*/
|
|
327
|
+
status?: 'available' | 'unavailable';
|
|
328
|
+
}
|
|
289
329
|
export declare namespace ProxyListResponse {
|
|
290
330
|
/**
|
|
291
|
-
* Configuration for
|
|
331
|
+
* Configuration for a datacenter proxy.
|
|
332
|
+
*/
|
|
333
|
+
interface DatacenterProxyConfig {
|
|
334
|
+
/**
|
|
335
|
+
* ISO 3166 country code. Defaults to US if not provided.
|
|
336
|
+
*/
|
|
337
|
+
country?: string;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Configuration for an ISP proxy.
|
|
341
|
+
*/
|
|
342
|
+
interface IspProxyConfig {
|
|
343
|
+
/**
|
|
344
|
+
* ISO 3166 country code. Defaults to US if not provided.
|
|
345
|
+
*/
|
|
346
|
+
country?: string;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* Configuration for residential proxies.
|
|
292
350
|
*/
|
|
293
|
-
interface
|
|
351
|
+
interface ResidentialProxyConfig {
|
|
294
352
|
/**
|
|
295
|
-
*
|
|
296
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
353
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
297
354
|
*/
|
|
298
|
-
|
|
299
|
-
id?: string;
|
|
355
|
+
asn?: string;
|
|
300
356
|
/**
|
|
301
|
-
*
|
|
357
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
358
|
+
* provided.
|
|
359
|
+
*/
|
|
360
|
+
city?: string;
|
|
361
|
+
/**
|
|
362
|
+
* ISO 3166 country code.
|
|
302
363
|
*/
|
|
303
|
-
|
|
364
|
+
country?: string;
|
|
304
365
|
/**
|
|
305
|
-
*
|
|
366
|
+
* @deprecated Operating system of the residential device.
|
|
306
367
|
*/
|
|
307
|
-
|
|
368
|
+
os?: 'windows' | 'macos' | 'android';
|
|
308
369
|
/**
|
|
309
|
-
*
|
|
370
|
+
* Two-letter state code.
|
|
310
371
|
*/
|
|
311
|
-
|
|
372
|
+
state?: string;
|
|
312
373
|
/**
|
|
313
|
-
*
|
|
374
|
+
* US ZIP code.
|
|
314
375
|
*/
|
|
315
|
-
|
|
376
|
+
zip?: string;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* Configuration for mobile proxies.
|
|
380
|
+
*/
|
|
381
|
+
interface MobileProxyConfig {
|
|
316
382
|
/**
|
|
317
|
-
*
|
|
383
|
+
* Provider city alias. Mobile carrier routing can make observed geo vary.
|
|
318
384
|
*/
|
|
319
|
-
|
|
385
|
+
city?: string;
|
|
320
386
|
/**
|
|
321
|
-
*
|
|
387
|
+
* ISO 3166 country code
|
|
322
388
|
*/
|
|
323
|
-
|
|
389
|
+
country?: string;
|
|
324
390
|
/**
|
|
325
|
-
*
|
|
391
|
+
* US-only state code. Mobile carrier routing can make observed geo vary.
|
|
326
392
|
*/
|
|
327
|
-
|
|
393
|
+
state?: string;
|
|
328
394
|
}
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
* Configuration for residential proxies.
|
|
350
|
-
*/
|
|
351
|
-
interface ResidentialProxyConfig {
|
|
352
|
-
/**
|
|
353
|
-
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
354
|
-
*/
|
|
355
|
-
asn?: string;
|
|
356
|
-
/**
|
|
357
|
-
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
358
|
-
* provided.
|
|
359
|
-
*/
|
|
360
|
-
city?: string;
|
|
361
|
-
/**
|
|
362
|
-
* ISO 3166 country code.
|
|
363
|
-
*/
|
|
364
|
-
country?: string;
|
|
365
|
-
/**
|
|
366
|
-
* @deprecated Operating system of the residential device.
|
|
367
|
-
*/
|
|
368
|
-
os?: 'windows' | 'macos' | 'android';
|
|
369
|
-
/**
|
|
370
|
-
* Two-letter state code.
|
|
371
|
-
*/
|
|
372
|
-
state?: string;
|
|
373
|
-
/**
|
|
374
|
-
* US ZIP code.
|
|
375
|
-
*/
|
|
376
|
-
zip?: string;
|
|
377
|
-
}
|
|
378
|
-
/**
|
|
379
|
-
* Configuration for mobile proxies.
|
|
380
|
-
*/
|
|
381
|
-
interface MobileProxyConfig {
|
|
382
|
-
/**
|
|
383
|
-
* Provider city alias. Mobile carrier routing can make observed geo vary.
|
|
384
|
-
*/
|
|
385
|
-
city?: string;
|
|
386
|
-
/**
|
|
387
|
-
* ISO 3166 country code
|
|
388
|
-
*/
|
|
389
|
-
country?: string;
|
|
390
|
-
/**
|
|
391
|
-
* US-only state code. Mobile carrier routing can make observed geo vary.
|
|
392
|
-
*/
|
|
393
|
-
state?: string;
|
|
394
|
-
}
|
|
395
|
-
/**
|
|
396
|
-
* Configuration for a custom proxy (e.g., private proxy server).
|
|
397
|
-
*/
|
|
398
|
-
interface CustomProxyConfig {
|
|
399
|
-
/**
|
|
400
|
-
* Proxy host address or IP.
|
|
401
|
-
*/
|
|
402
|
-
host: string;
|
|
403
|
-
/**
|
|
404
|
-
* Proxy port.
|
|
405
|
-
*/
|
|
406
|
-
port: number;
|
|
407
|
-
/**
|
|
408
|
-
* Whether the proxy has a password.
|
|
409
|
-
*/
|
|
410
|
-
has_password?: boolean;
|
|
411
|
-
/**
|
|
412
|
-
* Username for proxy authentication.
|
|
413
|
-
*/
|
|
414
|
-
username?: string;
|
|
415
|
-
}
|
|
395
|
+
/**
|
|
396
|
+
* Configuration for a custom proxy (e.g., private proxy server).
|
|
397
|
+
*/
|
|
398
|
+
interface CustomProxyConfig {
|
|
399
|
+
/**
|
|
400
|
+
* Proxy host address or IP.
|
|
401
|
+
*/
|
|
402
|
+
host: string;
|
|
403
|
+
/**
|
|
404
|
+
* Proxy port.
|
|
405
|
+
*/
|
|
406
|
+
port: number;
|
|
407
|
+
/**
|
|
408
|
+
* Whether the proxy has a password.
|
|
409
|
+
*/
|
|
410
|
+
has_password?: boolean;
|
|
411
|
+
/**
|
|
412
|
+
* Username for proxy authentication.
|
|
413
|
+
*/
|
|
414
|
+
username?: string;
|
|
416
415
|
}
|
|
417
416
|
}
|
|
418
417
|
/**
|
|
@@ -653,6 +652,8 @@ export declare namespace ProxyCreateParams {
|
|
|
653
652
|
username?: string;
|
|
654
653
|
}
|
|
655
654
|
}
|
|
655
|
+
export interface ProxyListParams extends OffsetPaginationParams {
|
|
656
|
+
}
|
|
656
657
|
export interface ProxyCheckParams {
|
|
657
658
|
/**
|
|
658
659
|
* An optional URL to test reachability against. If provided, the proxy check will
|
|
@@ -671,6 +672,6 @@ export interface ProxyCheckParams {
|
|
|
671
672
|
url?: string;
|
|
672
673
|
}
|
|
673
674
|
export declare namespace Proxies {
|
|
674
|
-
export { type ProxyCreateResponse as ProxyCreateResponse, type ProxyRetrieveResponse as ProxyRetrieveResponse, type ProxyListResponse as ProxyListResponse, type ProxyCheckResponse as ProxyCheckResponse, type ProxyCreateParams as ProxyCreateParams, type ProxyCheckParams as ProxyCheckParams, };
|
|
675
|
+
export { type ProxyCreateResponse as ProxyCreateResponse, type ProxyRetrieveResponse as ProxyRetrieveResponse, type ProxyListResponse as ProxyListResponse, type ProxyCheckResponse as ProxyCheckResponse, type ProxyListResponsesOffsetPagination as ProxyListResponsesOffsetPagination, type ProxyCreateParams as ProxyCreateParams, type ProxyListParams as ProxyListParams, type ProxyCheckParams as ProxyCheckParams, };
|
|
675
676
|
}
|
|
676
677
|
//# sourceMappingURL=proxies.d.mts.map
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"proxies.d.mts","sourceRoot":"","sources":["../src/resources/proxies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;
|
|
1
|
+
{"version":3,"file":"proxies.d.mts","sourceRoot":"","sources":["../src/resources/proxies.ts"],"names":[],"mappings":"AAEA,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAC/C,OAAO,EAAE,UAAU,EAAE,gCAA4B;AACjD,OAAO,EAAE,gBAAgB,EAAE,KAAK,sBAAsB,EAAE,WAAW,EAAE,+BAA2B;AAEhG,OAAO,EAAE,cAAc,EAAE,wCAAoC;AAG7D;;GAEG;AACH,qBAAa,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAI,EAAE,iBAAiB,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,mBAAmB,CAAC;IAI1F;;OAEG;IACH,QAAQ,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,qBAAqB,CAAC;IAIjF;;OAEG;IACH,IAAI,CACF,KAAK,GAAE,eAAe,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,WAAW,CAAC,kCAAkC,EAAE,iBAAiB,CAAC;IAIrE;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;IAO9D;;;;;;;OAOG;IACH,KAAK,CACH,EAAE,EAAE,MAAM,EACV,IAAI,GAAE,gBAAgB,GAAG,IAAI,GAAG,SAAc,EAC9C,OAAO,CAAC,EAAE,cAAc,GACvB,UAAU,CAAC,kBAAkB,CAAC;CAGlC;AAED,MAAM,MAAM,kCAAkC,GAAG,gBAAgB,CAAC,iBAAiB,CAAC,CAAC;AAErF;;GAEG;AACH,MAAM,WAAW,mBAAmB;IAClC;;;OAGG;IACH,IAAI,EAAE,YAAY,GAAG,KAAK,GAAG,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEjE,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EACH,mBAAmB,CAAC,qBAAqB,GACzC,mBAAmB,CAAC,cAAc,GAClC,mBAAmB,CAAC,sBAAsB,GAC1C,mBAAmB,CAAC,iBAAiB,GACrC,mBAAmB,CAAC,iBAAiB,CAAC;IAE1C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC;CACtC;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,qBAAqB;IACpC;;;OAGG;IACH,IAAI,EAAE,YAAY,GAAG,KAAK,GAAG,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEjE,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EACH,qBAAqB,CAAC,qBAAqB,GAC3C,qBAAqB,CAAC,cAAc,GACpC,qBAAqB,CAAC,sBAAsB,GAC5C,qBAAqB,CAAC,iBAAiB,GACvC,qBAAqB,CAAC,iBAAiB,CAAC;IAE5C;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC;CACtC;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,EAAE,YAAY,GAAG,KAAK,GAAG,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEjE,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EACH,iBAAiB,CAAC,qBAAqB,GACvC,iBAAiB,CAAC,cAAc,GAChC,iBAAiB,CAAC,sBAAsB,GACxC,iBAAiB,CAAC,iBAAiB,GACnC,iBAAiB,CAAC,iBAAiB,CAAC;IAExC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC;CACtC;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED;;GAEG;AACH,MAAM,WAAW,kBAAkB;IACjC;;;OAGG;IACH,IAAI,EAAE,YAAY,GAAG,KAAK,GAAG,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEjE,EAAE,CAAC,EAAE,MAAM,CAAC;IAEZ;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EACH,kBAAkB,CAAC,qBAAqB,GACxC,kBAAkB,CAAC,cAAc,GACjC,kBAAkB,CAAC,sBAAsB,GACzC,kBAAkB,CAAC,iBAAiB,GACpC,kBAAkB,CAAC,iBAAiB,CAAC;IAEzC;;OAEG;IACH,UAAU,CAAC,EAAE,MAAM,CAAC;IAEpB;;OAEG;IACH,YAAY,CAAC,EAAE,MAAM,CAAC;IAEtB;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;IAE5B;;OAEG;IACH,MAAM,CAAC,EAAE,WAAW,GAAG,aAAa,CAAC;CACtC;AAED,yBAAiB,kBAAkB,CAAC;IAClC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,YAAY,CAAC,EAAE,OAAO,CAAC;QAEvB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,EAAE,YAAY,GAAG,KAAK,GAAG,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEjE;;OAEG;IACH,YAAY,CAAC,EAAE,KAAK,CAAC,MAAM,CAAC,CAAC;IAE7B;;OAEG;IACH,MAAM,CAAC,EACH,iBAAiB,CAAC,qBAAqB,GACvC,iBAAiB,CAAC,cAAc,GAChC,iBAAiB,CAAC,sBAAsB,GACxC,iBAAiB,CAAC,iBAAiB,GACnC,iBAAiB,CAAC,uBAAuB,CAAC;IAE9C;;OAEG;IACH,IAAI,CAAC,EAAE,MAAM,CAAC;IAEd;;OAEG;IACH,QAAQ,CAAC,EAAE,MAAM,GAAG,OAAO,CAAC;CAC7B;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;KAClB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;QAErC;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;IAED;;OAEG;IACH,UAAiB,iBAAiB;QAChC;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;WAEG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;KAChB;IAED;;OAEG;IACH,UAAiB,uBAAuB;QACtC;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,IAAI,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;QAElB;;WAEG;QACH,QAAQ,CAAC,EAAE,MAAM,CAAC;KACnB;CACF;AAED,MAAM,WAAW,eAAgB,SAAQ,sBAAsB;CAAG;AAElE,MAAM,WAAW,gBAAgB;IAC/B;;;;;;;;;;;;;OAaG;IACH,GAAG,CAAC,EAAE,MAAM,CAAC;CACd;AAED,MAAM,CAAC,OAAO,WAAW,OAAO,CAAC;IAC/B,OAAO,EACL,KAAK,mBAAmB,IAAI,mBAAmB,EAC/C,KAAK,qBAAqB,IAAI,qBAAqB,EACnD,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,kBAAkB,IAAI,kBAAkB,EAC7C,KAAK,kCAAkC,IAAI,kCAAkC,EAC7E,KAAK,iBAAiB,IAAI,iBAAiB,EAC3C,KAAK,eAAe,IAAI,eAAe,EACvC,KAAK,gBAAgB,IAAI,gBAAgB,GAC1C,CAAC;CACH"}
|
package/resources/proxies.d.ts
CHANGED
|
@@ -1,5 +1,6 @@
|
|
|
1
1
|
import { APIResource } from "../core/resource.js";
|
|
2
2
|
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { OffsetPagination, type OffsetPaginationParams, PagePromise } from "../core/pagination.js";
|
|
3
4
|
import { RequestOptions } from "../internal/request-options.js";
|
|
4
5
|
/**
|
|
5
6
|
* Create and manage proxy configurations for routing browser traffic.
|
|
@@ -16,7 +17,7 @@ export declare class Proxies extends APIResource {
|
|
|
16
17
|
/**
|
|
17
18
|
* List proxies owned by the caller's organization.
|
|
18
19
|
*/
|
|
19
|
-
list(options?: RequestOptions):
|
|
20
|
+
list(query?: ProxyListParams | null | undefined, options?: RequestOptions): PagePromise<ProxyListResponsesOffsetPagination, ProxyListResponse>;
|
|
20
21
|
/**
|
|
21
22
|
* Soft delete a proxy. Sessions referencing it are not modified.
|
|
22
23
|
*/
|
|
@@ -31,6 +32,7 @@ export declare class Proxies extends APIResource {
|
|
|
31
32
|
*/
|
|
32
33
|
check(id: string, body?: ProxyCheckParams | null | undefined, options?: RequestOptions): APIPromise<ProxyCheckResponse>;
|
|
33
34
|
}
|
|
35
|
+
export type ProxyListResponsesOffsetPagination = OffsetPagination<ProxyListResponse>;
|
|
34
36
|
/**
|
|
35
37
|
* Configuration for routing traffic through a proxy.
|
|
36
38
|
*/
|
|
@@ -285,134 +287,131 @@ export declare namespace ProxyRetrieveResponse {
|
|
|
285
287
|
username?: string;
|
|
286
288
|
}
|
|
287
289
|
}
|
|
288
|
-
|
|
290
|
+
/**
|
|
291
|
+
* Configuration for routing traffic through a proxy.
|
|
292
|
+
*/
|
|
293
|
+
export interface ProxyListResponse {
|
|
294
|
+
/**
|
|
295
|
+
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
296
|
+
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
297
|
+
*/
|
|
298
|
+
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
299
|
+
id?: string;
|
|
300
|
+
/**
|
|
301
|
+
* Hostnames that should bypass the parent proxy and connect directly.
|
|
302
|
+
*/
|
|
303
|
+
bypass_hosts?: Array<string>;
|
|
304
|
+
/**
|
|
305
|
+
* Configuration specific to the selected proxy `type`.
|
|
306
|
+
*/
|
|
307
|
+
config?: ProxyListResponse.DatacenterProxyConfig | ProxyListResponse.IspProxyConfig | ProxyListResponse.ResidentialProxyConfig | ProxyListResponse.MobileProxyConfig | ProxyListResponse.CustomProxyConfig;
|
|
308
|
+
/**
|
|
309
|
+
* IP address that the proxy uses when making requests.
|
|
310
|
+
*/
|
|
311
|
+
ip_address?: string;
|
|
312
|
+
/**
|
|
313
|
+
* Timestamp of the last health check performed on this proxy.
|
|
314
|
+
*/
|
|
315
|
+
last_checked?: string;
|
|
316
|
+
/**
|
|
317
|
+
* Readable name of the proxy.
|
|
318
|
+
*/
|
|
319
|
+
name?: string;
|
|
320
|
+
/**
|
|
321
|
+
* Protocol to use for the proxy connection.
|
|
322
|
+
*/
|
|
323
|
+
protocol?: 'http' | 'https';
|
|
324
|
+
/**
|
|
325
|
+
* Current health status of the proxy.
|
|
326
|
+
*/
|
|
327
|
+
status?: 'available' | 'unavailable';
|
|
328
|
+
}
|
|
289
329
|
export declare namespace ProxyListResponse {
|
|
290
330
|
/**
|
|
291
|
-
* Configuration for
|
|
331
|
+
* Configuration for a datacenter proxy.
|
|
332
|
+
*/
|
|
333
|
+
interface DatacenterProxyConfig {
|
|
334
|
+
/**
|
|
335
|
+
* ISO 3166 country code. Defaults to US if not provided.
|
|
336
|
+
*/
|
|
337
|
+
country?: string;
|
|
338
|
+
}
|
|
339
|
+
/**
|
|
340
|
+
* Configuration for an ISP proxy.
|
|
341
|
+
*/
|
|
342
|
+
interface IspProxyConfig {
|
|
343
|
+
/**
|
|
344
|
+
* ISO 3166 country code. Defaults to US if not provided.
|
|
345
|
+
*/
|
|
346
|
+
country?: string;
|
|
347
|
+
}
|
|
348
|
+
/**
|
|
349
|
+
* Configuration for residential proxies.
|
|
292
350
|
*/
|
|
293
|
-
interface
|
|
351
|
+
interface ResidentialProxyConfig {
|
|
294
352
|
/**
|
|
295
|
-
*
|
|
296
|
-
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
353
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
297
354
|
*/
|
|
298
|
-
|
|
299
|
-
id?: string;
|
|
355
|
+
asn?: string;
|
|
300
356
|
/**
|
|
301
|
-
*
|
|
357
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
358
|
+
* provided.
|
|
359
|
+
*/
|
|
360
|
+
city?: string;
|
|
361
|
+
/**
|
|
362
|
+
* ISO 3166 country code.
|
|
302
363
|
*/
|
|
303
|
-
|
|
364
|
+
country?: string;
|
|
304
365
|
/**
|
|
305
|
-
*
|
|
366
|
+
* @deprecated Operating system of the residential device.
|
|
306
367
|
*/
|
|
307
|
-
|
|
368
|
+
os?: 'windows' | 'macos' | 'android';
|
|
308
369
|
/**
|
|
309
|
-
*
|
|
370
|
+
* Two-letter state code.
|
|
310
371
|
*/
|
|
311
|
-
|
|
372
|
+
state?: string;
|
|
312
373
|
/**
|
|
313
|
-
*
|
|
374
|
+
* US ZIP code.
|
|
314
375
|
*/
|
|
315
|
-
|
|
376
|
+
zip?: string;
|
|
377
|
+
}
|
|
378
|
+
/**
|
|
379
|
+
* Configuration for mobile proxies.
|
|
380
|
+
*/
|
|
381
|
+
interface MobileProxyConfig {
|
|
316
382
|
/**
|
|
317
|
-
*
|
|
383
|
+
* Provider city alias. Mobile carrier routing can make observed geo vary.
|
|
318
384
|
*/
|
|
319
|
-
|
|
385
|
+
city?: string;
|
|
320
386
|
/**
|
|
321
|
-
*
|
|
387
|
+
* ISO 3166 country code
|
|
322
388
|
*/
|
|
323
|
-
|
|
389
|
+
country?: string;
|
|
324
390
|
/**
|
|
325
|
-
*
|
|
391
|
+
* US-only state code. Mobile carrier routing can make observed geo vary.
|
|
326
392
|
*/
|
|
327
|
-
|
|
393
|
+
state?: string;
|
|
328
394
|
}
|
|
329
|
-
|
|
330
|
-
|
|
331
|
-
|
|
332
|
-
|
|
333
|
-
|
|
334
|
-
|
|
335
|
-
|
|
336
|
-
|
|
337
|
-
|
|
338
|
-
|
|
339
|
-
|
|
340
|
-
|
|
341
|
-
|
|
342
|
-
|
|
343
|
-
|
|
344
|
-
|
|
345
|
-
|
|
346
|
-
|
|
347
|
-
|
|
348
|
-
|
|
349
|
-
* Configuration for residential proxies.
|
|
350
|
-
*/
|
|
351
|
-
interface ResidentialProxyConfig {
|
|
352
|
-
/**
|
|
353
|
-
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
354
|
-
*/
|
|
355
|
-
asn?: string;
|
|
356
|
-
/**
|
|
357
|
-
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
358
|
-
* provided.
|
|
359
|
-
*/
|
|
360
|
-
city?: string;
|
|
361
|
-
/**
|
|
362
|
-
* ISO 3166 country code.
|
|
363
|
-
*/
|
|
364
|
-
country?: string;
|
|
365
|
-
/**
|
|
366
|
-
* @deprecated Operating system of the residential device.
|
|
367
|
-
*/
|
|
368
|
-
os?: 'windows' | 'macos' | 'android';
|
|
369
|
-
/**
|
|
370
|
-
* Two-letter state code.
|
|
371
|
-
*/
|
|
372
|
-
state?: string;
|
|
373
|
-
/**
|
|
374
|
-
* US ZIP code.
|
|
375
|
-
*/
|
|
376
|
-
zip?: string;
|
|
377
|
-
}
|
|
378
|
-
/**
|
|
379
|
-
* Configuration for mobile proxies.
|
|
380
|
-
*/
|
|
381
|
-
interface MobileProxyConfig {
|
|
382
|
-
/**
|
|
383
|
-
* Provider city alias. Mobile carrier routing can make observed geo vary.
|
|
384
|
-
*/
|
|
385
|
-
city?: string;
|
|
386
|
-
/**
|
|
387
|
-
* ISO 3166 country code
|
|
388
|
-
*/
|
|
389
|
-
country?: string;
|
|
390
|
-
/**
|
|
391
|
-
* US-only state code. Mobile carrier routing can make observed geo vary.
|
|
392
|
-
*/
|
|
393
|
-
state?: string;
|
|
394
|
-
}
|
|
395
|
-
/**
|
|
396
|
-
* Configuration for a custom proxy (e.g., private proxy server).
|
|
397
|
-
*/
|
|
398
|
-
interface CustomProxyConfig {
|
|
399
|
-
/**
|
|
400
|
-
* Proxy host address or IP.
|
|
401
|
-
*/
|
|
402
|
-
host: string;
|
|
403
|
-
/**
|
|
404
|
-
* Proxy port.
|
|
405
|
-
*/
|
|
406
|
-
port: number;
|
|
407
|
-
/**
|
|
408
|
-
* Whether the proxy has a password.
|
|
409
|
-
*/
|
|
410
|
-
has_password?: boolean;
|
|
411
|
-
/**
|
|
412
|
-
* Username for proxy authentication.
|
|
413
|
-
*/
|
|
414
|
-
username?: string;
|
|
415
|
-
}
|
|
395
|
+
/**
|
|
396
|
+
* Configuration for a custom proxy (e.g., private proxy server).
|
|
397
|
+
*/
|
|
398
|
+
interface CustomProxyConfig {
|
|
399
|
+
/**
|
|
400
|
+
* Proxy host address or IP.
|
|
401
|
+
*/
|
|
402
|
+
host: string;
|
|
403
|
+
/**
|
|
404
|
+
* Proxy port.
|
|
405
|
+
*/
|
|
406
|
+
port: number;
|
|
407
|
+
/**
|
|
408
|
+
* Whether the proxy has a password.
|
|
409
|
+
*/
|
|
410
|
+
has_password?: boolean;
|
|
411
|
+
/**
|
|
412
|
+
* Username for proxy authentication.
|
|
413
|
+
*/
|
|
414
|
+
username?: string;
|
|
416
415
|
}
|
|
417
416
|
}
|
|
418
417
|
/**
|
|
@@ -653,6 +652,8 @@ export declare namespace ProxyCreateParams {
|
|
|
653
652
|
username?: string;
|
|
654
653
|
}
|
|
655
654
|
}
|
|
655
|
+
export interface ProxyListParams extends OffsetPaginationParams {
|
|
656
|
+
}
|
|
656
657
|
export interface ProxyCheckParams {
|
|
657
658
|
/**
|
|
658
659
|
* An optional URL to test reachability against. If provided, the proxy check will
|
|
@@ -671,6 +672,6 @@ export interface ProxyCheckParams {
|
|
|
671
672
|
url?: string;
|
|
672
673
|
}
|
|
673
674
|
export declare namespace Proxies {
|
|
674
|
-
export { type ProxyCreateResponse as ProxyCreateResponse, type ProxyRetrieveResponse as ProxyRetrieveResponse, type ProxyListResponse as ProxyListResponse, type ProxyCheckResponse as ProxyCheckResponse, type ProxyCreateParams as ProxyCreateParams, type ProxyCheckParams as ProxyCheckParams, };
|
|
675
|
+
export { type ProxyCreateResponse as ProxyCreateResponse, type ProxyRetrieveResponse as ProxyRetrieveResponse, type ProxyListResponse as ProxyListResponse, type ProxyCheckResponse as ProxyCheckResponse, type ProxyListResponsesOffsetPagination as ProxyListResponsesOffsetPagination, type ProxyCreateParams as ProxyCreateParams, type ProxyListParams as ProxyListParams, type ProxyCheckParams as ProxyCheckParams, };
|
|
675
676
|
}
|
|
676
677
|
//# sourceMappingURL=proxies.d.ts.map
|