@scaleway/sdk 2.63.0 → 2.65.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 (70) hide show
  1. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +3 -3
  2. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +20 -20
  3. package/dist/api/cockpit/v1/api.gen.cjs +19 -1
  4. package/dist/api/cockpit/v1/api.gen.d.ts +4 -3
  5. package/dist/api/cockpit/v1/api.gen.js +20 -2
  6. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  7. package/dist/api/cockpit/v1/marshalling.gen.cjs +13 -0
  8. package/dist/api/cockpit/v1/marshalling.gen.d.ts +2 -1
  9. package/dist/api/cockpit/v1/marshalling.gen.js +13 -0
  10. package/dist/api/cockpit/v1/types.gen.d.ts +50 -31
  11. package/dist/api/edge_services/v1alpha1/types.gen.d.ts +3 -3
  12. package/dist/api/iam/v1alpha1/index.gen.d.ts +1 -1
  13. package/dist/api/iam/v1alpha1/marshalling.gen.cjs +16 -0
  14. package/dist/api/iam/v1alpha1/marshalling.gen.js +16 -0
  15. package/dist/api/iam/v1alpha1/types.gen.d.ts +48 -4
  16. package/dist/api/iam/v1alpha1/validation-rules.gen.cjs +7 -3
  17. package/dist/api/iam/v1alpha1/validation-rules.gen.d.ts +6 -3
  18. package/dist/api/iam/v1alpha1/validation-rules.gen.js +7 -3
  19. package/dist/api/inference/v1beta1/api.gen.d.ts +2 -2
  20. package/dist/api/inference/v1beta1/types.gen.d.ts +21 -21
  21. package/dist/api/instance/v1/api.gen.d.ts +2 -2
  22. package/dist/api/instance/v1/types.gen.d.ts +87 -87
  23. package/dist/api/instance/v1/types.private.gen.d.ts +5 -5
  24. package/dist/api/interlink/v1beta1/api.gen.cjs +5 -1
  25. package/dist/api/interlink/v1beta1/api.gen.d.ts +2 -2
  26. package/dist/api/interlink/v1beta1/api.gen.js +5 -1
  27. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +1 -0
  28. package/dist/api/interlink/v1beta1/marshalling.gen.js +1 -0
  29. package/dist/api/interlink/v1beta1/types.gen.d.ts +29 -24
  30. package/dist/api/ipam/v1/api.gen.cjs +5 -1
  31. package/dist/api/ipam/v1/api.gen.d.ts +2 -2
  32. package/dist/api/ipam/v1/api.gen.js +5 -1
  33. package/dist/api/ipam/v1/types.gen.d.ts +13 -13
  34. package/dist/api/key_manager/v1alpha1/api.gen.cjs +41 -37
  35. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +38 -38
  36. package/dist/api/key_manager/v1alpha1/api.gen.js +41 -37
  37. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +31 -30
  38. package/dist/api/lb/v1/api.gen.cjs +5 -1
  39. package/dist/api/lb/v1/api.gen.d.ts +3 -3
  40. package/dist/api/lb/v1/api.gen.js +5 -1
  41. package/dist/api/lb/v1/types.gen.d.ts +116 -116
  42. package/dist/api/vpc/v2/api.gen.cjs +5 -21
  43. package/dist/api/vpc/v2/api.gen.d.ts +3 -13
  44. package/dist/api/vpc/v2/api.gen.js +6 -22
  45. package/dist/api/vpc/v2/index.gen.d.ts +1 -1
  46. package/dist/api/vpc/v2/marshalling.gen.cjs +0 -16
  47. package/dist/api/vpc/v2/marshalling.gen.d.ts +1 -2
  48. package/dist/api/vpc/v2/marshalling.gen.js +1 -17
  49. package/dist/api/vpc/v2/types.gen.d.ts +24 -49
  50. package/dist/api/webhosting/v1/api.gen.cjs +98 -10
  51. package/dist/api/webhosting/v1/api.gen.d.ts +40 -12
  52. package/dist/api/webhosting/v1/api.gen.js +100 -12
  53. package/dist/api/webhosting/v1/content.gen.cjs +4 -0
  54. package/dist/api/webhosting/v1/content.gen.d.ts +5 -1
  55. package/dist/api/webhosting/v1/content.gen.js +4 -0
  56. package/dist/api/webhosting/v1/index.gen.cjs +2 -0
  57. package/dist/api/webhosting/v1/index.gen.d.ts +1 -1
  58. package/dist/api/webhosting/v1/index.gen.js +3 -1
  59. package/dist/api/webhosting/v1/marshalling.gen.cjs +45 -0
  60. package/dist/api/webhosting/v1/marshalling.gen.d.ts +3 -1
  61. package/dist/api/webhosting/v1/marshalling.gen.js +45 -0
  62. package/dist/api/webhosting/v1/types.gen.d.ts +102 -36
  63. package/dist/api/webhosting/v1alpha1/api.gen.cjs +6 -2
  64. package/dist/api/webhosting/v1alpha1/api.gen.d.ts +3 -3
  65. package/dist/api/webhosting/v1alpha1/api.gen.js +6 -2
  66. package/dist/api/webhosting/v1alpha1/types.gen.d.ts +19 -19
  67. package/dist/scw/constants.cjs +1 -1
  68. package/dist/scw/constants.d.ts +2 -2
  69. package/dist/scw/constants.js +1 -1
  70. package/package.json +2 -2
