@scaleway/sdk 2.67.0 → 2.69.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 (136) hide show
  1. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +6 -1
  2. package/dist/api/audit_trail/v1alpha1/api.gen.js +6 -1
  3. package/dist/api/audit_trail/v1alpha1/marshalling.gen.cjs +6 -0
  4. package/dist/api/audit_trail/v1alpha1/marshalling.gen.js +6 -0
  5. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +55 -15
  6. package/dist/api/audit_trail/v1alpha1/validation-rules.gen.cjs +3 -0
  7. package/dist/api/audit_trail/v1alpha1/validation-rules.gen.d.ts +3 -0
  8. package/dist/api/audit_trail/v1alpha1/validation-rules.gen.js +3 -0
  9. package/dist/api/baremetal/v1/api.gen.cjs +13 -0
  10. package/dist/api/baremetal/v1/api.gen.d.ts +8 -1
  11. package/dist/api/baremetal/v1/api.gen.js +13 -0
  12. package/dist/api/baremetal/v1/content.gen.cjs +2 -1
  13. package/dist/api/baremetal/v1/content.gen.js +2 -1
  14. package/dist/api/baremetal/v1/index.gen.d.ts +1 -1
  15. package/dist/api/baremetal/v1/marshalling.gen.cjs +1 -0
  16. package/dist/api/baremetal/v1/marshalling.gen.js +1 -0
  17. package/dist/api/baremetal/v1/types.gen.d.ts +9 -1
  18. package/dist/api/billing/v2beta1/api.gen.cjs +9 -2
  19. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -2
  20. package/dist/api/billing/v2beta1/api.gen.js +9 -2
  21. package/dist/api/billing/v2beta1/types.gen.d.ts +1 -1
  22. package/dist/api/block/index.gen.cjs +4 -2
  23. package/dist/api/block/index.gen.d.ts +1 -0
  24. package/dist/api/block/index.gen.js +4 -2
  25. package/dist/api/block/v1/api.gen.cjs +303 -0
  26. package/dist/api/block/v1/api.gen.d.ts +152 -0
  27. package/dist/api/block/v1/api.gen.js +303 -0
  28. package/dist/api/block/v1/content.gen.cjs +22 -0
  29. package/dist/api/block/v1/content.gen.d.ts +7 -0
  30. package/dist/api/block/v1/content.gen.js +22 -0
  31. package/dist/api/block/v1/index.gen.cjs +10 -0
  32. package/dist/api/block/v1/index.gen.d.ts +4 -0
  33. package/dist/api/block/v1/index.gen.js +10 -0
  34. package/dist/api/block/v1/marshalling.gen.cjs +200 -0
  35. package/dist/api/block/v1/marshalling.gen.d.ts +14 -0
  36. package/dist/api/block/v1/marshalling.gen.js +200 -0
  37. package/dist/api/block/v1/types.gen.d.ts +335 -0
  38. package/dist/api/block/v1/validation-rules.gen.cjs +56 -0
  39. package/dist/api/block/v1/validation-rules.gen.d.ts +47 -0
  40. package/dist/api/block/v1/validation-rules.gen.js +56 -0
  41. package/dist/api/block/v1alpha1/api.gen.cjs +1 -0
  42. package/dist/api/block/v1alpha1/api.gen.js +1 -0
  43. package/dist/api/block/v1alpha1/types.gen.d.ts +5 -0
  44. package/dist/api/edge_services/index.gen.cjs +2 -0
  45. package/dist/api/edge_services/index.gen.d.ts +1 -0
  46. package/dist/api/edge_services/index.gen.js +3 -1
  47. package/dist/api/edge_services/v1beta1/api.gen.cjs +941 -0
  48. package/dist/api/edge_services/v1beta1/api.gen.d.ts +454 -0
  49. package/dist/api/edge_services/v1beta1/api.gen.js +941 -0
  50. package/dist/api/edge_services/v1beta1/content.gen.cjs +8 -0
  51. package/dist/api/edge_services/v1beta1/content.gen.d.ts +5 -0
  52. package/dist/api/edge_services/v1beta1/content.gen.js +8 -0
  53. package/dist/api/{webhosting/v1alpha1 → edge_services/v1beta1}/index.gen.cjs +2 -2
  54. package/dist/api/edge_services/v1beta1/index.gen.d.ts +4 -0
  55. package/dist/api/edge_services/v1beta1/index.gen.js +9 -0
  56. package/dist/api/edge_services/v1beta1/marshalling.gen.cjs +809 -0
  57. package/dist/api/edge_services/v1beta1/marshalling.gen.d.ts +54 -0
  58. package/dist/api/edge_services/v1beta1/marshalling.gen.js +809 -0
  59. package/dist/api/edge_services/v1beta1/types.gen.d.ts +1218 -0
  60. package/dist/api/edge_services/v1beta1/validation-rules.gen.cjs +23 -0
  61. package/dist/api/edge_services/v1beta1/validation-rules.gen.d.ts +18 -0
  62. package/dist/api/edge_services/v1beta1/validation-rules.gen.js +23 -0
  63. package/dist/api/iam/v1alpha1/api.gen.cjs +7 -0
  64. package/dist/api/iam/v1alpha1/api.gen.d.ts +2 -1
  65. package/dist/api/iam/v1alpha1/api.gen.js +8 -1
  66. package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
  67. package/dist/api/iam/v1alpha1/marshalling.gen.cjs +51 -0
  68. package/dist/api/iam/v1alpha1/marshalling.gen.d.ts +2 -1
  69. package/dist/api/iam/v1alpha1/marshalling.gen.js +51 -0
  70. package/dist/api/iam/v1alpha1/types.gen.d.ts +24 -0
  71. package/dist/api/instance/v1/api.gen.cjs +18 -0
  72. package/dist/api/instance/v1/api.gen.d.ts +13 -1
  73. package/dist/api/instance/v1/api.gen.js +19 -1
  74. package/dist/api/instance/v1/index.gen.d.ts +1 -1
  75. package/dist/api/instance/v1/marshalling.gen.cjs +12 -0
  76. package/dist/api/instance/v1/marshalling.gen.d.ts +2 -1
  77. package/dist/api/instance/v1/marshalling.gen.js +12 -0
  78. package/dist/api/instance/v1/types.gen.d.ts +12 -0
  79. package/dist/api/lb/v1/marshalling.gen.cjs +2 -0
  80. package/dist/api/lb/v1/marshalling.gen.js +2 -0
  81. package/dist/api/lb/v1/types.gen.d.ts +2 -0
  82. package/dist/api/mongodb/v1alpha1/api.gen.cjs +11 -0
  83. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +2 -1
  84. package/dist/api/mongodb/v1alpha1/api.gen.js +12 -1
  85. package/dist/api/mongodb/v1alpha1/index.gen.d.ts +1 -1
  86. package/dist/api/mongodb/v1alpha1/marshalling.gen.cjs +26 -1
  87. package/dist/api/mongodb/v1alpha1/marshalling.gen.d.ts +2 -1
  88. package/dist/api/mongodb/v1alpha1/marshalling.gen.js +26 -1
  89. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +29 -0
  90. package/dist/api/mongodb/v1alpha1/validation-rules.gen.cjs +8 -0
  91. package/dist/api/mongodb/v1alpha1/validation-rules.gen.d.ts +7 -0
  92. package/dist/api/mongodb/v1alpha1/validation-rules.gen.js +8 -0
  93. package/dist/api/secret/v1beta1/api.gen.cjs +2 -34
  94. package/dist/api/secret/v1beta1/api.gen.d.ts +3 -19
  95. package/dist/api/secret/v1beta1/api.gen.js +2 -34
  96. package/dist/api/secret/v1beta1/index.gen.d.ts +1 -1
  97. package/dist/api/secret/v1beta1/types.gen.d.ts +3 -19
  98. package/dist/api/tem/v1alpha1/types.gen.d.ts +5 -5
  99. package/dist/api/vpcgw/v1/api.gen.cjs +7 -0
  100. package/dist/api/vpcgw/v1/api.gen.d.ts +7 -0
  101. package/dist/api/vpcgw/v1/api.gen.js +7 -0
  102. package/dist/api/vpcgw/v1/types.gen.d.ts +1 -0
  103. package/dist/api/webhosting/index.gen.cjs +0 -2
  104. package/dist/api/webhosting/index.gen.d.ts +0 -1
  105. package/dist/api/webhosting/index.gen.js +1 -3
  106. package/dist/api/webhosting/v1/content.gen.cjs +0 -6
  107. package/dist/api/webhosting/v1/content.gen.d.ts +1 -3
  108. package/dist/api/webhosting/v1/content.gen.js +0 -6
  109. package/dist/api/webhosting/v1/index.gen.cjs +0 -1
  110. package/dist/api/webhosting/v1/index.gen.d.ts +1 -1
  111. package/dist/api/webhosting/v1/index.gen.js +1 -2
  112. package/dist/api/webhosting/v1/marshalling.gen.cjs +1 -2
  113. package/dist/api/webhosting/v1/marshalling.gen.js +1 -2
  114. package/dist/api/webhosting/v1/types.gen.d.ts +3 -6
  115. package/dist/scw/constants.cjs +1 -1
  116. package/dist/scw/constants.d.ts +2 -2
  117. package/dist/scw/constants.js +1 -1
  118. package/dist/scw/errors/standard/quotas-exceeded-error.cjs +1 -1
  119. package/dist/scw/errors/standard/quotas-exceeded-error.d.ts +4 -4
  120. package/dist/scw/errors/standard/quotas-exceeded-error.js +1 -1
  121. package/package.json +2 -2
  122. package/dist/api/webhosting/v1alpha1/api.gen.cjs +0 -339
  123. package/dist/api/webhosting/v1alpha1/api.gen.d.ts +0 -168
  124. package/dist/api/webhosting/v1alpha1/api.gen.js +0 -339
  125. package/dist/api/webhosting/v1alpha1/content.gen.cjs +0 -8
  126. package/dist/api/webhosting/v1alpha1/content.gen.d.ts +0 -3
  127. package/dist/api/webhosting/v1alpha1/content.gen.js +0 -8
  128. package/dist/api/webhosting/v1alpha1/index.gen.d.ts +0 -4
  129. package/dist/api/webhosting/v1alpha1/index.gen.js +0 -9
  130. package/dist/api/webhosting/v1alpha1/marshalling.gen.cjs +0 -300
  131. package/dist/api/webhosting/v1alpha1/marshalling.gen.d.ts +0 -17
  132. package/dist/api/webhosting/v1alpha1/marshalling.gen.js +0 -300
  133. package/dist/api/webhosting/v1alpha1/types.gen.d.ts +0 -480
  134. package/dist/api/webhosting/v1alpha1/validation-rules.gen.cjs +0 -32
  135. package/dist/api/webhosting/v1alpha1/validation-rules.gen.d.ts +0 -27
  136. package/dist/api/webhosting/v1alpha1/validation-rules.gen.js +0 -32
