@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
@@ -3,8 +3,8 @@ import type { Region as ScwRegion } from '@scaleway/sdk-client';
3
3
  import type { ListNatsAccountsResponse, ListNatsCredentialsResponse, ListSnsCredentialsResponse, ListSqsCredentialsResponse, NatsAccount, NatsApiCreateNatsAccountRequest, NatsApiCreateNatsCredentialsRequest, NatsApiDeleteNatsAccountRequest, NatsApiDeleteNatsCredentialsRequest, NatsApiGetNatsAccountRequest, NatsApiGetNatsCredentialsRequest, NatsApiListNatsAccountsRequest, NatsApiListNatsCredentialsRequest, NatsApiUpdateNatsAccountRequest, NatsCredentials, SnsApiActivateSnsRequest, SnsApiCreateSnsCredentialsRequest, SnsApiDeactivateSnsRequest, SnsApiDeleteSnsCredentialsRequest, SnsApiGetSnsCredentialsRequest, SnsApiGetSnsInfoRequest, SnsApiListSnsCredentialsRequest, SnsApiUpdateSnsCredentialsRequest, SnsCredentials, SnsInfo, SqsApiActivateSqsRequest, SqsApiCreateSqsCredentialsRequest, SqsApiDeactivateSqsRequest, SqsApiDeleteSqsCredentialsRequest, SqsApiGetSqsCredentialsRequest, SqsApiGetSqsInfoRequest, SqsApiListSqsCredentialsRequest, SqsApiUpdateSqsCredentialsRequest, SqsCredentials, SqsInfo } from './types.gen';
4
4
  /**
5
5
  * NATS API.
6
- *
7
- * This API allows you to manage Scaleway NATS accounts.
6
+
7
+ This API allows you to manage Scaleway NATS accounts.
8
8
  */
