@onkernel/sdk 0.75.0 → 0.78.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 +34 -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/api-keys.d.mts +10 -2
- package/resources/api-keys.d.mts.map +1 -1
- package/resources/api-keys.d.ts +10 -2
- package/resources/api-keys.d.ts.map +1 -1
- package/resources/audit-logs.d.mts +2 -2
- package/resources/audit-logs.d.mts.map +1 -1
- package/resources/audit-logs.d.ts +2 -2
- package/resources/audit-logs.d.ts.map +1 -1
- package/resources/auth/connections.d.mts +30 -10
- package/resources/auth/connections.d.mts.map +1 -1
- package/resources/auth/connections.d.ts +30 -10
- package/resources/auth/connections.d.ts.map +1 -1
- package/resources/browser-pools.d.mts +56 -45
- package/resources/browser-pools.d.mts.map +1 -1
- package/resources/browser-pools.d.ts +56 -45
- package/resources/browser-pools.d.ts.map +1 -1
- package/resources/browsers/browsers.d.mts +34 -16
- package/resources/browsers/browsers.d.mts.map +1 -1
- package/resources/browsers/browsers.d.ts +34 -16
- 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/telemetry.d.mts +12 -9
- package/resources/browsers/telemetry.d.mts.map +1 -1
- package/resources/browsers/telemetry.d.ts +12 -9
- package/resources/browsers/telemetry.d.ts.map +1 -1
- package/resources/credential-providers.d.mts +2 -1
- package/resources/credential-providers.d.mts.map +1 -1
- package/resources/credential-providers.d.ts +2 -1
- package/resources/credential-providers.d.ts.map +1 -1
- package/resources/credentials.d.mts +18 -1
- package/resources/credentials.d.mts.map +1 -1
- package/resources/credentials.d.ts +18 -1
- package/resources/credentials.d.ts.map +1 -1
- package/resources/deployments.d.mts +112 -0
- package/resources/deployments.d.mts.map +1 -1
- package/resources/deployments.d.ts +112 -0
- package/resources/deployments.d.ts.map +1 -1
- package/resources/extensions.d.mts +9 -1
- package/resources/extensions.d.mts.map +1 -1
- package/resources/extensions.d.ts +9 -1
- package/resources/extensions.d.ts.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 +1 -1
- package/resources/index.mjs.map +1 -1
- package/resources/organization/limits.d.mts +14 -13
- package/resources/organization/limits.d.mts.map +1 -1
- package/resources/organization/limits.d.ts +14 -13
- package/resources/organization/limits.d.ts.map +1 -1
- package/resources/organization/limits.js +4 -4
- package/resources/organization/limits.js.map +1 -1
- package/resources/organization/limits.mjs +4 -4
- package/resources/organization/limits.mjs.map +1 -1
- package/resources/profiles.d.mts +72 -3
- package/resources/profiles.d.mts.map +1 -1
- package/resources/profiles.d.ts +72 -3
- package/resources/profiles.d.ts.map +1 -1
- package/resources/profiles.js +54 -0
- package/resources/profiles.js.map +1 -1
- package/resources/profiles.mjs +54 -0
- package/resources/profiles.mjs.map +1 -1
- package/resources/projects/limits.d.mts +18 -12
- package/resources/projects/limits.d.mts.map +1 -1
- package/resources/projects/limits.d.ts +18 -12
- package/resources/projects/limits.d.ts.map +1 -1
- package/resources/projects/projects.d.mts +5 -0
- package/resources/projects/projects.d.mts.map +1 -1
- package/resources/projects/projects.d.ts +5 -0
- package/resources/projects/projects.d.ts.map +1 -1
- package/resources/projects/projects.js.map +1 -1
- package/resources/projects/projects.mjs.map +1 -1
- package/resources/proxies.d.mts +187 -2
- package/resources/proxies.d.mts.map +1 -1
- package/resources/proxies.d.ts +187 -2
- package/resources/proxies.d.ts.map +1 -1
- package/resources/proxies.js +46 -0
- package/resources/proxies.js.map +1 -1
- package/resources/proxies.mjs +46 -0
- package/resources/proxies.mjs.map +1 -1
- package/src/client.ts +6 -1
- package/src/resources/api-keys.ts +11 -2
- package/src/resources/audit-logs.ts +2 -2
- package/src/resources/auth/connections.ts +30 -10
- package/src/resources/browser-pools.ts +57 -45
- package/src/resources/browsers/browsers.ts +34 -16
- package/src/resources/browsers/telemetry.ts +12 -9
- package/src/resources/credential-providers.ts +2 -1
- package/src/resources/credentials.ts +21 -1
- package/src/resources/deployments.ts +132 -0
- package/src/resources/extensions.ts +10 -1
- package/src/resources/index.ts +8 -1
- package/src/resources/organization/limits.ts +14 -13
- package/src/resources/profiles.ts +85 -3
- package/src/resources/projects/limits.ts +18 -12
- package/src/resources/projects/projects.ts +6 -0
- package/src/resources/proxies.ts +222 -1
- 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
package/resources/proxies.mjs
CHANGED
|
@@ -9,24 +9,65 @@ import { path } from "../internal/utils/path.mjs";
|
|
|
9
9
|
export class Proxies extends APIResource {
|
|
10
10
|
/**
|
|
11
11
|
* Create a new proxy configuration in the resolved project.
|
|
12
|
+
*
|
|
13
|
+
* @example
|
|
14
|
+
* ```ts
|
|
15
|
+
* const proxy = await client.proxies.create({
|
|
16
|
+
* type: 'datacenter',
|
|
17
|
+
* });
|
|
18
|
+
* ```
|
|
12
19
|
*/
|
|
13
20
|
create(body, options) {
|
|
14
21
|
return this._client.post('/proxies', { body, ...options });
|
|
15
22
|
}
|
|
16
23
|
/**
|
|
17
24
|
* Retrieve a proxy in the resolved project by ID.
|
|
25
|
+
*
|
|
26
|
+
* @example
|
|
27
|
+
* ```ts
|
|
28
|
+
* const proxy = await client.proxies.retrieve('id');
|
|
29
|
+
* ```
|
|
18
30
|
*/
|
|
19
31
|
retrieve(id, options) {
|
|
20
32
|
return this._client.get(path `/proxies/${id}`, options);
|
|
21
33
|
}
|
|
34
|
+
/**
|
|
35
|
+
* Update a proxy's name. Proxy names are not unique and are not ID-or-name
|
|
36
|
+
* addressable on this endpoint; duplicate names are allowed. Name-based
|
|
37
|
+
* session-create lookups can remain ambiguous until callers resolve proxies by ID
|
|
38
|
+
* or the API adds a stronger uniqueness contract.
|
|
39
|
+
*
|
|
40
|
+
* @example
|
|
41
|
+
* ```ts
|
|
42
|
+
* const proxy = await client.proxies.update('id', {
|
|
43
|
+
* name: 'my-renamed-proxy',
|
|
44
|
+
* });
|
|
45
|
+
* ```
|
|
46
|
+
*/
|
|
47
|
+
update(id, body, options) {
|
|
48
|
+
return this._client.patch(path `/proxies/${id}`, { body, ...options });
|
|
49
|
+
}
|
|
22
50
|
/**
|
|
23
51
|
* List proxies in the resolved project.
|
|
52
|
+
*
|
|
53
|
+
* @example
|
|
54
|
+
* ```ts
|
|
55
|
+
* // Automatically fetches more pages as needed.
|
|
56
|
+
* for await (const proxyListResponse of client.proxies.list()) {
|
|
57
|
+
* // ...
|
|
58
|
+
* }
|
|
59
|
+
* ```
|
|
24
60
|
*/
|
|
25
61
|
list(query = {}, options) {
|
|
26
62
|
return this._client.getAPIList('/proxies', (OffsetPagination), { query, ...options });
|
|
27
63
|
}
|
|
28
64
|
/**
|
|
29
65
|
* Soft delete a proxy. Sessions referencing it are not modified.
|
|
66
|
+
*
|
|
67
|
+
* @example
|
|
68
|
+
* ```ts
|
|
69
|
+
* await client.proxies.delete('id');
|
|
70
|
+
* ```
|
|
30
71
|
*/
|
|
31
72
|
delete(id, options) {
|
|
32
73
|
return this._client.delete(path `/proxies/${id}`, {
|
|
@@ -41,6 +82,11 @@ export class Proxies extends APIResource {
|
|
|
41
82
|
* exit IP. For residential and mobile proxies, the exit node varies between
|
|
42
83
|
* requests, so this validates proxy configuration and connectivity rather than
|
|
43
84
|
* guaranteeing site-specific reachability.
|
|
85
|
+
*
|
|
86
|
+
* @example
|
|
87
|
+
* ```ts
|
|
88
|
+
* const response = await client.proxies.check('id');
|
|
89
|
+
* ```
|
|
44
90
|
*/
|
|
45
91
|
check(id, body = {}, options) {
|
|
46
92
|
return this._client.post(path `/proxies/${id}/check`, { body, ...options });
|
|
@@ -1 +1 @@
|
|
|
1
|
-
{"version":3,"file":"proxies.mjs","sourceRoot":"","sources":["../src/resources/proxies.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,gBAAgB,EAA4C,+BAA2B;AAChG,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC
|
|
1
|
+
{"version":3,"file":"proxies.mjs","sourceRoot":"","sources":["../src/resources/proxies.ts"],"names":[],"mappings":"AAAA,sFAAsF;AAEtF,OAAO,EAAE,WAAW,EAAE,6BAAyB;AAE/C,OAAO,EAAE,gBAAgB,EAA4C,+BAA2B;AAChG,OAAO,EAAE,YAAY,EAAE,gCAA4B;AAEnD,OAAO,EAAE,IAAI,EAAE,mCAA+B;AAE9C;;GAEG;AACH,MAAM,OAAO,OAAQ,SAAQ,WAAW;IACtC;;;;;;;;;OASG;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;;;;;;;OAOG;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;;;;;;;;;;;;OAYG;IACH,MAAM,CAAC,EAAU,EAAE,IAAuB,EAAE,OAAwB;QAClE,OAAO,IAAI,CAAC,OAAO,CAAC,KAAK,CAAC,IAAI,CAAA,YAAY,EAAE,EAAE,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACxE,CAAC;IAED;;;;;;;;;;OAUG;IACH,IAAI,CACF,QAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,UAAU,CAAC,UAAU,EAAE,CAAA,gBAAmC,CAAA,EAAE,EAAE,KAAK,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IACzG,CAAC;IAED;;;;;;;OAOG;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;IAED;;;;;;;;;;;;OAYG;IACH,KAAK,CACH,EAAU,EACV,OAA4C,EAAE,EAC9C,OAAwB;QAExB,OAAO,IAAI,CAAC,OAAO,CAAC,IAAI,CAAC,IAAI,CAAA,YAAY,EAAE,QAAQ,EAAE,EAAE,IAAI,EAAE,GAAG,OAAO,EAAE,CAAC,CAAC;IAC7E,CAAC;CACF"}
|
package/src/client.ts
CHANGED
|
@@ -123,7 +123,7 @@ import {
|
|
|
123
123
|
InvocationUpdateResponse,
|
|
124
124
|
Invocations,
|
|
125
125
|
} from './resources/invocations';
|
|
126
|
-
import { ProfileCreateParams, ProfileListParams, Profiles } from './resources/profiles';
|
|
126
|
+
import { ProfileCreateParams, ProfileListParams, ProfileUpdateParams, Profiles } from './resources/profiles';
|
|
127
127
|
import {
|
|
128
128
|
Proxies,
|
|
129
129
|
ProxyCheckParams,
|
|
@@ -134,6 +134,8 @@ import {
|
|
|
134
134
|
ProxyListResponse,
|
|
135
135
|
ProxyListResponsesOffsetPagination,
|
|
136
136
|
ProxyRetrieveResponse,
|
|
137
|
+
ProxyUpdateParams,
|
|
138
|
+
ProxyUpdateResponse,
|
|
137
139
|
} from './resources/proxies';
|
|
138
140
|
import { Auth } from './resources/auth/auth';
|
|
139
141
|
import {
|
|
@@ -1122,6 +1124,7 @@ export declare namespace Kernel {
|
|
|
1122
1124
|
export {
|
|
1123
1125
|
Profiles as Profiles,
|
|
1124
1126
|
type ProfileCreateParams as ProfileCreateParams,
|
|
1127
|
+
type ProfileUpdateParams as ProfileUpdateParams,
|
|
1125
1128
|
type ProfileListParams as ProfileListParams,
|
|
1126
1129
|
};
|
|
1127
1130
|
|
|
@@ -1131,10 +1134,12 @@ export declare namespace Kernel {
|
|
|
1131
1134
|
Proxies as Proxies,
|
|
1132
1135
|
type ProxyCreateResponse as ProxyCreateResponse,
|
|
1133
1136
|
type ProxyRetrieveResponse as ProxyRetrieveResponse,
|
|
1137
|
+
type ProxyUpdateResponse as ProxyUpdateResponse,
|
|
1134
1138
|
type ProxyListResponse as ProxyListResponse,
|
|
1135
1139
|
type ProxyCheckResponse as ProxyCheckResponse,
|
|
1136
1140
|
type ProxyListResponsesOffsetPagination as ProxyListResponsesOffsetPagination,
|
|
1137
1141
|
type ProxyCreateParams as ProxyCreateParams,
|
|
1142
|
+
type ProxyUpdateParams as ProxyUpdateParams,
|
|
1138
1143
|
type ProxyListParams as ProxyListParams,
|
|
1139
1144
|
type ProxyCheckParams as ProxyCheckParams,
|
|
1140
1145
|
};
|
|
@@ -141,7 +141,8 @@ export interface APIKey {
|
|
|
141
141
|
masked_key: string;
|
|
142
142
|
|
|
143
143
|
/**
|
|
144
|
-
* API key name
|
|
144
|
+
* Label for the API key. API keys are not addressable by name; use the ID or key
|
|
145
|
+
* identifier for stable references.
|
|
145
146
|
*/
|
|
146
147
|
name: string;
|
|
147
148
|
|
|
@@ -188,7 +189,7 @@ export interface CreatedAPIKey extends APIKey {
|
|
|
188
189
|
|
|
189
190
|
export interface APIKeyCreateParams {
|
|
190
191
|
/**
|
|
191
|
-
* API key
|
|
192
|
+
* Label for the API key (1-255 characters). API keys are not addressable by name.
|
|
192
193
|
*/
|
|
193
194
|
name: string;
|
|
194
195
|
|
|
@@ -225,6 +226,14 @@ export interface APIKeyListParams extends OffsetPaginationParams {
|
|
|
225
226
|
*/
|
|
226
227
|
include_deleted?: boolean;
|
|
227
228
|
|
|
229
|
+
/**
|
|
230
|
+
* Exact-match filter on API key name using the database collation. In production,
|
|
231
|
+
* matching is case- and accent-insensitive. Names are not required to be unique,
|
|
232
|
+
* so multiple keys may match. When status=all or include_deleted=true is set,
|
|
233
|
+
* soft-deleted keys with the same name may also match.
|
|
234
|
+
*/
|
|
235
|
+
name?: string;
|
|
236
|
+
|
|
228
237
|
/**
|
|
229
238
|
* Case-insensitive substring match against API key name, creator, and project. API
|
|
230
239
|
* key identifiers and masked keys match by exact value or prefix.
|
|
@@ -119,7 +119,7 @@ export interface AuditLogListParams extends PageTokenPaginationParams {
|
|
|
119
119
|
/**
|
|
120
120
|
* Filter out results by HTTP method.
|
|
121
121
|
*/
|
|
122
|
-
exclude_method?: string
|
|
122
|
+
exclude_method?: Array<string>;
|
|
123
123
|
|
|
124
124
|
/**
|
|
125
125
|
* Filter by HTTP method.
|
|
@@ -166,7 +166,7 @@ export interface AuditLogExportChunkParams {
|
|
|
166
166
|
/**
|
|
167
167
|
* Filter out results by HTTP method.
|
|
168
168
|
*/
|
|
169
|
-
exclude_method?: string
|
|
169
|
+
exclude_method?: Array<string>;
|
|
170
170
|
|
|
171
171
|
/**
|
|
172
172
|
* Encoding for the returned chunk.
|
|
@@ -729,7 +729,9 @@ export interface ManagedAuthCreateRequest {
|
|
|
729
729
|
|
|
730
730
|
/**
|
|
731
731
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
732
|
-
* project as the resource referencing it.
|
|
732
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
733
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
734
|
+
* id for stable references.
|
|
733
735
|
*/
|
|
734
736
|
proxy?: ManagedAuthCreateRequest.Proxy;
|
|
735
737
|
|
|
@@ -778,7 +780,9 @@ export namespace ManagedAuthCreateRequest {
|
|
|
778
780
|
|
|
779
781
|
/**
|
|
780
782
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
781
|
-
* project as the resource referencing it.
|
|
783
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
784
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
785
|
+
* id for stable references.
|
|
782
786
|
*/
|
|
783
787
|
export interface Proxy {
|
|
784
788
|
/**
|
|
@@ -917,7 +921,9 @@ export interface ManagedAuthUpdateRequest {
|
|
|
917
921
|
|
|
918
922
|
/**
|
|
919
923
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
920
|
-
* project as the resource referencing it.
|
|
924
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
925
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
926
|
+
* id for stable references.
|
|
921
927
|
*/
|
|
922
928
|
proxy?: ManagedAuthUpdateRequest.Proxy;
|
|
923
929
|
|
|
@@ -964,7 +970,9 @@ export namespace ManagedAuthUpdateRequest {
|
|
|
964
970
|
|
|
965
971
|
/**
|
|
966
972
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
967
|
-
* project as the resource referencing it.
|
|
973
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
974
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
975
|
+
* id for stable references.
|
|
968
976
|
*/
|
|
969
977
|
export interface Proxy {
|
|
970
978
|
/**
|
|
@@ -1320,7 +1328,9 @@ export interface ConnectionCreateParams {
|
|
|
1320
1328
|
|
|
1321
1329
|
/**
|
|
1322
1330
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
1323
|
-
* project as the resource referencing it.
|
|
1331
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
1332
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1333
|
+
* id for stable references.
|
|
1324
1334
|
*/
|
|
1325
1335
|
proxy?: ConnectionCreateParams.Proxy;
|
|
1326
1336
|
|
|
@@ -1369,7 +1379,9 @@ export namespace ConnectionCreateParams {
|
|
|
1369
1379
|
|
|
1370
1380
|
/**
|
|
1371
1381
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
1372
|
-
* project as the resource referencing it.
|
|
1382
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
1383
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1384
|
+
* id for stable references.
|
|
1373
1385
|
*/
|
|
1374
1386
|
export interface Proxy {
|
|
1375
1387
|
/**
|
|
@@ -1430,7 +1442,9 @@ export interface ConnectionUpdateParams {
|
|
|
1430
1442
|
|
|
1431
1443
|
/**
|
|
1432
1444
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
1433
|
-
* project as the resource referencing it.
|
|
1445
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
1446
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1447
|
+
* id for stable references.
|
|
1434
1448
|
*/
|
|
1435
1449
|
proxy?: ConnectionUpdateParams.Proxy;
|
|
1436
1450
|
|
|
@@ -1477,7 +1491,9 @@ export namespace ConnectionUpdateParams {
|
|
|
1477
1491
|
|
|
1478
1492
|
/**
|
|
1479
1493
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
1480
|
-
* project as the resource referencing it.
|
|
1494
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
1495
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1496
|
+
* id for stable references.
|
|
1481
1497
|
*/
|
|
1482
1498
|
export interface Proxy {
|
|
1483
1499
|
/**
|
|
@@ -1512,7 +1528,9 @@ export interface ConnectionListParams extends OffsetPaginationParams {
|
|
|
1512
1528
|
export interface ConnectionLoginParams {
|
|
1513
1529
|
/**
|
|
1514
1530
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
1515
|
-
* project as the resource referencing it.
|
|
1531
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
1532
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1533
|
+
* id for stable references.
|
|
1516
1534
|
*/
|
|
1517
1535
|
proxy?: ConnectionLoginParams.Proxy;
|
|
1518
1536
|
|
|
@@ -1526,7 +1544,9 @@ export interface ConnectionLoginParams {
|
|
|
1526
1544
|
export namespace ConnectionLoginParams {
|
|
1527
1545
|
/**
|
|
1528
1546
|
* Proxy selection. Provide either id or name. The proxy must be in the same
|
|
1529
|
-
* project as the resource referencing it.
|
|
1547
|
+
* project as the resource referencing it. When selecting by name, the name must
|
|
1548
|
+
* match exactly one active proxy in the project. Ambiguous names return a 400; use
|
|
1549
|
+
* id for stable references.
|
|
1530
1550
|
*/
|
|
1531
1551
|
export interface Proxy {
|
|
1532
1552
|
/**
|
|
@@ -216,7 +216,7 @@ export namespace BrowserPool {
|
|
|
216
216
|
*/
|
|
217
217
|
export interface BrowserPoolConfig {
|
|
218
218
|
/**
|
|
219
|
-
* Number of browsers
|
|
219
|
+
* Number of browsers maintained in the pool. The maximum size is determined by
|
|
220
220
|
* your organization's pooled sessions limit (the sum of all pool sizes cannot
|
|
221
221
|
* exceed your limit).
|
|
222
222
|
*/
|
|
@@ -226,7 +226,8 @@ export namespace BrowserPool {
|
|
|
226
226
|
* Custom Chrome enterprise policy overrides applied to all browsers in this pool.
|
|
227
227
|
* Keys are Chrome enterprise policy names; values must match their expected types.
|
|
228
228
|
* Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See
|
|
229
|
-
* https://chromeenterprise.google/policies/
|
|
229
|
+
* https://chromeenterprise.google/policies/ The serialized JSON payload is capped
|
|
230
|
+
* at 5 MiB.
|
|
230
231
|
*/
|
|
231
232
|
chrome_policy?: { [key: string]: unknown };
|
|
232
233
|
|
|
@@ -236,14 +237,13 @@ export namespace BrowserPool {
|
|
|
236
237
|
extensions?: Array<Shared.BrowserExtension>;
|
|
237
238
|
|
|
238
239
|
/**
|
|
239
|
-
* Percentage of the pool to fill per minute.
|
|
240
|
-
*
|
|
241
|
-
* is enforced here.
|
|
240
|
+
* Percentage of the pool to fill per minute. The cap is 25 for most organizations
|
|
241
|
+
* but can be raised per-organization, so only the lower bound is enforced here.
|
|
242
242
|
*/
|
|
243
243
|
fill_rate_per_minute?: number;
|
|
244
244
|
|
|
245
245
|
/**
|
|
246
|
-
* If true, launches the browser using a headless image.
|
|
246
|
+
* If true, launches the browser using a headless image.
|
|
247
247
|
*/
|
|
248
248
|
headless?: boolean;
|
|
249
249
|
|
|
@@ -268,15 +268,15 @@ export namespace BrowserPool {
|
|
|
268
268
|
profile?: BrowserPoolConfig.Profile;
|
|
269
269
|
|
|
270
270
|
/**
|
|
271
|
-
* Optional proxy
|
|
272
|
-
*
|
|
271
|
+
* Optional proxy associated to the browser session. References a proxy in the same
|
|
272
|
+
* project as the browser session.
|
|
273
273
|
*/
|
|
274
274
|
proxy_id?: string;
|
|
275
275
|
|
|
276
276
|
/**
|
|
277
277
|
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
278
|
-
* pool browsers pick up the latest profile data.
|
|
279
|
-
* the pool.
|
|
278
|
+
* pool browsers pick up the latest profile data. When a profile is provided during
|
|
279
|
+
* creation, this defaults to true. Requires a profile to be set on the pool.
|
|
280
280
|
*/
|
|
281
281
|
refresh_on_profile_update?: boolean;
|
|
282
282
|
|
|
@@ -297,7 +297,7 @@ export namespace BrowserPool {
|
|
|
297
297
|
|
|
298
298
|
/**
|
|
299
299
|
* Default idle timeout in seconds for browsers acquired from this pool before they
|
|
300
|
-
* are destroyed.
|
|
300
|
+
* are destroyed. Minimum 10, maximum 259200 (72 hours).
|
|
301
301
|
*/
|
|
302
302
|
timeout_seconds?: number;
|
|
303
303
|
|
|
@@ -485,7 +485,8 @@ export interface BrowserPoolCreateParams {
|
|
|
485
485
|
* Custom Chrome enterprise policy overrides applied to all browsers in this pool.
|
|
486
486
|
* Keys are Chrome enterprise policy names; values must match their expected types.
|
|
487
487
|
* Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See
|
|
488
|
-
* https://chromeenterprise.google/policies/
|
|
488
|
+
* https://chromeenterprise.google/policies/ The serialized JSON payload is capped
|
|
489
|
+
* at 5 MiB.
|
|
489
490
|
*/
|
|
490
491
|
chrome_policy?: { [key: string]: unknown };
|
|
491
492
|
|
|
@@ -508,7 +509,7 @@ export interface BrowserPoolCreateParams {
|
|
|
508
509
|
|
|
509
510
|
/**
|
|
510
511
|
* If true, launches the browser in kiosk mode to hide address bar and tabs in live
|
|
511
|
-
* view.
|
|
512
|
+
* view. Defaults to false.
|
|
512
513
|
*/
|
|
513
514
|
kiosk_mode?: boolean;
|
|
514
515
|
|
|
@@ -534,8 +535,8 @@ export interface BrowserPoolCreateParams {
|
|
|
534
535
|
|
|
535
536
|
/**
|
|
536
537
|
* When true, flush idle browsers when the profile the pool uses is updated, so
|
|
537
|
-
* pool browsers pick up the latest profile data.
|
|
538
|
-
* the pool.
|
|
538
|
+
* pool browsers pick up the latest profile data. When a profile is provided during
|
|
539
|
+
* creation, this defaults to true. Requires a profile to be set on the pool.
|
|
539
540
|
*/
|
|
540
541
|
refresh_on_profile_update?: boolean;
|
|
541
542
|
|
|
@@ -550,7 +551,7 @@ export interface BrowserPoolCreateParams {
|
|
|
550
551
|
|
|
551
552
|
/**
|
|
552
553
|
* If true, launches the browser in stealth mode to reduce detection by anti-bot
|
|
553
|
-
* mechanisms.
|
|
554
|
+
* mechanisms. Defaults to false.
|
|
554
555
|
*/
|
|
555
556
|
stealth?: boolean;
|
|
556
557
|
|
|
@@ -601,10 +602,12 @@ export namespace BrowserPoolCreateParams {
|
|
|
601
602
|
|
|
602
603
|
export interface BrowserPoolUpdateParams {
|
|
603
604
|
/**
|
|
604
|
-
*
|
|
605
|
-
*
|
|
605
|
+
* If provided, replaces the custom Chrome enterprise policy overrides applied to
|
|
606
|
+
* all browsers in this pool. Empty object clears any previously-set policy. Keys
|
|
607
|
+
* are Chrome enterprise policy names; values must match their expected types.
|
|
606
608
|
* Blocked: kernel-managed policies (extensions, proxy, CDP/automation). See
|
|
607
|
-
* https://chromeenterprise.google/policies/
|
|
609
|
+
* https://chromeenterprise.google/policies/ The serialized JSON payload is capped
|
|
610
|
+
* at 5 MiB.
|
|
608
611
|
*/
|
|
609
612
|
chrome_policy?: { [key: string]: unknown };
|
|
610
613
|
|
|
@@ -619,30 +622,31 @@ export interface BrowserPoolUpdateParams {
|
|
|
619
622
|
discard_all_idle?: boolean;
|
|
620
623
|
|
|
621
624
|
/**
|
|
622
|
-
*
|
|
625
|
+
* If provided, replaces the extension list. Empty array clears all
|
|
626
|
+
* previously-selected extensions. Omit this field to leave extensions unchanged.
|
|
623
627
|
*/
|
|
624
628
|
extensions?: Array<Shared.BrowserExtension>;
|
|
625
629
|
|
|
626
630
|
/**
|
|
627
|
-
*
|
|
628
|
-
* most organizations but can be raised per-organization, so only the lower
|
|
629
|
-
* is enforced here.
|
|
631
|
+
* If provided, replaces the percentage of the pool to fill per minute. The cap is
|
|
632
|
+
* 25 for most organizations but can be raised per-organization, so only the lower
|
|
633
|
+
* bound is enforced here.
|
|
630
634
|
*/
|
|
631
635
|
fill_rate_per_minute?: number;
|
|
632
636
|
|
|
633
637
|
/**
|
|
634
|
-
* If
|
|
638
|
+
* If provided, replaces whether browsers launch using a headless image.
|
|
635
639
|
*/
|
|
636
640
|
headless?: boolean;
|
|
637
641
|
|
|
638
642
|
/**
|
|
639
|
-
* If
|
|
640
|
-
* view.
|
|
643
|
+
* If provided, replaces whether browsers launch in kiosk mode.
|
|
641
644
|
*/
|
|
642
645
|
kiosk_mode?: boolean;
|
|
643
646
|
|
|
644
647
|
/**
|
|
645
|
-
*
|
|
648
|
+
* If provided, replaces the pool name. Empty string is a no-op; the pool name
|
|
649
|
+
* cannot be cleared or reset to empty once assigned.
|
|
646
650
|
*/
|
|
647
651
|
name?: string;
|
|
648
652
|
|
|
@@ -656,43 +660,42 @@ export interface BrowserPoolUpdateParams {
|
|
|
656
660
|
profile?: BrowserPoolUpdateParams.Profile;
|
|
657
661
|
|
|
658
662
|
/**
|
|
659
|
-
*
|
|
660
|
-
*
|
|
663
|
+
* Empty string clears the previously-selected proxy. Omit this field to leave the
|
|
664
|
+
* proxy unchanged.
|
|
661
665
|
*/
|
|
662
666
|
proxy_id?: string;
|
|
663
667
|
|
|
664
668
|
/**
|
|
665
|
-
*
|
|
666
|
-
* pool
|
|
667
|
-
*
|
|
669
|
+
* If provided, replaces whether idle browsers are flushed when the profile the
|
|
670
|
+
* pool uses is updated. When the pool's profile reference is changed (including
|
|
671
|
+
* newly attached) and this field is omitted, it defaults to true. Re-sending the
|
|
672
|
+
* same profile reference leaves this setting unchanged. Clearing the profile also
|
|
673
|
+
* disables this setting. Requires a profile to be set on the pool.
|
|
668
674
|
*/
|
|
669
675
|
refresh_on_profile_update?: boolean;
|
|
670
676
|
|
|
671
677
|
/**
|
|
672
|
-
*
|
|
673
|
-
* your organization's pooled sessions limit (the sum
|
|
674
|
-
* exceed your limit).
|
|
678
|
+
* If provided, replaces the number of browsers to maintain in the pool. The
|
|
679
|
+
* maximum size is determined by your organization's pooled sessions limit (the sum
|
|
680
|
+
* of all pool sizes cannot exceed your limit).
|
|
675
681
|
*/
|
|
676
682
|
size?: number;
|
|
677
683
|
|
|
678
684
|
/**
|
|
679
|
-
*
|
|
680
|
-
*
|
|
681
|
-
*
|
|
682
|
-
* previous lease left them on. Accepts any URL Chromium can resolve, including
|
|
683
|
-
* chrome:// pages.
|
|
685
|
+
* If provided, replaces the URL to navigate to when a new browser is warmed into
|
|
686
|
+
* the pool. Empty string clears the previously-set URL. Omit this field to leave
|
|
687
|
+
* it unchanged.
|
|
684
688
|
*/
|
|
685
689
|
start_url?: string;
|
|
686
690
|
|
|
687
691
|
/**
|
|
688
|
-
* If
|
|
689
|
-
* mechanisms.
|
|
692
|
+
* If provided, replaces whether browsers launch in stealth mode.
|
|
690
693
|
*/
|
|
691
694
|
stealth?: boolean;
|
|
692
695
|
|
|
693
696
|
/**
|
|
694
|
-
*
|
|
695
|
-
*
|
|
697
|
+
* If provided, replaces the default idle timeout in seconds for browsers acquired
|
|
698
|
+
* from this pool before they are destroyed. Minimum 10, maximum 259200 (72 hours).
|
|
696
699
|
*/
|
|
697
700
|
timeout_seconds?: number;
|
|
698
701
|
|
|
@@ -737,7 +740,16 @@ export namespace BrowserPoolUpdateParams {
|
|
|
737
740
|
|
|
738
741
|
export interface BrowserPoolListParams extends OffsetPaginationParams {
|
|
739
742
|
/**
|
|
740
|
-
*
|
|
743
|
+
* Exact-match filter on browser pool name using the database collation. In
|
|
744
|
+
* production, matching is case- and accent-insensitive. During the default-project
|
|
745
|
+
* migration, unscoped requests prefer a concrete default-project browser pool over
|
|
746
|
+
* a legacy unscoped browser pool with the same name.
|
|
747
|
+
*/
|
|
748
|
+
name?: string;
|
|
749
|
+
|
|
750
|
+
/**
|
|
751
|
+
* Case-insensitive substring match against browser pool name. IDs match by exact
|
|
752
|
+
* value.
|
|
741
753
|
*/
|
|
742
754
|
query?: string;
|
|
743
755
|
}
|
|
@@ -1014,18 +1014,27 @@ export namespace BrowserCreateParams {
|
|
|
1014
1014
|
*/
|
|
1015
1015
|
export interface Telemetry {
|
|
1016
1016
|
/**
|
|
1017
|
-
* Per-category capture flags.
|
|
1018
|
-
*
|
|
1019
|
-
*
|
|
1020
|
-
*
|
|
1017
|
+
* Per-category capture flags. The operational categories (control, connection,
|
|
1018
|
+
* system, captcha) are captured whenever telemetry is enabled; set one to
|
|
1019
|
+
* enabled=false to opt out. The CDP categories (console, network, page,
|
|
1020
|
+
* interaction) and screenshot are off by default; set enabled=true to opt in. On
|
|
1021
|
+
* create, provided categories layer onto the default set. On update, provided
|
|
1022
|
+
* categories merge onto the session's current config; when no telemetry is active
|
|
1023
|
+
* this falls back to the default set (matching create). If browser is omitted or
|
|
1024
|
+
* empty, the default set is used. A browser config that disables every category
|
|
1025
|
+
* stops capture on update and starts no capture on create.
|
|
1021
1026
|
*/
|
|
1022
1027
|
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
|
|
1023
1028
|
|
|
1024
1029
|
/**
|
|
1025
|
-
* Request shortcut for browser telemetry capture. True enables capture
|
|
1026
|
-
*
|
|
1027
|
-
*
|
|
1028
|
-
*
|
|
1030
|
+
* Request shortcut for browser telemetry capture. True enables capture; with no
|
|
1031
|
+
* browser category settings it captures the default set (control, connection,
|
|
1032
|
+
* system, captcha), and any browser category settings are layered onto that
|
|
1033
|
+
* default set. On update, enabled=true resolves the config fresh from the default
|
|
1034
|
+
* set plus any provided categories, replacing the session's current selection
|
|
1035
|
+
* rather than merging onto it; omit enabled to merge categories onto the current
|
|
1036
|
+
* selection instead. False stops capture on update and starts no capture on
|
|
1037
|
+
* create. enabled=false cannot be combined with browser category settings.
|
|
1029
1038
|
*/
|
|
1030
1039
|
enabled?: boolean;
|
|
1031
1040
|
}
|
|
@@ -1096,18 +1105,27 @@ export namespace BrowserUpdateParams {
|
|
|
1096
1105
|
*/
|
|
1097
1106
|
export interface Telemetry {
|
|
1098
1107
|
/**
|
|
1099
|
-
* Per-category capture flags.
|
|
1100
|
-
*
|
|
1101
|
-
*
|
|
1102
|
-
*
|
|
1108
|
+
* Per-category capture flags. The operational categories (control, connection,
|
|
1109
|
+
* system, captcha) are captured whenever telemetry is enabled; set one to
|
|
1110
|
+
* enabled=false to opt out. The CDP categories (console, network, page,
|
|
1111
|
+
* interaction) and screenshot are off by default; set enabled=true to opt in. On
|
|
1112
|
+
* create, provided categories layer onto the default set. On update, provided
|
|
1113
|
+
* categories merge onto the session's current config; when no telemetry is active
|
|
1114
|
+
* this falls back to the default set (matching create). If browser is omitted or
|
|
1115
|
+
* empty, the default set is used. A browser config that disables every category
|
|
1116
|
+
* stops capture on update and starts no capture on create.
|
|
1103
1117
|
*/
|
|
1104
1118
|
browser?: TelemetryAPI.BrowserTelemetryCategoriesConfig;
|
|
1105
1119
|
|
|
1106
1120
|
/**
|
|
1107
|
-
* Request shortcut for browser telemetry capture. True enables capture
|
|
1108
|
-
*
|
|
1109
|
-
*
|
|
1110
|
-
*
|
|
1121
|
+
* Request shortcut for browser telemetry capture. True enables capture; with no
|
|
1122
|
+
* browser category settings it captures the default set (control, connection,
|
|
1123
|
+
* system, captcha), and any browser category settings are layered onto that
|
|
1124
|
+
* default set. On update, enabled=true resolves the config fresh from the default
|
|
1125
|
+
* set plus any provided categories, replacing the session's current selection
|
|
1126
|
+
* rather than merging onto it; omit enabled to merge categories onto the current
|
|
1127
|
+
* selection instead. False stops capture on update and starts no capture on
|
|
1128
|
+
* create. enabled=false cannot be combined with browser category settings.
|
|
1111
1129
|
*/
|
|
1112
1130
|
enabled?: boolean;
|
|
1113
1131
|
}
|
|
@@ -371,7 +371,10 @@ export namespace BrowserConsoleErrorEvent {
|
|
|
371
371
|
*/
|
|
372
372
|
export interface Data extends TelemetryAPI.BrowserEventContext {
|
|
373
373
|
/**
|
|
374
|
-
*
|
|
374
|
+
* Human-readable error text, as the browser console would display it. For
|
|
375
|
+
* console.error() calls, the first argument coerced to a string. For uncaught
|
|
376
|
+
* exceptions, the prefix and error message, e.g. "Uncaught Error: boom" or
|
|
377
|
+
* "Uncaught (in promise) TypeError: x is not a function".
|
|
375
378
|
*/
|
|
376
379
|
text: string;
|
|
377
380
|
|
|
@@ -1879,12 +1882,11 @@ export namespace BrowserSystemOomKillEvent {
|
|
|
1879
1882
|
}
|
|
1880
1883
|
|
|
1881
1884
|
/**
|
|
1882
|
-
* Per-category telemetry capture settings
|
|
1883
|
-
*
|
|
1884
|
-
* enabled=
|
|
1885
|
-
*
|
|
1886
|
-
*
|
|
1887
|
-
* into.
|
|
1885
|
+
* Per-category telemetry capture settings layered onto the default set. The
|
|
1886
|
+
* operational signals (control, connection, system, captcha) are on by default and
|
|
1887
|
+
* are opt-out: set one to enabled=false to stop capturing it. The CDP categories
|
|
1888
|
+
* (console, network, page, interaction) and screenshot are off by default and are
|
|
1889
|
+
* opt-in: set enabled=true to capture them.
|
|
1888
1890
|
*/
|
|
1889
1891
|
export interface BrowserTelemetryCategoriesConfig {
|
|
1890
1892
|
/**
|
|
@@ -1948,8 +1950,9 @@ export interface BrowserTelemetryCategoriesConfig {
|
|
|
1948
1950
|
*/
|
|
1949
1951
|
export interface BrowserTelemetryCategoryConfig {
|
|
1950
1952
|
/**
|
|
1951
|
-
* Whether this category is captured.
|
|
1952
|
-
*
|
|
1953
|
+
* Whether this category is captured. Operational categories (control, connection,
|
|
1954
|
+
* system, captcha) default to true; set false to opt out. CDP categories (console,
|
|
1955
|
+
* network, page, interaction) and screenshot default to false; set true to opt in.
|
|
1953
1956
|
*/
|
|
1954
1957
|
enabled?: boolean;
|
|
1955
1958
|
}
|
|
@@ -346,7 +346,8 @@ export interface CredentialProviderUpdateParams {
|
|
|
346
346
|
|
|
347
347
|
export interface CredentialProviderListParams extends OffsetPaginationParams {
|
|
348
348
|
/**
|
|
349
|
-
*
|
|
349
|
+
* Case-insensitive substring match against credential provider name. IDs match by
|
|
350
|
+
* exact value.
|
|
350
351
|
*/
|
|
351
352
|
query?: string;
|
|
352
353
|
}
|