@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
@@ -20,8 +20,7 @@ export interface GetConfigResponseRetention {
20
20
  }
21
21
  export interface Alert {
22
22
  /**
23
- * Region to target. If none is passed will use default region from the
24
- * config.
23
+ * Region to target. If none is passed will use default region from the config.
25
24
  */
26
25
  region: ScwRegion;
27
26
  preconfigured: boolean;
@@ -32,7 +31,9 @@ export interface Alert {
32
31
  state?: AlertState;
33
32
  annotations: Record<string, string>;
34
33
  }
35
- /** Contact point. */
34
+ /**
35
+ * Contact point.
36
+ */
36
37
  export interface ContactPoint {
37
38
  /**
38
39
  * Email address to send alerts to.
@@ -40,301 +41,538 @@ export interface ContactPoint {
40
41
  * One-of ('configuration'): at most one of 'email' could be set.
41
42
  */
42
43
  email?: ContactPointEmail;
43
- /** Region. */
44
+ /**
45
+ * Region.
46
+ */
44
47
  region: ScwRegion;
45
- /** Send an email notification when an alert is marked as resolved. */
48
+ /**
49
+ * Send an email notification when an alert is marked as resolved.
50
+ */
46
51
  sendResolvedNotifications: boolean;
47
52
  }
48
- /** Data source. */
53
+ /**
54
+ * Data source.
55
+ */
49
56
  export interface DataSource {
50
- /** ID of the data source. */
57
+ /**
58
+ * ID of the data source.
59
+ */
51
60
  id: string;
52
- /** ID of the Project the data source belongs to. */
61
+ /**
62
+ * ID of the Project the data source belongs to.
63
+ */
53
64
  projectId: string;
54
- /** Data source name. */
65
+ /**
66
+ * Data source name.
67
+ */
55
68
  name: string;
56
- /** Data source URL. */
69
+ /**
70
+ * Data source URL.
71
+ */
57
72
  url: string;
58
- /** Data source type. */
73
+ /**
74
+ * Data source type.
75
+ */
59
76
  type: DataSourceType;
60
- /** Data source origin. */
77
+ /**
78
+ * Data source origin.
79
+ */
61
80
  origin: DataSourceOrigin;
62
- /** Date the data source was created. */
81
+ /**
82
+ * Date the data source was created.
83
+ */
63
84
  createdAt?: Date;
64
- /** Date the data source was last updated. */
85
+ /**
86
+ * Date the data source was last updated.
87
+ */
65
88
  updatedAt?: Date;
66
- /** Indicates whether the data source is synchronized with Grafana. */
89
+ /**
90
+ * Indicates whether the data source is synchronized with Grafana.
91
+ */
67
92
  synchronizedWithGrafana: boolean;
68
- /** BETA - Duration for which the data will be retained in the data source. */
93
+ /**
94
+ * BETA - Duration for which the data will be retained in the data source.
95
+ */
69
96
  retentionDays: number;
70
- /** Region of the data source. */
97
+ /**
98
+ * Region of the data source.
99
+ */
71
100
  region: ScwRegion;
72
101
  }
73
- /** Grafana dashboard. */
102
+ /**
103
+ * Grafana dashboard.
104
+ */
74
105
  export interface GrafanaProductDashboard {
75
- /** Dashboard name. */
106
+ /**
107
+ * Dashboard name.
108
+ */
76
109
  name: string;
77
- /** Dashboard title. */
110
+ /**
111
+ * Dashboard title.
112
+ */
78
113
  title: string;
79
- /** Dashboard URL. */
114
+ /**
115
+ * Dashboard URL.
116
+ */
80
117
  url: string;
81
- /** Dashboard tags. */
118
+ /**
119
+ * Dashboard tags.
120
+ */
82
121
  tags: string[];
83
- /** Dashboard variables. */
122
+ /**
123
+ * Dashboard variables.
124
+ */
84
125
  variables: string[];
85
126
  }
86
- /** Grafana user. */
127
+ /**
128
+ * Grafana user.
129
+ */
87
130
  export interface GrafanaUser {
88
- /** ID of the Grafana user. */
131
+ /**
132
+ * ID of the Grafana user.
133
+ */
89
134
  id: number;
90
- /** Username of the Grafana user. */
135
+ /**
136
+ * Username of the Grafana user.
137
+ */
91
138
  login: string;
92
- /** Role assigned to the Grafana user. */
139
+ /**
140
+ * Role assigned to the Grafana user.
141
+ */
93
142
  role: GrafanaUserRole;
94
- /** Grafana user's password. */
143
+ /**
144
+ * Grafana user's password.
145
+ */
95
146
  password?: string;
96
147
  }
97
- /** Type of pricing plan. */
148
+ /**
149
+ * Type of pricing plan.
150
+ */
98
151
  export interface Plan {
99
- /** Name of a given pricing plan. */
152
+ /**
153
+ * Name of a given pricing plan.
154
+ */
100
155
  name: PlanName;
101
- /** Interval of time during which Scaleway's Cockpit keeps your metrics. */
156
+ /**
157
+ * Interval of time during which Scaleway's Cockpit keeps your metrics.
158
+ */
102
159
  retentionMetricsInterval?: string;
103
- /** Interval of time during which Scaleway's Cockpit keeps your logs. */
160
+ /**
161
+ * Interval of time during which Scaleway's Cockpit keeps your logs.
162
+ */
104
163
  retentionLogsInterval?: string;
105
- /** Interval of time during which Scaleway's Cockpit keeps your traces. */
164
+ /**
165
+ * Interval of time during which Scaleway's Cockpit keeps your traces.
166
+ */
106
167
  retentionTracesInterval?: string;
107
- /** Ingestion price in cents for 1 million samples. */
168
+ /**
169
+ * Ingestion price in cents for 1 million samples.
170
+ */
108
171
  sampleIngestionPrice: number;
109
- /** Ingestion price in cents for 1 GB of logs. */
172
+ /**
173
+ * Ingestion price in cents for 1 GB of logs.
174
+ */
110
175
  logsIngestionPrice: number;
111
- /** Ingestion price in cents for 1 GB of traces. */
176
+ /**
177
+ * Ingestion price in cents for 1 GB of traces.
178
+ */
112
179
  tracesIngestionPrice: number;
113
- /** Retention price in euros per month. */
180
+ /**
181
+ * Retention price in euros per month.
182
+ */
114
183
  monthlyPrice: number;
115
184
  }
116
- /** Token. */
185
+ /**
186
+ * Token.
187
+ */
117
188
  export interface Token {
118
- /** ID of the token. */
189
+ /**
190
+ * ID of the token.
191
+ */
119
192
  id: string;
120
- /** ID of the Project the token belongs to. */
193
+ /**
194
+ * ID of the Project the token belongs to.
195
+ */
121
196
  projectId: string;
122
- /** Name of the token. */
197
+ /**
198
+ * Name of the token.
199
+ */
123
200
  name: string;
124
- /** Token creation date. */
201
+ /**
202
+ * Token creation date.
203
+ */
125
204
  createdAt?: Date;
126
- /** Token last modification date. */
205
+ /**
206
+ * Token last modification date.
207
+ */
127
208
  updatedAt?: Date;
128
- /** Token permission scopes. */
209
+ /**
210
+ * Token permission scopes.
211
+ */
129
212
  scopes: TokenScope[];
130
- /** Token secret key. */
213
+ /**
214
+ * Token secret key.
215
+ */
131
216
  secretKey?: string;
132
- /** Regions where the token is located. */
217
+ /**
218
+ * Regions where the token is located.
219
+ */
133
220
  region: ScwRegion;
134
221
  }
135
- /** Data source usage. */
222
+ /**
223
+ * Data source usage.
224
+ */
136
225
  export interface Usage {
137
- /** ID of the data source. */
226
+ /**
227
+ * ID of the data source.
228
+ */
138
229
  dataSourceId?: string;
139
- /** ID of the Project the data source belongs to. */
230
+ /**
231
+ * ID of the Project the data source belongs to.
232
+ */
140
233
  projectId: string;
141
- /** Origin of the data source. */
234
+ /**
235
+ * Origin of the data source.
236
+ */
142
237
  dataSourceOrigin: DataSourceOrigin;
143
- /** Type of the data source. */
238
+ /**
239
+ * Type of the data source.
240
+ */
144
241
  dataSourceType: DataSourceType;
145
- /** Unit of the data source usage. */
242
+ /**
243
+ * Unit of the data source usage.
244
+ */
146
245
  unit: UsageUnit;
147
- /** Interval for the data source usage. */
246
+ /**
247
+ * Interval for the data source usage.
248
+ */
148
249
  interval?: string;
149
- /** Data source usage for the given interval. */
250
+ /**
251
+ * Data source usage for the given interval.
252
+ */
150
253
  quantityOverInterval: number;
151
- /** Region of the data source usage. */
254
+ /**
255
+ * Region of the data source usage.
256
+ */
152
257
  region: ScwRegion;
153
258
  }
154
- /** Alert manager information. */
259
+ /**
260
+ * Alert manager information.
261
+ */
155
262
  export interface AlertManager {
156
- /** Alert manager URL. */
263
+ /**
264
+ * Alert manager URL.
265
+ */
157
266
  alertManagerUrl?: string;
158
- /** The Alert manager is enabled. */
267
+ /**
268
+ * The Alert manager is enabled.
269
+ */
159
270
  alertManagerEnabled: boolean;
160
- /** Managed alerts are enabled. */
271
+ /**
272
+ * Managed alerts are enabled.
273
+ */
161
274
  managedAlertsEnabled: boolean;
162
- /** Regions where the Alert manager is enabled. */
275
+ /**
276
+ * Regions where the Alert manager is enabled.
277
+ */
163
278
  region: ScwRegion;
164
279
  }
165
- /** Cockpit configuration. */
280
+ /**
281
+ * Cockpit configuration.
282
+ */
166
283
  export interface GetConfigResponse {
167
- /** Custom metrics retention configuration. */
284
+ /**
285
+ * Custom metrics retention configuration.
286
+ */
168
287
  customMetricsRetention?: GetConfigResponseRetention;
169
- /** Custom logs retention configuration. */
288
+ /**
289
+ * Custom logs retention configuration.
290
+ */
170
291
  customLogsRetention?: GetConfigResponseRetention;
171
- /** Custom traces retention configuration. */
292
+ /**
293
+ * Custom traces retention configuration.
294
+ */
172
295
  customTracesRetention?: GetConfigResponseRetention;
173
- /** Scaleway metrics retention configuration. */
296
+ /**
297
+ * Scaleway metrics retention configuration.
298
+ */
174
299
  productMetricsRetention?: GetConfigResponseRetention;
175
- /** Scaleway logs retention configuration. */
300
+ /**
301
+ * Scaleway logs retention configuration.
302
+ */
176
303
  productLogsRetention?: GetConfigResponseRetention;
177
304
  }
178
- /** Create a Grafana user. */
305
+ /**
306
+ * Create a Grafana user.
307
+ */
179
308
  export type GlobalApiCreateGrafanaUserRequest = {
180
- /** ID of the Project in which to create the Grafana user. */
309
+ /**
310
+ * ID of the Project in which to create the Grafana user.
311
+ */
181
312
  projectId?: string;
182
313
  /**
183
- * Username of the Grafana user. Note that the `admin` username is not
184
- * available for creation.
314
+ * Username of the Grafana user. Note that the `admin` username is not available for creation.
185
315
  */
186
316
  login: string;
187
- /** Role assigned to the Grafana user. */
317
+ /**
318
+ * Role assigned to the Grafana user.
319
+ */
188
320
  role?: GrafanaUserRole;
189
321
  };
190
- /** Delete a Grafana user. */
322
+ /**
323
+ * Delete a Grafana user.
324
+ */
191
325
  export type GlobalApiDeleteGrafanaUserRequest = {
192
- /** ID of the Grafana user. */
326
+ /**
327
+ * ID of the Grafana user.
328
+ */
193
329
  grafanaUserId: number;
194
- /** ID of the Project to target. */
330
+ /**
331
+ * ID of the Project to target.
332
+ */
195
333
  projectId?: string;
196
334
  };
197
- /** Retrieve a pricing plan for the given Project. */
335
+ /**
336
+ * Retrieve a pricing plan for the given Project.
337
+ */
198
338
  export type GlobalApiGetCurrentPlanRequest = {
199
- /** ID of the Project. */
339
+ /**
340
+ * ID of the Project.
341
+ */
200
342
  projectId?: string;
201
343
  };
202
- /** Retrieve a specific dashboard. */
344
+ /**
345
+ * Retrieve a specific dashboard.
346
+ */
203
347
  export type GlobalApiGetGrafanaProductDashboardRequest = {
204
- /** Name of the dashboard. */
348
+ /**
349
+ * Name of the dashboard.
350
+ */
205
351
  dashboardName: string;
206
- /** ID of the Project the dashboard belongs to. */
352
+ /**
353
+ * ID of the Project the dashboard belongs to.
354
+ */
207
355
  projectId?: string;
208
356
  };
209
- /** Request a Grafana. */
357
+ /**
358
+ * Request a Grafana.
359
+ */
210
360
  export type GlobalApiGetGrafanaRequest = {
211
- /** ID of the Project. */
361
+ /**
362
+ * ID of the Project.
363
+ */
212
364
  projectId?: string;
213
365
  };
214
- /** Retrieve a list of available product dashboards. */
366
+ /**
367
+ * Retrieve a list of available product dashboards.
368
+ */
215
369
  export type GlobalApiListGrafanaProductDashboardsRequest = {
216
- /** ID of the Project to target. */
370
+ /**
371
+ * ID of the Project to target.
372
+ */
217
373
  projectId?: string;
218
- /** Page number. */
374
+ /**
375
+ * Page number.
376
+ */
219
377
  page?: number;
220
- /** Page size. */
378
+ /**
379
+ * Page size.
380
+ */
221
381
  pageSize?: number;
222
- /** Tags to filter for. */
382
+ /**
383
+ * Tags to filter for.
384
+ */
223
385
  tags?: string[];
224
386
  };
225
- /** List all Grafana users. */
387
+ /**
388
+ * List all Grafana users.
389
+ */
226
390
  export type GlobalApiListGrafanaUsersRequest = {
227
- /** Page number. */
391
+ /**
392
+ * Page number.
393
+ */
228
394
  page?: number;
229
- /** Page size. */
395
+ /**
396
+ * Page size.
397
+ */
230
398
  pageSize?: number;
231
- /** Order of the Grafana users. */
399
+ /**
400
+ * Order of the Grafana users.
401
+ */
232
402
  orderBy?: ListGrafanaUsersRequestOrderBy;
233
- /** ID of the Project to target. */
403
+ /**
404
+ * ID of the Project to target.
405
+ */
234
406
  projectId?: string;
235
407
  };
236
- /** Retrieve a list of available pricing plans. */
408
+ /**
409
+ * Retrieve a list of available pricing plans.
410
+ */
237
411
  export type GlobalApiListPlansRequest = {
238
- /** Page number. */
412
+ /**
413
+ * Page number.
414
+ */
239
415
  page?: number;
240
- /** Page size. */
416
+ /**
417
+ * Page size.
418
+ */
241
419
  pageSize?: number;
242
420
  orderBy?: ListPlansRequestOrderBy;
243
421
  };
244
- /** Reset a Grafana user's password. */
422
+ /**
423
+ * Reset a Grafana user's password.
424
+ */
245
425
  export type GlobalApiResetGrafanaUserPasswordRequest = {
246
- /** ID of the Grafana user. */
426
+ /**
427
+ * ID of the Grafana user.
428
+ */
247
429
  grafanaUserId: number;
248
- /** ID of the Project to target. */
430
+ /**
431
+ * ID of the Project to target.
432
+ */
249
433
  projectId?: string;
250
434
  };
251
- /** Select a specific pricing plan. */
435
+ /**
436
+ * Select a specific pricing plan.
437
+ */
252
438
  export type GlobalApiSelectPlanRequest = {
253
- /** ID of the Project. */
439
+ /**
440
+ * ID of the Project.
441
+ */
254
442
  projectId?: string;
255
- /** Name of the pricing plan. */
443
+ /**
444
+ * Name of the pricing plan.
445
+ */
256
446
  planName?: PlanName;
257
447
  };
258
448
  /**
259
- * Trigger the synchronization of all data sources created in the relevant
260
- * regions.
449
+ * Trigger the synchronization of all data sources created in the relevant regions.
261
450
  */
262
451
  export type GlobalApiSyncGrafanaDataSourcesRequest = {
263
- /** ID of the Project to target. */
452
+ /**
453
+ * ID of the Project to target.
454
+ */
264
455
  projectId?: string;
265
456
  };
266
- /** Grafana user. */
457
+ /**
458
+ * Grafana user.
459
+ */
267
460
  export interface Grafana {
268
- /** URL to access your Cockpit's Grafana. */
461
+ /**
462
+ * URL to access your Cockpit's Grafana.
463
+ */
269
464
  grafanaUrl: string;
270
465
  }
271
- /** Retrieve a list of alerts matching the request. */
466
+ /**
467
+ * Retrieve a list of alerts matching the request.
468
+ */
272
469
  export interface ListAlertsResponse {
273
- /** Total count of alerts matching the request. */
470
+ /**
471
+ * Total count of alerts matching the request.
472
+ */
274
473
  totalCount: number;
275
- /** List of alerts matching the applied filters. */
474
+ /**
475
+ * List of alerts matching the applied filters.
476
+ */
276
477
  alerts: Alert[];
277
478
  }
278
- /** Response returned when listing contact points. */
479
+ /**
480
+ * Response returned when listing contact points.
481
+ */
279
482
  export interface ListContactPointsResponse {
280
- /** Total count of contact points associated with the default receiver. */
483
+ /**
484
+ * Total count of contact points associated with the default receiver.
485
+ */
281
486
  totalCount: number;
282
- /** List of contact points associated with the default receiver. */
487
+ /**
488
+ * List of contact points associated with the default receiver.
489
+ */
283
490
  contactPoints: ContactPoint[];
284
491
  /**
285
- * Indicates whether the Alert manager has other receivers than the default
286
- * one.
492
+ * Indicates whether the Alert manager has other receivers than the default one.
287
493
  */
288
494
  hasAdditionalReceivers: boolean;
289
495
  /**
290
- * Indicates whether there are unmanaged contact points on the default
291
- * receiver.
496
+ * Indicates whether there are unmanaged contact points on the default receiver.
292
497
  */
293
498
  hasAdditionalContactPoints: boolean;
294
499
  }
295
- /** Response returned when listing data sources. */
500
+ /**
501
+ * Response returned when listing data sources.
502
+ */
296
503
  export interface ListDataSourcesResponse {
297
- /** Total count of data sources matching the request. */
504
+ /**
505
+ * Total count of data sources matching the request.
506
+ */
298
507
  totalCount: number;
299
- /** Data sources matching the request within the pagination. */
508
+ /**
509
+ * Data sources matching the request within the pagination.
510
+ */
300
511
  dataSources: DataSource[];
301
512
  }
302
- /** Output returned when listing dashboards. */
513
+ /**
514
+ * Output returned when listing dashboards.
515
+ */
303
516
  export interface ListGrafanaProductDashboardsResponse {
304
- /** Total count of Grafana dashboards. */
517
+ /**
518
+ * Total count of Grafana dashboards.
519
+ */
305
520
  totalCount: number;
306
- /** Grafana dashboards information. */
521
+ /**
522
+ * Grafana dashboards information.
523
+ */
307
524
  dashboards: GrafanaProductDashboard[];
308
525
  }
309
- /** Ouptut returned when listing Grafana users. */
526
+ /**
527
+ * Ouptut returned when listing Grafana users.
528
+ */
310
529
  export interface ListGrafanaUsersResponse {
311
- /** Total count of Grafana users. */
530
+ /**
531
+ * Total count of Grafana users.
532
+ */
312
533
  totalCount: number;
313
- /** Grafana users information. */
534
+ /**
535
+ * Grafana users information.
536
+ */
314
537
  grafanaUsers: GrafanaUser[];
315
538
  }
316
- /** Output returned when listing pricing plans. */
539
+ /**
540
+ * Output returned when listing pricing plans.
541
+ */
317
542
  export interface ListPlansResponse {
318
- /** Total count of available pricing plans. */
543
+ /**
544
+ * Total count of available pricing plans.
545
+ */
319
546
  totalCount: number;
320
- /** Plan types information. */
547
+ /**
548
+ * Plan types information.
549
+ */
321
550
  plans: Plan[];
322
551
  }
323
- /** Response returned when listing tokens. */
552
+ /**
553
+ * Response returned when listing tokens.
554
+ */
324
555
  export interface ListTokensResponse {
325
- /** Total count of tokens matching the request. */
556
+ /**
557
+ * Total count of tokens matching the request.
558
+ */
326
559
  totalCount: number;
327
- /** Tokens matching the request within the pagination. */
560
+ /**
561
+ * Tokens matching the request within the pagination.
562
+ */
328
563
  tokens: Token[];
329
564
  }
330
- /** Create a contact point. */
565
+ /**
566
+ * Create a contact point.
567
+ */
331
568
  export type RegionalApiCreateContactPointRequest = {
332
569
  /**
333
- * Region to target. If none is passed will use default region from the
334
- * config.
570
+ * Region to target. If none is passed will use default region from the config.
335
571
  */
336
572
  region?: ScwRegion;
337
- /** ID of the Project to create the contact point in. */
573
+ /**
574
+ * ID of the Project to create the contact point in.
575
+ */
338
576
  projectId?: string;
339
577
  /**
340
578
  * Email address of the contact point to create.
@@ -342,47 +580,68 @@ export type RegionalApiCreateContactPointRequest = {
342
580
  * One-of ('configuration'): at most one of 'email' could be set.
343
581
  */
344
582
  email?: ContactPointEmail;
345
- /** Send an email notification when an alert is marked as resolved. */
583
+ /**
584
+ * Send an email notification when an alert is marked as resolved.
585
+ */
346
586
  sendResolvedNotifications?: boolean;
347
587
  };
348
- /** Create a data source. */
588
+ /**
589
+ * Create a data source.
590
+ */
349
591
  export type RegionalApiCreateDataSourceRequest = {
350
592
  /**
351
- * Region to target. If none is passed will use default region from the
352
- * config.
593
+ * Region to target. If none is passed will use default region from the config.
353
594
  */
354
595
  region?: ScwRegion;
355
- /** ID of the Project the data source belongs to. */
596
+ /**
597
+ * ID of the Project the data source belongs to.
598
+ */
356
599
  projectId?: string;
357
- /** Data source name. */
600
+ /**
601
+ * Data source name.
602
+ */
358
603
  name: string;
359
- /** Data source type. */
604
+ /**
605
+ * Data source type.
606
+ */
360
607
  type?: DataSourceType;
361
- /** Default values are 30 days for metrics, 7 days for logs and traces. */
608
+ /**
609
+ * Default values are 30 days for metrics, 7 days for logs and traces.
610
+ */
362
611
  retentionDays?: number;
363
612
  };
364
- /** Create a token. */
613
+ /**
614
+ * Create a token.
615
+ */
365
616
  export type RegionalApiCreateTokenRequest = {
366
617
  /**
367
- * Region to target. If none is passed will use default region from the
368
- * config.
618
+ * Region to target. If none is passed will use default region from the config.
369
619
  */
370
620
  region?: ScwRegion;
371
- /** ID of the Project the token belongs to. */
621
+ /**
622
+ * ID of the Project the token belongs to.
623
+ */
372
624
  projectId?: string;
373
- /** Name of the token. */
625
+ /**
626
+ * Name of the token.
627
+ */
374
628
  name: string;
375
- /** Token permission scopes. */
629
+ /**
630
+ * Token permission scopes.
631
+ */
376
632
  tokenScopes?: TokenScope[];
377
633
  };
378
- /** Delete a contact point. */
634
+ /**
635
+ * Delete a contact point.
636
+ */
379
637
  export type RegionalApiDeleteContactPointRequest = {
380
638
  /**
381
- * Region to target. If none is passed will use default region from the
382
- * config.
639
+ * Region to target. If none is passed will use default region from the config.
383
640
  */
384
641
  region?: ScwRegion;
385
- /** ID of the Project containing the contact point to delete. */
642
+ /**
643
+ * ID of the Project containing the contact point to delete.
644
+ */
386
645
  projectId?: string;
387
646
  /**
388
647
  * Email address of the contact point to delete.
@@ -391,219 +650,272 @@ export type RegionalApiDeleteContactPointRequest = {
391
650
  */
392
651
  email?: ContactPointEmail;
393
652
  };
394
- /** Delete a data source. */
653
+ /**
654
+ * Delete a data source.
655
+ */
395
656
  export type RegionalApiDeleteDataSourceRequest = {
396
657
  /**
397
- * Region to target. If none is passed will use default region from the
398
- * config.
658
+ * Region to target. If none is passed will use default region from the config.
399
659
  */
400
660
  region?: ScwRegion;
401
- /** ID of the data source to delete. */
661
+ /**
662
+ * ID of the data source to delete.
663
+ */
402
664
  dataSourceId: string;
403
665
  };
404
- /** Delete a token. */
666
+ /**
667
+ * Delete a token.
668
+ */
405
669
  export type RegionalApiDeleteTokenRequest = {
406
670
  /**
407
- * Region to target. If none is passed will use default region from the
408
- * config.
671
+ * Region to target. If none is passed will use default region from the config.
409
672
  */
410
673
  region?: ScwRegion;
411
- /** ID of the token to delete. */
674
+ /**
675
+ * ID of the token to delete.
676
+ */
412
677
  tokenId: string;
413
678
  };
414
- /** Disable the Alert manager. */
679
+ /**
680
+ * Disable the Alert manager.
681
+ */
415
682
  export type RegionalApiDisableAlertManagerRequest = {
416
683
  /**
417
- * Region to target. If none is passed will use default region from the
418
- * config.
684
+ * Region to target. If none is passed will use default region from the config.
419
685
  */
420
686
  region?: ScwRegion;
421
- /** ID of the Project to disable the Alert manager in. */
687
+ /**
688
+ * ID of the Project to disable the Alert manager in.
689
+ */
422
690
  projectId?: string;
423
691
  };
424
- /** Disable the sending of managed alerts. */
692
+ /**
693
+ * Disable the sending of managed alerts.
694
+ */
425
695
  export type RegionalApiDisableManagedAlertsRequest = {
426
696
  /**
427
- * Region to target. If none is passed will use default region from the
428
- * config.
697
+ * Region to target. If none is passed will use default region from the config.
429
698
  */
430
699
  region?: ScwRegion;
431
- /** ID of the Project. */
700
+ /**
701
+ * ID of the Project.
702
+ */
432
703
  projectId?: string;
433
704
  };
434
- /** Enable the Alert manager. */
705
+ /**
706
+ * Enable the Alert manager.
707
+ */
435
708
  export type RegionalApiEnableAlertManagerRequest = {
436
709
  /**
437
- * Region to target. If none is passed will use default region from the
438
- * config.
710
+ * Region to target. If none is passed will use default region from the config.
439
711
  */
440
712
  region?: ScwRegion;
441
- /** ID of the Project to enable the Alert manager in. */
713
+ /**
714
+ * ID of the Project to enable the Alert manager in.
715
+ */
442
716
  projectId?: string;
443
717
  };
444
- /** Enable the sending of managed alerts. */
718
+ /**
719
+ * Enable the sending of managed alerts.
720
+ */
445
721
  export type RegionalApiEnableManagedAlertsRequest = {
446
722
  /**
447
- * Region to target. If none is passed will use default region from the
448
- * config.
723
+ * Region to target. If none is passed will use default region from the config.
449
724
  */
450
725
  region?: ScwRegion;
451
- /** ID of the Project. */
726
+ /**
727
+ * ID of the Project.
728
+ */
452
729
  projectId?: string;
453
730
  };
454
- /** Get the Alert manager. */
731
+ /**
732
+ * Get the Alert manager.
733
+ */
455
734
  export type RegionalApiGetAlertManagerRequest = {
456
735
  /**
457
- * Region to target. If none is passed will use default region from the
458
- * config.
736
+ * Region to target. If none is passed will use default region from the config.
459
737
  */
460
738
  region?: ScwRegion;
461
- /** Project ID of the requested Alert manager. */
739
+ /**
740
+ * Project ID of the requested Alert manager.
741
+ */
462
742
  projectId?: string;
463
743
  };
464
- /** Get Cockpit configuration. */
744
+ /**
745
+ * Get Cockpit configuration.
746
+ */
465
747
  export type RegionalApiGetConfigRequest = {
466
748
  /**
467
- * Region to target. If none is passed will use default region from the
468
- * config.
749
+ * Region to target. If none is passed will use default region from the config.
469
750
  */
470
751
  region?: ScwRegion;
471
752
  };
472
- /** Retrieve a data source. */
753
+ /**
754
+ * Retrieve a data source.
755
+ */
473
756
  export type RegionalApiGetDataSourceRequest = {
474
757
  /**
475
- * Region to target. If none is passed will use default region from the
476
- * config.
758
+ * Region to target. If none is passed will use default region from the config.
477
759
  */
478
760
  region?: ScwRegion;
479
- /** ID of the relevant data source. */
761
+ /**
762
+ * ID of the relevant data source.
763
+ */
480
764
  dataSourceId: string;
481
765
  };
482
- /** Get a token. */
766
+ /**
767
+ * Get a token.
768
+ */
483
769
  export type RegionalApiGetTokenRequest = {
484
770
  /**
485
- * Region to target. If none is passed will use default region from the
486
- * config.
771
+ * Region to target. If none is passed will use default region from the config.
487
772
  */
488
773
  region?: ScwRegion;
489
- /** Token ID. */
774
+ /**
775
+ * Token ID.
776
+ */
490
777
  tokenId: string;
491
778
  };
492
779
  export type RegionalApiGetUsageOverviewRequest = {
493
780
  /**
494
- * Region to target. If none is passed will use default region from the
495
- * config.
781
+ * Region to target. If none is passed will use default region from the config.
496
782
  */
497
783
  region?: ScwRegion;
498
784
  projectId?: string;
499
785
  interval?: string;
500
786
  };
501
- /** Retrieve a list of alerts. */
787
+ /**
788
+ * Retrieve a list of alerts.
789
+ */
502
790
  export type RegionalApiListAlertsRequest = {
503
791
  /**
504
- * Region to target. If none is passed will use default region from the
505
- * config.
792
+ * Region to target. If none is passed will use default region from the config.
506
793
  */
507
794
  region?: ScwRegion;
508
- /** Project ID to filter for, only alerts from this Project will be returned. */
795
+ /**
796
+ * Project ID to filter for, only alerts from this Project will be returned.
797
+ */
509
798
  projectId?: string;
510
799
  /**
511
- * True returns only enabled alerts. False returns only disabled alerts. If
512
- * omitted, no alert filtering is applied. Other filters may still apply.
800
+ * True returns only enabled alerts. False returns only disabled alerts. If omitted, no alert filtering is applied. Other filters may still apply.
513
801
  */
514
802
  isEnabled?: boolean;
515
803
  /**
516
- * True returns only preconfigured alerts. False returns only custom alerts.
517
- * If omitted, no filtering is applied on alert types. Other filters may still
518
- * apply.
804
+ * True returns only preconfigured alerts. False returns only custom alerts. If omitted, no filtering is applied on alert types. Other filters may still apply.
519
805
  */
520
806
  isPreconfigured?: boolean;
521
807
  /**
522
- * Valid values to filter on are `disabled`, `enabled`, `pending` and
523
- * `firing`. If omitted, no filtering is applied on alert states. Other
524
- * filters may still apply.
808
+ * Valid values to filter on are `disabled`, `enabled`, `pending` and `firing`. If omitted, no filtering is applied on alert states. Other filters may still apply.
525
809
  */
526
810
  state?: AlertState;
527
811
  };
528
- /** List contact points. */
812
+ /**
813
+ * List contact points.
814
+ */
529
815
  export type RegionalApiListContactPointsRequest = {
530
816
  /**
531
- * Region to target. If none is passed will use default region from the
532
- * config.
817
+ * Region to target. If none is passed will use default region from the config.
533
818
  */
534
819
  region?: ScwRegion;
535
- /** Page number to return, from the paginated results. */
820
+ /**
821
+ * Page number to return, from the paginated results.
822
+ */
536
823
  page?: number;
537
- /** Total count of contact points to return per page. */
824
+ /**
825
+ * Total count of contact points to return per page.
826
+ */
538
827
  pageSize?: number;
539
- /** ID of the Project containing the contact points to list. */
828
+ /**
829
+ * ID of the Project containing the contact points to list.
830
+ */
540
831
  projectId?: string;
541
832
  };
542
- /** List data sources. */
833
+ /**
834
+ * List data sources.
835
+ */
543
836
  export type RegionalApiListDataSourcesRequest = {
544
837
  /**
545
- * Region to target. If none is passed will use default region from the
546
- * config.
838
+ * Region to target. If none is passed will use default region from the config.
547
839
  */
548
840
  region?: ScwRegion;
549
- /** Page number to return, from the paginated results. */
841
+ /**
842
+ * Page number to return, from the paginated results.
843
+ */
550
844
  page?: number;
551
- /** Number of data sources to return per page. */
845
+ /**
846
+ * Number of data sources to return per page.
847
+ */
552
848
  pageSize?: number;
553
- /** Sort order for data sources in the response. */
849
+ /**
850
+ * Sort order for data sources in the response.
851
+ */
554
852
  orderBy?: ListDataSourcesRequestOrderBy;
555
853
  /**
556
- * Project ID to filter for, only data sources from this Project will be
557
- * returned.
854
+ * Project ID to filter for, only data sources from this Project will be returned.
558
855
  */
559
856
  projectId?: string;
560
857
  /**
561
- * Origin to filter for, only data sources with matching origin will be
562
- * returned.
858
+ * Origin to filter for, only data sources with matching origin will be returned.
563
859
  */
564
860
  origin?: DataSourceOrigin;
565
861
  /**
566
- * Types to filter for, only data sources with matching types will be
567
- * returned.
862
+ * Types to filter for, only data sources with matching types will be returned.
568
863
  */
569
864
  types?: DataSourceType[];
570
865
  };
571
- /** List tokens. */
866
+ /**
867
+ * List tokens.
868
+ */
572
869
  export type RegionalApiListTokensRequest = {
573
870
  /**
574
- * Region to target. If none is passed will use default region from the
575
- * config.
871
+ * Region to target. If none is passed will use default region from the config.
576
872
  */
577
873
  region?: ScwRegion;
578
- /** Page number to return, from the paginated results. */
874
+ /**
875
+ * Page number to return, from the paginated results.
876
+ */
579
877
  page?: number;
580
- /** Number of tokens to return per page. */
878
+ /**
879
+ * Number of tokens to return per page.
880
+ */
581
881
  pageSize?: number;
582
- /** Order in which to return results. */
882
+ /**
883
+ * Order in which to return results.
884
+ */
583
885
  orderBy?: ListTokensRequestOrderBy;
584
- /** ID of the Project the tokens belong to. */
886
+ /**
887
+ * ID of the Project the tokens belong to.
888
+ */
585
889
  projectId?: string;
586
- /** Token scopes to filter for. */
890
+ /**
891
+ * Token scopes to filter for.
892
+ */
587
893
  tokenScopes?: TokenScope[];
588
894
  };
589
- /** Request to trigger a test alert. */
895
+ /**
896
+ * Request to trigger a test alert.
897
+ */
590
898
  export type RegionalApiTriggerTestAlertRequest = {
591
899
  /**
592
- * Region to target. If none is passed will use default region from the
593
- * config.
900
+ * Region to target. If none is passed will use default region from the config.
594
901
  */
595
902
  region?: ScwRegion;
596
- /** ID of the Project. */
903
+ /**
904
+ * ID of the Project.
905
+ */
597
906
  projectId?: string;
598
907
  };
599
- /** Update a contact point. */
908
+ /**
909
+ * Update a contact point.
910
+ */
600
911
  export type RegionalApiUpdateContactPointRequest = {
601
912
  /**
602
- * Region to target. If none is passed will use default region from the
603
- * config.
913
+ * Region to target. If none is passed will use default region from the config.
604
914
  */
605
915
  region?: ScwRegion;
606
- /** ID of the Project containing the contact point to update. */
916
+ /**
917
+ * ID of the Project containing the contact point to update.
918
+ */
607
919
  projectId?: string;
608
920
  /**
609
921
  * Email address of the contact point to update.
@@ -611,21 +923,30 @@ export type RegionalApiUpdateContactPointRequest = {
611
923
  * One-of ('configuration'): at most one of 'email' could be set.
612
924
  */
613
925
  email?: ContactPointEmail;
614
- /** Enable or disable notifications when alert is resolved. */
926
+ /**
927
+ * Enable or disable notifications when alert is resolved.
928
+ */
615
929
  sendResolvedNotifications?: boolean;
616
930
  };
617
- /** Update a data source name. */
931
+ /**
932
+ * Update a data source name.
933
+ */
618
934
  export type RegionalApiUpdateDataSourceRequest = {
619
935
  /**
620
- * Region to target. If none is passed will use default region from the
621
- * config.
936
+ * Region to target. If none is passed will use default region from the config.
622
937
  */
623
938
  region?: ScwRegion;
624
- /** ID of the data source to update. */
939
+ /**
940
+ * ID of the data source to update.
941
+ */
625
942
  dataSourceId: string;
626
- /** Updated name of the data source. */
943
+ /**
944
+ * Updated name of the data source.
945
+ */
627
946
  name?: string;
628
- /** BETA - Duration for which the data will be retained in the data source. */
947
+ /**
948
+ * BETA - Duration for which the data will be retained in the data source.
949
+ */
629
950
  retentionDays?: number;
630
951
  };
631
952
  export interface UsageOverview {