@scaleway/sdk 2.72.0 → 2.74.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 (209) 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/index.gen.d.ts +1 -1
  5. package/dist/api/account/v3/marshalling.gen.cjs +94 -65
  6. package/dist/api/account/v3/marshalling.gen.js +94 -65
  7. package/dist/api/account/v3/types.gen.d.ts +224 -104
  8. package/dist/api/applesilicon/v1alpha1/api.gen.cjs +19 -46
  9. package/dist/api/applesilicon/v1alpha1/api.gen.d.ts +24 -49
  10. package/dist/api/applesilicon/v1alpha1/api.gen.js +19 -46
  11. package/dist/api/applesilicon/v1alpha1/types.gen.d.ts +310 -135
  12. package/dist/api/audit_trail/v1alpha1/api.gen.cjs +2 -5
  13. package/dist/api/audit_trail/v1alpha1/api.gen.d.ts +4 -8
  14. package/dist/api/audit_trail/v1alpha1/api.gen.js +2 -5
  15. package/dist/api/audit_trail/v1alpha1/types.gen.d.ts +110 -82
  16. package/dist/api/baremetal/v1/api.gen.cjs +28 -61
  17. package/dist/api/baremetal/v1/api.gen.d.ts +29 -60
  18. package/dist/api/baremetal/v1/api.gen.js +28 -61
  19. package/dist/api/baremetal/v1/types.gen.d.ts +802 -315
  20. package/dist/api/baremetal/v3/api.gen.cjs +7 -14
  21. package/dist/api/baremetal/v3/api.gen.d.ts +10 -15
  22. package/dist/api/baremetal/v3/api.gen.js +7 -14
  23. package/dist/api/baremetal/v3/types.gen.d.ts +82 -32
  24. package/dist/api/billing/v2beta1/api.gen.cjs +11 -20
  25. package/dist/api/billing/v2beta1/api.gen.d.ts +9 -19
  26. package/dist/api/billing/v2beta1/api.gen.js +11 -20
  27. package/dist/api/billing/v2beta1/types.gen.d.ts +231 -102
  28. package/dist/api/block/v1/api.gen.cjs +37 -55
  29. package/dist/api/block/v1/api.gen.d.ts +19 -37
  30. package/dist/api/block/v1/api.gen.js +37 -55
  31. package/dist/api/block/v1/types.gen.d.ts +306 -125
  32. package/dist/api/block/v1alpha1/api.gen.cjs +45 -64
  33. package/dist/api/block/v1alpha1/api.gen.d.ts +22 -41
  34. package/dist/api/block/v1alpha1/api.gen.js +45 -64
  35. package/dist/api/block/v1alpha1/types.gen.d.ts +327 -132
  36. package/dist/api/cockpit/v1/api.gen.cjs +132 -156
  37. package/dist/api/cockpit/v1/api.gen.d.ts +66 -113
  38. package/dist/api/cockpit/v1/api.gen.js +133 -157
  39. package/dist/api/cockpit/v1/index.gen.d.ts +1 -1
  40. package/dist/api/cockpit/v1/marshalling.gen.cjs +23 -0
  41. package/dist/api/cockpit/v1/marshalling.gen.d.ts +3 -1
  42. package/dist/api/cockpit/v1/marshalling.gen.js +23 -0
  43. package/dist/api/cockpit/v1/types.gen.d.ts +628 -246
  44. package/dist/api/container/v1beta1/api.gen.cjs +7 -14
  45. package/dist/api/container/v1beta1/api.gen.d.ts +9 -16
  46. package/dist/api/container/v1beta1/api.gen.js +7 -14
  47. package/dist/api/container/v1beta1/types.gen.d.ts +648 -322
  48. package/dist/api/dedibox/v1/api.gen.cjs +45 -69
  49. package/dist/api/dedibox/v1/api.gen.d.ts +52 -62
  50. package/dist/api/dedibox/v1/api.gen.js +45 -69
  51. package/dist/api/dedibox/v1/types.gen.d.ts +1765 -645
  52. package/dist/api/domain/v2beta1/api.gen.cjs +119 -178
  53. package/dist/api/domain/v2beta1/api.gen.d.ts +71 -130
  54. package/dist/api/domain/v2beta1/api.gen.js +119 -178
  55. package/dist/api/domain/v2beta1/content.gen.d.ts +1 -4
  56. package/dist/api/domain/v2beta1/types.gen.d.ts +411 -199
  57. package/dist/api/edge_services/v1beta1/api.gen.cjs +41 -22
  58. package/dist/api/edge_services/v1beta1/api.gen.d.ts +3 -2
  59. package/dist/api/edge_services/v1beta1/api.gen.js +41 -22
  60. package/dist/api/edge_services/v1beta1/index.gen.d.ts +1 -1
  61. package/dist/api/edge_services/v1beta1/types.gen.d.ts +7 -0
  62. package/dist/api/file/index.gen.cjs +4 -0
  63. package/dist/api/file/index.gen.d.ts +5 -0
  64. package/dist/api/file/index.gen.js +4 -0
  65. package/dist/api/file/v1alpha1/api.gen.cjs +142 -0
  66. package/dist/api/file/v1alpha1/api.gen.d.ts +73 -0
  67. package/dist/api/file/v1alpha1/api.gen.js +142 -0
  68. package/dist/api/file/v1alpha1/content.gen.cjs +7 -0
  69. package/dist/api/file/v1alpha1/content.gen.d.ts +3 -0
  70. package/dist/api/file/v1alpha1/content.gen.js +7 -0
  71. package/dist/api/file/v1alpha1/index.gen.cjs +8 -0
  72. package/dist/api/file/v1alpha1/index.gen.d.ts +4 -0
  73. package/dist/api/file/v1alpha1/index.gen.js +8 -0
  74. package/dist/api/file/v1alpha1/marshalling.gen.cjs +77 -0
  75. package/dist/api/file/v1alpha1/marshalling.gen.d.ts +7 -0
  76. package/dist/api/file/v1alpha1/marshalling.gen.js +77 -0
  77. package/dist/api/file/v1alpha1/types.gen.d.ts +239 -0
  78. package/dist/api/file/v1alpha1/validation-rules.gen.cjs +40 -0
  79. package/dist/api/file/v1alpha1/validation-rules.gen.d.ts +34 -0
  80. package/dist/api/file/v1alpha1/validation-rules.gen.js +40 -0
  81. package/dist/api/flexibleip/v1alpha1/api.gen.cjs +10 -25
  82. package/dist/api/flexibleip/v1alpha1/api.gen.d.ts +12 -28
  83. package/dist/api/flexibleip/v1alpha1/api.gen.js +10 -25
  84. package/dist/api/flexibleip/v1alpha1/types.gen.d.ts +186 -78
  85. package/dist/api/function/v1beta1/types.gen.d.ts +6 -6
  86. package/dist/api/iam/v1alpha1/api.gen.cjs +4 -4
  87. package/dist/api/iam/v1alpha1/api.gen.d.ts +4 -4
  88. package/dist/api/iam/v1alpha1/api.gen.js +4 -4
  89. package/dist/api/iam/v1alpha1/types.gen.d.ts +1 -1
  90. package/dist/api/index.gen.d.ts +3 -1
  91. package/dist/api/inference/v1/api.gen.cjs +8 -11
  92. package/dist/api/inference/v1/api.gen.d.ts +6 -9
  93. package/dist/api/inference/v1/api.gen.js +8 -11
  94. package/dist/api/inference/v1/types.gen.d.ts +330 -150
  95. package/dist/api/inference/v1beta1/api.gen.cjs +9 -12
  96. package/dist/api/inference/v1beta1/api.gen.d.ts +7 -10
  97. package/dist/api/inference/v1beta1/api.gen.js +9 -12
  98. package/dist/api/inference/v1beta1/types.gen.d.ts +341 -154
  99. package/dist/api/instance/v1/api.gen.cjs +64 -113
  100. package/dist/api/instance/v1/api.gen.d.ts +54 -103
  101. package/dist/api/instance/v1/api.gen.js +64 -113
  102. package/dist/api/instance/v1/marshalling.gen.cjs +4 -1
  103. package/dist/api/instance/v1/marshalling.gen.js +4 -1
  104. package/dist/api/instance/v1/types.gen.d.ts +1368 -600
  105. package/dist/api/instance/v1/types.private.gen.d.ts +131 -59
  106. package/dist/api/interlink/v1beta1/api.gen.cjs +21 -67
  107. package/dist/api/interlink/v1beta1/api.gen.d.ts +23 -70
  108. package/dist/api/interlink/v1beta1/api.gen.js +21 -67
  109. package/dist/api/interlink/v1beta1/marshalling.gen.cjs +2 -0
  110. package/dist/api/interlink/v1beta1/marshalling.gen.js +2 -0
  111. package/dist/api/interlink/v1beta1/types.gen.d.ts +464 -216
  112. package/dist/api/interlink/v1beta1/validation-rules.gen.cjs +8 -0
  113. package/dist/api/interlink/v1beta1/validation-rules.gen.d.ts +8 -0
  114. package/dist/api/interlink/v1beta1/validation-rules.gen.js +8 -0
  115. package/dist/api/iot/v1/api.gen.cjs +37 -70
  116. package/dist/api/iot/v1/api.gen.d.ts +34 -67
  117. package/dist/api/iot/v1/api.gen.js +37 -70
  118. package/dist/api/iot/v1/types.gen.d.ts +566 -321
  119. package/dist/api/ipam/v1/api.gen.cjs +6 -26
  120. package/dist/api/ipam/v1/api.gen.d.ts +8 -29
  121. package/dist/api/ipam/v1/api.gen.js +6 -26
  122. package/dist/api/ipam/v1/types.gen.d.ts +146 -105
  123. package/dist/api/jobs/v1alpha1/api.gen.cjs +2 -4
  124. package/dist/api/jobs/v1alpha1/api.gen.d.ts +4 -6
  125. package/dist/api/jobs/v1alpha1/api.gen.js +2 -4
  126. package/dist/api/jobs/v1alpha1/types.gen.d.ts +165 -91
  127. package/dist/api/k8s/v1/api.gen.cjs +33 -78
  128. package/dist/api/k8s/v1/api.gen.d.ts +27 -72
  129. package/dist/api/k8s/v1/api.gen.js +33 -78
  130. package/dist/api/k8s/v1/types.gen.d.ts +743 -506
  131. package/dist/api/key_manager/v1alpha1/api.gen.cjs +21 -57
  132. package/dist/api/key_manager/v1alpha1/api.gen.d.ts +19 -56
  133. package/dist/api/key_manager/v1alpha1/api.gen.js +21 -57
  134. package/dist/api/key_manager/v1alpha1/types.gen.d.ts +196 -114
  135. package/dist/api/lb/v1/marshalling.gen.cjs +4 -2
  136. package/dist/api/lb/v1/marshalling.gen.js +4 -2
  137. package/dist/api/lb/v1/types.gen.d.ts +4 -0
  138. package/dist/api/marketplace/v2/api.gen.cjs +8 -21
  139. package/dist/api/marketplace/v2/api.gen.d.ts +10 -24
  140. package/dist/api/marketplace/v2/api.gen.js +8 -21
  141. package/dist/api/marketplace/v2/types.gen.d.ts +94 -41
  142. package/dist/api/mnq/v1beta1/api.gen.cjs +24 -76
  143. package/dist/api/mnq/v1beta1/api.gen.d.ts +30 -82
  144. package/dist/api/mnq/v1beta1/api.gen.js +24 -76
  145. package/dist/api/mnq/v1beta1/types.gen.d.ts +342 -169
  146. package/dist/api/mongodb/v1alpha1/api.gen.cjs +19 -62
  147. package/dist/api/mongodb/v1alpha1/api.gen.d.ts +21 -64
  148. package/dist/api/mongodb/v1alpha1/api.gen.js +19 -62
  149. package/dist/api/mongodb/v1alpha1/types.gen.d.ts +443 -189
  150. package/dist/api/product_catalog/index.gen.cjs +4 -0
  151. package/dist/api/product_catalog/index.gen.d.ts +5 -0
  152. package/dist/api/product_catalog/index.gen.js +4 -0
  153. package/dist/api/product_catalog/v2alpha1/api.gen.cjs +36 -0
  154. package/dist/api/product_catalog/v2alpha1/api.gen.d.ts +18 -0
  155. package/dist/api/product_catalog/v2alpha1/api.gen.js +36 -0
  156. package/dist/api/product_catalog/v2alpha1/index.gen.cjs +6 -0
  157. package/dist/api/product_catalog/v2alpha1/index.gen.d.ts +3 -0
  158. package/dist/api/product_catalog/v2alpha1/index.gen.js +6 -0
  159. package/dist/api/product_catalog/v2alpha1/marshalling.gen.cjs +230 -0
  160. package/dist/api/product_catalog/v2alpha1/marshalling.gen.d.ts +2 -0
  161. package/dist/api/product_catalog/v2alpha1/marshalling.gen.js +230 -0
  162. package/dist/api/product_catalog/v2alpha1/types.gen.d.ts +293 -0
  163. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.cjs +11 -0
  164. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.d.ts +8 -0
  165. package/dist/api/product_catalog/v2alpha1/validation-rules.gen.js +11 -0
  166. package/dist/api/qaas/v1alpha1/api.gen.cjs +17 -34
  167. package/dist/api/qaas/v1alpha1/api.gen.d.ts +19 -36
  168. package/dist/api/qaas/v1alpha1/api.gen.js +17 -34
  169. package/dist/api/qaas/v1alpha1/types.gen.d.ts +502 -174
  170. package/dist/api/rdb/v1/api.gen.cjs +62 -202
  171. package/dist/api/rdb/v1/api.gen.d.ts +60 -201
  172. package/dist/api/rdb/v1/api.gen.js +62 -202
  173. package/dist/api/rdb/v1/types.gen.d.ts +1005 -524
  174. package/dist/api/redis/v1/api.gen.cjs +23 -83
  175. package/dist/api/redis/v1/api.gen.d.ts +25 -85
  176. package/dist/api/redis/v1/api.gen.js +23 -83
  177. package/dist/api/redis/v1/types.gen.d.ts +447 -170
  178. package/dist/api/registry/v1/api.gen.cjs +12 -40
  179. package/dist/api/registry/v1/api.gen.d.ts +14 -42
  180. package/dist/api/registry/v1/api.gen.js +12 -40
  181. package/dist/api/registry/v1/types.gen.d.ts +200 -116
  182. package/dist/api/secret/v1beta1/api.gen.cjs +19 -47
  183. package/dist/api/secret/v1beta1/api.gen.d.ts +21 -51
  184. package/dist/api/secret/v1beta1/api.gen.js +19 -47
  185. package/dist/api/secret/v1beta1/types.gen.d.ts +359 -224
  186. package/dist/api/serverless_sqldb/v1alpha1/api.gen.cjs +9 -27
  187. package/dist/api/serverless_sqldb/v1alpha1/api.gen.d.ts +11 -29
  188. package/dist/api/serverless_sqldb/v1alpha1/api.gen.js +9 -27
  189. package/dist/api/serverless_sqldb/v1alpha1/types.gen.d.ts +168 -76
  190. package/dist/api/tem/v1alpha1/api.gen.cjs +22 -58
  191. package/dist/api/tem/v1alpha1/api.gen.d.ts +24 -60
  192. package/dist/api/tem/v1alpha1/api.gen.js +22 -58
  193. package/dist/api/tem/v1alpha1/types.gen.d.ts +761 -338
  194. package/dist/api/test/v1/api.gen.cjs +8 -11
  195. package/dist/api/test/v1/api.gen.d.ts +6 -9
  196. package/dist/api/test/v1/api.gen.js +8 -11
  197. package/dist/api/test/v1/types.gen.d.ts +21 -10
  198. package/dist/api/vpcgw/v1/api.gen.cjs +37 -0
  199. package/dist/api/vpcgw/v1/api.gen.d.ts +37 -0
  200. package/dist/api/vpcgw/v1/api.gen.js +37 -0
  201. package/dist/client/dist/package.json.cjs +1 -1
  202. package/dist/client/dist/package.json.js +1 -1
  203. package/dist/index.cjs +36 -32
  204. package/dist/index.js +36 -32
  205. package/node_modules/@scaleway/sdk-client/dist/package.json.cjs +1 -1
  206. package/node_modules/@scaleway/sdk-client/dist/package.json.js +1 -1
  207. package/node_modules/@scaleway/sdk-client/package.json +1 -2
  208. package/package.json +2 -2
  209. package/node_modules/@scaleway/sdk-client/LICENSE +0 -191
