@scaleway/sdk 2.72.0 → 2.73.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 (146) hide show
  1. package/dist/api/account/v3/api.gen.cjs +13 -32
  2. package/dist/api/account/v3/api.gen.d.ts +17 -36
  3. package/dist/api/account/v3/api.gen.js +13 -32
  4. package/dist/api/account/v3/types.gen.d.ts +187 -85
  5. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  6. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  7. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  8. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  9. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  10. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  11. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  12. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  13. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  14. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  15. package/dist/api/baremetal/v1/api.gen.js +28 -61
  16. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  17. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  18. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  19. package/dist/api/baremetal/v3/api.gen.js +7 -14
  20. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  21. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  22. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  23. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  24. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  25. package/dist/api/block/v1/api.gen.cjs +37 -55
  26. package/dist/api/block/v1/api.gen.d.ts +19 -37
  27. package/dist/api/block/v1/api.gen.js +37 -55
  28. package/dist/api/block/v1/types.gen.d.ts +306 -125
  29. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  30. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  31. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  32. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  33. package/dist/api/cockpit/v1/api.gen.cjs +100 -156
  34. package/dist/api/cockpit/v1/api.gen.d.ts +53 -112
  35. package/dist/api/cockpit/v1/api.gen.js +100 -156
  36. package/dist/api/cockpit/v1/types.gen.d.ts +567 -246
  37. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  38. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  39. package/dist/api/container/v1beta1/api.gen.js +7 -14
  40. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  41. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  42. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  43. package/dist/api/dedibox/v1/api.gen.js +45 -69
  44. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  45. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  46. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  47. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  48. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  49. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  50. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  51. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  52. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  53. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  54. package/dist/api/inference/v1/api.gen.cjs +8 -11
  55. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  56. package/dist/api/inference/v1/api.gen.js +8 -11
  57. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  58. package/dist/api/inference/v1beta1/api.gen.cjs +8 -11
  59. package/dist/api/inference/v1beta1/api.gen.d.ts +6 -9
  60. package/dist/api/inference/v1beta1/api.gen.js +8 -11
  61. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  62. package/dist/api/instance/v1/api.gen.cjs +64 -113
  63. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  64. package/dist/api/instance/v1/api.gen.js +64 -113
  65. package/dist/api/instance/v1/types.gen.d.ts +1351 -598
  66. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  67. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  68. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  69. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  70. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  71. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  72. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  73. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  74. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  75. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  76. package/dist/api/iot/v1/api.gen.cjs +37 -70
  77. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  78. package/dist/api/iot/v1/api.gen.js +37 -70
  79. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  80. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  81. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  82. package/dist/api/ipam/v1/api.gen.js +6 -26
  83. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  84. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  85. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  86. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  87. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  88. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  89. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  90. package/dist/api/k8s/v1/api.gen.js +33 -78
  91. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  92. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  93. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  94. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  95. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  96. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  97. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  98. package/dist/api/marketplace/v2/api.gen.js +8 -21
  99. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  100. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  101. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  102. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  103. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  104. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  105. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  106. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  107. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  108. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  109. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  110. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  111. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  112. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  113. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  114. package/dist/api/rdb/v1/api.gen.js +62 -202
  115. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  116. package/dist/api/redis/v1/api.gen.cjs +23 -83
  117. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  118. package/dist/api/redis/v1/api.gen.js +23 -83
  119. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  120. package/dist/api/registry/v1/api.gen.cjs +12 -40
  121. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  122. package/dist/api/registry/v1/api.gen.js +12 -40
  123. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  124. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  125. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  126. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  127. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  128. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  129. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  130. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  131. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  132. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  133. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  134. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  135. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  136. package/dist/api/test/v1/api.gen.cjs +8 -11
  137. package/dist/api/test/v1/api.gen.d.ts +6 -9
  138. package/dist/api/test/v1/api.gen.js +8 -11
  139. package/dist/api/test/v1/types.gen.d.ts +21 -10
  140. package/dist/client/dist/package.json.cjs +1 -1
  141. package/dist/client/dist/package.json.js +1 -1
  142. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  143. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  144. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  145. package/package.json +2 -2
  146. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -8,27 +8,41 @@ export type SettingPropertyType = 'BOOLEAN' | 'INT' | 'STRING' | 'FLOAT';
8
8
  export type SnapshotStatus = 'unknown_status' | 'creating' | 'ready' | 'restoring' | 'deleting' | 'error' | 'locked';
9
9
  export type UserRoleRole = 'unknown_role' | 'read' | 'read_write' | 'db_admin' | 'sync';
