alchemy 0.83.3 → 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.
Files changed (111) hide show
  1. package/bin/alchemy.js +1 -1
  2. package/lib/cloudflare/api-error.d.ts +11 -0
  3. package/lib/cloudflare/api-error.d.ts.map +1 -1
  4. package/lib/cloudflare/api-error.js +11 -0
  5. package/lib/cloudflare/api-error.js.map +1 -1
  6. package/lib/cloudflare/api.js +1 -1
  7. package/lib/cloudflare/api.js.map +1 -1
  8. package/lib/cloudflare/bindings.d.ts +12 -2
  9. package/lib/cloudflare/bindings.d.ts.map +1 -1
  10. package/lib/cloudflare/bindings.js.map +1 -1
  11. package/lib/cloudflare/bound.d.ts +2 -1
  12. package/lib/cloudflare/bound.d.ts.map +1 -1
  13. package/lib/cloudflare/d1-database.d.ts.map +1 -1
  14. package/lib/cloudflare/d1-database.js +9 -1
  15. package/lib/cloudflare/d1-database.js.map +1 -1
  16. package/lib/cloudflare/index.d.ts +1 -0
  17. package/lib/cloudflare/index.d.ts.map +1 -1
  18. package/lib/cloudflare/index.js +1 -0
  19. package/lib/cloudflare/index.js.map +1 -1
  20. package/lib/cloudflare/kv-namespace.d.ts.map +1 -1
  21. package/lib/cloudflare/kv-namespace.js +2 -2
  22. package/lib/cloudflare/kv-namespace.js.map +1 -1
  23. package/lib/cloudflare/miniflare/build-worker-options.d.ts.map +1 -1
  24. package/lib/cloudflare/miniflare/build-worker-options.js +15 -0
  25. package/lib/cloudflare/miniflare/build-worker-options.js.map +1 -1
  26. package/lib/cloudflare/miniflare/miniflare-controller.d.ts +1 -1
  27. package/lib/cloudflare/miniflare/miniflare-controller.d.ts.map +1 -1
  28. package/lib/cloudflare/miniflare/miniflare-worker-proxy.d.ts.map +1 -1
  29. package/lib/cloudflare/miniflare/miniflare-worker-proxy.js +41 -3
  30. package/lib/cloudflare/miniflare/miniflare-worker-proxy.js.map +1 -1
  31. package/lib/cloudflare/vpc-service.d.ts +288 -0
  32. package/lib/cloudflare/vpc-service.d.ts.map +1 -0
  33. package/lib/cloudflare/vpc-service.js +238 -0
  34. package/lib/cloudflare/vpc-service.js.map +1 -0
  35. package/lib/cloudflare/worker-metadata.d.ts +1 -0
  36. package/lib/cloudflare/worker-metadata.d.ts.map +1 -1
  37. package/lib/cloudflare/worker-metadata.js +8 -0
  38. package/lib/cloudflare/worker-metadata.js.map +1 -1
  39. package/lib/cloudflare/worker-stub.d.ts.map +1 -1
  40. package/lib/cloudflare/worker-stub.js +8 -10
  41. package/lib/cloudflare/worker-stub.js.map +1 -1
  42. package/lib/cloudflare/worker-subdomain.d.ts +11 -8
  43. package/lib/cloudflare/worker-subdomain.d.ts.map +1 -1
  44. package/lib/cloudflare/worker-subdomain.js +16 -25
  45. package/lib/cloudflare/worker-subdomain.js.map +1 -1
  46. package/lib/cloudflare/worker.d.ts +16 -0
  47. package/lib/cloudflare/worker.d.ts.map +1 -1
  48. package/lib/cloudflare/worker.js +50 -24
  49. package/lib/cloudflare/worker.js.map +1 -1
  50. package/lib/cloudflare/wrangler.json.d.ts.map +1 -1
  51. package/lib/cloudflare/wrangler.json.js +9 -0
  52. package/lib/cloudflare/wrangler.json.js.map +1 -1
  53. package/lib/planetscale/api/sdk.gen.d.ts +874 -190
  54. package/lib/planetscale/api/sdk.gen.d.ts.map +1 -1
  55. package/lib/planetscale/api/sdk.gen.js +1250 -306
  56. package/lib/planetscale/api/sdk.gen.js.map +1 -1
  57. package/lib/planetscale/api/types.gen.d.ts +8241 -4128
  58. package/lib/planetscale/api/types.gen.d.ts.map +1 -1
  59. package/lib/planetscale/branch.js +4 -4
  60. package/lib/planetscale/branch.js.map +1 -1
  61. package/lib/planetscale/database.d.ts +43 -24
  62. package/lib/planetscale/database.d.ts.map +1 -1
  63. package/lib/planetscale/database.js +39 -18
  64. package/lib/planetscale/database.js.map +1 -1
  65. package/lib/planetscale/default-role.d.ts +51 -0
  66. package/lib/planetscale/default-role.d.ts.map +1 -0
  67. package/lib/planetscale/default-role.js +100 -0
  68. package/lib/planetscale/default-role.js.map +1 -0
  69. package/lib/planetscale/index.d.ts +1 -0
  70. package/lib/planetscale/index.d.ts.map +1 -1
  71. package/lib/planetscale/index.js +1 -0
  72. package/lib/planetscale/index.js.map +1 -1
  73. package/lib/planetscale/organization.js +1 -1
  74. package/lib/planetscale/organization.js.map +1 -1
  75. package/lib/planetscale/role.d.ts +1 -1
  76. package/lib/planetscale/role.d.ts.map +1 -1
  77. package/lib/planetscale/role.js +1 -1
  78. package/lib/planetscale/role.js.map +1 -1
  79. package/lib/planetscale/utils.d.ts +1 -1
  80. package/lib/planetscale/utils.d.ts.map +1 -1
  81. package/lib/planetscale/utils.js +9 -10
  82. package/lib/planetscale/utils.js.map +1 -1
  83. package/lib/state/sqlite-state-store.js +2 -0
  84. package/lib/state/sqlite-state-store.js.map +1 -1
  85. package/package.json +2 -2
  86. package/src/cloudflare/api-error.ts +19 -0
  87. package/src/cloudflare/api.ts +1 -1
  88. package/src/cloudflare/bindings.ts +15 -2
  89. package/src/cloudflare/bound.ts +6 -3
  90. package/src/cloudflare/d1-database.ts +11 -4
  91. package/src/cloudflare/index.ts +1 -0
  92. package/src/cloudflare/kv-namespace.ts +6 -2
  93. package/src/cloudflare/miniflare/build-worker-options.ts +30 -18
  94. package/src/cloudflare/miniflare/miniflare-worker-proxy.ts +47 -2
  95. package/src/cloudflare/vpc-service.ts +466 -0
  96. package/src/cloudflare/worker-metadata.ts +8 -0
  97. package/src/cloudflare/worker-stub.ts +9 -11
  98. package/src/cloudflare/worker-subdomain.ts +29 -34
  99. package/src/cloudflare/worker.ts +170 -98
  100. package/src/cloudflare/wrangler.json.ts +8 -0
  101. package/src/planetscale/api/sdk.gen.ts +2331 -987
  102. package/src/planetscale/api/types.gen.ts +8980 -4574
  103. package/src/planetscale/branch.ts +4 -4
  104. package/src/planetscale/database.ts +87 -46
  105. package/src/planetscale/default-role.ts +162 -0
  106. package/src/planetscale/index.ts +1 -0
  107. package/src/planetscale/organization.ts +1 -1
  108. package/src/planetscale/role.ts +3 -2
  109. package/src/planetscale/utils.ts +10 -10
  110. package/src/state/sqlite-state-store.ts +2 -0
  111. package/workers/tunnel-proxy.js +1 -1
@@ -7,6 +7,12 @@ import type {
7
7
  } from "../../util/api/client/index.ts";
8
8
  import { client } from "./client.gen.ts";
