alchemy 0.84.0 → 0.85.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/bin/alchemy.js +1 -1
- package/lib/cloudflare/api-error.d.ts +11 -0
- package/lib/cloudflare/api-error.d.ts.map +1 -1
- package/lib/cloudflare/api-error.js +11 -0
- package/lib/cloudflare/api-error.js.map +1 -1
- package/lib/cloudflare/api.js +1 -1
- package/lib/cloudflare/api.js.map +1 -1
- package/lib/cloudflare/bindings.d.ts +12 -2
- package/lib/cloudflare/bindings.d.ts.map +1 -1
- package/lib/cloudflare/bindings.js.map +1 -1
- package/lib/cloudflare/bound.d.ts +2 -1
- package/lib/cloudflare/bound.d.ts.map +1 -1
- package/lib/cloudflare/d1-database.d.ts.map +1 -1
- package/lib/cloudflare/d1-database.js +9 -1
- package/lib/cloudflare/d1-database.js.map +1 -1
- package/lib/cloudflare/index.d.ts +1 -0
- package/lib/cloudflare/index.d.ts.map +1 -1
- package/lib/cloudflare/index.js +1 -0
- package/lib/cloudflare/index.js.map +1 -1
- package/lib/cloudflare/miniflare/build-worker-options.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/build-worker-options.js +15 -0
- package/lib/cloudflare/miniflare/build-worker-options.js.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-controller.d.ts +1 -1
- package/lib/cloudflare/miniflare/miniflare-controller.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.d.ts.map +1 -1
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.js +41 -3
- package/lib/cloudflare/miniflare/miniflare-worker-proxy.js.map +1 -1
- package/lib/cloudflare/vpc-service.d.ts +288 -0
- package/lib/cloudflare/vpc-service.d.ts.map +1 -0
- package/lib/cloudflare/vpc-service.js +238 -0
- package/lib/cloudflare/vpc-service.js.map +1 -0
- package/lib/cloudflare/worker-metadata.d.ts +1 -0
- package/lib/cloudflare/worker-metadata.d.ts.map +1 -1
- package/lib/cloudflare/worker-metadata.js +8 -0
- package/lib/cloudflare/worker-metadata.js.map +1 -1
- package/lib/cloudflare/worker.d.ts +9 -0
- package/lib/cloudflare/worker.d.ts.map +1 -1
- package/lib/cloudflare/worker.js.map +1 -1
- package/lib/cloudflare/wrangler.json.d.ts.map +1 -1
- package/lib/cloudflare/wrangler.json.js +9 -0
- package/lib/cloudflare/wrangler.json.js.map +1 -1
- package/lib/planetscale/api/sdk.gen.d.ts +874 -190
- package/lib/planetscale/api/sdk.gen.d.ts.map +1 -1
- package/lib/planetscale/api/sdk.gen.js +1250 -306
- package/lib/planetscale/api/sdk.gen.js.map +1 -1
- package/lib/planetscale/api/types.gen.d.ts +8241 -4128
- package/lib/planetscale/api/types.gen.d.ts.map +1 -1
- package/lib/planetscale/branch.js +4 -4
- package/lib/planetscale/branch.js.map +1 -1
- package/lib/planetscale/database.d.ts +43 -24
- package/lib/planetscale/database.d.ts.map +1 -1
- package/lib/planetscale/database.js +39 -18
- package/lib/planetscale/database.js.map +1 -1
- package/lib/planetscale/default-role.d.ts +51 -0
- package/lib/planetscale/default-role.d.ts.map +1 -0
- package/lib/planetscale/default-role.js +100 -0
- package/lib/planetscale/default-role.js.map +1 -0
- package/lib/planetscale/index.d.ts +1 -0
- package/lib/planetscale/index.d.ts.map +1 -1
- package/lib/planetscale/index.js +1 -0
- package/lib/planetscale/index.js.map +1 -1
- package/lib/planetscale/organization.js +1 -1
- package/lib/planetscale/organization.js.map +1 -1
- package/lib/planetscale/role.d.ts +1 -1
- package/lib/planetscale/role.d.ts.map +1 -1
- package/lib/planetscale/role.js +1 -1
- package/lib/planetscale/role.js.map +1 -1
- package/lib/planetscale/utils.d.ts +1 -1
- package/lib/planetscale/utils.d.ts.map +1 -1
- package/lib/planetscale/utils.js +9 -10
- package/lib/planetscale/utils.js.map +1 -1
- package/lib/state/sqlite-state-store.js +2 -0
- package/lib/state/sqlite-state-store.js.map +1 -1
- package/package.json +2 -2
- package/src/cloudflare/api-error.ts +19 -0
- package/src/cloudflare/api.ts +1 -1
- package/src/cloudflare/bindings.ts +15 -2
- package/src/cloudflare/bound.ts +6 -3
- package/src/cloudflare/d1-database.ts +11 -4
- package/src/cloudflare/index.ts +1 -0
- package/src/cloudflare/miniflare/build-worker-options.ts +30 -18
- package/src/cloudflare/miniflare/miniflare-worker-proxy.ts +47 -2
- package/src/cloudflare/vpc-service.ts +466 -0
- package/src/cloudflare/worker-metadata.ts +8 -0
- package/src/cloudflare/worker.ts +9 -0
- package/src/cloudflare/wrangler.json.ts +8 -0
- package/src/planetscale/api/sdk.gen.ts +2331 -987
- package/src/planetscale/api/types.gen.ts +8980 -4574
- package/src/planetscale/branch.ts +4 -4
- package/src/planetscale/database.ts +87 -46
- package/src/planetscale/default-role.ts +162 -0
- package/src/planetscale/index.ts +1 -0
- package/src/planetscale/organization.ts +1 -1
- package/src/planetscale/role.ts +3 -2
- package/src/planetscale/utils.ts +10 -10
- package/src/state/sqlite-state-store.ts +2 -0
- package/workers/tunnel-proxy.js +1 -1
|
@@ -45,7 +45,7 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
45
45
|
*/
|
|
46
46
|
getOrganization(options) {
|
|
47
47
|
return (options.client ?? this._client).get({
|
|
48
|
-
url: "/organizations/{
|
|
48
|
+
url: "/organizations/{organization}",
|
|
49
49
|
...options,
|
|
50
50
|
});
|
|
51
51
|
}
|
|
@@ -63,7 +63,7 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
63
63
|
*/
|
|
64
64
|
updateOrganization(options) {
|
|
65
65
|
return (options.client ?? this._client).patch({
|
|
66
|
-
url: "/organizations/{
|
|
66
|
+
url: "/organizations/{organization}",
|
|
67
67
|
...options,
|
|
68
68
|
headers: {
|
|
69
69
|
"Content-Type": "application/json",
|
|
@@ -84,13 +84,13 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
84
84
|
*/
|
|
85
85
|
listAuditLogs(options) {
|
|
86
86
|
return (options.client ?? this._client).get({
|
|
87
|
-
url: "/organizations/{
|
|
87
|
+
url: "/organizations/{organization}/audit-log",
|
|
88
88
|
...options,
|
|
89
89
|
});
|
|
90
90
|
}
|
|
91
91
|
/**
|
|
92
|
-
* List
|
|
93
|
-
*
|
|
92
|
+
* List available cluster sizes
|
|
93
|
+
* List available cluster sizes for an organization
|
|
94
94
|
* ### Authorization
|
|
95
95
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
96
96
|
*
|
|
@@ -104,9 +104,9 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
104
104
|
* | User | `read_organizations` |
|
|
105
105
|
* | Organization | `read_organization` |
|
|
106
106
|
*/
|
|
107
|
-
|
|
107
|
+
listClusterSizeSkus(options) {
|
|
108
108
|
return (options.client ?? this._client).get({
|
|
109
|
-
url: "/organizations/{
|
|
109
|
+
url: "/organizations/{organization}/cluster-size-skus",
|
|
110
110
|
...options,
|
|
111
111
|
});
|
|
112
112
|
}
|
|
@@ -117,7 +117,7 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
117
117
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
118
118
|
*
|
|
119
119
|
* **Service Token Accesses**
|
|
120
|
-
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `
|
|
120
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
121
121
|
*
|
|
122
122
|
* **OAuth Scopes**
|
|
123
123
|
*
|
|
@@ -156,6 +156,76 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
156
156
|
},
|
|
157
157
|
});
|
|
158
158
|
}
|
|
159
|
+
/**
|
|
160
|
+
* Delete a database
|
|
161
|
+
*
|
|
162
|
+
* ### Authorization
|
|
163
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
164
|
+
*
|
|
165
|
+
* **Service Token Accesses**
|
|
166
|
+
* `delete_database`
|
|
167
|
+
*
|
|
168
|
+
* **OAuth Scopes**
|
|
169
|
+
*
|
|
170
|
+
* | Resource | Scopes |
|
|
171
|
+
* | :------- | :---------- |
|
|
172
|
+
* | Organization | `delete_databases` |
|
|
173
|
+
* | Database | `delete_database` |
|
|
174
|
+
*/
|
|
175
|
+
deleteDatabase(options) {
|
|
176
|
+
return (options.client ?? this._client).delete({
|
|
177
|
+
url: "/organizations/{organization}/databases/{database}",
|
|
178
|
+
...options,
|
|
179
|
+
});
|
|
180
|
+
}
|
|
181
|
+
/**
|
|
182
|
+
* Get a database
|
|
183
|
+
*
|
|
184
|
+
* ### Authorization
|
|
185
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
186
|
+
*
|
|
187
|
+
* **Service Token Accesses**
|
|
188
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
189
|
+
*
|
|
190
|
+
* **OAuth Scopes**
|
|
191
|
+
*
|
|
192
|
+
* | Resource | Scopes |
|
|
193
|
+
* | :------- | :---------- |
|
|
194
|
+
* | Organization | `read_databases` |
|
|
195
|
+
* | Database | `read_database` |
|
|
196
|
+
*/
|
|
197
|
+
getDatabase(options) {
|
|
198
|
+
return (options.client ?? this._client).get({
|
|
199
|
+
url: "/organizations/{organization}/databases/{database}",
|
|
200
|
+
...options,
|
|
201
|
+
});
|
|
202
|
+
}
|
|
203
|
+
/**
|
|
204
|
+
* Update database settings
|
|
205
|
+
*
|
|
206
|
+
* ### Authorization
|
|
207
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
208
|
+
*
|
|
209
|
+
* **Service Token Accesses**
|
|
210
|
+
* `write_database`
|
|
211
|
+
*
|
|
212
|
+
* **OAuth Scopes**
|
|
213
|
+
*
|
|
214
|
+
* | Resource | Scopes |
|
|
215
|
+
* | :------- | :---------- |
|
|
216
|
+
* | Organization | `write_databases` |
|
|
217
|
+
* | Database | `write_database` |
|
|
218
|
+
*/
|
|
219
|
+
updateDatabaseSettings(options) {
|
|
220
|
+
return (options.client ?? this._client).patch({
|
|
221
|
+
url: "/organizations/{organization}/databases/{database}",
|
|
222
|
+
...options,
|
|
223
|
+
headers: {
|
|
224
|
+
"Content-Type": "application/json",
|
|
225
|
+
...options.headers,
|
|
226
|
+
},
|
|
227
|
+
});
|
|
228
|
+
}
|
|
159
229
|
/**
|
|
160
230
|
* List branches
|
|
161
231
|
*
|
|
@@ -206,6 +276,79 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
206
276
|
},
|
|
207
277
|
});
|
|
208
278
|
}
|
|
279
|
+
/**
|
|
280
|
+
* Delete a branch
|
|
281
|
+
*
|
|
282
|
+
* ### Authorization
|
|
283
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
284
|
+
*
|
|
285
|
+
* **Service Token Accesses**
|
|
286
|
+
* `delete_branch`
|
|
287
|
+
*
|
|
288
|
+
* **OAuth Scopes**
|
|
289
|
+
*
|
|
290
|
+
* | Resource | Scopes |
|
|
291
|
+
* | :------- | :---------- |
|
|
292
|
+
* | Organization | `delete_branches`, `delete_production_branches` |
|
|
293
|
+
* | Database | `delete_branches`, `delete_production_branches` |
|
|
294
|
+
* | Branch | `delete_branch` |
|
|
295
|
+
*/
|
|
296
|
+
deleteBranch(options) {
|
|
297
|
+
return (options.client ?? this._client).delete({
|
|
298
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}",
|
|
299
|
+
...options,
|
|
300
|
+
});
|
|
301
|
+
}
|
|
302
|
+
/**
|
|
303
|
+
* Get a branch
|
|
304
|
+
*
|
|
305
|
+
* ### Authorization
|
|
306
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
307
|
+
*
|
|
308
|
+
* **Service Token Accesses**
|
|
309
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
310
|
+
*
|
|
311
|
+
* **OAuth Scopes**
|
|
312
|
+
*
|
|
313
|
+
* | Resource | Scopes |
|
|
314
|
+
* | :------- | :---------- |
|
|
315
|
+
* | Organization | `read_branches` |
|
|
316
|
+
* | Database | `read_branches` |
|
|
317
|
+
* | Branch | `read_branch` |
|
|
318
|
+
*/
|
|
319
|
+
getBranch(options) {
|
|
320
|
+
return (options.client ?? this._client).get({
|
|
321
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}",
|
|
322
|
+
...options,
|
|
323
|
+
});
|
|
324
|
+
}
|
|
325
|
+
/**
|
|
326
|
+
* Update a branch
|
|
327
|
+
*
|
|
328
|
+
* ### Authorization
|
|
329
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
330
|
+
*
|
|
331
|
+
* **Service Token Accesses**
|
|
332
|
+
* `write_database`
|
|
333
|
+
*
|
|
334
|
+
* **OAuth Scopes**
|
|
335
|
+
*
|
|
336
|
+
* | Resource | Scopes |
|
|
337
|
+
* | :------- | :---------- |
|
|
338
|
+
* | Organization | `write_branches` |
|
|
339
|
+
* | Database | `write_branches` |
|
|
340
|
+
* | Branch | `write_branch` |
|
|
341
|
+
*/
|
|
342
|
+
updateBranch(options) {
|
|
343
|
+
return (options.client ?? this._client).patch({
|
|
344
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}",
|
|
345
|
+
...options,
|
|
346
|
+
headers: {
|
|
347
|
+
"Content-Type": "application/json",
|
|
348
|
+
...options.headers,
|
|
349
|
+
},
|
|
350
|
+
});
|
|
351
|
+
}
|
|
209
352
|
/**
|
|
210
353
|
* List backups
|
|
211
354
|
*
|
|
@@ -330,7 +473,7 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
330
473
|
});
|
|
331
474
|
}
|
|
332
475
|
/**
|
|
333
|
-
* Get
|
|
476
|
+
* Get bouncer resize requests
|
|
334
477
|
*
|
|
335
478
|
* ### Authorization
|
|
336
479
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
@@ -346,14 +489,37 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
346
489
|
* | Database | `read_branches` |
|
|
347
490
|
* | Branch | `read_branch` |
|
|
348
491
|
*/
|
|
349
|
-
|
|
492
|
+
listBranchBouncerResizeRequests(options) {
|
|
350
493
|
return (options.client ?? this._client).get({
|
|
351
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
494
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncer-resizes",
|
|
352
495
|
...options,
|
|
353
496
|
});
|
|
354
497
|
}
|
|
355
498
|
/**
|
|
356
|
-
*
|
|
499
|
+
* List bouncers
|
|
500
|
+
*
|
|
501
|
+
* ### Authorization
|
|
502
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
503
|
+
*
|
|
504
|
+
* **Service Token Accesses**
|
|
505
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
506
|
+
*
|
|
507
|
+
* **OAuth Scopes**
|
|
508
|
+
*
|
|
509
|
+
* | Resource | Scopes |
|
|
510
|
+
* | :------- | :---------- |
|
|
511
|
+
* | Organization | `read_branches` |
|
|
512
|
+
* | Database | `read_branches` |
|
|
513
|
+
* | Branch | `read_branch` |
|
|
514
|
+
*/
|
|
515
|
+
listBouncers(options) {
|
|
516
|
+
return (options.client ?? this._client).get({
|
|
517
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers",
|
|
518
|
+
...options,
|
|
519
|
+
});
|
|
520
|
+
}
|
|
521
|
+
/**
|
|
522
|
+
* Create a bouncer
|
|
357
523
|
*
|
|
358
524
|
* ### Authorization
|
|
359
525
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
@@ -368,9 +534,9 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
368
534
|
* | Organization | `write_databases` |
|
|
369
535
|
* | Database | `write_database` |
|
|
370
536
|
*/
|
|
371
|
-
|
|
372
|
-
return (options.client ?? this._client).
|
|
373
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
537
|
+
createBouncer(options) {
|
|
538
|
+
return (options.client ?? this._client).post({
|
|
539
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers",
|
|
374
540
|
...options,
|
|
375
541
|
headers: {
|
|
376
542
|
"Content-Type": "application/json",
|
|
@@ -379,85 +545,114 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
379
545
|
});
|
|
380
546
|
}
|
|
381
547
|
/**
|
|
382
|
-
*
|
|
548
|
+
* Delete a bouncer
|
|
383
549
|
*
|
|
384
550
|
* ### Authorization
|
|
385
551
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
386
552
|
*
|
|
387
553
|
* **Service Token Accesses**
|
|
388
|
-
* `
|
|
554
|
+
* `write_database`
|
|
389
555
|
*
|
|
390
556
|
* **OAuth Scopes**
|
|
391
557
|
*
|
|
392
558
|
* | Resource | Scopes |
|
|
393
559
|
* | :------- | :---------- |
|
|
394
|
-
* | Organization | `
|
|
395
|
-
* | Database | `
|
|
396
|
-
* | Branch | `read_branch` |
|
|
560
|
+
* | Organization | `write_databases` |
|
|
561
|
+
* | Database | `write_database` |
|
|
397
562
|
*/
|
|
398
|
-
|
|
399
|
-
return (options.client ?? this._client).
|
|
400
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
563
|
+
deleteBouncer(options) {
|
|
564
|
+
return (options.client ?? this._client).delete({
|
|
565
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}",
|
|
401
566
|
...options,
|
|
402
567
|
});
|
|
403
568
|
}
|
|
404
569
|
/**
|
|
405
|
-
* Get
|
|
570
|
+
* Get a bouncer
|
|
571
|
+
*
|
|
572
|
+
* ### Authorization
|
|
573
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
574
|
+
*
|
|
575
|
+
* **Service Token Accesses**
|
|
576
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
406
577
|
*
|
|
578
|
+
* **OAuth Scopes**
|
|
407
579
|
*
|
|
580
|
+
* | Resource | Scopes |
|
|
581
|
+
* | :------- | :---------- |
|
|
582
|
+
* | Organization | `read_branches` |
|
|
583
|
+
* | Database | `read_branches` |
|
|
584
|
+
* | Branch | `read_branch` |
|
|
408
585
|
*/
|
|
409
|
-
|
|
586
|
+
getBouncer(options) {
|
|
410
587
|
return (options.client ?? this._client).get({
|
|
411
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
588
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}",
|
|
412
589
|
...options,
|
|
413
590
|
});
|
|
414
591
|
}
|
|
415
592
|
/**
|
|
416
|
-
*
|
|
593
|
+
* Cancel a resize request
|
|
594
|
+
*
|
|
595
|
+
* ### Authorization
|
|
596
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
597
|
+
*
|
|
598
|
+
* **Service Token Accesses**
|
|
599
|
+
* `write_database`
|
|
417
600
|
*
|
|
601
|
+
* **OAuth Scopes**
|
|
418
602
|
*
|
|
603
|
+
* | Resource | Scopes |
|
|
604
|
+
* | :------- | :---------- |
|
|
605
|
+
* | Organization | `write_databases` |
|
|
606
|
+
* | Database | `write_database` |
|
|
419
607
|
*/
|
|
420
|
-
|
|
421
|
-
return (options.client ?? this._client).
|
|
422
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
608
|
+
cancelBouncerResizeRequest(options) {
|
|
609
|
+
return (options.client ?? this._client).delete({
|
|
610
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes",
|
|
423
611
|
...options,
|
|
424
|
-
headers: {
|
|
425
|
-
"Content-Type": "application/json",
|
|
426
|
-
...options.headers,
|
|
427
|
-
},
|
|
428
612
|
});
|
|
429
613
|
}
|
|
430
614
|
/**
|
|
431
|
-
* Get
|
|
615
|
+
* Get bouncer resize requests
|
|
432
616
|
*
|
|
433
617
|
* ### Authorization
|
|
434
|
-
* A service token
|
|
618
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
435
619
|
*
|
|
436
620
|
* **Service Token Accesses**
|
|
437
621
|
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
438
622
|
*
|
|
623
|
+
* **OAuth Scopes**
|
|
439
624
|
*
|
|
625
|
+
* | Resource | Scopes |
|
|
626
|
+
* | :------- | :---------- |
|
|
627
|
+
* | Organization | `read_branches` |
|
|
628
|
+
* | Database | `read_branches` |
|
|
629
|
+
* | Branch | `read_branch` |
|
|
440
630
|
*/
|
|
441
|
-
|
|
631
|
+
listBouncerResizeRequests(options) {
|
|
442
632
|
return (options.client ?? this._client).get({
|
|
443
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
633
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes",
|
|
444
634
|
...options,
|
|
445
635
|
});
|
|
446
636
|
}
|
|
447
637
|
/**
|
|
448
|
-
*
|
|
638
|
+
* Upsert a bouncer resize request
|
|
449
639
|
*
|
|
450
640
|
* ### Authorization
|
|
451
|
-
* A service token
|
|
641
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
452
642
|
*
|
|
453
643
|
* **Service Token Accesses**
|
|
454
|
-
* `
|
|
644
|
+
* `write_database`
|
|
455
645
|
*
|
|
646
|
+
* **OAuth Scopes**
|
|
456
647
|
*
|
|
648
|
+
* | Resource | Scopes |
|
|
649
|
+
* | :------- | :---------- |
|
|
650
|
+
* | Organization | `write_databases` |
|
|
651
|
+
* | Database | `write_database` |
|
|
457
652
|
*/
|
|
458
|
-
|
|
653
|
+
updateBouncerResizeRequest(options) {
|
|
459
654
|
return (options.client ?? this._client).patch({
|
|
460
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
655
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes",
|
|
461
656
|
...options,
|
|
462
657
|
headers: {
|
|
463
658
|
"Content-Type": "application/json",
|
|
@@ -466,51 +661,290 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
466
661
|
});
|
|
467
662
|
}
|
|
468
663
|
/**
|
|
469
|
-
*
|
|
664
|
+
* Get branch change requests
|
|
470
665
|
*
|
|
666
|
+
* ### Authorization
|
|
667
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
471
668
|
*
|
|
472
|
-
|
|
473
|
-
|
|
474
|
-
return (options.client ?? this._client).delete({
|
|
475
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name}",
|
|
476
|
-
...options,
|
|
477
|
-
});
|
|
478
|
-
}
|
|
479
|
-
/**
|
|
480
|
-
* Get a keyspace
|
|
669
|
+
* **Service Token Accesses**
|
|
670
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
481
671
|
*
|
|
672
|
+
* **OAuth Scopes**
|
|
482
673
|
*
|
|
674
|
+
* | Resource | Scopes |
|
|
675
|
+
* | :------- | :---------- |
|
|
676
|
+
* | Organization | `read_branches` |
|
|
677
|
+
* | Database | `read_branches` |
|
|
678
|
+
* | Branch | `read_branch` |
|
|
483
679
|
*/
|
|
484
|
-
|
|
680
|
+
listBranchChangeRequests(options) {
|
|
485
681
|
return (options.client ?? this._client).get({
|
|
486
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/
|
|
682
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes",
|
|
487
683
|
...options,
|
|
488
684
|
});
|
|
489
685
|
}
|
|
490
686
|
/**
|
|
491
|
-
*
|
|
687
|
+
* Upsert a change request
|
|
688
|
+
*
|
|
689
|
+
* ### Authorization
|
|
690
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
691
|
+
*
|
|
692
|
+
* **Service Token Accesses**
|
|
693
|
+
* `write_database`
|
|
694
|
+
*
|
|
695
|
+
* **OAuth Scopes**
|
|
696
|
+
*
|
|
697
|
+
* | Resource | Scopes |
|
|
698
|
+
* | :------- | :---------- |
|
|
699
|
+
* | Organization | `write_databases` |
|
|
700
|
+
* | Database | `write_database` |
|
|
701
|
+
*/
|
|
702
|
+
updateBranchChangeRequest(options) {
|
|
703
|
+
return (options.client ?? this._client).patch({
|
|
704
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes",
|
|
705
|
+
...options,
|
|
706
|
+
headers: {
|
|
707
|
+
"Content-Type": "application/json",
|
|
708
|
+
...options.headers,
|
|
709
|
+
},
|
|
710
|
+
});
|
|
711
|
+
}
|
|
712
|
+
/**
|
|
713
|
+
* Get a branch change request
|
|
714
|
+
*
|
|
715
|
+
* ### Authorization
|
|
716
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
717
|
+
*
|
|
718
|
+
* **Service Token Accesses**
|
|
719
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
720
|
+
*
|
|
721
|
+
* **OAuth Scopes**
|
|
722
|
+
*
|
|
723
|
+
* | Resource | Scopes |
|
|
724
|
+
* | :------- | :---------- |
|
|
725
|
+
* | Organization | `read_branches` |
|
|
726
|
+
* | Database | `read_branches` |
|
|
727
|
+
* | Branch | `read_branch` |
|
|
728
|
+
*/
|
|
729
|
+
getBranchChangeRequest(options) {
|
|
730
|
+
return (options.client ?? this._client).get({
|
|
731
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes/{id}",
|
|
732
|
+
...options,
|
|
733
|
+
});
|
|
734
|
+
}
|
|
735
|
+
/**
|
|
736
|
+
* Change a branch cluster configuration
|
|
737
|
+
*
|
|
738
|
+
* ### Authorization
|
|
739
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
740
|
+
*
|
|
741
|
+
* **Service Token Accesses**
|
|
742
|
+
* `write_database`
|
|
743
|
+
*
|
|
744
|
+
*
|
|
745
|
+
*/
|
|
746
|
+
updateBranchClusterConfig(options) {
|
|
747
|
+
return (options.client ?? this._client).patch({
|
|
748
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/cluster",
|
|
749
|
+
...options,
|
|
750
|
+
headers: {
|
|
751
|
+
"Content-Type": "application/json",
|
|
752
|
+
...options.headers,
|
|
753
|
+
},
|
|
754
|
+
});
|
|
755
|
+
}
|
|
756
|
+
/**
|
|
757
|
+
* Demote a branch
|
|
758
|
+
* Demotes a branch from production to development
|
|
759
|
+
* ### Authorization
|
|
760
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
761
|
+
*
|
|
762
|
+
* **Service Token Accesses**
|
|
763
|
+
* `connect_production_branch`, `demote_branches`
|
|
764
|
+
*
|
|
765
|
+
* **OAuth Scopes**
|
|
766
|
+
*
|
|
767
|
+
* | Resource | Scopes |
|
|
768
|
+
* | :------- | :---------- |
|
|
769
|
+
* | Organization | `demote_branches` |
|
|
770
|
+
* | Database | `demote_branches` |
|
|
771
|
+
*/
|
|
772
|
+
demoteBranch(options) {
|
|
773
|
+
return (options.client ?? this._client).post({
|
|
774
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/demote",
|
|
775
|
+
...options,
|
|
776
|
+
});
|
|
777
|
+
}
|
|
778
|
+
/**
|
|
779
|
+
* List cluster extensions
|
|
780
|
+
*
|
|
781
|
+
* ### Authorization
|
|
782
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
783
|
+
*
|
|
784
|
+
* **Service Token Accesses**
|
|
785
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
786
|
+
*
|
|
787
|
+
* **OAuth Scopes**
|
|
788
|
+
*
|
|
789
|
+
* | Resource | Scopes |
|
|
790
|
+
* | :------- | :---------- |
|
|
791
|
+
* | Organization | `read_branches` |
|
|
792
|
+
* | Database | `read_branches` |
|
|
793
|
+
* | Branch | `read_branch` |
|
|
794
|
+
*/
|
|
795
|
+
listExtensions(options) {
|
|
796
|
+
return (options.client ?? this._client).get({
|
|
797
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/extensions",
|
|
798
|
+
...options,
|
|
799
|
+
});
|
|
800
|
+
}
|
|
801
|
+
/**
|
|
802
|
+
* Get keyspaces
|
|
803
|
+
*
|
|
804
|
+
* ### Authorization
|
|
805
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
806
|
+
*
|
|
807
|
+
* **Service Token Accesses**
|
|
808
|
+
* `read_branch`
|
|
809
|
+
*
|
|
810
|
+
*
|
|
811
|
+
*/
|
|
812
|
+
listKeyspaces(options) {
|
|
813
|
+
return (options.client ?? this._client).get({
|
|
814
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces",
|
|
815
|
+
...options,
|
|
816
|
+
});
|
|
817
|
+
}
|
|
818
|
+
/**
|
|
819
|
+
* Create a keyspace
|
|
820
|
+
*
|
|
821
|
+
* ### Authorization
|
|
822
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
823
|
+
*
|
|
824
|
+
* **Service Token Accesses**
|
|
825
|
+
* `create_branch`
|
|
826
|
+
*
|
|
827
|
+
*
|
|
828
|
+
*/
|
|
829
|
+
createKeyspace(options) {
|
|
830
|
+
return (options.client ?? this._client).post({
|
|
831
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces",
|
|
832
|
+
...options,
|
|
833
|
+
headers: {
|
|
834
|
+
"Content-Type": "application/json",
|
|
835
|
+
...options.headers,
|
|
836
|
+
},
|
|
837
|
+
});
|
|
838
|
+
}
|
|
839
|
+
/**
|
|
840
|
+
* Delete a keyspace
|
|
841
|
+
*
|
|
842
|
+
* ### Authorization
|
|
843
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
844
|
+
*
|
|
845
|
+
* **Service Token Accesses**
|
|
846
|
+
* `delete_branch`, `delete_production_branch`
|
|
847
|
+
*
|
|
848
|
+
*
|
|
849
|
+
*/
|
|
850
|
+
deleteKeyspace(options) {
|
|
851
|
+
return (options.client ?? this._client).delete({
|
|
852
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}",
|
|
853
|
+
...options,
|
|
854
|
+
});
|
|
855
|
+
}
|
|
856
|
+
/**
|
|
857
|
+
* Get a keyspace
|
|
858
|
+
*
|
|
859
|
+
* ### Authorization
|
|
860
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
861
|
+
*
|
|
862
|
+
* **Service Token Accesses**
|
|
863
|
+
* `read_branch`
|
|
864
|
+
*
|
|
865
|
+
*
|
|
866
|
+
*/
|
|
867
|
+
getKeyspace(options) {
|
|
868
|
+
return (options.client ?? this._client).get({
|
|
869
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}",
|
|
870
|
+
...options,
|
|
871
|
+
});
|
|
872
|
+
}
|
|
873
|
+
/**
|
|
874
|
+
* Configure keyspace settings
|
|
875
|
+
*
|
|
876
|
+
* ### Authorization
|
|
877
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
878
|
+
*
|
|
879
|
+
* **Service Token Accesses**
|
|
880
|
+
* `create_branch`
|
|
492
881
|
*
|
|
493
882
|
*
|
|
494
883
|
*/
|
|
495
884
|
updateKeyspace(options) {
|
|
496
885
|
return (options.client ?? this._client).patch({
|
|
497
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{
|
|
886
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}",
|
|
498
887
|
...options,
|
|
499
888
|
});
|
|
500
889
|
}
|
|
501
890
|
/**
|
|
502
891
|
* Get keyspace rollout status
|
|
503
892
|
*
|
|
893
|
+
* ### Authorization
|
|
894
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
895
|
+
*
|
|
896
|
+
* **Service Token Accesses**
|
|
897
|
+
* `read_branch`
|
|
898
|
+
*
|
|
504
899
|
*
|
|
505
900
|
*/
|
|
506
901
|
getKeyspaceRolloutStatus(options) {
|
|
507
902
|
return (options.client ?? this._client).get({
|
|
508
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{
|
|
903
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/rollout-status",
|
|
904
|
+
...options,
|
|
905
|
+
});
|
|
906
|
+
}
|
|
907
|
+
/**
|
|
908
|
+
* Get the VSchema for the keyspace
|
|
909
|
+
*
|
|
910
|
+
* ### Authorization
|
|
911
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
912
|
+
*
|
|
913
|
+
* **Service Token Accesses**
|
|
914
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
915
|
+
*
|
|
916
|
+
*
|
|
917
|
+
*/
|
|
918
|
+
getKeyspaceVschema(options) {
|
|
919
|
+
return (options.client ?? this._client).get({
|
|
920
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema",
|
|
921
|
+
...options,
|
|
922
|
+
});
|
|
923
|
+
}
|
|
924
|
+
/**
|
|
925
|
+
* Update the VSchema for the keyspace
|
|
926
|
+
*
|
|
927
|
+
* ### Authorization
|
|
928
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
929
|
+
*
|
|
930
|
+
* **Service Token Accesses**
|
|
931
|
+
* `write_production_branch_vschema`, `write_branch_vschema`
|
|
932
|
+
*
|
|
933
|
+
*
|
|
934
|
+
*/
|
|
935
|
+
updateKeyspaceVschema(options) {
|
|
936
|
+
return (options.client ?? this._client).patch({
|
|
937
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema",
|
|
509
938
|
...options,
|
|
939
|
+
headers: {
|
|
940
|
+
"Content-Type": "application/json",
|
|
941
|
+
...options.headers,
|
|
942
|
+
},
|
|
510
943
|
});
|
|
511
944
|
}
|
|
512
945
|
/**
|
|
513
946
|
* List cluster parameters
|
|
947
|
+
* Returns the parameters for a branch. To update the parameters, use the "Upsert a change request" endpoint.
|
|
514
948
|
*
|
|
515
949
|
* ### Authorization
|
|
516
950
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
@@ -539,15 +973,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
539
973
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
540
974
|
*
|
|
541
975
|
* **Service Token Accesses**
|
|
542
|
-
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
976
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
543
977
|
*
|
|
544
978
|
* **OAuth Scopes**
|
|
545
979
|
*
|
|
546
980
|
* | Resource | Scopes |
|
|
547
981
|
* | :------- | :---------- |
|
|
548
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
549
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
550
|
-
* | Branch | `manage_passwords` |
|
|
982
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
983
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
984
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
551
985
|
*/
|
|
552
986
|
listPasswords(options) {
|
|
553
987
|
return (options.client ?? this._client).get({
|
|
@@ -562,15 +996,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
562
996
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
563
997
|
*
|
|
564
998
|
* **Service Token Accesses**
|
|
565
|
-
* `connect_production_branch`, `connect_branch`
|
|
999
|
+
* `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
566
1000
|
*
|
|
567
1001
|
* **OAuth Scopes**
|
|
568
1002
|
*
|
|
569
1003
|
* | Resource | Scopes |
|
|
570
1004
|
* | :------- | :---------- |
|
|
571
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
572
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
573
|
-
* | Branch | `manage_passwords` |
|
|
1005
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1006
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1007
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
574
1008
|
*/
|
|
575
1009
|
createPassword(options) {
|
|
576
1010
|
return (options.client ?? this._client).post({
|
|
@@ -589,15 +1023,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
589
1023
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
590
1024
|
*
|
|
591
1025
|
* **Service Token Accesses**
|
|
592
|
-
* `delete_production_branch_password`, `delete_branch_password`
|
|
1026
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
593
1027
|
*
|
|
594
1028
|
* **OAuth Scopes**
|
|
595
1029
|
*
|
|
596
1030
|
* | Resource | Scopes |
|
|
597
1031
|
* | :------- | :---------- |
|
|
598
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
599
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
600
|
-
* | Branch | `manage_passwords` |
|
|
1032
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1033
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1034
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
601
1035
|
*/
|
|
602
1036
|
deletePassword(options) {
|
|
603
1037
|
return (options.client ?? this._client).delete({
|
|
@@ -612,15 +1046,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
612
1046
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
613
1047
|
*
|
|
614
1048
|
* **Service Token Accesses**
|
|
615
|
-
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
1049
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
616
1050
|
*
|
|
617
1051
|
* **OAuth Scopes**
|
|
618
1052
|
*
|
|
619
1053
|
* | Resource | Scopes |
|
|
620
1054
|
* | :------- | :---------- |
|
|
621
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
622
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
623
|
-
* | Branch | `manage_passwords` |
|
|
1055
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1056
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1057
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
624
1058
|
*/
|
|
625
1059
|
getPassword(options) {
|
|
626
1060
|
return (options.client ?? this._client).get({
|
|
@@ -635,15 +1069,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
635
1069
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
636
1070
|
*
|
|
637
1071
|
* **Service Token Accesses**
|
|
638
|
-
* `connect_production_branch`, `connect_branch`
|
|
1072
|
+
* `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
639
1073
|
*
|
|
640
1074
|
* **OAuth Scopes**
|
|
641
1075
|
*
|
|
642
1076
|
* | Resource | Scopes |
|
|
643
1077
|
* | :------- | :---------- |
|
|
644
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
645
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
646
|
-
* | Branch | `manage_passwords` |
|
|
1078
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1079
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1080
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
647
1081
|
*/
|
|
648
1082
|
updatePassword(options) {
|
|
649
1083
|
return (options.client ?? this._client).patch({
|
|
@@ -662,15 +1096,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
662
1096
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
663
1097
|
*
|
|
664
1098
|
* **Service Token Accesses**
|
|
665
|
-
* `connect_production_branch`, `connect_branch`
|
|
1099
|
+
* `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
666
1100
|
*
|
|
667
1101
|
* **OAuth Scopes**
|
|
668
1102
|
*
|
|
669
1103
|
* | Resource | Scopes |
|
|
670
1104
|
* | :------- | :---------- |
|
|
671
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
672
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
673
|
-
* | Branch | `manage_passwords` |
|
|
1105
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1106
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1107
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
674
1108
|
*/
|
|
675
1109
|
renewPassword(options) {
|
|
676
1110
|
return (options.client ?? this._client).post({
|
|
@@ -678,6 +1112,28 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
678
1112
|
...options,
|
|
679
1113
|
});
|
|
680
1114
|
}
|
|
1115
|
+
/**
|
|
1116
|
+
* Promote a branch
|
|
1117
|
+
* Promotes a branch from development to production
|
|
1118
|
+
* ### Authorization
|
|
1119
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1120
|
+
*
|
|
1121
|
+
* **Service Token Accesses**
|
|
1122
|
+
* `connect_production_branch`, `promote_branches`
|
|
1123
|
+
*
|
|
1124
|
+
* **OAuth Scopes**
|
|
1125
|
+
*
|
|
1126
|
+
* | Resource | Scopes |
|
|
1127
|
+
* | :------- | :---------- |
|
|
1128
|
+
* | Organization | `promote_branches` |
|
|
1129
|
+
* | Database | `promote_branches` |
|
|
1130
|
+
*/
|
|
1131
|
+
promoteBranch(options) {
|
|
1132
|
+
return (options.client ?? this._client).post({
|
|
1133
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/promote",
|
|
1134
|
+
...options,
|
|
1135
|
+
});
|
|
1136
|
+
}
|
|
681
1137
|
/**
|
|
682
1138
|
* List generated query patterns reports
|
|
683
1139
|
*
|
|
@@ -822,15 +1278,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
822
1278
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
823
1279
|
*
|
|
824
1280
|
* **Service Token Accesses**
|
|
825
|
-
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
|
|
1281
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
826
1282
|
*
|
|
827
1283
|
* **OAuth Scopes**
|
|
828
1284
|
*
|
|
829
1285
|
* | Resource | Scopes |
|
|
830
1286
|
* | :------- | :---------- |
|
|
831
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
832
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
833
|
-
* | Branch | `manage_passwords` |
|
|
1287
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1288
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1289
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
834
1290
|
*/
|
|
835
1291
|
listRoles(options) {
|
|
836
1292
|
return (options.client ?? this._client).get({
|
|
@@ -845,15 +1301,15 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
845
1301
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
846
1302
|
*
|
|
847
1303
|
* **Service Token Accesses**
|
|
848
|
-
* `create_production_branch_password`, `create_branch_password`
|
|
1304
|
+
* `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
|
|
849
1305
|
*
|
|
850
1306
|
* **OAuth Scopes**
|
|
851
1307
|
*
|
|
852
1308
|
* | Resource | Scopes |
|
|
853
1309
|
* | :------- | :---------- |
|
|
854
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
855
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
856
|
-
* | Branch | `manage_passwords` |
|
|
1310
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1311
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1312
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
857
1313
|
*/
|
|
858
1314
|
createRole(options) {
|
|
859
1315
|
return (options.client ?? this._client).post({
|
|
@@ -866,74 +1322,70 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
866
1322
|
});
|
|
867
1323
|
}
|
|
868
1324
|
/**
|
|
869
|
-
*
|
|
1325
|
+
* Get the default postgres role
|
|
870
1326
|
*
|
|
871
1327
|
* ### Authorization
|
|
872
1328
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
873
1329
|
*
|
|
874
1330
|
* **Service Token Accesses**
|
|
875
|
-
* `
|
|
1331
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
876
1332
|
*
|
|
877
1333
|
* **OAuth Scopes**
|
|
878
1334
|
*
|
|
879
1335
|
* | Resource | Scopes |
|
|
880
1336
|
* | :------- | :---------- |
|
|
881
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
882
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
883
|
-
* | Branch | `manage_passwords` |
|
|
1337
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1338
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1339
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
884
1340
|
*/
|
|
885
|
-
|
|
886
|
-
return (options.client ?? this._client).
|
|
887
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/
|
|
1341
|
+
getDefaultRole(options) {
|
|
1342
|
+
return (options.client ?? this._client).get({
|
|
1343
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/default",
|
|
888
1344
|
...options,
|
|
889
|
-
headers: {
|
|
890
|
-
"Content-Type": "application/json",
|
|
891
|
-
...options.headers,
|
|
892
|
-
},
|
|
893
1345
|
});
|
|
894
1346
|
}
|
|
895
1347
|
/**
|
|
896
|
-
*
|
|
1348
|
+
* Reset default credentials
|
|
897
1349
|
*
|
|
898
1350
|
* ### Authorization
|
|
899
1351
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
900
1352
|
*
|
|
901
1353
|
* **Service Token Accesses**
|
|
902
|
-
* `
|
|
1354
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
903
1355
|
*
|
|
904
1356
|
* **OAuth Scopes**
|
|
905
1357
|
*
|
|
906
1358
|
* | Resource | Scopes |
|
|
907
1359
|
* | :------- | :---------- |
|
|
908
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
909
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
910
|
-
* | Branch | `manage_passwords` |
|
|
1360
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1361
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1362
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
911
1363
|
*/
|
|
912
|
-
|
|
913
|
-
return (options.client ?? this._client).
|
|
914
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/
|
|
1364
|
+
resetDefaultRole(options) {
|
|
1365
|
+
return (options.client ?? this._client).post({
|
|
1366
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/reset-default",
|
|
915
1367
|
...options,
|
|
916
1368
|
});
|
|
917
1369
|
}
|
|
918
1370
|
/**
|
|
919
|
-
*
|
|
1371
|
+
* Delete role credentials
|
|
920
1372
|
*
|
|
921
1373
|
* ### Authorization
|
|
922
1374
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
923
1375
|
*
|
|
924
1376
|
* **Service Token Accesses**
|
|
925
|
-
* `
|
|
1377
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
926
1378
|
*
|
|
927
1379
|
* **OAuth Scopes**
|
|
928
1380
|
*
|
|
929
1381
|
* | Resource | Scopes |
|
|
930
1382
|
* | :------- | :---------- |
|
|
931
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
932
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
933
|
-
* | Branch | `manage_passwords` |
|
|
1383
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1384
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1385
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
934
1386
|
*/
|
|
935
|
-
|
|
936
|
-
return (options.client ?? this._client).
|
|
1387
|
+
deleteRole(options) {
|
|
1388
|
+
return (options.client ?? this._client).delete({
|
|
937
1389
|
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
|
|
938
1390
|
...options,
|
|
939
1391
|
headers: {
|
|
@@ -943,88 +1395,75 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
943
1395
|
});
|
|
944
1396
|
}
|
|
945
1397
|
/**
|
|
946
|
-
*
|
|
1398
|
+
* Get a role
|
|
947
1399
|
*
|
|
948
1400
|
* ### Authorization
|
|
949
1401
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
950
1402
|
*
|
|
951
1403
|
* **Service Token Accesses**
|
|
952
|
-
* `
|
|
1404
|
+
* `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
|
|
953
1405
|
*
|
|
954
1406
|
* **OAuth Scopes**
|
|
955
1407
|
*
|
|
956
1408
|
* | Resource | Scopes |
|
|
957
1409
|
* | :------- | :---------- |
|
|
958
|
-
* | Organization | `manage_passwords`, `manage_production_branch_passwords` |
|
|
959
|
-
* | Database | `manage_passwords`, `manage_production_branch_passwords` |
|
|
960
|
-
* | Branch | `manage_passwords` |
|
|
1410
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1411
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1412
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
961
1413
|
*/
|
|
962
|
-
|
|
963
|
-
return (options.client ?? this._client).
|
|
964
|
-
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}
|
|
1414
|
+
getRole(options) {
|
|
1415
|
+
return (options.client ?? this._client).get({
|
|
1416
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
|
|
965
1417
|
...options,
|
|
966
1418
|
});
|
|
967
1419
|
}
|
|
968
1420
|
/**
|
|
969
|
-
*
|
|
1421
|
+
* Update role name
|
|
970
1422
|
*
|
|
971
1423
|
* ### Authorization
|
|
972
1424
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
973
1425
|
*
|
|
974
1426
|
* **Service Token Accesses**
|
|
975
|
-
* `
|
|
1427
|
+
* `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
|
|
976
1428
|
*
|
|
977
1429
|
* **OAuth Scopes**
|
|
978
1430
|
*
|
|
979
1431
|
* | Resource | Scopes |
|
|
980
1432
|
* | :------- | :---------- |
|
|
981
|
-
* | Organization | `
|
|
982
|
-
* | Database | `
|
|
983
|
-
* | Branch | `
|
|
1433
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1434
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1435
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
984
1436
|
*/
|
|
985
|
-
|
|
986
|
-
return (options.client ?? this._client).
|
|
987
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1437
|
+
updateRole(options) {
|
|
1438
|
+
return (options.client ?? this._client).patch({
|
|
1439
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
|
|
988
1440
|
...options,
|
|
1441
|
+
headers: {
|
|
1442
|
+
"Content-Type": "application/json",
|
|
1443
|
+
...options.headers,
|
|
1444
|
+
},
|
|
989
1445
|
});
|
|
990
1446
|
}
|
|
991
1447
|
/**
|
|
992
|
-
*
|
|
1448
|
+
* Reassign objects owned by one role to another role
|
|
993
1449
|
*
|
|
994
1450
|
* ### Authorization
|
|
995
1451
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
996
1452
|
*
|
|
997
1453
|
* **Service Token Accesses**
|
|
998
|
-
* `
|
|
1454
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
999
1455
|
*
|
|
1000
1456
|
* **OAuth Scopes**
|
|
1001
1457
|
*
|
|
1002
1458
|
* | Resource | Scopes |
|
|
1003
1459
|
* | :------- | :---------- |
|
|
1004
|
-
* | Organization | `
|
|
1005
|
-
* | Database | `
|
|
1006
|
-
* | Branch | `
|
|
1007
|
-
*/
|
|
1008
|
-
getBranch(options) {
|
|
1009
|
-
return (options.client ?? this._client).get({
|
|
1010
|
-
url: "/organizations/{organization}/databases/{database}/branches/{name}",
|
|
1011
|
-
...options,
|
|
1012
|
-
});
|
|
1013
|
-
}
|
|
1014
|
-
/**
|
|
1015
|
-
* Change a branch cluster configuration
|
|
1016
|
-
*
|
|
1017
|
-
* ### Authorization
|
|
1018
|
-
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
1019
|
-
*
|
|
1020
|
-
* **Service Token Accesses**
|
|
1021
|
-
* `write_database`
|
|
1022
|
-
*
|
|
1023
|
-
*
|
|
1460
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1461
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1462
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
1024
1463
|
*/
|
|
1025
|
-
|
|
1026
|
-
return (options.client ?? this._client).
|
|
1027
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1464
|
+
reassignRoleObjects(options) {
|
|
1465
|
+
return (options.client ?? this._client).post({
|
|
1466
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reassign",
|
|
1028
1467
|
...options,
|
|
1029
1468
|
headers: {
|
|
1030
1469
|
"Content-Type": "application/json",
|
|
@@ -1033,46 +1472,48 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1033
1472
|
});
|
|
1034
1473
|
}
|
|
1035
1474
|
/**
|
|
1036
|
-
*
|
|
1037
|
-
*
|
|
1475
|
+
* Renew role expiration
|
|
1476
|
+
*
|
|
1038
1477
|
* ### Authorization
|
|
1039
1478
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1040
1479
|
*
|
|
1041
1480
|
* **Service Token Accesses**
|
|
1042
|
-
* `
|
|
1481
|
+
* `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
|
|
1043
1482
|
*
|
|
1044
1483
|
* **OAuth Scopes**
|
|
1045
1484
|
*
|
|
1046
1485
|
* | Resource | Scopes |
|
|
1047
1486
|
* | :------- | :---------- |
|
|
1048
|
-
* | Organization | `
|
|
1049
|
-
* | Database | `
|
|
1487
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1488
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1489
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
1050
1490
|
*/
|
|
1051
|
-
|
|
1491
|
+
renewRole(options) {
|
|
1052
1492
|
return (options.client ?? this._client).post({
|
|
1053
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1493
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/renew",
|
|
1054
1494
|
...options,
|
|
1055
1495
|
});
|
|
1056
1496
|
}
|
|
1057
1497
|
/**
|
|
1058
|
-
*
|
|
1059
|
-
*
|
|
1498
|
+
* Reset a role's password
|
|
1499
|
+
*
|
|
1060
1500
|
* ### Authorization
|
|
1061
1501
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1062
1502
|
*
|
|
1063
1503
|
* **Service Token Accesses**
|
|
1064
|
-
* `
|
|
1504
|
+
* `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
|
|
1065
1505
|
*
|
|
1066
1506
|
* **OAuth Scopes**
|
|
1067
1507
|
*
|
|
1068
1508
|
* | Resource | Scopes |
|
|
1069
1509
|
* | :------- | :---------- |
|
|
1070
|
-
* | Organization | `
|
|
1071
|
-
* | Database | `
|
|
1510
|
+
* | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1511
|
+
* | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
|
|
1512
|
+
* | Branch | `manage_passwords`, `manage_read_only_passwords` |
|
|
1072
1513
|
*/
|
|
1073
|
-
|
|
1514
|
+
resetRole(options) {
|
|
1074
1515
|
return (options.client ?? this._client).post({
|
|
1075
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1516
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reset",
|
|
1076
1517
|
...options,
|
|
1077
1518
|
});
|
|
1078
1519
|
}
|
|
@@ -1083,7 +1524,7 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1083
1524
|
*/
|
|
1084
1525
|
disableSafeMigrations(options) {
|
|
1085
1526
|
return (options.client ?? this._client).delete({
|
|
1086
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1527
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations",
|
|
1087
1528
|
...options,
|
|
1088
1529
|
});
|
|
1089
1530
|
}
|
|
@@ -1094,7 +1535,7 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1094
1535
|
*/
|
|
1095
1536
|
enableSafeMigrations(options) {
|
|
1096
1537
|
return (options.client ?? this._client).post({
|
|
1097
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1538
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations",
|
|
1098
1539
|
...options,
|
|
1099
1540
|
});
|
|
1100
1541
|
}
|
|
@@ -1117,7 +1558,7 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1117
1558
|
*/
|
|
1118
1559
|
getBranchSchema(options) {
|
|
1119
1560
|
return (options.client ?? this._client).get({
|
|
1120
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1561
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/schema",
|
|
1121
1562
|
...options,
|
|
1122
1563
|
});
|
|
1123
1564
|
}
|
|
@@ -1140,8 +1581,111 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1140
1581
|
*/
|
|
1141
1582
|
lintBranchSchema(options) {
|
|
1142
1583
|
return (options.client ?? this._client).get({
|
|
1143
|
-
url: "/organizations/{organization}/databases/{database}/branches/{
|
|
1584
|
+
url: "/organizations/{organization}/databases/{database}/branches/{branch}/schema/lint",
|
|
1585
|
+
...options,
|
|
1586
|
+
});
|
|
1587
|
+
}
|
|
1588
|
+
/**
|
|
1589
|
+
* List IP restriction entries
|
|
1590
|
+
*
|
|
1591
|
+
* ### Authorization
|
|
1592
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1593
|
+
*
|
|
1594
|
+
* **OAuth Scopes**
|
|
1595
|
+
*
|
|
1596
|
+
* | Resource | Scopes |
|
|
1597
|
+
* | :------- | :---------- |
|
|
1598
|
+
* | Organization | `read_databases` |
|
|
1599
|
+
* | Database | `read_database` |
|
|
1600
|
+
*/
|
|
1601
|
+
listDatabasePostgresCidrs(options) {
|
|
1602
|
+
return (options.client ?? this._client).get({
|
|
1603
|
+
url: "/organizations/{organization}/databases/{database}/cidrs",
|
|
1604
|
+
...options,
|
|
1605
|
+
});
|
|
1606
|
+
}
|
|
1607
|
+
/**
|
|
1608
|
+
* Create an IP restriction entry
|
|
1609
|
+
*
|
|
1610
|
+
* ### Authorization
|
|
1611
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1612
|
+
*
|
|
1613
|
+
* **OAuth Scopes**
|
|
1614
|
+
*
|
|
1615
|
+
* | Resource | Scopes |
|
|
1616
|
+
* | :------- | :---------- |
|
|
1617
|
+
* | Organization | `write_databases` |
|
|
1618
|
+
* | Database | `write_database` |
|
|
1619
|
+
*/
|
|
1620
|
+
createDatabasePostgresCidr(options) {
|
|
1621
|
+
return (options.client ?? this._client).post({
|
|
1622
|
+
url: "/organizations/{organization}/databases/{database}/cidrs",
|
|
1623
|
+
...options,
|
|
1624
|
+
headers: {
|
|
1625
|
+
"Content-Type": "application/json",
|
|
1626
|
+
...options.headers,
|
|
1627
|
+
},
|
|
1628
|
+
});
|
|
1629
|
+
}
|
|
1630
|
+
/**
|
|
1631
|
+
* Delete an IP restriction entry
|
|
1632
|
+
*
|
|
1633
|
+
* ### Authorization
|
|
1634
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1635
|
+
*
|
|
1636
|
+
* **OAuth Scopes**
|
|
1637
|
+
*
|
|
1638
|
+
* | Resource | Scopes |
|
|
1639
|
+
* | :------- | :---------- |
|
|
1640
|
+
* | Organization | `write_databases` |
|
|
1641
|
+
* | Database | `write_database` |
|
|
1642
|
+
*/
|
|
1643
|
+
deleteDatabasePostgresCidr(options) {
|
|
1644
|
+
return (options.client ?? this._client).delete({
|
|
1645
|
+
url: "/organizations/{organization}/databases/{database}/cidrs/{id}",
|
|
1646
|
+
...options,
|
|
1647
|
+
});
|
|
1648
|
+
}
|
|
1649
|
+
/**
|
|
1650
|
+
* Get an IP restriction entry
|
|
1651
|
+
*
|
|
1652
|
+
* ### Authorization
|
|
1653
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1654
|
+
*
|
|
1655
|
+
* **OAuth Scopes**
|
|
1656
|
+
*
|
|
1657
|
+
* | Resource | Scopes |
|
|
1658
|
+
* | :------- | :---------- |
|
|
1659
|
+
* | Organization | `read_databases` |
|
|
1660
|
+
* | Database | `read_database` |
|
|
1661
|
+
*/
|
|
1662
|
+
getDatabasePostgresCidr(options) {
|
|
1663
|
+
return (options.client ?? this._client).get({
|
|
1664
|
+
url: "/organizations/{organization}/databases/{database}/cidrs/{id}",
|
|
1665
|
+
...options,
|
|
1666
|
+
});
|
|
1667
|
+
}
|
|
1668
|
+
/**
|
|
1669
|
+
* Update an IP restriction entry
|
|
1670
|
+
*
|
|
1671
|
+
* ### Authorization
|
|
1672
|
+
* A OAuth token must have at least one of the following scopes in order to use this API endpoint:
|
|
1673
|
+
*
|
|
1674
|
+
* **OAuth Scopes**
|
|
1675
|
+
*
|
|
1676
|
+
* | Resource | Scopes |
|
|
1677
|
+
* | :------- | :---------- |
|
|
1678
|
+
* | Organization | `write_databases` |
|
|
1679
|
+
* | Database | `write_database` |
|
|
1680
|
+
*/
|
|
1681
|
+
updateDatabasePostgresCidr(options) {
|
|
1682
|
+
return (options.client ?? this._client).put({
|
|
1683
|
+
url: "/organizations/{organization}/databases/{database}/cidrs/{id}",
|
|
1144
1684
|
...options,
|
|
1685
|
+
headers: {
|
|
1686
|
+
"Content-Type": "application/json",
|
|
1687
|
+
...options.headers,
|
|
1688
|
+
},
|
|
1145
1689
|
});
|
|
1146
1690
|
}
|
|
1147
1691
|
/**
|
|
@@ -1299,6 +1843,32 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1299
1843
|
},
|
|
1300
1844
|
});
|
|
1301
1845
|
}
|
|
1846
|
+
/**
|
|
1847
|
+
* Update auto-delete branch for deploy request
|
|
1848
|
+
* Enables or disabled the auto-delete branch setting for a deploy request
|
|
1849
|
+
* ### Authorization
|
|
1850
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1851
|
+
*
|
|
1852
|
+
* **Service Token Accesses**
|
|
1853
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1854
|
+
*
|
|
1855
|
+
* **OAuth Scopes**
|
|
1856
|
+
*
|
|
1857
|
+
* | Resource | Scopes |
|
|
1858
|
+
* | :------- | :---------- |
|
|
1859
|
+
* | Organization | `deploy_deploy_requests` |
|
|
1860
|
+
* | Database | `deploy_deploy_requests` |
|
|
1861
|
+
*/
|
|
1862
|
+
updateAutoDeleteBranch(options) {
|
|
1863
|
+
return (options.client ?? this._client).put({
|
|
1864
|
+
url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-delete-branch",
|
|
1865
|
+
...options,
|
|
1866
|
+
headers: {
|
|
1867
|
+
"Content-Type": "application/json",
|
|
1868
|
+
...options.headers,
|
|
1869
|
+
},
|
|
1870
|
+
});
|
|
1871
|
+
}
|
|
1302
1872
|
/**
|
|
1303
1873
|
* Cancel a queued deploy request
|
|
1304
1874
|
*
|
|
@@ -1554,56 +2124,52 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1554
2124
|
});
|
|
1555
2125
|
}
|
|
1556
2126
|
/**
|
|
1557
|
-
*
|
|
1558
|
-
*
|
|
2127
|
+
* List read-only regions
|
|
2128
|
+
* List read-only regions for the database's default branch
|
|
1559
2129
|
* ### Authorization
|
|
1560
2130
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1561
2131
|
*
|
|
1562
2132
|
* **Service Token Accesses**
|
|
1563
|
-
* `read_deploy_request`, `create_deploy_request`
|
|
2133
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
1564
2134
|
*
|
|
1565
2135
|
* **OAuth Scopes**
|
|
1566
2136
|
*
|
|
1567
2137
|
* | Resource | Scopes |
|
|
1568
2138
|
* | :------- | :---------- |
|
|
1569
|
-
* | Organization | `
|
|
1570
|
-
* | Database | `
|
|
2139
|
+
* | Organization | `read_branches` |
|
|
2140
|
+
* | Database | `read_branches` |
|
|
1571
2141
|
*/
|
|
1572
|
-
|
|
2142
|
+
listReadOnlyRegions(options) {
|
|
1573
2143
|
return (options.client ?? this._client).get({
|
|
1574
|
-
url: "/organizations/{organization}/databases/{database}/
|
|
2144
|
+
url: "/organizations/{organization}/databases/{database}/read-only-regions",
|
|
1575
2145
|
...options,
|
|
1576
2146
|
});
|
|
1577
2147
|
}
|
|
1578
2148
|
/**
|
|
1579
|
-
*
|
|
2149
|
+
* List database regions
|
|
1580
2150
|
*
|
|
1581
2151
|
* ### Authorization
|
|
1582
2152
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1583
2153
|
*
|
|
1584
2154
|
* **Service Token Accesses**
|
|
1585
|
-
* `read_deploy_request`, `create_deploy_request`
|
|
2155
|
+
* `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `delete_branch_password`, `delete_production_branch_password`, `delete_production_read_only_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_comment`, `create_comment`, `restore_backup`, `restore_production_branch_backup`, `read_backups`, `write_backups`, `delete_backups`, `delete_production_branch_backups`, `write_branch_vschema`, `write_production_branch_vschema`
|
|
1586
2156
|
*
|
|
1587
2157
|
* **OAuth Scopes**
|
|
1588
2158
|
*
|
|
1589
2159
|
* | Resource | Scopes |
|
|
1590
2160
|
* | :------- | :---------- |
|
|
1591
|
-
* | Organization | `
|
|
1592
|
-
* | Database | `
|
|
2161
|
+
* | Organization | `read_databases` |
|
|
2162
|
+
* | Database | `read_database` |
|
|
1593
2163
|
*/
|
|
1594
|
-
|
|
1595
|
-
return (options.client ?? this._client).
|
|
1596
|
-
url: "/organizations/{organization}/databases/{database}/
|
|
2164
|
+
listDatabaseRegions(options) {
|
|
2165
|
+
return (options.client ?? this._client).get({
|
|
2166
|
+
url: "/organizations/{organization}/databases/{database}/regions",
|
|
1597
2167
|
...options,
|
|
1598
|
-
headers: {
|
|
1599
|
-
"Content-Type": "application/json",
|
|
1600
|
-
...options.headers,
|
|
1601
|
-
},
|
|
1602
2168
|
});
|
|
1603
2169
|
}
|
|
1604
2170
|
/**
|
|
1605
|
-
* List
|
|
1606
|
-
*
|
|
2171
|
+
* List schema recommendations
|
|
2172
|
+
*
|
|
1607
2173
|
* ### Authorization
|
|
1608
2174
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1609
2175
|
*
|
|
@@ -1617,40 +2183,36 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1617
2183
|
* | Organization | `read_databases` |
|
|
1618
2184
|
* | Database | `read_database` |
|
|
1619
2185
|
*/
|
|
1620
|
-
|
|
2186
|
+
listSchemaRecommendations(options) {
|
|
1621
2187
|
return (options.client ?? this._client).get({
|
|
1622
|
-
url: "/organizations/{organization}/databases/{database}/
|
|
2188
|
+
url: "/organizations/{organization}/databases/{database}/schema-recommendations",
|
|
1623
2189
|
...options,
|
|
1624
2190
|
});
|
|
1625
2191
|
}
|
|
1626
2192
|
/**
|
|
1627
|
-
*
|
|
2193
|
+
* Get a schema recommendation
|
|
1628
2194
|
*
|
|
1629
2195
|
* ### Authorization
|
|
1630
2196
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1631
2197
|
*
|
|
1632
2198
|
* **Service Token Accesses**
|
|
1633
|
-
* `
|
|
2199
|
+
* `read_database`
|
|
1634
2200
|
*
|
|
1635
2201
|
* **OAuth Scopes**
|
|
1636
2202
|
*
|
|
1637
2203
|
* | Resource | Scopes |
|
|
1638
2204
|
* | :------- | :---------- |
|
|
1639
|
-
* | Organization | `
|
|
1640
|
-
* | Database | `
|
|
2205
|
+
* | Organization | `read_databases` |
|
|
2206
|
+
* | Database | `read_database` |
|
|
1641
2207
|
*/
|
|
1642
|
-
|
|
1643
|
-
return (options.client ?? this._client).
|
|
1644
|
-
url: "/organizations/{organization}/databases/{database}/
|
|
2208
|
+
getSchemaRecommendation(options) {
|
|
2209
|
+
return (options.client ?? this._client).get({
|
|
2210
|
+
url: "/organizations/{organization}/databases/{database}/schema-recommendations/{number}",
|
|
1645
2211
|
...options,
|
|
1646
|
-
headers: {
|
|
1647
|
-
"Content-Type": "application/json",
|
|
1648
|
-
...options.headers,
|
|
1649
|
-
},
|
|
1650
2212
|
});
|
|
1651
2213
|
}
|
|
1652
2214
|
/**
|
|
1653
|
-
*
|
|
2215
|
+
* Dismiss a schema recommendation
|
|
1654
2216
|
*
|
|
1655
2217
|
* ### Authorization
|
|
1656
2218
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
@@ -1665,20 +2227,24 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1665
2227
|
* | Organization | `write_databases` |
|
|
1666
2228
|
* | Database | `write_database` |
|
|
1667
2229
|
*/
|
|
1668
|
-
|
|
1669
|
-
return (options.client ?? this._client).
|
|
1670
|
-
url: "/organizations/{organization}/databases/{database}/
|
|
2230
|
+
dismissSchemaRecommendation(options) {
|
|
2231
|
+
return (options.client ?? this._client).post({
|
|
2232
|
+
url: "/organizations/{organization}/databases/{database}/schema-recommendations/{number}/dismiss",
|
|
1671
2233
|
...options,
|
|
2234
|
+
headers: {
|
|
2235
|
+
"Content-Type": "application/json",
|
|
2236
|
+
...options.headers,
|
|
2237
|
+
},
|
|
1672
2238
|
});
|
|
1673
2239
|
}
|
|
1674
2240
|
/**
|
|
1675
|
-
* Get
|
|
2241
|
+
* Get database throttler configurations
|
|
1676
2242
|
*
|
|
1677
2243
|
* ### Authorization
|
|
1678
2244
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1679
2245
|
*
|
|
1680
2246
|
* **Service Token Accesses**
|
|
1681
|
-
* `
|
|
2247
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
1682
2248
|
*
|
|
1683
2249
|
* **OAuth Scopes**
|
|
1684
2250
|
*
|
|
@@ -1687,9 +2253,127 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1687
2253
|
* | Organization | `read_databases` |
|
|
1688
2254
|
* | Database | `read_database` |
|
|
1689
2255
|
*/
|
|
1690
|
-
|
|
2256
|
+
getDatabaseThrottler(options) {
|
|
1691
2257
|
return (options.client ?? this._client).get({
|
|
1692
|
-
url: "/organizations/{organization}/databases/{database}/
|
|
2258
|
+
url: "/organizations/{organization}/databases/{database}/throttler",
|
|
2259
|
+
...options,
|
|
2260
|
+
});
|
|
2261
|
+
}
|
|
2262
|
+
/**
|
|
2263
|
+
* Update database throttler configurations
|
|
2264
|
+
*
|
|
2265
|
+
* ### Authorization
|
|
2266
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2267
|
+
*
|
|
2268
|
+
* **Service Token Accesses**
|
|
2269
|
+
* `read_deploy_request`, `create_deploy_request`
|
|
2270
|
+
*
|
|
2271
|
+
* **OAuth Scopes**
|
|
2272
|
+
*
|
|
2273
|
+
* | Resource | Scopes |
|
|
2274
|
+
* | :------- | :---------- |
|
|
2275
|
+
* | Organization | `deploy_deploy_requests` |
|
|
2276
|
+
* | Database | `deploy_deploy_requests` |
|
|
2277
|
+
*/
|
|
2278
|
+
updateDatabaseThrottler(options) {
|
|
2279
|
+
return (options.client ?? this._client).patch({
|
|
2280
|
+
url: "/organizations/{organization}/databases/{database}/throttler",
|
|
2281
|
+
...options,
|
|
2282
|
+
headers: {
|
|
2283
|
+
"Content-Type": "application/json",
|
|
2284
|
+
...options.headers,
|
|
2285
|
+
},
|
|
2286
|
+
});
|
|
2287
|
+
}
|
|
2288
|
+
/**
|
|
2289
|
+
* List webhooks
|
|
2290
|
+
* List webhooks for a database
|
|
2291
|
+
* ### Authorization
|
|
2292
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2293
|
+
*
|
|
2294
|
+
* **Service Token Accesses**
|
|
2295
|
+
* `read_database`
|
|
2296
|
+
*
|
|
2297
|
+
* **OAuth Scopes**
|
|
2298
|
+
*
|
|
2299
|
+
* | Resource | Scopes |
|
|
2300
|
+
* | :------- | :---------- |
|
|
2301
|
+
* | Organization | `read_databases` |
|
|
2302
|
+
* | Database | `read_database` |
|
|
2303
|
+
*/
|
|
2304
|
+
listWebhooks(options) {
|
|
2305
|
+
return (options.client ?? this._client).get({
|
|
2306
|
+
url: "/organizations/{organization}/databases/{database}/webhooks",
|
|
2307
|
+
...options,
|
|
2308
|
+
});
|
|
2309
|
+
}
|
|
2310
|
+
/**
|
|
2311
|
+
* Create a webhook
|
|
2312
|
+
*
|
|
2313
|
+
* ### Authorization
|
|
2314
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2315
|
+
*
|
|
2316
|
+
* **Service Token Accesses**
|
|
2317
|
+
* `write_database`
|
|
2318
|
+
*
|
|
2319
|
+
* **OAuth Scopes**
|
|
2320
|
+
*
|
|
2321
|
+
* | Resource | Scopes |
|
|
2322
|
+
* | :------- | :---------- |
|
|
2323
|
+
* | Organization | `write_databases` |
|
|
2324
|
+
* | Database | `write_database` |
|
|
2325
|
+
*/
|
|
2326
|
+
createWebhook(options) {
|
|
2327
|
+
return (options.client ?? this._client).post({
|
|
2328
|
+
url: "/organizations/{organization}/databases/{database}/webhooks",
|
|
2329
|
+
...options,
|
|
2330
|
+
headers: {
|
|
2331
|
+
"Content-Type": "application/json",
|
|
2332
|
+
...options.headers,
|
|
2333
|
+
},
|
|
2334
|
+
});
|
|
2335
|
+
}
|
|
2336
|
+
/**
|
|
2337
|
+
* Delete a webhook
|
|
2338
|
+
*
|
|
2339
|
+
* ### Authorization
|
|
2340
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2341
|
+
*
|
|
2342
|
+
* **Service Token Accesses**
|
|
2343
|
+
* `write_database`
|
|
2344
|
+
*
|
|
2345
|
+
* **OAuth Scopes**
|
|
2346
|
+
*
|
|
2347
|
+
* | Resource | Scopes |
|
|
2348
|
+
* | :------- | :---------- |
|
|
2349
|
+
* | Organization | `write_databases` |
|
|
2350
|
+
* | Database | `write_database` |
|
|
2351
|
+
*/
|
|
2352
|
+
deleteWebhook(options) {
|
|
2353
|
+
return (options.client ?? this._client).delete({
|
|
2354
|
+
url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
|
|
2355
|
+
...options,
|
|
2356
|
+
});
|
|
2357
|
+
}
|
|
2358
|
+
/**
|
|
2359
|
+
* Get a webhook
|
|
2360
|
+
*
|
|
2361
|
+
* ### Authorization
|
|
2362
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2363
|
+
*
|
|
2364
|
+
* **Service Token Accesses**
|
|
2365
|
+
* `read_database`
|
|
2366
|
+
*
|
|
2367
|
+
* **OAuth Scopes**
|
|
2368
|
+
*
|
|
2369
|
+
* | Resource | Scopes |
|
|
2370
|
+
* | :------- | :---------- |
|
|
2371
|
+
* | Organization | `read_databases` |
|
|
2372
|
+
* | Database | `read_database` |
|
|
2373
|
+
*/
|
|
2374
|
+
getWebhook(options) {
|
|
2375
|
+
return (options.client ?? this._client).get({
|
|
2376
|
+
url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
|
|
1693
2377
|
...options,
|
|
1694
2378
|
});
|
|
1695
2379
|
}
|
|
@@ -1878,197 +2562,158 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
1878
2562
|
});
|
|
1879
2563
|
}
|
|
1880
2564
|
/**
|
|
1881
|
-
*
|
|
1882
|
-
*
|
|
1883
|
-
* ### Authorization
|
|
1884
|
-
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1885
|
-
*
|
|
1886
|
-
* **Service Token Accesses**
|
|
1887
|
-
* `delete_database`
|
|
1888
|
-
*
|
|
1889
|
-
* **OAuth Scopes**
|
|
1890
|
-
*
|
|
1891
|
-
* | Resource | Scopes |
|
|
1892
|
-
* | :------- | :---------- |
|
|
1893
|
-
* | Organization | `delete_databases` |
|
|
1894
|
-
* | Database | `delete_database` |
|
|
1895
|
-
*/
|
|
1896
|
-
deleteDatabase(options) {
|
|
1897
|
-
return (options.client ?? this._client).delete({
|
|
1898
|
-
url: "/organizations/{organization}/databases/{name}",
|
|
1899
|
-
...options,
|
|
1900
|
-
});
|
|
1901
|
-
}
|
|
1902
|
-
/**
|
|
1903
|
-
* Get a database
|
|
1904
|
-
*
|
|
2565
|
+
* Get invoices
|
|
2566
|
+
* Get the invoices for an organization
|
|
1905
2567
|
* ### Authorization
|
|
1906
2568
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1907
2569
|
*
|
|
1908
2570
|
* **Service Token Accesses**
|
|
1909
|
-
* `
|
|
2571
|
+
* `read_invoices`
|
|
1910
2572
|
*
|
|
1911
2573
|
* **OAuth Scopes**
|
|
1912
2574
|
*
|
|
1913
2575
|
* | Resource | Scopes |
|
|
1914
2576
|
* | :------- | :---------- |
|
|
1915
|
-
* | Organization | `
|
|
1916
|
-
* | Database | `read_database` |
|
|
2577
|
+
* | Organization | `read_invoices` |
|
|
1917
2578
|
*/
|
|
1918
|
-
|
|
2579
|
+
listInvoices(options) {
|
|
1919
2580
|
return (options.client ?? this._client).get({
|
|
1920
|
-
url: "/organizations/{organization}/
|
|
2581
|
+
url: "/organizations/{organization}/invoices",
|
|
1921
2582
|
...options,
|
|
1922
2583
|
});
|
|
1923
2584
|
}
|
|
1924
2585
|
/**
|
|
1925
|
-
*
|
|
2586
|
+
* Get an invoice
|
|
1926
2587
|
*
|
|
1927
2588
|
* ### Authorization
|
|
1928
2589
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1929
2590
|
*
|
|
1930
2591
|
* **Service Token Accesses**
|
|
1931
|
-
* `
|
|
2592
|
+
* `read_invoices`
|
|
1932
2593
|
*
|
|
1933
2594
|
* **OAuth Scopes**
|
|
1934
2595
|
*
|
|
1935
2596
|
* | Resource | Scopes |
|
|
1936
2597
|
* | :------- | :---------- |
|
|
1937
|
-
* | Organization | `
|
|
1938
|
-
* | Database | `write_database` |
|
|
2598
|
+
* | Organization | `read_invoices` |
|
|
1939
2599
|
*/
|
|
1940
|
-
|
|
1941
|
-
return (options.client ?? this._client).
|
|
1942
|
-
url: "/organizations/{organization}/
|
|
2600
|
+
getInvoice(options) {
|
|
2601
|
+
return (options.client ?? this._client).get({
|
|
2602
|
+
url: "/organizations/{organization}/invoices/{id}",
|
|
1943
2603
|
...options,
|
|
1944
|
-
headers: {
|
|
1945
|
-
"Content-Type": "application/json",
|
|
1946
|
-
...options.headers,
|
|
1947
|
-
},
|
|
1948
2604
|
});
|
|
1949
2605
|
}
|
|
1950
2606
|
/**
|
|
1951
|
-
*
|
|
1952
|
-
*
|
|
2607
|
+
* Get invoice line items
|
|
2608
|
+
* Get the line items for an invoice
|
|
1953
2609
|
* ### Authorization
|
|
1954
2610
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1955
2611
|
*
|
|
1956
2612
|
* **Service Token Accesses**
|
|
1957
|
-
* `
|
|
2613
|
+
* `read_invoices`
|
|
1958
2614
|
*
|
|
1959
2615
|
* **OAuth Scopes**
|
|
1960
2616
|
*
|
|
1961
2617
|
* | Resource | Scopes |
|
|
1962
2618
|
* | :------- | :---------- |
|
|
1963
|
-
* | Organization | `
|
|
1964
|
-
* | Database | `read_branches` |
|
|
2619
|
+
* | Organization | `read_invoices` |
|
|
1965
2620
|
*/
|
|
1966
|
-
|
|
2621
|
+
getInvoiceLineItems(options) {
|
|
1967
2622
|
return (options.client ?? this._client).get({
|
|
1968
|
-
url: "/organizations/{organization}/
|
|
2623
|
+
url: "/organizations/{organization}/invoices/{id}/line-items",
|
|
1969
2624
|
...options,
|
|
1970
2625
|
});
|
|
1971
2626
|
}
|
|
1972
2627
|
/**
|
|
1973
|
-
* List
|
|
2628
|
+
* List organization members
|
|
1974
2629
|
*
|
|
1975
2630
|
* ### Authorization
|
|
1976
2631
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1977
2632
|
*
|
|
1978
2633
|
* **Service Token Accesses**
|
|
1979
|
-
* `
|
|
2634
|
+
* `read_organization`
|
|
1980
2635
|
*
|
|
1981
2636
|
* **OAuth Scopes**
|
|
1982
2637
|
*
|
|
1983
2638
|
* | Resource | Scopes |
|
|
1984
2639
|
* | :------- | :---------- |
|
|
1985
|
-
* | Organization | `
|
|
1986
|
-
* | Database | `read_database` |
|
|
2640
|
+
* | Organization | `read_organization` |
|
|
1987
2641
|
*/
|
|
1988
|
-
|
|
2642
|
+
listOrganizationMembers(options) {
|
|
1989
2643
|
return (options.client ?? this._client).get({
|
|
1990
|
-
url: "/organizations/{organization}/
|
|
2644
|
+
url: "/organizations/{organization}/members",
|
|
1991
2645
|
...options,
|
|
1992
2646
|
});
|
|
1993
2647
|
}
|
|
1994
2648
|
/**
|
|
1995
|
-
*
|
|
1996
|
-
*
|
|
2649
|
+
* Remove a member from an organization
|
|
2650
|
+
*
|
|
1997
2651
|
* ### Authorization
|
|
1998
2652
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
1999
2653
|
*
|
|
2000
2654
|
* **Service Token Accesses**
|
|
2001
|
-
* `
|
|
2655
|
+
* `write_organization`
|
|
2002
2656
|
*
|
|
2003
2657
|
* **OAuth Scopes**
|
|
2004
2658
|
*
|
|
2005
2659
|
* | Resource | Scopes |
|
|
2006
2660
|
* | :------- | :---------- |
|
|
2007
|
-
* | Organization | `
|
|
2661
|
+
* | Organization | `write_organization` |
|
|
2008
2662
|
*/
|
|
2009
|
-
|
|
2010
|
-
return (options.client ?? this._client).
|
|
2011
|
-
url: "/organizations/{organization}/
|
|
2663
|
+
removeOrganizationMember(options) {
|
|
2664
|
+
return (options.client ?? this._client).delete({
|
|
2665
|
+
url: "/organizations/{organization}/members/{id}",
|
|
2012
2666
|
...options,
|
|
2667
|
+
headers: {
|
|
2668
|
+
"Content-Type": "application/json",
|
|
2669
|
+
...options.headers,
|
|
2670
|
+
},
|
|
2013
2671
|
});
|
|
2014
2672
|
}
|
|
2015
2673
|
/**
|
|
2016
|
-
* Get an
|
|
2674
|
+
* Get an organization member
|
|
2017
2675
|
*
|
|
2018
2676
|
* ### Authorization
|
|
2019
2677
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2020
2678
|
*
|
|
2021
2679
|
* **Service Token Accesses**
|
|
2022
|
-
* `
|
|
2680
|
+
* `read_organization`
|
|
2023
2681
|
*
|
|
2024
2682
|
* **OAuth Scopes**
|
|
2025
2683
|
*
|
|
2026
2684
|
* | Resource | Scopes |
|
|
2027
2685
|
* | :------- | :---------- |
|
|
2028
|
-
* | Organization | `
|
|
2686
|
+
* | Organization | `read_organization` |
|
|
2029
2687
|
*/
|
|
2030
|
-
|
|
2688
|
+
getOrganizationMembership(options) {
|
|
2031
2689
|
return (options.client ?? this._client).get({
|
|
2032
|
-
url: "/organizations/{organization}/
|
|
2690
|
+
url: "/organizations/{organization}/members/{id}",
|
|
2033
2691
|
...options,
|
|
2034
2692
|
});
|
|
2035
2693
|
}
|
|
2036
2694
|
/**
|
|
2037
|
-
*
|
|
2038
|
-
*
|
|
2695
|
+
* Update organization member role
|
|
2696
|
+
*
|
|
2039
2697
|
* ### Authorization
|
|
2040
2698
|
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2041
2699
|
*
|
|
2042
2700
|
* **Service Token Accesses**
|
|
2043
|
-
* `
|
|
2701
|
+
* `write_organization`
|
|
2044
2702
|
*
|
|
2045
2703
|
* **OAuth Scopes**
|
|
2046
2704
|
*
|
|
2047
2705
|
* | Resource | Scopes |
|
|
2048
2706
|
* | :------- | :---------- |
|
|
2049
|
-
* | Organization | `
|
|
2050
|
-
*/
|
|
2051
|
-
getInvoiceLineItems(options) {
|
|
2052
|
-
return (options.client ?? this._client).get({
|
|
2053
|
-
url: "/organizations/{organization}/invoices/{id}/line-items",
|
|
2054
|
-
...options,
|
|
2055
|
-
});
|
|
2056
|
-
}
|
|
2057
|
-
/**
|
|
2058
|
-
* List organization members
|
|
2059
|
-
*
|
|
2060
|
-
* ### Authorization
|
|
2061
|
-
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2062
|
-
*
|
|
2063
|
-
* **Service Token Accesses**
|
|
2064
|
-
* `read_organization`
|
|
2065
|
-
*
|
|
2066
|
-
*
|
|
2707
|
+
* | Organization | `write_organization` |
|
|
2067
2708
|
*/
|
|
2068
|
-
|
|
2069
|
-
return (options.client ?? this._client).
|
|
2070
|
-
url: "/organizations/{organization}/members",
|
|
2709
|
+
updateOrganizationMembership(options) {
|
|
2710
|
+
return (options.client ?? this._client).patch({
|
|
2711
|
+
url: "/organizations/{organization}/members/{id}",
|
|
2071
2712
|
...options,
|
|
2713
|
+
headers: {
|
|
2714
|
+
"Content-Type": "application/json",
|
|
2715
|
+
...options.headers,
|
|
2716
|
+
},
|
|
2072
2717
|
});
|
|
2073
2718
|
}
|
|
2074
2719
|
/**
|
|
@@ -2177,6 +2822,305 @@ export class PlanetScaleClient extends _HeyApiClient {
|
|
|
2177
2822
|
},
|
|
2178
2823
|
});
|
|
2179
2824
|
}
|
|
2825
|
+
/**
|
|
2826
|
+
* List regions for an organization
|
|
2827
|
+
*
|
|
2828
|
+
* ### Authorization
|
|
2829
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2830
|
+
*
|
|
2831
|
+
* **Service Token Accesses**
|
|
2832
|
+
* `read_organization`
|
|
2833
|
+
*
|
|
2834
|
+
* **OAuth Scopes**
|
|
2835
|
+
*
|
|
2836
|
+
* | Resource | Scopes |
|
|
2837
|
+
* | :------- | :---------- |
|
|
2838
|
+
* | User | `read_organizations` |
|
|
2839
|
+
* | Organization | `read_organization` |
|
|
2840
|
+
*/
|
|
2841
|
+
listRegionsForOrganization(options) {
|
|
2842
|
+
return (options.client ?? this._client).get({
|
|
2843
|
+
url: "/organizations/{organization}/regions",
|
|
2844
|
+
...options,
|
|
2845
|
+
});
|
|
2846
|
+
}
|
|
2847
|
+
/**
|
|
2848
|
+
* List service tokens
|
|
2849
|
+
* List service tokens for an organization.
|
|
2850
|
+
* ### Authorization
|
|
2851
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2852
|
+
*
|
|
2853
|
+
* **Service Token Accesses**
|
|
2854
|
+
* `read_service_tokens`
|
|
2855
|
+
*
|
|
2856
|
+
*
|
|
2857
|
+
*/
|
|
2858
|
+
listServiceTokens(options) {
|
|
2859
|
+
return (options.client ?? this._client).get({
|
|
2860
|
+
url: "/organizations/{organization}/service-tokens",
|
|
2861
|
+
...options,
|
|
2862
|
+
});
|
|
2863
|
+
}
|
|
2864
|
+
/**
|
|
2865
|
+
* Create a service token
|
|
2866
|
+
* Create a new service token for the organization.
|
|
2867
|
+
* ### Authorization
|
|
2868
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2869
|
+
*
|
|
2870
|
+
* **Service Token Accesses**
|
|
2871
|
+
* `write_service_tokens`
|
|
2872
|
+
*
|
|
2873
|
+
*
|
|
2874
|
+
*/
|
|
2875
|
+
createServiceToken(options) {
|
|
2876
|
+
return (options.client ?? this._client).post({
|
|
2877
|
+
url: "/organizations/{organization}/service-tokens",
|
|
2878
|
+
...options,
|
|
2879
|
+
headers: {
|
|
2880
|
+
"Content-Type": "application/json",
|
|
2881
|
+
...options.headers,
|
|
2882
|
+
},
|
|
2883
|
+
});
|
|
2884
|
+
}
|
|
2885
|
+
/**
|
|
2886
|
+
* Delete a service token
|
|
2887
|
+
* Delete a service token from the organization.
|
|
2888
|
+
* ### Authorization
|
|
2889
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2890
|
+
*
|
|
2891
|
+
* **Service Token Accesses**
|
|
2892
|
+
* `delete_service_tokens`
|
|
2893
|
+
*
|
|
2894
|
+
*
|
|
2895
|
+
*/
|
|
2896
|
+
deleteServiceToken(options) {
|
|
2897
|
+
return (options.client ?? this._client).delete({
|
|
2898
|
+
url: "/organizations/{organization}/service-tokens/{id}",
|
|
2899
|
+
...options,
|
|
2900
|
+
});
|
|
2901
|
+
}
|
|
2902
|
+
/**
|
|
2903
|
+
* Get a service token
|
|
2904
|
+
* Get information about a service token.
|
|
2905
|
+
* ### Authorization
|
|
2906
|
+
* A service token must have at least one of the following access in order to use this API endpoint:
|
|
2907
|
+
*
|
|
2908
|
+
* **Service Token Accesses**
|
|
2909
|
+
* `read_service_tokens`
|
|
2910
|
+
*
|
|
2911
|
+
*
|
|
2912
|
+
*/
|
|
2913
|
+
getServiceToken(options) {
|
|
2914
|
+
return (options.client ?? this._client).get({
|
|
2915
|
+
url: "/organizations/{organization}/service-tokens/{id}",
|
|
2916
|
+
...options,
|
|
2917
|
+
});
|
|
2918
|
+
}
|
|
2919
|
+
/**
|
|
2920
|
+
* List teams in an organization
|
|
2921
|
+
*
|
|
2922
|
+
* ### Authorization
|
|
2923
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2924
|
+
*
|
|
2925
|
+
* **Service Token Accesses**
|
|
2926
|
+
* `read_organization`
|
|
2927
|
+
*
|
|
2928
|
+
* **OAuth Scopes**
|
|
2929
|
+
*
|
|
2930
|
+
* | Resource | Scopes |
|
|
2931
|
+
* | :------- | :---------- |
|
|
2932
|
+
* | Organization | `read_organization` |
|
|
2933
|
+
*/
|
|
2934
|
+
listOrganizationTeams(options) {
|
|
2935
|
+
return (options.client ?? this._client).get({
|
|
2936
|
+
url: "/organizations/{organization}/teams",
|
|
2937
|
+
...options,
|
|
2938
|
+
});
|
|
2939
|
+
}
|
|
2940
|
+
/**
|
|
2941
|
+
* Create an organization team
|
|
2942
|
+
*
|
|
2943
|
+
* ### Authorization
|
|
2944
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2945
|
+
*
|
|
2946
|
+
* **Service Token Accesses**
|
|
2947
|
+
* `write_teams`
|
|
2948
|
+
*
|
|
2949
|
+
* **OAuth Scopes**
|
|
2950
|
+
*
|
|
2951
|
+
* | Resource | Scopes |
|
|
2952
|
+
* | :------- | :---------- |
|
|
2953
|
+
* | Organization | `write_organization` |
|
|
2954
|
+
*/
|
|
2955
|
+
createOrganizationTeam(options) {
|
|
2956
|
+
return (options.client ?? this._client).post({
|
|
2957
|
+
url: "/organizations/{organization}/teams",
|
|
2958
|
+
...options,
|
|
2959
|
+
headers: {
|
|
2960
|
+
"Content-Type": "application/json",
|
|
2961
|
+
...options.headers,
|
|
2962
|
+
},
|
|
2963
|
+
});
|
|
2964
|
+
}
|
|
2965
|
+
/**
|
|
2966
|
+
* Delete an organization team
|
|
2967
|
+
*
|
|
2968
|
+
* ### Authorization
|
|
2969
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2970
|
+
*
|
|
2971
|
+
* **Service Token Accesses**
|
|
2972
|
+
* `write_teams`
|
|
2973
|
+
*
|
|
2974
|
+
* **OAuth Scopes**
|
|
2975
|
+
*
|
|
2976
|
+
* | Resource | Scopes |
|
|
2977
|
+
* | :------- | :---------- |
|
|
2978
|
+
* | Organization | `write_organization` |
|
|
2979
|
+
*/
|
|
2980
|
+
deleteOrganizationTeam(options) {
|
|
2981
|
+
return (options.client ?? this._client).delete({
|
|
2982
|
+
url: "/organizations/{organization}/teams/{team}",
|
|
2983
|
+
...options,
|
|
2984
|
+
});
|
|
2985
|
+
}
|
|
2986
|
+
/**
|
|
2987
|
+
* Get an organization team
|
|
2988
|
+
*
|
|
2989
|
+
* ### Authorization
|
|
2990
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
2991
|
+
*
|
|
2992
|
+
* **Service Token Accesses**
|
|
2993
|
+
* `read_organization`
|
|
2994
|
+
*
|
|
2995
|
+
* **OAuth Scopes**
|
|
2996
|
+
*
|
|
2997
|
+
* | Resource | Scopes |
|
|
2998
|
+
* | :------- | :---------- |
|
|
2999
|
+
* | Organization | `read_organization` |
|
|
3000
|
+
*/
|
|
3001
|
+
getOrganizationTeam(options) {
|
|
3002
|
+
return (options.client ?? this._client).get({
|
|
3003
|
+
url: "/organizations/{organization}/teams/{team}",
|
|
3004
|
+
...options,
|
|
3005
|
+
});
|
|
3006
|
+
}
|
|
3007
|
+
/**
|
|
3008
|
+
* Update an organization team
|
|
3009
|
+
*
|
|
3010
|
+
* ### Authorization
|
|
3011
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
3012
|
+
*
|
|
3013
|
+
* **Service Token Accesses**
|
|
3014
|
+
* `write_teams`
|
|
3015
|
+
*
|
|
3016
|
+
* **OAuth Scopes**
|
|
3017
|
+
*
|
|
3018
|
+
* | Resource | Scopes |
|
|
3019
|
+
* | :------- | :---------- |
|
|
3020
|
+
* | Organization | `write_organization` |
|
|
3021
|
+
*/
|
|
3022
|
+
updateOrganizationTeam(options) {
|
|
3023
|
+
return (options.client ?? this._client).patch({
|
|
3024
|
+
url: "/organizations/{organization}/teams/{team}",
|
|
3025
|
+
...options,
|
|
3026
|
+
headers: {
|
|
3027
|
+
"Content-Type": "application/json",
|
|
3028
|
+
...options.headers,
|
|
3029
|
+
},
|
|
3030
|
+
});
|
|
3031
|
+
}
|
|
3032
|
+
/**
|
|
3033
|
+
* List team members
|
|
3034
|
+
*
|
|
3035
|
+
* ### Authorization
|
|
3036
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
3037
|
+
*
|
|
3038
|
+
* **Service Token Accesses**
|
|
3039
|
+
* `read_organization`
|
|
3040
|
+
*
|
|
3041
|
+
* **OAuth Scopes**
|
|
3042
|
+
*
|
|
3043
|
+
* | Resource | Scopes |
|
|
3044
|
+
* | :------- | :---------- |
|
|
3045
|
+
* | Organization | `read_organization` |
|
|
3046
|
+
*/
|
|
3047
|
+
listOrganizationTeamMembers(options) {
|
|
3048
|
+
return (options.client ?? this._client).get({
|
|
3049
|
+
url: "/organizations/{organization}/teams/{team}/members",
|
|
3050
|
+
...options,
|
|
3051
|
+
});
|
|
3052
|
+
}
|
|
3053
|
+
/**
|
|
3054
|
+
* Add a member to a team
|
|
3055
|
+
*
|
|
3056
|
+
* ### Authorization
|
|
3057
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
3058
|
+
*
|
|
3059
|
+
* **Service Token Accesses**
|
|
3060
|
+
* `write_teams`
|
|
3061
|
+
*
|
|
3062
|
+
* **OAuth Scopes**
|
|
3063
|
+
*
|
|
3064
|
+
* | Resource | Scopes |
|
|
3065
|
+
* | :------- | :---------- |
|
|
3066
|
+
* | Organization | `write_organization` |
|
|
3067
|
+
*/
|
|
3068
|
+
addOrganizationTeamMember(options) {
|
|
3069
|
+
return (options.client ?? this._client).post({
|
|
3070
|
+
url: "/organizations/{organization}/teams/{team}/members",
|
|
3071
|
+
...options,
|
|
3072
|
+
headers: {
|
|
3073
|
+
"Content-Type": "application/json",
|
|
3074
|
+
...options.headers,
|
|
3075
|
+
},
|
|
3076
|
+
});
|
|
3077
|
+
}
|
|
3078
|
+
/**
|
|
3079
|
+
* Remove a member from a team
|
|
3080
|
+
*
|
|
3081
|
+
* ### Authorization
|
|
3082
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
3083
|
+
*
|
|
3084
|
+
* **Service Token Accesses**
|
|
3085
|
+
* `write_teams`
|
|
3086
|
+
*
|
|
3087
|
+
* **OAuth Scopes**
|
|
3088
|
+
*
|
|
3089
|
+
* | Resource | Scopes |
|
|
3090
|
+
* | :------- | :---------- |
|
|
3091
|
+
* | Organization | `write_organization` |
|
|
3092
|
+
*/
|
|
3093
|
+
removeOrganizationTeamMember(options) {
|
|
3094
|
+
return (options.client ?? this._client).delete({
|
|
3095
|
+
url: "/organizations/{organization}/teams/{team}/members/{id}",
|
|
3096
|
+
...options,
|
|
3097
|
+
headers: {
|
|
3098
|
+
"Content-Type": "application/json",
|
|
3099
|
+
...options.headers,
|
|
3100
|
+
},
|
|
3101
|
+
});
|
|
3102
|
+
}
|
|
3103
|
+
/**
|
|
3104
|
+
* Get a team member
|
|
3105
|
+
*
|
|
3106
|
+
* ### Authorization
|
|
3107
|
+
* A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
|
|
3108
|
+
*
|
|
3109
|
+
* **Service Token Accesses**
|
|
3110
|
+
* `read_organization`
|
|
3111
|
+
*
|
|
3112
|
+
* **OAuth Scopes**
|
|
3113
|
+
*
|
|
3114
|
+
* | Resource | Scopes |
|
|
3115
|
+
* | :------- | :---------- |
|
|
3116
|
+
* | Organization | `read_organization` |
|
|
3117
|
+
*/
|
|
3118
|
+
getOrganizationTeamMember(options) {
|
|
3119
|
+
return (options.client ?? this._client).get({
|
|
3120
|
+
url: "/organizations/{organization}/teams/{team}/members/{id}",
|
|
3121
|
+
...options,
|
|
3122
|
+
});
|
|
3123
|
+
}
|
|
2180
3124
|
/**
|
|
2181
3125
|
* List public regions
|
|
2182
3126
|
* Endpoint is available without authentication.
|