10
10
  export type VolumeType = 'unknown_type' | 'sbs_5k' | 'sbs_15k';
11
- /** Private Network details. */
11
+ /**
12
+ * Private Network details.
13
+ */
12
14
  export interface EndpointPrivateNetworkDetails {
13
- /** UUID of the Private Network. */
15
+ /**
16
+ * UUID of the Private Network.
17
+ */
14
18
  privateNetworkId: string;
15
19
  }
16
20
  export interface EndpointPublicDetails {
17
21
  }
18
22
  export interface EndpointSpecPrivateNetworkDetails {
19
- /** UUID of the Private Network. */
23
+ /**
24
+ * UUID of the Private Network.
25
+ */
20
26
  privateNetworkId: string;
21
27
  }
22
28
  export interface EndpointSpecPublicDetails {
23
29
  }
24
30
  export interface Endpoint {
25
- /** UUID of the endpoint. */
31
+ /**
32
+ * UUID of the endpoint.
33
+ */
26
34
  id: string;
27
- /** List of IPv4 addresses of the endpoint. */
35
+ /**
36
+ * List of IPv4 addresses of the endpoint.
37
+ */
28
38
  ips: string[];
29
- /** List of DNS records of the endpoint. */
39
+ /**
40
+ * List of DNS records of the endpoint.
41
+ */
30
42
  dnsRecords: string[];
31
- /** TCP port of the endpoint. */
43
+ /**
44
+ * TCP port of the endpoint.
45
+ */
32
46
  port: number;
33
47
  /**
34
48
  * Private Network endpoint details.
@@ -44,27 +58,45 @@ export interface Endpoint {
44
58
  public?: EndpointPublicDetails;
45
59
  }
46
60
  export interface InstanceSetting {
47
- /** Name of the settings. */
61
+ /**
62
+ * Name of the settings.
63
+ */
48
64
  name: string;
49
- /** Value of the settings. */
65
+ /**
66
+ * Value of the settings.
67
+ */
50
68
  value: string;
51
69
  }
52
70
  export interface Volume {
53
- /** Type of volume where data is stored. */
71
+ /**
72
+ * Type of volume where data is stored.
73
+ */
54
74
  type: VolumeType;
55
- /** Volume size. */
75
+ /**
76
+ * Volume size.
77
+ */
56
78
  size: number;
57
79
  }
58
80
  export interface NodeTypeVolumeType {
59
- /** Volume Type. */
81
+ /**
82
+ * Volume Type.
83
+ */
60
84
  type: VolumeType;
61
- /** The description of the volume. */
85
+ /**
86
+ * The description of the volume.
87
+ */
62
88
  description: string;
63
- /** Mimimum size required for the volume. */
89
+ /**
90
+ * Mimimum size required for the volume.
91
+ */
64
92
  minSize: number;
65
- /** Maximum size required for the volume. */
93
+ /**
94
+ * Maximum size required for the volume.
95
+ */
66
96
  maxSize: number;
67
- /** Minimum increment level for a Block Storage volume size. */
97
+ /**
98
+ * Minimum increment level for a Block Storage volume size.
99
+ */
68
100
  chunkSize: number;
69
101
  }