9
9
  import type {
10
+ AddOrganizationTeamMemberData,
11
+ AddOrganizationTeamMemberErrors,
12
+ AddOrganizationTeamMemberResponses,
13
+ CancelBouncerResizeRequestData,
14
+ CancelBouncerResizeRequestErrors,
15
+ CancelBouncerResizeRequestResponses,
10
16
  CancelBranchChangeRequestData,
11
17
  CancelBranchChangeRequestErrors,
12
18
  CancelBranchChangeRequestResponses,
@@ -28,11 +34,17 @@ import type {
28
34
  CreateBackupData,
29
35
  CreateBackupErrors,
30
36
  CreateBackupResponses,
37
+ CreateBouncerData,
38
+ CreateBouncerErrors,
39
+ CreateBouncerResponses,
31
40
  CreateBranchData,
32
41
  CreateBranchErrors,
33
42
  CreateBranchResponses,
34
43
  CreateDatabaseData,
35
44
  CreateDatabaseErrors,
45
+ CreateDatabasePostgresCidrData,
46
+ CreateDatabasePostgresCidrErrors,
47
+ CreateDatabasePostgresCidrResponses,
36
48
  CreateDatabaseResponses,
37
49
  CreateDeployRequestData,
38
50
  CreateDeployRequestErrors,
@@ -43,6 +55,9 @@ import type {
43
55
  CreateOauthTokenData,
44
56
  CreateOauthTokenErrors,
45
57
  CreateOauthTokenResponses,
58
+ CreateOrganizationTeamData,
59
+ CreateOrganizationTeamErrors,
60
+ CreateOrganizationTeamResponses,
46
61
  CreatePasswordData,
47
62
  CreatePasswordErrors,
48
63
  CreatePasswordResponses,
@@ -52,6 +67,9 @@ import type {
52
67
  CreateRoleData,
53
68
  CreateRoleErrors,
54
69
  CreateRoleResponses,
70
+ CreateServiceTokenData,
71
+ CreateServiceTokenErrors,
72
+ CreateServiceTokenResponses,
55
73
  CreateWebhookData,
56
74
  CreateWebhookErrors,
57
75
  CreateWebhookResponses,
@@ -61,11 +79,17 @@ import type {
61
79
  DeleteBackupData,
62
80
  DeleteBackupErrors,
63
81
  DeleteBackupResponses,
82
+ DeleteBouncerData,
83
+ DeleteBouncerErrors,
84
+ DeleteBouncerResponses,
64
85
  DeleteBranchData,
65
86
  DeleteBranchErrors,
66
87
  DeleteBranchResponses,
67
88
  DeleteDatabaseData,
68
89
  DeleteDatabaseErrors,
90
+ DeleteDatabasePostgresCidrData,
91
+ DeleteDatabasePostgresCidrErrors,
92
+ DeleteDatabasePostgresCidrResponses,
69
93
  DeleteDatabaseResponses,
70
94
  DeleteKeyspaceData,
71
95
  DeleteKeyspaceErrors,
@@ -73,6 +97,9 @@ import type {
73
97
  DeleteOauthTokenData,
74
98
  DeleteOauthTokenErrors,
75
99
  DeleteOauthTokenResponses,
100
+ DeleteOrganizationTeamData,
101
+ DeleteOrganizationTeamErrors,
102
+ DeleteOrganizationTeamResponses,
76
103
  DeletePasswordData,
77
104
  DeletePasswordErrors,
78
105
  DeletePasswordResponses,
@@ -82,6 +109,9 @@ import type {
82
109
  DeleteRoleData,
83
110
  DeleteRoleErrors,
84
111
  DeleteRoleResponses,
112
+ DeleteServiceTokenData,
113
+ DeleteServiceTokenErrors,
114
+ DeleteServiceTokenResponses,
85
115
  DeleteWebhookData,
86
116
  DeleteWebhookErrors,
87
117
  DeleteWebhookResponses,
@@ -91,12 +121,21 @@ import type {
91
121
  DisableSafeMigrationsData,
92
122
  DisableSafeMigrationsErrors,
93
123
  DisableSafeMigrationsResponses,
124
+ DismissSchemaRecommendationData,
125
+ DismissSchemaRecommendationErrors,
126
+ DismissSchemaRecommendationResponses,
94
127
  EnableSafeMigrationsData,
95
128
  EnableSafeMigrationsErrors,
96
129
  EnableSafeMigrationsResponses,
97
130
  GetBackupData,
98
131
  GetBackupErrors,
99
132
  GetBackupResponses,
133
+ GetBouncerData,
134
+ GetBouncerErrors,
135
+ GetBouncerResponses,
136
+ GetBranchChangeRequestData,
137
+ GetBranchChangeRequestErrors,
138
+ GetBranchChangeRequestResponses,
100
139
  GetBranchData,
101
140
  GetBranchErrors,
102
141
  GetBranchResponses,
@@ -108,10 +147,16 @@ import type {
108
147
  GetCurrentUserResponses,
109
148
  GetDatabaseData,
110
149
  GetDatabaseErrors,
150
+ GetDatabasePostgresCidrData,
151
+ GetDatabasePostgresCidrErrors,
152
+ GetDatabasePostgresCidrResponses,
111
153
  GetDatabaseResponses,
112
154
  GetDatabaseThrottlerData,
113
155
  GetDatabaseThrottlerErrors,
114
156
  GetDatabaseThrottlerResponses,
157
+ GetDefaultRoleData,
158
+ GetDefaultRoleErrors,
159
+ GetDefaultRoleResponses,
115
160
  GetDeploymentData,
116
161
  GetDeploymentErrors,
117
162
  GetDeploymentResponses,
@@ -147,7 +192,16 @@ import type {
147
192
  GetOauthTokenResponses,
148
193
  GetOrganizationData,
149
194
  GetOrganizationErrors,
195
+ GetOrganizationMembershipData,
196
+ GetOrganizationMembershipErrors,
197
+ GetOrganizationMembershipResponses,
150
198
  GetOrganizationResponses,
199
+ GetOrganizationTeamData,
200
+ GetOrganizationTeamErrors,
201
+ GetOrganizationTeamMemberData,
202
+ GetOrganizationTeamMemberErrors,
203
+ GetOrganizationTeamMemberResponses,
204
+ GetOrganizationTeamResponses,
151
205
  GetPasswordData,
152
206
  GetPasswordErrors,
153
207
  GetPasswordResponses,
@@ -159,6 +213,12 @@ import type {
159
213
  GetRoleData,
160
214
  GetRoleErrors,
161
215
  GetRoleResponses,
216
+ GetSchemaRecommendationData,
217
+ GetSchemaRecommendationErrors,
218
+ GetSchemaRecommendationResponses,
219
+ GetServiceTokenData,
220
+ GetServiceTokenErrors,
221
+ GetServiceTokenResponses,
162
222
  GetWebhookData,
163
223
  GetWebhookErrors,
164
224
  GetWebhookResponses,
@@ -174,12 +234,27 @@ import type {
174
234
  ListBackupsData,
175
235
  ListBackupsErrors,
176
236
  ListBackupsResponses,
237
+ ListBouncerResizeRequestsData,
238
+ ListBouncerResizeRequestsErrors,
239
+ ListBouncerResizeRequestsResponses,
240
+ ListBouncersData,
241
+ ListBouncersErrors,
242
+ ListBouncersResponses,
243
+ ListBranchBouncerResizeRequestsData,
244
+ ListBranchBouncerResizeRequestsErrors,
245
+ ListBranchBouncerResizeRequestsResponses,
177
246
  ListBranchChangeRequestsData,
178
247
  ListBranchChangeRequestsErrors,
179
248
  ListBranchChangeRequestsResponses,
180
249
  ListBranchesData,
181
250
  ListBranchesErrors,
182
251
  ListBranchesResponses,
252
+ ListClusterSizeSkusData,
253
+ ListClusterSizeSkusErrors,
254
+ ListClusterSizeSkusResponses,
255
+ ListDatabasePostgresCidrsData,
256
+ ListDatabasePostgresCidrsErrors,
257
+ ListDatabasePostgresCidrsResponses,
183
258
  ListDatabaseRegionsData,
184
259
  ListDatabaseRegionsErrors,
185
260
  ListDatabaseRegionsResponses,
@@ -222,6 +297,12 @@ import type {
222
297
  ListOrganizationsData,
223
298
  ListOrganizationsErrors,
224
299
  ListOrganizationsResponses,
300
+ ListOrganizationTeamMembersData,
301
+ ListOrganizationTeamMembersErrors,
302
+ ListOrganizationTeamMembersResponses,
303
+ ListOrganizationTeamsData,
304
+ ListOrganizationTeamsErrors,
305
+ ListOrganizationTeamsResponses,
225
306
  ListParametersData,
226
307
  ListParametersErrors,
227
308
  ListParametersResponses,
@@ -240,6 +321,12 @@ import type {
240
321
  ListRolesData,
241
322
  ListRolesErrors,
242
323
  ListRolesResponses,
324
+ ListSchemaRecommendationsData,
325
+ ListSchemaRecommendationsErrors,
326
+ ListSchemaRecommendationsResponses,
327
+ ListServiceTokensData,
328
+ ListServiceTokensErrors,
329
+ ListServiceTokensResponses,
243
330
  ListWebhooksData,
244
331
  ListWebhooksErrors,
245
332
  ListWebhooksResponses,
@@ -252,12 +339,27 @@ import type {
252
339
  QueueDeployRequestData,
253
340
  QueueDeployRequestErrors,
254
341
  QueueDeployRequestResponses,
342
+ ReassignRoleObjectsData,
343
+ ReassignRoleObjectsErrors,
344
+ ReassignRoleObjectsResponses,
345
+ RemoveOrganizationMemberData,
346
+ RemoveOrganizationMemberErrors,
347
+ RemoveOrganizationMemberResponses,
348
+ RemoveOrganizationTeamMemberData,
349
+ RemoveOrganizationTeamMemberErrors,
350
+ RemoveOrganizationTeamMemberResponses,
255
351
  RenewPasswordData,
256
352
  RenewPasswordErrors,
257
353
  RenewPasswordResponses,
258
354
  RenewRoleData,
259
355
  RenewRoleErrors,
260
356
  RenewRoleResponses,
357
+ ResetDefaultRoleData,
358
+ ResetDefaultRoleErrors,
359
+ ResetDefaultRoleResponses,
360
+ ResetRoleData,
361
+ ResetRoleErrors,
362
+ ResetRoleResponses,
261
363
  ReviewDeployRequestData,
262
364
  ReviewDeployRequestErrors,
263
365
  ReviewDeployRequestResponses,
@@ -270,15 +372,27 @@ import type {
270
372
  UpdateAutoApplyData,
271
373
  UpdateAutoApplyErrors,
272
374
  UpdateAutoApplyResponses,
375
+ UpdateAutoDeleteBranchData,
376
+ UpdateAutoDeleteBranchErrors,
377
+ UpdateAutoDeleteBranchResponses,
273
378
  UpdateBackupData,
274
379
  UpdateBackupErrors,
275
380
  UpdateBackupResponses,
381
+ UpdateBouncerResizeRequestData,
382
+ UpdateBouncerResizeRequestErrors,
383
+ UpdateBouncerResizeRequestResponses,
276
384
  UpdateBranchChangeRequestData,
277
385
  UpdateBranchChangeRequestErrors,
278
386
  UpdateBranchChangeRequestResponses,
279
387
  UpdateBranchClusterConfigData,
280
388
  UpdateBranchClusterConfigErrors,
281
389
  UpdateBranchClusterConfigResponses,
390
+ UpdateBranchData,
391
+ UpdateBranchErrors,
392
+ UpdateBranchResponses,
393
+ UpdateDatabasePostgresCidrData,
394
+ UpdateDatabasePostgresCidrErrors,
395
+ UpdateDatabasePostgresCidrResponses,
282
396
  UpdateDatabaseSettingsData,
283
397
  UpdateDatabaseSettingsErrors,
284
398
  UpdateDatabaseSettingsResponses,
@@ -296,7 +410,13 @@ import type {
296
410
  UpdateKeyspaceVschemaResponses,
297
411
  UpdateOrganizationData,
298
412
  UpdateOrganizationErrors,
413
+ UpdateOrganizationMembershipData,
414
+ UpdateOrganizationMembershipErrors,
415
+ UpdateOrganizationMembershipResponses,
299
416
  UpdateOrganizationResponses,
417
+ UpdateOrganizationTeamData,
418
+ UpdateOrganizationTeamErrors,
419
+ UpdateOrganizationTeamResponses,
300
420
  UpdatePasswordData,
301
421
  UpdatePasswordErrors,
302
422
  UpdatePasswordResponses,
@@ -412,7 +532,7 @@ export class PlanetScaleClient extends _HeyApiClient {
412
532
  GetOrganizationErrors,
413
533
  ThrowOnError
414
534
  >({
415
- url: "/organizations/{name}",
535
+ url: "/organizations/{organization}",
416
536
  ...options,
417
537
  });
418
538
  }
@@ -437,7 +557,7 @@ export class PlanetScaleClient extends _HeyApiClient {
437
557
  UpdateOrganizationErrors,
438
558
  ThrowOnError
439
559
  >({
440
- url: "/organizations/{name}",
560
+ url: "/organizations/{organization}",
441
561
  ...options,
442
562
  headers: {
443
563
  "Content-Type": "application/json",
@@ -465,14 +585,14 @@ export class PlanetScaleClient extends _HeyApiClient {
465
585
  ListAuditLogsErrors,
466
586
  ThrowOnError
467
587
  >({
468
- url: "/organizations/{name}/audit-log",
588
+ url: "/organizations/{organization}/audit-log",
469
589
  ...options,
470
590
  });
471
591
  }
472
592
 
473
593
  /**
474
- * List regions for an organization
475
- *
594
+ * List available cluster sizes
595
+ * List available cluster sizes for an organization
476
596
  * ### Authorization
477
597
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
478
598
  *
@@ -486,15 +606,15 @@ export class PlanetScaleClient extends _HeyApiClient {
486
606
  * | User | `read_organizations` |
487
607
  * | Organization | `read_organization` |
488
608
  */
489
- public listRegionsForOrganization<ThrowOnError extends boolean = true>(
490
- options: Options<ListRegionsForOrganizationData, ThrowOnError>,
609
+ public listClusterSizeSkus<ThrowOnError extends boolean = true>(
610
+ options: Options<ListClusterSizeSkusData, ThrowOnError>,
491
611
  ) {
492
612
  return (options.client ?? this._client).get<
493
- ListRegionsForOrganizationResponses,
494
- ListRegionsForOrganizationErrors,
613
+ ListClusterSizeSkusResponses,
614
+ ListClusterSizeSkusErrors,
495
615
  ThrowOnError
496
616
  >({
497
- url: "/organizations/{name}/regions",
617
+ url: "/organizations/{organization}/cluster-size-skus",
498
618
  ...options,
499
619
  });
500
620
  }
@@ -506,7 +626,7 @@ export class PlanetScaleClient extends _HeyApiClient {
506
626
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
507
627
  *
508
628
  * **Service Token Accesses**
509
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `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`
629
+ * `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`
510
630
  *
511
631
  * **OAuth Scopes**
512
632
  *
@@ -559,6 +679,97 @@ export class PlanetScaleClient extends _HeyApiClient {
559
679
  });
560
680
  }
561
681
 
682
+ /**
683
+ * Delete a database
684
+ *
685
+ * ### Authorization
686
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
687
+ *
688
+ * **Service Token Accesses**
689
+ * `delete_database`
690
+ *
691
+ * **OAuth Scopes**
692
+ *
693
+ * | Resource | Scopes |
694
+ * | :------- | :---------- |
695
+ * | Organization | `delete_databases` |
696
+ * | Database | `delete_database` |
697
+ */
698
+ public deleteDatabase<ThrowOnError extends boolean = true>(
699
+ options: Options<DeleteDatabaseData, ThrowOnError>,
700
+ ) {
701
+ return (options.client ?? this._client).delete<
702
+ DeleteDatabaseResponses,
703
+ DeleteDatabaseErrors,
704
+ ThrowOnError
705
+ >({
706
+ url: "/organizations/{organization}/databases/{database}",
707
+ ...options,
708
+ });
709
+ }
710
+
711
+ /**
712
+ * Get a database
713
+ *
714
+ * ### Authorization
715
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
716
+ *
717
+ * **Service Token Accesses**
718
+ * `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`
719
+ *
720
+ * **OAuth Scopes**
721
+ *
722
+ * | Resource | Scopes |
723
+ * | :------- | :---------- |
724
+ * | Organization | `read_databases` |
725
+ * | Database | `read_database` |
726
+ */
727
+ public getDatabase<ThrowOnError extends boolean = true>(
728
+ options: Options<GetDatabaseData, ThrowOnError>,
729
+ ) {
730
+ return (options.client ?? this._client).get<
731
+ GetDatabaseResponses,
732
+ GetDatabaseErrors,
733
+ ThrowOnError
734
+ >({
735
+ url: "/organizations/{organization}/databases/{database}",
736
+ ...options,
737
+ });
738
+ }
739
+
740
+ /**
741
+ * Update database settings
742
+ *
743
+ * ### Authorization
744
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
745
+ *
746
+ * **Service Token Accesses**
747
+ * `write_database`
748
+ *
749
+ * **OAuth Scopes**
750
+ *
751
+ * | Resource | Scopes |
752
+ * | :------- | :---------- |
753
+ * | Organization | `write_databases` |
754
+ * | Database | `write_database` |
755
+ */
756
+ public updateDatabaseSettings<ThrowOnError extends boolean = true>(
757
+ options: Options<UpdateDatabaseSettingsData, ThrowOnError>,
758
+ ) {
759
+ return (options.client ?? this._client).patch<
760
+ UpdateDatabaseSettingsResponses,
761
+ UpdateDatabaseSettingsErrors,
762
+ ThrowOnError
763
+ >({
764
+ url: "/organizations/{organization}/databases/{database}",
765
+ ...options,
766
+ headers: {
767
+ "Content-Type": "application/json",
768
+ ...options.headers,
769
+ },
770
+ });
771
+ }
772
+
562
773
  /**
563
774
  * List branches
564
775
  *
@@ -623,6 +834,100 @@ export class PlanetScaleClient extends _HeyApiClient {
623
834
  });
624
835
  }
625
836
 
837
+ /**
838
+ * Delete a branch
839
+ *
840
+ * ### Authorization
841
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
842
+ *
843
+ * **Service Token Accesses**
844
+ * `delete_branch`
845
+ *
846
+ * **OAuth Scopes**
847
+ *
848
+ * | Resource | Scopes |
849
+ * | :------- | :---------- |
850
+ * | Organization | `delete_branches`, `delete_production_branches` |
851
+ * | Database | `delete_branches`, `delete_production_branches` |
852
+ * | Branch | `delete_branch` |
853
+ */
854
+ public deleteBranch<ThrowOnError extends boolean = true>(
855
+ options: Options<DeleteBranchData, ThrowOnError>,
856
+ ) {
857
+ return (options.client ?? this._client).delete<
858
+ DeleteBranchResponses,
859
+ DeleteBranchErrors,
860
+ ThrowOnError
861
+ >({
862
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}",
863
+ ...options,
864
+ });
865
+ }
866
+
867
+ /**
868
+ * Get a branch
869
+ *
870
+ * ### Authorization
871
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
872
+ *
873
+ * **Service Token Accesses**
874
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
875
+ *
876
+ * **OAuth Scopes**
877
+ *
878
+ * | Resource | Scopes |
879
+ * | :------- | :---------- |
880
+ * | Organization | `read_branches` |
881
+ * | Database | `read_branches` |
882
+ * | Branch | `read_branch` |
883
+ */
884
+ public getBranch<ThrowOnError extends boolean = true>(
885
+ options: Options<GetBranchData, ThrowOnError>,
886
+ ) {
887
+ return (options.client ?? this._client).get<
888
+ GetBranchResponses,
889
+ GetBranchErrors,
890
+ ThrowOnError
891
+ >({
892
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}",
893
+ ...options,
894
+ });
895
+ }
896
+
897
+ /**
898
+ * Update a branch
899
+ *
900
+ * ### Authorization
901
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
902
+ *
903
+ * **Service Token Accesses**
904
+ * `write_database`
905
+ *
906
+ * **OAuth Scopes**
907
+ *
908
+ * | Resource | Scopes |
909
+ * | :------- | :---------- |
910
+ * | Organization | `write_branches` |
911
+ * | Database | `write_branches` |
912
+ * | Branch | `write_branch` |
913
+ */
914
+ public updateBranch<ThrowOnError extends boolean = true>(
915
+ options: Options<UpdateBranchData, ThrowOnError>,
916
+ ) {
917
+ return (options.client ?? this._client).patch<
918
+ UpdateBranchResponses,
919
+ UpdateBranchErrors,
920
+ ThrowOnError
921
+ >({
922
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}",
923
+ ...options,
924
+ headers: {
925
+ "Content-Type": "application/json",
926
+ ...options.headers,
927
+ },
928
+ });
929
+ }
930
+
626
931
  /**
627
932
  * List backups
628
933
  *
@@ -782,7 +1087,7 @@ export class PlanetScaleClient extends _HeyApiClient {
782
1087
  }
783
1088
 
784
1089
  /**
785
- * Get branch change requests
1090
+ * Get bouncer resize requests
786
1091
  *
787
1092
  * ### Authorization
788
1093
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
@@ -798,21 +1103,51 @@ export class PlanetScaleClient extends _HeyApiClient {
798
1103
  * | Database | `read_branches` |
799
1104
  * | Branch | `read_branch` |
800
1105
  */
801
- public listBranchChangeRequests<ThrowOnError extends boolean = true>(
802
- options: Options<ListBranchChangeRequestsData, ThrowOnError>,
1106
+ public listBranchBouncerResizeRequests<ThrowOnError extends boolean = true>(
1107
+ options: Options<ListBranchBouncerResizeRequestsData, ThrowOnError>,
803
1108
  ) {
804
1109
  return (options.client ?? this._client).get<
805
- ListBranchChangeRequestsResponses,
806
- ListBranchChangeRequestsErrors,
1110
+ ListBranchBouncerResizeRequestsResponses,
1111
+ ListBranchBouncerResizeRequestsErrors,
807
1112
  ThrowOnError
808
1113
  >({
809
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes",
1114
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncer-resizes",
810
1115
  ...options,
811
1116
  });
812
1117
  }
813
1118
 
814
1119
  /**
815
- * Upsert a change request
1120
+ * List bouncers
1121
+ *
1122
+ * ### Authorization
1123
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1124
+ *
1125
+ * **Service Token Accesses**
1126
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1127
+ *
1128
+ * **OAuth Scopes**
1129
+ *
1130
+ * | Resource | Scopes |
1131
+ * | :------- | :---------- |
1132
+ * | Organization | `read_branches` |
1133
+ * | Database | `read_branches` |
1134
+ * | Branch | `read_branch` |
1135
+ */
1136
+ public listBouncers<ThrowOnError extends boolean = true>(
1137
+ options: Options<ListBouncersData, ThrowOnError>,
1138
+ ) {
1139
+ return (options.client ?? this._client).get<
1140
+ ListBouncersResponses,
1141
+ ListBouncersErrors,
1142
+ ThrowOnError
1143
+ >({
1144
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers",
1145
+ ...options,
1146
+ });
1147
+ }
1148
+
1149
+ /**
1150
+ * Create a bouncer
816
1151
  *
817
1152
  * ### Authorization
818
1153
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
@@ -827,15 +1162,15 @@ export class PlanetScaleClient extends _HeyApiClient {
827
1162
  * | Organization | `write_databases` |
828
1163
  * | Database | `write_database` |
829
1164
  */
830
- public updateBranchChangeRequest<ThrowOnError extends boolean = true>(
831
- options: Options<UpdateBranchChangeRequestData, ThrowOnError>,
1165
+ public createBouncer<ThrowOnError extends boolean = true>(
1166
+ options: Options<CreateBouncerData, ThrowOnError>,
832
1167
  ) {
833
- return (options.client ?? this._client).patch<
834
- UpdateBranchChangeRequestResponses,
835
- UpdateBranchChangeRequestErrors,
1168
+ return (options.client ?? this._client).post<
1169
+ CreateBouncerResponses,
1170
+ CreateBouncerErrors,
836
1171
  ThrowOnError
837
1172
  >({
838
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes",
1173
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers",
839
1174
  ...options,
840
1175
  headers: {
841
1176
  "Content-Type": "application/json",
@@ -845,119 +1180,148 @@ export class PlanetScaleClient extends _HeyApiClient {
845
1180
  }
846
1181
 
847
1182
  /**
848
- * List cluster extensions
1183
+ * Delete a bouncer
849
1184
  *
850
1185
  * ### Authorization
851
1186
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
852
1187
  *
853
1188
  * **Service Token Accesses**
854
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1189
+ * `write_database`
855
1190
  *
856
1191
  * **OAuth Scopes**
857
1192
  *
858
1193
  * | Resource | Scopes |
859
1194
  * | :------- | :---------- |
860
- * | Organization | `read_branches` |
861
- * | Database | `read_branches` |
862
- * | Branch | `read_branch` |
1195
+ * | Organization | `write_databases` |
1196
+ * | Database | `write_database` |
863
1197
  */
864
- public listExtensions<ThrowOnError extends boolean = true>(
865
- options: Options<ListExtensionsData, ThrowOnError>,
1198
+ public deleteBouncer<ThrowOnError extends boolean = true>(
1199
+ options: Options<DeleteBouncerData, ThrowOnError>,
866
1200
  ) {
867
- return (options.client ?? this._client).get<
868
- ListExtensionsResponses,
869
- ListExtensionsErrors,
1201
+ return (options.client ?? this._client).delete<
1202
+ DeleteBouncerResponses,
1203
+ DeleteBouncerErrors,
870
1204
  ThrowOnError
871
1205
  >({
872
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/extensions",
1206
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}",
873
1207
  ...options,
874
1208
  });
875
1209
  }
876
1210
 
877
1211
  /**
878
- * Get keyspaces
1212
+ * Get a bouncer
1213
+ *
1214
+ * ### Authorization
1215
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1216
+ *
1217
+ * **Service Token Accesses**
1218
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
879
1219
  *
1220
+ * **OAuth Scopes**
880
1221
  *
1222
+ * | Resource | Scopes |
1223
+ * | :------- | :---------- |
1224
+ * | Organization | `read_branches` |
1225
+ * | Database | `read_branches` |
1226
+ * | Branch | `read_branch` |
881
1227
  */
882
- public listKeyspaces<ThrowOnError extends boolean = true>(
883
- options: Options<ListKeyspacesData, ThrowOnError>,
1228
+ public getBouncer<ThrowOnError extends boolean = true>(
1229
+ options: Options<GetBouncerData, ThrowOnError>,
884
1230
  ) {
885
1231
  return (options.client ?? this._client).get<
886
- ListKeyspacesResponses,
887
- ListKeyspacesErrors,
1232
+ GetBouncerResponses,
1233
+ GetBouncerErrors,
888
1234
  ThrowOnError
889
1235
  >({
890
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces",
1236
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}",
891
1237
  ...options,
892
1238
  });
893
1239
  }
894
1240
 
895
1241
  /**
896
- * Create a keyspace
1242
+ * Cancel a resize request
897
1243
  *
1244
+ * ### Authorization
1245
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
898
1246
  *
899
- */
900
- public createKeyspace<ThrowOnError extends boolean = true>(
901
- options: Options<CreateKeyspaceData, ThrowOnError>,
902
- ) {
903
- return (options.client ?? this._client).post<
904
- CreateKeyspaceResponses,
905
- CreateKeyspaceErrors,
1247
+ * **Service Token Accesses**
1248
+ * `write_database`
1249
+ *
1250
+ * **OAuth Scopes**
1251
+ *
1252
+ * | Resource | Scopes |
1253
+ * | :------- | :---------- |
1254
+ * | Organization | `write_databases` |
1255
+ * | Database | `write_database` |
1256
+ */
1257
+ public cancelBouncerResizeRequest<ThrowOnError extends boolean = true>(
1258
+ options: Options<CancelBouncerResizeRequestData, ThrowOnError>,
1259
+ ) {
1260
+ return (options.client ?? this._client).delete<
1261
+ CancelBouncerResizeRequestResponses,
1262
+ CancelBouncerResizeRequestErrors,
906
1263
  ThrowOnError
907
1264
  >({
908
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces",
1265
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes",
909
1266
  ...options,
910
- headers: {
911
- "Content-Type": "application/json",
912
- ...options.headers,
913
- },
914
1267
  });
915
1268
  }
916
1269
 
917
1270
  /**
918
- * Get the VSchema for the keyspace
1271
+ * Get bouncer resize requests
919
1272
  *
920
1273
  * ### Authorization
921
- * A service token must have at least one of the following access in order to use this API endpoint:
1274
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
922
1275
  *
923
1276
  * **Service Token Accesses**
924
1277
  * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
925
1278
  *
1279
+ * **OAuth Scopes**
926
1280
  *
1281
+ * | Resource | Scopes |
1282
+ * | :------- | :---------- |
1283
+ * | Organization | `read_branches` |
1284
+ * | Database | `read_branches` |
1285
+ * | Branch | `read_branch` |
927
1286
  */
928
- public getKeyspaceVschema<ThrowOnError extends boolean = true>(
929
- options: Options<GetKeyspaceVschemaData, ThrowOnError>,
1287
+ public listBouncerResizeRequests<ThrowOnError extends boolean = true>(
1288
+ options: Options<ListBouncerResizeRequestsData, ThrowOnError>,
930
1289
  ) {
931
1290
  return (options.client ?? this._client).get<
932
- GetKeyspaceVschemaResponses,
933
- GetKeyspaceVschemaErrors,
1291
+ ListBouncerResizeRequestsResponses,
1292
+ ListBouncerResizeRequestsErrors,
934
1293
  ThrowOnError
935
1294
  >({
936
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema",
1295
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes",
937
1296
  ...options,
938
1297
  });
939
1298
  }
940
1299
 
941
1300
  /**
942
- * Update the VSchema for the keyspace
1301
+ * Upsert a bouncer resize request
943
1302
  *
944
1303
  * ### Authorization
945
- * A service token must have at least one of the following access in order to use this API endpoint:
1304
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
946
1305
  *
947
1306
  * **Service Token Accesses**
948
- * `write_production_branch_vschema`, `write_branch_vschema`
1307
+ * `write_database`
949
1308
  *
1309
+ * **OAuth Scopes**
950
1310
  *
1311
+ * | Resource | Scopes |
1312
+ * | :------- | :---------- |
1313
+ * | Organization | `write_databases` |
1314
+ * | Database | `write_database` |
951
1315
  */
952
- public updateKeyspaceVschema<ThrowOnError extends boolean = true>(
953
- options: Options<UpdateKeyspaceVschemaData, ThrowOnError>,
1316
+ public updateBouncerResizeRequest<ThrowOnError extends boolean = true>(
1317
+ options: Options<UpdateBouncerResizeRequestData, ThrowOnError>,
954
1318
  ) {
955
1319
  return (options.client ?? this._client).patch<
956
- UpdateKeyspaceVschemaResponses,
957
- UpdateKeyspaceVschemaErrors,
1320
+ UpdateBouncerResizeRequestResponses,
1321
+ UpdateBouncerResizeRequestErrors,
958
1322
  ThrowOnError
959
1323
  >({
960
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema",
1324
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/bouncers/{bouncer}/resizes",
961
1325
  ...options,
962
1326
  headers: {
963
1327
  "Content-Type": "application/json",
@@ -967,79 +1331,70 @@ export class PlanetScaleClient extends _HeyApiClient {
967
1331
  }
968
1332
 
969
1333
  /**
970
- * Delete a keyspace
1334
+ * Get branch change requests
971
1335
  *
1336
+ * ### Authorization
1337
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
972
1338
  *
973
- */
974
- public deleteKeyspace<ThrowOnError extends boolean = true>(
975
- options: Options<DeleteKeyspaceData, ThrowOnError>,
976
- ) {
977
- return (options.client ?? this._client).delete<
978
- DeleteKeyspaceResponses,
979
- DeleteKeyspaceErrors,
980
- ThrowOnError
981
- >({
982
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name}",
983
- ...options,
984
- });
985
- }
986
-
987
- /**
988
- * Get a keyspace
1339
+ * **Service Token Accesses**
1340
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
989
1341
  *
1342
+ * **OAuth Scopes**
990
1343
  *
1344
+ * | Resource | Scopes |
1345
+ * | :------- | :---------- |
1346
+ * | Organization | `read_branches` |
1347
+ * | Database | `read_branches` |
1348
+ * | Branch | `read_branch` |
991
1349
  */
992
- public getKeyspace<ThrowOnError extends boolean = true>(
993
- options: Options<GetKeyspaceData, ThrowOnError>,
1350
+ public listBranchChangeRequests<ThrowOnError extends boolean = true>(
1351
+ options: Options<ListBranchChangeRequestsData, ThrowOnError>,
994
1352
  ) {
995
1353
  return (options.client ?? this._client).get<
996
- GetKeyspaceResponses,
997
- GetKeyspaceErrors,
1354
+ ListBranchChangeRequestsResponses,
1355
+ ListBranchChangeRequestsErrors,
998
1356
  ThrowOnError
999
1357
  >({
1000
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name}",
1358
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes",
1001
1359
  ...options,
1002
1360
  });
1003
1361
  }
1004
1362
 
1005
1363
  /**
1006
- * Configure keyspace settings
1364
+ * Upsert a change request
1007
1365
  *
1366
+ * ### Authorization
1367
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1008
1368
  *
1009
- */
1010
- public updateKeyspace<ThrowOnError extends boolean = true>(
1011
- options: Options<UpdateKeyspaceData, ThrowOnError>,
1012
- ) {
1013
- return (options.client ?? this._client).patch<
1014
- UpdateKeyspaceResponses,
1015
- UpdateKeyspaceErrors,
1016
- ThrowOnError
1017
- >({
1018
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name}",
1019
- ...options,
1020
- });
1021
- }
1022
-
1023
- /**
1024
- * Get keyspace rollout status
1369
+ * **Service Token Accesses**
1370
+ * `write_database`
1025
1371
  *
1372
+ * **OAuth Scopes**
1026
1373
  *
1374
+ * | Resource | Scopes |
1375
+ * | :------- | :---------- |
1376
+ * | Organization | `write_databases` |
1377
+ * | Database | `write_database` |
1027
1378
  */
1028
- public getKeyspaceRolloutStatus<ThrowOnError extends boolean = true>(
1029
- options: Options<GetKeyspaceRolloutStatusData, ThrowOnError>,
1379
+ public updateBranchChangeRequest<ThrowOnError extends boolean = true>(
1380
+ options: Options<UpdateBranchChangeRequestData, ThrowOnError>,
1030
1381
  ) {
1031
- return (options.client ?? this._client).get<
1032
- GetKeyspaceRolloutStatusResponses,
1033
- GetKeyspaceRolloutStatusErrors,
1382
+ return (options.client ?? this._client).patch<
1383
+ UpdateBranchChangeRequestResponses,
1384
+ UpdateBranchChangeRequestErrors,
1034
1385
  ThrowOnError
1035
1386
  >({
1036
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{name}/rollout-status",
1387
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes",
1037
1388
  ...options,
1389
+ headers: {
1390
+ "Content-Type": "application/json",
1391
+ ...options.headers,
1392
+ },
1038
1393
  });
1039
1394
  }
1040
1395
 
1041
1396
  /**
1042
- * List cluster parameters
1397
+ * Get a branch change request
1043
1398
  *
1044
1399
  * ### Authorization
1045
1400
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
@@ -1055,169 +1410,150 @@ export class PlanetScaleClient extends _HeyApiClient {
1055
1410
  * | Database | `read_branches` |
1056
1411
  * | Branch | `read_branch` |
1057
1412
  */
1058
- public listParameters<ThrowOnError extends boolean = true>(
1059
- options: Options<ListParametersData, ThrowOnError>,
1413
+ public getBranchChangeRequest<ThrowOnError extends boolean = true>(
1414
+ options: Options<GetBranchChangeRequestData, ThrowOnError>,
1060
1415
  ) {
1061
1416
  return (options.client ?? this._client).get<
1062
- ListParametersResponses,
1063
- ListParametersErrors,
1417
+ GetBranchChangeRequestResponses,
1418
+ GetBranchChangeRequestErrors,
1064
1419
  ThrowOnError
1065
1420
  >({
1066
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/parameters",
1421
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/changes/{id}",
1067
1422
  ...options,
1068
1423
  });
1069
1424
  }
1070
1425
 
1071
1426
  /**
1072
- * List passwords
1427
+ * Change a branch cluster configuration
1073
1428
  *
1074
1429
  * ### Authorization
1075
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1430
+ * A service token must have at least one of the following access in order to use this API endpoint:
1076
1431
  *
1077
1432
  * **Service Token Accesses**
1078
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1433
+ * `write_database`
1079
1434
  *
1080
- * **OAuth Scopes**
1081
1435
  *
1082
- * | Resource | Scopes |
1083
- * | :------- | :---------- |
1084
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1085
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1086
- * | Branch | `manage_passwords` |
1087
1436
  */
1088
- public listPasswords<ThrowOnError extends boolean = true>(
1089
- options: Options<ListPasswordsData, ThrowOnError>,
1437
+ public updateBranchClusterConfig<ThrowOnError extends boolean = true>(
1438
+ options: Options<UpdateBranchClusterConfigData, ThrowOnError>,
1090
1439
  ) {
1091
- return (options.client ?? this._client).get<
1092
- ListPasswordsResponses,
1093
- ListPasswordsErrors,
1440
+ return (options.client ?? this._client).patch<
1441
+ UpdateBranchClusterConfigResponses,
1442
+ UpdateBranchClusterConfigErrors,
1094
1443
  ThrowOnError
1095
1444
  >({
1096
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords",
1445
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/cluster",
1097
1446
  ...options,
1447
+ headers: {
1448
+ "Content-Type": "application/json",
1449
+ ...options.headers,
1450
+ },
1098
1451
  });
1099
1452
  }
1100
1453
 
1101
1454
  /**
1102
- * Create a password
1103
- *
1455
+ * Demote a branch
1456
+ * Demotes a branch from production to development
1104
1457
  * ### Authorization
1105
1458
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1106
1459
  *
1107
1460
  * **Service Token Accesses**
1108
- * `connect_production_branch`, `connect_branch`
1461
+ * `connect_production_branch`, `demote_branches`
1109
1462
  *
1110
1463
  * **OAuth Scopes**
1111
1464
  *
1112
1465
  * | Resource | Scopes |
1113
1466
  * | :------- | :---------- |
1114
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1115
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1116
- * | Branch | `manage_passwords` |
1467
+ * | Organization | `demote_branches` |
1468
+ * | Database | `demote_branches` |
1117
1469
  */
1118
- public createPassword<ThrowOnError extends boolean = true>(
1119
- options: Options<CreatePasswordData, ThrowOnError>,
1470
+ public demoteBranch<ThrowOnError extends boolean = true>(
1471
+ options: Options<DemoteBranchData, ThrowOnError>,
1120
1472
  ) {
1121
1473
  return (options.client ?? this._client).post<
1122
- CreatePasswordResponses,
1123
- CreatePasswordErrors,
1474
+ DemoteBranchResponses,
1475
+ DemoteBranchErrors,
1124
1476
  ThrowOnError
1125
1477
  >({
1126
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords",
1478
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/demote",
1127
1479
  ...options,
1128
- headers: {
1129
- "Content-Type": "application/json",
1130
- ...options.headers,
1131
- },
1132
1480
  });
1133
1481
  }
1134
1482
 
1135
1483
  /**
1136
- * Delete a password
1484
+ * List cluster extensions
1137
1485
  *
1138
1486
  * ### Authorization
1139
1487
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1140
1488
  *
1141
1489
  * **Service Token Accesses**
1142
- * `delete_production_branch_password`, `delete_branch_password`
1490
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1143
1491
  *
1144
1492
  * **OAuth Scopes**
1145
1493
  *
1146
1494
  * | Resource | Scopes |
1147
1495
  * | :------- | :---------- |
1148
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1149
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1150
- * | Branch | `manage_passwords` |
1496
+ * | Organization | `read_branches` |
1497
+ * | Database | `read_branches` |
1498
+ * | Branch | `read_branch` |
1151
1499
  */
1152
- public deletePassword<ThrowOnError extends boolean = true>(
1153
- options: Options<DeletePasswordData, ThrowOnError>,
1500
+ public listExtensions<ThrowOnError extends boolean = true>(
1501
+ options: Options<ListExtensionsData, ThrowOnError>,
1154
1502
  ) {
1155
- return (options.client ?? this._client).delete<
1156
- DeletePasswordResponses,
1157
- DeletePasswordErrors,
1503
+ return (options.client ?? this._client).get<
1504
+ ListExtensionsResponses,
1505
+ ListExtensionsErrors,
1158
1506
  ThrowOnError
1159
1507
  >({
1160
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}",
1508
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/extensions",
1161
1509
  ...options,
1162
1510
  });
1163
1511
  }
1164
1512
 
1165
1513
  /**
1166
- * Get a password
1514
+ * Get keyspaces
1167
1515
  *
1168
1516
  * ### Authorization
1169
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1517
+ * A service token must have at least one of the following access in order to use this API endpoint:
1170
1518
  *
1171
1519
  * **Service Token Accesses**
1172
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1520
+ * `read_branch`
1173
1521
  *
1174
- * **OAuth Scopes**
1175
1522
  *
1176
- * | Resource | Scopes |
1177
- * | :------- | :---------- |
1178
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1179
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1180
- * | Branch | `manage_passwords` |
1181
1523
  */
1182
- public getPassword<ThrowOnError extends boolean = true>(
1183
- options: Options<GetPasswordData, ThrowOnError>,
1524
+ public listKeyspaces<ThrowOnError extends boolean = true>(
1525
+ options: Options<ListKeyspacesData, ThrowOnError>,
1184
1526
  ) {
1185
1527
  return (options.client ?? this._client).get<
1186
- GetPasswordResponses,
1187
- GetPasswordErrors,
1528
+ ListKeyspacesResponses,
1529
+ ListKeyspacesErrors,
1188
1530
  ThrowOnError
1189
1531
  >({
1190
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}",
1532
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces",
1191
1533
  ...options,
1192
1534
  });
1193
1535
  }
1194
1536
 
1195
1537
  /**
1196
- * Update a password
1538
+ * Create a keyspace
1197
1539
  *
1198
1540
  * ### Authorization
1199
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1541
+ * A service token must have at least one of the following access in order to use this API endpoint:
1200
1542
  *
1201
1543
  * **Service Token Accesses**
1202
- * `connect_production_branch`, `connect_branch`
1544
+ * `create_branch`
1203
1545
  *
1204
- * **OAuth Scopes**
1205
1546
  *
1206
- * | Resource | Scopes |
1207
- * | :------- | :---------- |
1208
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1209
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1210
- * | Branch | `manage_passwords` |
1211
1547
  */
1212
- public updatePassword<ThrowOnError extends boolean = true>(
1213
- options: Options<UpdatePasswordData, ThrowOnError>,
1548
+ public createKeyspace<ThrowOnError extends boolean = true>(
1549
+ options: Options<CreateKeyspaceData, ThrowOnError>,
1214
1550
  ) {
1215
- return (options.client ?? this._client).patch<
1216
- UpdatePasswordResponses,
1217
- UpdatePasswordErrors,
1551
+ return (options.client ?? this._client).post<
1552
+ CreateKeyspaceResponses,
1553
+ CreateKeyspaceErrors,
1218
1554
  ThrowOnError
1219
1555
  >({
1220
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}",
1556
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces",
1221
1557
  ...options,
1222
1558
  headers: {
1223
1559
  "Content-Type": "application/json",
@@ -1227,270 +1563,240 @@ export class PlanetScaleClient extends _HeyApiClient {
1227
1563
  }
1228
1564
 
1229
1565
  /**
1230
- * Renew a password
1566
+ * Delete a keyspace
1231
1567
  *
1232
1568
  * ### Authorization
1233
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1569
+ * A service token must have at least one of the following access in order to use this API endpoint:
1234
1570
  *
1235
1571
  * **Service Token Accesses**
1236
- * `connect_production_branch`, `connect_branch`
1572
+ * `delete_branch`, `delete_production_branch`
1237
1573
  *
1238
- * **OAuth Scopes**
1239
1574
  *
1240
- * | Resource | Scopes |
1241
- * | :------- | :---------- |
1242
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1243
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1244
- * | Branch | `manage_passwords` |
1245
1575
  */
1246
- public renewPassword<ThrowOnError extends boolean = true>(
1247
- options: Options<RenewPasswordData, ThrowOnError>,
1576
+ public deleteKeyspace<ThrowOnError extends boolean = true>(
1577
+ options: Options<DeleteKeyspaceData, ThrowOnError>,
1248
1578
  ) {
1249
- return (options.client ?? this._client).post<
1250
- RenewPasswordResponses,
1251
- RenewPasswordErrors,
1579
+ return (options.client ?? this._client).delete<
1580
+ DeleteKeyspaceResponses,
1581
+ DeleteKeyspaceErrors,
1252
1582
  ThrowOnError
1253
1583
  >({
1254
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}/renew",
1584
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}",
1255
1585
  ...options,
1256
1586
  });
1257
1587
  }
1258
1588
 
1259
1589
  /**
1260
- * List generated query patterns reports
1590
+ * Get a keyspace
1261
1591
  *
1262
1592
  * ### Authorization
1263
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1593
+ * A service token must have at least one of the following access in order to use this API endpoint:
1264
1594
  *
1265
1595
  * **Service Token Accesses**
1266
1596
  * `read_branch`
1267
1597
  *
1268
- * **OAuth Scopes**
1269
1598
  *
1270
- * | Resource | Scopes |
1271
- * | :------- | :---------- |
1272
- * | Organization | `read_branches` |
1273
- * | Database | `read_branches` |
1274
- * | Branch | `read_branch` |
1275
1599
  */
1276
- public listGeneratedQueryPatternsReports<ThrowOnError extends boolean = true>(
1277
- options: Options<ListGeneratedQueryPatternsReportsData, ThrowOnError>,
1600
+ public getKeyspace<ThrowOnError extends boolean = true>(
1601
+ options: Options<GetKeyspaceData, ThrowOnError>,
1278
1602
  ) {
1279
1603
  return (options.client ?? this._client).get<
1280
- ListGeneratedQueryPatternsReportsResponses,
1281
- ListGeneratedQueryPatternsReportsErrors,
1604
+ GetKeyspaceResponses,
1605
+ GetKeyspaceErrors,
1282
1606
  ThrowOnError
1283
1607
  >({
1284
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns",
1608
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}",
1285
1609
  ...options,
1286
1610
  });
1287
1611
  }
1288
1612
 
1289
1613
  /**
1290
- * Create a new query patterns report
1614
+ * Configure keyspace settings
1291
1615
  *
1292
1616
  * ### Authorization
1293
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1617
+ * A service token must have at least one of the following access in order to use this API endpoint:
1294
1618
  *
1295
1619
  * **Service Token Accesses**
1296
- * `read_branch`
1620
+ * `create_branch`
1297
1621
  *
1298
- * **OAuth Scopes**
1299
1622
  *
1300
- * | Resource | Scopes |
1301
- * | :------- | :---------- |
1302
- * | Organization | `read_branches` |
1303
- * | Database | `read_branches` |
1304
- * | Branch | `read_branch` |
1305
1623
  */
1306
- public createQueryPatternsReport<ThrowOnError extends boolean = true>(
1307
- options: Options<CreateQueryPatternsReportData, ThrowOnError>,
1624
+ public updateKeyspace<ThrowOnError extends boolean = true>(
1625
+ options: Options<UpdateKeyspaceData, ThrowOnError>,
1308
1626
  ) {
1309
- return (options.client ?? this._client).post<
1310
- CreateQueryPatternsReportResponses,
1311
- CreateQueryPatternsReportErrors,
1627
+ return (options.client ?? this._client).patch<
1628
+ UpdateKeyspaceResponses,
1629
+ UpdateKeyspaceErrors,
1312
1630
  ThrowOnError
1313
1631
  >({
1314
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns",
1632
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}",
1315
1633
  ...options,
1316
1634
  });
1317
1635
  }
1318
1636
 
1319
1637
  /**
1320
- * Delete a query patterns report
1638
+ * Get keyspace rollout status
1321
1639
  *
1322
1640
  * ### Authorization
1323
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1641
+ * A service token must have at least one of the following access in order to use this API endpoint:
1324
1642
  *
1325
1643
  * **Service Token Accesses**
1326
1644
  * `read_branch`
1327
1645
  *
1328
- * **OAuth Scopes**
1329
1646
  *
1330
- * | Resource | Scopes |
1331
- * | :------- | :---------- |
1332
- * | Organization | `read_branches` |
1333
- * | Database | `read_branches` |
1334
- * | Branch | `read_branch` |
1335
1647
  */
1336
- public deleteQueryPatternsReport<ThrowOnError extends boolean = true>(
1337
- options: Options<DeleteQueryPatternsReportData, ThrowOnError>,
1648
+ public getKeyspaceRolloutStatus<ThrowOnError extends boolean = true>(
1649
+ options: Options<GetKeyspaceRolloutStatusData, ThrowOnError>,
1338
1650
  ) {
1339
- return (options.client ?? this._client).delete<
1340
- DeleteQueryPatternsReportResponses,
1341
- DeleteQueryPatternsReportErrors,
1651
+ return (options.client ?? this._client).get<
1652
+ GetKeyspaceRolloutStatusResponses,
1653
+ GetKeyspaceRolloutStatusErrors,
1342
1654
  ThrowOnError
1343
1655
  >({
1344
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}",
1656
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/rollout-status",
1345
1657
  ...options,
1346
1658
  });
1347
1659
  }
1348
1660
 
1349
1661
  /**
1350
- * Show the status of a query patterns report
1662
+ * Get the VSchema for the keyspace
1351
1663
  *
1352
1664
  * ### Authorization
1353
- * 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
+ * A service token must have at least one of the following access in order to use this API endpoint:
1354
1666
  *
1355
1667
  * **Service Token Accesses**
1356
- * `read_branch`
1668
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1357
1669
  *
1358
- * **OAuth Scopes**
1359
1670
  *
1360
- * | Resource | Scopes |
1361
- * | :------- | :---------- |
1362
- * | Organization | `read_branches` |
1363
- * | Database | `read_branches` |
1364
- * | Branch | `read_branch` |
1365
1671
  */
1366
- public getQueryPatternsReportStatus<ThrowOnError extends boolean = true>(
1367
- options: Options<GetQueryPatternsReportStatusData, ThrowOnError>,
1672
+ public getKeyspaceVschema<ThrowOnError extends boolean = true>(
1673
+ options: Options<GetKeyspaceVschemaData, ThrowOnError>,
1368
1674
  ) {
1369
1675
  return (options.client ?? this._client).get<
1370
- GetQueryPatternsReportStatusResponses,
1371
- GetQueryPatternsReportStatusErrors,
1676
+ GetKeyspaceVschemaResponses,
1677
+ GetKeyspaceVschemaErrors,
1372
1678
  ThrowOnError
1373
1679
  >({
1374
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}",
1680
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema",
1375
1681
  ...options,
1376
1682
  });
1377
1683
  }
1378
1684
 
1379
1685
  /**
1380
- * Download a finished query patterns report
1686
+ * Update the VSchema for the keyspace
1381
1687
  *
1382
1688
  * ### Authorization
1383
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1689
+ * A service token must have at least one of the following access in order to use this API endpoint:
1384
1690
  *
1385
1691
  * **Service Token Accesses**
1386
- * `read_branch`
1692
+ * `write_production_branch_vschema`, `write_branch_vschema`
1387
1693
  *
1388
- * **OAuth Scopes**
1389
1694
  *
1390
- * | Resource | Scopes |
1391
- * | :------- | :---------- |
1392
- * | Organization | `read_branches` |
1393
- * | Database | `read_branches` |
1394
- * | Branch | `read_branch` |
1395
1695
  */
1396
- public getQueryPatternsReport<ThrowOnError extends boolean = true>(
1397
- options: Options<GetQueryPatternsReportData, ThrowOnError>,
1696
+ public updateKeyspaceVschema<ThrowOnError extends boolean = true>(
1697
+ options: Options<UpdateKeyspaceVschemaData, ThrowOnError>,
1398
1698
  ) {
1399
- return (options.client ?? this._client).get<
1400
- unknown,
1401
- GetQueryPatternsReportErrors,
1699
+ return (options.client ?? this._client).patch<
1700
+ UpdateKeyspaceVschemaResponses,
1701
+ UpdateKeyspaceVschemaErrors,
1402
1702
  ThrowOnError
1403
1703
  >({
1404
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}/download",
1704
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/keyspaces/{keyspace}/vschema",
1405
1705
  ...options,
1706
+ headers: {
1707
+ "Content-Type": "application/json",
1708
+ ...options.headers,
1709
+ },
1406
1710
  });
1407
1711
  }
1408
1712
 
1409
1713
  /**
1410
- * Cancel a change request
1714
+ * List cluster parameters
1715
+ * Returns the parameters for a branch. To update the parameters, use the "Upsert a change request" endpoint.
1411
1716
  *
1412
1717
  * ### Authorization
1413
1718
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1414
1719
  *
1415
1720
  * **Service Token Accesses**
1416
- * `write_database`
1721
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1417
1722
  *
1418
1723
  * **OAuth Scopes**
1419
1724
  *
1420
1725
  * | Resource | Scopes |
1421
1726
  * | :------- | :---------- |
1422
- * | Organization | `write_databases` |
1423
- * | Database | `write_database` |
1727
+ * | Organization | `read_branches` |
1728
+ * | Database | `read_branches` |
1729
+ * | Branch | `read_branch` |
1424
1730
  */
1425
- public cancelBranchChangeRequest<ThrowOnError extends boolean = true>(
1426
- options: Options<CancelBranchChangeRequestData, ThrowOnError>,
1731
+ public listParameters<ThrowOnError extends boolean = true>(
1732
+ options: Options<ListParametersData, ThrowOnError>,
1427
1733
  ) {
1428
- return (options.client ?? this._client).delete<
1429
- CancelBranchChangeRequestResponses,
1430
- CancelBranchChangeRequestErrors,
1734
+ return (options.client ?? this._client).get<
1735
+ ListParametersResponses,
1736
+ ListParametersErrors,
1431
1737
  ThrowOnError
1432
1738
  >({
1433
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/resizes",
1739
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/parameters",
1434
1740
  ...options,
1435
1741
  });
1436
1742
  }
1437
1743
 
1438
1744
  /**
1439
- * List roles
1745
+ * List passwords
1440
1746
  *
1441
1747
  * ### Authorization
1442
1748
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1443
1749
  *
1444
1750
  * **Service Token Accesses**
1445
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1751
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1446
1752
  *
1447
1753
  * **OAuth Scopes**
1448
1754
  *
1449
1755
  * | Resource | Scopes |
1450
1756
  * | :------- | :---------- |
1451
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1452
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1453
- * | Branch | `manage_passwords` |
1757
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1758
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1759
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1454
1760
  */
1455
- public listRoles<ThrowOnError extends boolean = true>(
1456
- options: Options<ListRolesData, ThrowOnError>,
1761
+ public listPasswords<ThrowOnError extends boolean = true>(
1762
+ options: Options<ListPasswordsData, ThrowOnError>,
1457
1763
  ) {
1458
1764
  return (options.client ?? this._client).get<
1459
- ListRolesResponses,
1460
- ListRolesErrors,
1765
+ ListPasswordsResponses,
1766
+ ListPasswordsErrors,
1461
1767
  ThrowOnError
1462
1768
  >({
1463
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles",
1769
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords",
1464
1770
  ...options,
1465
1771
  });
1466
1772
  }
1467
1773
 
1468
1774
  /**
1469
- * Create role credentials
1775
+ * Create a password
1470
1776
  *
1471
1777
  * ### Authorization
1472
1778
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1473
1779
  *
1474
1780
  * **Service Token Accesses**
1475
- * `create_production_branch_password`, `create_branch_password`
1781
+ * `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1476
1782
  *
1477
1783
  * **OAuth Scopes**
1478
1784
  *
1479
1785
  * | Resource | Scopes |
1480
1786
  * | :------- | :---------- |
1481
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1482
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1483
- * | Branch | `manage_passwords` |
1787
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1788
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1789
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1484
1790
  */
1485
- public createRole<ThrowOnError extends boolean = true>(
1486
- options: Options<CreateRoleData, ThrowOnError>,
1791
+ public createPassword<ThrowOnError extends boolean = true>(
1792
+ options: Options<CreatePasswordData, ThrowOnError>,
1487
1793
  ) {
1488
1794
  return (options.client ?? this._client).post<
1489
- CreateRoleResponses,
1490
- CreateRoleErrors,
1795
+ CreatePasswordResponses,
1796
+ CreatePasswordErrors,
1491
1797
  ThrowOnError
1492
1798
  >({
1493
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles",
1799
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords",
1494
1800
  ...options,
1495
1801
  headers: {
1496
1802
  "Content-Type": "application/json",
@@ -1500,95 +1806,91 @@ export class PlanetScaleClient extends _HeyApiClient {
1500
1806
  }
1501
1807
 
1502
1808
  /**
1503
- * Delete role credentials
1809
+ * Delete a password
1504
1810
  *
1505
1811
  * ### Authorization
1506
1812
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1507
1813
  *
1508
1814
  * **Service Token Accesses**
1509
- * `delete_production_branch_password`, `delete_branch_password`
1815
+ * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
1510
1816
  *
1511
1817
  * **OAuth Scopes**
1512
1818
  *
1513
1819
  * | Resource | Scopes |
1514
1820
  * | :------- | :---------- |
1515
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1516
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1517
- * | Branch | `manage_passwords` |
1821
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1822
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1823
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1518
1824
  */
1519
- public deleteRole<ThrowOnError extends boolean = true>(
1520
- options: Options<DeleteRoleData, ThrowOnError>,
1825
+ public deletePassword<ThrowOnError extends boolean = true>(
1826
+ options: Options<DeletePasswordData, ThrowOnError>,
1521
1827
  ) {
1522
1828
  return (options.client ?? this._client).delete<
1523
- DeleteRoleResponses,
1524
- DeleteRoleErrors,
1829
+ DeletePasswordResponses,
1830
+ DeletePasswordErrors,
1525
1831
  ThrowOnError
1526
1832
  >({
1527
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
1833
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}",
1528
1834
  ...options,
1529
- headers: {
1530
- "Content-Type": "application/json",
1531
- ...options.headers,
1532
- },
1533
1835
  });
1534
1836
  }
1535
1837
 
1536
1838
  /**
1537
- * Get a role
1839
+ * Get a password
1538
1840
  *
1539
1841
  * ### Authorization
1540
1842
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1541
1843
  *
1542
1844
  * **Service Token Accesses**
1543
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1845
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1544
1846
  *
1545
1847
  * **OAuth Scopes**
1546
1848
  *
1547
1849
  * | Resource | Scopes |
1548
1850
  * | :------- | :---------- |
1549
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1550
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1551
- * | Branch | `manage_passwords` |
1851
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1852
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1853
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1552
1854
  */
1553
- public getRole<ThrowOnError extends boolean = true>(
1554
- options: Options<GetRoleData, ThrowOnError>,
1855
+ public getPassword<ThrowOnError extends boolean = true>(
1856
+ options: Options<GetPasswordData, ThrowOnError>,
1555
1857
  ) {
1556
1858
  return (options.client ?? this._client).get<
1557
- GetRoleResponses,
1558
- GetRoleErrors,
1859
+ GetPasswordResponses,
1860
+ GetPasswordErrors,
1559
1861
  ThrowOnError
1560
1862
  >({
1561
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
1863
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}",
1562
1864
  ...options,
1563
1865
  });
1564
1866
  }
1565
1867
 
1566
1868
  /**
1567
- * Update role name
1869
+ * Update a password
1568
1870
  *
1569
1871
  * ### Authorization
1570
1872
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1571
1873
  *
1572
1874
  * **Service Token Accesses**
1573
- * `create_production_branch_password`, `create_branch_password`
1875
+ * `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1574
1876
  *
1575
1877
  * **OAuth Scopes**
1576
1878
  *
1577
1879
  * | Resource | Scopes |
1578
1880
  * | :------- | :---------- |
1579
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1580
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1581
- * | Branch | `manage_passwords` |
1881
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1882
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1883
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1582
1884
  */
1583
- public updateRole<ThrowOnError extends boolean = true>(
1584
- options: Options<UpdateRoleData, ThrowOnError>,
1885
+ public updatePassword<ThrowOnError extends boolean = true>(
1886
+ options: Options<UpdatePasswordData, ThrowOnError>,
1585
1887
  ) {
1586
1888
  return (options.client ?? this._client).patch<
1587
- UpdateRoleResponses,
1588
- UpdateRoleErrors,
1889
+ UpdatePasswordResponses,
1890
+ UpdatePasswordErrors,
1589
1891
  ThrowOnError
1590
1892
  >({
1591
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
1893
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}",
1592
1894
  ...options,
1593
1895
  headers: {
1594
1896
  "Content-Type": "application/json",
@@ -1598,73 +1900,72 @@ export class PlanetScaleClient extends _HeyApiClient {
1598
1900
  }
1599
1901
 
1600
1902
  /**
1601
- * Renew role expiration
1903
+ * Renew a password
1602
1904
  *
1603
1905
  * ### Authorization
1604
1906
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1605
1907
  *
1606
1908
  * **Service Token Accesses**
1607
- * `create_production_branch_password`, `create_branch_password`
1909
+ * `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1608
1910
  *
1609
1911
  * **OAuth Scopes**
1610
1912
  *
1611
1913
  * | Resource | Scopes |
1612
1914
  * | :------- | :---------- |
1613
- * | Organization | `manage_passwords`, `manage_production_branch_passwords` |
1614
- * | Database | `manage_passwords`, `manage_production_branch_passwords` |
1615
- * | Branch | `manage_passwords` |
1915
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1916
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
1917
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1616
1918
  */
1617
- public renewRole<ThrowOnError extends boolean = true>(
1618
- options: Options<RenewRoleData, ThrowOnError>,
1919
+ public renewPassword<ThrowOnError extends boolean = true>(
1920
+ options: Options<RenewPasswordData, ThrowOnError>,
1619
1921
  ) {
1620
1922
  return (options.client ?? this._client).post<
1621
- RenewRoleResponses,
1622
- RenewRoleErrors,
1923
+ RenewPasswordResponses,
1924
+ RenewPasswordErrors,
1623
1925
  ThrowOnError
1624
1926
  >({
1625
- url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/renew",
1927
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/passwords/{id}/renew",
1626
1928
  ...options,
1627
1929
  });
1628
1930
  }
1629
1931
 
1630
1932
  /**
1631
- * Delete a branch
1632
- *
1933
+ * Promote a branch
1934
+ * Promotes a branch from development to production
1633
1935
  * ### Authorization
1634
1936
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1635
1937
  *
1636
1938
  * **Service Token Accesses**
1637
- * `delete_branch`
1939
+ * `connect_production_branch`, `promote_branches`
1638
1940
  *
1639
1941
  * **OAuth Scopes**
1640
1942
  *
1641
1943
  * | Resource | Scopes |
1642
1944
  * | :------- | :---------- |
1643
- * | Organization | `delete_branches`, `delete_production_branches` |
1644
- * | Database | `delete_branches`, `delete_production_branches` |
1645
- * | Branch | `delete_branch` |
1945
+ * | Organization | `promote_branches` |
1946
+ * | Database | `promote_branches` |
1646
1947
  */
1647
- public deleteBranch<ThrowOnError extends boolean = true>(
1648
- options: Options<DeleteBranchData, ThrowOnError>,
1948
+ public promoteBranch<ThrowOnError extends boolean = true>(
1949
+ options: Options<PromoteBranchData, ThrowOnError>,
1649
1950
  ) {
1650
- return (options.client ?? this._client).delete<
1651
- DeleteBranchResponses,
1652
- DeleteBranchErrors,
1951
+ return (options.client ?? this._client).post<
1952
+ PromoteBranchResponses,
1953
+ PromoteBranchErrors,
1653
1954
  ThrowOnError
1654
1955
  >({
1655
- url: "/organizations/{organization}/databases/{database}/branches/{name}",
1956
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/promote",
1656
1957
  ...options,
1657
1958
  });
1658
1959
  }
1659
1960
 
1660
1961
  /**
1661
- * Get a branch
1962
+ * List generated query patterns reports
1662
1963
  *
1663
1964
  * ### Authorization
1664
1965
  * 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
1966
  *
1666
1967
  * **Service Token Accesses**
1667
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
1968
+ * `read_branch`
1668
1969
  *
1669
1970
  * **OAuth Scopes**
1670
1971
  *
@@ -1674,273 +1975,318 @@ export class PlanetScaleClient extends _HeyApiClient {
1674
1975
  * | Database | `read_branches` |
1675
1976
  * | Branch | `read_branch` |
1676
1977
  */
1677
- public getBranch<ThrowOnError extends boolean = true>(
1678
- options: Options<GetBranchData, ThrowOnError>,
1978
+ public listGeneratedQueryPatternsReports<ThrowOnError extends boolean = true>(
1979
+ options: Options<ListGeneratedQueryPatternsReportsData, ThrowOnError>,
1679
1980
  ) {
1680
1981
  return (options.client ?? this._client).get<
1681
- GetBranchResponses,
1682
- GetBranchErrors,
1982
+ ListGeneratedQueryPatternsReportsResponses,
1983
+ ListGeneratedQueryPatternsReportsErrors,
1683
1984
  ThrowOnError
1684
1985
  >({
1685
- url: "/organizations/{organization}/databases/{database}/branches/{name}",
1986
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns",
1686
1987
  ...options,
1687
1988
  });
1688
1989
  }
1689
1990
 
1690
1991
  /**
1691
- * Change a branch cluster configuration
1992
+ * Create a new query patterns report
1692
1993
  *
1693
1994
  * ### Authorization
1694
- * A service token must have at least one of the following access in order to use this API endpoint:
1995
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1695
1996
  *
1696
1997
  * **Service Token Accesses**
1697
- * `write_database`
1998
+ * `read_branch`
1698
1999
  *
2000
+ * **OAuth Scopes**
1699
2001
  *
2002
+ * | Resource | Scopes |
2003
+ * | :------- | :---------- |
2004
+ * | Organization | `read_branches` |
2005
+ * | Database | `read_branches` |
2006
+ * | Branch | `read_branch` |
1700
2007
  */
1701
- public updateBranchClusterConfig<ThrowOnError extends boolean = true>(
1702
- options: Options<UpdateBranchClusterConfigData, ThrowOnError>,
2008
+ public createQueryPatternsReport<ThrowOnError extends boolean = true>(
2009
+ options: Options<CreateQueryPatternsReportData, ThrowOnError>,
1703
2010
  ) {
1704
- return (options.client ?? this._client).patch<
1705
- UpdateBranchClusterConfigResponses,
1706
- UpdateBranchClusterConfigErrors,
2011
+ return (options.client ?? this._client).post<
2012
+ CreateQueryPatternsReportResponses,
2013
+ CreateQueryPatternsReportErrors,
1707
2014
  ThrowOnError
1708
2015
  >({
1709
- url: "/organizations/{organization}/databases/{database}/branches/{name}/cluster",
2016
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns",
1710
2017
  ...options,
1711
- headers: {
1712
- "Content-Type": "application/json",
1713
- ...options.headers,
1714
- },
1715
2018
  });
1716
2019
  }
1717
2020
 
1718
2021
  /**
1719
- * Demote a branch
1720
- * Demotes a branch from production to development
2022
+ * Delete a query patterns report
2023
+ *
1721
2024
  * ### Authorization
1722
2025
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1723
2026
  *
1724
2027
  * **Service Token Accesses**
1725
- * `connect_production_branch`, `demote_branches`
2028
+ * `read_branch`
1726
2029
  *
1727
2030
  * **OAuth Scopes**
1728
2031
  *
1729
2032
  * | Resource | Scopes |
1730
2033
  * | :------- | :---------- |
1731
- * | Organization | `demote_branches` |
1732
- * | Database | `demote_branches` |
2034
+ * | Organization | `read_branches` |
2035
+ * | Database | `read_branches` |
2036
+ * | Branch | `read_branch` |
1733
2037
  */
1734
- public demoteBranch<ThrowOnError extends boolean = true>(
1735
- options: Options<DemoteBranchData, ThrowOnError>,
2038
+ public deleteQueryPatternsReport<ThrowOnError extends boolean = true>(
2039
+ options: Options<DeleteQueryPatternsReportData, ThrowOnError>,
1736
2040
  ) {
1737
- return (options.client ?? this._client).post<
1738
- DemoteBranchResponses,
1739
- DemoteBranchErrors,
2041
+ return (options.client ?? this._client).delete<
2042
+ DeleteQueryPatternsReportResponses,
2043
+ DeleteQueryPatternsReportErrors,
1740
2044
  ThrowOnError
1741
2045
  >({
1742
- url: "/organizations/{organization}/databases/{database}/branches/{name}/demote",
2046
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}",
1743
2047
  ...options,
1744
2048
  });
1745
2049
  }
1746
2050
 
1747
2051
  /**
1748
- * Promote a branch
1749
- * Promotes a branch from development to production
2052
+ * Show the status of a query patterns report
2053
+ *
1750
2054
  * ### Authorization
1751
2055
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1752
2056
  *
1753
2057
  * **Service Token Accesses**
1754
- * `connect_production_branch`, `promote_branches`
2058
+ * `read_branch`
1755
2059
  *
1756
2060
  * **OAuth Scopes**
1757
2061
  *
1758
2062
  * | Resource | Scopes |
1759
2063
  * | :------- | :---------- |
1760
- * | Organization | `promote_branches` |
1761
- * | Database | `promote_branches` |
2064
+ * | Organization | `read_branches` |
2065
+ * | Database | `read_branches` |
2066
+ * | Branch | `read_branch` |
1762
2067
  */
1763
- public promoteBranch<ThrowOnError extends boolean = true>(
1764
- options: Options<PromoteBranchData, ThrowOnError>,
2068
+ public getQueryPatternsReportStatus<ThrowOnError extends boolean = true>(
2069
+ options: Options<GetQueryPatternsReportStatusData, ThrowOnError>,
1765
2070
  ) {
1766
- return (options.client ?? this._client).post<
1767
- PromoteBranchResponses,
1768
- PromoteBranchErrors,
2071
+ return (options.client ?? this._client).get<
2072
+ GetQueryPatternsReportStatusResponses,
2073
+ GetQueryPatternsReportStatusErrors,
1769
2074
  ThrowOnError
1770
2075
  >({
1771
- url: "/organizations/{organization}/databases/{database}/branches/{name}/promote",
2076
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}",
1772
2077
  ...options,
1773
2078
  });
1774
2079
  }
1775
2080
 
1776
2081
  /**
1777
- * Disable safe migrations for a branch
2082
+ * Download a finished query patterns report
2083
+ *
2084
+ * ### Authorization
2085
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2086
+ *
2087
+ * **Service Token Accesses**
2088
+ * `read_branch`
1778
2089
  *
2090
+ * **OAuth Scopes**
1779
2091
  *
2092
+ * | Resource | Scopes |
2093
+ * | :------- | :---------- |
2094
+ * | Organization | `read_branches` |
2095
+ * | Database | `read_branches` |
2096
+ * | Branch | `read_branch` |
1780
2097
  */
1781
- public disableSafeMigrations<ThrowOnError extends boolean = true>(
1782
- options: Options<DisableSafeMigrationsData, ThrowOnError>,
2098
+ public getQueryPatternsReport<ThrowOnError extends boolean = true>(
2099
+ options: Options<GetQueryPatternsReportData, ThrowOnError>,
1783
2100
  ) {
1784
- return (options.client ?? this._client).delete<
1785
- DisableSafeMigrationsResponses,
1786
- DisableSafeMigrationsErrors,
2101
+ return (options.client ?? this._client).get<
2102
+ unknown,
2103
+ GetQueryPatternsReportErrors,
1787
2104
  ThrowOnError
1788
2105
  >({
1789
- url: "/organizations/{organization}/databases/{database}/branches/{name}/safe-migrations",
2106
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/query-patterns/{id}/download",
1790
2107
  ...options,
1791
2108
  });
1792
2109
  }
1793
2110
 
1794
2111
  /**
1795
- * Enable safe migrations for a branch
2112
+ * Cancel a change request
2113
+ *
2114
+ * ### Authorization
2115
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2116
+ *
2117
+ * **Service Token Accesses**
2118
+ * `write_database`
1796
2119
  *
2120
+ * **OAuth Scopes**
1797
2121
  *
2122
+ * | Resource | Scopes |
2123
+ * | :------- | :---------- |
2124
+ * | Organization | `write_databases` |
2125
+ * | Database | `write_database` |
1798
2126
  */
1799
- public enableSafeMigrations<ThrowOnError extends boolean = true>(
1800
- options: Options<EnableSafeMigrationsData, ThrowOnError>,
2127
+ public cancelBranchChangeRequest<ThrowOnError extends boolean = true>(
2128
+ options: Options<CancelBranchChangeRequestData, ThrowOnError>,
1801
2129
  ) {
1802
- return (options.client ?? this._client).post<
1803
- EnableSafeMigrationsResponses,
1804
- EnableSafeMigrationsErrors,
2130
+ return (options.client ?? this._client).delete<
2131
+ CancelBranchChangeRequestResponses,
2132
+ CancelBranchChangeRequestErrors,
1805
2133
  ThrowOnError
1806
2134
  >({
1807
- url: "/organizations/{organization}/databases/{database}/branches/{name}/safe-migrations",
2135
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/resizes",
1808
2136
  ...options,
1809
2137
  });
1810
2138
  }
1811
2139
 
1812
2140
  /**
1813
- * Get a branch schema
2141
+ * List roles
1814
2142
  *
1815
2143
  * ### Authorization
1816
2144
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1817
2145
  *
1818
2146
  * **Service Token Accesses**
1819
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
2147
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1820
2148
  *
1821
2149
  * **OAuth Scopes**
1822
2150
  *
1823
2151
  * | Resource | Scopes |
1824
2152
  * | :------- | :---------- |
1825
- * | Organization | `read_branches` |
1826
- * | Database | `read_branches` |
1827
- * | Branch | `read_branch` |
2153
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2154
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2155
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1828
2156
  */
1829
- public getBranchSchema<ThrowOnError extends boolean = true>(
1830
- options: Options<GetBranchSchemaData, ThrowOnError>,
2157
+ public listRoles<ThrowOnError extends boolean = true>(
2158
+ options: Options<ListRolesData, ThrowOnError>,
1831
2159
  ) {
1832
2160
  return (options.client ?? this._client).get<
1833
- GetBranchSchemaResponses,
1834
- GetBranchSchemaErrors,
2161
+ ListRolesResponses,
2162
+ ListRolesErrors,
1835
2163
  ThrowOnError
1836
2164
  >({
1837
- url: "/organizations/{organization}/databases/{database}/branches/{name}/schema",
2165
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles",
1838
2166
  ...options,
1839
2167
  });
1840
2168
  }
1841
2169
 
1842
2170
  /**
1843
- * Lint a branch schema
2171
+ * Create role credentials
1844
2172
  *
1845
2173
  * ### Authorization
1846
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:
1847
2175
  *
1848
2176
  * **Service Token Accesses**
1849
- * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
2177
+ * `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
1850
2178
  *
1851
2179
  * **OAuth Scopes**
1852
2180
  *
1853
2181
  * | Resource | Scopes |
1854
2182
  * | :------- | :---------- |
1855
- * | Organization | `read_branches` |
1856
- * | Database | `read_branches` |
1857
- * | Branch | `read_branch` |
2183
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2184
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2185
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1858
2186
  */
1859
- public lintBranchSchema<ThrowOnError extends boolean = true>(
1860
- options: Options<LintBranchSchemaData, ThrowOnError>,
2187
+ public createRole<ThrowOnError extends boolean = true>(
2188
+ options: Options<CreateRoleData, ThrowOnError>,
1861
2189
  ) {
1862
- return (options.client ?? this._client).get<
1863
- LintBranchSchemaResponses,
1864
- LintBranchSchemaErrors,
2190
+ return (options.client ?? this._client).post<
2191
+ CreateRoleResponses,
2192
+ CreateRoleErrors,
1865
2193
  ThrowOnError
1866
2194
  >({
1867
- url: "/organizations/{organization}/databases/{database}/branches/{name}/schema/lint",
2195
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles",
1868
2196
  ...options,
2197
+ headers: {
2198
+ "Content-Type": "application/json",
2199
+ ...options.headers,
2200
+ },
1869
2201
  });
1870
2202
  }
1871
2203
 
1872
2204
  /**
1873
- * Get the deploy queue
1874
- * The deploy queue returns the current list of deploy requests in the order they will be deployed.
2205
+ * Get the default postgres role
2206
+ *
2207
+ * ### Authorization
2208
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2209
+ *
2210
+ * **Service Token Accesses**
2211
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1875
2212
  *
2213
+ * **OAuth Scopes**
2214
+ *
2215
+ * | Resource | Scopes |
2216
+ * | :------- | :---------- |
2217
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2218
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2219
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1876
2220
  */
1877
- public getDeployQueue<ThrowOnError extends boolean = true>(
1878
- options: Options<GetDeployQueueData, ThrowOnError>,
2221
+ public getDefaultRole<ThrowOnError extends boolean = true>(
2222
+ options: Options<GetDefaultRoleData, ThrowOnError>,
1879
2223
  ) {
1880
2224
  return (options.client ?? this._client).get<
1881
- GetDeployQueueResponses,
1882
- GetDeployQueueErrors,
2225
+ GetDefaultRoleResponses,
2226
+ GetDefaultRoleErrors,
1883
2227
  ThrowOnError
1884
2228
  >({
1885
- url: "/organizations/{organization}/databases/{database}/deploy-queue",
2229
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/default",
1886
2230
  ...options,
1887
2231
  });
1888
2232
  }
1889
2233
 
1890
2234
  /**
1891
- * List deploy requests
1892
- * List deploy requests for a database
2235
+ * Reset default credentials
2236
+ *
1893
2237
  * ### Authorization
1894
2238
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1895
2239
  *
1896
2240
  * **Service Token Accesses**
1897
- * `read_deploy_request`
2241
+ * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
1898
2242
  *
1899
2243
  * **OAuth Scopes**
1900
2244
  *
1901
2245
  * | Resource | Scopes |
1902
2246
  * | :------- | :---------- |
1903
- * | Organization | `read_deploy_requests` |
1904
- * | Database | `read_deploy_requests` |
2247
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2248
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2249
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1905
2250
  */
1906
- public listDeployRequests<ThrowOnError extends boolean = true>(
1907
- options: Options<ListDeployRequestsData, ThrowOnError>,
2251
+ public resetDefaultRole<ThrowOnError extends boolean = true>(
2252
+ options: Options<ResetDefaultRoleData, ThrowOnError>,
1908
2253
  ) {
1909
- return (options.client ?? this._client).get<
1910
- ListDeployRequestsResponses,
1911
- ListDeployRequestsErrors,
2254
+ return (options.client ?? this._client).post<
2255
+ ResetDefaultRoleResponses,
2256
+ ResetDefaultRoleErrors,
1912
2257
  ThrowOnError
1913
2258
  >({
1914
- url: "/organizations/{organization}/databases/{database}/deploy-requests",
2259
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/reset-default",
1915
2260
  ...options,
1916
2261
  });
1917
2262
  }
1918
2263
 
1919
2264
  /**
1920
- * Create a deploy request
2265
+ * Delete role credentials
1921
2266
  *
1922
2267
  * ### Authorization
1923
2268
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1924
2269
  *
1925
2270
  * **Service Token Accesses**
1926
- * `read_deploy_request`, `create_deploy_requests`
2271
+ * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
1927
2272
  *
1928
2273
  * **OAuth Scopes**
1929
2274
  *
1930
2275
  * | Resource | Scopes |
1931
2276
  * | :------- | :---------- |
1932
- * | Organization | `write_deploy_requests` |
1933
- * | Database | `write_deploy_requests` |
2277
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2278
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2279
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1934
2280
  */
1935
- public createDeployRequest<ThrowOnError extends boolean = true>(
1936
- options: Options<CreateDeployRequestData, ThrowOnError>,
2281
+ public deleteRole<ThrowOnError extends boolean = true>(
2282
+ options: Options<DeleteRoleData, ThrowOnError>,
1937
2283
  ) {
1938
- return (options.client ?? this._client).post<
1939
- CreateDeployRequestResponses,
1940
- CreateDeployRequestErrors,
2284
+ return (options.client ?? this._client).delete<
2285
+ DeleteRoleResponses,
2286
+ DeleteRoleErrors,
1941
2287
  ThrowOnError
1942
2288
  >({
1943
- url: "/organizations/{organization}/databases/{database}/deploy-requests",
2289
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
1944
2290
  ...options,
1945
2291
  headers: {
1946
2292
  "Content-Type": "application/json",
@@ -1950,59 +2296,61 @@ export class PlanetScaleClient extends _HeyApiClient {
1950
2296
  }
1951
2297
 
1952
2298
  /**
1953
- * Get a deploy request
2299
+ * Get a role
1954
2300
  *
1955
2301
  * ### Authorization
1956
2302
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1957
2303
  *
1958
2304
  * **Service Token Accesses**
1959
- * `read_deploy_request`
2305
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_production_read_only_branch`, `connect_branch`
1960
2306
  *
1961
2307
  * **OAuth Scopes**
1962
2308
  *
1963
2309
  * | Resource | Scopes |
1964
2310
  * | :------- | :---------- |
1965
- * | Organization | `read_deploy_requests` |
1966
- * | Database | `read_deploy_requests` |
2311
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2312
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2313
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1967
2314
  */
1968
- public getDeployRequest<ThrowOnError extends boolean = true>(
1969
- options: Options<GetDeployRequestData, ThrowOnError>,
2315
+ public getRole<ThrowOnError extends boolean = true>(
2316
+ options: Options<GetRoleData, ThrowOnError>,
1970
2317
  ) {
1971
2318
  return (options.client ?? this._client).get<
1972
- GetDeployRequestResponses,
1973
- GetDeployRequestErrors,
2319
+ GetRoleResponses,
2320
+ GetRoleErrors,
1974
2321
  ThrowOnError
1975
2322
  >({
1976
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}",
2323
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
1977
2324
  ...options,
1978
2325
  });
1979
2326
  }
1980
2327
 
1981
2328
  /**
1982
- * Close a deploy request
2329
+ * Update role name
1983
2330
  *
1984
2331
  * ### Authorization
1985
2332
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
1986
2333
  *
1987
2334
  * **Service Token Accesses**
1988
- * `read_deploy_request`
2335
+ * `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
1989
2336
  *
1990
2337
  * **OAuth Scopes**
1991
2338
  *
1992
2339
  * | Resource | Scopes |
1993
2340
  * | :------- | :---------- |
1994
- * | Organization | `write_deploy_requests` |
1995
- * | Database | `write_deploy_requests` |
2341
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2342
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2343
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
1996
2344
  */
1997
- public closeDeployRequest<ThrowOnError extends boolean = true>(
1998
- options: Options<CloseDeployRequestData, ThrowOnError>,
2345
+ public updateRole<ThrowOnError extends boolean = true>(
2346
+ options: Options<UpdateRoleData, ThrowOnError>,
1999
2347
  ) {
2000
2348
  return (options.client ?? this._client).patch<
2001
- CloseDeployRequestResponses,
2002
- CloseDeployRequestErrors,
2349
+ UpdateRoleResponses,
2350
+ UpdateRoleErrors,
2003
2351
  ThrowOnError
2004
2352
  >({
2005
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}",
2353
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}",
2006
2354
  ...options,
2007
2355
  headers: {
2008
2356
  "Content-Type": "application/json",
@@ -2012,339 +2360,354 @@ export class PlanetScaleClient extends _HeyApiClient {
2012
2360
  }
2013
2361
 
2014
2362
  /**
2015
- * Complete a gated deploy request
2363
+ * Reassign objects owned by one role to another role
2016
2364
  *
2017
2365
  * ### Authorization
2018
2366
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2019
2367
  *
2020
2368
  * **Service Token Accesses**
2021
- * `read_deploy_request`, `create_deploy_request`
2369
+ * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
2022
2370
  *
2023
2371
  * **OAuth Scopes**
2024
2372
  *
2025
2373
  * | Resource | Scopes |
2026
2374
  * | :------- | :---------- |
2027
- * | Organization | `deploy_deploy_requests` |
2028
- * | Database | `deploy_deploy_requests` |
2375
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2376
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2377
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
2029
2378
  */
2030
- public completeGatedDeployRequest<ThrowOnError extends boolean = true>(
2031
- options: Options<CompleteGatedDeployRequestData, ThrowOnError>,
2379
+ public reassignRoleObjects<ThrowOnError extends boolean = true>(
2380
+ options: Options<ReassignRoleObjectsData, ThrowOnError>,
2032
2381
  ) {
2033
2382
  return (options.client ?? this._client).post<
2034
- CompleteGatedDeployRequestResponses,
2035
- CompleteGatedDeployRequestErrors,
2383
+ ReassignRoleObjectsResponses,
2384
+ ReassignRoleObjectsErrors,
2036
2385
  ThrowOnError
2037
2386
  >({
2038
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/apply-deploy",
2387
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reassign",
2039
2388
  ...options,
2389
+ headers: {
2390
+ "Content-Type": "application/json",
2391
+ ...options.headers,
2392
+ },
2040
2393
  });
2041
2394
  }
2042
2395
 
2043
2396
  /**
2044
- * Update auto-apply for deploy request
2045
- * Enables or disabled the auto-apply setting for a deploy request
2397
+ * Renew role expiration
2398
+ *
2046
2399
  * ### Authorization
2047
2400
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2048
2401
  *
2049
2402
  * **Service Token Accesses**
2050
- * `read_deploy_request`, `create_deploy_request`
2403
+ * `create_production_branch_password`, `create_production_read_only_branch_password`, `create_branch_password`
2051
2404
  *
2052
2405
  * **OAuth Scopes**
2053
2406
  *
2054
2407
  * | Resource | Scopes |
2055
2408
  * | :------- | :---------- |
2056
- * | Organization | `deploy_deploy_requests` |
2057
- * | Database | `deploy_deploy_requests` |
2409
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2410
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2411
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
2058
2412
  */
2059
- public updateAutoApply<ThrowOnError extends boolean = true>(
2060
- options: Options<UpdateAutoApplyData, ThrowOnError>,
2413
+ public renewRole<ThrowOnError extends boolean = true>(
2414
+ options: Options<RenewRoleData, ThrowOnError>,
2061
2415
  ) {
2062
- return (options.client ?? this._client).put<
2063
- UpdateAutoApplyResponses,
2064
- UpdateAutoApplyErrors,
2416
+ return (options.client ?? this._client).post<
2417
+ RenewRoleResponses,
2418
+ RenewRoleErrors,
2065
2419
  ThrowOnError
2066
2420
  >({
2067
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-apply",
2421
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/renew",
2068
2422
  ...options,
2069
- headers: {
2070
- "Content-Type": "application/json",
2071
- ...options.headers,
2072
- },
2073
2423
  });
2074
2424
  }
2075
2425
 
2076
2426
  /**
2077
- * Cancel a queued deploy request
2427
+ * Reset a role's password
2078
2428
  *
2079
2429
  * ### Authorization
2080
2430
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2081
2431
  *
2082
2432
  * **Service Token Accesses**
2083
- * `read_deploy_request`, `create_deploy_request`
2433
+ * `delete_production_branch_password`, `delete_production_read_only_branch_password`, `delete_branch_password`
2084
2434
  *
2085
2435
  * **OAuth Scopes**
2086
2436
  *
2087
2437
  * | Resource | Scopes |
2088
2438
  * | :------- | :---------- |
2089
- * | Organization | `deploy_deploy_requests` |
2090
- * | Database | `deploy_deploy_requests` |
2439
+ * | Organization | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2440
+ * | Database | `manage_passwords`, `manage_production_branch_passwords`, `manage_read_only_passwords`, `manage_production_read_only_passwords` |
2441
+ * | Branch | `manage_passwords`, `manage_read_only_passwords` |
2091
2442
  */
2092
- public cancelDeployRequest<ThrowOnError extends boolean = true>(
2093
- options: Options<CancelDeployRequestData, ThrowOnError>,
2443
+ public resetRole<ThrowOnError extends boolean = true>(
2444
+ options: Options<ResetRoleData, ThrowOnError>,
2094
2445
  ) {
2095
2446
  return (options.client ?? this._client).post<
2096
- CancelDeployRequestResponses,
2097
- CancelDeployRequestErrors,
2447
+ ResetRoleResponses,
2448
+ ResetRoleErrors,
2098
2449
  ThrowOnError
2099
2450
  >({
2100
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/cancel",
2451
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/roles/{id}/reset",
2101
2452
  ...options,
2102
2453
  });
2103
2454
  }
2104
2455
 
2105
2456
  /**
2106
- * Complete an errored deploy
2457
+ * Disable safe migrations for a branch
2107
2458
  *
2108
- * ### Authorization
2109
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2110
2459
  *
2111
- * **Service Token Accesses**
2112
- * `read_deploy_request`, `create_deploy_request`
2460
+ */
2461
+ public disableSafeMigrations<ThrowOnError extends boolean = true>(
2462
+ options: Options<DisableSafeMigrationsData, ThrowOnError>,
2463
+ ) {
2464
+ return (options.client ?? this._client).delete<
2465
+ DisableSafeMigrationsResponses,
2466
+ DisableSafeMigrationsErrors,
2467
+ ThrowOnError
2468
+ >({
2469
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations",
2470
+ ...options,
2471
+ });
2472
+ }
2473
+
2474
+ /**
2475
+ * Enable safe migrations for a branch
2113
2476
  *
2114
- * **OAuth Scopes**
2115
2477
  *
2116
- * | Resource | Scopes |
2117
- * | :------- | :---------- |
2118
- * | Organization | `deploy_deploy_requests` |
2119
- * | Database | `deploy_deploy_requests` |
2120
2478
  */
2121
- public completeErroredDeploy<ThrowOnError extends boolean = true>(
2122
- options: Options<CompleteErroredDeployData, ThrowOnError>,
2479
+ public enableSafeMigrations<ThrowOnError extends boolean = true>(
2480
+ options: Options<EnableSafeMigrationsData, ThrowOnError>,
2123
2481
  ) {
2124
2482
  return (options.client ?? this._client).post<
2125
- CompleteErroredDeployResponses,
2126
- CompleteErroredDeployErrors,
2483
+ EnableSafeMigrationsResponses,
2484
+ EnableSafeMigrationsErrors,
2127
2485
  ThrowOnError
2128
2486
  >({
2129
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/complete-deploy",
2487
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/safe-migrations",
2130
2488
  ...options,
2131
2489
  });
2132
2490
  }
2133
2491
 
2134
2492
  /**
2135
- * Queue a deploy request
2493
+ * Get a branch schema
2136
2494
  *
2137
2495
  * ### Authorization
2138
2496
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2139
2497
  *
2140
2498
  * **Service Token Accesses**
2141
- * `read_deploy_request`, `create_deploy_request`
2499
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
2142
2500
  *
2143
2501
  * **OAuth Scopes**
2144
2502
  *
2145
2503
  * | Resource | Scopes |
2146
2504
  * | :------- | :---------- |
2147
- * | Organization | `deploy_deploy_requests` |
2148
- * | Database | `deploy_deploy_requests` |
2505
+ * | Organization | `read_branches` |
2506
+ * | Database | `read_branches` |
2507
+ * | Branch | `read_branch` |
2149
2508
  */
2150
- public queueDeployRequest<ThrowOnError extends boolean = true>(
2151
- options: Options<QueueDeployRequestData, ThrowOnError>,
2509
+ public getBranchSchema<ThrowOnError extends boolean = true>(
2510
+ options: Options<GetBranchSchemaData, ThrowOnError>,
2152
2511
  ) {
2153
- return (options.client ?? this._client).post<
2154
- QueueDeployRequestResponses,
2155
- QueueDeployRequestErrors,
2512
+ return (options.client ?? this._client).get<
2513
+ GetBranchSchemaResponses,
2514
+ GetBranchSchemaErrors,
2156
2515
  ThrowOnError
2157
2516
  >({
2158
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/deploy",
2517
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/schema",
2159
2518
  ...options,
2160
- headers: {
2161
- "Content-Type": "application/json",
2162
- ...options.headers,
2163
- },
2164
2519
  });
2165
2520
  }
2166
2521
 
2167
2522
  /**
2168
- * Get a deployment
2169
- * Get the deployment for a deploy request
2523
+ * Lint a branch schema
2524
+ *
2170
2525
  * ### Authorization
2171
2526
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2172
2527
  *
2173
2528
  * **Service Token Accesses**
2174
- * `read_deploy_request`
2529
+ * `read_branch`, `delete_branch`, `create_branch`, `connect_production_branch`, `connect_branch`
2175
2530
  *
2176
2531
  * **OAuth Scopes**
2177
2532
  *
2178
2533
  * | Resource | Scopes |
2179
2534
  * | :------- | :---------- |
2180
- * | Organization | `read_deploy_requests` |
2181
- * | Database | `read_deploy_requests` |
2535
+ * | Organization | `read_branches` |
2536
+ * | Database | `read_branches` |
2537
+ * | Branch | `read_branch` |
2182
2538
  */
2183
- public getDeployment<ThrowOnError extends boolean = true>(
2184
- options: Options<GetDeploymentData, ThrowOnError>,
2539
+ public lintBranchSchema<ThrowOnError extends boolean = true>(
2540
+ options: Options<LintBranchSchemaData, ThrowOnError>,
2185
2541
  ) {
2186
2542
  return (options.client ?? this._client).get<
2187
- GetDeploymentResponses,
2188
- GetDeploymentErrors,
2543
+ LintBranchSchemaResponses,
2544
+ LintBranchSchemaErrors,
2189
2545
  ThrowOnError
2190
2546
  >({
2191
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/deployment",
2547
+ url: "/organizations/{organization}/databases/{database}/branches/{branch}/schema/lint",
2192
2548
  ...options,
2193
2549
  });
2194
2550
  }
2195
2551
 
2196
2552
  /**
2197
- * List deploy operations
2198
- * List deploy operations for a deploy request
2199
- * ### Authorization
2200
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2553
+ * List IP restriction entries
2201
2554
  *
2202
- * **Service Token Accesses**
2203
- * `read_deploy_request`
2555
+ * ### Authorization
2556
+ * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
2204
2557
  *
2205
2558
  * **OAuth Scopes**
2206
2559
  *
2207
2560
  * | Resource | Scopes |
2208
2561
  * | :------- | :---------- |
2209
- * | Organization | `read_deploy_requests` |
2210
- * | Database | `read_deploy_requests` |
2562
+ * | Organization | `read_databases` |
2563
+ * | Database | `read_database` |
2211
2564
  */
2212
- public listDeployOperations<ThrowOnError extends boolean = true>(
2213
- options: Options<ListDeployOperationsData, ThrowOnError>,
2565
+ public listDatabasePostgresCidrs<ThrowOnError extends boolean = true>(
2566
+ options: Options<ListDatabasePostgresCidrsData, ThrowOnError>,
2214
2567
  ) {
2215
2568
  return (options.client ?? this._client).get<
2216
- ListDeployOperationsResponses,
2217
- ListDeployOperationsErrors,
2569
+ ListDatabasePostgresCidrsResponses,
2570
+ ListDatabasePostgresCidrsErrors,
2218
2571
  ThrowOnError
2219
2572
  >({
2220
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/operations",
2573
+ url: "/organizations/{organization}/databases/{database}/cidrs",
2221
2574
  ...options,
2222
2575
  });
2223
2576
  }
2224
2577
 
2225
2578
  /**
2226
- * Complete a revert
2579
+ * Create an IP restriction entry
2227
2580
  *
2228
2581
  * ### Authorization
2229
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2230
- *
2231
- * **Service Token Accesses**
2232
- * `read_deploy_request`, `create_deploy_request`
2582
+ * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
2233
2583
  *
2234
2584
  * **OAuth Scopes**
2235
2585
  *
2236
2586
  * | Resource | Scopes |
2237
2587
  * | :------- | :---------- |
2238
- * | Organization | `deploy_deploy_requests` |
2239
- * | Database | `deploy_deploy_requests` |
2588
+ * | Organization | `write_databases` |
2589
+ * | Database | `write_database` |
2240
2590
  */
2241
- public completeRevert<ThrowOnError extends boolean = true>(
2242
- options: Options<CompleteRevertData, ThrowOnError>,
2591
+ public createDatabasePostgresCidr<ThrowOnError extends boolean = true>(
2592
+ options: Options<CreateDatabasePostgresCidrData, ThrowOnError>,
2243
2593
  ) {
2244
2594
  return (options.client ?? this._client).post<
2245
- CompleteRevertResponses,
2246
- CompleteRevertErrors,
2595
+ CreateDatabasePostgresCidrResponses,
2596
+ CreateDatabasePostgresCidrErrors,
2247
2597
  ThrowOnError
2248
2598
  >({
2249
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/revert",
2599
+ url: "/organizations/{organization}/databases/{database}/cidrs",
2250
2600
  ...options,
2601
+ headers: {
2602
+ "Content-Type": "application/json",
2603
+ ...options.headers,
2604
+ },
2251
2605
  });
2252
2606
  }
2253
2607
 
2254
2608
  /**
2255
- * List deploy request reviews
2609
+ * Delete an IP restriction entry
2256
2610
  *
2257
2611
  * ### Authorization
2258
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2259
- *
2260
- * **Service Token Accesses**
2261
- * `read_deploy_request`
2612
+ * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
2262
2613
  *
2263
2614
  * **OAuth Scopes**
2264
2615
  *
2265
2616
  * | Resource | Scopes |
2266
2617
  * | :------- | :---------- |
2267
- * | Organization | `read_deploy_requests` |
2268
- * | Database | `read_deploy_requests` |
2618
+ * | Organization | `write_databases` |
2619
+ * | Database | `write_database` |
2269
2620
  */
2270
- public listDeployRequestReviews<ThrowOnError extends boolean = true>(
2271
- options: Options<ListDeployRequestReviewsData, ThrowOnError>,
2621
+ public deleteDatabasePostgresCidr<ThrowOnError extends boolean = true>(
2622
+ options: Options<DeleteDatabasePostgresCidrData, ThrowOnError>,
2272
2623
  ) {
2273
- return (options.client ?? this._client).get<
2274
- ListDeployRequestReviewsResponses,
2275
- ListDeployRequestReviewsErrors,
2624
+ return (options.client ?? this._client).delete<
2625
+ DeleteDatabasePostgresCidrResponses,
2626
+ DeleteDatabasePostgresCidrErrors,
2276
2627
  ThrowOnError
2277
2628
  >({
2278
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews",
2629
+ url: "/organizations/{organization}/databases/{database}/cidrs/{id}",
2279
2630
  ...options,
2280
2631
  });
2281
2632
  }
2282
2633
 
2283
2634
  /**
2284
- * Review a deploy request
2285
- * Review a deploy request by either approving or commenting on the deploy request
2286
- * ### Authorization
2287
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2635
+ * Get an IP restriction entry
2288
2636
  *
2289
- * **Service Token Accesses**
2290
- * `approve_deploy_request`, `review_deploy_request`
2637
+ * ### Authorization
2638
+ * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
2291
2639
  *
2292
2640
  * **OAuth Scopes**
2293
2641
  *
2294
2642
  * | Resource | Scopes |
2295
2643
  * | :------- | :---------- |
2296
- * | Organization | `approve_deploy_requests` |
2297
- * | Database | `approve_deploy_requests` |
2644
+ * | Organization | `read_databases` |
2645
+ * | Database | `read_database` |
2298
2646
  */
2299
- public reviewDeployRequest<ThrowOnError extends boolean = true>(
2300
- options: Options<ReviewDeployRequestData, ThrowOnError>,
2647
+ public getDatabasePostgresCidr<ThrowOnError extends boolean = true>(
2648
+ options: Options<GetDatabasePostgresCidrData, ThrowOnError>,
2301
2649
  ) {
2302
- return (options.client ?? this._client).post<
2303
- ReviewDeployRequestResponses,
2304
- ReviewDeployRequestErrors,
2650
+ return (options.client ?? this._client).get<
2651
+ GetDatabasePostgresCidrResponses,
2652
+ GetDatabasePostgresCidrErrors,
2305
2653
  ThrowOnError
2306
2654
  >({
2307
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews",
2655
+ url: "/organizations/{organization}/databases/{database}/cidrs/{id}",
2308
2656
  ...options,
2309
- headers: {
2310
- "Content-Type": "application/json",
2311
- ...options.headers,
2312
- },
2313
2657
  });
2314
2658
  }
2315
2659
 
2316
2660
  /**
2317
- * Skip revert period
2318
- * Skips the revert period for a deploy request
2319
- * ### Authorization
2320
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2661
+ * Update an IP restriction entry
2321
2662
  *
2322
- * **Service Token Accesses**
2323
- * `read_deploy_request`, `create_deploy_request`
2663
+ * ### Authorization
2664
+ * A OAuth token must have at least one of the following scopes in order to use this API endpoint:
2324
2665
  *
2325
2666
  * **OAuth Scopes**
2326
2667
  *
2327
2668
  * | Resource | Scopes |
2328
2669
  * | :------- | :---------- |
2329
- * | Organization | `deploy_deploy_requests` |
2330
- * | Database | `deploy_deploy_requests` |
2670
+ * | Organization | `write_databases` |
2671
+ * | Database | `write_database` |
2331
2672
  */
2332
- public skipRevertPeriod<ThrowOnError extends boolean = true>(
2333
- options: Options<SkipRevertPeriodData, ThrowOnError>,
2673
+ public updateDatabasePostgresCidr<ThrowOnError extends boolean = true>(
2674
+ options: Options<UpdateDatabasePostgresCidrData, ThrowOnError>,
2334
2675
  ) {
2335
- return (options.client ?? this._client).post<
2336
- SkipRevertPeriodResponses,
2337
- SkipRevertPeriodErrors,
2676
+ return (options.client ?? this._client).put<
2677
+ UpdateDatabasePostgresCidrResponses,
2678
+ UpdateDatabasePostgresCidrErrors,
2338
2679
  ThrowOnError
2339
2680
  >({
2340
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/skip-revert",
2681
+ url: "/organizations/{organization}/databases/{database}/cidrs/{id}",
2341
2682
  ...options,
2683
+ headers: {
2684
+ "Content-Type": "application/json",
2685
+ ...options.headers,
2686
+ },
2342
2687
  });
2343
2688
  }
2344
2689
 
2345
2690
  /**
2346
- * Get deploy request throttler configurations
2691
+ * Get the deploy queue
2692
+ * The deploy queue returns the current list of deploy requests in the order they will be deployed.
2347
2693
  *
2694
+ */
2695
+ public getDeployQueue<ThrowOnError extends boolean = true>(
2696
+ options: Options<GetDeployQueueData, ThrowOnError>,
2697
+ ) {
2698
+ return (options.client ?? this._client).get<
2699
+ GetDeployQueueResponses,
2700
+ GetDeployQueueErrors,
2701
+ ThrowOnError
2702
+ >({
2703
+ url: "/organizations/{organization}/databases/{database}/deploy-queue",
2704
+ ...options,
2705
+ });
2706
+ }
2707
+
2708
+ /**
2709
+ * List deploy requests
2710
+ * List deploy requests for a database
2348
2711
  * ### Authorization
2349
2712
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2350
2713
  *
@@ -2358,44 +2721,44 @@ export class PlanetScaleClient extends _HeyApiClient {
2358
2721
  * | Organization | `read_deploy_requests` |
2359
2722
  * | Database | `read_deploy_requests` |
2360
2723
  */
2361
- public getDeployRequestThrottler<ThrowOnError extends boolean = true>(
2362
- options: Options<GetDeployRequestThrottlerData, ThrowOnError>,
2724
+ public listDeployRequests<ThrowOnError extends boolean = true>(
2725
+ options: Options<ListDeployRequestsData, ThrowOnError>,
2363
2726
  ) {
2364
2727
  return (options.client ?? this._client).get<
2365
- GetDeployRequestThrottlerResponses,
2366
- GetDeployRequestThrottlerErrors,
2728
+ ListDeployRequestsResponses,
2729
+ ListDeployRequestsErrors,
2367
2730
  ThrowOnError
2368
2731
  >({
2369
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler",
2732
+ url: "/organizations/{organization}/databases/{database}/deploy-requests",
2370
2733
  ...options,
2371
2734
  });
2372
2735
  }
2373
2736
 
2374
2737
  /**
2375
- * Update deploy request throttler configurations
2738
+ * Create a deploy request
2376
2739
  *
2377
2740
  * ### Authorization
2378
2741
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2379
2742
  *
2380
2743
  * **Service Token Accesses**
2381
- * `read_deploy_request`, `create_deploy_request`
2744
+ * `read_deploy_request`, `create_deploy_requests`
2382
2745
  *
2383
2746
  * **OAuth Scopes**
2384
2747
  *
2385
2748
  * | Resource | Scopes |
2386
2749
  * | :------- | :---------- |
2387
- * | Organization | `deploy_deploy_requests` |
2388
- * | Database | `deploy_deploy_requests` |
2750
+ * | Organization | `write_deploy_requests` |
2751
+ * | Database | `write_deploy_requests` |
2389
2752
  */
2390
- public updateDeployRequestThrottler<ThrowOnError extends boolean = true>(
2391
- options: Options<UpdateDeployRequestThrottlerData, ThrowOnError>,
2753
+ public createDeployRequest<ThrowOnError extends boolean = true>(
2754
+ options: Options<CreateDeployRequestData, ThrowOnError>,
2392
2755
  ) {
2393
- return (options.client ?? this._client).patch<
2394
- UpdateDeployRequestThrottlerResponses,
2395
- UpdateDeployRequestThrottlerErrors,
2756
+ return (options.client ?? this._client).post<
2757
+ CreateDeployRequestResponses,
2758
+ CreateDeployRequestErrors,
2396
2759
  ThrowOnError
2397
2760
  >({
2398
- url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler",
2761
+ url: "/organizations/{organization}/databases/{database}/deploy-requests",
2399
2762
  ...options,
2400
2763
  headers: {
2401
2764
  "Content-Type": "application/json",
@@ -2405,59 +2768,59 @@ export class PlanetScaleClient extends _HeyApiClient {
2405
2768
  }
2406
2769
 
2407
2770
  /**
2408
- * Get database throttler configurations
2771
+ * Get a deploy request
2409
2772
  *
2410
2773
  * ### Authorization
2411
2774
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2412
2775
  *
2413
2776
  * **Service Token Accesses**
2414
- * `read_deploy_request`, `create_deploy_request`
2777
+ * `read_deploy_request`
2415
2778
  *
2416
2779
  * **OAuth Scopes**
2417
2780
  *
2418
2781
  * | Resource | Scopes |
2419
2782
  * | :------- | :---------- |
2420
- * | Organization | `read_databases` |
2421
- * | Database | `read_database` |
2783
+ * | Organization | `read_deploy_requests` |
2784
+ * | Database | `read_deploy_requests` |
2422
2785
  */
2423
- public getDatabaseThrottler<ThrowOnError extends boolean = true>(
2424
- options: Options<GetDatabaseThrottlerData, ThrowOnError>,
2786
+ public getDeployRequest<ThrowOnError extends boolean = true>(
2787
+ options: Options<GetDeployRequestData, ThrowOnError>,
2425
2788
  ) {
2426
2789
  return (options.client ?? this._client).get<
2427
- GetDatabaseThrottlerResponses,
2428
- GetDatabaseThrottlerErrors,
2790
+ GetDeployRequestResponses,
2791
+ GetDeployRequestErrors,
2429
2792
  ThrowOnError
2430
2793
  >({
2431
- url: "/organizations/{organization}/databases/{database}/throttler",
2794
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}",
2432
2795
  ...options,
2433
2796
  });
2434
2797
  }
2435
2798
 
2436
2799
  /**
2437
- * Update database throttler configurations
2800
+ * Close a deploy request
2438
2801
  *
2439
2802
  * ### Authorization
2440
2803
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2441
2804
  *
2442
2805
  * **Service Token Accesses**
2443
- * `read_deploy_request`, `create_deploy_request`
2806
+ * `read_deploy_request`
2444
2807
  *
2445
2808
  * **OAuth Scopes**
2446
2809
  *
2447
2810
  * | Resource | Scopes |
2448
2811
  * | :------- | :---------- |
2449
- * | Organization | `deploy_deploy_requests` |
2450
- * | Database | `deploy_deploy_requests` |
2812
+ * | Organization | `write_deploy_requests` |
2813
+ * | Database | `write_deploy_requests` |
2451
2814
  */
2452
- public updateDatabaseThrottler<ThrowOnError extends boolean = true>(
2453
- options: Options<UpdateDatabaseThrottlerData, ThrowOnError>,
2815
+ public closeDeployRequest<ThrowOnError extends boolean = true>(
2816
+ options: Options<CloseDeployRequestData, ThrowOnError>,
2454
2817
  ) {
2455
2818
  return (options.client ?? this._client).patch<
2456
- UpdateDatabaseThrottlerResponses,
2457
- UpdateDatabaseThrottlerErrors,
2819
+ CloseDeployRequestResponses,
2820
+ CloseDeployRequestErrors,
2458
2821
  ThrowOnError
2459
2822
  >({
2460
- url: "/organizations/{organization}/databases/{database}/throttler",
2823
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}",
2461
2824
  ...options,
2462
2825
  headers: {
2463
2826
  "Content-Type": "application/json",
@@ -2467,59 +2830,59 @@ export class PlanetScaleClient extends _HeyApiClient {
2467
2830
  }
2468
2831
 
2469
2832
  /**
2470
- * List webhooks
2471
- * List webhooks for a database
2833
+ * Complete a gated deploy request
2834
+ *
2472
2835
  * ### Authorization
2473
2836
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2474
2837
  *
2475
2838
  * **Service Token Accesses**
2476
- * `read_database`
2839
+ * `read_deploy_request`, `create_deploy_request`
2477
2840
  *
2478
2841
  * **OAuth Scopes**
2479
2842
  *
2480
2843
  * | Resource | Scopes |
2481
2844
  * | :------- | :---------- |
2482
- * | Organization | `read_databases` |
2483
- * | Database | `read_database` |
2845
+ * | Organization | `deploy_deploy_requests` |
2846
+ * | Database | `deploy_deploy_requests` |
2484
2847
  */
2485
- public listWebhooks<ThrowOnError extends boolean = true>(
2486
- options: Options<ListWebhooksData, ThrowOnError>,
2848
+ public completeGatedDeployRequest<ThrowOnError extends boolean = true>(
2849
+ options: Options<CompleteGatedDeployRequestData, ThrowOnError>,
2487
2850
  ) {
2488
- return (options.client ?? this._client).get<
2489
- ListWebhooksResponses,
2490
- ListWebhooksErrors,
2851
+ return (options.client ?? this._client).post<
2852
+ CompleteGatedDeployRequestResponses,
2853
+ CompleteGatedDeployRequestErrors,
2491
2854
  ThrowOnError
2492
2855
  >({
2493
- url: "/organizations/{organization}/databases/{database}/webhooks",
2856
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/apply-deploy",
2494
2857
  ...options,
2495
2858
  });
2496
2859
  }
2497
2860
 
2498
2861
  /**
2499
- * Create a webhook
2500
- *
2862
+ * Update auto-apply for deploy request
2863
+ * Enables or disabled the auto-apply setting for a deploy request
2501
2864
  * ### Authorization
2502
2865
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2503
2866
  *
2504
2867
  * **Service Token Accesses**
2505
- * `write_database`
2868
+ * `read_deploy_request`, `create_deploy_request`
2506
2869
  *
2507
2870
  * **OAuth Scopes**
2508
2871
  *
2509
2872
  * | Resource | Scopes |
2510
2873
  * | :------- | :---------- |
2511
- * | Organization | `write_databases` |
2512
- * | Database | `write_database` |
2874
+ * | Organization | `deploy_deploy_requests` |
2875
+ * | Database | `deploy_deploy_requests` |
2513
2876
  */
2514
- public createWebhook<ThrowOnError extends boolean = true>(
2515
- options: Options<CreateWebhookData, ThrowOnError>,
2877
+ public updateAutoApply<ThrowOnError extends boolean = true>(
2878
+ options: Options<UpdateAutoApplyData, ThrowOnError>,
2516
2879
  ) {
2517
- return (options.client ?? this._client).post<
2518
- CreateWebhookResponses,
2519
- CreateWebhookErrors,
2880
+ return (options.client ?? this._client).put<
2881
+ UpdateAutoApplyResponses,
2882
+ UpdateAutoApplyErrors,
2520
2883
  ThrowOnError
2521
2884
  >({
2522
- url: "/organizations/{organization}/databases/{database}/webhooks",
2885
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-apply",
2523
2886
  ...options,
2524
2887
  headers: {
2525
2888
  "Content-Type": "application/json",
@@ -2529,428 +2892,1407 @@ export class PlanetScaleClient extends _HeyApiClient {
2529
2892
  }
2530
2893
 
2531
2894
  /**
2532
- * Delete a webhook
2533
- *
2895
+ * Update auto-delete branch for deploy request
2896
+ * Enables or disabled the auto-delete branch setting for a deploy request
2534
2897
  * ### Authorization
2535
2898
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2536
2899
  *
2537
2900
  * **Service Token Accesses**
2538
- * `write_database`
2901
+ * `read_deploy_request`, `create_deploy_request`
2539
2902
  *
2540
2903
  * **OAuth Scopes**
2541
2904
  *
2542
2905
  * | Resource | Scopes |
2543
2906
  * | :------- | :---------- |
2544
- * | Organization | `write_databases` |
2545
- * | Database | `write_database` |
2907
+ * | Organization | `deploy_deploy_requests` |
2908
+ * | Database | `deploy_deploy_requests` |
2546
2909
  */
2547
- public deleteWebhook<ThrowOnError extends boolean = true>(
2548
- options: Options<DeleteWebhookData, ThrowOnError>,
2910
+ public updateAutoDeleteBranch<ThrowOnError extends boolean = true>(
2911
+ options: Options<UpdateAutoDeleteBranchData, ThrowOnError>,
2549
2912
  ) {
2550
- return (options.client ?? this._client).delete<
2551
- DeleteWebhookResponses,
2552
- DeleteWebhookErrors,
2913
+ return (options.client ?? this._client).put<
2914
+ UpdateAutoDeleteBranchResponses,
2915
+ UpdateAutoDeleteBranchErrors,
2553
2916
  ThrowOnError
2554
2917
  >({
2555
- url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
2918
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/auto-delete-branch",
2556
2919
  ...options,
2920
+ headers: {
2921
+ "Content-Type": "application/json",
2922
+ ...options.headers,
2923
+ },
2557
2924
  });
2558
2925
  }
2559
2926
 
2560
2927
  /**
2561
- * Get a webhook
2928
+ * Cancel a queued deploy request
2562
2929
  *
2563
2930
  * ### Authorization
2564
2931
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2565
2932
  *
2566
2933
  * **Service Token Accesses**
2567
- * `read_database`
2934
+ * `read_deploy_request`, `create_deploy_request`
2568
2935
  *
2569
2936
  * **OAuth Scopes**
2570
2937
  *
2571
2938
  * | Resource | Scopes |
2572
2939
  * | :------- | :---------- |
2573
- * | Organization | `read_databases` |
2574
- * | Database | `read_database` |
2940
+ * | Organization | `deploy_deploy_requests` |
2941
+ * | Database | `deploy_deploy_requests` |
2575
2942
  */
2576
- public getWebhook<ThrowOnError extends boolean = true>(
2577
- options: Options<GetWebhookData, ThrowOnError>,
2943
+ public cancelDeployRequest<ThrowOnError extends boolean = true>(
2944
+ options: Options<CancelDeployRequestData, ThrowOnError>,
2578
2945
  ) {
2579
- return (options.client ?? this._client).get<
2580
- GetWebhookResponses,
2581
- GetWebhookErrors,
2946
+ return (options.client ?? this._client).post<
2947
+ CancelDeployRequestResponses,
2948
+ CancelDeployRequestErrors,
2582
2949
  ThrowOnError
2583
2950
  >({
2584
- url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
2951
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/cancel",
2585
2952
  ...options,
2586
2953
  });
2587
2954
  }
2588
2955
 
2589
2956
  /**
2590
- * Update a webhook
2957
+ * Complete an errored deploy
2591
2958
  *
2592
2959
  * ### Authorization
2593
2960
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2594
2961
  *
2595
2962
  * **Service Token Accesses**
2596
- * `write_database`
2963
+ * `read_deploy_request`, `create_deploy_request`
2597
2964
  *
2598
2965
  * **OAuth Scopes**
2599
2966
  *
2600
2967
  * | Resource | Scopes |
2601
2968
  * | :------- | :---------- |
2602
- * | Organization | `write_databases` |
2603
- * | Database | `write_database` |
2969
+ * | Organization | `deploy_deploy_requests` |
2970
+ * | Database | `deploy_deploy_requests` |
2604
2971
  */
2605
- public updateWebhook<ThrowOnError extends boolean = true>(
2606
- options: Options<UpdateWebhookData, ThrowOnError>,
2972
+ public completeErroredDeploy<ThrowOnError extends boolean = true>(
2973
+ options: Options<CompleteErroredDeployData, ThrowOnError>,
2607
2974
  ) {
2608
- return (options.client ?? this._client).patch<
2609
- UpdateWebhookResponses,
2610
- UpdateWebhookErrors,
2975
+ return (options.client ?? this._client).post<
2976
+ CompleteErroredDeployResponses,
2977
+ CompleteErroredDeployErrors,
2611
2978
  ThrowOnError
2612
2979
  >({
2613
- url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
2980
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/complete-deploy",
2614
2981
  ...options,
2615
- headers: {
2616
- "Content-Type": "application/json",
2617
- ...options.headers,
2618
- },
2619
2982
  });
2620
2983
  }
2621
2984
 
2622
2985
  /**
2623
- * Test a webhook
2624
- * Sends a test event to the webhook
2986
+ * Queue a deploy request
2987
+ *
2625
2988
  * ### Authorization
2626
2989
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2627
2990
  *
2628
2991
  * **Service Token Accesses**
2629
- * `write_database`
2992
+ * `read_deploy_request`, `create_deploy_request`
2630
2993
  *
2631
2994
  * **OAuth Scopes**
2632
2995
  *
2633
2996
  * | Resource | Scopes |
2634
2997
  * | :------- | :---------- |
2635
- * | Organization | `write_databases` |
2636
- * | Database | `write_database` |
2998
+ * | Organization | `deploy_deploy_requests` |
2999
+ * | Database | `deploy_deploy_requests` |
2637
3000
  */
2638
- public testWebhook<ThrowOnError extends boolean = true>(
2639
- options: Options<TestWebhookData, ThrowOnError>,
3001
+ public queueDeployRequest<ThrowOnError extends boolean = true>(
3002
+ options: Options<QueueDeployRequestData, ThrowOnError>,
2640
3003
  ) {
2641
3004
  return (options.client ?? this._client).post<
2642
- TestWebhookResponses,
2643
- TestWebhookErrors,
3005
+ QueueDeployRequestResponses,
3006
+ QueueDeployRequestErrors,
2644
3007
  ThrowOnError
2645
3008
  >({
2646
- url: "/organizations/{organization}/databases/{database}/webhooks/{id}/test",
3009
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/deploy",
2647
3010
  ...options,
3011
+ headers: {
3012
+ "Content-Type": "application/json",
3013
+ ...options.headers,
3014
+ },
2648
3015
  });
2649
3016
  }
2650
3017
 
2651
3018
  /**
2652
- * List workflows
3019
+ * Get a deployment
3020
+ * Get the deployment for a deploy request
3021
+ * ### Authorization
3022
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3023
+ *
3024
+ * **Service Token Accesses**
3025
+ * `read_deploy_request`
2653
3026
  *
3027
+ * **OAuth Scopes**
2654
3028
  *
3029
+ * | Resource | Scopes |
3030
+ * | :------- | :---------- |
3031
+ * | Organization | `read_deploy_requests` |
3032
+ * | Database | `read_deploy_requests` |
2655
3033
  */
2656
- public listWorkflows<ThrowOnError extends boolean = true>(
2657
- options: Options<ListWorkflowsData, ThrowOnError>,
3034
+ public getDeployment<ThrowOnError extends boolean = true>(
3035
+ options: Options<GetDeploymentData, ThrowOnError>,
2658
3036
  ) {
2659
3037
  return (options.client ?? this._client).get<
2660
- ListWorkflowsResponses,
2661
- ListWorkflowsErrors,
3038
+ GetDeploymentResponses,
3039
+ GetDeploymentErrors,
2662
3040
  ThrowOnError
2663
3041
  >({
2664
- url: "/organizations/{organization}/databases/{database}/workflows",
3042
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/deployment",
2665
3043
  ...options,
2666
3044
  });
2667
3045
  }
2668
3046
 
2669
3047
  /**
2670
- * Create a workflow
3048
+ * List deploy operations
3049
+ * List deploy operations for a deploy request
3050
+ * ### Authorization
3051
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3052
+ *
3053
+ * **Service Token Accesses**
3054
+ * `read_deploy_request`
2671
3055
  *
3056
+ * **OAuth Scopes**
2672
3057
  *
3058
+ * | Resource | Scopes |
3059
+ * | :------- | :---------- |
3060
+ * | Organization | `read_deploy_requests` |
3061
+ * | Database | `read_deploy_requests` |
2673
3062
  */
2674
- public createWorkflow<ThrowOnError extends boolean = true>(
2675
- options: Options<CreateWorkflowData, ThrowOnError>,
3063
+ public listDeployOperations<ThrowOnError extends boolean = true>(
3064
+ options: Options<ListDeployOperationsData, ThrowOnError>,
2676
3065
  ) {
2677
- return (options.client ?? this._client).post<
2678
- CreateWorkflowResponses,
2679
- CreateWorkflowErrors,
3066
+ return (options.client ?? this._client).get<
3067
+ ListDeployOperationsResponses,
3068
+ ListDeployOperationsErrors,
2680
3069
  ThrowOnError
2681
3070
  >({
2682
- url: "/organizations/{organization}/databases/{database}/workflows",
3071
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/operations",
2683
3072
  ...options,
2684
- headers: {
2685
- "Content-Type": "application/json",
2686
- ...options.headers,
2687
- },
2688
3073
  });
2689
3074
  }
2690
3075
 
2691
3076
  /**
2692
- * Cancel a workflow
3077
+ * Complete a revert
3078
+ *
3079
+ * ### Authorization
3080
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3081
+ *
3082
+ * **Service Token Accesses**
3083
+ * `read_deploy_request`, `create_deploy_request`
2693
3084
  *
3085
+ * **OAuth Scopes**
2694
3086
  *
3087
+ * | Resource | Scopes |
3088
+ * | :------- | :---------- |
3089
+ * | Organization | `deploy_deploy_requests` |
3090
+ * | Database | `deploy_deploy_requests` |
2695
3091
  */
2696
- public workflowCancel<ThrowOnError extends boolean = true>(
2697
- options: Options<WorkflowCancelData, ThrowOnError>,
3092
+ public completeRevert<ThrowOnError extends boolean = true>(
3093
+ options: Options<CompleteRevertData, ThrowOnError>,
2698
3094
  ) {
2699
- return (options.client ?? this._client).delete<
2700
- WorkflowCancelResponses,
2701
- WorkflowCancelErrors,
3095
+ return (options.client ?? this._client).post<
3096
+ CompleteRevertResponses,
3097
+ CompleteRevertErrors,
2702
3098
  ThrowOnError
2703
3099
  >({
2704
- url: "/organizations/{organization}/databases/{database}/workflows/{number}",
3100
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/revert",
2705
3101
  ...options,
2706
3102
  });
2707
3103
  }
2708
3104
 
2709
3105
  /**
2710
- * Get a workflow
3106
+ * List deploy request reviews
3107
+ *
3108
+ * ### Authorization
3109
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3110
+ *
3111
+ * **Service Token Accesses**
3112
+ * `read_deploy_request`
2711
3113
  *
3114
+ * **OAuth Scopes**
2712
3115
  *
3116
+ * | Resource | Scopes |
3117
+ * | :------- | :---------- |
3118
+ * | Organization | `read_deploy_requests` |
3119
+ * | Database | `read_deploy_requests` |
2713
3120
  */
2714
- public getWorkflow<ThrowOnError extends boolean = true>(
2715
- options: Options<GetWorkflowData, ThrowOnError>,
3121
+ public listDeployRequestReviews<ThrowOnError extends boolean = true>(
3122
+ options: Options<ListDeployRequestReviewsData, ThrowOnError>,
2716
3123
  ) {
2717
3124
  return (options.client ?? this._client).get<
2718
- GetWorkflowResponses,
2719
- GetWorkflowErrors,
3125
+ ListDeployRequestReviewsResponses,
3126
+ ListDeployRequestReviewsErrors,
2720
3127
  ThrowOnError
2721
3128
  >({
2722
- url: "/organizations/{organization}/databases/{database}/workflows/{number}",
3129
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews",
2723
3130
  ...options,
2724
3131
  });
2725
3132
  }
2726
3133
 
2727
3134
  /**
2728
- * Complete a workflow
3135
+ * Review a deploy request
3136
+ * Review a deploy request by either approving or commenting on the deploy request
3137
+ * ### Authorization
3138
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3139
+ *
3140
+ * **Service Token Accesses**
3141
+ * `approve_deploy_request`, `review_deploy_request`
2729
3142
  *
3143
+ * **OAuth Scopes**
2730
3144
  *
3145
+ * | Resource | Scopes |
3146
+ * | :------- | :---------- |
3147
+ * | Organization | `approve_deploy_requests` |
3148
+ * | Database | `approve_deploy_requests` |
2731
3149
  */
2732
- public workflowComplete<ThrowOnError extends boolean = true>(
2733
- options: Options<WorkflowCompleteData, ThrowOnError>,
3150
+ public reviewDeployRequest<ThrowOnError extends boolean = true>(
3151
+ options: Options<ReviewDeployRequestData, ThrowOnError>,
3152
+ ) {
3153
+ return (options.client ?? this._client).post<
3154
+ ReviewDeployRequestResponses,
3155
+ ReviewDeployRequestErrors,
3156
+ ThrowOnError
3157
+ >({
3158
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/reviews",
3159
+ ...options,
3160
+ headers: {
3161
+ "Content-Type": "application/json",
3162
+ ...options.headers,
3163
+ },
3164
+ });
3165
+ }
3166
+
3167
+ /**
3168
+ * Skip revert period
3169
+ * Skips the revert period for a deploy request
3170
+ * ### Authorization
3171
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3172
+ *
3173
+ * **Service Token Accesses**
3174
+ * `read_deploy_request`, `create_deploy_request`
3175
+ *
3176
+ * **OAuth Scopes**
3177
+ *
3178
+ * | Resource | Scopes |
3179
+ * | :------- | :---------- |
3180
+ * | Organization | `deploy_deploy_requests` |
3181
+ * | Database | `deploy_deploy_requests` |
3182
+ */
3183
+ public skipRevertPeriod<ThrowOnError extends boolean = true>(
3184
+ options: Options<SkipRevertPeriodData, ThrowOnError>,
3185
+ ) {
3186
+ return (options.client ?? this._client).post<
3187
+ SkipRevertPeriodResponses,
3188
+ SkipRevertPeriodErrors,
3189
+ ThrowOnError
3190
+ >({
3191
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/skip-revert",
3192
+ ...options,
3193
+ });
3194
+ }
3195
+
3196
+ /**
3197
+ * Get deploy request throttler configurations
3198
+ *
3199
+ * ### Authorization
3200
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3201
+ *
3202
+ * **Service Token Accesses**
3203
+ * `read_deploy_request`
3204
+ *
3205
+ * **OAuth Scopes**
3206
+ *
3207
+ * | Resource | Scopes |
3208
+ * | :------- | :---------- |
3209
+ * | Organization | `read_deploy_requests` |
3210
+ * | Database | `read_deploy_requests` |
3211
+ */
3212
+ public getDeployRequestThrottler<ThrowOnError extends boolean = true>(
3213
+ options: Options<GetDeployRequestThrottlerData, ThrowOnError>,
3214
+ ) {
3215
+ return (options.client ?? this._client).get<
3216
+ GetDeployRequestThrottlerResponses,
3217
+ GetDeployRequestThrottlerErrors,
3218
+ ThrowOnError
3219
+ >({
3220
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler",
3221
+ ...options,
3222
+ });
3223
+ }
3224
+
3225
+ /**
3226
+ * Update deploy request throttler configurations
3227
+ *
3228
+ * ### Authorization
3229
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3230
+ *
3231
+ * **Service Token Accesses**
3232
+ * `read_deploy_request`, `create_deploy_request`
3233
+ *
3234
+ * **OAuth Scopes**
3235
+ *
3236
+ * | Resource | Scopes |
3237
+ * | :------- | :---------- |
3238
+ * | Organization | `deploy_deploy_requests` |
3239
+ * | Database | `deploy_deploy_requests` |
3240
+ */
3241
+ public updateDeployRequestThrottler<ThrowOnError extends boolean = true>(
3242
+ options: Options<UpdateDeployRequestThrottlerData, ThrowOnError>,
3243
+ ) {
3244
+ return (options.client ?? this._client).patch<
3245
+ UpdateDeployRequestThrottlerResponses,
3246
+ UpdateDeployRequestThrottlerErrors,
3247
+ ThrowOnError
3248
+ >({
3249
+ url: "/organizations/{organization}/databases/{database}/deploy-requests/{number}/throttler",
3250
+ ...options,
3251
+ headers: {
3252
+ "Content-Type": "application/json",
3253
+ ...options.headers,
3254
+ },
3255
+ });
3256
+ }
3257
+
3258
+ /**
3259
+ * List read-only regions
3260
+ * List read-only regions for the database's default branch
3261
+ * ### Authorization
3262
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3263
+ *
3264
+ * **Service Token Accesses**
3265
+ * `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`
3266
+ *
3267
+ * **OAuth Scopes**
3268
+ *
3269
+ * | Resource | Scopes |
3270
+ * | :------- | :---------- |
3271
+ * | Organization | `read_branches` |
3272
+ * | Database | `read_branches` |
3273
+ */
3274
+ public listReadOnlyRegions<ThrowOnError extends boolean = true>(
3275
+ options: Options<ListReadOnlyRegionsData, ThrowOnError>,
3276
+ ) {
3277
+ return (options.client ?? this._client).get<
3278
+ ListReadOnlyRegionsResponses,
3279
+ ListReadOnlyRegionsErrors,
3280
+ ThrowOnError
3281
+ >({
3282
+ url: "/organizations/{organization}/databases/{database}/read-only-regions",
3283
+ ...options,
3284
+ });
3285
+ }
3286
+
3287
+ /**
3288
+ * List database regions
3289
+ *
3290
+ * ### Authorization
3291
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3292
+ *
3293
+ * **Service Token Accesses**
3294
+ * `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`
3295
+ *
3296
+ * **OAuth Scopes**
3297
+ *
3298
+ * | Resource | Scopes |
3299
+ * | :------- | :---------- |
3300
+ * | Organization | `read_databases` |
3301
+ * | Database | `read_database` |
3302
+ */
3303
+ public listDatabaseRegions<ThrowOnError extends boolean = true>(
3304
+ options: Options<ListDatabaseRegionsData, ThrowOnError>,
3305
+ ) {
3306
+ return (options.client ?? this._client).get<
3307
+ ListDatabaseRegionsResponses,
3308
+ ListDatabaseRegionsErrors,
3309
+ ThrowOnError
3310
+ >({
3311
+ url: "/organizations/{organization}/databases/{database}/regions",
3312
+ ...options,
3313
+ });
3314
+ }
3315
+
3316
+ /**
3317
+ * List schema recommendations
3318
+ *
3319
+ * ### Authorization
3320
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3321
+ *
3322
+ * **Service Token Accesses**
3323
+ * `read_database`
3324
+ *
3325
+ * **OAuth Scopes**
3326
+ *
3327
+ * | Resource | Scopes |
3328
+ * | :------- | :---------- |
3329
+ * | Organization | `read_databases` |
3330
+ * | Database | `read_database` |
3331
+ */
3332
+ public listSchemaRecommendations<ThrowOnError extends boolean = true>(
3333
+ options: Options<ListSchemaRecommendationsData, ThrowOnError>,
3334
+ ) {
3335
+ return (options.client ?? this._client).get<
3336
+ ListSchemaRecommendationsResponses,
3337
+ ListSchemaRecommendationsErrors,
3338
+ ThrowOnError
3339
+ >({
3340
+ url: "/organizations/{organization}/databases/{database}/schema-recommendations",
3341
+ ...options,
3342
+ });
3343
+ }
3344
+
3345
+ /**
3346
+ * Get a schema recommendation
3347
+ *
3348
+ * ### Authorization
3349
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3350
+ *
3351
+ * **Service Token Accesses**
3352
+ * `read_database`
3353
+ *
3354
+ * **OAuth Scopes**
3355
+ *
3356
+ * | Resource | Scopes |
3357
+ * | :------- | :---------- |
3358
+ * | Organization | `read_databases` |
3359
+ * | Database | `read_database` |
3360
+ */
3361
+ public getSchemaRecommendation<ThrowOnError extends boolean = true>(
3362
+ options: Options<GetSchemaRecommendationData, ThrowOnError>,
3363
+ ) {
3364
+ return (options.client ?? this._client).get<
3365
+ GetSchemaRecommendationResponses,
3366
+ GetSchemaRecommendationErrors,
3367
+ ThrowOnError
3368
+ >({
3369
+ url: "/organizations/{organization}/databases/{database}/schema-recommendations/{number}",
3370
+ ...options,
3371
+ });
3372
+ }
3373
+
3374
+ /**
3375
+ * Dismiss a schema recommendation
3376
+ *
3377
+ * ### Authorization
3378
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3379
+ *
3380
+ * **Service Token Accesses**
3381
+ * `write_database`
3382
+ *
3383
+ * **OAuth Scopes**
3384
+ *
3385
+ * | Resource | Scopes |
3386
+ * | :------- | :---------- |
3387
+ * | Organization | `write_databases` |
3388
+ * | Database | `write_database` |
3389
+ */
3390
+ public dismissSchemaRecommendation<ThrowOnError extends boolean = true>(
3391
+ options: Options<DismissSchemaRecommendationData, ThrowOnError>,
3392
+ ) {
3393
+ return (options.client ?? this._client).post<
3394
+ DismissSchemaRecommendationResponses,
3395
+ DismissSchemaRecommendationErrors,
3396
+ ThrowOnError
3397
+ >({
3398
+ url: "/organizations/{organization}/databases/{database}/schema-recommendations/{number}/dismiss",
3399
+ ...options,
3400
+ headers: {
3401
+ "Content-Type": "application/json",
3402
+ ...options.headers,
3403
+ },
3404
+ });
3405
+ }
3406
+
3407
+ /**
3408
+ * Get database throttler configurations
3409
+ *
3410
+ * ### Authorization
3411
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3412
+ *
3413
+ * **Service Token Accesses**
3414
+ * `read_deploy_request`, `create_deploy_request`
3415
+ *
3416
+ * **OAuth Scopes**
3417
+ *
3418
+ * | Resource | Scopes |
3419
+ * | :------- | :---------- |
3420
+ * | Organization | `read_databases` |
3421
+ * | Database | `read_database` |
3422
+ */
3423
+ public getDatabaseThrottler<ThrowOnError extends boolean = true>(
3424
+ options: Options<GetDatabaseThrottlerData, ThrowOnError>,
3425
+ ) {
3426
+ return (options.client ?? this._client).get<
3427
+ GetDatabaseThrottlerResponses,
3428
+ GetDatabaseThrottlerErrors,
3429
+ ThrowOnError
3430
+ >({
3431
+ url: "/organizations/{organization}/databases/{database}/throttler",
3432
+ ...options,
3433
+ });
3434
+ }
3435
+
3436
+ /**
3437
+ * Update database throttler configurations
3438
+ *
3439
+ * ### Authorization
3440
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3441
+ *
3442
+ * **Service Token Accesses**
3443
+ * `read_deploy_request`, `create_deploy_request`
3444
+ *
3445
+ * **OAuth Scopes**
3446
+ *
3447
+ * | Resource | Scopes |
3448
+ * | :------- | :---------- |
3449
+ * | Organization | `deploy_deploy_requests` |
3450
+ * | Database | `deploy_deploy_requests` |
3451
+ */
3452
+ public updateDatabaseThrottler<ThrowOnError extends boolean = true>(
3453
+ options: Options<UpdateDatabaseThrottlerData, ThrowOnError>,
3454
+ ) {
3455
+ return (options.client ?? this._client).patch<
3456
+ UpdateDatabaseThrottlerResponses,
3457
+ UpdateDatabaseThrottlerErrors,
3458
+ ThrowOnError
3459
+ >({
3460
+ url: "/organizations/{organization}/databases/{database}/throttler",
3461
+ ...options,
3462
+ headers: {
3463
+ "Content-Type": "application/json",
3464
+ ...options.headers,
3465
+ },
3466
+ });
3467
+ }
3468
+
3469
+ /**
3470
+ * List webhooks
3471
+ * List webhooks for a database
3472
+ * ### Authorization
3473
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3474
+ *
3475
+ * **Service Token Accesses**
3476
+ * `read_database`
3477
+ *
3478
+ * **OAuth Scopes**
3479
+ *
3480
+ * | Resource | Scopes |
3481
+ * | :------- | :---------- |
3482
+ * | Organization | `read_databases` |
3483
+ * | Database | `read_database` |
3484
+ */
3485
+ public listWebhooks<ThrowOnError extends boolean = true>(
3486
+ options: Options<ListWebhooksData, ThrowOnError>,
3487
+ ) {
3488
+ return (options.client ?? this._client).get<
3489
+ ListWebhooksResponses,
3490
+ ListWebhooksErrors,
3491
+ ThrowOnError
3492
+ >({
3493
+ url: "/organizations/{organization}/databases/{database}/webhooks",
3494
+ ...options,
3495
+ });
3496
+ }
3497
+
3498
+ /**
3499
+ * Create a webhook
3500
+ *
3501
+ * ### Authorization
3502
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3503
+ *
3504
+ * **Service Token Accesses**
3505
+ * `write_database`
3506
+ *
3507
+ * **OAuth Scopes**
3508
+ *
3509
+ * | Resource | Scopes |
3510
+ * | :------- | :---------- |
3511
+ * | Organization | `write_databases` |
3512
+ * | Database | `write_database` |
3513
+ */
3514
+ public createWebhook<ThrowOnError extends boolean = true>(
3515
+ options: Options<CreateWebhookData, ThrowOnError>,
3516
+ ) {
3517
+ return (options.client ?? this._client).post<
3518
+ CreateWebhookResponses,
3519
+ CreateWebhookErrors,
3520
+ ThrowOnError
3521
+ >({
3522
+ url: "/organizations/{organization}/databases/{database}/webhooks",
3523
+ ...options,
3524
+ headers: {
3525
+ "Content-Type": "application/json",
3526
+ ...options.headers,
3527
+ },
3528
+ });
3529
+ }
3530
+
3531
+ /**
3532
+ * Delete a webhook
3533
+ *
3534
+ * ### Authorization
3535
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3536
+ *
3537
+ * **Service Token Accesses**
3538
+ * `write_database`
3539
+ *
3540
+ * **OAuth Scopes**
3541
+ *
3542
+ * | Resource | Scopes |
3543
+ * | :------- | :---------- |
3544
+ * | Organization | `write_databases` |
3545
+ * | Database | `write_database` |
3546
+ */
3547
+ public deleteWebhook<ThrowOnError extends boolean = true>(
3548
+ options: Options<DeleteWebhookData, ThrowOnError>,
3549
+ ) {
3550
+ return (options.client ?? this._client).delete<
3551
+ DeleteWebhookResponses,
3552
+ DeleteWebhookErrors,
3553
+ ThrowOnError
3554
+ >({
3555
+ url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
3556
+ ...options,
3557
+ });
3558
+ }
3559
+
3560
+ /**
3561
+ * Get a webhook
3562
+ *
3563
+ * ### Authorization
3564
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3565
+ *
3566
+ * **Service Token Accesses**
3567
+ * `read_database`
3568
+ *
3569
+ * **OAuth Scopes**
3570
+ *
3571
+ * | Resource | Scopes |
3572
+ * | :------- | :---------- |
3573
+ * | Organization | `read_databases` |
3574
+ * | Database | `read_database` |
3575
+ */
3576
+ public getWebhook<ThrowOnError extends boolean = true>(
3577
+ options: Options<GetWebhookData, ThrowOnError>,
3578
+ ) {
3579
+ return (options.client ?? this._client).get<
3580
+ GetWebhookResponses,
3581
+ GetWebhookErrors,
3582
+ ThrowOnError
3583
+ >({
3584
+ url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
3585
+ ...options,
3586
+ });
3587
+ }
3588
+
3589
+ /**
3590
+ * Update a webhook
3591
+ *
3592
+ * ### Authorization
3593
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3594
+ *
3595
+ * **Service Token Accesses**
3596
+ * `write_database`
3597
+ *
3598
+ * **OAuth Scopes**
3599
+ *
3600
+ * | Resource | Scopes |
3601
+ * | :------- | :---------- |
3602
+ * | Organization | `write_databases` |
3603
+ * | Database | `write_database` |
3604
+ */
3605
+ public updateWebhook<ThrowOnError extends boolean = true>(
3606
+ options: Options<UpdateWebhookData, ThrowOnError>,
3607
+ ) {
3608
+ return (options.client ?? this._client).patch<
3609
+ UpdateWebhookResponses,
3610
+ UpdateWebhookErrors,
3611
+ ThrowOnError
3612
+ >({
3613
+ url: "/organizations/{organization}/databases/{database}/webhooks/{id}",
3614
+ ...options,
3615
+ headers: {
3616
+ "Content-Type": "application/json",
3617
+ ...options.headers,
3618
+ },
3619
+ });
3620
+ }
3621
+
3622
+ /**
3623
+ * Test a webhook
3624
+ * Sends a test event to the webhook
3625
+ * ### Authorization
3626
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3627
+ *
3628
+ * **Service Token Accesses**
3629
+ * `write_database`
3630
+ *
3631
+ * **OAuth Scopes**
3632
+ *
3633
+ * | Resource | Scopes |
3634
+ * | :------- | :---------- |
3635
+ * | Organization | `write_databases` |
3636
+ * | Database | `write_database` |
3637
+ */
3638
+ public testWebhook<ThrowOnError extends boolean = true>(
3639
+ options: Options<TestWebhookData, ThrowOnError>,
3640
+ ) {
3641
+ return (options.client ?? this._client).post<
3642
+ TestWebhookResponses,
3643
+ TestWebhookErrors,
3644
+ ThrowOnError
3645
+ >({
3646
+ url: "/organizations/{organization}/databases/{database}/webhooks/{id}/test",
3647
+ ...options,
3648
+ });
3649
+ }
3650
+
3651
+ /**
3652
+ * List workflows
3653
+ *
3654
+ *
3655
+ */
3656
+ public listWorkflows<ThrowOnError extends boolean = true>(
3657
+ options: Options<ListWorkflowsData, ThrowOnError>,
3658
+ ) {
3659
+ return (options.client ?? this._client).get<
3660
+ ListWorkflowsResponses,
3661
+ ListWorkflowsErrors,
3662
+ ThrowOnError
3663
+ >({
3664
+ url: "/organizations/{organization}/databases/{database}/workflows",
3665
+ ...options,
3666
+ });
3667
+ }
3668
+
3669
+ /**
3670
+ * Create a workflow
3671
+ *
3672
+ *
3673
+ */
3674
+ public createWorkflow<ThrowOnError extends boolean = true>(
3675
+ options: Options<CreateWorkflowData, ThrowOnError>,
3676
+ ) {
3677
+ return (options.client ?? this._client).post<
3678
+ CreateWorkflowResponses,
3679
+ CreateWorkflowErrors,
3680
+ ThrowOnError
3681
+ >({
3682
+ url: "/organizations/{organization}/databases/{database}/workflows",
3683
+ ...options,
3684
+ headers: {
3685
+ "Content-Type": "application/json",
3686
+ ...options.headers,
3687
+ },
3688
+ });
3689
+ }
3690
+
3691
+ /**
3692
+ * Cancel a workflow
3693
+ *
3694
+ *
3695
+ */
3696
+ public workflowCancel<ThrowOnError extends boolean = true>(
3697
+ options: Options<WorkflowCancelData, ThrowOnError>,
3698
+ ) {
3699
+ return (options.client ?? this._client).delete<
3700
+ WorkflowCancelResponses,
3701
+ WorkflowCancelErrors,
3702
+ ThrowOnError
3703
+ >({
3704
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}",
3705
+ ...options,
3706
+ });
3707
+ }
3708
+
3709
+ /**
3710
+ * Get a workflow
3711
+ *
3712
+ *
3713
+ */
3714
+ public getWorkflow<ThrowOnError extends boolean = true>(
3715
+ options: Options<GetWorkflowData, ThrowOnError>,
3716
+ ) {
3717
+ return (options.client ?? this._client).get<
3718
+ GetWorkflowResponses,
3719
+ GetWorkflowErrors,
3720
+ ThrowOnError
3721
+ >({
3722
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}",
3723
+ ...options,
3724
+ });
3725
+ }
3726
+
3727
+ /**
3728
+ * Complete a workflow
3729
+ *
3730
+ *
3731
+ */
3732
+ public workflowComplete<ThrowOnError extends boolean = true>(
3733
+ options: Options<WorkflowCompleteData, ThrowOnError>,
3734
+ ) {
3735
+ return (options.client ?? this._client).patch<
3736
+ WorkflowCompleteResponses,
3737
+ WorkflowCompleteErrors,
3738
+ ThrowOnError
3739
+ >({
3740
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/complete",
3741
+ ...options,
3742
+ });
3743
+ }
3744
+
3745
+ /**
3746
+ * Cutover traffic
3747
+ *
3748
+ *
3749
+ */
3750
+ public workflowCutover<ThrowOnError extends boolean = true>(
3751
+ options: Options<WorkflowCutoverData, ThrowOnError>,
3752
+ ) {
3753
+ return (options.client ?? this._client).patch<
3754
+ WorkflowCutoverResponses,
3755
+ WorkflowCutoverErrors,
3756
+ ThrowOnError
3757
+ >({
3758
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/cutover",
3759
+ ...options,
3760
+ });
3761
+ }
3762
+
3763
+ /**
3764
+ * Retry a failed workflow
3765
+ *
3766
+ *
3767
+ */
3768
+ public workflowRetry<ThrowOnError extends boolean = true>(
3769
+ options: Options<WorkflowRetryData, ThrowOnError>,
3770
+ ) {
3771
+ return (options.client ?? this._client).patch<
3772
+ WorkflowRetryResponses,
3773
+ WorkflowRetryErrors,
3774
+ ThrowOnError
3775
+ >({
3776
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/retry",
3777
+ ...options,
3778
+ });
3779
+ }
3780
+
3781
+ /**
3782
+ * Reverse traffic cutover
3783
+ *
3784
+ *
3785
+ */
3786
+ public workflowReverseCutover<ThrowOnError extends boolean = true>(
3787
+ options: Options<WorkflowReverseCutoverData, ThrowOnError>,
3788
+ ) {
3789
+ return (options.client ?? this._client).patch<
3790
+ WorkflowReverseCutoverResponses,
3791
+ WorkflowReverseCutoverErrors,
3792
+ ThrowOnError
3793
+ >({
3794
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/reverse-cutover",
3795
+ ...options,
3796
+ });
3797
+ }
3798
+
3799
+ /**
3800
+ * Reverse traffic
3801
+ *
3802
+ *
3803
+ */
3804
+ public workflowReverseTraffic<ThrowOnError extends boolean = true>(
3805
+ options: Options<WorkflowReverseTrafficData, ThrowOnError>,
3806
+ ) {
3807
+ return (options.client ?? this._client).patch<
3808
+ WorkflowReverseTrafficResponses,
3809
+ WorkflowReverseTrafficErrors,
3810
+ ThrowOnError
3811
+ >({
3812
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/reverse-traffic",
3813
+ ...options,
3814
+ });
3815
+ }
3816
+
3817
+ /**
3818
+ * Switch primary traffic
3819
+ *
3820
+ *
3821
+ */
3822
+ public workflowSwitchPrimaries<ThrowOnError extends boolean = true>(
3823
+ options: Options<WorkflowSwitchPrimariesData, ThrowOnError>,
3824
+ ) {
3825
+ return (options.client ?? this._client).patch<
3826
+ WorkflowSwitchPrimariesResponses,
3827
+ WorkflowSwitchPrimariesErrors,
3828
+ ThrowOnError
3829
+ >({
3830
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/switch-primaries",
3831
+ ...options,
3832
+ });
3833
+ }
3834
+
3835
+ /**
3836
+ * Switch replica traffic
3837
+ *
3838
+ *
3839
+ */
3840
+ public workflowSwitchReplicas<ThrowOnError extends boolean = true>(
3841
+ options: Options<WorkflowSwitchReplicasData, ThrowOnError>,
3842
+ ) {
3843
+ return (options.client ?? this._client).patch<
3844
+ WorkflowSwitchReplicasResponses,
3845
+ WorkflowSwitchReplicasErrors,
3846
+ ThrowOnError
3847
+ >({
3848
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/switch-replicas",
3849
+ ...options,
3850
+ });
3851
+ }
3852
+
3853
+ /**
3854
+ * Verify workflow data
3855
+ *
3856
+ *
3857
+ */
3858
+ public verifyWorkflow<ThrowOnError extends boolean = true>(
3859
+ options: Options<VerifyWorkflowData, ThrowOnError>,
3860
+ ) {
3861
+ return (options.client ?? this._client).patch<
3862
+ VerifyWorkflowResponses,
3863
+ VerifyWorkflowErrors,
3864
+ ThrowOnError
3865
+ >({
3866
+ url: "/organizations/{organization}/databases/{database}/workflows/{number}/verify-data",
3867
+ ...options,
3868
+ });
3869
+ }
3870
+
3871
+ /**
3872
+ * Get invoices
3873
+ * Get the invoices for an organization
3874
+ * ### Authorization
3875
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3876
+ *
3877
+ * **Service Token Accesses**
3878
+ * `read_invoices`
3879
+ *
3880
+ * **OAuth Scopes**
3881
+ *
3882
+ * | Resource | Scopes |
3883
+ * | :------- | :---------- |
3884
+ * | Organization | `read_invoices` |
3885
+ */
3886
+ public listInvoices<ThrowOnError extends boolean = true>(
3887
+ options: Options<ListInvoicesData, ThrowOnError>,
3888
+ ) {
3889
+ return (options.client ?? this._client).get<
3890
+ ListInvoicesResponses,
3891
+ ListInvoicesErrors,
3892
+ ThrowOnError
3893
+ >({
3894
+ url: "/organizations/{organization}/invoices",
3895
+ ...options,
3896
+ });
3897
+ }
3898
+
3899
+ /**
3900
+ * Get an invoice
3901
+ *
3902
+ * ### Authorization
3903
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3904
+ *
3905
+ * **Service Token Accesses**
3906
+ * `read_invoices`
3907
+ *
3908
+ * **OAuth Scopes**
3909
+ *
3910
+ * | Resource | Scopes |
3911
+ * | :------- | :---------- |
3912
+ * | Organization | `read_invoices` |
3913
+ */
3914
+ public getInvoice<ThrowOnError extends boolean = true>(
3915
+ options: Options<GetInvoiceData, ThrowOnError>,
2734
3916
  ) {
2735
- return (options.client ?? this._client).patch<
2736
- WorkflowCompleteResponses,
2737
- WorkflowCompleteErrors,
3917
+ return (options.client ?? this._client).get<
3918
+ GetInvoiceResponses,
3919
+ GetInvoiceErrors,
2738
3920
  ThrowOnError
2739
3921
  >({
2740
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/complete",
3922
+ url: "/organizations/{organization}/invoices/{id}",
2741
3923
  ...options,
2742
3924
  });
2743
3925
  }
2744
3926
 
2745
3927
  /**
2746
- * Cutover traffic
3928
+ * Get invoice line items
3929
+ * Get the line items for an invoice
3930
+ * ### Authorization
3931
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3932
+ *
3933
+ * **Service Token Accesses**
3934
+ * `read_invoices`
2747
3935
  *
3936
+ * **OAuth Scopes**
2748
3937
  *
3938
+ * | Resource | Scopes |
3939
+ * | :------- | :---------- |
3940
+ * | Organization | `read_invoices` |
2749
3941
  */
2750
- public workflowCutover<ThrowOnError extends boolean = true>(
2751
- options: Options<WorkflowCutoverData, ThrowOnError>,
3942
+ public getInvoiceLineItems<ThrowOnError extends boolean = true>(
3943
+ options: Options<GetInvoiceLineItemsData, ThrowOnError>,
2752
3944
  ) {
2753
- return (options.client ?? this._client).patch<
2754
- WorkflowCutoverResponses,
2755
- WorkflowCutoverErrors,
3945
+ return (options.client ?? this._client).get<
3946
+ GetInvoiceLineItemsResponses,
3947
+ GetInvoiceLineItemsErrors,
2756
3948
  ThrowOnError
2757
3949
  >({
2758
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/cutover",
3950
+ url: "/organizations/{organization}/invoices/{id}/line-items",
2759
3951
  ...options,
2760
3952
  });
2761
3953
  }
2762
3954
 
2763
3955
  /**
2764
- * Retry a failed workflow
3956
+ * List organization members
3957
+ *
3958
+ * ### Authorization
3959
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3960
+ *
3961
+ * **Service Token Accesses**
3962
+ * `read_organization`
2765
3963
  *
3964
+ * **OAuth Scopes**
2766
3965
  *
3966
+ * | Resource | Scopes |
3967
+ * | :------- | :---------- |
3968
+ * | Organization | `read_organization` |
2767
3969
  */
2768
- public workflowRetry<ThrowOnError extends boolean = true>(
2769
- options: Options<WorkflowRetryData, ThrowOnError>,
3970
+ public listOrganizationMembers<ThrowOnError extends boolean = true>(
3971
+ options: Options<ListOrganizationMembersData, ThrowOnError>,
2770
3972
  ) {
2771
- return (options.client ?? this._client).patch<
2772
- WorkflowRetryResponses,
2773
- WorkflowRetryErrors,
3973
+ return (options.client ?? this._client).get<
3974
+ ListOrganizationMembersResponses,
3975
+ ListOrganizationMembersErrors,
2774
3976
  ThrowOnError
2775
3977
  >({
2776
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/retry",
3978
+ url: "/organizations/{organization}/members",
2777
3979
  ...options,
2778
3980
  });
2779
3981
  }
2780
3982
 
2781
3983
  /**
2782
- * Reverse traffic cutover
3984
+ * Remove a member from an organization
3985
+ *
3986
+ * ### Authorization
3987
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3988
+ *
3989
+ * **Service Token Accesses**
3990
+ * `write_organization`
2783
3991
  *
3992
+ * **OAuth Scopes**
2784
3993
  *
3994
+ * | Resource | Scopes |
3995
+ * | :------- | :---------- |
3996
+ * | Organization | `write_organization` |
2785
3997
  */
2786
- public workflowReverseCutover<ThrowOnError extends boolean = true>(
2787
- options: Options<WorkflowReverseCutoverData, ThrowOnError>,
3998
+ public removeOrganizationMember<ThrowOnError extends boolean = true>(
3999
+ options: Options<RemoveOrganizationMemberData, ThrowOnError>,
2788
4000
  ) {
2789
- return (options.client ?? this._client).patch<
2790
- WorkflowReverseCutoverResponses,
2791
- WorkflowReverseCutoverErrors,
4001
+ return (options.client ?? this._client).delete<
4002
+ RemoveOrganizationMemberResponses,
4003
+ RemoveOrganizationMemberErrors,
2792
4004
  ThrowOnError
2793
4005
  >({
2794
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/reverse-cutover",
4006
+ url: "/organizations/{organization}/members/{id}",
2795
4007
  ...options,
4008
+ headers: {
4009
+ "Content-Type": "application/json",
4010
+ ...options.headers,
4011
+ },
2796
4012
  });
2797
4013
  }
2798
4014
 
2799
4015
  /**
2800
- * Reverse traffic
4016
+ * Get an organization member
2801
4017
  *
4018
+ * ### Authorization
4019
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
4020
+ *
4021
+ * **Service Token Accesses**
4022
+ * `read_organization`
4023
+ *
4024
+ * **OAuth Scopes**
2802
4025
  *
4026
+ * | Resource | Scopes |
4027
+ * | :------- | :---------- |
4028
+ * | Organization | `read_organization` |
2803
4029
  */
2804
- public workflowReverseTraffic<ThrowOnError extends boolean = true>(
2805
- options: Options<WorkflowReverseTrafficData, ThrowOnError>,
4030
+ public getOrganizationMembership<ThrowOnError extends boolean = true>(
4031
+ options: Options<GetOrganizationMembershipData, ThrowOnError>,
2806
4032
  ) {
2807
- return (options.client ?? this._client).patch<
2808
- WorkflowReverseTrafficResponses,
2809
- WorkflowReverseTrafficErrors,
4033
+ return (options.client ?? this._client).get<
4034
+ GetOrganizationMembershipResponses,
4035
+ GetOrganizationMembershipErrors,
2810
4036
  ThrowOnError
2811
4037
  >({
2812
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/reverse-traffic",
4038
+ url: "/organizations/{organization}/members/{id}",
2813
4039
  ...options,
2814
4040
  });
2815
4041
  }
2816
4042
 
2817
4043
  /**
2818
- * Switch primary traffic
4044
+ * Update organization member role
4045
+ *
4046
+ * ### Authorization
4047
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
4048
+ *
4049
+ * **Service Token Accesses**
4050
+ * `write_organization`
2819
4051
  *
4052
+ * **OAuth Scopes**
2820
4053
  *
4054
+ * | Resource | Scopes |
4055
+ * | :------- | :---------- |
4056
+ * | Organization | `write_organization` |
2821
4057
  */
2822
- public workflowSwitchPrimaries<ThrowOnError extends boolean = true>(
2823
- options: Options<WorkflowSwitchPrimariesData, ThrowOnError>,
4058
+ public updateOrganizationMembership<ThrowOnError extends boolean = true>(
4059
+ options: Options<UpdateOrganizationMembershipData, ThrowOnError>,
2824
4060
  ) {
2825
4061
  return (options.client ?? this._client).patch<
2826
- WorkflowSwitchPrimariesResponses,
2827
- WorkflowSwitchPrimariesErrors,
4062
+ UpdateOrganizationMembershipResponses,
4063
+ UpdateOrganizationMembershipErrors,
2828
4064
  ThrowOnError
2829
4065
  >({
2830
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/switch-primaries",
4066
+ url: "/organizations/{organization}/members/{id}",
2831
4067
  ...options,
4068
+ headers: {
4069
+ "Content-Type": "application/json",
4070
+ ...options.headers,
4071
+ },
2832
4072
  });
2833
4073
  }
2834
4074
 
2835
4075
  /**
2836
- * Switch replica traffic
4076
+ * List OAuth applications
4077
+ *
4078
+ * ### Authorization
4079
+ * A service token must have at least one of the following access in order to use this API endpoint:
4080
+ *
4081
+ * **Service Token Accesses**
4082
+ * `read_oauth_applications`
2837
4083
  *
2838
4084
  *
2839
4085
  */
2840
- public workflowSwitchReplicas<ThrowOnError extends boolean = true>(
2841
- options: Options<WorkflowSwitchReplicasData, ThrowOnError>,
4086
+ public listOauthApplications<ThrowOnError extends boolean = true>(
4087
+ options: Options<ListOauthApplicationsData, ThrowOnError>,
2842
4088
  ) {
2843
- return (options.client ?? this._client).patch<
2844
- WorkflowSwitchReplicasResponses,
2845
- WorkflowSwitchReplicasErrors,
4089
+ return (options.client ?? this._client).get<
4090
+ ListOauthApplicationsResponses,
4091
+ ListOauthApplicationsErrors,
2846
4092
  ThrowOnError
2847
4093
  >({
2848
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/switch-replicas",
4094
+ url: "/organizations/{organization}/oauth-applications",
2849
4095
  ...options,
2850
4096
  });
2851
4097
  }
2852
4098
 
2853
4099
  /**
2854
- * Verify workflow data
4100
+ * Get an OAuth application
4101
+ *
4102
+ * ### Authorization
4103
+ * A service token must have at least one of the following access in order to use this API endpoint:
4104
+ *
4105
+ * **Service Token Accesses**
4106
+ * `read_oauth_applications`
4107
+ *
4108
+ *
4109
+ */
4110
+ public getOauthApplication<ThrowOnError extends boolean = true>(
4111
+ options: Options<GetOauthApplicationData, ThrowOnError>,
4112
+ ) {
4113
+ return (options.client ?? this._client).get<
4114
+ GetOauthApplicationResponses,
4115
+ GetOauthApplicationErrors,
4116
+ ThrowOnError
4117
+ >({
4118
+ url: "/organizations/{organization}/oauth-applications/{application_id}",
4119
+ ...options,
4120
+ });
4121
+ }
4122
+
4123
+ /**
4124
+ * List OAuth tokens
4125
+ * List OAuth tokens created by an OAuth application
4126
+ * ### Authorization
4127
+ * A service token must have at least one of the following access in order to use this API endpoint:
4128
+ *
4129
+ * **Service Token Accesses**
4130
+ * `read_oauth_tokens`
4131
+ *
4132
+ *
4133
+ */
4134
+ public listOauthTokens<ThrowOnError extends boolean = true>(
4135
+ options: Options<ListOauthTokensData, ThrowOnError>,
4136
+ ) {
4137
+ return (options.client ?? this._client).get<
4138
+ ListOauthTokensResponses,
4139
+ ListOauthTokensErrors,
4140
+ ThrowOnError
4141
+ >({
4142
+ url: "/organizations/{organization}/oauth-applications/{application_id}/tokens",
4143
+ ...options,
4144
+ });
4145
+ }
4146
+
4147
+ /**
4148
+ * Delete an OAuth token
4149
+ *
4150
+ * ### Authorization
4151
+ * A service token must have at least one of the following access in order to use this API endpoint:
4152
+ *
4153
+ * **Service Token Accesses**
4154
+ * `delete_oauth_tokens`
4155
+ *
4156
+ *
4157
+ */
4158
+ public deleteOauthToken<ThrowOnError extends boolean = true>(
4159
+ options: Options<DeleteOauthTokenData, ThrowOnError>,
4160
+ ) {
4161
+ return (options.client ?? this._client).delete<
4162
+ DeleteOauthTokenResponses,
4163
+ DeleteOauthTokenErrors,
4164
+ ThrowOnError
4165
+ >({
4166
+ url: "/organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}",
4167
+ ...options,
4168
+ });
4169
+ }
4170
+
4171
+ /**
4172
+ * Get an OAuth token
4173
+ *
4174
+ * ### Authorization
4175
+ * A service token must have at least one of the following access in order to use this API endpoint:
4176
+ *
4177
+ * **Service Token Accesses**
4178
+ * `read_oauth_tokens`
4179
+ *
4180
+ *
4181
+ */
4182
+ public getOauthToken<ThrowOnError extends boolean = true>(
4183
+ options: Options<GetOauthTokenData, ThrowOnError>,
4184
+ ) {
4185
+ return (options.client ?? this._client).get<
4186
+ GetOauthTokenResponses,
4187
+ GetOauthTokenErrors,
4188
+ ThrowOnError
4189
+ >({
4190
+ url: "/organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}",
4191
+ ...options,
4192
+ });
4193
+ }
4194
+
4195
+ /**
4196
+ * Create or renew an OAuth token
4197
+ * Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token
4198
+ * ### Authorization
4199
+ * A service token must have at least one of the following access in order to use this API endpoint:
4200
+ *
4201
+ * **Service Token Accesses**
4202
+ * `write_oauth_tokens`
2855
4203
  *
2856
4204
  *
2857
4205
  */
2858
- public verifyWorkflow<ThrowOnError extends boolean = true>(
2859
- options: Options<VerifyWorkflowData, ThrowOnError>,
4206
+ public createOauthToken<ThrowOnError extends boolean = true>(
4207
+ options: Options<CreateOauthTokenData, ThrowOnError>,
2860
4208
  ) {
2861
- return (options.client ?? this._client).patch<
2862
- VerifyWorkflowResponses,
2863
- VerifyWorkflowErrors,
4209
+ return (options.client ?? this._client).post<
4210
+ CreateOauthTokenResponses,
4211
+ CreateOauthTokenErrors,
2864
4212
  ThrowOnError
2865
4213
  >({
2866
- url: "/organizations/{organization}/databases/{database}/workflows/{number}/verify-data",
4214
+ url: "/organizations/{organization}/oauth-applications/{id}/token",
2867
4215
  ...options,
4216
+ headers: {
4217
+ "Content-Type": "application/json",
4218
+ ...options.headers,
4219
+ },
2868
4220
  });
2869
4221
  }
2870
4222
 
2871
4223
  /**
2872
- * Delete a database
4224
+ * List regions for an organization
2873
4225
  *
2874
4226
  * ### Authorization
2875
4227
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
2876
4228
  *
2877
4229
  * **Service Token Accesses**
2878
- * `delete_database`
4230
+ * `read_organization`
2879
4231
  *
2880
4232
  * **OAuth Scopes**
2881
4233
  *
2882
4234
  * | Resource | Scopes |
2883
4235
  * | :------- | :---------- |
2884
- * | Organization | `delete_databases` |
2885
- * | Database | `delete_database` |
4236
+ * | User | `read_organizations` |
4237
+ * | Organization | `read_organization` |
2886
4238
  */
2887
- public deleteDatabase<ThrowOnError extends boolean = true>(
2888
- options: Options<DeleteDatabaseData, ThrowOnError>,
4239
+ public listRegionsForOrganization<ThrowOnError extends boolean = true>(
4240
+ options: Options<ListRegionsForOrganizationData, ThrowOnError>,
2889
4241
  ) {
2890
- return (options.client ?? this._client).delete<
2891
- DeleteDatabaseResponses,
2892
- DeleteDatabaseErrors,
4242
+ return (options.client ?? this._client).get<
4243
+ ListRegionsForOrganizationResponses,
4244
+ ListRegionsForOrganizationErrors,
2893
4245
  ThrowOnError
2894
4246
  >({
2895
- url: "/organizations/{organization}/databases/{name}",
4247
+ url: "/organizations/{organization}/regions",
2896
4248
  ...options,
2897
4249
  });
2898
4250
  }
2899
4251
 
2900
4252
  /**
2901
- * Get a database
2902
- *
4253
+ * List service tokens
4254
+ * List service tokens for an organization.
2903
4255
  * ### Authorization
2904
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
4256
+ * A service token must have at least one of the following access in order to use this API endpoint:
2905
4257
  *
2906
4258
  * **Service Token Accesses**
2907
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `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`
4259
+ * `read_service_tokens`
2908
4260
  *
2909
- * **OAuth Scopes**
2910
4261
  *
2911
- * | Resource | Scopes |
2912
- * | :------- | :---------- |
2913
- * | Organization | `read_databases` |
2914
- * | Database | `read_database` |
2915
4262
  */
2916
- public getDatabase<ThrowOnError extends boolean = true>(
2917
- options: Options<GetDatabaseData, ThrowOnError>,
4263
+ public listServiceTokens<ThrowOnError extends boolean = true>(
4264
+ options: Options<ListServiceTokensData, ThrowOnError>,
2918
4265
  ) {
2919
4266
  return (options.client ?? this._client).get<
2920
- GetDatabaseResponses,
2921
- GetDatabaseErrors,
4267
+ ListServiceTokensResponses,
4268
+ ListServiceTokensErrors,
2922
4269
  ThrowOnError
2923
4270
  >({
2924
- url: "/organizations/{organization}/databases/{name}",
4271
+ url: "/organizations/{organization}/service-tokens",
2925
4272
  ...options,
2926
4273
  });
2927
4274
  }
2928
4275
 
2929
4276
  /**
2930
- * Update database settings
2931
- *
4277
+ * Create a service token
4278
+ * Create a new service token for the organization.
2932
4279
  * ### Authorization
2933
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
4280
+ * A service token must have at least one of the following access in order to use this API endpoint:
2934
4281
  *
2935
4282
  * **Service Token Accesses**
2936
- * `write_database`
4283
+ * `write_service_tokens`
2937
4284
  *
2938
- * **OAuth Scopes**
2939
4285
  *
2940
- * | Resource | Scopes |
2941
- * | :------- | :---------- |
2942
- * | Organization | `write_databases` |
2943
- * | Database | `write_database` |
2944
4286
  */
2945
- public updateDatabaseSettings<ThrowOnError extends boolean = true>(
2946
- options: Options<UpdateDatabaseSettingsData, ThrowOnError>,
4287
+ public createServiceToken<ThrowOnError extends boolean = true>(
4288
+ options: Options<CreateServiceTokenData, ThrowOnError>,
2947
4289
  ) {
2948
- return (options.client ?? this._client).patch<
2949
- UpdateDatabaseSettingsResponses,
2950
- UpdateDatabaseSettingsErrors,
4290
+ return (options.client ?? this._client).post<
4291
+ CreateServiceTokenResponses,
4292
+ CreateServiceTokenErrors,
2951
4293
  ThrowOnError
2952
4294
  >({
2953
- url: "/organizations/{organization}/databases/{name}",
4295
+ url: "/organizations/{organization}/service-tokens",
2954
4296
  ...options,
2955
4297
  headers: {
2956
4298
  "Content-Type": "application/json",
@@ -2960,316 +4302,318 @@ export class PlanetScaleClient extends _HeyApiClient {
2960
4302
  }
2961
4303
 
2962
4304
  /**
2963
- * List read-only regions
2964
- * List read-only regions for the database's default branch
4305
+ * Delete a service token
4306
+ * Delete a service token from the organization.
2965
4307
  * ### Authorization
2966
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
4308
+ * A service token must have at least one of the following access in order to use this API endpoint:
2967
4309
  *
2968
4310
  * **Service Token Accesses**
2969
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `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`
4311
+ * `delete_service_tokens`
2970
4312
  *
2971
- * **OAuth Scopes**
2972
4313
  *
2973
- * | Resource | Scopes |
2974
- * | :------- | :---------- |
2975
- * | Organization | `read_branches` |
2976
- * | Database | `read_branches` |
2977
4314
  */
2978
- public listReadOnlyRegions<ThrowOnError extends boolean = true>(
2979
- options: Options<ListReadOnlyRegionsData, ThrowOnError>,
4315
+ public deleteServiceToken<ThrowOnError extends boolean = true>(
4316
+ options: Options<DeleteServiceTokenData, ThrowOnError>,
2980
4317
  ) {
2981
- return (options.client ?? this._client).get<
2982
- ListReadOnlyRegionsResponses,
2983
- ListReadOnlyRegionsErrors,
4318
+ return (options.client ?? this._client).delete<
4319
+ DeleteServiceTokenResponses,
4320
+ DeleteServiceTokenErrors,
2984
4321
  ThrowOnError
2985
4322
  >({
2986
- url: "/organizations/{organization}/databases/{name}/read-only-regions",
4323
+ url: "/organizations/{organization}/service-tokens/{id}",
2987
4324
  ...options,
2988
4325
  });
2989
4326
  }
2990
4327
 
2991
4328
  /**
2992
- * List database regions
2993
- *
4329
+ * Get a service token
4330
+ * Get information about a service token.
2994
4331
  * ### Authorization
2995
- * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
4332
+ * A service token must have at least one of the following access in order to use this API endpoint:
2996
4333
  *
2997
4334
  * **Service Token Accesses**
2998
- * `read_database`, `delete_database`, `write_database`, `read_branch`, `delete_branch`, `create_branch`, `delete_production_branch`, `connect_branch`, `connect_production_branch`, `delete_branch_password`, `delete_production_branch_password`, `read_deploy_request`, `create_deploy_request`, `approve_deploy_request`, `read_schema_recommendations`, `close_schema_recommendations`, `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`
4335
+ * `read_service_tokens`
2999
4336
  *
3000
- * **OAuth Scopes**
3001
4337
  *
3002
- * | Resource | Scopes |
3003
- * | :------- | :---------- |
3004
- * | Organization | `read_databases` |
3005
- * | Database | `read_database` |
3006
4338
  */
3007
- public listDatabaseRegions<ThrowOnError extends boolean = true>(
3008
- options: Options<ListDatabaseRegionsData, ThrowOnError>,
4339
+ public getServiceToken<ThrowOnError extends boolean = true>(
4340
+ options: Options<GetServiceTokenData, ThrowOnError>,
3009
4341
  ) {
3010
4342
  return (options.client ?? this._client).get<
3011
- ListDatabaseRegionsResponses,
3012
- ListDatabaseRegionsErrors,
4343
+ GetServiceTokenResponses,
4344
+ GetServiceTokenErrors,
3013
4345
  ThrowOnError
3014
4346
  >({
3015
- url: "/organizations/{organization}/databases/{name}/regions",
4347
+ url: "/organizations/{organization}/service-tokens/{id}",
3016
4348
  ...options,
3017
4349
  });
3018
4350
  }
3019
4351
 
3020
4352
  /**
3021
- * Get invoices
3022
- * Get the invoices for an organization
4353
+ * List teams in an organization
4354
+ *
3023
4355
  * ### Authorization
3024
4356
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3025
4357
  *
3026
4358
  * **Service Token Accesses**
3027
- * `read_invoices`
4359
+ * `read_organization`
3028
4360
  *
3029
4361
  * **OAuth Scopes**
3030
4362
  *
3031
4363
  * | Resource | Scopes |
3032
4364
  * | :------- | :---------- |
3033
- * | Organization | `read_invoices` |
4365
+ * | Organization | `read_organization` |
3034
4366
  */
3035
- public listInvoices<ThrowOnError extends boolean = true>(
3036
- options: Options<ListInvoicesData, ThrowOnError>,
4367
+ public listOrganizationTeams<ThrowOnError extends boolean = true>(
4368
+ options: Options<ListOrganizationTeamsData, ThrowOnError>,
3037
4369
  ) {
3038
4370
  return (options.client ?? this._client).get<
3039
- ListInvoicesResponses,
3040
- ListInvoicesErrors,
4371
+ ListOrganizationTeamsResponses,
4372
+ ListOrganizationTeamsErrors,
3041
4373
  ThrowOnError
3042
4374
  >({
3043
- url: "/organizations/{organization}/invoices",
4375
+ url: "/organizations/{organization}/teams",
3044
4376
  ...options,
3045
4377
  });
3046
4378
  }
3047
4379
 
3048
4380
  /**
3049
- * Get an invoice
4381
+ * Create an organization team
3050
4382
  *
3051
4383
  * ### Authorization
3052
4384
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3053
4385
  *
3054
4386
  * **Service Token Accesses**
3055
- * `read_invoices`
4387
+ * `write_teams`
3056
4388
  *
3057
4389
  * **OAuth Scopes**
3058
4390
  *
3059
4391
  * | Resource | Scopes |
3060
4392
  * | :------- | :---------- |
3061
- * | Organization | `read_invoices` |
4393
+ * | Organization | `write_organization` |
3062
4394
  */
3063
- public getInvoice<ThrowOnError extends boolean = true>(
3064
- options: Options<GetInvoiceData, ThrowOnError>,
4395
+ public createOrganizationTeam<ThrowOnError extends boolean = true>(
4396
+ options: Options<CreateOrganizationTeamData, ThrowOnError>,
3065
4397
  ) {
3066
- return (options.client ?? this._client).get<
3067
- GetInvoiceResponses,
3068
- GetInvoiceErrors,
4398
+ return (options.client ?? this._client).post<
4399
+ CreateOrganizationTeamResponses,
4400
+ CreateOrganizationTeamErrors,
3069
4401
  ThrowOnError
3070
4402
  >({
3071
- url: "/organizations/{organization}/invoices/{id}",
4403
+ url: "/organizations/{organization}/teams",
3072
4404
  ...options,
4405
+ headers: {
4406
+ "Content-Type": "application/json",
4407
+ ...options.headers,
4408
+ },
3073
4409
  });
3074
4410
  }
3075
4411
 
3076
4412
  /**
3077
- * Get invoice line items
3078
- * Get the line items for an invoice
4413
+ * Delete an organization team
4414
+ *
3079
4415
  * ### Authorization
3080
4416
  * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3081
4417
  *
3082
4418
  * **Service Token Accesses**
3083
- * `read_invoices`
4419
+ * `write_teams`
3084
4420
  *
3085
4421
  * **OAuth Scopes**
3086
4422
  *
3087
4423
  * | Resource | Scopes |
3088
4424
  * | :------- | :---------- |
3089
- * | Organization | `read_invoices` |
4425
+ * | Organization | `write_organization` |
3090
4426
  */
3091
- public getInvoiceLineItems<ThrowOnError extends boolean = true>(
3092
- options: Options<GetInvoiceLineItemsData, ThrowOnError>,
4427
+ public deleteOrganizationTeam<ThrowOnError extends boolean = true>(
4428
+ options: Options<DeleteOrganizationTeamData, ThrowOnError>,
3093
4429
  ) {
3094
- return (options.client ?? this._client).get<
3095
- GetInvoiceLineItemsResponses,
3096
- GetInvoiceLineItemsErrors,
4430
+ return (options.client ?? this._client).delete<
4431
+ DeleteOrganizationTeamResponses,
4432
+ DeleteOrganizationTeamErrors,
3097
4433
  ThrowOnError
3098
4434
  >({
3099
- url: "/organizations/{organization}/invoices/{id}/line-items",
4435
+ url: "/organizations/{organization}/teams/{team}",
3100
4436
  ...options,
3101
4437
  });
3102
4438
  }
3103
4439
 
3104
4440
  /**
3105
- * List organization members
4441
+ * Get an organization team
3106
4442
  *
3107
4443
  * ### Authorization
3108
- * A service token must have at least one of the following access in order to use this API endpoint:
4444
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3109
4445
  *
3110
4446
  * **Service Token Accesses**
3111
4447
  * `read_organization`
3112
4448
  *
4449
+ * **OAuth Scopes**
3113
4450
  *
4451
+ * | Resource | Scopes |
4452
+ * | :------- | :---------- |
4453
+ * | Organization | `read_organization` |
3114
4454
  */
3115
- public listOrganizationMembers<ThrowOnError extends boolean = true>(
3116
- options: Options<ListOrganizationMembersData, ThrowOnError>,
4455
+ public getOrganizationTeam<ThrowOnError extends boolean = true>(
4456
+ options: Options<GetOrganizationTeamData, ThrowOnError>,
3117
4457
  ) {
3118
4458
  return (options.client ?? this._client).get<
3119
- ListOrganizationMembersResponses,
3120
- ListOrganizationMembersErrors,
4459
+ GetOrganizationTeamResponses,
4460
+ GetOrganizationTeamErrors,
3121
4461
  ThrowOnError
3122
4462
  >({
3123
- url: "/organizations/{organization}/members",
4463
+ url: "/organizations/{organization}/teams/{team}",
3124
4464
  ...options,
3125
4465
  });
3126
4466
  }
3127
4467
 
3128
4468
  /**
3129
- * List OAuth applications
4469
+ * Update an organization team
3130
4470
  *
3131
4471
  * ### Authorization
3132
- * A service token must have at least one of the following access in order to use this API endpoint:
4472
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3133
4473
  *
3134
4474
  * **Service Token Accesses**
3135
- * `read_oauth_applications`
4475
+ * `write_teams`
3136
4476
  *
4477
+ * **OAuth Scopes**
3137
4478
  *
4479
+ * | Resource | Scopes |
4480
+ * | :------- | :---------- |
4481
+ * | Organization | `write_organization` |
3138
4482
  */
3139
- public listOauthApplications<ThrowOnError extends boolean = true>(
3140
- options: Options<ListOauthApplicationsData, ThrowOnError>,
4483
+ public updateOrganizationTeam<ThrowOnError extends boolean = true>(
4484
+ options: Options<UpdateOrganizationTeamData, ThrowOnError>,
3141
4485
  ) {
3142
- return (options.client ?? this._client).get<
3143
- ListOauthApplicationsResponses,
3144
- ListOauthApplicationsErrors,
4486
+ return (options.client ?? this._client).patch<
4487
+ UpdateOrganizationTeamResponses,
4488
+ UpdateOrganizationTeamErrors,
3145
4489
  ThrowOnError
3146
4490
  >({
3147
- url: "/organizations/{organization}/oauth-applications",
4491
+ url: "/organizations/{organization}/teams/{team}",
3148
4492
  ...options,
4493
+ headers: {
4494
+ "Content-Type": "application/json",
4495
+ ...options.headers,
4496
+ },
3149
4497
  });
3150
4498
  }
3151
4499
 
3152
4500
  /**
3153
- * Get an OAuth application
4501
+ * List team members
3154
4502
  *
3155
4503
  * ### Authorization
3156
- * A service token must have at least one of the following access in order to use this API endpoint:
4504
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3157
4505
  *
3158
4506
  * **Service Token Accesses**
3159
- * `read_oauth_applications`
4507
+ * `read_organization`
3160
4508
  *
4509
+ * **OAuth Scopes**
3161
4510
  *
4511
+ * | Resource | Scopes |
4512
+ * | :------- | :---------- |
4513
+ * | Organization | `read_organization` |
3162
4514
  */
3163
- public getOauthApplication<ThrowOnError extends boolean = true>(
3164
- options: Options<GetOauthApplicationData, ThrowOnError>,
4515
+ public listOrganizationTeamMembers<ThrowOnError extends boolean = true>(
4516
+ options: Options<ListOrganizationTeamMembersData, ThrowOnError>,
3165
4517
  ) {
3166
4518
  return (options.client ?? this._client).get<
3167
- GetOauthApplicationResponses,
3168
- GetOauthApplicationErrors,
4519
+ ListOrganizationTeamMembersResponses,
4520
+ ListOrganizationTeamMembersErrors,
3169
4521
  ThrowOnError
3170
4522
  >({
3171
- url: "/organizations/{organization}/oauth-applications/{application_id}",
4523
+ url: "/organizations/{organization}/teams/{team}/members",
3172
4524
  ...options,
3173
4525
  });
3174
4526
  }
3175
4527
 
3176
4528
  /**
3177
- * List OAuth tokens
3178
- * List OAuth tokens created by an OAuth application
4529
+ * Add a member to a team
4530
+ *
3179
4531
  * ### Authorization
3180
- * A service token must have at least one of the following access in order to use this API endpoint:
4532
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3181
4533
  *
3182
4534
  * **Service Token Accesses**
3183
- * `read_oauth_tokens`
4535
+ * `write_teams`
3184
4536
  *
4537
+ * **OAuth Scopes**
3185
4538
  *
4539
+ * | Resource | Scopes |
4540
+ * | :------- | :---------- |
4541
+ * | Organization | `write_organization` |
3186
4542
  */
3187
- public listOauthTokens<ThrowOnError extends boolean = true>(
3188
- options: Options<ListOauthTokensData, ThrowOnError>,
4543
+ public addOrganizationTeamMember<ThrowOnError extends boolean = true>(
4544
+ options: Options<AddOrganizationTeamMemberData, ThrowOnError>,
3189
4545
  ) {
3190
- return (options.client ?? this._client).get<
3191
- ListOauthTokensResponses,
3192
- ListOauthTokensErrors,
4546
+ return (options.client ?? this._client).post<
4547
+ AddOrganizationTeamMemberResponses,
4548
+ AddOrganizationTeamMemberErrors,
3193
4549
  ThrowOnError
3194
4550
  >({
3195
- url: "/organizations/{organization}/oauth-applications/{application_id}/tokens",
4551
+ url: "/organizations/{organization}/teams/{team}/members",
3196
4552
  ...options,
4553
+ headers: {
4554
+ "Content-Type": "application/json",
4555
+ ...options.headers,
4556
+ },
3197
4557
  });
3198
4558
  }
3199
4559
 
3200
4560
  /**
3201
- * Delete an OAuth token
4561
+ * Remove a member from a team
3202
4562
  *
3203
4563
  * ### Authorization
3204
- * A service token must have at least one of the following access in order to use this API endpoint:
4564
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3205
4565
  *
3206
4566
  * **Service Token Accesses**
3207
- * `delete_oauth_tokens`
4567
+ * `write_teams`
3208
4568
  *
4569
+ * **OAuth Scopes**
3209
4570
  *
4571
+ * | Resource | Scopes |
4572
+ * | :------- | :---------- |
4573
+ * | Organization | `write_organization` |
3210
4574
  */
3211
- public deleteOauthToken<ThrowOnError extends boolean = true>(
3212
- options: Options<DeleteOauthTokenData, ThrowOnError>,
4575
+ public removeOrganizationTeamMember<ThrowOnError extends boolean = true>(
4576
+ options: Options<RemoveOrganizationTeamMemberData, ThrowOnError>,
3213
4577
  ) {
3214
4578
  return (options.client ?? this._client).delete<
3215
- DeleteOauthTokenResponses,
3216
- DeleteOauthTokenErrors,
4579
+ RemoveOrganizationTeamMemberResponses,
4580
+ RemoveOrganizationTeamMemberErrors,
3217
4581
  ThrowOnError
3218
4582
  >({
3219
- url: "/organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}",
4583
+ url: "/organizations/{organization}/teams/{team}/members/{id}",
3220
4584
  ...options,
4585
+ headers: {
4586
+ "Content-Type": "application/json",
4587
+ ...options.headers,
4588
+ },
3221
4589
  });
3222
4590
  }
3223
4591
 
3224
4592
  /**
3225
- * Get an OAuth token
4593
+ * Get a team member
3226
4594
  *
3227
4595
  * ### Authorization
3228
- * A service token must have at least one of the following access in order to use this API endpoint:
4596
+ * A service token or OAuth token must have at least one of the following access or scopes in order to use this API endpoint:
3229
4597
  *
3230
4598
  * **Service Token Accesses**
3231
- * `read_oauth_tokens`
4599
+ * `read_organization`
3232
4600
  *
4601
+ * **OAuth Scopes**
3233
4602
  *
4603
+ * | Resource | Scopes |
4604
+ * | :------- | :---------- |
4605
+ * | Organization | `read_organization` |
3234
4606
  */
3235
- public getOauthToken<ThrowOnError extends boolean = true>(
3236
- options: Options<GetOauthTokenData, ThrowOnError>,
4607
+ public getOrganizationTeamMember<ThrowOnError extends boolean = true>(
4608
+ options: Options<GetOrganizationTeamMemberData, ThrowOnError>,
3237
4609
  ) {
3238
4610
  return (options.client ?? this._client).get<
3239
- GetOauthTokenResponses,
3240
- GetOauthTokenErrors,
3241
- ThrowOnError
3242
- >({
3243
- url: "/organizations/{organization}/oauth-applications/{application_id}/tokens/{token_id}",
3244
- ...options,
3245
- });
3246
- }
3247
-
3248
- /**
3249
- * Create or renew an OAuth token
3250
- * Create an OAuth token from an authorization grant code, or refresh an OAuth token from a refresh token
3251
- * ### Authorization
3252
- * A service token must have at least one of the following access in order to use this API endpoint:
3253
- *
3254
- * **Service Token Accesses**
3255
- * `write_oauth_tokens`
3256
- *
3257
- *
3258
- */
3259
- public createOauthToken<ThrowOnError extends boolean = true>(
3260
- options: Options<CreateOauthTokenData, ThrowOnError>,
3261
- ) {
3262
- return (options.client ?? this._client).post<
3263
- CreateOauthTokenResponses,
3264
- CreateOauthTokenErrors,
4611
+ GetOrganizationTeamMemberResponses,
4612
+ GetOrganizationTeamMemberErrors,
3265
4613
  ThrowOnError
3266
4614
  >({
3267
- url: "/organizations/{organization}/oauth-applications/{id}/token",
4615
+ url: "/organizations/{organization}/teams/{team}/members/{id}",
3268
4616
  ...options,
3269
- headers: {
3270
- "Content-Type": "application/json",
3271
- ...options.headers,
3272
- },
3273
4617
  });
3274
4618
  }
3275
4619