@onkernel/sdk 0.11.1 → 0.11.2
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 +13 -0
- package/client.d.mts +3 -0
- package/client.d.mts.map +1 -1
- package/client.d.ts +3 -0
- package/client.d.ts.map +1 -1
- package/client.js +3 -0
- package/client.js.map +1 -1
- package/client.mjs +3 -0
- package/client.mjs.map +1 -1
- package/package.json +1 -1
- package/resources/browsers/browsers.d.mts +9 -1
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +9 -1
- 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/index.d.mts +1 -0
- package/resources/index.d.mts.map +1 -1
- package/resources/index.d.ts +1 -0
- package/resources/index.d.ts.map +1 -1
- package/resources/index.js +3 -1
- package/resources/index.js.map +1 -1
- package/resources/index.mjs +1 -0
- package/resources/index.mjs.map +1 -1
- package/resources/invocations.d.mts +2 -1
- package/resources/invocations.d.mts.map +1 -1
- package/resources/invocations.d.ts +2 -1
- package/resources/invocations.d.ts.map +1 -1
- package/resources/invocations.js +2 -1
- package/resources/invocations.js.map +1 -1
- package/resources/invocations.mjs +2 -1
- package/resources/invocations.mjs.map +1 -1
- package/resources/proxies.d.mts +512 -0
- package/resources/proxies.d.mts.map +1 -0
- package/resources/proxies.d.ts +512 -0
- package/resources/proxies.d.ts.map +1 -0
- package/resources/proxies.js +38 -0
- package/resources/proxies.js.map +1 -0
- package/resources/proxies.mjs +34 -0
- package/resources/proxies.mjs.map +1 -0
- package/src/client.ts +17 -0
- package/src/resources/browsers/browsers.ts +10 -1
- package/src/resources/index.ts +7 -0
- package/src/resources/invocations.ts +2 -1
- package/src/resources/proxies.ts +876 -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
|
@@ -0,0 +1,512 @@
|
|
|
1
|
+
import { APIResource } from "../core/resource.js";
|
|
2
|
+
import { APIPromise } from "../core/api-promise.js";
|
|
3
|
+
import { RequestOptions } from "../internal/request-options.js";
|
|
4
|
+
export declare class Proxies extends APIResource {
|
|
5
|
+
/**
|
|
6
|
+
* Create a new proxy configuration for the caller's organization.
|
|
7
|
+
*/
|
|
8
|
+
create(body: ProxyCreateParams, options?: RequestOptions): APIPromise<ProxyCreateResponse>;
|
|
9
|
+
/**
|
|
10
|
+
* Retrieve a proxy belonging to the caller's organization by ID.
|
|
11
|
+
*/
|
|
12
|
+
retrieve(id: string, options?: RequestOptions): APIPromise<ProxyRetrieveResponse>;
|
|
13
|
+
/**
|
|
14
|
+
* List proxies owned by the caller's organization.
|
|
15
|
+
*/
|
|
16
|
+
list(options?: RequestOptions): APIPromise<ProxyListResponse>;
|
|
17
|
+
/**
|
|
18
|
+
* Soft delete a proxy. Sessions referencing it are not modified.
|
|
19
|
+
*/
|
|
20
|
+
delete(id: string, options?: RequestOptions): APIPromise<void>;
|
|
21
|
+
}
|
|
22
|
+
/**
|
|
23
|
+
* Configuration for routing traffic through a proxy.
|
|
24
|
+
*/
|
|
25
|
+
export interface ProxyCreateResponse {
|
|
26
|
+
/**
|
|
27
|
+
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
28
|
+
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
29
|
+
*/
|
|
30
|
+
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
31
|
+
id?: string;
|
|
32
|
+
/**
|
|
33
|
+
* Configuration specific to the selected proxy `type`.
|
|
34
|
+
*/
|
|
35
|
+
config?: ProxyCreateResponse.DatacenterProxyConfig | ProxyCreateResponse.IspProxyConfig | ProxyCreateResponse.ResidentialProxyConfig | ProxyCreateResponse.MobileProxyConfig | ProxyCreateResponse.CustomProxyConfig;
|
|
36
|
+
/**
|
|
37
|
+
* Readable name of the proxy.
|
|
38
|
+
*/
|
|
39
|
+
name?: string;
|
|
40
|
+
}
|
|
41
|
+
export declare namespace ProxyCreateResponse {
|
|
42
|
+
/**
|
|
43
|
+
* Configuration for a datacenter proxy.
|
|
44
|
+
*/
|
|
45
|
+
interface DatacenterProxyConfig {
|
|
46
|
+
/**
|
|
47
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
48
|
+
*/
|
|
49
|
+
country: string;
|
|
50
|
+
}
|
|
51
|
+
/**
|
|
52
|
+
* Configuration for an ISP proxy.
|
|
53
|
+
*/
|
|
54
|
+
interface IspProxyConfig {
|
|
55
|
+
/**
|
|
56
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
57
|
+
*/
|
|
58
|
+
country: string;
|
|
59
|
+
}
|
|
60
|
+
/**
|
|
61
|
+
* Configuration for residential proxies.
|
|
62
|
+
*/
|
|
63
|
+
interface ResidentialProxyConfig {
|
|
64
|
+
/**
|
|
65
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
66
|
+
*/
|
|
67
|
+
asn?: string;
|
|
68
|
+
/**
|
|
69
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
70
|
+
* provided.
|
|
71
|
+
*/
|
|
72
|
+
city?: string;
|
|
73
|
+
/**
|
|
74
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
75
|
+
* provided.
|
|
76
|
+
*/
|
|
77
|
+
country?: string;
|
|
78
|
+
/**
|
|
79
|
+
* Operating system of the residential device.
|
|
80
|
+
*/
|
|
81
|
+
os?: 'windows' | 'macos' | 'android';
|
|
82
|
+
/**
|
|
83
|
+
* Two-letter state code.
|
|
84
|
+
*/
|
|
85
|
+
state?: string;
|
|
86
|
+
/**
|
|
87
|
+
* US ZIP code.
|
|
88
|
+
*/
|
|
89
|
+
zip?: string;
|
|
90
|
+
}
|
|
91
|
+
/**
|
|
92
|
+
* Configuration for mobile proxies.
|
|
93
|
+
*/
|
|
94
|
+
interface MobileProxyConfig {
|
|
95
|
+
/**
|
|
96
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
97
|
+
*/
|
|
98
|
+
asn?: string;
|
|
99
|
+
/**
|
|
100
|
+
* Mobile carrier.
|
|
101
|
+
*/
|
|
102
|
+
carrier?: 'a1' | 'aircel' | 'airtel' | 'att' | 'celcom' | 'chinamobile' | 'claro' | 'comcast' | 'cox' | 'digi' | 'dt' | 'docomo' | 'dtac' | 'etisalat' | 'idea' | 'kyivstar' | 'meo' | 'megafon' | 'mtn' | 'mtnza' | 'mts' | 'optus' | 'orange' | 'qwest' | 'reliance_jio' | 'robi' | 'sprint' | 'telefonica' | 'telstra' | 'tmobile' | 'tigo' | 'tim' | 'verizon' | 'vimpelcom' | 'vodacomza' | 'vodafone' | 'vivo' | 'zain' | 'vivabo' | 'telenormyanmar' | 'kcelljsc' | 'swisscom' | 'singtel' | 'asiacell' | 'windit' | 'cellc' | 'ooredoo' | 'drei' | 'umobile' | 'cableone' | 'proximus' | 'tele2' | 'mobitel' | 'o2' | 'bouygues' | 'free' | 'sfr' | 'digicel';
|
|
103
|
+
/**
|
|
104
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
105
|
+
* provided.
|
|
106
|
+
*/
|
|
107
|
+
city?: string;
|
|
108
|
+
/**
|
|
109
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
110
|
+
* provided.
|
|
111
|
+
*/
|
|
112
|
+
country?: string;
|
|
113
|
+
/**
|
|
114
|
+
* Two-letter state code.
|
|
115
|
+
*/
|
|
116
|
+
state?: string;
|
|
117
|
+
/**
|
|
118
|
+
* US ZIP code.
|
|
119
|
+
*/
|
|
120
|
+
zip?: string;
|
|
121
|
+
}
|
|
122
|
+
/**
|
|
123
|
+
* Configuration for a custom proxy (e.g., private proxy server).
|
|
124
|
+
*/
|
|
125
|
+
interface CustomProxyConfig {
|
|
126
|
+
/**
|
|
127
|
+
* Proxy host address or IP.
|
|
128
|
+
*/
|
|
129
|
+
host: string;
|
|
130
|
+
/**
|
|
131
|
+
* Proxy port.
|
|
132
|
+
*/
|
|
133
|
+
port: number;
|
|
134
|
+
/**
|
|
135
|
+
* Whether the proxy has a password.
|
|
136
|
+
*/
|
|
137
|
+
has_password?: boolean;
|
|
138
|
+
/**
|
|
139
|
+
* Username for proxy authentication.
|
|
140
|
+
*/
|
|
141
|
+
username?: string;
|
|
142
|
+
}
|
|
143
|
+
}
|
|
144
|
+
/**
|
|
145
|
+
* Configuration for routing traffic through a proxy.
|
|
146
|
+
*/
|
|
147
|
+
export interface ProxyRetrieveResponse {
|
|
148
|
+
/**
|
|
149
|
+
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
150
|
+
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
151
|
+
*/
|
|
152
|
+
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
153
|
+
id?: string;
|
|
154
|
+
/**
|
|
155
|
+
* Configuration specific to the selected proxy `type`.
|
|
156
|
+
*/
|
|
157
|
+
config?: ProxyRetrieveResponse.DatacenterProxyConfig | ProxyRetrieveResponse.IspProxyConfig | ProxyRetrieveResponse.ResidentialProxyConfig | ProxyRetrieveResponse.MobileProxyConfig | ProxyRetrieveResponse.CustomProxyConfig;
|
|
158
|
+
/**
|
|
159
|
+
* Readable name of the proxy.
|
|
160
|
+
*/
|
|
161
|
+
name?: string;
|
|
162
|
+
}
|
|
163
|
+
export declare namespace ProxyRetrieveResponse {
|
|
164
|
+
/**
|
|
165
|
+
* Configuration for a datacenter proxy.
|
|
166
|
+
*/
|
|
167
|
+
interface DatacenterProxyConfig {
|
|
168
|
+
/**
|
|
169
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
170
|
+
*/
|
|
171
|
+
country: string;
|
|
172
|
+
}
|
|
173
|
+
/**
|
|
174
|
+
* Configuration for an ISP proxy.
|
|
175
|
+
*/
|
|
176
|
+
interface IspProxyConfig {
|
|
177
|
+
/**
|
|
178
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
179
|
+
*/
|
|
180
|
+
country: string;
|
|
181
|
+
}
|
|
182
|
+
/**
|
|
183
|
+
* Configuration for residential proxies.
|
|
184
|
+
*/
|
|
185
|
+
interface ResidentialProxyConfig {
|
|
186
|
+
/**
|
|
187
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
188
|
+
*/
|
|
189
|
+
asn?: string;
|
|
190
|
+
/**
|
|
191
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
192
|
+
* provided.
|
|
193
|
+
*/
|
|
194
|
+
city?: string;
|
|
195
|
+
/**
|
|
196
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
197
|
+
* provided.
|
|
198
|
+
*/
|
|
199
|
+
country?: string;
|
|
200
|
+
/**
|
|
201
|
+
* Operating system of the residential device.
|
|
202
|
+
*/
|
|
203
|
+
os?: 'windows' | 'macos' | 'android';
|
|
204
|
+
/**
|
|
205
|
+
* Two-letter state code.
|
|
206
|
+
*/
|
|
207
|
+
state?: string;
|
|
208
|
+
/**
|
|
209
|
+
* US ZIP code.
|
|
210
|
+
*/
|
|
211
|
+
zip?: string;
|
|
212
|
+
}
|
|
213
|
+
/**
|
|
214
|
+
* Configuration for mobile proxies.
|
|
215
|
+
*/
|
|
216
|
+
interface MobileProxyConfig {
|
|
217
|
+
/**
|
|
218
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
219
|
+
*/
|
|
220
|
+
asn?: string;
|
|
221
|
+
/**
|
|
222
|
+
* Mobile carrier.
|
|
223
|
+
*/
|
|
224
|
+
carrier?: 'a1' | 'aircel' | 'airtel' | 'att' | 'celcom' | 'chinamobile' | 'claro' | 'comcast' | 'cox' | 'digi' | 'dt' | 'docomo' | 'dtac' | 'etisalat' | 'idea' | 'kyivstar' | 'meo' | 'megafon' | 'mtn' | 'mtnza' | 'mts' | 'optus' | 'orange' | 'qwest' | 'reliance_jio' | 'robi' | 'sprint' | 'telefonica' | 'telstra' | 'tmobile' | 'tigo' | 'tim' | 'verizon' | 'vimpelcom' | 'vodacomza' | 'vodafone' | 'vivo' | 'zain' | 'vivabo' | 'telenormyanmar' | 'kcelljsc' | 'swisscom' | 'singtel' | 'asiacell' | 'windit' | 'cellc' | 'ooredoo' | 'drei' | 'umobile' | 'cableone' | 'proximus' | 'tele2' | 'mobitel' | 'o2' | 'bouygues' | 'free' | 'sfr' | 'digicel';
|
|
225
|
+
/**
|
|
226
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
227
|
+
* provided.
|
|
228
|
+
*/
|
|
229
|
+
city?: string;
|
|
230
|
+
/**
|
|
231
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
232
|
+
* provided.
|
|
233
|
+
*/
|
|
234
|
+
country?: string;
|
|
235
|
+
/**
|
|
236
|
+
* Two-letter state code.
|
|
237
|
+
*/
|
|
238
|
+
state?: string;
|
|
239
|
+
/**
|
|
240
|
+
* US ZIP code.
|
|
241
|
+
*/
|
|
242
|
+
zip?: string;
|
|
243
|
+
}
|
|
244
|
+
/**
|
|
245
|
+
* Configuration for a custom proxy (e.g., private proxy server).
|
|
246
|
+
*/
|
|
247
|
+
interface CustomProxyConfig {
|
|
248
|
+
/**
|
|
249
|
+
* Proxy host address or IP.
|
|
250
|
+
*/
|
|
251
|
+
host: string;
|
|
252
|
+
/**
|
|
253
|
+
* Proxy port.
|
|
254
|
+
*/
|
|
255
|
+
port: number;
|
|
256
|
+
/**
|
|
257
|
+
* Whether the proxy has a password.
|
|
258
|
+
*/
|
|
259
|
+
has_password?: boolean;
|
|
260
|
+
/**
|
|
261
|
+
* Username for proxy authentication.
|
|
262
|
+
*/
|
|
263
|
+
username?: string;
|
|
264
|
+
}
|
|
265
|
+
}
|
|
266
|
+
export type ProxyListResponse = Array<ProxyListResponse.ProxyListResponseItem>;
|
|
267
|
+
export declare namespace ProxyListResponse {
|
|
268
|
+
/**
|
|
269
|
+
* Configuration for routing traffic through a proxy.
|
|
270
|
+
*/
|
|
271
|
+
interface ProxyListResponseItem {
|
|
272
|
+
/**
|
|
273
|
+
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
274
|
+
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
275
|
+
*/
|
|
276
|
+
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
277
|
+
id?: string;
|
|
278
|
+
/**
|
|
279
|
+
* Configuration specific to the selected proxy `type`.
|
|
280
|
+
*/
|
|
281
|
+
config?: ProxyListResponseItem.DatacenterProxyConfig | ProxyListResponseItem.IspProxyConfig | ProxyListResponseItem.ResidentialProxyConfig | ProxyListResponseItem.MobileProxyConfig | ProxyListResponseItem.CustomProxyConfig;
|
|
282
|
+
/**
|
|
283
|
+
* Readable name of the proxy.
|
|
284
|
+
*/
|
|
285
|
+
name?: string;
|
|
286
|
+
}
|
|
287
|
+
namespace ProxyListResponseItem {
|
|
288
|
+
/**
|
|
289
|
+
* Configuration for a datacenter proxy.
|
|
290
|
+
*/
|
|
291
|
+
interface DatacenterProxyConfig {
|
|
292
|
+
/**
|
|
293
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
294
|
+
*/
|
|
295
|
+
country: string;
|
|
296
|
+
}
|
|
297
|
+
/**
|
|
298
|
+
* Configuration for an ISP proxy.
|
|
299
|
+
*/
|
|
300
|
+
interface IspProxyConfig {
|
|
301
|
+
/**
|
|
302
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
303
|
+
*/
|
|
304
|
+
country: string;
|
|
305
|
+
}
|
|
306
|
+
/**
|
|
307
|
+
* Configuration for residential proxies.
|
|
308
|
+
*/
|
|
309
|
+
interface ResidentialProxyConfig {
|
|
310
|
+
/**
|
|
311
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
312
|
+
*/
|
|
313
|
+
asn?: string;
|
|
314
|
+
/**
|
|
315
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
316
|
+
* provided.
|
|
317
|
+
*/
|
|
318
|
+
city?: string;
|
|
319
|
+
/**
|
|
320
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
321
|
+
* provided.
|
|
322
|
+
*/
|
|
323
|
+
country?: string;
|
|
324
|
+
/**
|
|
325
|
+
* Operating system of the residential device.
|
|
326
|
+
*/
|
|
327
|
+
os?: 'windows' | 'macos' | 'android';
|
|
328
|
+
/**
|
|
329
|
+
* Two-letter state code.
|
|
330
|
+
*/
|
|
331
|
+
state?: string;
|
|
332
|
+
/**
|
|
333
|
+
* US ZIP code.
|
|
334
|
+
*/
|
|
335
|
+
zip?: string;
|
|
336
|
+
}
|
|
337
|
+
/**
|
|
338
|
+
* Configuration for mobile proxies.
|
|
339
|
+
*/
|
|
340
|
+
interface MobileProxyConfig {
|
|
341
|
+
/**
|
|
342
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
343
|
+
*/
|
|
344
|
+
asn?: string;
|
|
345
|
+
/**
|
|
346
|
+
* Mobile carrier.
|
|
347
|
+
*/
|
|
348
|
+
carrier?: 'a1' | 'aircel' | 'airtel' | 'att' | 'celcom' | 'chinamobile' | 'claro' | 'comcast' | 'cox' | 'digi' | 'dt' | 'docomo' | 'dtac' | 'etisalat' | 'idea' | 'kyivstar' | 'meo' | 'megafon' | 'mtn' | 'mtnza' | 'mts' | 'optus' | 'orange' | 'qwest' | 'reliance_jio' | 'robi' | 'sprint' | 'telefonica' | 'telstra' | 'tmobile' | 'tigo' | 'tim' | 'verizon' | 'vimpelcom' | 'vodacomza' | 'vodafone' | 'vivo' | 'zain' | 'vivabo' | 'telenormyanmar' | 'kcelljsc' | 'swisscom' | 'singtel' | 'asiacell' | 'windit' | 'cellc' | 'ooredoo' | 'drei' | 'umobile' | 'cableone' | 'proximus' | 'tele2' | 'mobitel' | 'o2' | 'bouygues' | 'free' | 'sfr' | 'digicel';
|
|
349
|
+
/**
|
|
350
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
351
|
+
* provided.
|
|
352
|
+
*/
|
|
353
|
+
city?: string;
|
|
354
|
+
/**
|
|
355
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
356
|
+
* provided.
|
|
357
|
+
*/
|
|
358
|
+
country?: string;
|
|
359
|
+
/**
|
|
360
|
+
* Two-letter state code.
|
|
361
|
+
*/
|
|
362
|
+
state?: string;
|
|
363
|
+
/**
|
|
364
|
+
* US ZIP code.
|
|
365
|
+
*/
|
|
366
|
+
zip?: string;
|
|
367
|
+
}
|
|
368
|
+
/**
|
|
369
|
+
* Configuration for a custom proxy (e.g., private proxy server).
|
|
370
|
+
*/
|
|
371
|
+
interface CustomProxyConfig {
|
|
372
|
+
/**
|
|
373
|
+
* Proxy host address or IP.
|
|
374
|
+
*/
|
|
375
|
+
host: string;
|
|
376
|
+
/**
|
|
377
|
+
* Proxy port.
|
|
378
|
+
*/
|
|
379
|
+
port: number;
|
|
380
|
+
/**
|
|
381
|
+
* Whether the proxy has a password.
|
|
382
|
+
*/
|
|
383
|
+
has_password?: boolean;
|
|
384
|
+
/**
|
|
385
|
+
* Username for proxy authentication.
|
|
386
|
+
*/
|
|
387
|
+
username?: string;
|
|
388
|
+
}
|
|
389
|
+
}
|
|
390
|
+
}
|
|
391
|
+
export interface ProxyCreateParams {
|
|
392
|
+
/**
|
|
393
|
+
* Proxy type to use. In terms of quality for avoiding bot-detection, from best to
|
|
394
|
+
* worst: `mobile` > `residential` > `isp` > `datacenter`.
|
|
395
|
+
*/
|
|
396
|
+
type: 'datacenter' | 'isp' | 'residential' | 'mobile' | 'custom';
|
|
397
|
+
/**
|
|
398
|
+
* Configuration specific to the selected proxy `type`.
|
|
399
|
+
*/
|
|
400
|
+
config?: ProxyCreateParams.DatacenterProxyConfig | ProxyCreateParams.IspProxyConfig | ProxyCreateParams.ResidentialProxyConfig | ProxyCreateParams.MobileProxyConfig | ProxyCreateParams.CreateCustomProxyConfig;
|
|
401
|
+
/**
|
|
402
|
+
* Readable name of the proxy.
|
|
403
|
+
*/
|
|
404
|
+
name?: string;
|
|
405
|
+
}
|
|
406
|
+
export declare namespace ProxyCreateParams {
|
|
407
|
+
/**
|
|
408
|
+
* Configuration for a datacenter proxy.
|
|
409
|
+
*/
|
|
410
|
+
interface DatacenterProxyConfig {
|
|
411
|
+
/**
|
|
412
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
413
|
+
*/
|
|
414
|
+
country: string;
|
|
415
|
+
}
|
|
416
|
+
/**
|
|
417
|
+
* Configuration for an ISP proxy.
|
|
418
|
+
*/
|
|
419
|
+
interface IspProxyConfig {
|
|
420
|
+
/**
|
|
421
|
+
* ISO 3166 country code or EU for the proxy exit node.
|
|
422
|
+
*/
|
|
423
|
+
country: string;
|
|
424
|
+
}
|
|
425
|
+
/**
|
|
426
|
+
* Configuration for residential proxies.
|
|
427
|
+
*/
|
|
428
|
+
interface ResidentialProxyConfig {
|
|
429
|
+
/**
|
|
430
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
431
|
+
*/
|
|
432
|
+
asn?: string;
|
|
433
|
+
/**
|
|
434
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
435
|
+
* provided.
|
|
436
|
+
*/
|
|
437
|
+
city?: string;
|
|
438
|
+
/**
|
|
439
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
440
|
+
* provided.
|
|
441
|
+
*/
|
|
442
|
+
country?: string;
|
|
443
|
+
/**
|
|
444
|
+
* Operating system of the residential device.
|
|
445
|
+
*/
|
|
446
|
+
os?: 'windows' | 'macos' | 'android';
|
|
447
|
+
/**
|
|
448
|
+
* Two-letter state code.
|
|
449
|
+
*/
|
|
450
|
+
state?: string;
|
|
451
|
+
/**
|
|
452
|
+
* US ZIP code.
|
|
453
|
+
*/
|
|
454
|
+
zip?: string;
|
|
455
|
+
}
|
|
456
|
+
/**
|
|
457
|
+
* Configuration for mobile proxies.
|
|
458
|
+
*/
|
|
459
|
+
interface MobileProxyConfig {
|
|
460
|
+
/**
|
|
461
|
+
* Autonomous system number. See https://bgp.potaroo.net/cidr/autnums.html
|
|
462
|
+
*/
|
|
463
|
+
asn?: string;
|
|
464
|
+
/**
|
|
465
|
+
* Mobile carrier.
|
|
466
|
+
*/
|
|
467
|
+
carrier?: 'a1' | 'aircel' | 'airtel' | 'att' | 'celcom' | 'chinamobile' | 'claro' | 'comcast' | 'cox' | 'digi' | 'dt' | 'docomo' | 'dtac' | 'etisalat' | 'idea' | 'kyivstar' | 'meo' | 'megafon' | 'mtn' | 'mtnza' | 'mts' | 'optus' | 'orange' | 'qwest' | 'reliance_jio' | 'robi' | 'sprint' | 'telefonica' | 'telstra' | 'tmobile' | 'tigo' | 'tim' | 'verizon' | 'vimpelcom' | 'vodacomza' | 'vodafone' | 'vivo' | 'zain' | 'vivabo' | 'telenormyanmar' | 'kcelljsc' | 'swisscom' | 'singtel' | 'asiacell' | 'windit' | 'cellc' | 'ooredoo' | 'drei' | 'umobile' | 'cableone' | 'proximus' | 'tele2' | 'mobitel' | 'o2' | 'bouygues' | 'free' | 'sfr' | 'digicel';
|
|
468
|
+
/**
|
|
469
|
+
* City name (no spaces, e.g. `sanfrancisco`). If provided, `country` must also be
|
|
470
|
+
* provided.
|
|
471
|
+
*/
|
|
472
|
+
city?: string;
|
|
473
|
+
/**
|
|
474
|
+
* ISO 3166 country code or EU for the proxy exit node. Required if `city` is
|
|
475
|
+
* provided.
|
|
476
|
+
*/
|
|
477
|
+
country?: string;
|
|
478
|
+
/**
|
|
479
|
+
* Two-letter state code.
|
|
480
|
+
*/
|
|
481
|
+
state?: string;
|
|
482
|
+
/**
|
|
483
|
+
* US ZIP code.
|
|
484
|
+
*/
|
|
485
|
+
zip?: string;
|
|
486
|
+
}
|
|
487
|
+
/**
|
|
488
|
+
* Configuration for a custom proxy (e.g., private proxy server).
|
|
489
|
+
*/
|
|
490
|
+
interface CreateCustomProxyConfig {
|
|
491
|
+
/**
|
|
492
|
+
* Proxy host address or IP.
|
|
493
|
+
*/
|
|
494
|
+
host: string;
|
|
495
|
+
/**
|
|
496
|
+
* Proxy port.
|
|
497
|
+
*/
|
|
498
|
+
port: number;
|
|
499
|
+
/**
|
|
500
|
+
* Password for proxy authentication.
|
|
501
|
+
*/
|
|
502
|
+
password?: string;
|
|
503
|
+
/**
|
|
504
|
+
* Username for proxy authentication.
|
|
505
|
+
*/
|
|
506
|
+
username?: string;
|
|
507
|
+
}
|
|
508
|
+
}
|
|
509
|
+
export declare namespace Proxies {
|
|
510
|
+
export { type ProxyCreateResponse as ProxyCreateResponse, type ProxyRetrieveResponse as ProxyRetrieveResponse, type ProxyListResponse as ProxyListResponse, type ProxyCreateParams as ProxyCreateParams, };
|
|
511
|
+
}
|
|
512
|
+
//# sourceMappingURL=proxies.d.ts.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proxies.d.ts","sourceRoot":"","sources":["../src/resources/proxies.ts"],"names":[],"mappings":"OAEO,EAAE,WAAW,EAAE;OACf,EAAE,UAAU,EAAE;OAEd,EAAE,cAAc,EAAE;AAGzB,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,CAAC,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,iBAAiB,CAAC;IAI7D;;OAEG;IACH,MAAM,CAAC,EAAE,EAAE,MAAM,EAAE,OAAO,CAAC,EAAE,cAAc,GAAG,UAAU,CAAC,IAAI,CAAC;CAM/D;AAED;;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,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,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,mBAAmB,CAAC;IACnC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;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,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EACJ,IAAI,GACJ,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,aAAa,GACb,OAAO,GACP,SAAS,GACT,KAAK,GACL,MAAM,GACN,IAAI,GACJ,QAAQ,GACR,MAAM,GACN,UAAU,GACV,MAAM,GACN,UAAU,GACV,KAAK,GACL,SAAS,GACT,KAAK,GACL,OAAO,GACP,KAAK,GACL,OAAO,GACP,QAAQ,GACR,OAAO,GACP,cAAc,GACd,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,SAAS,GACT,MAAM,GACN,KAAK,GACL,SAAS,GACT,WAAW,GACX,WAAW,GACX,UAAU,GACV,MAAM,GACN,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,UAAU,GACV,UAAU,GACV,SAAS,GACT,UAAU,GACV,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,UAAU,GACV,UAAU,GACV,OAAO,GACP,SAAS,GACT,IAAI,GACJ,UAAU,GACV,MAAM,GACN,KAAK,GACL,SAAS,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;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,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,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,IAAI,CAAC,EAAE,MAAM,CAAC;CACf;AAED,yBAAiB,qBAAqB,CAAC;IACrC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;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,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EACJ,IAAI,GACJ,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,aAAa,GACb,OAAO,GACP,SAAS,GACT,KAAK,GACL,MAAM,GACN,IAAI,GACJ,QAAQ,GACR,MAAM,GACN,UAAU,GACV,MAAM,GACN,UAAU,GACV,KAAK,GACL,SAAS,GACT,KAAK,GACL,OAAO,GACP,KAAK,GACL,OAAO,GACP,QAAQ,GACR,OAAO,GACP,cAAc,GACd,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,SAAS,GACT,MAAM,GACN,KAAK,GACL,SAAS,GACT,WAAW,GACX,WAAW,GACX,UAAU,GACV,MAAM,GACN,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,UAAU,GACV,UAAU,GACV,SAAS,GACT,UAAU,GACV,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,UAAU,GACV,UAAU,GACV,OAAO,GACP,SAAS,GACT,IAAI,GACJ,UAAU,GACV,MAAM,GACN,KAAK,GACL,SAAS,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;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,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,MAAM,iBAAiB,GAAG,KAAK,CAAC,iBAAiB,CAAC,qBAAqB,CAAC,CAAC;AAE/E,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;;WAGG;QACH,IAAI,EAAE,YAAY,GAAG,KAAK,GAAG,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;QAEjE,EAAE,CAAC,EAAE,MAAM,CAAC;QAEZ;;WAEG;QACH,MAAM,CAAC,EACH,qBAAqB,CAAC,qBAAqB,GAC3C,qBAAqB,CAAC,cAAc,GACpC,qBAAqB,CAAC,sBAAsB,GAC5C,qBAAqB,CAAC,iBAAiB,GACvC,qBAAqB,CAAC,iBAAiB,CAAC;QAE5C;;WAEG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;KACf;IAED,UAAiB,qBAAqB,CAAC;QACrC;;WAEG;QACH,UAAiB,qBAAqB;YACpC;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;SACjB;QAED;;WAEG;QACH,UAAiB,cAAc;YAC7B;;eAEG;YACH,OAAO,EAAE,MAAM,CAAC;SACjB;QAED;;WAEG;QACH,UAAiB,sBAAsB;YACrC;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,EAAE,CAAC,EAAE,SAAS,GAAG,OAAO,GAAG,SAAS,CAAC;YAErC;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,OAAO,CAAC,EACJ,IAAI,GACJ,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,aAAa,GACb,OAAO,GACP,SAAS,GACT,KAAK,GACL,MAAM,GACN,IAAI,GACJ,QAAQ,GACR,MAAM,GACN,UAAU,GACV,MAAM,GACN,UAAU,GACV,KAAK,GACL,SAAS,GACT,KAAK,GACL,OAAO,GACP,KAAK,GACL,OAAO,GACP,QAAQ,GACR,OAAO,GACP,cAAc,GACd,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,SAAS,GACT,MAAM,GACN,KAAK,GACL,SAAS,GACT,WAAW,GACX,WAAW,GACX,UAAU,GACV,MAAM,GACN,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,UAAU,GACV,UAAU,GACV,SAAS,GACT,UAAU,GACV,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,UAAU,GACV,UAAU,GACV,OAAO,GACP,SAAS,GACT,IAAI,GACJ,UAAU,GACV,MAAM,GACN,KAAK,GACL,SAAS,CAAC;YAEd;;;eAGG;YACH,IAAI,CAAC,EAAE,MAAM,CAAC;YAEd;;;eAGG;YACH,OAAO,CAAC,EAAE,MAAM,CAAC;YAEjB;;eAEG;YACH,KAAK,CAAC,EAAE,MAAM,CAAC;YAEf;;eAEG;YACH,GAAG,CAAC,EAAE,MAAM,CAAC;SACd;QAED;;WAEG;QACH,UAAiB,iBAAiB;YAChC;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,IAAI,EAAE,MAAM,CAAC;YAEb;;eAEG;YACH,YAAY,CAAC,EAAE,OAAO,CAAC;YAEvB;;eAEG;YACH,QAAQ,CAAC,EAAE,MAAM,CAAC;SACnB;KACF;CACF;AAED,MAAM,WAAW,iBAAiB;IAChC;;;OAGG;IACH,IAAI,EAAE,YAAY,GAAG,KAAK,GAAG,aAAa,GAAG,QAAQ,GAAG,QAAQ,CAAC;IAEjE;;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;CACf;AAED,yBAAiB,iBAAiB,CAAC;IACjC;;OAEG;IACH,UAAiB,qBAAqB;QACpC;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,cAAc;QAC7B;;WAEG;QACH,OAAO,EAAE,MAAM,CAAC;KACjB;IAED;;OAEG;IACH,UAAiB,sBAAsB;QACrC;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;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,GAAG,CAAC,EAAE,MAAM,CAAC;QAEb;;WAEG;QACH,OAAO,CAAC,EACJ,IAAI,GACJ,QAAQ,GACR,QAAQ,GACR,KAAK,GACL,QAAQ,GACR,aAAa,GACb,OAAO,GACP,SAAS,GACT,KAAK,GACL,MAAM,GACN,IAAI,GACJ,QAAQ,GACR,MAAM,GACN,UAAU,GACV,MAAM,GACN,UAAU,GACV,KAAK,GACL,SAAS,GACT,KAAK,GACL,OAAO,GACP,KAAK,GACL,OAAO,GACP,QAAQ,GACR,OAAO,GACP,cAAc,GACd,MAAM,GACN,QAAQ,GACR,YAAY,GACZ,SAAS,GACT,SAAS,GACT,MAAM,GACN,KAAK,GACL,SAAS,GACT,WAAW,GACX,WAAW,GACX,UAAU,GACV,MAAM,GACN,MAAM,GACN,QAAQ,GACR,gBAAgB,GAChB,UAAU,GACV,UAAU,GACV,SAAS,GACT,UAAU,GACV,QAAQ,GACR,OAAO,GACP,SAAS,GACT,MAAM,GACN,SAAS,GACT,UAAU,GACV,UAAU,GACV,OAAO,GACP,SAAS,GACT,IAAI,GACJ,UAAU,GACV,MAAM,GACN,KAAK,GACL,SAAS,CAAC;QAEd;;;WAGG;QACH,IAAI,CAAC,EAAE,MAAM,CAAC;QAEd;;;WAGG;QACH,OAAO,CAAC,EAAE,MAAM,CAAC;QAEjB;;WAEG;QACH,KAAK,CAAC,EAAE,MAAM,CAAC;QAEf;;WAEG;QACH,GAAG,CAAC,EAAE,MAAM,CAAC;KACd;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,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,iBAAiB,IAAI,iBAAiB,GAC5C,CAAC;CACH"}
|
|
@@ -0,0 +1,38 @@
|
|
|
1
|
+
"use strict";
|
|
2
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
3
|
+
Object.defineProperty(exports, "__esModule", { value: true });
|
|
4
|
+
exports.Proxies = void 0;
|
|
5
|
+
const resource_1 = require("../core/resource.js");
|
|
6
|
+
const headers_1 = require("../internal/headers.js");
|
|
7
|
+
const path_1 = require("../internal/utils/path.js");
|
|
8
|
+
class Proxies extends resource_1.APIResource {
|
|
9
|
+
/**
|
|
10
|
+
* Create a new proxy configuration for the caller's organization.
|
|
11
|
+
*/
|
|
12
|
+
create(body, options) {
|
|
13
|
+
return this._client.post('/proxies', { body, ...options });
|
|
14
|
+
}
|
|
15
|
+
/**
|
|
16
|
+
* Retrieve a proxy belonging to the caller's organization by ID.
|
|
17
|
+
*/
|
|
18
|
+
retrieve(id, options) {
|
|
19
|
+
return this._client.get((0, path_1.path) `/proxies/${id}`, options);
|
|
20
|
+
}
|
|
21
|
+
/**
|
|
22
|
+
* List proxies owned by the caller's organization.
|
|
23
|
+
*/
|
|
24
|
+
list(options) {
|
|
25
|
+
return this._client.get('/proxies', options);
|
|
26
|
+
}
|
|
27
|
+
/**
|
|
28
|
+
* Soft delete a proxy. Sessions referencing it are not modified.
|
|
29
|
+
*/
|
|
30
|
+
delete(id, options) {
|
|
31
|
+
return this._client.delete((0, path_1.path) `/proxies/${id}`, {
|
|
32
|
+
...options,
|
|
33
|
+
headers: (0, headers_1.buildHeaders)([{ Accept: '*/*' }, options?.headers]),
|
|
34
|
+
});
|
|
35
|
+
}
|
|
36
|
+
}
|
|
37
|
+
exports.Proxies = Proxies;
|
|
38
|
+
//# sourceMappingURL=proxies.js.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proxies.js","sourceRoot":"","sources":["../src/resources/proxies.ts"],"names":[],"mappings":";AAAA,sFAAsF;;;AAEtF,kDAA+C;AAE/C,oDAAmD;AAEnD,oDAA8C;AAE9C,MAAa,OAAQ,SAAQ,sBAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAA,WAAI,EAAA,YAAY,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,IAAA,sBAAY,EAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF;AA/BD,0BA+BC"}
|
|
@@ -0,0 +1,34 @@
|
|
|
1
|
+
// File generated from our OpenAPI spec by Stainless. See CONTRIBUTING.md for details.
|
|
2
|
+
import { APIResource } from "../core/resource.mjs";
|
|
3
|
+
import { buildHeaders } from "../internal/headers.mjs";
|
|
4
|
+
import { path } from "../internal/utils/path.mjs";
|
|
5
|
+
export class Proxies extends APIResource {
|
|
6
|
+
/**
|
|
7
|
+
* Create a new proxy configuration for the caller's organization.
|
|
8
|
+
*/
|
|
9
|
+
create(body, options) {
|
|
10
|
+
return this._client.post('/proxies', { body, ...options });
|
|
11
|
+
}
|
|
12
|
+
/**
|
|
13
|
+
* Retrieve a proxy belonging to the caller's organization by ID.
|
|
14
|
+
*/
|
|
15
|
+
retrieve(id, options) {
|
|
16
|
+
return this._client.get(path `/proxies/${id}`, options);
|
|
17
|
+
}
|
|
18
|
+
/**
|
|
19
|
+
* List proxies owned by the caller's organization.
|
|
20
|
+
*/
|
|
21
|
+
list(options) {
|
|
22
|
+
return this._client.get('/proxies', options);
|
|
23
|
+
}
|
|
24
|
+
/**
|
|
25
|
+
* Soft delete a proxy. Sessions referencing it are not modified.
|
|
26
|
+
*/
|
|
27
|
+
delete(id, options) {
|
|
28
|
+
return this._client.delete(path `/proxies/${id}`, {
|
|
29
|
+
...options,
|
|
30
|
+
headers: buildHeaders([{ Accept: '*/*' }, options?.headers]),
|
|
31
|
+
});
|
|
32
|
+
}
|
|
33
|
+
}
|
|
34
|
+
//# sourceMappingURL=proxies.mjs.map
|
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{"version":3,"file":"proxies.mjs","sourceRoot":"","sources":["../src/resources/proxies.ts"],"names":[],"mappings":"AAAA,sFAAsF;OAE/E,EAAE,WAAW,EAAE;OAEf,EAAE,YAAY,EAAE;OAEhB,EAAE,IAAI,EAAE;AAEf,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;OAEG;IACH,MAAM,CAAC,IAAuB,EAAE,OAAwB;QACtD,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,UAAU,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7D,CAAC;IAED;;OAEG;IACH,QAAQ,CAAC,EAAU,EAAE,OAAwB;QAC3C,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,OAAO,CAAC,CAAC;IACzD,CAAC;IAED;;OAEG;IACH,IAAI,CAAC,OAAwB;QAC3B,OAAO,IAAI,CAAC,OAAO,CAAC,GAAG,CAAC,UAAU,EAAE,OAAO,CAAC,CAAC;IAC/C,CAAC;IAED;;OAEG;IACH,MAAM,CAAC,EAAU,EAAE,OAAwB;QACzC,OAAO,IAAI,CAAC,OAAO,CAAC,MAAM,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE;YAC/C,GAAG,OAAO;YACV,OAAO,EAAE,YAAY,CAAC,CAAC,EAAE,MAAM,EAAE,KAAK,EAAE,EAAE,OAAO,EAAE,OAAO,CAAC,CAAC;SAC7D,CAAC,CAAC;IACL,CAAC;CACF"}
|
package/src/client.ts
CHANGED
|
@@ -43,6 +43,13 @@ import {
|
|
|
43
43
|
Invocations,
|
|
44
44
|
} from './resources/invocations';
|
|
45
45
|
import { ProfileCreateParams, ProfileListResponse, Profiles } from './resources/profiles';
|
|
46
|
+
import {
|
|
47
|
+
Proxies,
|
|
48
|
+
ProxyCreateParams,
|
|
49
|
+
ProxyCreateResponse,
|
|
50
|
+
ProxyListResponse,
|
|
51
|
+
ProxyRetrieveResponse,
|
|
52
|
+
} from './resources/proxies';
|
|
46
53
|
import {
|
|
47
54
|
BrowserCreateParams,
|
|
48
55
|
BrowserCreateResponse,
|
|
@@ -820,6 +827,7 @@ export class Kernel {
|
|
|
820
827
|
invocations: API.Invocations = new API.Invocations(this);
|
|
821
828
|
browsers: API.Browsers = new API.Browsers(this);
|
|
822
829
|
profiles: API.Profiles = new API.Profiles(this);
|
|
830
|
+
proxies: API.Proxies = new API.Proxies(this);
|
|
823
831
|
}
|
|
824
832
|
|
|
825
833
|
Kernel.Deployments = Deployments;
|
|
@@ -827,6 +835,7 @@ Kernel.Apps = Apps;
|
|
|
827
835
|
Kernel.Invocations = Invocations;
|
|
828
836
|
Kernel.Browsers = Browsers;
|
|
829
837
|
Kernel.Profiles = Profiles;
|
|
838
|
+
Kernel.Proxies = Proxies;
|
|
830
839
|
|
|
831
840
|
export declare namespace Kernel {
|
|
832
841
|
export type RequestOptions = Opts.RequestOptions;
|
|
@@ -880,6 +889,14 @@ export declare namespace Kernel {
|
|
|
880
889
|
type ProfileCreateParams as ProfileCreateParams,
|
|
881
890
|
};
|
|
882
891
|
|
|
892
|
+
export {
|
|
893
|
+
Proxies as Proxies,
|
|
894
|
+
type ProxyCreateResponse as ProxyCreateResponse,
|
|
895
|
+
type ProxyRetrieveResponse as ProxyRetrieveResponse,
|
|
896
|
+
type ProxyListResponse as ProxyListResponse,
|
|
897
|
+
type ProxyCreateParams as ProxyCreateParams,
|
|
898
|
+
};
|
|
899
|
+
|
|
883
900
|
export type AppAction = API.AppAction;
|
|
884
901
|
export type ErrorDetail = API.ErrorDetail;
|
|
885
902
|
export type ErrorEvent = API.ErrorEvent;
|
|
@@ -348,6 +348,12 @@ export interface BrowserCreateParams {
|
|
|
348
348
|
*/
|
|
349
349
|
profile?: BrowserCreateParams.Profile;
|
|
350
350
|
|
|
351
|
+
/**
|
|
352
|
+
* Optional proxy to associate to the browser session. Must reference a proxy
|
|
353
|
+
* belonging to the caller's org.
|
|
354
|
+
*/
|
|
355
|
+
proxy_id?: string;
|
|
356
|
+
|
|
351
357
|
/**
|
|
352
358
|
* If true, launches the browser in stealth mode to reduce detection by anti-bot
|
|
353
359
|
* mechanisms.
|
|
@@ -357,7 +363,10 @@ export interface BrowserCreateParams {
|
|
|
357
363
|
/**
|
|
358
364
|
* The number of seconds of inactivity before the browser session is terminated.
|
|
359
365
|
* Only applicable to non-persistent browsers. Activity includes CDP connections
|
|
360
|
-
* and live view connections. Defaults to 60 seconds.
|
|
366
|
+
* and live view connections. Defaults to 60 seconds. Minimum allowed is 10
|
|
367
|
+
* seconds. Maximum allowed is 86400 (24 hours). We check for inactivity every 5
|
|
368
|
+
* seconds, so the actual timeout behavior you will see is +/- 5 seconds around the
|
|
369
|
+
* specified value.
|
|
361
370
|
*/
|
|
362
371
|
timeout_seconds?: number;
|
|
363
372
|
}
|