@@ -407,6 +407,17 @@ class API extends api.API {
407
407
  method: "DELETE",
408
408
  path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/users/${marshalling.validatePathParam("name", request.name)}`
409
409
  });
410
+ setUserRole = (request) => this.client.fetch(
411
+ {
412
+ body: JSON.stringify(
413
+ marshalling_gen.marshalSetUserRoleRequest(request, this.client.settings)
414
+ ),
415
+ headers: jsonContentHeaders,
416
+ method: "PUT",
417
+ path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/roles`
418
+ },
419
+ marshalling_gen.unmarshalUser
420
+ );
410
421
  /**
411
422
  * Delete a Database Instance endpoint. Delete the endpoint of a Database
412
423
  * Instance. You must specify the `endpoint_id` parameter of the endpoint you
@@ -1,6 +1,6 @@
1
1
  import { API as ParentAPI } from '../../../bridge';
2
2
  import type { Region as ScwRegion, WaitForOptions } from '../../../bridge';
3
- import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, RestoreSnapshotRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
3
+ import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
4
4
  /**
5
5
  * Managed MongoDB®.
6
6
  *
@@ -215,6 +215,7 @@ export declare class API extends ParentAPI {
215
215
  * @param request - The request {@link DeleteUserRequest}
216
216
  */