@@ -17,10 +17,7 @@ class API extends api.API {
17
17
  "pl-waw"
18
18
  ];
19
19
  /**
20
- * Create a key. Create a key in a given region specified by the `region`
21
- * parameter. Keys only support symmetric encryption. You can use keys to
22
- * encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
23
- * **Data encryption keys are not stored in Key Manager**.
20
+ * Create a key. Create a key in a given region specified by the `region` parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
24
21
  *
25
22
  * @param request - The request {@link CreateKeyRequest}
26
23
  * @returns A Promise of Key
@@ -37,8 +34,7 @@ class API extends api.API {
37
34
  marshalling_gen.unmarshalKey
38
35
  );
39
36
  /**
40
- * Get key metadata. Retrieve metadata for a specified key using the `region`
41
- * and `key_id` parameters.
37
+ * Get key metadata. Retrieve metadata for a specified key using the `region` and `key_id` parameters.
42
38
  *
43
39
  * @param request - The request {@link GetKeyRequest}
44
40
  * @returns A Promise of Key
@@ -51,8 +47,7 @@ class API extends api.API {
51
47
  marshalling_gen.unmarshalKey
52
48
  );
53
49
  /**
54
- * Update a key. Modify a key's metadata including name, description and tags,
55
- * specified by the `key_id` and `region` parameters.
50
+ * Update a key. Modify a key's metadata including name, description and tags, specified by the `key_id` and `region` parameters.
56
51
  *
57
52
  * @param request - The request {@link UpdateKeyRequest}
58
53
  * @returns A Promise of Key
@@ -69,9 +64,7 @@ class API extends api.API {
69
64
  marshalling_gen.unmarshalKey
70
65
  );
71
66
  /**
72
- * Delete a key. Permanently delete a key specified by the `region` and
73
- * `key_id` parameters. This action is irreversible. Any data encrypted with
74
- * this key, including data encryption keys, will no longer be decipherable.
67
+ * Delete a key. Permanently delete a key specified by the `region` and `key_id` parameters. This action is irreversible. Any data encrypted with this key, including data encryption keys, will no longer be decipherable.
75
68
  *
76
69
  * @param request - The request {@link DeleteKeyRequest}
77
70
  */