9
9
  export declare class NatsAPI extends ParentAPI {
10
10
  /** Lists the available regions of the API. */
@@ -17,26 +17,20 @@ export declare class NatsAPI extends ParentAPI {
17
17
  */
18
18
  createNatsAccount: (request?: Readonly<NatsApiCreateNatsAccountRequest>) => Promise<NatsAccount>;
19
19
  /**
20
- * Delete a NATS account. Delete a NATS account, specified by its NATS account
21
- * ID. Note that deleting a NATS account is irreversible, and any credentials,
22
- * streams, consumer and stored messages belonging to this NATS account will
23
- * also be deleted.
20
+ * Delete a NATS account. Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted.
24
21
  *
25
22
  * @param request - The request {@link NatsApiDeleteNatsAccountRequest}
26
23
  */
27
24
  deleteNatsAccount: (request: Readonly<NatsApiDeleteNatsAccountRequest>) => Promise<void>;
28
25
  /**
29
- * Update the name of a NATS account. Update the name of a NATS account,
30
- * specified by its NATS account ID.
26
+ * Update the name of a NATS account. Update the name of a NATS account, specified by its NATS account ID.
31
27
  *
32
28
  * @param request - The request {@link NatsApiUpdateNatsAccountRequest}
33
29
  * @returns A Promise of NatsAccount
34
30
  */
35
31
  updateNatsAccount: (request: Readonly<NatsApiUpdateNatsAccountRequest>) => Promise<NatsAccount>;
36
32
  /**
37
- * Get a NATS account. Retrieve information about an existing NATS account
38
- * identified by its NATS account ID. Its full details, including name and
39
- * endpoint, are returned in the response.
33
+ * Get a NATS account. Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response.
40
34
  *
41
35
  * @param request - The request {@link NatsApiGetNatsAccountRequest}
42
36
  * @returns A Promise of NatsAccount
@@ -44,10 +38,7 @@ export declare class NatsAPI extends ParentAPI {
44
38
  getNatsAccount: (request: Readonly<NatsApiGetNatsAccountRequest>) => Promise<NatsAccount>;
45
39
  protected pageOfListNatsAccounts: (request?: Readonly<NatsApiListNatsAccountsRequest>) => Promise<ListNatsAccountsResponse>;
46
40
  /**
47
- * List NATS accounts. List all NATS accounts in the specified region, for a
48
- * Scaleway Organization or Project. By default, the NATS accounts returned in
49
- * the list are ordered by creation date in ascending order, though this can
50
- * be modified via the `order_by` field.
41
+ * List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
51
42
  *
52
43
  * @param request - The request {@link NatsApiListNatsAccountsRequest}
53
44
  * @returns A Promise of ListNatsAccountsResponse
@@ -57,27 +48,20 @@ export declare class NatsAPI extends ParentAPI {
57
48
  [Symbol.asyncIterator]: () => AsyncGenerator<NatsAccount[], void, void>;
58
49
  };
59
50
  /**
60
- * Create NATS credentials. Create a set of credentials for a NATS account,
61
- * specified by its NATS account ID.
51
+ * Create NATS credentials. Create a set of credentials for a NATS account, specified by its NATS account ID.
62
52
  *
63
53
  * @param request - The request {@link NatsApiCreateNatsCredentialsRequest}
64
54
  * @returns A Promise of NatsCredentials
65
55
  */
66
56
  createNatsCredentials: (request: Readonly<NatsApiCreateNatsCredentialsRequest>) => Promise<NatsCredentials>;
67
57
  /**
68
- * Delete NATS credentials. Delete a set of credentials, specified by their
69
- * credentials ID. Deleting credentials is irreversible and cannot be undone.
70
- * The credentials can no longer be used to access the NATS account, and
71
- * active connections using this credentials will be closed.
58
+ * Delete NATS credentials. Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed.
72
59
  *
73
60
  * @param request - The request {@link NatsApiDeleteNatsCredentialsRequest}
74
61
  */
75
62
  deleteNatsCredentials: (request: Readonly<NatsApiDeleteNatsCredentialsRequest>) => Promise<void>;
76
63
  /**
77
- * Get NATS credentials. Retrieve an existing set of credentials, identified
78
- * by the `nats_credentials_id`. The credentials themselves are NOT returned,
79
- * only their metadata (NATS account ID, credentials name, etc), are returned
80
- * in the response.
64
+ * Get NATS credentials. Retrieve an existing set of credentials, identified by the `nats_credentials_id`. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response.
81
65
  *
82
66
  * @param request - The request {@link NatsApiGetNatsCredentialsRequest}
83
67
  * @returns A Promise of NatsCredentials
@@ -85,10 +69,7 @@ export declare class NatsAPI extends ParentAPI {
85
69
  getNatsCredentials: (request: Readonly<NatsApiGetNatsCredentialsRequest>) => Promise<NatsCredentials>;
86
70
  protected pageOfListNatsCredentials: (request?: Readonly<NatsApiListNatsCredentialsRequest>) => Promise<ListNatsCredentialsResponse>;
87
71
  /**
88
- * List NATS credentials. List existing credentials in the specified NATS
89
- * account. The response contains only the metadata for the credentials, not
90
- * the credentials themselves, which are only returned after a **Create
91
- * Credentials** call.
72
+ * List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a **Create Credentials** call.
92
73
  *
93
74
  * @param request - The request {@link NatsApiListNatsCredentialsRequest}
94
75
  * @returns A Promise of ListNatsCredentialsResponse
@@ -100,70 +81,55 @@ export declare class NatsAPI extends ParentAPI {
100
81
  }
101
82
  /**
102
83
  * Topics and Events API.
103
- *
104
- * This API allows you to manage your Scaleway Topics and Events.
84
+
85
+ This API allows you to manage your Scaleway Topics and Events.
105
86
  */
106
87
  export declare class SnsAPI extends ParentAPI {
107
88
  /** Lists the available regions of the API. */
108
89
  static readonly LOCALITIES: ScwRegion[];
109
90
  /**
110
- * Activate Topics and Events. Activate Topics and Events for the specified
111
- * Project ID. Topics and Events must be activated before any usage.
112
- * Activating Topics and Events does not trigger any billing, and you can
113
- * deactivate at any time.
91
+ * Activate Topics and Events. Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time.
114
92
  *
115
93
  * @param request - The request {@link SnsApiActivateSnsRequest}
116
94
  * @returns A Promise of SnsInfo
117
95
  */
118
96
  activateSns: (request?: Readonly<SnsApiActivateSnsRequest>) => Promise<SnsInfo>;
119
97
  /**
120
- * Get Topics and Events info. Retrieve the Topics and Events information of
121
- * the specified Project ID. Informations include the activation status and
122
- * the Topics and Events API endpoint URL.
98
+ * Get Topics and Events info. Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.
123
99
  *
124
100
  * @param request - The request {@link SnsApiGetSnsInfoRequest}
125
101
  * @returns A Promise of SnsInfo
126
102
  */
127
103
  getSnsInfo: (request?: Readonly<SnsApiGetSnsInfoRequest>) => Promise<SnsInfo>;
128
104
  /**
129
- * Deactivate Topics and Events. Deactivate Topics and Events for the
130
- * specified Project ID. You must delete all topics and credentials before
131
- * this call or you need to set the force_delete parameter.
105
+ * Deactivate Topics and Events. Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter.
132
106
  *
133
107
  * @param request - The request {@link SnsApiDeactivateSnsRequest}
134
108
  * @returns A Promise of SnsInfo
135
109
  */
136
110
  deactivateSns: (request?: Readonly<SnsApiDeactivateSnsRequest>) => Promise<SnsInfo>;
137
111
  /**
138
- * Create Topics and Events credentials. Create a set of credentials for
139
- * Topics and Events, specified by a Project ID. Credentials give the bearer
140
- * access to topics, and the level of permissions can be defined granularly.
112
+ * Create Topics and Events credentials. Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.
141
113
  *
142
114
  * @param request - The request {@link SnsApiCreateSnsCredentialsRequest}
143
115
  * @returns A Promise of SnsCredentials
144
116
  */
145
117
  createSnsCredentials: (request?: Readonly<SnsApiCreateSnsCredentialsRequest>) => Promise<SnsCredentials>;
146
118
  /**
147
- * Delete Topics and Events credentials. Delete a set of Topics and Events
148
- * credentials, specified by their credentials ID. Deleting credentials is
149
- * irreversible and cannot be undone. The credentials can then no longer be
150
- * used to access Topics and Events.
119
+ * Delete Topics and Events credentials. Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events.
151
120
  *
152
121
  * @param request - The request {@link SnsApiDeleteSnsCredentialsRequest}
153
122
  */
154
123
  deleteSnsCredentials: (request: Readonly<SnsApiDeleteSnsCredentialsRequest>) => Promise<void>;
155
124
  /**
156
- * Update Topics and Events credentials. Update a set of Topics and Events
157
- * credentials. You can update the credentials' name, or their permissions.
125
+ * Update Topics and Events credentials. Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions.
158
126
  *
159
127
  * @param request - The request {@link SnsApiUpdateSnsCredentialsRequest}
160
128
  * @returns A Promise of SnsCredentials
161
129
  */
162
130
  updateSnsCredentials: (request: Readonly<SnsApiUpdateSnsCredentialsRequest>) => Promise<SnsCredentials>;
163
131
  /**
164
- * Get Topics and Events credentials. Retrieve an existing set of credentials,
165
- * identified by the `credentials_id`. The credentials themselves, as well as
166
- * their metadata (name, project ID etc), are returned in the response.
132
+ * Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
167
133
  *
168
134
  * @param request - The request {@link SnsApiGetSnsCredentialsRequest}
169
135
  * @returns A Promise of SnsCredentials
@@ -171,9 +137,7 @@ export declare class SnsAPI extends ParentAPI {
171
137
  getSnsCredentials: (request: Readonly<SnsApiGetSnsCredentialsRequest>) => Promise<SnsCredentials>;
172
138
  protected pageOfListSnsCredentials: (request?: Readonly<SnsApiListSnsCredentialsRequest>) => Promise<ListSnsCredentialsResponse>;
173
139
  /**
174
- * List Topics and Events credentials. List existing Topics and Events
175
- * credentials in the specified region. The response contains only the
176
- * metadata for the credentials, not the credentials themselves.
140
+ * List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
177
141
  *
178
142
  * @param request - The request {@link SnsApiListSnsCredentialsRequest}
179
143
  * @returns A Promise of ListSnsCredentialsResponse
@@ -185,69 +149,55 @@ export declare class SnsAPI extends ParentAPI {
185
149
  }
186
150
  /**
187
151
  * Queues API.
188
- *
189
- * This API allows you to manage your Scaleway Queues.
152
+
153
+ This API allows you to manage your Scaleway Queues.
190
154
  */
191
155
  export declare class SqsAPI extends ParentAPI {
192
156
  /** Lists the available regions of the API. */
193
157
  static readonly LOCALITIES: ScwRegion[];
194
158
  /**
195
- * Activate Queues. Activate Queues for the specified Project ID. Queues must
196
- * be activated before any usage such as creating credentials and queues.
197
- * Activating Queues does not trigger any billing, and you can deactivate at
198
- * any time.
159
+ * Activate Queues. Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time.
199
160
  *
200
161
  * @param request - The request {@link SqsApiActivateSqsRequest}
201
162
  * @returns A Promise of SqsInfo
202
163
  */
203
164
  activateSqs: (request?: Readonly<SqsApiActivateSqsRequest>) => Promise<SqsInfo>;
204
165
  /**
205
- * Get Queues info. Retrieve the Queues information of the specified Project
206
- * ID. Informations include the activation status and the Queues API endpoint
207
- * URL.
166
+ * Get Queues info. Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL.
208
167
  *
209
168
  * @param request - The request {@link SqsApiGetSqsInfoRequest}
210
169
  * @returns A Promise of SqsInfo
211
170
  */
212
171
  getSqsInfo: (request?: Readonly<SqsApiGetSqsInfoRequest>) => Promise<SqsInfo>;
213
172
  /**
214
- * Deactivate Queues. Deactivate Queues for the specified Project ID. You must
215
- * delete all queues and credentials before this call or you need to set the
216
- * force_delete parameter.
173
+ * Deactivate Queues. Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.
217
174
  *
218
175
  * @param request - The request {@link SqsApiDeactivateSqsRequest}
219
176
  * @returns A Promise of SqsInfo
220
177
  */
221
178
  deactivateSqs: (request?: Readonly<SqsApiDeactivateSqsRequest>) => Promise<SqsInfo>;
222
179
  /**
223
- * Create Queues credentials. Create a set of credentials for Queues,
224
- * specified by a Project ID. Credentials give the bearer access to queues,
225
- * and the level of permissions can be defined granularly.
180
+ * Create Queues credentials. Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.
226
181
  *
227
182
  * @param request - The request {@link SqsApiCreateSqsCredentialsRequest}
228
183
  * @returns A Promise of SqsCredentials
229
184
  */
230
185
  createSqsCredentials: (request?: Readonly<SqsApiCreateSqsCredentialsRequest>) => Promise<SqsCredentials>;
231
186
  /**
232
- * Delete Queues credentials. Delete a set of Queues credentials, specified by
233
- * their credentials ID. Deleting credentials is irreversible and cannot be
234
- * undone. The credentials can then no longer be used to access Queues.
187
+ * Delete Queues credentials. Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues.
235
188
  *
236
189
  * @param request - The request {@link SqsApiDeleteSqsCredentialsRequest}
237
190
  */
238
191
  deleteSqsCredentials: (request: Readonly<SqsApiDeleteSqsCredentialsRequest>) => Promise<void>;
239
192
  /**
240
- * Update Queues credentials. Update a set of Queues credentials. You can
241
- * update the credentials' name, or their permissions.
193
+ * Update Queues credentials. Update a set of Queues credentials. You can update the credentials' name, or their permissions.
242
194
  *
243
195
  * @param request - The request {@link SqsApiUpdateSqsCredentialsRequest}
244
196
  * @returns A Promise of SqsCredentials
245
197
  */
246
198
  updateSqsCredentials: (request: Readonly<SqsApiUpdateSqsCredentialsRequest>) => Promise<SqsCredentials>;
247
199
  /**
248
- * Get Queues credentials. Retrieve an existing set of credentials, identified
249
- * by the `credentials_id`. The credentials themselves, as well as their
250
- * metadata (name, project ID etc), are returned in the response.
200
+ * Get Queues credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
251
201
  *
252
202
  * @param request - The request {@link SqsApiGetSqsCredentialsRequest}
253
203
  * @returns A Promise of SqsCredentials
@@ -255,9 +205,7 @@ export declare class SqsAPI extends ParentAPI {
255
205
  getSqsCredentials: (request: Readonly<SqsApiGetSqsCredentialsRequest>) => Promise<SqsCredentials>;
256
206
  protected pageOfListSqsCredentials: (request?: Readonly<SqsApiListSqsCredentialsRequest>) => Promise<ListSqsCredentialsResponse>;
257
207
  /**
258
- * List Queues credentials. List existing Queues credentials in the specified
259
- * region. The response contains only the metadata for the credentials, not
260
- * the credentials themselves.
208
+ * List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
261
209
  *
262
210
  * @param request - The request {@link SqsApiListSqsCredentialsRequest}
263
211
  * @returns A Promise of ListSqsCredentialsResponse
@@ -28,10 +28,7 @@ class NatsAPI extends API$1 {
28
28
  unmarshalNatsAccount
29
29
  );
30
30
  /**
31
- * Delete a NATS account. Delete a NATS account, specified by its NATS account
32
- * ID. Note that deleting a NATS account is irreversible, and any credentials,
33
- * streams, consumer and stored messages belonging to this NATS account will
34
- * also be deleted.
31
+ * Delete a NATS account. Delete a NATS account, specified by its NATS account ID. Note that deleting a NATS account is irreversible, and any credentials, streams, consumer and stored messages belonging to this NATS account will also be deleted.
35
32
  *
36
33
  * @param request - The request {@link NatsApiDeleteNatsAccountRequest}
37
34
  */
@@ -40,8 +37,7 @@ class NatsAPI extends API$1 {
40
37
  path: `/mnq/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nats-accounts/${validatePathParam("natsAccountId", request.natsAccountId)}`
41
38
  });
42
39
  /**
43
- * Update the name of a NATS account. Update the name of a NATS account,
44
- * specified by its NATS account ID.
40
+ * Update the name of a NATS account. Update the name of a NATS account, specified by its NATS account ID.
45
41
  *
46
42
  * @param request - The request {@link NatsApiUpdateNatsAccountRequest}
47
43
  * @returns A Promise of NatsAccount
@@ -58,9 +54,7 @@ class NatsAPI extends API$1 {
58
54
  unmarshalNatsAccount
59
55
  );
60
56
  /**
61
- * Get a NATS account. Retrieve information about an existing NATS account
62
- * identified by its NATS account ID. Its full details, including name and
63
- * endpoint, are returned in the response.
57
+ * Get a NATS account. Retrieve information about an existing NATS account identified by its NATS account ID. Its full details, including name and endpoint, are returned in the response.
64
58
  *
65
59
  * @param request - The request {@link NatsApiGetNatsAccountRequest}
66
60
  * @returns A Promise of NatsAccount
@@ -89,18 +83,14 @@ class NatsAPI extends API$1 {
89
83
  unmarshalListNatsAccountsResponse
90
84
  );
91
85
  /**
92
- * List NATS accounts. List all NATS accounts in the specified region, for a
93
- * Scaleway Organization or Project. By default, the NATS accounts returned in
94
- * the list are ordered by creation date in ascending order, though this can
95
- * be modified via the `order_by` field.
86
+ * List NATS accounts. List all NATS accounts in the specified region, for a Scaleway Organization or Project. By default, the NATS accounts returned in the list are ordered by creation date in ascending order, though this can be modified via the `order_by` field.
96
87
  *
97
88
  * @param request - The request {@link NatsApiListNatsAccountsRequest}
98
89
  * @returns A Promise of ListNatsAccountsResponse
99
90
  */
100
91
  listNatsAccounts = (request = {}) => enrichForPagination("natsAccounts", this.pageOfListNatsAccounts, request);
101
92
  /**
102
- * Create NATS credentials. Create a set of credentials for a NATS account,
103
- * specified by its NATS account ID.
93
+ * Create NATS credentials. Create a set of credentials for a NATS account, specified by its NATS account ID.
104
94
  *
105
95
  * @param request - The request {@link NatsApiCreateNatsCredentialsRequest}
106
96
  * @returns A Promise of NatsCredentials
@@ -120,10 +110,7 @@ class NatsAPI extends API$1 {
120
110
  unmarshalNatsCredentials
121
111
  );
122
112
  /**
123
- * Delete NATS credentials. Delete a set of credentials, specified by their
124
- * credentials ID. Deleting credentials is irreversible and cannot be undone.
125
- * The credentials can no longer be used to access the NATS account, and
126
- * active connections using this credentials will be closed.
113
+ * Delete NATS credentials. Delete a set of credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can no longer be used to access the NATS account, and active connections using this credentials will be closed.
127
114
  *
128
115
  * @param request - The request {@link NatsApiDeleteNatsCredentialsRequest}
129
116
  */
@@ -132,10 +119,7 @@ class NatsAPI extends API$1 {
132
119
  path: `/mnq/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/nats-credentials/${validatePathParam("natsCredentialsId", request.natsCredentialsId)}`
133
120
  });
134
121
  /**
135
- * Get NATS credentials. Retrieve an existing set of credentials, identified
136
- * by the `nats_credentials_id`. The credentials themselves are NOT returned,
137
- * only their metadata (NATS account ID, credentials name, etc), are returned
138
- * in the response.
122
+ * Get NATS credentials. Retrieve an existing set of credentials, identified by the `nats_credentials_id`. The credentials themselves are NOT returned, only their metadata (NATS account ID, credentials name, etc), are returned in the response.
139
123
  *
140
124
  * @param request - The request {@link NatsApiGetNatsCredentialsRequest}
141
125
  * @returns A Promise of NatsCredentials
@@ -165,10 +149,7 @@ class NatsAPI extends API$1 {
165
149
  unmarshalListNatsCredentialsResponse
166
150
  );
167
151
  /**
168
- * List NATS credentials. List existing credentials in the specified NATS
169
- * account. The response contains only the metadata for the credentials, not
170
- * the credentials themselves, which are only returned after a **Create
171
- * Credentials** call.
152
+ * List NATS credentials. List existing credentials in the specified NATS account. The response contains only the metadata for the credentials, not the credentials themselves, which are only returned after a **Create Credentials** call.
172
153
  *
173
154
  * @param request - The request {@link NatsApiListNatsCredentialsRequest}
174
155
  * @returns A Promise of ListNatsCredentialsResponse
@@ -183,10 +164,7 @@ class SnsAPI extends API$1 {
183
164
  /** Lists the available regions of the API. */
184
165
  static LOCALITIES = ["fr-par", "nl-ams"];
185
166
  /**
186
- * Activate Topics and Events. Activate Topics and Events for the specified
187
- * Project ID. Topics and Events must be activated before any usage.
188
- * Activating Topics and Events does not trigger any billing, and you can
189
- * deactivate at any time.
167
+ * Activate Topics and Events. Activate Topics and Events for the specified Project ID. Topics and Events must be activated before any usage. Activating Topics and Events does not trigger any billing, and you can deactivate at any time.
190
168
  *
191
169
  * @param request - The request {@link SnsApiActivateSnsRequest}
192
170
  * @returns A Promise of SnsInfo
@@ -203,9 +181,7 @@ class SnsAPI extends API$1 {
203
181
  unmarshalSnsInfo
204
182
  );
205
183
  /**
206
- * Get Topics and Events info. Retrieve the Topics and Events information of
207
- * the specified Project ID. Informations include the activation status and
208
- * the Topics and Events API endpoint URL.
184
+ * Get Topics and Events info. Retrieve the Topics and Events information of the specified Project ID. Informations include the activation status and the Topics and Events API endpoint URL.
209
185
  *
210
186
  * @param request - The request {@link SnsApiGetSnsInfoRequest}
211
187
  * @returns A Promise of SnsInfo
@@ -222,9 +198,7 @@ class SnsAPI extends API$1 {
222
198
  unmarshalSnsInfo
223
199
  );
224
200
  /**
225
- * Deactivate Topics and Events. Deactivate Topics and Events for the
226
- * specified Project ID. You must delete all topics and credentials before
227
- * this call or you need to set the force_delete parameter.
201
+ * Deactivate Topics and Events. Deactivate Topics and Events for the specified Project ID. You must delete all topics and credentials before this call or you need to set the force_delete parameter.
228
202
  *
229
203
  * @param request - The request {@link SnsApiDeactivateSnsRequest}
230
204
  * @returns A Promise of SnsInfo
@@ -241,9 +215,7 @@ class SnsAPI extends API$1 {
241
215
  unmarshalSnsInfo
242
216
  );
243
217
  /**
244
- * Create Topics and Events credentials. Create a set of credentials for
245
- * Topics and Events, specified by a Project ID. Credentials give the bearer
246
- * access to topics, and the level of permissions can be defined granularly.
218
+ * Create Topics and Events credentials. Create a set of credentials for Topics and Events, specified by a Project ID. Credentials give the bearer access to topics, and the level of permissions can be defined granularly.
247
219
  *
248
220
  * @param request - The request {@link SnsApiCreateSnsCredentialsRequest}
249
221
  * @returns A Promise of SnsCredentials
@@ -263,10 +235,7 @@ class SnsAPI extends API$1 {
263
235
  unmarshalSnsCredentials
264
236
  );
265
237
  /**
266
- * Delete Topics and Events credentials. Delete a set of Topics and Events
267
- * credentials, specified by their credentials ID. Deleting credentials is
268
- * irreversible and cannot be undone. The credentials can then no longer be
269
- * used to access Topics and Events.
238
+ * Delete Topics and Events credentials. Delete a set of Topics and Events credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Topics and Events.
270
239
  *
271
240
  * @param request - The request {@link SnsApiDeleteSnsCredentialsRequest}
272
241
  */
@@ -275,8 +244,7 @@ class SnsAPI extends API$1 {
275
244
  path: `/mnq/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sns-credentials/${validatePathParam("snsCredentialsId", request.snsCredentialsId)}`
276
245
  });
277
246
  /**
278
- * Update Topics and Events credentials. Update a set of Topics and Events
279
- * credentials. You can update the credentials' name, or their permissions.
247
+ * Update Topics and Events credentials. Update a set of Topics and Events credentials. You can update the credentials' name, or their permissions.
280
248
  *
281
249
  * @param request - The request {@link SnsApiUpdateSnsCredentialsRequest}
282
250
  * @returns A Promise of SnsCredentials
@@ -296,9 +264,7 @@ class SnsAPI extends API$1 {
296
264
  unmarshalSnsCredentials
297
265
  );
298
266
  /**
299
- * Get Topics and Events credentials. Retrieve an existing set of credentials,
300
- * identified by the `credentials_id`. The credentials themselves, as well as
301
- * their metadata (name, project ID etc), are returned in the response.
267
+ * Get Topics and Events credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
302
268
  *
303
269
  * @param request - The request {@link SnsApiGetSnsCredentialsRequest}
304
270
  * @returns A Promise of SnsCredentials
@@ -327,9 +293,7 @@ class SnsAPI extends API$1 {
327
293
  unmarshalListSnsCredentialsResponse
328
294
  );
329
295
  /**
330
- * List Topics and Events credentials. List existing Topics and Events
331
- * credentials in the specified region. The response contains only the
332
- * metadata for the credentials, not the credentials themselves.
296
+ * List Topics and Events credentials. List existing Topics and Events credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
333
297
  *
334
298
  * @param request - The request {@link SnsApiListSnsCredentialsRequest}
335
299
  * @returns A Promise of ListSnsCredentialsResponse
@@ -344,10 +308,7 @@ class SqsAPI extends API$1 {
344
308
  /** Lists the available regions of the API. */
345
309
  static LOCALITIES = ["fr-par", "nl-ams"];
346
310
  /**
347
- * Activate Queues. Activate Queues for the specified Project ID. Queues must
348
- * be activated before any usage such as creating credentials and queues.
349
- * Activating Queues does not trigger any billing, and you can deactivate at
350
- * any time.
311
+ * Activate Queues. Activate Queues for the specified Project ID. Queues must be activated before any usage such as creating credentials and queues. Activating Queues does not trigger any billing, and you can deactivate at any time.
351
312
  *
352
313
  * @param request - The request {@link SqsApiActivateSqsRequest}
353
314
  * @returns A Promise of SqsInfo
@@ -364,9 +325,7 @@ class SqsAPI extends API$1 {
364
325
  unmarshalSqsInfo
365
326
  );
366
327
  /**
367
- * Get Queues info. Retrieve the Queues information of the specified Project
368
- * ID. Informations include the activation status and the Queues API endpoint
369
- * URL.
328
+ * Get Queues info. Retrieve the Queues information of the specified Project ID. Informations include the activation status and the Queues API endpoint URL.
370
329
  *
371
330
  * @param request - The request {@link SqsApiGetSqsInfoRequest}
372
331
  * @returns A Promise of SqsInfo
@@ -383,9 +342,7 @@ class SqsAPI extends API$1 {
383
342
  unmarshalSqsInfo
384
343
  );
385
344
  /**
386
- * Deactivate Queues. Deactivate Queues for the specified Project ID. You must
387
- * delete all queues and credentials before this call or you need to set the
388
- * force_delete parameter.
345
+ * Deactivate Queues. Deactivate Queues for the specified Project ID. You must delete all queues and credentials before this call or you need to set the force_delete parameter.
389
346
  *
390
347
  * @param request - The request {@link SqsApiDeactivateSqsRequest}
391
348
  * @returns A Promise of SqsInfo
@@ -402,9 +359,7 @@ class SqsAPI extends API$1 {
402
359
  unmarshalSqsInfo
403
360
  );
404
361
  /**
405
- * Create Queues credentials. Create a set of credentials for Queues,
406
- * specified by a Project ID. Credentials give the bearer access to queues,
407
- * and the level of permissions can be defined granularly.
362
+ * Create Queues credentials. Create a set of credentials for Queues, specified by a Project ID. Credentials give the bearer access to queues, and the level of permissions can be defined granularly.
408
363
  *
409
364
  * @param request - The request {@link SqsApiCreateSqsCredentialsRequest}
410
365
  * @returns A Promise of SqsCredentials
@@ -424,9 +379,7 @@ class SqsAPI extends API$1 {
424
379
  unmarshalSqsCredentials
425
380
  );
426
381
  /**
427
- * Delete Queues credentials. Delete a set of Queues credentials, specified by
428
- * their credentials ID. Deleting credentials is irreversible and cannot be
429
- * undone. The credentials can then no longer be used to access Queues.
382
+ * Delete Queues credentials. Delete a set of Queues credentials, specified by their credentials ID. Deleting credentials is irreversible and cannot be undone. The credentials can then no longer be used to access Queues.
430
383
  *
431
384
  * @param request - The request {@link SqsApiDeleteSqsCredentialsRequest}
432
385
  */
@@ -435,8 +388,7 @@ class SqsAPI extends API$1 {
435
388
  path: `/mnq/v1beta1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/sqs-credentials/${validatePathParam("sqsCredentialsId", request.sqsCredentialsId)}`
436
389
  });