@@ -1,5 +1,5 @@
1
1
  import { API as ParentAPI } from '../../../bridge';
2
- import type { Region } from '../../../bridge';
2
+ import type { Region as ScwRegion } from '../../../bridge';
3
3
  import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, DeleteKeyMaterialRequest, DeleteKeyRequest, DisableKeyRequest, EnableKeyRequest, EncryptRequest, EncryptResponse, GenerateDataKeyRequest, GetKeyRequest, ImportKeyMaterialRequest, Key, ListKeysRequest, ListKeysResponse, ProtectKeyRequest, RotateKeyRequest, UnprotectKeyRequest, UpdateKeyRequest } from './types.gen';
4
4
  /**
5
5
  * Key Manager API.
@@ -9,19 +9,19 @@ import type { CreateKeyRequest, DataKey, DecryptRequest, DecryptResponse, Delete
9
9
  */
10
10
  export declare class API extends ParentAPI {
11
11
  /** Lists the available regions of the API. */
12
- static readonly LOCALITIES: Region[];
12
+ static readonly LOCALITIES: ScwRegion[];
13
13
  /**
14
14
  * Create a key. Create a key in a given region specified by the `region`
15
15
  * parameter. Keys only support symmetric encryption. You can use keys to
16
- * encrypt or decrypt arbitrary payloads, or to generate data encryption keys
17
- * that can be used without being stored in Key Manager.
16
+ * encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
17
+ * **Data encryption keys are not stored in Key Manager**.
18
18
  *
19
19
  * @param request - The request {@link CreateKeyRequest}
20
20
  * @returns A Promise of Key
21
21
  */
22
22
  createKey: (request: Readonly<CreateKeyRequest>) => Promise<Key>;
23
23
  /**
24
- * Get key metadata. Retrieve the metadata of a key specified by the `region`
24
+ * Get key metadata. Retrieve metadata for a specified key using the `region`
25
25
  * and `key_id` parameters.
26
26
  *
27
27
  * @param request - The request {@link GetKeyRequest}
@@ -29,7 +29,7 @@ export declare class API extends ParentAPI {
29
29
  */
30
30
  getKey: (request: Readonly<GetKeyRequest>) => Promise<Key>;
31
31
  /**
32
- * Update a key. Update a key's metadata (name, description and tags),
32
+ * Update a key. Modify a key's metadata including name, description and tags,
33
33
  * specified by the `key_id` and `region` parameters.
34
34
  *
35
35
  * @param request - The request {@link UpdateKeyRequest}
@@ -37,26 +37,25 @@ export declare class API extends ParentAPI {
37
37
  */
38
38
  updateKey: (request: Readonly<UpdateKeyRequest>) => Promise<Key>;
39
39
  /**
40
- * Delete a key. Delete an existing key specified by the `region` and `key_id`
41
- * parameters. Deleting a key is permanent and cannot be undone. All data
42
- * encrypted using this key, including data encryption keys, will become
43
- * unusable.
40
+ * Delete a key. Permanently delete a key specified by the `region` and
41
+ * `key_id` parameters. This action is irreversible. Any data encrypted with
42
+ * this key, including data encryption keys, will no longer be decipherable.
44
43
  *
45
44
  * @param request - The request {@link DeleteKeyRequest}
46
45
  */
47
46
  deleteKey: (request: Readonly<DeleteKeyRequest>) => Promise<void>;
48
47
  /**
49
- * Rotate a key. Generate a new version of an existing key with randomly
50
- * generated key material. Rotated keys can still be used to decrypt
51
- * previously encrypted data. The key's new material will be used for
52
- * subsequent encryption operations and data key generation.
48
+ * Rotate a key. Generate a new version of an existing key with new key
49
+ * material. Previous key versions remain usable to decrypt previously
50
+ * encrypted data, but the key's new version will be used for subsequent
51
+ * encryption operations and data key generation.
53
52
  *
54
53
  * @param request - The request {@link RotateKeyRequest}
55
54
  * @returns A Promise of Key
56
55
  */
57
56
  rotateKey: (request: Readonly<RotateKeyRequest>) => Promise<Key>;
58
57
  /**
59
- * Apply key protection. Apply key protection to a given key specified by the
58
+ * Apply key protection. Apply protection to a given key specified by the
60
59
  * `key_id` parameter. Applying key protection means that your key can be used
61
60
  * and modified, but it cannot be deleted.
62
61
  *
@@ -83,9 +82,9 @@ export declare class API extends ParentAPI {
83
82
  */
84
83
  enableKey: (request: Readonly<EnableKeyRequest>) => Promise<Key>;
85
84
  /**
86
- * Disable key. Disable a given key to be used for cryptographic operations.
87
- * Disabling a key renders it unusable. You must specify the `region` and
88
- * `key_id` parameters.
85
+ * Disable key. Disable a given key, preventing it to be used for
86
+ * cryptographic operations. Disabling a key renders it unusable. You must
87
+ * specify the `region` and `key_id` parameters.
89
88
  *
90
89
  * @param request - The request {@link DisableKeyRequest}
91
90
  * @returns A Promise of Key
@@ -93,9 +92,9 @@ export declare class API extends ParentAPI {
93
92
  disableKey: (request: Readonly<DisableKeyRequest>) => Promise<Key>;
94
93
  protected pageOfListKeys: (request?: Readonly<ListKeysRequest>) => Promise<ListKeysResponse>;
95
94
  /**
96
- * List keys. Retrieve the list of keys created within all Projects of an
97
- * Organization or in a given Project. You must specify the `region`, and
98
- * either the `organization_id` or the `project_id`.
95
+ * List keys. Retrieve a list of keys across all Projects in an Organization
96
+ * or within a specific Project. You must specify the `region`, and either the
97
+ * `organization_id` or the `project_id`.
99
98
  *
100
99
  * @param request - The request {@link ListKeysRequest}
101
100
  * @returns A Promise of ListKeysResponse
@@ -105,43 +104,44 @@ export declare class API extends ParentAPI {
105
104
  [Symbol.asyncIterator]: () => AsyncGenerator<Key[], void, void>;
106
105
  };
107
106
  /**
108
- * Generate a data encryption key. Generate a new data encryption key to use
109
- * for cryptographic operations outside of Key Manager. Note that Key Manager
110
- * does not store your data encryption key. The data encryption key is
107
+ * Create a data encryption key. Create a new data encryption key for
108
+ * cryptographic operations outside of Key Manager. The data encryption key is
111
109
  * encrypted and must be decrypted using the key you have created in Key
112
- * Manager. The data encryption key's plaintext is returned in the response
113
- * object, for immediate usage.
110
+ * Manager.
114
111
  *
115
- * Always store the data encryption key's ciphertext, rather than its
116
- * plaintext, which must not be stored. To retrieve your key's plaintext, call
117
- * the Decrypt endpoint with your key's ID and ciphertext.
112
+ * The data encryption key is returned in plaintext and ciphertext but it
113
+ * should only be stored in its encrypted form (ciphertext). Key Manager does
114
+ * not store your data encryption key. To retrieve your key's plaintext, use
115
+ * the `Decrypt` method with your key's ID and ciphertext.
118
116
  *
119
117
  * @param request - The request {@link GenerateDataKeyRequest}
120
118
  * @returns A Promise of DataKey
121
119
  */
122
120
  generateDataKey: (request: Readonly<GenerateDataKeyRequest>) => Promise<DataKey>;
123
121
  /**
124
- * Encrypt data. Encrypt data using an existing key, specified by the `key_id`
125
- * parameter. Only keys with a usage set to **symmetric_encryption** are
126
- * supported by this method. The maximum payload size that can be encrypted is
127
- * 64KB of plaintext.
122
+ * Encrypt a payload. Encrypt a payload using an existing key, specified by
123
+ * the `key_id` parameter. Only keys with a usage set to
124
+ * `symmetric_encryption` are supported by this method. The maximum payload
125
+ * size that can be encrypted is 64 KB of plaintext.
128
126
  *
129
127
  * @param request - The request {@link EncryptRequest}
130
128
  * @returns A Promise of EncryptResponse
131
129
  */
132
130
  encrypt: (request: Readonly<EncryptRequest>) => Promise<EncryptResponse>;
133
131
  /**
134
- * Decrypt data. Decrypt data using an existing key, specified by the `key_id`
135
- * parameter. The maximum payload size that can be decrypted is the result of
136
- * the encryption of 64KB of data (around 131KB).
132
+ * Decrypt an encrypted payload. Decrypt an encrypted payload using an
133
+ * existing key, specified by the `key_id` parameter. The maximum payload size
134
+ * that can be decrypted is equivalent to the encrypted output of 64 KB of
135
+ * data (around 131 KB).
137
136
  *
138
137
  * @param request - The request {@link DecryptRequest}
139
138
  * @returns A Promise of DecryptResponse
140
139
  */
141
140
  decrypt: (request: Readonly<DecryptRequest>) => Promise<DecryptResponse>;
142
141
  /**
143
- * Import key material. Import key material to use to derive a new
144
- * cryptographic key. The key's origin must be `external`.
142
+ * Import key material. Import externally generated key material into Key
143
+ * Manager to derive a new cryptographic key. The key's origin must be
144
+ * `external`.
145
145
  *
146
146
  * @param request - The request {@link ImportKeyMaterialRequest}
147
147
  * @returns A Promise of Key
@@ -8,12 +8,16 @@ const jsonContentHeaders = {
8
8
  };
9
9
  class API extends API$1 {
10
10
  /** Lists the available regions of the API. */
11
- static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
11
+ static LOCALITIES = [
12
+ "fr-par",
13
+ "nl-ams",
14
+ "pl-waw"
15
+ ];
12
16
  /**
13
17
  * Create a key. Create a key in a given region specified by the `region`
14
18
  * parameter. Keys only support symmetric encryption. You can use keys to
15
- * encrypt or decrypt arbitrary payloads, or to generate data encryption keys
16
- * that can be used without being stored in Key Manager.
19
+ * encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
20
+ * **Data encryption keys are not stored in Key Manager**.
17
21
  *
18
22
  * @param request - The request {@link CreateKeyRequest}
19
23
  * @returns A Promise of Key
@@ -30,7 +34,7 @@ class API extends API$1 {
30
34
  unmarshalKey
31
35
  );
32
36
  /**
33
- * Get key metadata. Retrieve the metadata of a key specified by the `region`
37
+ * Get key metadata. Retrieve metadata for a specified key using the `region`
34
38
  * and `key_id` parameters.
35
39
  *
36
40
  * @param request - The request {@link GetKeyRequest}
@@ -44,7 +48,7 @@ class API extends API$1 {
44
48
  unmarshalKey
45
49
  );
46
50
  /**
47
- * Update a key. Update a key's metadata (name, description and tags),
51
+ * Update a key. Modify a key's metadata including name, description and tags,
48
52
  * specified by the `key_id` and `region` parameters.
49
53
  *
50
54
  * @param request - The request {@link UpdateKeyRequest}
@@ -62,10 +66,9 @@ class API extends API$1 {
62
66
  unmarshalKey
63
67
  );
64
68
  /**
65
- * Delete a key. Delete an existing key specified by the `region` and `key_id`
66
- * parameters. Deleting a key is permanent and cannot be undone. All data
67
- * encrypted using this key, including data encryption keys, will become
68
- * unusable.
69
+ * Delete a key. Permanently delete a key specified by the `region` and
70
+ * `key_id` parameters. This action is irreversible. Any data encrypted with
71
+ * this key, including data encryption keys, will no longer be decipherable.
69
72
  *
70
73
  * @param request - The request {@link DeleteKeyRequest}
71
74
  */
@@ -74,10 +77,10 @@ class API extends API$1 {
74
77
  path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}`
75
78
  });
76
79
  /**
77
- * Rotate a key. Generate a new version of an existing key with randomly
78
- * generated key material. Rotated keys can still be used to decrypt
79
- * previously encrypted data. The key's new material will be used for
80
- * subsequent encryption operations and data key generation.
80
+ * Rotate a key. Generate a new version of an existing key with new key
81
+ * material. Previous key versions remain usable to decrypt previously
82
+ * encrypted data, but the key's new version will be used for subsequent
83
+ * encryption operations and data key generation.
81
84
  *
82
85
  * @param request - The request {@link RotateKeyRequest}
83
86
  * @returns A Promise of Key
@@ -92,7 +95,7 @@ class API extends API$1 {
92
95
  unmarshalKey
93
96
  );
94
97
  /**
95
- * Apply key protection. Apply key protection to a given key specified by the
98
+ * Apply key protection. Apply protection to a given key specified by the
96
99
  * `key_id` parameter. Applying key protection means that your key can be used
97
100
  * and modified, but it cannot be deleted.
98
101
  *
@@ -143,9 +146,9 @@ class API extends API$1 {
143
146
  unmarshalKey
144
147
  );
145
148
  /**
146
- * Disable key. Disable a given key to be used for cryptographic operations.
147
- * Disabling a key renders it unusable. You must specify the `region` and
148
- * `key_id` parameters.
149
+ * Disable key. Disable a given key, preventing it to be used for
150
+ * cryptographic operations. Disabling a key renders it unusable. You must
151
+ * specify the `region` and `key_id` parameters.
149
152
  *
150
153
  * @param request - The request {@link DisableKeyRequest}
151
154
  * @returns A Promise of Key
@@ -179,25 +182,24 @@ class API extends API$1 {
179
182
  unmarshalListKeysResponse
180
183
  );
181
184
  /**
182
- * List keys. Retrieve the list of keys created within all Projects of an
183
- * Organization or in a given Project. You must specify the `region`, and
184
- * either the `organization_id` or the `project_id`.
185
+ * List keys. Retrieve a list of keys across all Projects in an Organization
186
+ * or within a specific Project. You must specify the `region`, and either the
187
+ * `organization_id` or the `project_id`.
185
188
  *
186
189
  * @param request - The request {@link ListKeysRequest}
187
190
  * @returns A Promise of ListKeysResponse
188
191
  */
189
192
  listKeys = (request = {}) => enrichForPagination("keys", this.pageOfListKeys, request);
190
193
  /**
191
- * Generate a data encryption key. Generate a new data encryption key to use
192
- * for cryptographic operations outside of Key Manager. Note that Key Manager
193
- * does not store your data encryption key. The data encryption key is
194
+ * Create a data encryption key. Create a new data encryption key for
195
+ * cryptographic operations outside of Key Manager. The data encryption key is
194
196
  * encrypted and must be decrypted using the key you have created in Key
195
- * Manager. The data encryption key's plaintext is returned in the response
196
- * object, for immediate usage.
197
+ * Manager.
197
198
  *
198
- * Always store the data encryption key's ciphertext, rather than its
199
- * plaintext, which must not be stored. To retrieve your key's plaintext, call
200
- * the Decrypt endpoint with your key's ID and ciphertext.
199
+ * The data encryption key is returned in plaintext and ciphertext but it
200
+ * should only be stored in its encrypted form (ciphertext). Key Manager does
201
+ * not store your data encryption key. To retrieve your key's plaintext, use
202
+ * the `Decrypt` method with your key's ID and ciphertext.
201
203
  *
202
204
  * @param request - The request {@link GenerateDataKeyRequest}
203
205
  * @returns A Promise of DataKey
@@ -214,10 +216,10 @@ class API extends API$1 {
214
216
  unmarshalDataKey
215
217
  );
216
218
  /**
217
- * Encrypt data. Encrypt data using an existing key, specified by the `key_id`
218
- * parameter. Only keys with a usage set to **symmetric_encryption** are
219
- * supported by this method. The maximum payload size that can be encrypted is
220
- * 64KB of plaintext.
219
+ * Encrypt a payload. Encrypt a payload using an existing key, specified by
220
+ * the `key_id` parameter. Only keys with a usage set to
221
+ * `symmetric_encryption` are supported by this method. The maximum payload
222
+ * size that can be encrypted is 64 KB of plaintext.
221
223
  *
222
224
  * @param request - The request {@link EncryptRequest}
223
225
  * @returns A Promise of EncryptResponse
@@ -234,9 +236,10 @@ class API extends API$1 {
234
236
  unmarshalEncryptResponse
235
237
  );
236
238
  /**
237
- * Decrypt data. Decrypt data using an existing key, specified by the `key_id`
238
- * parameter. The maximum payload size that can be decrypted is the result of
239
- * the encryption of 64KB of data (around 131KB).
239
+ * Decrypt an encrypted payload. Decrypt an encrypted payload using an
240
+ * existing key, specified by the `key_id` parameter. The maximum payload size
241
+ * that can be decrypted is equivalent to the encrypted output of 64 KB of
242
+ * data (around 131 KB).
240
243
  *
241
244
  * @param request - The request {@link DecryptRequest}
242
245
  * @returns A Promise of DecryptResponse
@@ -253,8 +256,9 @@ class API extends API$1 {
253
256
  unmarshalDecryptResponse
254
257
  );
255
258
  /**
256
- * Import key material. Import key material to use to derive a new
257
- * cryptographic key. The key's origin must be `external`.
259
+ * Import key material. Import externally generated key material into Key
260
+ * Manager to derive a new cryptographic key. The key's origin must be
261
+ * `external`.
258
262
  *
259
263
  * @param request - The request {@link ImportKeyMaterialRequest}
260
264
  * @returns A Promise of Key
@@ -1,4 +1,4 @@
1
- import type { Region } from '../../../bridge';
1
+ import type { Region as ScwRegion } from '../../../bridge';
2
2
  export type DataKeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
3
3
  export type KeyAlgorithmSymmetricEncryption = 'unknown_symmetric_encryption' | 'aes_256_gcm';
4
4
  export type KeyOrigin = 'unknown_origin' | 'scaleway_kms' | 'external';
@@ -6,11 +6,11 @@ export type KeyState = 'unknown_state' | 'enabled' | 'disabled' | 'pending_key_m
6
6
  export type ListKeysRequestOrderBy = 'name_asc' | 'name_desc' | 'created_at_asc' | 'created_at_desc' | 'updated_at_asc' | 'updated_at_desc';
7
7
  export interface KeyRotationPolicy {
8
8
  /**
9
- * Duration between two key rotations. The minimum duration is 24 hours and
10
- * the maximum duration is 876000 hours (1 year).
9
+ * Time interval between two key rotations. The minimum duration is 24 hours
10
+ * and the maximum duration is 1 year (876000 hours).
11
11
  */
12
12
  rotationPeriod?: string;
13
- /** Date at which the key will be rotated next. */
13
+ /** Timestamp indicating the next scheduled rotation. */
14
14
  nextRotationAt?: Date;
15
15
  }
16
16
  export interface KeyUsage {
@@ -30,14 +30,14 @@ export interface Key {
30
30
  /** Name of the key. */
31
31
  name: string;
32
32
  /**
33
- * Keys with a usage set to `symmetric_encryption` are used to encrypt and
34
- * decrypt data. The only key algorithm currently supported by Key Manager is
35
- * AES-256-GCM.
33
+ * Keys with a usage set to `symmetric_encryption` can encrypt and decrypt
34
+ * data using the `AES-256-GCM` key algorithm. Key Manager currently only
35
+ * supports `AES-256-GCM`.
36
36
  */
37
37
  usage?: KeyUsage;
38
- /** See the `Key.State` enum for a description of values. */
38
+ /** See the `Key.State` enum for a description of possible values. */
39
39
  state: KeyState;
40
- /** The rotation count tracks the amount of times that the key was rotated. */
40
+ /** The rotation count tracks the number of times the key has been rotated. */
41
41
  rotationCount: number;
42
42
  /** Key creation date. */
43
43
  createdAt?: Date;
@@ -57,15 +57,15 @@ export interface Key {
57
57
  rotationPolicy?: KeyRotationPolicy;
58
58
  /** Refer to the `Key.Origin` enum for a description of values. */
59
59
  origin: KeyOrigin;
60
- /** Region of the key. */
61
- region: Region;
60
+ /** Region where the key is stored. */
61
+ region: ScwRegion;
62
62
  }
63
63
  export type CreateKeyRequest = {
64
64
  /**
65
65
  * Region to target. If none is passed will use default region from the
66
66
  * config.
67
67
  */
68
- region?: Region;
68
+ region?: ScwRegion;
69
69
  /** ID of the Project containing the key. */
70
70
  projectId?: string;
71
71
  /** (Optional) Name of the key. */
@@ -89,7 +89,7 @@ export type CreateKeyRequest = {
89
89
  export interface DataKey {
90
90
  /** ID of the data encryption key. */
91
91
  keyId: string;
92
- /** Symmetric encryption algorithm of the data encryption key. */
92
+ /** Symmetric encryption algorithm of the data encryption key (`AES-256-GCM`). */
93
93
  algorithm: DataKeyAlgorithmSymmetricEncryption;
94
94
  /**
95
95
  * Your data encryption key's ciphertext can be stored safely. It can only be
@@ -110,7 +110,7 @@ export type DecryptRequest = {
110
110
  * Region to target. If none is passed will use default region from the
111
111
  * config.
112
112
  */
113
- region?: Region;
113
+ region?: ScwRegion;
114
114
  /** ID of the key to decrypt. */
115
115
  keyId: string;
116
116
  /** Data size must be between 1 and 131071 bytes. */
@@ -134,7 +134,7 @@ export type DeleteKeyMaterialRequest = {
134
134
  * Region to target. If none is passed will use default region from the
135
135
  * config.
136
136
  */
137
- region?: Region;
137
+ region?: ScwRegion;
138
138
  /** ID of the key of which to delete the key material. */
139
139
  keyId: string;
140
140
  };
@@ -143,7 +143,7 @@ export type DeleteKeyRequest = {
143
143
  * Region to target. If none is passed will use default region from the
144
144
  * config.
145
145
  */
146
- region?: Region;
146
+ region?: ScwRegion;
147
147
  /** ID of the key to delete. */
148
148
  keyId: string;
149
149
  };
@@ -152,7 +152,7 @@ export type DisableKeyRequest = {
152
152
  * Region to target. If none is passed will use default region from the
153
153
  * config.
154
154
  */
155
- region?: Region;
155
+ region?: ScwRegion;
156
156
  /** ID of the key to disable. */
157
157
  keyId: string;
158
158
  };
@@ -161,7 +161,7 @@ export type EnableKeyRequest = {
161
161
  * Region to target. If none is passed will use default region from the
162
162
  * config.
163
163
  */
164
- region?: Region;
164
+ region?: ScwRegion;
165
165
  /** ID of the key to enable. */
166
166
  keyId: string;
167
167
  };
@@ -170,7 +170,7 @@ export type EncryptRequest = {
170
170
  * Region to target. If none is passed will use default region from the
171
171
  * config.
172
172
  */
173
- region?: Region;
173
+ region?: ScwRegion;
174
174
  /** ID of the key to encrypt. */
175
175
  keyId: string;
176
176
  /** Data size must be between 1 and 65535 bytes. */
@@ -192,7 +192,7 @@ export type GenerateDataKeyRequest = {
192
192
  * Region to target. If none is passed will use default region from the
193
193
  * config.
194
194
  */
195
- region?: Region;
195
+ region?: ScwRegion;
196
196
  /** ID of the key. */
197
197
  keyId: string;
198
198
  /**
@@ -212,7 +212,7 @@ export type GetKeyRequest = {
212
212
  * Region to target. If none is passed will use default region from the
213
213
  * config.
214
214
  */
215
- region?: Region;
215
+ region?: ScwRegion;
216
216
  /** ID of the key to target. */
217
217
  keyId: string;
218
218
  };
@@ -221,8 +221,8 @@ export type ImportKeyMaterialRequest = {
221
221
  * Region to target. If none is passed will use default region from the
222
222
  * config.
223
223
  */
224
- region?: Region;
225
- /** The key's origin must be 'external'. */
224
+ region?: ScwRegion;
225
+ /** The key's origin must be `external`. */
226
226
  keyId: string;
227
227
  /**
228
228
  * The key material The key material is a random sequence of bytes used to
@@ -230,8 +230,9 @@ export type ImportKeyMaterialRequest = {
230
230
  */
231
231
  keyMaterial: string;
232
232
  /**
233
- * A salt can be used to improve the quality of randomness when the key
234
- * material is generated from a low entropy source.
233
+ * A salt is random data added to key material to ensure unique derived keys,
234
+ * even if the input is similar. It helps strengthen security when the key
235
+ * material has low randomness (low entropy).
235
236
  */
236
237
  salt?: string;
237
238
  };
@@ -240,7 +241,7 @@ export type ListKeysRequest = {
240
241
  * Region to target. If none is passed will use default region from the
241
242
  * config.
242
243
  */
243
- region?: Region;
244
+ region?: ScwRegion;
244
245
  /** (Optional) Filter by Organization ID. */
245
246
  organizationId?: string;
246
247
  /** (Optional) Filter by Project ID. */
@@ -264,7 +265,7 @@ export type ProtectKeyRequest = {
264
265
  * Region to target. If none is passed will use default region from the
265
266
  * config.
266
267
  */
267
- region?: Region;
268
+ region?: ScwRegion;
268
269
  /** ID of the key to apply key protection to. */
269
270
  keyId: string;
270
271
  };
@@ -273,7 +274,7 @@ export type RotateKeyRequest = {
273
274
  * Region to target. If none is passed will use default region from the
274
275
  * config.
275
276
  */
276
- region?: Region;
277
+ region?: ScwRegion;
277
278
  /** ID of the key to rotate. */
278
279
  keyId: string;
279
280
  };
@@ -282,7 +283,7 @@ export type UnprotectKeyRequest = {
282
283
  * Region to target. If none is passed will use default region from the
283
284
  * config.
284
285
  */
285
- region?: Region;
286
+ region?: ScwRegion;
286
287
  /** ID of the key to remove key protection from. */
287
288
  keyId: string;
288
289
  };
@@ -291,7 +292,7 @@ export type UpdateKeyRequest = {
291
292
  * Region to target. If none is passed will use default region from the
292
293
  * config.
293
294
  */
294
- region?: Region;
295
+ region?: ScwRegion;
295
296
  /** ID of the key to update. */
296
297
  keyId: string;
297
298
  /** (Optional) Updated name of the key. */
@@ -1078,7 +1078,11 @@ class ZonedAPI extends api.API {
1078
1078
  }
1079
1079
  class API extends api.API {
1080
1080
  /** Lists the available regions of the API. */
1081
- static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
1081
+ static LOCALITIES = [
1082
+ "fr-par",
1083
+ "nl-ams",
1084
+ "pl-waw"
1085
+ ];
1082
1086
  pageOfListLbs = (request = {}) => this.client.fetch(
1083
1087
  {
1084
1088
  method: "GET",
@@ -1,5 +1,5 @@
1
1
  import { API as ParentAPI } from '../../../bridge';
2
- import type { Region, WaitForOptions, Zone } from '../../../bridge';
2
+ import type { Region as ScwRegion, Zone as ScwZone, WaitForOptions } from '../../../bridge';
3
3
  import type { Acl, AddBackendServersRequest, AttachPrivateNetworkRequest, Backend, Certificate, CreateAclRequest, CreateBackendRequest, CreateCertificateRequest, CreateFrontendRequest, CreateIpRequest, CreateLbRequest, CreateRouteRequest, CreateSubscriberRequest, DeleteAclRequest, DeleteBackendRequest, DeleteCertificateRequest, DeleteFrontendRequest, DeleteLbRequest, DeleteRouteRequest, DeleteSubscriberRequest, DetachPrivateNetworkRequest, Frontend, GetAclRequest, GetBackendRequest, GetCertificateRequest, GetFrontendRequest, GetIpRequest, GetLbRequest, GetLbStatsRequest, GetRouteRequest, GetSubscriberRequest, HealthCheck, Ip, Lb, LbStats, ListAclResponse, ListAclsRequest, ListBackendStatsRequest, ListBackendStatsResponse, ListBackendsRequest, ListBackendsResponse, ListCertificatesRequest, ListCertificatesResponse, ListFrontendsRequest, ListFrontendsResponse, ListIPsRequest, ListIpsResponse, ListLbPrivateNetworksRequest, ListLbPrivateNetworksResponse, ListLbTypesRequest, ListLbTypesResponse, ListLbsRequest, ListLbsResponse, ListRoutesRequest, ListRoutesResponse, ListSubscriberRequest, ListSubscriberResponse, MigrateLbRequest, PrivateNetwork, ReleaseIpRequest, RemoveBackendServersRequest, Route, SetAclsResponse, SetBackendServersRequest, SubscribeToLbRequest, Subscriber, UnsubscribeFromLbRequest, UpdateAclRequest, UpdateBackendRequest, UpdateCertificateRequest, UpdateFrontendRequest, UpdateHealthCheckRequest, UpdateIpRequest, UpdateLbRequest, UpdateRouteRequest, UpdateSubscriberRequest, ZonedApiAddBackendServersRequest, ZonedApiAttachPrivateNetworkRequest, ZonedApiCreateAclRequest, ZonedApiCreateBackendRequest, ZonedApiCreateCertificateRequest, ZonedApiCreateFrontendRequest, ZonedApiCreateIpRequest, ZonedApiCreateLbRequest, ZonedApiCreateRouteRequest, ZonedApiCreateSubscriberRequest, ZonedApiDeleteAclRequest, ZonedApiDeleteBackendRequest, ZonedApiDeleteCertificateRequest, ZonedApiDeleteFrontendRequest, ZonedApiDeleteLbRequest, ZonedApiDeleteRouteRequest, ZonedApiDeleteSubscriberRequest, ZonedApiDetachPrivateNetworkRequest, ZonedApiGetAclRequest, ZonedApiGetBackendRequest, ZonedApiGetCertificateRequest, ZonedApiGetFrontendRequest, ZonedApiGetIpRequest, ZonedApiGetLbRequest, ZonedApiGetLbStatsRequest, ZonedApiGetRouteRequest, ZonedApiGetSubscriberRequest, ZonedApiListAclsRequest, ZonedApiListBackendStatsRequest, ZonedApiListBackendsRequest, ZonedApiListCertificatesRequest, ZonedApiListFrontendsRequest, ZonedApiListIPsRequest, ZonedApiListLbPrivateNetworksRequest, ZonedApiListLbTypesRequest, ZonedApiListLbsRequest, ZonedApiListRoutesRequest, ZonedApiListSubscriberRequest, ZonedApiMigrateLbRequest, ZonedApiReleaseIpRequest, ZonedApiRemoveBackendServersRequest, ZonedApiSetAclsRequest, ZonedApiSetBackendServersRequest, ZonedApiSubscribeToLbRequest, ZonedApiUnsubscribeFromLbRequest, ZonedApiUpdateAclRequest, ZonedApiUpdateBackendRequest, ZonedApiUpdateCertificateRequest, ZonedApiUpdateFrontendRequest, ZonedApiUpdateHealthCheckRequest, ZonedApiUpdateIpRequest, ZonedApiUpdateLbRequest, ZonedApiUpdateRouteRequest, ZonedApiUpdateSubscriberRequest } from './types.gen';
4
4
  /**
5
5
  * Load Balancer API.
@@ -8,7 +8,7 @@ import type { Acl, AddBackendServersRequest, AttachPrivateNetworkRequest, Backen
8
8
  */
9
9
  export declare class ZonedAPI extends ParentAPI {
10
10
  /** Lists the available zones of the API. */
11
- static readonly LOCALITIES: Zone[];
11
+ static readonly LOCALITIES: ScwZone[];
12
12
  protected pageOfListLbs: (request?: Readonly<ZonedApiListLbsRequest>) => Promise<ListLbsResponse>;
13
13
  /**
14
14
  * List Load Balancers. List all Load Balancers in the specified zone, for a
@@ -562,7 +562,7 @@ export declare class ZonedAPI extends ParentAPI {
562
562
  */
563
563
  export declare class API extends ParentAPI {
564
564
  /** Lists the available regions of the API. */
565
- static readonly LOCALITIES: Region[];
565
+ static readonly LOCALITIES: ScwRegion[];
566
566
  protected pageOfListLbs: (request?: Readonly<ListLbsRequest>) => Promise<ListLbsResponse>;
567
567
  /**
568
568
  * List load balancers.
@@ -1076,7 +1076,11 @@ class ZonedAPI extends API$1 {
1076
1076
  }
1077
1077
  class API extends API$1 {
1078
1078
  /** Lists the available regions of the API. */
1079
- static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
1079
+ static LOCALITIES = [
1080
+ "fr-par",
1081
+ "nl-ams",
1082
+ "pl-waw"
1083
+ ];
1080
1084
  pageOfListLbs = (request = {}) => this.client.fetch(
1081
1085
  {
1082
1086
  method: "GET",