217
217
  deleteUser: (request: Readonly<DeleteUserRequest>) => Promise<void>;
218
+ setUserRole: (request: Readonly<SetUserRoleRequest>) => Promise<User>;
218
219
  /**
219
220
  * Delete a Database Instance endpoint. Delete the endpoint of a Database
220
221
  * Instance. You must specify the `endpoint_id` parameter of the endpoint you
@@ -4,7 +4,7 @@ import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
4
4
  import "../../../vendor/base64/index.js";
5
5
  import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
6
6
  import { INSTANCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from "./content.gen.js";
7
- import { unmarshalListNodeTypesResponse, unmarshalListVersionsResponse, unmarshalListInstancesResponse, unmarshalInstance, marshalCreateInstanceRequest, marshalUpdateInstanceRequest, marshalUpgradeInstanceRequest, marshalCreateSnapshotRequest, unmarshalSnapshot, marshalUpdateSnapshotRequest, marshalRestoreSnapshotRequest, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, marshalCreateUserRequest, unmarshalUser, marshalUpdateUserRequest, marshalCreateEndpointRequest, unmarshalEndpoint } from "./marshalling.gen.js";
7
+ import { unmarshalListNodeTypesResponse, unmarshalListVersionsResponse, unmarshalListInstancesResponse, unmarshalInstance, marshalCreateInstanceRequest, marshalUpdateInstanceRequest, marshalUpgradeInstanceRequest, marshalCreateSnapshotRequest, unmarshalSnapshot, marshalUpdateSnapshotRequest, marshalRestoreSnapshotRequest, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, marshalCreateUserRequest, unmarshalUser, marshalUpdateUserRequest, marshalSetUserRoleRequest, marshalCreateEndpointRequest, unmarshalEndpoint } from "./marshalling.gen.js";
8
8
  const jsonContentHeaders = {
9
9
  "Content-Type": "application/json; charset=utf-8"
10
10
  };
@@ -405,6 +405,17 @@ class API extends API$1 {
405
405
  method: "DELETE",
406
406
  path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/users/${validatePathParam("name", request.name)}`
407
407
  });
408
+ setUserRole = (request) => this.client.fetch(
409
+ {
410
+ body: JSON.stringify(
411
+ marshalSetUserRoleRequest(request, this.client.settings)
412
+ ),
413
+ headers: jsonContentHeaders,
414
+ method: "PUT",
415
+ path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/roles`
416
+ },
417
+ unmarshalUser
418
+ );
408
419
  /**
409
420
  * Delete a Database Instance endpoint. Delete the endpoint of a Database
410
421
  * Instance. You must specify the `endpoint_id` parameter of the endpoint you
@@ -1,4 +1,4 @@
1
1
  export { API } from './api.gen.js';
2
2
  export * from './content.gen.js';
3
- export type { CreateEndpointRequest, CreateInstanceRequest, CreateInstanceRequestVolumeDetails, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, InstanceSetting, InstanceStatus, ListInstancesRequest, ListInstancesRequestOrderBy, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsRequestOrderBy, ListSnapshotsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, NodeType, NodeTypeStock, NodeTypeVolumeType, RestoreSnapshotRequest, RestoreSnapshotRequestVolumeDetails, Setting, SettingPropertyType, Snapshot, SnapshotStatus, SnapshotVolumeType, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, Version, Volume, VolumeType, } from './types.gen';
3
+ export type { CreateEndpointRequest, CreateInstanceRequest, CreateInstanceRequestVolumeDetails, CreateSnapshotRequest, CreateUserRequest, DeleteEndpointRequest, DeleteInstanceRequest, DeleteSnapshotRequest, DeleteUserRequest, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, InstanceSetting, InstanceStatus, ListInstancesRequest, ListInstancesRequestOrderBy, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsRequestOrderBy, ListSnapshotsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, NodeType, NodeTypeStock, NodeTypeVolumeType, RestoreSnapshotRequest, RestoreSnapshotRequestVolumeDetails, SetUserRoleRequest, Setting, SettingPropertyType, Snapshot, SnapshotStatus, SnapshotVolumeType, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, UserRole, UserRoleRole, Version, Volume, VolumeType, } from './types.gen';
4
4
  export * as ValidationRules from './validation-rules.gen.js';
@@ -112,6 +112,18 @@ const unmarshalSnapshot = (data) => {
112
112
  volumeType: data.volume_type ? unmarshalSnapshotVolumeType(data.volume_type) : void 0
113
113
  };
114
114
  };
115
+ const unmarshalUserRole = (data) => {
116
+ if (!json.isJSONObject(data)) {
117
+ throw new TypeError(
118
+ `Unmarshalling the type 'UserRole' failed as data isn't a dictionary.`
119
+ );
120
+ }
121
+ return {
122
+ anyDatabase: data.any_database,
123
+ database: data.database,
124
+ role: data.role
125
+ };
126
+ };
115
127
  const unmarshalUser = (data) => {
116
128
  if (!json.isJSONObject(data)) {
117
129
  throw new TypeError(
@@ -119,7 +131,8 @@ const unmarshalUser = (data) => {
119
131
  );
120
132
  }
121
133
  return {
122
- name: data.name
134
+ name: data.name,
135
+ roles: marshalling.unmarshalArrayOfObject(data.roles, unmarshalUserRole)
123
136
  };
124
137
  };
125
138
  const unmarshalListInstancesResponse = (data) => {
@@ -302,6 +315,17 @@ const marshalRestoreSnapshotRequest = (request, defaults) => ({
302
315
  node_type: request.nodeType,
303
316
  volume: marshalRestoreSnapshotRequestVolumeDetails(request.volume)
304
317
  });
318
+ const marshalUserRole = (request, defaults) => ({
319
+ role: request.role,
320
+ ...marshalling.resolveOneOf([
321
+ { param: "database", value: request.database },
322
+ { param: "any_database", value: request.anyDatabase }
323
+ ])
324
+ });
325
+ const marshalSetUserRoleRequest = (request, defaults) => ({
326
+ roles: request.roles !== void 0 ? request.roles.map((elt) => marshalUserRole(elt)) : void 0,
327
+ user_name: request.userName
328
+ });
305
329
  const marshalUpdateInstanceRequest = (request, defaults) => ({
306
330
  name: request.name,
307
331
  tags: request.tags
@@ -321,6 +345,7 @@ exports.marshalCreateInstanceRequest = marshalCreateInstanceRequest;
321
345
  exports.marshalCreateSnapshotRequest = marshalCreateSnapshotRequest;
322
346
  exports.marshalCreateUserRequest = marshalCreateUserRequest;
323
347
  exports.marshalRestoreSnapshotRequest = marshalRestoreSnapshotRequest;
348
+ exports.marshalSetUserRoleRequest = marshalSetUserRoleRequest;
324
349
  exports.marshalUpdateInstanceRequest = marshalUpdateInstanceRequest;
325
350
  exports.marshalUpdateSnapshotRequest = marshalUpdateSnapshotRequest;
326
351
  exports.marshalUpdateUserRequest = marshalUpdateUserRequest;
@@ -1,5 +1,5 @@
1
1
  import type { DefaultValues } from '../../../bridge';
2
- import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, Endpoint, Instance, InstanceSetting, ListInstancesResponse, ListNodeTypesResponse, ListSnapshotsResponse, ListUsersResponse, ListVersionsResponse, RestoreSnapshotRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, Volume } from './types.gen';
2
+ import type { CreateEndpointRequest, CreateInstanceRequest, CreateSnapshotRequest, CreateUserRequest, Endpoint, Instance, InstanceSetting, ListInstancesResponse, ListNodeTypesResponse, ListSnapshotsResponse, ListUsersResponse, ListVersionsResponse, RestoreSnapshotRequest, SetUserRoleRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, Volume } from './types.gen';
3
3
  export declare const unmarshalEndpoint: (data: unknown) => Endpoint;
4
4
  export declare const unmarshalInstanceSetting: (data: unknown) => InstanceSetting;
5
5
  export declare const unmarshalVolume: (data: unknown) => Volume;
@@ -16,6 +16,7 @@ export declare const marshalCreateInstanceRequest: (request: CreateInstanceReque
16
16
  export declare const marshalCreateSnapshotRequest: (request: CreateSnapshotRequest, defaults: DefaultValues) => Record<string, unknown>;
17
17
  export declare const marshalCreateUserRequest: (request: CreateUserRequest, defaults: DefaultValues) => Record<string, unknown>;
18
18
  export declare const marshalRestoreSnapshotRequest: (request: RestoreSnapshotRequest, defaults: DefaultValues) => Record<string, unknown>;
19
+ export declare const marshalSetUserRoleRequest: (request: SetUserRoleRequest, defaults: DefaultValues) => Record<string, unknown>;
19
20
  export declare const marshalUpdateInstanceRequest: (request: UpdateInstanceRequest, defaults: DefaultValues) => Record<string, unknown>;
20
21
  export declare const marshalUpdateSnapshotRequest: (request: UpdateSnapshotRequest, defaults: DefaultValues) => Record<string, unknown>;
21
22
  export declare const marshalUpdateUserRequest: (request: UpdateUserRequest, defaults: DefaultValues) => Record<string, unknown>;
@@ -110,6 +110,18 @@ const unmarshalSnapshot = (data) => {
110
110
  volumeType: data.volume_type ? unmarshalSnapshotVolumeType(data.volume_type) : void 0
111
111
  };
112
112
  };
113
+ const unmarshalUserRole = (data) => {
114
+ if (!isJSONObject(data)) {
115
+ throw new TypeError(
116
+ `Unmarshalling the type 'UserRole' failed as data isn't a dictionary.`
117
+ );
118
+ }
119
+ return {
120
+ anyDatabase: data.any_database,
121
+ database: data.database,
122
+ role: data.role
123
+ };
124
+ };
113
125
  const unmarshalUser = (data) => {
114
126
  if (!isJSONObject(data)) {
115
127
  throw new TypeError(
@@ -117,7 +129,8 @@ const unmarshalUser = (data) => {
117
129
  );
118
130
  }
119
131
  return {
120
- name: data.name
132
+ name: data.name,
133
+ roles: unmarshalArrayOfObject(data.roles, unmarshalUserRole)
121
134
  };
122
135
  };
123
136
  const unmarshalListInstancesResponse = (data) => {
@@ -300,6 +313,17 @@ const marshalRestoreSnapshotRequest = (request, defaults) => ({
300
313
  node_type: request.nodeType,
301
314
  volume: marshalRestoreSnapshotRequestVolumeDetails(request.volume)
302
315
  });
316
+ const marshalUserRole = (request, defaults) => ({
317
+ role: request.role,
318
+ ...resolveOneOf([
319
+ { param: "database", value: request.database },
320
+ { param: "any_database", value: request.anyDatabase }
321
+ ])
322
+ });
323
+ const marshalSetUserRoleRequest = (request, defaults) => ({
324
+ roles: request.roles !== void 0 ? request.roles.map((elt) => marshalUserRole(elt)) : void 0,
325
+ user_name: request.userName
326
+ });
303
327
  const marshalUpdateInstanceRequest = (request, defaults) => ({
304
328
  name: request.name,
305
329
  tags: request.tags
@@ -320,6 +344,7 @@ export {
320
344
  marshalCreateSnapshotRequest,
321
345
  marshalCreateUserRequest,
322
346
  marshalRestoreSnapshotRequest,
347
+ marshalSetUserRoleRequest,
323
348
  marshalUpdateInstanceRequest,
324
349
  marshalUpdateSnapshotRequest,
325
350
  marshalUpdateUserRequest,
@@ -6,6 +6,7 @@ export type ListUsersRequestOrderBy = 'name_asc' | 'name_desc';
6
6
  export type NodeTypeStock = 'unknown_stock' | 'low_stock' | 'out_of_stock' | 'available';
7
7
  export type SettingPropertyType = 'BOOLEAN' | 'INT' | 'STRING' | 'FLOAT';
8
8
  export type SnapshotStatus = 'unknown_status' | 'creating' | 'ready' | 'restoring' | 'deleting' | 'error' | 'locked';
9
+ export type UserRoleRole = 'unknown_role' | 'read' | 'read_write' | 'db_admin' | 'sync';
9
10
  export type VolumeType = 'unknown_type' | 'sbs_5k' | 'sbs_15k';
10
11
  /** Private Network details. */