70
102
  export interface SnapshotVolumeType {
@@ -72,367 +104,558 @@ export interface SnapshotVolumeType {
72
104
  }
73
105
  export interface UserRole {
74
106
  role: UserRoleRole;
75
- /** One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. */
107
+ /**
108
+ *
109
+ * One-of ('scope'): at most one of 'database', 'anyDatabase' could be set.
110
+ */
76
111
  database?: string;
77
- /** One-of ('scope'): at most one of 'database', 'anyDatabase' could be set. */
112
+ /**
113
+ *
114
+ * One-of ('scope'): at most one of 'database', 'anyDatabase' could be set.
115
+ */
78
116
  anyDatabase?: boolean;
79
117
  }
80
118
  export interface Setting {
81
- /** Setting name from the database engine. */
119
+ /**
120
+ * Setting name from the database engine.
121
+ */
82
122
  name: string;
83
- /** Value set when not specified. */
123
+ /**
124
+ * Value set when not specified.
125
+ */
84
126
  defaultValue: string;
85
- /** Setting can be applied without restarting. */
127
+ /**
128
+ * Setting can be applied without restarting.
129
+ */
86
130
  hotConfigurable: boolean;
87
- /** Setting description. */
131
+ /**
132
+ * Setting description.
133
+ */
88
134
  description: string;
89
- /** Setting type. */
135
+ /**
136
+ * Setting type.
137
+ */
90
138
  propertyType: SettingPropertyType;
91
- /** Setting base unit. */
139
+ /**
140
+ * Setting base unit.
141
+ */
92
142
  unit?: string;
93
- /** Validation regex for string type settings. */
143
+ /**
144
+ * Validation regex for string type settings.
145
+ */
94
146
  stringConstraint?: string;
95
- /** Minimum value for int types. */
147
+ /**
148
+ * Minimum value for int types.
149
+ */
96
150
  intMin?: number;
97
- /** Maximum value for int types. */
151
+ /**
152
+ * Maximum value for int types.
153
+ */
98
154
  intMax?: number;
99
- /** Minimum value for float types. */
155
+ /**
156
+ * Minimum value for float types.
157
+ */
100
158
  floatMin?: number;
101
- /** Maximum value for float types. */
159
+ /**
160
+ * Maximum value for float types.
161
+ */
102
162
  floatMax?: number;
103
163
  }
104
164
  export interface EndpointSpec {
105
- /** One-of ('details'): at most one of 'public', 'privateNetwork' could be set. */
165
+ /**
166
+ *
167
+ * One-of ('details'): at most one of 'public', 'privateNetwork' could be set.
168
+ */
106
169
  public?: EndpointSpecPublicDetails;
107
- /** One-of ('details'): at most one of 'public', 'privateNetwork' could be set. */
170
+ /**
171
+ *
172
+ * One-of ('details'): at most one of 'public', 'privateNetwork' could be set.
173
+ */
108
174
  privateNetwork?: EndpointSpecPrivateNetworkDetails;
109
175
  }
110
176
  export interface CreateInstanceRequestVolumeDetails {
111
- /** Volume size. */
177
+ /**
178
+ * Volume size.
179
+ */
112
180
  volumeSize: number;
113
- /** Type of volume where data is stored. */
181
+ /**
182
+ * Type of volume where data is stored.
183
+ */
114
184
  volumeType: VolumeType;
115
185
  }
116
186
  export interface Instance {
117
- /** UUID of the Database Instance. */
187
+ /**
188
+ * UUID of the Database Instance.
189
+ */
118
190
  id: string;
119
- /** Name of the Database Instance. */
191
+ /**
192
+ * Name of the Database Instance.
193
+ */
120
194
  name: string;
121
- /** Project ID the Database Instance belongs to. */
195
+ /**
196
+ * Project ID the Database Instance belongs to.
197
+ */
122
198
  projectId: string;
123
- /** Status of the Database Instance. */
199
+ /**
200
+ * Status of the Database Instance.
201
+ */
124
202
  status: InstanceStatus;
125
- /** MongoDB® engine version of the Database Instance. */
203
+ /**
204
+ * MongoDB® engine version of the Database Instance.
205
+ */
126
206
  version: string;
127
- /** List of tags applied to the Database Instance. */
207
+ /**
208
+ * List of tags applied to the Database Instance.
209
+ */
128
210
  tags: string[];
129
- /** Advanced settings of the Database Instance. */
211
+ /**
212
+ * Advanced settings of the Database Instance.
213
+ */
130
214
  settings: InstanceSetting[];
131
- /** Number of node in the Database Instance. */
215
+ /**
216
+ * Number of node in the Database Instance.
217
+ */
132
218
  nodeNumber: number;
133
- /** Node type of the Database Instance. */
219
+ /**
220
+ * Node type of the Database Instance.
221
+ */
134
222
  nodeType: string;
135
- /** Volumes of the Database Instance. */
223
+ /**
224
+ * Volumes of the Database Instance.
225
+ */
136
226
  volume?: Volume;
137
- /** List of Database Instance endpoints. */
227
+ /**
228
+ * List of Database Instance endpoints.
229
+ */
138
230
  endpoints: Endpoint[];
139
- /** Creation date (must follow the ISO 8601 format). */
231
+ /**
232
+ * Creation date (must follow the ISO 8601 format).
233
+ */
140
234
  createdAt?: Date;
141
- /** Region the Database Instance is in. */
235
+ /**
236
+ * Region the Database Instance is in.
237
+ */
142
238
  region: ScwRegion;
143
239
  }
144
240
  export interface NodeType {
145
- /** Node type name identifier. */
241
+ /**
242
+ * Node type name identifier.
243
+ */
146
244
  name: string;
147
- /** Current stock status for the node type. */
245
+ /**
246
+ * Current stock status for the node type.
247
+ */
148
248
  stockStatus: NodeTypeStock;
149
- /** Current specs of the offer. */
249
+ /**
250
+ * Current specs of the offer.
251
+ */
150
252
  description: string;
151
- /** Number of virtual CPUs. */
253
+ /**
254
+ * Number of virtual CPUs.
255
+ */
152
256
  vcpus: number;
153
- /** Quantity of RAM. */
257
+ /**
258
+ * Quantity of RAM.
259
+ */
154
260
  memory: number;
155
- /** Available storage options for the node type. */
261
+ /**
262
+ * Available storage options for the node type.
263
+ */
156
264
  availableVolumeTypes: NodeTypeVolumeType[];
157
- /** The node type is currently disabled. */
265
+ /**
266
+ * The node type is currently disabled.
267
+ */
158
268
  disabled: boolean;
159
- /** The node type is currently in beta. */
269
+ /**
270
+ * The node type is currently in beta.
271
+ */
160
272
  beta: boolean;
161
- /** Instance range associated with the node type offer. */
273
+ /**
274
+ * Instance range associated with the node type offer.
275
+ */
162
276
  instanceRange: string;
163
277
  }
164
278
  export interface Snapshot {
165
- /** UUID of the snapshot. */
279
+ /**
280
+ * UUID of the snapshot.
281
+ */
166
282
  id: string;
167
- /** UUID of the Database Instance. */
283
+ /**
284
+ * UUID of the Database Instance.
285
+ */
168
286
  instanceId: string;
169
- /** Name of the snapshot. */
287
+ /**
288
+ * Name of the snapshot.
289
+ */
170
290
  name: string;
171
- /** Status of the snapshot. */
291
+ /**
292
+ * Status of the snapshot.
293
+ */
172
294
  status: SnapshotStatus;
173
- /** Size of the snapshot. */
295
+ /**
296
+ * Size of the snapshot.
297
+ */
174
298
  size: number;
175
- /** Expiration date (must follow the ISO 8601 format). */
299
+ /**
300
+ * Expiration date (must follow the ISO 8601 format).
301
+ */
176
302
  expiresAt?: Date;
177
- /** Creation date (must follow the ISO 8601 format). */
303
+ /**
304
+ * Creation date (must follow the ISO 8601 format).
305
+ */
178
306
  createdAt?: Date;
179
- /** Updated date (must follow the ISO 8601 format). */
307
+ /**
308
+ * Updated date (must follow the ISO 8601 format).
309
+ */
180
310
  updatedAt?: Date;
181
- /** Name of the Database Instance of the snapshot. */
311
+ /**
312
+ * Name of the Database Instance of the snapshot.
313
+ */
182
314
  instanceName: string;
183
- /** Source node type. */
315
+ /**
316
+ * Source node type.
317
+ */
184
318
  nodeType: string;
185
- /** Type of volume where data is stored - sbs_5k or sbs_15k. */
319
+ /**
320
+ * Type of volume where data is stored - sbs_5k or sbs_15k.
321
+ */
186
322
  volumeType?: SnapshotVolumeType;
187
- /** Region of the snapshot. */
323
+ /**
324
+ * Region of the snapshot.
325
+ */
188
326
  region: ScwRegion;
189
327
  }
190
328
  export interface User {
191
329
  /**
192
- * Name of the user (Length must be between 1 and 63 characters. First
193
- * character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$-
194
- * characters are accepted).
330
+ * Name of the user (Length must be between 1 and 63 characters. First character must be an alphabet character (a-zA-Z). Only a-zA-Z0-9_$- characters are accepted).
195
331
  */
196
332
  name: string;
197
333
  /**
198
- * List of roles assigned to the user, along with the corresponding database
199
- * where each role is granted.
334
+ * List of roles assigned to the user, along with the corresponding database where each role is granted.
200
335
  */
201
336
  roles: UserRole[];
202
337
  }
203
338
  export interface Version {
204
- /** MongoDB® engine version. */
339
+ /**
340
+ * MongoDB® engine version.
341
+ */
205
342
  version: string;
206
- /** Date of End of Life. */
343
+ /**
344
+ * Date of End of Life.
345
+ */
207
346
  endOfLifeAt?: Date;
208
- /** Instance settings available to be updated. */
347
+ /**
348
+ * Instance settings available to be updated.
349
+ */
209
350
  availableSettings: Setting[];
210
351
  }
211
352
  export interface RestoreSnapshotRequestVolumeDetails {
212
- /** Type of volume where data is stored. */
353
+ /**
354
+ * Type of volume where data is stored.
355
+ */
213
356
  volumeType: VolumeType;
214
357
  }
215
358
  export type CreateEndpointRequest = {
216
359
  /**
217
- * Region to target. If none is passed will use default region from the
218
- * config.
360
+ * Region to target. If none is passed will use default region from the config.
219
361
  */
220
362
  region?: ScwRegion;
221
- /** UUID of the Database Instance. */
363
+ /**
364
+ * UUID of the Database Instance.
365
+ */
222
366
  instanceId: string;
223
- /** EndpointSpec used to expose your Database Instance. */
367
+ /**
368
+ * EndpointSpec used to expose your Database Instance.
369
+ */
224
370
  endpoint: EndpointSpec;
225
371
  };
226
372
  export type CreateInstanceRequest = {
227
373
  /**
228
- * Region to target. If none is passed will use default region from the
229
- * config.
374
+ * Region to target. If none is passed will use default region from the config.
230
375
  */
231
376
  region?: ScwRegion;
232
- /** The Project ID on which the Database Instance will be created. */
377
+ /**
378
+ * The Project ID on which the Database Instance will be created.
379
+ */
233
380
  projectId?: string;
234
- /** Name of the Database Instance. */
381
+ /**
382
+ * Name of the Database Instance.
383
+ */
235
384
  name?: string;
236
- /** Version of the MongoDB® engine. */
385
+ /**
386
+ * Version of the MongoDB® engine.
387
+ */
237
388
  version: string;
238
- /** Tags to apply to the Database Instance. */
389
+ /**
390
+ * Tags to apply to the Database Instance.
391
+ */
239
392
  tags?: string[];
240
- /** Number of node to use for the Database Instance. */
393
+ /**
394
+ * Number of node to use for the Database Instance.
395
+ */
241
396
  nodeNumber: number;
242
- /** Type of node to use for the Database Instance. */
397
+ /**
398
+ * Type of node to use for the Database Instance.
399
+ */
243
400
  nodeType: string;
244
- /** Username created when the Database Instance is created. */
401
+ /**
402
+ * Username created when the Database Instance is created.
403
+ */
245
404
  userName: string;
246
- /** Password of the initial user. */
405
+ /**
406
+ * Password of the initial user.
407
+ */
247
408
  password: string;
248
- /** Instance volume information. */
409
+ /**
410
+ * Instance volume information.
411
+ */
249
412
  volume?: CreateInstanceRequestVolumeDetails;
250
- /** One or multiple EndpointSpec used to expose your Database Instance. */
413
+ /**
414
+ * One or multiple EndpointSpec used to expose your Database Instance.
415
+ */
251
416
  endpoints?: EndpointSpec[];
252
417
  };
253
418
  export type CreateSnapshotRequest = {
254
419
  /**
255
- * Region to target. If none is passed will use default region from the
256
- * config.
420
+ * Region to target. If none is passed will use default region from the config.
257
421
  */
258
422
  region?: ScwRegion;
259
- /** UUID of the Database Instance to snapshot. */
423
+ /**
424
+ * UUID of the Database Instance to snapshot.
425
+ */
260
426
  instanceId: string;
261
- /** Name of the snapshot. */
427
+ /**
428
+ * Name of the snapshot.
429
+ */
262
430
  name: string;
263
- /** Expiration date of the snapshot (must follow the ISO 8601 format). */
431
+ /**
432
+ * Expiration date of the snapshot (must follow the ISO 8601 format).
433
+ */
264
434
  expiresAt?: Date;
265
435
  };
266
436
  export type CreateUserRequest = {
267
437
  /**
268
- * Region to target. If none is passed will use default region from the
269
- * config.
438
+ * Region to target. If none is passed will use default region from the config.
270
439
  */
271
440
  region?: ScwRegion;
272
- /** UUID of the Database Instance the user belongs to. */
441
+ /**
442
+ * UUID of the Database Instance the user belongs to.
443
+ */
273
444
  instanceId: string;
274
- /** Name of the database user. */
445
+ /**
446
+ * Name of the database user.
447
+ */
275
448
  name: string;
276
- /** Password of the database user. */
449
+ /**
450
+ * Password of the database user.
451
+ */
277
452
  password: string;
278
453
  };
279
454
  export type DeleteEndpointRequest = {
280
455
  /**
281
- * Region to target. If none is passed will use default region from the
282
- * config.
456
+ * Region to target. If none is passed will use default region from the config.
283
457
  */
284
458
  region?: ScwRegion;
285
- /** UUID of the Endpoint to delete. */
459
+ /**
460
+ * UUID of the Endpoint to delete.
461
+ */
286
462
  endpointId: string;
287
463
  };
288
464
  export type DeleteInstanceRequest = {
289
465
  /**
290
- * Region to target. If none is passed will use default region from the
291
- * config.
466
+ * Region to target. If none is passed will use default region from the config.
292
467
  */
293
468
  region?: ScwRegion;
294
- /** UUID of the Database Instance to delete. */
469
+ /**
470
+ * UUID of the Database Instance to delete.
471
+ */
295
472
  instanceId: string;
296
473
  };
297
474
  export type DeleteSnapshotRequest = {
298
475
  /**
299
- * Region to target. If none is passed will use default region from the
300
- * config.
476
+ * Region to target. If none is passed will use default region from the config.
301
477
  */
302
478
  region?: ScwRegion;
303
- /** UUID of the snapshot. */
479
+ /**
480
+ * UUID of the snapshot.
481
+ */
304
482
  snapshotId: string;
305
483
  };
306
484
  export type DeleteUserRequest = {
307
485
  /**
308
- * Region to target. If none is passed will use default region from the
309
- * config.
486
+ * Region to target. If none is passed will use default region from the config.
310
487
  */
311
488
  region?: ScwRegion;
312
- /** UUID of the Database Instance the user belongs to. */
489
+ /**
490
+ * UUID of the Database Instance the user belongs to.
491
+ */
313
492
  instanceId: string;
314
- /** Name of the database user. */
493
+ /**
494
+ * Name of the database user.
495
+ */
315
496
  name: string;
316
497
  };
317
498
  export type GetInstanceCertificateRequest = {
318
499
  /**
319
- * Region to target. If none is passed will use default region from the
320
- * config.
500
+ * Region to target. If none is passed will use default region from the config.
321
501
  */
322
502
  region?: ScwRegion;
323
- /** UUID of the Database Instance. */
503
+ /**
504
+ * UUID of the Database Instance.
505
+ */
324
506
  instanceId: string;
325
507
  };
326
508
  export type GetInstanceRequest = {
327
509
  /**
328
- * Region to target. If none is passed will use default region from the
329
- * config.
510
+ * Region to target. If none is passed will use default region from the config.
330
511
  */
331
512
  region?: ScwRegion;
332
- /** UUID of the Database Instance. */
513
+ /**
514
+ * UUID of the Database Instance.
515
+ */
333
516
  instanceId: string;
334
517
  };
335
518
  export type GetSnapshotRequest = {
336
519
  /**
337
- * Region to target. If none is passed will use default region from the
338
- * config.
520
+ * Region to target. If none is passed will use default region from the config.
339
521
  */
340
522
  region?: ScwRegion;
341
- /** UUID of the snapshot. */
523
+ /**
524
+ * UUID of the snapshot.
525
+ */
342
526
  snapshotId: string;
343
527
  };
344
528
  export type ListInstancesRequest = {
345
529
  /**
346
- * Region to target. If none is passed will use default region from the
347
- * config.
530
+ * Region to target. If none is passed will use default region from the config.
348
531
  */
349
532
  region?: ScwRegion;
350
- /** List Database Instances that have a given tag. */
533
+ /**
534
+ * List Database Instances that have a given tag.
535
+ */
351
536
  tags?: string[];
352
- /** Lists Database Instances that match a name pattern. */
537
+ /**
538
+ * Lists Database Instances that match a name pattern.
539
+ */
353
540
  name?: string;
354
- /** Criteria to use when ordering Database Instance listings. */
541
+ /**
542
+ * Criteria to use when ordering Database Instance listings.
543
+ */
355
544
  orderBy?: ListInstancesRequestOrderBy;
356
- /** Organization ID of the Database Instance. */
545
+ /**
546
+ * Organization ID of the Database Instance.
547
+ */
357
548
  organizationId?: string;
358
- /** Project ID. */
549
+ /**
550
+ * Project ID.
551
+ */
359
552
  projectId?: string;
360
553
  page?: number;
361
554
  pageSize?: number;
362
555
  };
363
556
  export interface ListInstancesResponse {
364
- /** List of all Database Instances available in an Organization or Project. */
557
+ /**
558
+ * List of all Database Instances available in an Organization or Project.
559
+ */
365
560
  instances: Instance[];
366
- /** Total count of Database Instances available in an Organization or Project. */
561
+ /**
562
+ * Total count of Database Instances available in an Organization or Project.
563
+ */
367
564
  totalCount: number;
368
565
  }
369
566
  export type ListNodeTypesRequest = {
370
567
  /**
371
- * Region to target. If none is passed will use default region from the
372
- * config.
568
+ * Region to target. If none is passed will use default region from the config.
373
569
  */
374
570
  region?: ScwRegion;
375
- /** Defines whether or not to include disabled types. */
571
+ /**
572
+ * Defines whether or not to include disabled types.
573
+ */
376
574
  includeDisabledTypes?: boolean;
377
575
  page?: number;
378
576
  pageSize?: number;
379
577
  };
380
578
  export interface ListNodeTypesResponse {
381
- /** Types of the node. */
579
+ /**
580
+ * Types of the node.
581
+ */
382
582
  nodeTypes: NodeType[];
383
- /** Total count of node-types available. */
583
+ /**
584
+ * Total count of node-types available.
585
+ */
384
586
  totalCount: number;
385
587
  }
386
588
  export type ListSnapshotsRequest = {
387
589
  /**
388
- * Region to target. If none is passed will use default region from the
389
- * config.
590
+ * Region to target. If none is passed will use default region from the config.
390
591
  */
391
592
  region?: ScwRegion;
392
- /** Instance ID the snapshots belongs to. */
593
+ /**
594
+ * Instance ID the snapshots belongs to.
595
+ */
393
596
  instanceId?: string;
394
- /** Lists database snapshots that match a name pattern. */
597
+ /**
598
+ * Lists database snapshots that match a name pattern.
599
+ */
395
600
  name?: string;
396
- /** Criteria to use when ordering snapshot listings. */
601
+ /**
602
+ * Criteria to use when ordering snapshot listings.
603
+ */
397
604
  orderBy?: ListSnapshotsRequestOrderBy;
398
- /** Organization ID the snapshots belongs to. */
605
+ /**
606
+ * Organization ID the snapshots belongs to.
607
+ */
399
608
  organizationId?: string;
400
- /** Project ID to list the snapshots of. */
609
+ /**
610
+ * Project ID to list the snapshots of.
611
+ */
401
612
  projectId?: string;
402
613
  page?: number;
403
614
  pageSize?: number;
404
615
  };
405
616
  export interface ListSnapshotsResponse {
406
- /** List of all database snapshots available in an Organization or Project. */
617
+ /**
618
+ * List of all database snapshots available in an Organization or Project.
619
+ */
407
620
  snapshots: Snapshot[];
408
- /** Total count of database snapshots available in a Organization or Project. */
621
+ /**
622
+ * Total count of database snapshots available in a Organization or Project.
623
+ */
409
624
  totalCount: number;
410
625
  }
411
626
  export type ListUsersRequest = {
412
627
  /**
413
- * Region to target. If none is passed will use default region from the
414
- * config.
628
+ * Region to target. If none is passed will use default region from the config.
415
629
  */
416
630
  region?: ScwRegion;
417
- /** UUID of the Database Instance. */
631
+ /**
632
+ * UUID of the Database Instance.
633
+ */
418
634
  instanceId: string;
419
- /** Name of the user. */
635
+ /**
636
+ * Name of the user.
637
+ */
420
638
  name?: string;
421
- /** Criteria to use when requesting user listing. */
639
+ /**
640
+ * Criteria to use when requesting user listing.
641
+ */
422
642
  orderBy?: ListUsersRequestOrderBy;
423
643
  page?: number;
424
644
  pageSize?: number;
425
645
  };
426
646
  export interface ListUsersResponse {
427
- /** List of users in a Database Instance. */
647
+ /**
648
+ * List of users in a Database Instance.
649
+ */
428
650
  users: User[];
429
- /** Total count of users present on a Database Instance. */
651
+ /**
652
+ * Total count of users present on a Database Instance.
653
+ */
430
654
  totalCount: number;
431
655
  }
432
656
  export type ListVersionsRequest = {
433
657
  /**
434
- * Region to target. If none is passed will use default region from the
435
- * config.
658
+ * Region to target. If none is passed will use default region from the config.
436
659
  */
437
660
  region?: ScwRegion;
438
661
  version?: string;
@@ -440,90 +663,121 @@ export type ListVersionsRequest = {
440
663
  pageSize?: number;
441
664
  };
442
665
  export interface ListVersionsResponse {
443
- /** Available MongoDB® engine version. */
666
+ /**
667
+ * Available MongoDB® engine version.
668
+ */
444
669
  versions: Version[];
445
- /** Total count of MongoDB® engine version available. */
670
+ /**
671
+ * Total count of MongoDB® engine version available.
672
+ */
446
673
  totalCount: number;
447
674
  }
448
675
  export type RestoreSnapshotRequest = {
449
676
  /**
450
- * Region to target. If none is passed will use default region from the
451
- * config.
677
+ * Region to target. If none is passed will use default region from the config.
452
678
  */
453
679
  region?: ScwRegion;
454
- /** UUID of the snapshot. */
680
+ /**
681
+ * UUID of the snapshot.
682
+ */
455
683
  snapshotId: string;
456
- /** Name of the new Database Instance. */
684
+ /**
685
+ * Name of the new Database Instance.
686
+ */
457
687
  instanceName: string;
458
- /** Node type to use for the new Database Instance. */
688
+ /**
689
+ * Node type to use for the new Database Instance.
690
+ */
459
691
  nodeType: string;
460
- /** Number of nodes to use for the new Database Instance. */
692
+ /**
693
+ * Number of nodes to use for the new Database Instance.
694
+ */
461
695
  nodeNumber: number;
462
- /** Instance volume information. */
696
+ /**
697
+ * Instance volume information.
698
+ */
463
699
  volume: RestoreSnapshotRequestVolumeDetails;
464
700
  };
465
701
  export type SetUserRoleRequest = {
466
702
  /**
467
- * Region to target. If none is passed will use default region from the
468
- * config.
703
+ * Region to target. If none is passed will use default region from the config.
469
704
  */
470
705
  region?: ScwRegion;
471
- /** UUID of the Database Instance the user belongs to. */
706
+ /**
707
+ * UUID of the Database Instance the user belongs to.
708
+ */
472
709
  instanceId: string;
473
- /** Name of the database user. */
710
+ /**
711
+ * Name of the database user.
712
+ */
474
713
  userName: string;
475
714
  /**
476
- * List of roles assigned to the user, along with the corresponding database
477
- * where each role is granted.
715
+ * List of roles assigned to the user, along with the corresponding database where each role is granted.
478
716
  */
479
717
  roles?: UserRole[];
480
718
  };
481
719
  export type UpdateInstanceRequest = {
482
720
  /**
483
- * Region to target. If none is passed will use default region from the
484
- * config.
721
+ * Region to target. If none is passed will use default region from the config.
485
722
  */
486
723
  region?: ScwRegion;
487
- /** UUID of the Database Instance to update. */
724
+ /**
725
+ * UUID of the Database Instance to update.
726
+ */
488
727
  instanceId: string;
489
- /** Name of the Database Instance. */
728
+ /**
729
+ * Name of the Database Instance.
730
+ */
490
731
  name?: string;
491
- /** Tags of a Database Instance. */
732
+ /**
733
+ * Tags of a Database Instance.
734
+ */
492
735
  tags?: string[];
493
736
  };
494
737
  export type UpdateSnapshotRequest = {
495
738
  /**
496
- * Region to target. If none is passed will use default region from the
497
- * config.
739
+ * Region to target. If none is passed will use default region from the config.
498
740
  */
499
741
  region?: ScwRegion;
500
- /** UUID of the Snapshot. */
742
+ /**
743
+ * UUID of the Snapshot.
744
+ */
501
745
  snapshotId: string;
502
- /** Name of the snapshot. */
746
+ /**
747
+ * Name of the snapshot.
748
+ */
503
749
  name?: string;
504
- /** Expiration date of the snapshot (must follow the ISO 8601 format). */
750
+ /**
751
+ * Expiration date of the snapshot (must follow the ISO 8601 format).
752
+ */
505
753
  expiresAt?: Date;
506
754
  };
507
755
  export type UpdateUserRequest = {
508
756
  /**
509
- * Region to target. If none is passed will use default region from the
510
- * config.
757
+ * Region to target. If none is passed will use default region from the config.
511
758
  */
512
759
  region?: ScwRegion;
513
- /** UUID of the Database Instance the user belongs to. */
760
+ /**
761
+ * UUID of the Database Instance the user belongs to.
762
+ */
514
763
  instanceId: string;
515
- /** Name of the database user. */
764
+ /**
765
+ * Name of the database user.
766
+ */
516
767
  name: string;
517
- /** Password of the database user. */
768
+ /**
769
+ * Password of the database user.
770
+ */
518
771
  password?: string;
519
772
  };
520
773
  export type UpgradeInstanceRequest = {
521
774
  /**
522
- * Region to target. If none is passed will use default region from the
523
- * config.
775
+ * Region to target. If none is passed will use default region from the config.
524
776
  */
525
777
  region?: ScwRegion;
526
- /** UUID of the Database Instance you want to upgrade. */
778
+ /**
779
+ * UUID of the Database Instance you want to upgrade.
780
+ */
527
781
  instanceId: string;
528
782
  /**
529
783
  * Increase your Block Storage volume size.