@@ -80,10 +73,7 @@ class API extends api.API {
80
73
  path: `/key-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${marshalling.validatePathParam("keyId", request.keyId)}`
81
74
  });
82
75
  /**
83
- * Rotate a key. Generate a new version of an existing key with new key
84
- * material. Previous key versions remain usable to decrypt previously
85
- * encrypted data, but the key's new version will be used for subsequent
86
- * encryption operations and data key generation.
76
+ * Rotate a key. Generate a new version of an existing key with new key material. Previous key versions remain usable to decrypt previously encrypted data, but the key's new version will be used for subsequent encryption operations and data key generation.
87
77
  *
88
78
  * @param request - The request {@link RotateKeyRequest}
89
79
  * @returns A Promise of Key
@@ -98,9 +88,7 @@ class API extends api.API {
98
88
  marshalling_gen.unmarshalKey
99
89
  );
100
90
  /**
101
- * Apply key protection. Apply protection to a given key specified by the
102
- * `key_id` parameter. Applying key protection means that your key can be used
103
- * and modified, but it cannot be deleted.
91
+ * Apply key protection. Apply protection to a given key specified by the `key_id` parameter. Applying key protection means that your key can be used and modified, but it cannot be deleted.
104
92
  *
105
93
  * @param request - The request {@link ProtectKeyRequest}
106
94
  * @returns A Promise of Key
@@ -115,9 +103,7 @@ class API extends api.API {
115
103
  marshalling_gen.unmarshalKey
116
104
  );
117
105
  /**
118
- * Remove key protection. Remove key protection from a given key specified by
119
- * the `key_id` parameter. Removing key protection means that your key can be
120
- * deleted anytime.
106
+ * Remove key protection. Remove key protection from a given key specified by the `key_id` parameter. Removing key protection means that your key can be deleted anytime.
121
107
  *
122
108
  * @param request - The request {@link UnprotectKeyRequest}
123
109
  * @returns A Promise of Key
@@ -132,9 +118,7 @@ class API extends api.API {
132
118
  marshalling_gen.unmarshalKey
133
119
  );
134
120
  /**
135
- * Enable key. Enable a given key to be used for cryptographic operations.
136
- * Enabling a key allows you to make a disabled key usable again. You must
137
- * specify the `region` and `key_id` parameters.
121
+ * Enable key. Enable a given key to be used for cryptographic operations. Enabling a key allows you to make a disabled key usable again. You must specify the `region` and `key_id` parameters.
138
122
  *
139
123
  * @param request - The request {@link EnableKeyRequest}
140
124
  * @returns A Promise of Key
@@ -149,9 +133,7 @@ class API extends api.API {
149
133
  marshalling_gen.unmarshalKey
150
134
  );
151
135
  /**
152
- * Disable key. Disable a given key, preventing it to be used for
153
- * cryptographic operations. Disabling a key renders it unusable. You must
154
- * specify the `region` and `key_id` parameters.
136
+ * Disable key. Disable a given key, preventing it to be used for cryptographic operations. Disabling a key renders it unusable. You must specify the `region` and `key_id` parameters.
155
137
  *
156
138
  * @param request - The request {@link DisableKeyRequest}
157
139
  * @returns A Promise of Key
@@ -185,28 +167,20 @@ class API extends api.API {
185
167
  marshalling_gen.unmarshalListKeysResponse
186
168
  );
187
169
  /**
188
- * List keys. Retrieve a list of keys across all Projects in an Organization
189
- * or within a specific Project. You must specify the `region`, and either the
190
- * `organization_id` or the `project_id`.
170
+ * List keys. Retrieve a list of keys across all Projects in an Organization or within a specific Project. You must specify the `region`, and either the `organization_id` or the `project_id`.
191
171
  *
192
172
  * @param request - The request {@link ListKeysRequest}
193
173
  * @returns A Promise of ListKeysResponse
194
174
  */