11
12
  export interface EndpointPrivateNetworkDetails {
@@ -69,6 +70,13 @@ export interface NodeTypeVolumeType {
69
70
  export interface SnapshotVolumeType {
70
71
  type: VolumeType;
71
72
  }
73
+ export interface UserRole {
74
+ role: UserRoleRole;
75
+ /** One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. */
76
+ database?: string;
77
+ /** One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. */
78
+ anyDatabase?: boolean;
79
+ }
72
80
  export interface Setting {
73
81
  /** Setting name from the database engine. */
74
82
  name: string;
@@ -186,6 +194,11 @@ export interface User {
186
194
  * characters are accepted).
187
195
  */
188
196
  name: string;
197
+ /**
198
+ * List of roles assigned to the user, along with the corresponding database
199
+ * where each role is granted.
200
+ */
201
+ roles: UserRole[];
189
202
  }
190
203
  export interface Version {
191
204
  /** MongoDB® engine version. */
@@ -449,6 +462,22 @@ export type RestoreSnapshotRequest = {
449
462
  /** Instance volume information. */
450
463
  volume: RestoreSnapshotRequestVolumeDetails;
451
464
  };
465
+ export type SetUserRoleRequest = {
466
+ /**
467
+ * Region to target. If none is passed will use default region from the
468
+ * config.
469
+ */
470
+ region?: ScwRegion;
471
+ /** UUID of the Database Instance the user belongs to. */
472
+ instanceId: string;
473
+ /** Name of the database user. */
474
+ userName: string;
475
+ /**
476
+ * List of roles assigned to the user, along with the corresponding database
477
+ * where each role is granted.
478
+ */
479
+ roles?: UserRole[];
480
+ };
452
481
  export type UpdateInstanceRequest = {
453
482
  /**
454
483
  * Region to target. If none is passed will use default region from the
@@ -127,6 +127,13 @@ const RestoreSnapshotRequest = {
127
127
  lessThanOrEqual: 3
128
128
  }
129
129
  };
130
+ const SetUserRoleRequest = {
131
+ userName: {
132
+ maxLength: 63,
133
+ minLength: 1,
134
+ pattern: /^[a-zA-Z0-9_\-]*$/
135
+ }
136
+ };
130
137
  const UpdateInstanceRequest = {
131
138
  name: {
132
139
  maxLength: 255,
@@ -162,6 +169,7 @@ exports.ListSnapshotsRequest = ListSnapshotsRequest;
162
169
  exports.ListUsersRequest = ListUsersRequest;
163
170
  exports.ListVersionsRequest = ListVersionsRequest;
164
171
  exports.RestoreSnapshotRequest = RestoreSnapshotRequest;
172
+ exports.SetUserRoleRequest = SetUserRoleRequest;
165
173
  exports.UpdateInstanceRequest = UpdateInstanceRequest;
166
174
  exports.UpdateSnapshotRequest = UpdateSnapshotRequest;
167
175
  exports.UpdateUserRequest = UpdateUserRequest;
@@ -125,6 +125,13 @@ export declare const RestoreSnapshotRequest: {
125
125
  lessThanOrEqual: number;
126
126
  };
127
127
  };
128
+ export declare const SetUserRoleRequest: {
129
+ userName: {
130
+ maxLength: number;
131
+ minLength: number;
132
+ pattern: RegExp;
133
+ };
134
+ };
128
135
  export declare const UpdateInstanceRequest: {
129
136
  name: {
130
137
  maxLength: number;
@@ -125,6 +125,13 @@ const RestoreSnapshotRequest = {
125
125
  lessThanOrEqual: 3
126
126
  }
127
127
  };
128
+ const SetUserRoleRequest = {
129
+ userName: {
130
+ maxLength: 63,
131
+ minLength: 1,
132
+ pattern: /^[a-zA-Z0-9_\-]*$/
133
+ }
134
+ };
128
135
  const UpdateInstanceRequest = {
129
136
  name: {
130
137
  maxLength: 255,
@@ -161,6 +168,7 @@ export {
161
168
  ListUsersRequest,
162
169
  ListVersionsRequest,
163
170
  RestoreSnapshotRequest,
171
+ SetUserRoleRequest,
164
172
  UpdateInstanceRequest,
165
173
  UpdateSnapshotRequest,
166
174
  UpdateUserRequest
@@ -76,7 +76,7 @@ class API extends api.API {
76
76
  method: "DELETE",
77
77
  path: `/secret-manager/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}`
78
78
  });
79
- pageOfListSecrets = (request = {}) => this.client.fetch(
79
+ pageOfListSecrets = (request) => this.client.fetch(
80
80
  {
81
81
  method: "GET",
82
82
  path: `/secret-manager/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`,
@@ -107,7 +107,7 @@ class API extends api.API {
107
107
  * @param request - The request {@link ListSecretsRequest}
108
108
  * @returns A Promise of ListSecretsResponse
109
109
  */
110
- listSecrets = (request = {}) => resourcePaginator.enrichForPagination("secrets", this.pageOfListSecrets, request);
110
+ listSecrets = (request) => resourcePaginator.enrichForPagination("secrets", this.pageOfListSecrets, request);
111
111
  /**
112
112
  * Browse secrets. Retrieve the list of secrets and folders for the given
113
113
  * prefix. You must specify either the `organization_id` or the `project_id`
@@ -387,37 +387,5 @@ class API extends api.API {
387
387
  * @returns A Promise of ListSecretTypesResponse
388
388
  */
389
389
  listSecretTypes = (request = {}) => resourcePaginator.enrichForPagination("types", this.pageOfListSecretTypes, request);
390
- /**
391
- * Restore a version.. Restore a secret's version specified by the `region`,
392
- * `secret_id` and `revision` parameters.
393
- *
394
- * @param request - The request {@link RestoreSecretVersionRequest}
395
- * @returns A Promise of SecretVersion
396
- */
397
- restoreSecretVersion = (request) => this.client.fetch(
398
- {
399
- body: "{}",
400
- headers: jsonContentHeaders,
401
- method: "POST",
402
- path: `/secret-manager/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions/${marshalling.validatePathParam("revision", request.revision)}/restore`
403
- },
404
- marshalling_gen.unmarshalSecretVersion
405
- );
406
- /**
407
- * Restore a secret.. Restore a secret and all its versions scheduled for
408
- * deletion specified by the `region` and `secret_id` parameters.
409
- *
410
- * @param request - The request {@link RestoreSecretRequest}
411
- * @returns A Promise of Secret
412
- */
413
- restoreSecret = (request) => this.client.fetch(
414
- {
415
- body: "{}",
416
- headers: jsonContentHeaders,
417
- method: "POST",
418
- path: `/secret-manager/v1beta1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/restore`
419
- },
420
- marshalling_gen.unmarshalSecret
421
- );
422
390
  }
423
391
  exports.API = API;
@@ -1,6 +1,6 @@
1
1
  import { API as ParentAPI } from '../../../bridge';
2
2
  import type { Region as ScwRegion } from '../../../bridge';
3
- import type { AccessSecretVersionByPathRequest, AccessSecretVersionRequest, AccessSecretVersionResponse, AddSecretOwnerRequest, BrowseSecretsRequest, BrowseSecretsResponse, CreateSecretRequest, CreateSecretVersionRequest, DeleteSecretRequest, DeleteSecretVersionRequest, DisableSecretVersionRequest, EnableSecretVersionRequest, GetSecretRequest, GetSecretVersionRequest, ListSecretTypesRequest, ListSecretTypesResponse, ListSecretVersionsRequest, ListSecretVersionsResponse, ListSecretsRequest, ListSecretsResponse, ListTagsRequest, ListTagsResponse, ProtectSecretRequest, RestoreSecretRequest, RestoreSecretVersionRequest, Secret, SecretVersion, UnprotectSecretRequest, UpdateSecretRequest, UpdateSecretVersionRequest } from './types.gen';
3
+ import type { AccessSecretVersionByPathRequest, AccessSecretVersionRequest, AccessSecretVersionResponse, AddSecretOwnerRequest, BrowseSecretsRequest, BrowseSecretsResponse, CreateSecretRequest, CreateSecretVersionRequest, DeleteSecretRequest, DeleteSecretVersionRequest, DisableSecretVersionRequest, EnableSecretVersionRequest, GetSecretRequest, GetSecretVersionRequest, ListSecretTypesRequest, ListSecretTypesResponse, ListSecretVersionsRequest, ListSecretVersionsResponse, ListSecretsRequest, ListSecretsResponse, ListTagsRequest, ListTagsResponse, ProtectSecretRequest, Secret, SecretVersion, UnprotectSecretRequest, UpdateSecretRequest, UpdateSecretVersionRequest } from './types.gen';
4
4
  /**
5
5
  * Secret Manager API.
6
6
  *
@@ -43,7 +43,7 @@ export declare class API extends ParentAPI {
43
43
  * @param request - The request {@link DeleteSecretRequest}
44
44
  */
45
45
  deleteSecret: (request: Readonly<DeleteSecretRequest>) => Promise<void>;
46
- protected pageOfListSecrets: (request?: Readonly<ListSecretsRequest>) => Promise<ListSecretsResponse>;
46
+ protected pageOfListSecrets: (request: Readonly<ListSecretsRequest>) => Promise<ListSecretsResponse>;
47
47
  /**
48
48
  * List secrets. Retrieve the list of secrets created within an Organization
49
49
  * and/or Project. You must specify either the `organization_id` or the
@@ -52,7 +52,7 @@ export declare class API extends ParentAPI {
52
52
  * @param request - The request {@link ListSecretsRequest}
53
53
  * @returns A Promise of ListSecretsResponse
54
54
  */
55
- listSecrets: (request?: Readonly<ListSecretsRequest>) => Promise<ListSecretsResponse> & {
55
+ listSecrets: (request: Readonly<ListSecretsRequest>) => Promise<ListSecretsResponse> & {
56
56
  all: () => Promise<Secret[]>;
57
57
  [Symbol.asyncIterator]: () => AsyncGenerator<Secret[], void, void>;
58
58
  };
@@ -190,20 +190,4 @@ export declare class API extends ParentAPI {
190
190
  all: () => Promise<import("./types.gen").SecretType[]>;
191
191
  [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").SecretType[], void, void>;
192
192
  };
193
- /**
194
- * Restore a version.. Restore a secret's version specified by the `region`,
195
- * `secret_id` and `revision` parameters.
196
- *
197
- * @param request - The request {@link RestoreSecretVersionRequest}
198
- * @returns A Promise of SecretVersion
199
- */
200
- restoreSecretVersion: (request: Readonly<RestoreSecretVersionRequest>) => Promise<SecretVersion>;
201
- /**
202
- * Restore a secret.. Restore a secret and all its versions scheduled for
203
- * deletion specified by the `region` and `secret_id` parameters.
204
- *
205
- * @param request - The request {@link RestoreSecretRequest}
206
- * @returns A Promise of Secret
207
- */
208
- restoreSecret: (request: Readonly<RestoreSecretRequest>) => Promise<Secret>;
209
193
  }
@@ -74,7 +74,7 @@ class API extends API$1 {
74
74
  method: "DELETE",
75
75
  path: `/secret-manager/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}`
76
76
  });
77
- pageOfListSecrets = (request = {}) => this.client.fetch(
77
+ pageOfListSecrets = (request) => this.client.fetch(
78
78
  {
79
79
  method: "GET",
80
80
  path: `/secret-manager/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`,
@@ -105,7 +105,7 @@ class API extends API$1 {
105
105
  * @param request - The request {@link ListSecretsRequest}
106
106
  * @returns A Promise of ListSecretsResponse
107
107
  */
108
- listSecrets = (request = {}) => enrichForPagination("secrets", this.pageOfListSecrets, request);
108
+ listSecrets = (request) => enrichForPagination("secrets", this.pageOfListSecrets, request);
109
109
  /**
110
110
  * Browse secrets. Retrieve the list of secrets and folders for the given
111
111
  * prefix. You must specify either the `organization_id` or the `project_id`
@@ -385,38 +385,6 @@ class API extends API$1 {
385
385
  * @returns A Promise of ListSecretTypesResponse
386
386
  */
387
387
  listSecretTypes = (request = {}) => enrichForPagination("types", this.pageOfListSecretTypes, request);
388
- /**
389
- * Restore a version.. Restore a secret's version specified by the `region`,
390
- * `secret_id` and `revision` parameters.
391
- *
392
- * @param request - The request {@link RestoreSecretVersionRequest}
393
- * @returns A Promise of SecretVersion
394
- */
395
- restoreSecretVersion = (request) => this.client.fetch(
396
- {
397
- body: "{}",
398
- headers: jsonContentHeaders,
399
- method: "POST",
400
- path: `/secret-manager/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}/versions/${validatePathParam("revision", request.revision)}/restore`
401
- },
402
- unmarshalSecretVersion
403
- );
404
- /**
405
- * Restore a secret.. Restore a secret and all its versions scheduled for
406
- * deletion specified by the `region` and `secret_id` parameters.
407
- *
408
- * @param request - The request {@link RestoreSecretRequest}
409
- * @returns A Promise of Secret
410
- */
411
- restoreSecret = (request) => this.client.fetch(
412
- {
413
- body: "{}",
414
- headers: jsonContentHeaders,
415
- method: "POST",
416
- path: `/secret-manager/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam("secretId", request.secretId)}/restore`
417
- },
418
- unmarshalSecret
419
- );
420
388
  }
421
389
  export {
422
390
  API
@@ -1,3 +1,3 @@
1
1
  export { API } from './api.gen.js';
2
- export type { AccessSecretVersionByPathRequest, AccessSecretVersionRequest, AccessSecretVersionResponse, AddSecretOwnerRequest, BasicCredentials, BrowseSecretsRequest, BrowseSecretsRequestOrderBy, BrowseSecretsResponse, BrowseSecretsResponseItem, BrowseSecretsResponseItemFolderDetails, BrowseSecretsResponseItemSecretDetails, CreateSecretRequest, CreateSecretVersionRequest, DatabaseCredentials, DeleteSecretRequest, DeleteSecretVersionRequest, DisableSecretVersionRequest, EnableSecretVersionRequest, EphemeralPolicy, EphemeralPolicyAction, EphemeralProperties, GetSecretRequest, GetSecretVersionRequest, ListSecretTypesRequest, ListSecretTypesResponse, ListSecretVersionsRequest, ListSecretVersionsResponse, ListSecretsRequest, ListSecretsRequestOrderBy, ListSecretsResponse, ListTagsRequest, ListTagsResponse, Product, ProtectSecretRequest, RestoreSecretRequest, RestoreSecretVersionRequest, SSHKey, Secret, SecretStatus, SecretType, SecretVersion, SecretVersionStatus, UnprotectSecretRequest, UpdateSecretRequest, UpdateSecretVersionRequest, } from './types.gen';
2
+ export type { AccessSecretVersionByPathRequest, AccessSecretVersionRequest, AccessSecretVersionResponse, AddSecretOwnerRequest, BasicCredentials, BrowseSecretsRequest, BrowseSecretsRequestOrderBy, BrowseSecretsResponse, BrowseSecretsResponseItem, BrowseSecretsResponseItemFolderDetails, BrowseSecretsResponseItemSecretDetails, CreateSecretRequest, CreateSecretVersionRequest, DatabaseCredentials, DeleteSecretRequest, DeleteSecretVersionRequest, DisableSecretVersionRequest, EnableSecretVersionRequest, EphemeralPolicy, EphemeralPolicyAction, EphemeralProperties, GetSecretRequest, GetSecretVersionRequest, ListSecretTypesRequest, ListSecretTypesResponse, ListSecretVersionsRequest, ListSecretVersionsResponse, ListSecretsRequest, ListSecretsRequestOrderBy, ListSecretsResponse, ListTagsRequest, ListTagsResponse, Product, ProtectSecretRequest, SSHKey, Secret, SecretStatus, SecretType, SecretVersion, SecretVersionStatus, UnprotectSecretRequest, UpdateSecretRequest, UpdateSecretVersionRequest, } from './types.gen';
3
3
  export * as ValidationRules from './validation-rules.gen.js';
@@ -448,9 +448,10 @@ export type ListSecretsRequest = {
448
448
  type?: SecretType;
449
449
  /**
450
450
  * Filter by whether the secret was scheduled for deletion / not scheduled for
451
- * deletion (optional).
451
+ * deletion. By default, it will display only not scheduled for deletion
452
+ * secrets.
452
453
  */
453
- scheduledForDeletion?: boolean;
454
+ scheduledForDeletion: boolean;
454
455
  };
455
456
  export interface ListSecretsResponse {
456
457
  /** Single page of secrets matching the requested criteria. */
@@ -484,23 +485,6 @@ export type ProtectSecretRequest = {
484
485
  /** ID of the secret to enable secret protection for. */
485
486
  secretId: string;
486
487
  };
487
- export type RestoreSecretRequest = {
488
- /**
489
- * Region to target. If none is passed will use default region from the
490
- * config.
491
- */
492
- region?: ScwRegion;
493
- secretId: string;
494
- };
495
- export type RestoreSecretVersionRequest = {
496
- /**
497
- * Region to target. If none is passed will use default region from the
498
- * config.
499
- */
500
- region?: ScwRegion;
501
- secretId: string;
502
- revision: string;
503
- };
504
488
  export interface SSHKey {
505
489
  /** The private SSH key. */
506
490
  sshPrivateKey: string;
@@ -114,7 +114,7 @@ export interface Email {
114
114
  projectId: string;
115
115
  /** Email address of the sender. */
116
116
  mailFrom: string;
117
- /** @deprecated Email address of the recipient. */
117
+ /** @deprecated Deprecated. Email address of the recipient. */
118
118
  rcptTo?: string;
119
119
  /** Email address of the recipient. */
120
120
  mailRcpt: string;
@@ -191,7 +191,7 @@ export interface Domain {
191
191
  lastValidAt?: Date;
192
192
  /** Date and time of the domain's deletion. */
193
193
  revokedAt?: Date;
194
- /** @deprecated Error message returned if the last check failed. */
194
+ /** @deprecated Deprecated. Error message returned if the last check failed. */
195
195
  lastError?: string;
196
196
  /** Snippet of the SPF record to register in the DNS zone. */
197
197
  spfConfig: string;
@@ -331,8 +331,8 @@ export type CreateDomainRequest = {
331
331
  projectId?: string;
332
332
  /** Fully qualified domain dame. */
333
333
  domainName: string;
334
- /** Accept Scaleway's Terms of Service. */
335
- acceptTos: boolean;
334
+ /** @deprecated Deprecated. Accept Scaleway's Terms of Service. */
335
+ acceptTos?: boolean;
336
336
  /** Activate auto-configuration of the domain's DNS zone. */
337
337
  autoconfig: boolean;
338
338
  };
@@ -558,7 +558,7 @@ export type ListEmailsRequest = {
558
558
  until?: Date;
559
559
  /** (Optional) List emails sent with this sender's email address. */
560
560
  mailFrom?: string;
561
- /** @deprecated List emails sent to this recipient's email address. */
561
+ /** @deprecated Deprecated. List emails sent to this recipient's email address. */
562
562
  mailTo?: string;
563
563
  /** (Optional) List emails sent to this recipient's email address. */
564
564
  mailRcpt?: string;
@@ -740,6 +740,13 @@ class API extends api.API {
740
740
  },
741
741
  marshalling_gen.unmarshalGateway
742
742
  );
743
+ /**
744
+ * Put a Public Gateway in IPAM mode. Put a Public Gateway in IPAM mode, so
745
+ * that it can be used with the Public Gateways API v2. This call is
746
+ * idempotent.
747
+ *
748
+ * @param request - The request {@link MigrateToV2Request}
749
+ */
743
750
  migrateToV2 = (request) => this.client.fetch({
744
751
  body: "{}",
745
752
  headers: jsonContentHeaders,
@@ -391,5 +391,12 @@ export declare class API extends ParentAPI {
391
391
  * @returns A Promise of Gateway
392
392
  */
393
393
  refreshSSHKeys: (request: Readonly<RefreshSSHKeysRequest>) => Promise<Gateway>;
394
+ /**
395
+ * Put a Public Gateway in IPAM mode. Put a Public Gateway in IPAM mode, so
396
+ * that it can be used with the Public Gateways API v2. This call is
397
+ * idempotent.
398
+ *
399
+ * @param request - The request {@link MigrateToV2Request}
400
+ */
394
401
  migrateToV2: (request: Readonly<MigrateToV2Request>) => Promise<void>;
395
402
  }
@@ -738,6 +738,13 @@ class API extends API$1 {
738
738
  },
739
739
  unmarshalGateway
740
740
  );
741
+ /**
742
+ * Put a Public Gateway in IPAM mode. Put a Public Gateway in IPAM mode, so
743
+ * that it can be used with the Public Gateways API v2. This call is
744
+ * idempotent.
745
+ *
746
+ * @param request - The request {@link MigrateToV2Request}
747
+ */
741
748
  migrateToV2 = (request) => this.client.fetch({
742
749
  body: "{}",
743
750
  headers: jsonContentHeaders,
@@ -711,6 +711,7 @@ export interface ListPATRulesResponse {
711
711
  export type MigrateToV2Request = {
712
712
  /** Zone to target. If none is passed will use default zone from the config. */
713
713
  zone?: ScwZone;
714
+ /** ID of the gateway to put into IPAM mode. */
714
715
  gatewayId: string;
715
716
  };
716
717
  export type RefreshSSHKeysRequest = {
@@ -1,6 +1,4 @@
1
1
  "use strict";
2
2
  Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
3
  const index_gen = require("./v1/index.gen.cjs");
4
- const index_gen$1 = require("./v1alpha1/index.gen.cjs");
5
4
  exports.v1 = index_gen;
6
- exports.v1alpha1 = index_gen$1;
@@ -3,4 +3,3 @@
3
3
  * EDIT HERE
4
4
  */
5
5
  export * as v1 from './v1/index.gen.js';
6
- export * as v1alpha1 from './v1alpha1/index.gen.js';
@@ -1,6 +1,4 @@
1
1
  import * as index_gen from "./v1/index.gen.js";
2
- import * as index_gen$1 from "./v1alpha1/index.gen.js";
3
2
  export {
4
- index_gen as v1,
5
- index_gen$1 as v1alpha1
3
+ index_gen as v1
6
4
  };