437
390
  /**
438
- * Update Queues credentials. Update a set of Queues credentials. You can
439
- * update the credentials' name, or their permissions.
391
+ * Update Queues credentials. Update a set of Queues credentials. You can update the credentials' name, or their permissions.
440
392
  *
441
393
  * @param request - The request {@link SqsApiUpdateSqsCredentialsRequest}
442
394
  * @returns A Promise of SqsCredentials
@@ -456,9 +408,7 @@ class SqsAPI extends API$1 {
456
408
  unmarshalSqsCredentials
457
409
  );
458
410
  /**
459
- * Get Queues credentials. Retrieve an existing set of credentials, identified
460
- * by the `credentials_id`. The credentials themselves, as well as their
461
- * metadata (name, project ID etc), are returned in the response.
411
+ * Get Queues credentials. Retrieve an existing set of credentials, identified by the `credentials_id`. The credentials themselves, as well as their metadata (name, project ID etc), are returned in the response.
462
412
  *
463
413
  * @param request - The request {@link SqsApiGetSqsCredentialsRequest}
464
414
  * @returns A Promise of SqsCredentials
@@ -487,9 +437,7 @@ class SqsAPI extends API$1 {
487
437
  unmarshalListSqsCredentialsResponse
488
438
  );
489
439
  /**
490
- * List Queues credentials. List existing Queues credentials in the specified
491
- * region. The response contains only the metadata for the credentials, not
492
- * the credentials themselves.
440
+ * List Queues credentials. List existing Queues credentials in the specified region. The response contains only the metadata for the credentials, not the credentials themselves.
493
441
  *
494
442
  * @param request - The request {@link SqsApiListSqsCredentialsRequest}
495
443
  * @returns A Promise of ListSqsCredentialsResponse