@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
@@ -1,36 +1,29 @@
1
1
  import { API as ParentAPI } from '@scaleway/sdk-client';
2
2
  import type { Region as ScwRegion } from '@scaleway/sdk-client';
3
- import type { AlertManager, ContactPoint, DataSource, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
3
+ import type { AlertManager, ContactPoint, DataSource, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
4
4
  /**
5
5
  * Cockpit Global API.
6
- *
7
- * The Cockpit Global API allows you to manage your Cockpit's Grafana and plans.
6
+
7
+ The Cockpit Global API allows you to manage your Cockpit's Grafana.
8
8
  */
9
9
  export declare class GlobalAPI extends ParentAPI {
10
10
  /**
11
- * Get your Cockpit's Grafana. Retrieve information on your Cockpit's Grafana,
12
- * specified by the ID of the Project the Cockpit belongs to. The output
13
- * returned displays the URL to access your Cockpit's Grafana.
11
+ * Get your Cockpit's Grafana. Retrieve information on your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to.
12
+ The output returned displays the URL to access your Cockpit's Grafana.
14
13
  *
15
14
  * @param request - The request {@link GlobalApiGetGrafanaRequest}
16
15
  * @returns A Promise of Grafana
17
16
  */
18
17
  getGrafana: (request?: Readonly<GlobalApiGetGrafanaRequest>) => Promise<Grafana>;
19
18
  /**
20
- * Synchronize Grafana data sources. Trigger the synchronization of all your
21
- * data sources and the alert manager in the relevant regions. The alert
22
- * manager will only be synchronized if you have enabled it.
19
+ * Synchronize Grafana data sources. Trigger the synchronization of all your data sources and the alert manager in the relevant regions. The alert manager will only be synchronized if you have enabled it.
23
20
  *
24
21
  * @param request - The request {@link GlobalApiSyncGrafanaDataSourcesRequest}
25
22
  */
26
23
  syncGrafanaDataSources: (request?: Readonly<GlobalApiSyncGrafanaDataSourcesRequest>) => Promise<void>;
27
24
  /**
28
- * Create a Grafana user. Create a Grafana user to connect to your Cockpit's
29
- * Grafana. Upon creation, your user password displays only once, so make sure
30
- * that you save it. Each Grafana user is associated with a role: viewer or
31
- * editor. A viewer can only view dashboards, whereas an editor can create and
32
- * edit dashboards. Note that the `admin` username is not available for
33
- * creation.
25
+ * Create a Grafana user. Create a Grafana user to connect to your Cockpit's Grafana. Upon creation, your user password displays only once, so make sure that you save it.
26
+ Each Grafana user is associated with a role: viewer or editor. A viewer can only view dashboards, whereas an editor can create and edit dashboards. Note that the `admin` username is not available for creation.
34
27
  *
35
28
  * @param request - The request {@link GlobalApiCreateGrafanaUserRequest}
36
29
  * @returns A Promise of GrafanaUser
@@ -38,9 +31,7 @@ export declare class GlobalAPI extends ParentAPI {
38
31
  createGrafanaUser: (request: Readonly<GlobalApiCreateGrafanaUserRequest>) => Promise<GrafanaUser>;
39
32
  protected pageOfListGrafanaUsers: (request?: Readonly<GlobalApiListGrafanaUsersRequest>) => Promise<ListGrafanaUsersResponse>;
40
33
  /**
41
- * List Grafana users. List all Grafana users created in your Cockpit's
42
- * Grafana. By default, the Grafana users returned in the list are ordered in
43
- * ascending order.
34
+ * List Grafana users. List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
44
35
  *
45
36
  * @param request - The request {@link GlobalApiListGrafanaUsersRequest}
46
37
  * @returns A Promise of ListGrafanaUsersResponse
@@ -50,31 +41,24 @@ export declare class GlobalAPI extends ParentAPI {
50
41
  [Symbol.asyncIterator]: () => AsyncGenerator<GrafanaUser[], void, void>;
51
42
  };
52
43
  /**
53
- * Delete a Grafana user. Delete a Grafana user from your Cockpit's Grafana,
54
- * specified by the ID of the Project the Cockpit belongs to, and the ID of
55
- * the Grafana user.
44
+ * Delete a Grafana user. Delete a Grafana user from your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
56
45
  *
57
46
  * @param request - The request {@link GlobalApiDeleteGrafanaUserRequest}
58
47
  */
59
48
  deleteGrafanaUser: (request: Readonly<GlobalApiDeleteGrafanaUserRequest>) => Promise<void>;
60
49
  /**
61
- * Reset a Grafana user password. Reset the password of a Grafana user,
62
- * specified by the ID of the Project the Cockpit belongs to, and the ID of
63
- * the Grafana user. A new password regenerates and only displays once. Make
64
- * sure that you save it.
50
+ * Reset a Grafana user password. Reset the password of a Grafana user, specified by the ID of the Project the Cockpit belongs to, and the ID of the Grafana user.
51
+ A new password regenerates and only displays once. Make sure that you save it.
65
52
  *
66
- * @param request - The request
67
- * {@link GlobalApiResetGrafanaUserPasswordRequest}
53
+ * @param request - The request {@link GlobalApiResetGrafanaUserPasswordRequest}
68
54
  * @returns A Promise of GrafanaUser
69
55
  */
70
56
  resetGrafanaUserPassword: (request: Readonly<GlobalApiResetGrafanaUserPasswordRequest>) => Promise<GrafanaUser>;
71
57
  protected pageOfListGrafanaProductDashboards: (request?: Readonly<GlobalApiListGrafanaProductDashboardsRequest>) => Promise<ListGrafanaProductDashboardsResponse>;
72
58
  /**
73
- * List Scaleway resources dashboards. Retrieve a list of available dashboards
74
- * in Grafana, for all Scaleway resources which are integrated with Cockpit.
59
+ * List Scaleway resources dashboards. Retrieve a list of available dashboards in Grafana, for all Scaleway resources which are integrated with Cockpit.
75
60
  *
76
- * @param request - The request
77
- * {@link GlobalApiListGrafanaProductDashboardsRequest}
61
+ * @param request - The request {@link GlobalApiListGrafanaProductDashboardsRequest}
78
62
  * @returns A Promise of ListGrafanaProductDashboardsResponse
79
63
  */
80
64
  listGrafanaProductDashboards: (request?: Readonly<GlobalApiListGrafanaProductDashboardsRequest>) => Promise<ListGrafanaProductDashboardsResponse> & {
@@ -82,19 +66,16 @@ export declare class GlobalAPI extends ParentAPI {
82
66
  [Symbol.asyncIterator]: () => AsyncGenerator<GrafanaProductDashboard[], void, void>;
83
67
  };
84
68
  /**
85
- * Get Scaleway resource dashboard. Retrieve information about the dashboard
86
- * of a Scaleway resource in Grafana, specified by the ID of the Project the
87
- * Cockpit belongs to, and the name of the dashboard.
69
+ * Get Scaleway resource dashboard. Retrieve information about the dashboard of a Scaleway resource in Grafana, specified by the ID of the Project the Cockpit belongs to, and the name of the dashboard.
88
70
  *
89
- * @param request - The request
90
- * {@link GlobalApiGetGrafanaProductDashboardRequest}
71
+ * @param request - The request {@link GlobalApiGetGrafanaProductDashboardRequest}
91
72
  * @returns A Promise of GrafanaProductDashboard
92
73
  */
93
74
  getGrafanaProductDashboard: (request: Readonly<GlobalApiGetGrafanaProductDashboardRequest>) => Promise<GrafanaProductDashboard>;
94
75
  protected pageOfListPlans: (request?: Readonly<GlobalApiListPlansRequest>) => Promise<ListPlansResponse>;
95
76
  /**
96
77
  * List plan types. Retrieve a list of available pricing plan types.
97
- * Deprecated, retention is now managed at the data source level.
78
+ Deprecated: retention is now managed at the data source level.
98
79
  *
99
80
  * @deprecated
100
81
  * @param request - The request {@link GlobalApiListPlansRequest}
@@ -105,10 +86,8 @@ export declare class GlobalAPI extends ParentAPI {
105
86
  [Symbol.asyncIterator]: () => AsyncGenerator<Plan[], void, void>;
106
87
  };
107
88
  /**
108
- * Apply a pricing plan. Apply a pricing plan on a given Project. You must
109
- * specify the ID of the pricing plan type. Note that you will be billed for
110
- * the plan you apply. Deprecated, retention is now managed at the data source
111
- * level.
89
+ * Apply a pricing plan. Apply a pricing plan on a given Project. You must specify the ID of the pricing plan type. Note that you will be billed for the plan you apply.
90
+ Deprecated: retention is now managed at the data source level.
112
91
  *
113
92
  * @deprecated
114
93
  * @param request - The request {@link GlobalApiSelectPlanRequest}
@@ -116,9 +95,8 @@ export declare class GlobalAPI extends ParentAPI {
116
95
  */
117
96
  selectPlan: (request?: Readonly<GlobalApiSelectPlanRequest>) => Promise<Plan>;
118
97
  /**
119
- * Get current plan. Retrieve a pricing plan for the given Project, specified
120
- * by the ID of the Project. Deprecated, retention is now managed at the data
121
- * source level.
98
+ * Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project.
99
+ Deprecated: retention is now managed at the data source level.
122
100
  *
123
101
  * @deprecated
124
102
  * @param request - The request {@link GlobalApiGetCurrentPlanRequest}
@@ -128,11 +106,8 @@ export declare class GlobalAPI extends ParentAPI {
128
106
  }
129
107
  /**
130
108
  * Cockpit Regional API.
131
- *
132
- * The Cockpit Regional API allows you to create data sources and tokens to
133
- * store and query data types such as metrics, logs, and traces. You can also
134
- * push your data into Cockpit, and send alerts to your contact points when your
135
- * resources may require your attention, using the regional Alert manager.
109
+
110
+ The Cockpit Regional API allows you to create data sources and tokens to store and query data types such as metrics, logs, and traces. You can also push your data into Cockpit, and send alerts to your contact points when your resources may require your attention, using the regional Alert manager.
136
111
  */
137
112
  export declare class RegionalAPI extends ParentAPI {
138
113
  /** Lists the available regions of the API. */
@@ -145,41 +120,33 @@ export declare class RegionalAPI extends ParentAPI {
145
120
  */
146
121
  getConfig: (request?: Readonly<RegionalApiGetConfigRequest>) => Promise<GetConfigResponse>;
147
122
  /**
148
- * Create a data source. You must specify the data source type upon creation.
149
- * Available data source types include:
150
- *
151
- * - Metrics
152
- * - Logs
153
- * - Traces The name of the data source will then be used as reference to name
154
- * the associated Grafana data source.
123
+ * Create a data source. You must specify the data source type upon creation. Available data source types include:
124
+ - metrics
125
+ - logs
126
+ - traces
127
+ The name of the data source will then be used as reference to name the associated Grafana data source.
155
128
  *
156
129
  * @param request - The request {@link RegionalApiCreateDataSourceRequest}
157
130
  * @returns A Promise of DataSource
158
131
  */
159
132
  createDataSource: (request: Readonly<RegionalApiCreateDataSourceRequest>) => Promise<DataSource>;
160
133
  /**
161
- * Get a data source. Retrieve information about a given data source,
162
- * specified by the data source ID. The data source's information such as its
163
- * name, type, URL, origin, and retention period, is returned.
134
+ * Get a data source. Retrieve information about a given data source, specified by the data source ID. The data source's information such as its name, type, URL, origin, and retention period, is returned.
164
135
  *
165
136
  * @param request - The request {@link RegionalApiGetDataSourceRequest}
166
137
  * @returns A Promise of DataSource
167
138
  */
168
139
  getDataSource: (request: Readonly<RegionalApiGetDataSourceRequest>) => Promise<DataSource>;
169
140
  /**
170
- * Delete a data source. Delete a given data source, specified by the data
171
- * source ID. Note that deleting a data source is irreversible, and cannot be
172
- * undone.
141
+ * Delete a data source. Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
173
142
  *
174
143
  * @param request - The request {@link RegionalApiDeleteDataSourceRequest}
175
144
  */
176
145
  deleteDataSource: (request: Readonly<RegionalApiDeleteDataSourceRequest>) => Promise<void>;
177
146
  protected pageOfListDataSources: (request?: Readonly<RegionalApiListDataSourcesRequest>) => Promise<ListDataSourcesResponse>;
178
147
  /**
179
- * List data sources. Retrieve the list of data sources available in the
180
- * specified region. By default, the data sources returned in the list are
181
- * ordered by creation date, in ascending order. You can list data sources by
182
- * Project, type and origin.
148
+ * List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
149
+ You can list data sources by Project, type and origin.
183
150
  *
184
151
  * @param request - The request {@link RegionalApiListDataSourcesRequest}
185
152
  * @returns A Promise of ListDataSourcesResponse
@@ -189,27 +156,22 @@ export declare class RegionalAPI extends ParentAPI {
189
156
  [Symbol.asyncIterator]: () => AsyncGenerator<DataSource[], void, void>;
190
157
  };
191
158
  /**
192
- * Update a data source. Update a given data source name, specified by the
193
- * data source ID.
159
+ * Update a data source. Update a given data source name, specified by the data source ID.
194
160
  *
195
161
  * @param request - The request {@link RegionalApiUpdateDataSourceRequest}
196
162
  * @returns A Promise of DataSource
197
163
  */
198
164
  updateDataSource: (request: Readonly<RegionalApiUpdateDataSourceRequest>) => Promise<DataSource>;
199
165
  /**
200
- * Get data source usage overview. Retrieve the data source usage overview per
201
- * type for the specified Project.
166
+ * Get data source usage overview. Retrieve the data source usage overview per type for the specified Project.
202
167
  *
203
168
  * @param request - The request {@link RegionalApiGetUsageOverviewRequest}
204
169
  * @returns A Promise of UsageOverview
205
170
  */
206
171
  getUsageOverview: (request?: Readonly<RegionalApiGetUsageOverviewRequest>) => Promise<UsageOverview>;
207
172
  /**
208
- * Create a token. Give your token the relevant scopes to ensure it has the
209
- * right permissions to interact with your data sources and the Alert manager.
210
- * Make sure that you create your token in the same regions as the data
211
- * sources you want to use it for. Upon creation, your token's secret key
212
- * display only once. Make sure that you save it.
173
+ * Create a token. Give your token the relevant scopes to ensure it has the right permissions to interact with your data sources and the Alert manager. Make sure that you create your token in the same regions as the data sources you want to use it for.
174
+ Upon creation, your token's secret key display only once. Make sure that you save it.
213
175
  *
214
176
  * @param request - The request {@link RegionalApiCreateTokenRequest}
215
177
  * @returns A Promise of Token
@@ -217,9 +179,8 @@ export declare class RegionalAPI extends ParentAPI {
217
179
  createToken: (request: Readonly<RegionalApiCreateTokenRequest>) => Promise<Token>;
218
180
  protected pageOfListTokens: (request?: Readonly<RegionalApiListTokensRequest>) => Promise<ListTokensResponse>;
219
181
  /**
220
- * List tokens. Retrieve a list of all tokens in the specified region. By
221
- * default, tokens returned in the list are ordered by creation date, in
222
- * ascending order. You can filter tokens by Project ID and token scopes.
182
+ * List tokens. Retrieve a list of all tokens in the specified region. By default, tokens returned in the list are ordered by creation date, in ascending order.
183
+ You can filter tokens by Project ID and token scopes.
223
184
  *
224
185
  * @param request - The request {@link RegionalApiListTokensRequest}
225
186
  * @returns A Promise of ListTokensResponse
@@ -229,56 +190,44 @@ export declare class RegionalAPI extends ParentAPI {
229
190
  [Symbol.asyncIterator]: () => AsyncGenerator<Token[], void, void>;
230
191
  };
231
192
  /**
232
- * Get a token. Retrieve information about a given token, specified by the
233
- * token ID. The token's information such as its scopes, is returned.
193
+ * Get a token. Retrieve information about a given token, specified by the token ID. The token's information such as its scopes, is returned.
234
194
  *
235
195
  * @param request - The request {@link RegionalApiGetTokenRequest}
236
196
  * @returns A Promise of Token
237
197
  */
238
198
  getToken: (request: Readonly<RegionalApiGetTokenRequest>) => Promise<Token>;
239
199
  /**
240
- * Delete a token. Delete a given token, specified by the token ID. Deleting a
241
- * token is irreversible and cannot be undone.
200
+ * Delete a token. Delete a given token, specified by the token ID. Deleting a token is irreversible and cannot be undone.
242
201
  *
243
202
  * @param request - The request {@link RegionalApiDeleteTokenRequest}
244
203
  */
245
204
  deleteToken: (request: Readonly<RegionalApiDeleteTokenRequest>) => Promise<void>;
246
205
  /**
247
- * Get the Alert manager. Retrieve information about the Alert manager which
248
- * is unique per Project and region. By default the Alert manager is disabled.
249
- * The output returned displays a URL to access the Alert manager, and whether
250
- * the Alert manager and managed alerts are enabled.
206
+ * Get the Alert manager. Retrieve information about the Alert manager which is unique per Project and region. By default the Alert manager is disabled.
207
+ The output returned displays a URL to access the Alert manager, and whether the Alert manager and managed alerts are enabled.
251
208
  *
252
209
  * @param request - The request {@link RegionalApiGetAlertManagerRequest}
253
210
  * @returns A Promise of AlertManager
254
211
  */
255
212
  getAlertManager: (request?: Readonly<RegionalApiGetAlertManagerRequest>) => Promise<AlertManager>;
256
213
  /**
257
- * Enable the Alert manager. Enabling the Alert manager allows you to enable
258
- * managed alerts and create contact points in the specified Project and
259
- * region, to be notified when your Scaleway resources may require your
260
- * attention.
214
+ * Enable the Alert manager. Enabling the Alert manager allows you to enable managed alerts and create contact points in the specified Project and region, to be notified when your Scaleway resources may require your attention.
261
215
  *
262
216
  * @param request - The request {@link RegionalApiEnableAlertManagerRequest}
263
217
  * @returns A Promise of AlertManager
264
218
  */
265
219
  enableAlertManager: (request?: Readonly<RegionalApiEnableAlertManagerRequest>) => Promise<AlertManager>;
266
220
  /**
267
- * Disable the Alert manager. Disabling the Alert manager deletes the contact
268
- * points you have created and disables managed alerts in the specified
269
- * Project and region.
221
+ * Disable the Alert manager. Disabling the Alert manager deletes the contact points you have created and disables managed alerts in the specified Project and region.
270
222
  *
271
223
  * @param request - The request {@link RegionalApiDisableAlertManagerRequest}
272
224
  * @returns A Promise of AlertManager
273
225
  */
274
226
  disableAlertManager: (request?: Readonly<RegionalApiDisableAlertManagerRequest>) => Promise<AlertManager>;
275
227
  /**
276
- * Create a contact point. Contact points are email addresses associated with
277
- * the default receiver, that the Alert manager sends alerts to. The source of
278
- * the alerts are data sources within the same Project and region as the Alert
279
- * manager. If you need to receive alerts for other receivers, you can create
280
- * additional contact points and receivers in Grafana. Make sure that you
281
- * select the Scaleway Alert manager.
228
+ * Create a contact point. Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to.
229
+ The source of the alerts are data sources within the same Project and region as the Alert manager.
230
+ If you need to receive alerts for other receivers, you can create additional contact points and receivers in Grafana. Make sure that you select the Scaleway Alert manager.
282
231
  *
283
232
  * @param request - The request {@link RegionalApiCreateContactPointRequest}
284
233
  * @returns A Promise of ContactPoint
@@ -286,9 +235,7 @@ export declare class RegionalAPI extends ParentAPI {
286
235
  createContactPoint: (request?: Readonly<RegionalApiCreateContactPointRequest>) => Promise<ContactPoint>;
287
236
  protected pageOfListContactPoints: (request?: Readonly<RegionalApiListContactPointsRequest>) => Promise<ListContactPointsResponse>;
288
237
  /**
289
- * List contact points. Retrieve a list of contact points for the specified
290
- * Project. The response lists all contact points and receivers created in
291
- * Grafana or via the API.
238
+ * List contact points. Retrieve a list of contact points for the specified Project. The response lists all contact points and receivers created in Grafana or via the API.
292
239
  *
293
240
  * @param request - The request {@link RegionalApiListContactPointsRequest}
294
241
  * @returns A Promise of ListContactPointsResponse
@@ -299,40 +246,46 @@ export declare class RegionalAPI extends ParentAPI {
299
246
  };
300
247
  updateContactPoint: (request?: Readonly<RegionalApiUpdateContactPointRequest>) => Promise<ContactPoint>;
301
248
  /**
302
- * Delete a contact point. Delete a contact point associated with the default
303
- * receiver.
249
+ * Delete a contact point. Delete a contact point associated with the default receiver.
304
250
  *
305
251
  * @param request - The request {@link RegionalApiDeleteContactPointRequest}
306
252
  */
307
253
  deleteContactPoint: (request?: Readonly<RegionalApiDeleteContactPointRequest>) => Promise<void>;
308
254
  /**
309
- * List alerts. List preconfigured and/or custom alerts for the specified
310
- * Project.
255
+ * List alerts. List preconfigured and/or custom alerts for the specified Project.
311
256
  *
312
257
  * @param request - The request {@link RegionalApiListAlertsRequest}
313
258
  * @returns A Promise of ListAlertsResponse
314
259
  */
315
260
  listAlerts: (request?: Readonly<RegionalApiListAlertsRequest>) => Promise<ListAlertsResponse>;
316
261
  /**
317
- * Enable managed alerts. Enable the sending of managed alerts for the
318
- * specified Project. Managed alerts are predefined alerts that apply to
319
- * Scaleway recources integrated with Cockpit by default.
262
+ * Enable managed alerts. Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway recources integrated with Cockpit by default.
320
263
  *
321
264
  * @param request - The request {@link RegionalApiEnableManagedAlertsRequest}
322
265
  * @returns A Promise of AlertManager
323
266
  */
324
267
  enableManagedAlerts: (request?: Readonly<RegionalApiEnableManagedAlertsRequest>) => Promise<AlertManager>;
325
268
  /**
326
- * Disable managed alerts. Disable the sending of managed alerts for the
327
- * specified Project.
269
+ * Disable managed alerts. Disable the sending of managed alerts for the specified Project.
328
270
  *
329
271
  * @param request - The request {@link RegionalApiDisableManagedAlertsRequest}
330
272
  * @returns A Promise of AlertManager
331
273
  */
332
274
  disableManagedAlerts: (request?: Readonly<RegionalApiDisableManagedAlertsRequest>) => Promise<AlertManager>;
333
275
  /**
334
- * Trigger a test alert. Send a test alert to the Alert manager to make sure
335
- * your contact points get notified.
276
+ * Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.. Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
277
+ *
278
+ * @param request - The request {@link RegionalApiEnableAlertRulesRequest}
279
+ */
280
+ enableAlertRules: (request?: Readonly<RegionalApiEnableAlertRulesRequest>) => Promise<void>;
281
+ /**
282
+ * Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.. Disable preconfigured alert rules. Disable alert rules from the list of available preconfigured rules.
283
+ *
284
+ * @param request - The request {@link RegionalApiDisableAlertRulesRequest}
285
+ */
286
+ disableAlertRules: (request?: Readonly<RegionalApiDisableAlertRulesRequest>) => Promise<void>;
287
+ /**
288
+ * Trigger a test alert. Send a test alert to the Alert manager to make sure your contact points get notified.
336
289
  *
337
290
  * @param request - The request {@link RegionalApiTriggerTestAlertRequest}
338
291
  */