@scaleway/sdk-cockpit 1.7.0 → 2.1.1
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.
- package/README.md +96 -0
- package/dist/v1/api.gen.d.ts +45 -10
- package/dist/v1/api.gen.js +174 -183
- package/dist/v1/index.gen.d.ts +1 -1
- package/dist/v1/index.gen.js +4 -1
- package/dist/v1/marshalling.gen.d.ts +4 -1
- package/dist/v1/marshalling.gen.js +38 -16
- package/dist/v1/types.gen.d.ts +63 -1
- package/dist/v1/validation-rules.gen.d.ts +10 -0
- package/dist/v1/validation-rules.gen.js +11 -0
- package/package.json +6 -9
- package/dist/index.gen.cjs +0 -4
- package/dist/v1/api.gen.cjs +0 -667
- package/dist/v1/index.gen.cjs +0 -43
- package/dist/v1/marshalling.gen.cjs +0 -468
- package/dist/v1/validation-rules.gen.cjs +0 -67
package/dist/v1/api.gen.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { API, toApiLocality, validatePathParam, urlParams, enrichForPagination } from "@scaleway/sdk-client";
|
|
2
|
-
import { unmarshalGetConfigResponse, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, marshalRegionalApiUpdateDataSourceRequest, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, unmarshalAlertManager, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiDisableAlertManagerRequest, unmarshalGetRulesCountResponse, marshalRegionalApiCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiDeleteContactPointRequest, unmarshalListAlertsResponse, marshalRegionalApiEnableAlertRulesRequest, unmarshalEnableAlertRulesResponse, marshalRegionalApiDisableAlertRulesRequest, unmarshalDisableAlertRulesResponse, marshalRegionalApiTriggerTestAlertRequest, unmarshalGrafana, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalGlobalApiCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalGlobalApiResetGrafanaUserPasswordRequest, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard, unmarshalListPlansResponse, marshalGlobalApiSelectPlanRequest, unmarshalPlan } from "./marshalling.gen.js";
|
|
2
|
+
import { unmarshalGetConfigResponse, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, marshalRegionalApiUpdateDataSourceRequest, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, unmarshalListProductsResponse, unmarshalAlertManager, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiDisableAlertManagerRequest, unmarshalGetRulesCountResponse, marshalRegionalApiCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiDeleteContactPointRequest, unmarshalListAlertsResponse, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiEnableAlertRulesRequest, unmarshalEnableAlertRulesResponse, marshalRegionalApiDisableAlertRulesRequest, unmarshalDisableAlertRulesResponse, marshalRegionalApiTriggerTestAlertRequest, unmarshalGrafana, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalGlobalApiCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalGlobalApiResetGrafanaUserPasswordRequest, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard, unmarshalListPlansResponse, marshalGlobalApiSelectPlanRequest, unmarshalPlan } from "./marshalling.gen.js";
|
|
3
3
|
const jsonContentHeaders = {
|
|
4
4
|
"Content-Type": "application/json; charset=utf-8"
|
|
5
5
|
};
|
|
@@ -15,10 +15,9 @@ class GlobalAPI extends API {
|
|
|
15
15
|
{
|
|
16
16
|
method: "GET",
|
|
17
17
|
path: `/cockpit/v1/grafana`,
|
|
18
|
-
urlParams: urlParams(
|
|
19
|
-
"project_id",
|
|
20
|
-
|
|
21
|
-
])
|
|
18
|
+
urlParams: urlParams(
|
|
19
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
20
|
+
)
|
|
22
21
|
},
|
|
23
22
|
unmarshalGrafana
|
|
24
23
|
);
|
|
@@ -27,31 +26,29 @@ class GlobalAPI extends API {
|
|
|
27
26
|
*
|
|
28
27
|
* @param request - The request {@link GlobalApiSyncGrafanaDataSourcesRequest}
|
|
29
28
|
*/
|
|
30
|
-
syncGrafanaDataSources = (request = {}) => this.client.fetch(
|
|
31
|
-
|
|
32
|
-
|
|
33
|
-
request,
|
|
34
|
-
|
|
35
|
-
|
|
36
|
-
|
|
37
|
-
|
|
38
|
-
|
|
39
|
-
|
|
40
|
-
});
|
|
29
|
+
syncGrafanaDataSources = (request = {}) => this.client.fetch(
|
|
30
|
+
{
|
|
31
|
+
body: JSON.stringify(
|
|
32
|
+
marshalGlobalApiSyncGrafanaDataSourcesRequest(request, this.client.settings)
|
|
33
|
+
),
|
|
34
|
+
headers: jsonContentHeaders,
|
|
35
|
+
method: "POST",
|
|
36
|
+
path: `/cockpit/v1/grafana/sync-data-sources`
|
|
37
|
+
}
|
|
38
|
+
);
|
|
41
39
|
/**
|
|
42
|
-
*
|
|
40
|
+
* (Deprecated) EOL 2026-01-20. Create a Grafana user
|
|
41
|
+
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.
|
|
43
42
|
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.
|
|
44
43
|
*
|
|
44
|
+
* @deprecated
|
|
45
45
|
* @param request - The request {@link GlobalApiCreateGrafanaUserRequest}
|
|
46
46
|
* @returns A Promise of GrafanaUser
|
|
47
47
|
*/
|
|
48
48
|
createGrafanaUser = (request) => this.client.fetch(
|
|
49
49
|
{
|
|
50
50
|
body: JSON.stringify(
|
|
51
|
-
marshalGlobalApiCreateGrafanaUserRequest(
|
|
52
|
-
request,
|
|
53
|
-
this.client.settings
|
|
54
|
-
)
|
|
51
|
+
marshalGlobalApiCreateGrafanaUserRequest(request, this.client.settings)
|
|
55
52
|
),
|
|
56
53
|
headers: jsonContentHeaders,
|
|
57
54
|
method: "POST",
|
|
@@ -66,52 +63,50 @@ class GlobalAPI extends API {
|
|
|
66
63
|
urlParams: urlParams(
|
|
67
64
|
["order_by", request.orderBy],
|
|
68
65
|
["page", request.page],
|
|
69
|
-
[
|
|
70
|
-
|
|
71
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
72
|
-
],
|
|
73
|
-
[
|
|
74
|
-
"project_id",
|
|
75
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
76
|
-
]
|
|
66
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
67
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
77
68
|
)
|
|
78
69
|
},
|
|
79
70
|
unmarshalListGrafanaUsersResponse
|
|
80
71
|
);
|
|
81
72
|
/**
|
|
82
|
-
|
|
83
|
-
|
|
84
|
-
|
|
85
|
-
|
|
86
|
-
|
|
73
|
+
* (Deprecated) EOL 2026-01-20. List Grafana users
|
|
74
|
+
List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
|
|
75
|
+
*
|
|
76
|
+
* @deprecated
|
|
77
|
+
* @param request - The request {@link GlobalApiListGrafanaUsersRequest}
|
|
78
|
+
* @returns A Promise of ListGrafanaUsersResponse
|
|
79
|
+
*/
|
|
87
80
|
listGrafanaUsers = (request = {}) => enrichForPagination("grafanaUsers", this.pageOfListGrafanaUsers, request);
|
|
88
81
|
/**
|
|
89
|
-
|
|
90
|
-
|
|
91
|
-
|
|
92
|
-
|
|
93
|
-
|
|
94
|
-
|
|
95
|
-
|
|
96
|
-
|
|
97
|
-
"
|
|
98
|
-
|
|
99
|
-
|
|
100
|
-
|
|
82
|
+
* (Deprecated) EOL 2026-01-20. Delete a Grafana user
|
|
83
|
+
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.
|
|
84
|
+
*
|
|
85
|
+
* @deprecated
|
|
86
|
+
* @param request - The request {@link GlobalApiDeleteGrafanaUserRequest}
|
|
87
|
+
*/
|
|
88
|
+
deleteGrafanaUser = (request) => this.client.fetch(
|
|
89
|
+
{
|
|
90
|
+
method: "DELETE",
|
|
91
|
+
path: `/cockpit/v1/grafana/users/${validatePathParam("grafanaUserId", request.grafanaUserId)}`,
|
|
92
|
+
urlParams: urlParams(
|
|
93
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
94
|
+
)
|
|
95
|
+
}
|
|
96
|
+
);
|
|
101
97
|
/**
|
|
102
|
-
*
|
|
98
|
+
* (Deprecated) EOL 2026-01-20. Reset a Grafana user password
|
|
99
|
+
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.
|
|
103
100
|
A new password regenerates and only displays once. Make sure that you save it.
|
|
104
101
|
*
|
|
102
|
+
* @deprecated
|
|
105
103
|
* @param request - The request {@link GlobalApiResetGrafanaUserPasswordRequest}
|
|
106
104
|
* @returns A Promise of GrafanaUser
|
|
107
105
|
*/
|
|
108
106
|
resetGrafanaUserPassword = (request) => this.client.fetch(
|
|
109
107
|
{
|
|
110
108
|
body: JSON.stringify(
|
|
111
|
-
marshalGlobalApiResetGrafanaUserPasswordRequest(
|
|
112
|
-
request,
|
|
113
|
-
this.client.settings
|
|
114
|
-
)
|
|
109
|
+
marshalGlobalApiResetGrafanaUserPasswordRequest(request, this.client.settings)
|
|
115
110
|
),
|
|
116
111
|
headers: jsonContentHeaders,
|
|
117
112
|
method: "POST",
|
|
@@ -125,14 +120,8 @@ class GlobalAPI extends API {
|
|
|
125
120
|
path: `/cockpit/v1/grafana/product-dashboards`,
|
|
126
121
|
urlParams: urlParams(
|
|
127
122
|
["page", request.page],
|
|
128
|
-
[
|
|
129
|
-
|
|
130
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
131
|
-
],
|
|
132
|
-
[
|
|
133
|
-
"project_id",
|
|
134
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
135
|
-
],
|
|
123
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
124
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId],
|
|
136
125
|
["tags", request.tags]
|
|
137
126
|
)
|
|
138
127
|
},
|
|
@@ -144,11 +133,7 @@ class GlobalAPI extends API {
|
|
|
144
133
|
* @param request - The request {@link GlobalApiListGrafanaProductDashboardsRequest}
|
|
145
134
|
* @returns A Promise of ListGrafanaProductDashboardsResponse
|
|
146
135
|
*/
|
|
147
|
-
listGrafanaProductDashboards = (request = {}) => enrichForPagination(
|
|
148
|
-
"dashboards",
|
|
149
|
-
this.pageOfListGrafanaProductDashboards,
|
|
150
|
-
request
|
|
151
|
-
);
|
|
136
|
+
listGrafanaProductDashboards = (request = {}) => enrichForPagination("dashboards", this.pageOfListGrafanaProductDashboards, request);
|
|
152
137
|
/**
|
|
153
138
|
* 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.
|
|
154
139
|
*
|
|
@@ -159,10 +144,9 @@ class GlobalAPI extends API {
|
|
|
159
144
|
{
|
|
160
145
|
method: "GET",
|
|
161
146
|
path: `/cockpit/v1/grafana/product-dashboards/${validatePathParam("dashboardName", request.dashboardName)}`,
|
|
162
|
-
urlParams: urlParams(
|
|
163
|
-
"project_id",
|
|
164
|
-
|
|
165
|
-
])
|
|
147
|
+
urlParams: urlParams(
|
|
148
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
149
|
+
)
|
|
166
150
|
},
|
|
167
151
|
unmarshalGrafanaProductDashboard
|
|
168
152
|
);
|
|
@@ -173,17 +157,14 @@ class GlobalAPI extends API {
|
|
|
173
157
|
urlParams: urlParams(
|
|
174
158
|
["order_by", request.orderBy],
|
|
175
159
|
["page", request.page],
|
|
176
|
-
[
|
|
177
|
-
"page_size",
|
|
178
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
179
|
-
]
|
|
160
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
180
161
|
)
|
|
181
162
|
},
|
|
182
163
|
unmarshalListPlansResponse
|
|
183
164
|
);
|
|
184
165
|
/**
|
|
185
166
|
* List plan types. Retrieve a list of available pricing plan types.
|
|
186
|
-
Deprecated
|
|
167
|
+
Deprecated due to retention now being managed at the data source level.
|
|
187
168
|
*
|
|
188
169
|
* @deprecated
|
|
189
170
|
* @param request - The request {@link GlobalApiListPlansRequest}
|
|
@@ -192,7 +173,7 @@ class GlobalAPI extends API {
|
|
|
192
173
|
listPlans = (request = {}) => enrichForPagination("plans", this.pageOfListPlans, request);
|
|
193
174
|
/**
|
|
194
175
|
* 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.
|
|
195
|
-
Deprecated
|
|
176
|
+
Deprecated due to retention now being managed at the data source level.
|
|
196
177
|
*
|
|
197
178
|
* @deprecated
|
|
198
179
|
* @param request - The request {@link GlobalApiSelectPlanRequest}
|
|
@@ -211,7 +192,7 @@ class GlobalAPI extends API {
|
|
|
211
192
|
);
|
|
212
193
|
/**
|
|
213
194
|
* Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project.
|
|
214
|
-
Deprecated
|
|
195
|
+
Deprecated due to retention now being managed at the data source level.
|
|
215
196
|
*
|
|
216
197
|
* @deprecated
|
|
217
198
|
* @param request - The request {@link GlobalApiGetCurrentPlanRequest}
|
|
@@ -221,10 +202,9 @@ class GlobalAPI extends API {
|
|
|
221
202
|
{
|
|
222
203
|
method: "GET",
|
|
223
204
|
path: `/cockpit/v1/current-plan`,
|
|
224
|
-
urlParams: urlParams(
|
|
225
|
-
"project_id",
|
|
226
|
-
|
|
227
|
-
])
|
|
205
|
+
urlParams: urlParams(
|
|
206
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
207
|
+
)
|
|
228
208
|
},
|
|
229
209
|
unmarshalPlan
|
|
230
210
|
);
|
|
@@ -235,7 +215,11 @@ class RegionalAPI extends API {
|
|
|
235
215
|
* type ∈ {'zone','region','global','unspecified'}
|
|
236
216
|
*/
|
|
237
217
|
static LOCALITY = toApiLocality({
|
|
238
|
-
regions: [
|
|
218
|
+
regions: [
|
|
219
|
+
"fr-par",
|
|
220
|
+
"nl-ams",
|
|
221
|
+
"pl-waw"
|
|
222
|
+
]
|
|
239
223
|
});
|
|
240
224
|
/**
|
|
241
225
|
* Get the Cockpit configuration.
|
|
@@ -260,10 +244,7 @@ class RegionalAPI extends API {
|
|
|
260
244
|
createDataSource = (request) => this.client.fetch(
|
|
261
245
|
{
|
|
262
246
|
body: JSON.stringify(
|
|
263
|
-
marshalRegionalApiCreateDataSourceRequest(
|
|
264
|
-
request,
|
|
265
|
-
this.client.settings
|
|
266
|
-
)
|
|
247
|
+
marshalRegionalApiCreateDataSourceRequest(request, this.client.settings)
|
|
267
248
|
),
|
|
268
249
|
headers: jsonContentHeaders,
|
|
269
250
|
method: "POST",
|
|
@@ -289,10 +270,12 @@ class RegionalAPI extends API {
|
|
|
289
270
|
*
|
|
290
271
|
* @param request - The request {@link RegionalApiDeleteDataSourceRequest}
|
|
291
272
|
*/
|
|
292
|
-
deleteDataSource = (request) => this.client.fetch(
|
|
293
|
-
|
|
294
|
-
|
|
295
|
-
|
|
273
|
+
deleteDataSource = (request) => this.client.fetch(
|
|
274
|
+
{
|
|
275
|
+
method: "DELETE",
|
|
276
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/data-sources/${validatePathParam("dataSourceId", request.dataSourceId)}`
|
|
277
|
+
}
|
|
278
|
+
);
|
|
296
279
|
pageOfListDataSources = (request = {}) => this.client.fetch(
|
|
297
280
|
{
|
|
298
281
|
method: "GET",
|
|
@@ -301,14 +284,8 @@ class RegionalAPI extends API {
|
|
|
301
284
|
["order_by", request.orderBy],
|
|
302
285
|
["origin", request.origin],
|
|
303
286
|
["page", request.page],
|
|
304
|
-
[
|
|
305
|
-
|
|
306
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
307
|
-
],
|
|
308
|
-
[
|
|
309
|
-
"project_id",
|
|
310
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
311
|
-
],
|
|
287
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
288
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId],
|
|
312
289
|
["types", request.types]
|
|
313
290
|
)
|
|
314
291
|
},
|
|
@@ -330,10 +307,7 @@ class RegionalAPI extends API {
|
|
|
330
307
|
updateDataSource = (request) => this.client.fetch(
|
|
331
308
|
{
|
|
332
309
|
body: JSON.stringify(
|
|
333
|
-
marshalRegionalApiUpdateDataSourceRequest(
|
|
334
|
-
request,
|
|
335
|
-
this.client.settings
|
|
336
|
-
)
|
|
310
|
+
marshalRegionalApiUpdateDataSourceRequest(request, this.client.settings)
|
|
337
311
|
),
|
|
338
312
|
headers: jsonContentHeaders,
|
|
339
313
|
method: "PATCH",
|
|
@@ -353,10 +327,7 @@ class RegionalAPI extends API {
|
|
|
353
327
|
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/usage-overview`,
|
|
354
328
|
urlParams: urlParams(
|
|
355
329
|
["interval", request.interval],
|
|
356
|
-
[
|
|
357
|
-
"project_id",
|
|
358
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
359
|
-
]
|
|
330
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
360
331
|
)
|
|
361
332
|
},
|
|
362
333
|
unmarshalUsageOverview
|
|
@@ -386,14 +357,8 @@ class RegionalAPI extends API {
|
|
|
386
357
|
urlParams: urlParams(
|
|
387
358
|
["order_by", request.orderBy],
|
|
388
359
|
["page", request.page],
|
|
389
|
-
[
|
|
390
|
-
|
|
391
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
392
|
-
],
|
|
393
|
-
[
|
|
394
|
-
"project_id",
|
|
395
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
396
|
-
],
|
|
360
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
361
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId],
|
|
397
362
|
["token_scopes", request.tokenScopes]
|
|
398
363
|
)
|
|
399
364
|
},
|
|
@@ -425,10 +390,31 @@ class RegionalAPI extends API {
|
|
|
425
390
|
*
|
|
426
391
|
* @param request - The request {@link RegionalApiDeleteTokenRequest}
|
|
427
392
|
*/
|
|
428
|
-
deleteToken = (request) => this.client.fetch(
|
|
429
|
-
|
|
430
|
-
|
|
431
|
-
|
|
393
|
+
deleteToken = (request) => this.client.fetch(
|
|
394
|
+
{
|
|
395
|
+
method: "DELETE",
|
|
396
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/tokens/${validatePathParam("tokenId", request.tokenId)}`
|
|
397
|
+
}
|
|
398
|
+
);
|
|
399
|
+
pageOfListProducts = (request = {}) => this.client.fetch(
|
|
400
|
+
{
|
|
401
|
+
method: "GET",
|
|
402
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/products`,
|
|
403
|
+
urlParams: urlParams(
|
|
404
|
+
["order_by", request.orderBy],
|
|
405
|
+
["page", request.page],
|
|
406
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize]
|
|
407
|
+
)
|
|
408
|
+
},
|
|
409
|
+
unmarshalListProductsResponse
|
|
410
|
+
);
|
|
411
|
+
/**
|
|
412
|
+
* List all Scaleway products that send metrics and/or logs to Cockpit.. List all Scaleway products that send metrics and/or logs to Cockpit.
|
|
413
|
+
*
|
|
414
|
+
* @param request - The request {@link RegionalApiListProductsRequest}
|
|
415
|
+
* @returns A Promise of ListProductsResponse
|
|
416
|
+
*/
|
|
417
|
+
listProducts = (request = {}) => enrichForPagination("productsList", this.pageOfListProducts, request);
|
|
432
418
|
/**
|
|
433
419
|
* Get the Alert manager. Retrieve information about the Alert manager which is unique per Project and region. By default the Alert manager is disabled.
|
|
434
420
|
The output returned displays a URL to access the Alert manager, and whether the Alert manager and managed alerts are enabled.
|
|
@@ -440,10 +426,9 @@ class RegionalAPI extends API {
|
|
|
440
426
|
{
|
|
441
427
|
method: "GET",
|
|
442
428
|
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager`,
|
|
443
|
-
urlParams: urlParams(
|
|
444
|
-
"project_id",
|
|
445
|
-
|
|
446
|
-
])
|
|
429
|
+
urlParams: urlParams(
|
|
430
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
431
|
+
)
|
|
447
432
|
},
|
|
448
433
|
unmarshalAlertManager
|
|
449
434
|
);
|
|
@@ -456,10 +441,7 @@ class RegionalAPI extends API {
|
|
|
456
441
|
enableAlertManager = (request = {}) => this.client.fetch(
|
|
457
442
|
{
|
|
458
443
|
body: JSON.stringify(
|
|
459
|
-
marshalRegionalApiEnableAlertManagerRequest(
|
|
460
|
-
request,
|
|
461
|
-
this.client.settings
|
|
462
|
-
)
|
|
444
|
+
marshalRegionalApiEnableAlertManagerRequest(request, this.client.settings)
|
|
463
445
|
),
|
|
464
446
|
headers: jsonContentHeaders,
|
|
465
447
|
method: "POST",
|
|
@@ -476,10 +458,7 @@ class RegionalAPI extends API {
|
|
|
476
458
|
disableAlertManager = (request = {}) => this.client.fetch(
|
|
477
459
|
{
|
|
478
460
|
body: JSON.stringify(
|
|
479
|
-
marshalRegionalApiDisableAlertManagerRequest(
|
|
480
|
-
request,
|
|
481
|
-
this.client.settings
|
|
482
|
-
)
|
|
461
|
+
marshalRegionalApiDisableAlertManagerRequest(request, this.client.settings)
|
|
483
462
|
),
|
|
484
463
|
headers: jsonContentHeaders,
|
|
485
464
|
method: "POST",
|
|
@@ -488,7 +467,7 @@ class RegionalAPI extends API {
|
|
|
488
467
|
unmarshalAlertManager
|
|
489
468
|
);
|
|
490
469
|
/**
|
|
491
|
-
* Get the number of enabled rules
|
|
470
|
+
* Get the number of enabled rules. Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
|
|
492
471
|
*
|
|
493
472
|
* @param request - The request {@link RegionalApiGetRulesCountRequest}
|
|
494
473
|
* @returns A Promise of GetRulesCountResponse
|
|
@@ -497,10 +476,9 @@ class RegionalAPI extends API {
|
|
|
497
476
|
{
|
|
498
477
|
method: "GET",
|
|
499
478
|
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/rules/count`,
|
|
500
|
-
urlParams: urlParams(
|
|
501
|
-
"project_id",
|
|
502
|
-
|
|
503
|
-
])
|
|
479
|
+
urlParams: urlParams(
|
|
480
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
481
|
+
)
|
|
504
482
|
},
|
|
505
483
|
unmarshalGetRulesCountResponse
|
|
506
484
|
);
|
|
@@ -515,10 +493,7 @@ class RegionalAPI extends API {
|
|
|
515
493
|
createContactPoint = (request = {}) => this.client.fetch(
|
|
516
494
|
{
|
|
517
495
|
body: JSON.stringify(
|
|
518
|
-
marshalRegionalApiCreateContactPointRequest(
|
|
519
|
-
request,
|
|
520
|
-
this.client.settings
|
|
521
|
-
)
|
|
496
|
+
marshalRegionalApiCreateContactPointRequest(request, this.client.settings)
|
|
522
497
|
),
|
|
523
498
|
headers: jsonContentHeaders,
|
|
524
499
|
method: "POST",
|
|
@@ -532,14 +507,8 @@ class RegionalAPI extends API {
|
|
|
532
507
|
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/contact-points`,
|
|
533
508
|
urlParams: urlParams(
|
|
534
509
|
["page", request.page],
|
|
535
|
-
[
|
|
536
|
-
|
|
537
|
-
request.pageSize ?? this.client.settings.defaultPageSize
|
|
538
|
-
],
|
|
539
|
-
[
|
|
540
|
-
"project_id",
|
|
541
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
542
|
-
]
|
|
510
|
+
["page_size", request.pageSize ?? this.client.settings.defaultPageSize],
|
|
511
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId]
|
|
543
512
|
)
|
|
544
513
|
},
|
|
545
514
|
unmarshalListContactPointsResponse
|
|
@@ -554,10 +523,7 @@ class RegionalAPI extends API {
|
|
|
554
523
|
updateContactPoint = (request = {}) => this.client.fetch(
|
|
555
524
|
{
|
|
556
525
|
body: JSON.stringify(
|
|
557
|
-
marshalRegionalApiUpdateContactPointRequest(
|
|
558
|
-
request,
|
|
559
|
-
this.client.settings
|
|
560
|
-
)
|
|
526
|
+
marshalRegionalApiUpdateContactPointRequest(request, this.client.settings)
|
|
561
527
|
),
|
|
562
528
|
headers: jsonContentHeaders,
|
|
563
529
|
method: "PATCH",
|
|
@@ -570,17 +536,16 @@ class RegionalAPI extends API {
|
|
|
570
536
|
*
|
|
571
537
|
* @param request - The request {@link RegionalApiDeleteContactPointRequest}
|
|
572
538
|
*/
|
|
573
|
-
deleteContactPoint = (request = {}) => this.client.fetch(
|
|
574
|
-
|
|
575
|
-
|
|
576
|
-
request,
|
|
577
|
-
|
|
578
|
-
|
|
579
|
-
|
|
580
|
-
|
|
581
|
-
|
|
582
|
-
|
|
583
|
-
});
|
|
539
|
+
deleteContactPoint = (request = {}) => this.client.fetch(
|
|
540
|
+
{
|
|
541
|
+
body: JSON.stringify(
|
|
542
|
+
marshalRegionalApiDeleteContactPointRequest(request, this.client.settings)
|
|
543
|
+
),
|
|
544
|
+
headers: jsonContentHeaders,
|
|
545
|
+
method: "POST",
|
|
546
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/contact-points/delete`
|
|
547
|
+
}
|
|
548
|
+
);
|
|
584
549
|
/**
|
|
585
550
|
* List alerts. List preconfigured and/or custom alerts for the specified Project and data source.
|
|
586
551
|
*
|
|
@@ -594,16 +559,49 @@ class RegionalAPI extends API {
|
|
|
594
559
|
urlParams: urlParams(
|
|
595
560
|
["data_source_id", request.dataSourceId],
|
|
596
561
|
["is_preconfigured", request.isPreconfigured],
|
|
597
|
-
[
|
|
598
|
-
"project_id",
|
|
599
|
-
request.projectId ?? this.client.settings.defaultProjectId
|
|
600
|
-
],
|
|
562
|
+
["project_id", request.projectId ?? this.client.settings.defaultProjectId],
|
|
601
563
|
["rule_status", request.ruleStatus],
|
|
602
564
|
["state", request.state]
|
|
603
565
|
)
|
|
604
566
|
},
|
|
605
567
|
unmarshalListAlertsResponse
|
|
606
568
|
);
|
|
569
|
+
/**
|
|
570
|
+
* Enable managed alerts. Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway resources integrated with Cockpit by default.
|
|
571
|
+
*
|
|
572
|
+
* @deprecated
|
|
573
|
+
* @param request - The request {@link RegionalApiEnableManagedAlertsRequest}
|
|
574
|
+
* @returns A Promise of AlertManager
|
|
575
|
+
*/
|
|
576
|
+
enableManagedAlerts = (request = {}) => this.client.fetch(
|
|
577
|
+
{
|
|
578
|
+
body: JSON.stringify(
|
|
579
|
+
marshalRegionalApiEnableManagedAlertsRequest(request, this.client.settings)
|
|
580
|
+
),
|
|
581
|
+
headers: jsonContentHeaders,
|
|
582
|
+
method: "POST",
|
|
583
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/managed-alerts/enable`
|
|
584
|
+
},
|
|
585
|
+
unmarshalAlertManager
|
|
586
|
+
);
|
|
587
|
+
/**
|
|
588
|
+
* Disable managed alerts. Disable the sending of managed alerts for the specified Project.
|
|
589
|
+
*
|
|
590
|
+
* @deprecated
|
|
591
|
+
* @param request - The request {@link RegionalApiDisableManagedAlertsRequest}
|
|
592
|
+
* @returns A Promise of AlertManager
|
|
593
|
+
*/
|
|
594
|
+
disableManagedAlerts = (request = {}) => this.client.fetch(
|
|
595
|
+
{
|
|
596
|
+
body: JSON.stringify(
|
|
597
|
+
marshalRegionalApiDisableManagedAlertsRequest(request, this.client.settings)
|
|
598
|
+
),
|
|
599
|
+
headers: jsonContentHeaders,
|
|
600
|
+
method: "POST",
|
|
601
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/managed-alerts/disable`
|
|
602
|
+
},
|
|
603
|
+
unmarshalAlertManager
|
|
604
|
+
);
|
|
607
605
|
/**
|
|
608
606
|
* Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
|
|
609
607
|
*
|
|
@@ -613,10 +611,7 @@ class RegionalAPI extends API {
|
|
|
613
611
|
enableAlertRules = (request = {}) => this.client.fetch(
|
|
614
612
|
{
|
|
615
613
|
body: JSON.stringify(
|
|
616
|
-
marshalRegionalApiEnableAlertRulesRequest(
|
|
617
|
-
request,
|
|
618
|
-
this.client.settings
|
|
619
|
-
)
|
|
614
|
+
marshalRegionalApiEnableAlertRulesRequest(request, this.client.settings)
|
|
620
615
|
),
|
|
621
616
|
headers: jsonContentHeaders,
|
|
622
617
|
method: "POST",
|
|
@@ -633,10 +628,7 @@ class RegionalAPI extends API {
|
|
|
633
628
|
disableAlertRules = (request = {}) => this.client.fetch(
|
|
634
629
|
{
|
|
635
630
|
body: JSON.stringify(
|
|
636
|
-
marshalRegionalApiDisableAlertRulesRequest(
|
|
637
|
-
request,
|
|
638
|
-
this.client.settings
|
|
639
|
-
)
|
|
631
|
+
marshalRegionalApiDisableAlertRulesRequest(request, this.client.settings)
|
|
640
632
|
),
|
|
641
633
|
headers: jsonContentHeaders,
|
|
642
634
|
method: "POST",
|
|
@@ -649,17 +641,16 @@ class RegionalAPI extends API {
|
|
|
649
641
|
*
|
|
650
642
|
* @param request - The request {@link RegionalApiTriggerTestAlertRequest}
|
|
651
643
|
*/
|
|
652
|
-
triggerTestAlert = (request = {}) => this.client.fetch(
|
|
653
|
-
|
|
654
|
-
|
|
655
|
-
request,
|
|
656
|
-
|
|
657
|
-
|
|
658
|
-
|
|
659
|
-
|
|
660
|
-
|
|
661
|
-
|
|
662
|
-
});
|
|
644
|
+
triggerTestAlert = (request = {}) => this.client.fetch(
|
|
645
|
+
{
|
|
646
|
+
body: JSON.stringify(
|
|
647
|
+
marshalRegionalApiTriggerTestAlertRequest(request, this.client.settings)
|
|
648
|
+
),
|
|
649
|
+
headers: jsonContentHeaders,
|
|
650
|
+
method: "POST",
|
|
651
|
+
path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/trigger-test-alert`
|
|
652
|
+
}
|
|
653
|
+
);
|
|
663
654
|
}
|
|
664
655
|
export {
|
|
665
656
|
GlobalAPI,
|
package/dist/v1/index.gen.d.ts
CHANGED
|
@@ -1,4 +1,4 @@
|
|
|
1
1
|
export { GlobalAPI, RegionalAPI, } from './api.gen.js';
|
|
2
2
|
export * from './marshalling.gen.js';
|
|
3
|
-
export type { Alert, AlertManager, AlertState, AlertStatus, ContactPoint, ContactPointEmail, DataSource, DataSourceOrigin, DataSourceType, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GetConfigResponseRetention, GetRulesCountResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, GrafanaUserRole, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesRequestOrderBy, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersRequestOrderBy, ListGrafanaUsersResponse, ListPlansRequestOrderBy, ListPlansResponse, ListTokensRequestOrderBy, ListTokensResponse, Plan, PlanName, PreconfiguredAlertData, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetRulesCountRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, RulesCount, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen.js';
|
|
3
|
+
export type { Alert, AlertManager, AlertState, AlertStatus, ContactPoint, ContactPointEmail, DataSource, DataSourceOrigin, DataSourceType, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GetConfigResponseRetention, GetRulesCountResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, GrafanaUserRole, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesRequestOrderBy, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersRequestOrderBy, ListGrafanaUsersResponse, ListPlansRequestOrderBy, ListPlansResponse, ListProductsRequestOrderBy, ListProductsResponse, ListTokensRequestOrderBy, ListTokensResponse, Plan, PlanName, PreconfiguredAlertData, Product, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetRulesCountRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListProductsRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, RulesCount, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen.js';
|
|
4
4
|
export * as ValidationRules from './validation-rules.gen.js';
|
package/dist/v1/index.gen.js
CHANGED
|
@@ -1,5 +1,5 @@
|
|
|
1
1
|
import { GlobalAPI, RegionalAPI } from "./api.gen.js";
|
|
2
|
-
import { marshalGlobalApiCreateGrafanaUserRequest, marshalGlobalApiResetGrafanaUserPasswordRequest, marshalGlobalApiSelectPlanRequest, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalRegionalApiCreateContactPointRequest, marshalRegionalApiCreateDataSourceRequest, marshalRegionalApiCreateTokenRequest, marshalRegionalApiDeleteContactPointRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiDisableAlertRulesRequest, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiEnableAlertRulesRequest, marshalRegionalApiTriggerTestAlertRequest, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiUpdateDataSourceRequest, unmarshalAlertManager, unmarshalContactPoint, unmarshalDataSource, unmarshalDisableAlertRulesResponse, unmarshalEnableAlertRulesResponse, unmarshalGetConfigResponse, unmarshalGetRulesCountResponse, unmarshalGrafana, unmarshalGrafanaProductDashboard, unmarshalGrafanaUser, unmarshalListAlertsResponse, unmarshalListContactPointsResponse, unmarshalListDataSourcesResponse, unmarshalListGrafanaProductDashboardsResponse, unmarshalListGrafanaUsersResponse, unmarshalListPlansResponse, unmarshalListTokensResponse, unmarshalPlan, unmarshalToken, unmarshalUsageOverview } from "./marshalling.gen.js";
|
|
2
|
+
import { marshalGlobalApiCreateGrafanaUserRequest, marshalGlobalApiResetGrafanaUserPasswordRequest, marshalGlobalApiSelectPlanRequest, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalRegionalApiCreateContactPointRequest, marshalRegionalApiCreateDataSourceRequest, marshalRegionalApiCreateTokenRequest, marshalRegionalApiDeleteContactPointRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiDisableAlertRulesRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiEnableAlertRulesRequest, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiTriggerTestAlertRequest, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiUpdateDataSourceRequest, unmarshalAlertManager, unmarshalContactPoint, unmarshalDataSource, unmarshalDisableAlertRulesResponse, unmarshalEnableAlertRulesResponse, unmarshalGetConfigResponse, unmarshalGetRulesCountResponse, unmarshalGrafana, unmarshalGrafanaProductDashboard, unmarshalGrafanaUser, unmarshalListAlertsResponse, unmarshalListContactPointsResponse, unmarshalListDataSourcesResponse, unmarshalListGrafanaProductDashboardsResponse, unmarshalListGrafanaUsersResponse, unmarshalListPlansResponse, unmarshalListProductsResponse, unmarshalListTokensResponse, unmarshalPlan, unmarshalToken, unmarshalUsageOverview } from "./marshalling.gen.js";
|
|
3
3
|
import * as validationRules_gen from "./validation-rules.gen.js";
|
|
4
4
|
export {
|
|
5
5
|
GlobalAPI,
|
|
@@ -15,8 +15,10 @@ export {
|
|
|
15
15
|
marshalRegionalApiDeleteContactPointRequest,
|
|
16
16
|
marshalRegionalApiDisableAlertManagerRequest,
|
|
17
17
|
marshalRegionalApiDisableAlertRulesRequest,
|
|
18
|
+
marshalRegionalApiDisableManagedAlertsRequest,
|
|
18
19
|
marshalRegionalApiEnableAlertManagerRequest,
|
|
19
20
|
marshalRegionalApiEnableAlertRulesRequest,
|
|
21
|
+
marshalRegionalApiEnableManagedAlertsRequest,
|
|
20
22
|
marshalRegionalApiTriggerTestAlertRequest,
|
|
21
23
|
marshalRegionalApiUpdateContactPointRequest,
|
|
22
24
|
marshalRegionalApiUpdateDataSourceRequest,
|
|
@@ -36,6 +38,7 @@ export {
|
|
|
36
38
|
unmarshalListGrafanaProductDashboardsResponse,
|
|
37
39
|
unmarshalListGrafanaUsersResponse,
|
|
38
40
|
unmarshalListPlansResponse,
|
|
41
|
+
unmarshalListProductsResponse,
|
|
39
42
|
unmarshalListTokensResponse,
|
|
40
43
|
unmarshalPlan,
|
|
41
44
|
unmarshalToken,
|