195
175
  listKeys = (request = {}) => resourcePaginator.enrichForPagination("keys", this.pageOfListKeys, request);
196
176
  /**
197
- * Create a data encryption key. Create a new data encryption key for
198
- * cryptographic operations outside of Key Manager. The data encryption key is
199
- * encrypted and must be decrypted using the key you have created in Key
200
- * Manager.
201
- *
202
- * The data encryption key is returned in plaintext and ciphertext but it
203
- * should only be stored in its encrypted form (ciphertext). Key Manager does
204
- * not store your data encryption key. To retrieve your key's plaintext, use
205
- * the `Decrypt` method with your key's ID and ciphertext.
206
- *
207
- * @param request - The request {@link GenerateDataKeyRequest}
208
- * @returns A Promise of DataKey
209
- */
177
+ * Create a data encryption key. Create a new data encryption key for cryptographic operations outside of Key Manager. The data encryption key is encrypted and must be decrypted using the key you have created in Key Manager.
178
+
179
+ The data encryption key is returned in plaintext and ciphertext but it should only be stored in its encrypted form (ciphertext). Key Manager does not store your data encryption key. To retrieve your key's plaintext, use the `Decrypt` method with your key's ID and ciphertext.
180
+ *
181
+ * @param request - The request {@link GenerateDataKeyRequest}
182
+ * @returns A Promise of DataKey
183
+ */
210
184
  generateDataKey = (request) => this.client.fetch(
211
185
  {
212
186
  body: JSON.stringify(
@@ -219,10 +193,7 @@ class API extends api.API {
219
193
  marshalling_gen.unmarshalDataKey
220
194
  );
221
195
  /**
222
- * Encrypt a payload. Encrypt a payload using an existing key, specified by
223
- * the `key_id` parameter. Only keys with a usage set to
224
- * `symmetric_encryption` are supported by this method. The maximum payload
225
- * size that can be encrypted is 64 KB of plaintext.
196
+ * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. Only keys with a usage set to `symmetric_encryption` are supported by this method. The maximum payload size that can be encrypted is 64 KB of plaintext.
226
197
  *
227
198
  * @param request - The request {@link EncryptRequest}
228
199
  * @returns A Promise of EncryptResponse
@@ -239,10 +210,7 @@ class API extends api.API {
239
210
  marshalling_gen.unmarshalEncryptResponse
240
211
  );
241
212
  /**
242
- * Decrypt an encrypted payload. Decrypt an encrypted payload using an
243
- * existing key, specified by the `key_id` parameter. The maximum payload size
244
- * that can be decrypted is equivalent to the encrypted output of 64 KB of
245
- * data (around 131 KB).
213
+ * Decrypt an encrypted payload. Decrypt an encrypted payload using an existing key, specified by the `key_id` parameter. The maximum payload size that can be decrypted is equivalent to the encrypted output of 64 KB of data (around 131 KB).
246
214
  *
247
215
  * @param request - The request {@link DecryptRequest}
248
216
  * @returns A Promise of DecryptResponse
@@ -259,9 +227,7 @@ class API extends api.API {
259
227
  marshalling_gen.unmarshalDecryptResponse
260
228
  );
261
229
  /**
262
- * Import key material. Import externally generated key material into Key
263
- * Manager to derive a new cryptographic key. The key's origin must be
264
- * `external`.
230
+ * Import key material. Import externally generated key material into Key Manager to derive a new cryptographic key. The key's origin must be `external`.
265
231
  *
266
232
  * @param request - The request {@link ImportKeyMaterialRequest}
267
233
  * @returns A Promise of Key
@@ -278,9 +244,7 @@ class API extends api.API {
278
244
  marshalling_gen.unmarshalKey
279
245
  );
280
246
  /**
281
- * Delete key material. Delete previously imported key material. This renders
282
- * the associated cryptographic key unusable for any operation. The key's
283
- * origin must be `external`.
247
+ * Delete key material. Delete previously imported key material. This renders the associated cryptographic key unusable for any operation. The key's origin must be `external`.
284
248
  *
285
249
  * @param request - The request {@link DeleteKeyMaterialRequest}
286
250
  */
@@ -3,88 +3,69 @@ import type { Region as ScwRegion } from '@scaleway/sdk-client';
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.
6
- *
7
- * This API allows you to create, manage and use cryptographic keys in a
8
- * centralized and secure service.
6
+
7
+ This API allows you to create, manage and use cryptographic keys in a centralized and secure service.
9
8
  */
10
9
  export declare class API extends ParentAPI {
11
10
  /** Lists the available regions of the API. */
12
11
  static readonly LOCALITIES: ScwRegion[];
13
12
  /**
14
- * Create a key. Create a key in a given region specified by the `region`
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
- * **Data encryption keys are not stored in Key Manager**.
13
+ * Create a key. Create a key in a given region specified by the `region` parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
18
14
  *
19
15
  * @param request - The request {@link CreateKeyRequest}
20
16
  * @returns A Promise of Key
21
17
  */
22
18
  createKey: (request: Readonly<CreateKeyRequest>) => Promise<Key>;
23
19
  /**
24
- * Get key metadata. Retrieve metadata for a specified key using the `region`
25
- * and `key_id` parameters.
20
+ * Get key metadata. Retrieve metadata for a specified key using the `region` and `key_id` parameters.
26
21
  *
27
22
  * @param request - The request {@link GetKeyRequest}
28
23
  * @returns A Promise of Key
29
24
  */
30
25
  getKey: (request: Readonly<GetKeyRequest>) => Promise<Key>;
31
26
  /**
32
- * Update a key. Modify a key's metadata including name, description and tags,
33
- * specified by the `key_id` and `region` parameters.
27
+ * Update a key. Modify a key's metadata including name, description and tags, specified by the `key_id` and `region` parameters.
34
28
  *
35
29
  * @param request - The request {@link UpdateKeyRequest}
36
30
  * @returns A Promise of Key
37
31
  */
38
32
  updateKey: (request: Readonly<UpdateKeyRequest>) => Promise<Key>;
39
33
  /**
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.
34
+ * Delete a key. Permanently delete a key specified by the `region` and `key_id` parameters. This action is irreversible. Any data encrypted with this key, including data encryption keys, will no longer be decipherable.
43
35
  *
44
36
  * @param request - The request {@link DeleteKeyRequest}
45
37
  */
46
38
  deleteKey: (request: Readonly<DeleteKeyRequest>) => Promise<void>;
47
39
  /**
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.
40
+ * Rotate a key. Generate a new version of an existing key with new key material. Previous key versions remain usable to decrypt previously encrypted data, but the key's new version will be used for subsequent encryption operations and data key generation.
52
41
  *
53
42
  * @param request - The request {@link RotateKeyRequest}
54
43
  * @returns A Promise of Key
55
44
  */
56
45
  rotateKey: (request: Readonly<RotateKeyRequest>) => Promise<Key>;
57
46
  /**
58
- * Apply key protection. Apply protection to a given key specified by the
59
- * `key_id` parameter. Applying key protection means that your key can be used
60
- * and modified, but it cannot be deleted.
47
+ * Apply key protection. Apply protection to a given key specified by the `key_id` parameter. Applying key protection means that your key can be used and modified, but it cannot be deleted.
61
48
  *
62
49
  * @param request - The request {@link ProtectKeyRequest}
63
50
  * @returns A Promise of Key
64
51
  */
65
52
  protectKey: (request: Readonly<ProtectKeyRequest>) => Promise<Key>;
66
53
  /**
67
- * Remove key protection. Remove key protection from a given key specified by
68
- * the `key_id` parameter. Removing key protection means that your key can be
69
- * deleted anytime.
54
+ * Remove key protection. Remove key protection from a given key specified by the `key_id` parameter. Removing key protection means that your key can be deleted anytime.
70
55
  *
71
56
  * @param request - The request {@link UnprotectKeyRequest}
72
57
  * @returns A Promise of Key
73
58
  */
74
59
  unprotectKey: (request: Readonly<UnprotectKeyRequest>) => Promise<Key>;
75
60
  /**
76
- * Enable key. Enable a given key to be used for cryptographic operations.
77
- * Enabling a key allows you to make a disabled key usable again. You must
78
- * specify the `region` and `key_id` parameters.
61
+ * Enable key. Enable a given key to be used for cryptographic operations. Enabling a key allows you to make a disabled key usable again. You must specify the `region` and `key_id` parameters.
79
62
  *
80
63
  * @param request - The request {@link EnableKeyRequest}
81
64
  * @returns A Promise of Key
82
65
  */
83
66
  enableKey: (request: Readonly<EnableKeyRequest>) => Promise<Key>;
84
67
  /**
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.
68
+ * Disable key. Disable a given key, preventing it to be used for cryptographic operations. Disabling a key renders it unusable. You must specify the `region` and `key_id` parameters.
88
69
  *
89
70
  * @param request - The request {@link DisableKeyRequest}
90
71
  * @returns A Promise of Key
@@ -92,9 +73,7 @@ export declare class API extends ParentAPI {
92
73
  disableKey: (request: Readonly<DisableKeyRequest>) => Promise<Key>;
93
74
  protected pageOfListKeys: (request?: Readonly<ListKeysRequest>) => Promise<ListKeysResponse>;
94
75
  /**
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`.
76
+ * List keys. Retrieve a list of keys across all Projects in an Organization or within a specific Project. You must specify the `region`, and either the `organization_id` or the `project_id`.
98
77
  *
99
78
  * @param request - The request {@link ListKeysRequest}
100
79
  * @returns A Promise of ListKeysResponse
@@ -104,53 +83,37 @@ export declare class API extends ParentAPI {
104
83
  [Symbol.asyncIterator]: () => AsyncGenerator<Key[], void, void>;
105
84
  };
106
85
  /**
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
109
- * encrypted and must be decrypted using the key you have created in Key
110
- * Manager.
111
- *
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.
86
+ * Create a data encryption key. Create a new data encryption key for cryptographic operations outside of Key Manager. The data encryption key is encrypted and must be decrypted using the key you have created in Key Manager.
87
+
88
+ The data encryption key is returned in plaintext and ciphertext but it should only be stored in its encrypted form (ciphertext). Key Manager does not store your data encryption key. To retrieve your key's plaintext, use the `Decrypt` method with your key's ID and ciphertext.
116
89
  *
117
90
  * @param request - The request {@link GenerateDataKeyRequest}
118
91
  * @returns A Promise of DataKey
119
92
  */
120
93
  generateDataKey: (request: Readonly<GenerateDataKeyRequest>) => Promise<DataKey>;
121
94
  /**
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.
95
+ * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. Only keys with a usage set to `symmetric_encryption` are supported by this method. The maximum payload size that can be encrypted is 64 KB of plaintext.
126
96
  *
127
97
  * @param request - The request {@link EncryptRequest}
128
98
  * @returns A Promise of EncryptResponse
129
99
  */
130
100
  encrypt: (request: Readonly<EncryptRequest>) => Promise<EncryptResponse>;
131
101
  /**
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).
102
+ * Decrypt an encrypted payload. Decrypt an encrypted payload using an existing key, specified by the `key_id` parameter. The maximum payload size that can be decrypted is equivalent to the encrypted output of 64 KB of data (around 131 KB).
136
103
  *
137
104
  * @param request - The request {@link DecryptRequest}
138
105
  * @returns A Promise of DecryptResponse
139
106
  */
140
107
  decrypt: (request: Readonly<DecryptRequest>) => Promise<DecryptResponse>;
141
108
  /**
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`.
109
+ * Import key material. Import externally generated key material into Key Manager to derive a new cryptographic key. The key's origin must be `external`.
145
110
  *
146
111
  * @param request - The request {@link ImportKeyMaterialRequest}
147
112
  * @returns A Promise of Key
148
113
  */
149
114
  importKeyMaterial: (request: Readonly<ImportKeyMaterialRequest>) => Promise<Key>;
150
115
  /**
151
- * Delete key material. Delete previously imported key material. This renders
152
- * the associated cryptographic key unusable for any operation. The key's
153
- * origin must be `external`.
116
+ * Delete key material. Delete previously imported key material. This renders the associated cryptographic key unusable for any operation. The key's origin must be `external`.
154
117
  *
155
118
  * @param request - The request {@link DeleteKeyMaterialRequest}
156
119
  */
@@ -15,10 +15,7 @@ class API extends API$1 {
15
15
  "pl-waw"
16
16
  ];
17
17
  /**
18
- * Create a key. Create a key in a given region specified by the `region`
19
- * parameter. Keys only support symmetric encryption. You can use keys to
20
- * encrypt or decrypt arbitrary payloads, or to generate data encryption keys.
21
- * **Data encryption keys are not stored in Key Manager**.
18
+ * Create a key. Create a key in a given region specified by the `region` parameter. Keys only support symmetric encryption. You can use keys to encrypt or decrypt arbitrary payloads, or to generate data encryption keys. **Data encryption keys are not stored in Key Manager**.
22
19
  *
23
20
  * @param request - The request {@link CreateKeyRequest}
24
21
  * @returns A Promise of Key
@@ -35,8 +32,7 @@ class API extends API$1 {
35
32
  unmarshalKey
36
33
  );
37
34
  /**
38
- * Get key metadata. Retrieve metadata for a specified key using the `region`
39
- * and `key_id` parameters.
35
+ * Get key metadata. Retrieve metadata for a specified key using the `region` and `key_id` parameters.
40
36
  *
41
37
  * @param request - The request {@link GetKeyRequest}
42
38
  * @returns A Promise of Key
@@ -49,8 +45,7 @@ class API extends API$1 {
49
45
  unmarshalKey
50
46
  );
51
47
  /**
52
- * Update a key. Modify a key's metadata including name, description and tags,
53
- * specified by the `key_id` and `region` parameters.
48
+ * Update a key. Modify a key's metadata including name, description and tags, specified by the `key_id` and `region` parameters.
54
49
  *
55
50
  * @param request - The request {@link UpdateKeyRequest}
56
51
  * @returns A Promise of Key
@@ -67,9 +62,7 @@ class API extends API$1 {
67
62
  unmarshalKey
68
63
  );
69
64
  /**
70
- * Delete a key. Permanently delete a key specified by the `region` and
71
- * `key_id` parameters. This action is irreversible. Any data encrypted with
72
- * this key, including data encryption keys, will no longer be decipherable.
65
+ * Delete a key. Permanently delete a key specified by the `region` and `key_id` parameters. This action is irreversible. Any data encrypted with this key, including data encryption keys, will no longer be decipherable.
73
66
  *
74
67
  * @param request - The request {@link DeleteKeyRequest}
75
68
  */
@@ -78,10 +71,7 @@ class API extends API$1 {
78
71
  path: `/key-manager/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/keys/${validatePathParam("keyId", request.keyId)}`
79
72
  });
80
73
  /**
81
- * Rotate a key. Generate a new version of an existing key with new key
82
- * material. Previous key versions remain usable to decrypt previously
83
- * encrypted data, but the key's new version will be used for subsequent
84
- * encryption operations and data key generation.
74
+ * Rotate a key. Generate a new version of an existing key with new key material. Previous key versions remain usable to decrypt previously encrypted data, but the key's new version will be used for subsequent encryption operations and data key generation.
85
75
  *
86
76
  * @param request - The request {@link RotateKeyRequest}
87
77
  * @returns A Promise of Key
@@ -96,9 +86,7 @@ class API extends API$1 {
96
86
  unmarshalKey
97
87
  );
98
88
  /**
99
- * Apply key protection. Apply protection to a given key specified by the
100
- * `key_id` parameter. Applying key protection means that your key can be used
101
- * and modified, but it cannot be deleted.
89
+ * Apply key protection. Apply protection to a given key specified by the `key_id` parameter. Applying key protection means that your key can be used and modified, but it cannot be deleted.
102
90
  *
103
91
  * @param request - The request {@link ProtectKeyRequest}
104
92
  * @returns A Promise of Key
@@ -113,9 +101,7 @@ class API extends API$1 {
113
101
  unmarshalKey
114
102
  );
115
103
  /**
116
- * Remove key protection. Remove key protection from a given key specified by
117
- * the `key_id` parameter. Removing key protection means that your key can be
118
- * deleted anytime.
104
+ * Remove key protection. Remove key protection from a given key specified by the `key_id` parameter. Removing key protection means that your key can be deleted anytime.
119
105
  *
120
106
  * @param request - The request {@link UnprotectKeyRequest}
121
107
  * @returns A Promise of Key
@@ -130,9 +116,7 @@ class API extends API$1 {
130
116
  unmarshalKey
131
117
  );
132
118
  /**
133
- * Enable key. Enable a given key to be used for cryptographic operations.
134
- * Enabling a key allows you to make a disabled key usable again. You must
135
- * specify the `region` and `key_id` parameters.
119
+ * Enable key. Enable a given key to be used for cryptographic operations. Enabling a key allows you to make a disabled key usable again. You must specify the `region` and `key_id` parameters.
136
120
  *
137
121
  * @param request - The request {@link EnableKeyRequest}
138
122
  * @returns A Promise of Key
@@ -147,9 +131,7 @@ class API extends API$1 {
147
131
  unmarshalKey
148
132
  );
149
133
  /**
150
- * Disable key. Disable a given key, preventing it to be used for
151
- * cryptographic operations. Disabling a key renders it unusable. You must
152
- * specify the `region` and `key_id` parameters.
134
+ * Disable key. Disable a given key, preventing it to be used for cryptographic operations. Disabling a key renders it unusable. You must specify the `region` and `key_id` parameters.
153
135
  *
154
136
  * @param request - The request {@link DisableKeyRequest}
155
137
  * @returns A Promise of Key
@@ -183,28 +165,20 @@ class API extends API$1 {
183
165
  unmarshalListKeysResponse
184
166
  );
185
167
  /**
186
- * List keys. Retrieve a list of keys across all Projects in an Organization
187
- * or within a specific Project. You must specify the `region`, and either the
188
- * `organization_id` or the `project_id`.
168
+ * List keys. Retrieve a list of keys across all Projects in an Organization or within a specific Project. You must specify the `region`, and either the `organization_id` or the `project_id`.
189
169
  *
190
170
  * @param request - The request {@link ListKeysRequest}
191
171
  * @returns A Promise of ListKeysResponse
192
172
  */
193
173
  listKeys = (request = {}) => enrichForPagination("keys", this.pageOfListKeys, request);
194
174
  /**
195
- * Create a data encryption key. Create a new data encryption key for
196
- * cryptographic operations outside of Key Manager. The data encryption key is
197
- * encrypted and must be decrypted using the key you have created in Key
198
- * Manager.
199
- *
200
- * The data encryption key is returned in plaintext and ciphertext but it
201
- * should only be stored in its encrypted form (ciphertext). Key Manager does
202
- * not store your data encryption key. To retrieve your key's plaintext, use
203
- * the `Decrypt` method with your key's ID and ciphertext.
204
- *
205
- * @param request - The request {@link GenerateDataKeyRequest}
206
- * @returns A Promise of DataKey
207
- */
175
+ * Create a data encryption key. Create a new data encryption key for cryptographic operations outside of Key Manager. The data encryption key is encrypted and must be decrypted using the key you have created in Key Manager.
176
+
177
+ The data encryption key is returned in plaintext and ciphertext but it should only be stored in its encrypted form (ciphertext). Key Manager does not store your data encryption key. To retrieve your key's plaintext, use the `Decrypt` method with your key's ID and ciphertext.
178
+ *
179
+ * @param request - The request {@link GenerateDataKeyRequest}
180
+ * @returns A Promise of DataKey
181
+ */
208
182
  generateDataKey = (request) => this.client.fetch(
209
183
  {
210
184
  body: JSON.stringify(
@@ -217,10 +191,7 @@ class API extends API$1 {
217
191
  unmarshalDataKey
218
192
  );
219
193
  /**
220
- * Encrypt a payload. Encrypt a payload using an existing key, specified by
221
- * the `key_id` parameter. Only keys with a usage set to
222
- * `symmetric_encryption` are supported by this method. The maximum payload
223
- * size that can be encrypted is 64 KB of plaintext.
194
+ * Encrypt a payload. Encrypt a payload using an existing key, specified by the `key_id` parameter. Only keys with a usage set to `symmetric_encryption` are supported by this method. The maximum payload size that can be encrypted is 64 KB of plaintext.
224
195
  *
225
196
  * @param request - The request {@link EncryptRequest}
226
197
  * @returns A Promise of EncryptResponse
@@ -237,10 +208,7 @@ class API extends API$1 {
237
208
  unmarshalEncryptResponse
238
209
  );
239
210
  /**
240
- * Decrypt an encrypted payload. Decrypt an encrypted payload using an
241
- * existing key, specified by the `key_id` parameter. The maximum payload size
242
- * that can be decrypted is equivalent to the encrypted output of 64 KB of
243
- * data (around 131 KB).
211
+ * Decrypt an encrypted payload. Decrypt an encrypted payload using an existing key, specified by the `key_id` parameter. The maximum payload size that can be decrypted is equivalent to the encrypted output of 64 KB of data (around 131 KB).
244
212
  *
245
213
  * @param request - The request {@link DecryptRequest}
246
214
  * @returns A Promise of DecryptResponse
@@ -257,9 +225,7 @@ class API extends API$1 {
257
225
  unmarshalDecryptResponse
258
226
  );
259
227
  /**
260
- * Import key material. Import externally generated key material into Key
261
- * Manager to derive a new cryptographic key. The key's origin must be
262
- * `external`.
228
+ * Import key material. Import externally generated key material into Key Manager to derive a new cryptographic key. The key's origin must be `external`.
263
229
  *
264
230
  * @param request - The request {@link ImportKeyMaterialRequest}
265
231
  * @returns A Promise of Key
@@ -276,9 +242,7 @@ class API extends API$1 {
276
242
  unmarshalKey
277
243
  );
278
244
  /**
279
- * Delete key material. Delete previously imported key material. This renders
280
- * the associated cryptographic key unusable for any operation. The key's
281
- * origin must be `external`.
245
+ * Delete key material. Delete previously imported key material. This renders the associated cryptographic key unusable for any operation. The key's origin must be `external`.
282
246
  *
283
247
  * @param request - The request {@link DeleteKeyMaterialRequest}
284
248
  */