@scaleway/sdk-cockpit 1.6.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.
@@ -1,5 +1,5 @@
1
1
  import type { DefaultValues } from '@scaleway/sdk-client';
2
- import type { AlertManager, ContactPoint, DataSource, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GetRulesCountResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen.js';
2
+ import type { AlertManager, ContactPoint, DataSource, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GetRulesCountResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListProductsResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen.js';
3
3
  export declare const unmarshalContactPoint: (data: unknown) => ContactPoint;
4
4
  export declare const unmarshalDataSource: (data: unknown) => DataSource;
5
5
  export declare const unmarshalGrafanaProductDashboard: (data: unknown) => GrafanaProductDashboard;
@@ -18,6 +18,7 @@ export declare const unmarshalListDataSourcesResponse: (data: unknown) => ListDa
18
18
  export declare const unmarshalListGrafanaProductDashboardsResponse: (data: unknown) => ListGrafanaProductDashboardsResponse;
19
19
  export declare const unmarshalListGrafanaUsersResponse: (data: unknown) => ListGrafanaUsersResponse;
20
20
  export declare const unmarshalListPlansResponse: (data: unknown) => ListPlansResponse;
21
+ export declare const unmarshalListProductsResponse: (data: unknown) => ListProductsResponse;
21
22
  export declare const unmarshalListTokensResponse: (data: unknown) => ListTokensResponse;
22
23
  export declare const unmarshalUsageOverview: (data: unknown) => UsageOverview;
23
24
  export declare const marshalGlobalApiCreateGrafanaUserRequest: (request: GlobalApiCreateGrafanaUserRequest, defaults: DefaultValues) => Record<string, unknown>;
@@ -30,8 +31,10 @@ export declare const marshalRegionalApiCreateTokenRequest: (request: RegionalApi
30
31
  export declare const marshalRegionalApiDeleteContactPointRequest: (request: RegionalApiDeleteContactPointRequest, defaults: DefaultValues) => Record<string, unknown>;
31
32
  export declare const marshalRegionalApiDisableAlertManagerRequest: (request: RegionalApiDisableAlertManagerRequest, defaults: DefaultValues) => Record<string, unknown>;
32
33
  export declare const marshalRegionalApiDisableAlertRulesRequest: (request: RegionalApiDisableAlertRulesRequest, defaults: DefaultValues) => Record<string, unknown>;
34
+ export declare const marshalRegionalApiDisableManagedAlertsRequest: (request: RegionalApiDisableManagedAlertsRequest, defaults: DefaultValues) => Record<string, unknown>;
33
35
  export declare const marshalRegionalApiEnableAlertManagerRequest: (request: RegionalApiEnableAlertManagerRequest, defaults: DefaultValues) => Record<string, unknown>;
34
36
  export declare const marshalRegionalApiEnableAlertRulesRequest: (request: RegionalApiEnableAlertRulesRequest, defaults: DefaultValues) => Record<string, unknown>;
37
+ export declare const marshalRegionalApiEnableManagedAlertsRequest: (request: RegionalApiEnableManagedAlertsRequest, defaults: DefaultValues) => Record<string, unknown>;
35
38
  export declare const marshalRegionalApiTriggerTestAlertRequest: (request: RegionalApiTriggerTestAlertRequest, defaults: DefaultValues) => Record<string, unknown>;
36
39
  export declare const marshalRegionalApiUpdateContactPointRequest: (request: RegionalApiUpdateContactPointRequest, defaults: DefaultValues) => Record<string, unknown>;
37
40
  export declare const marshalRegionalApiUpdateDataSourceRequest: (request: RegionalApiUpdateDataSourceRequest, defaults: DefaultValues) => Record<string, unknown>;
@@ -29,6 +29,7 @@ const unmarshalDataSource = (data) => {
29
29
  }
30
30
  return {
31
31
  createdAt: unmarshalDate(data.created_at),
32
+ currentMonthUsage: data.current_month_usage,
32
33
  id: data.id,
33
34
  name: data.name,
34
35
  origin: data.origin,
@@ -182,10 +183,7 @@ const unmarshalGetRulesCountResponse = (data) => {
182
183
  return {
183
184
  customRulesCount: data.custom_rules_count,
184
185
  preconfiguredRulesCount: data.preconfigured_rules_count,
185
- rulesCountByDatasource: unmarshalArrayOfObject(
186
- data.rules_count_by_datasource,
187
- unmarshalRulesCount
188
- )
186
+ rulesCountByDatasource: unmarshalArrayOfObject(data.rules_count_by_datasource, unmarshalRulesCount)
189
187
  };
190
188
  };
191
189
  const unmarshalGrafana = (data) => {
@@ -249,10 +247,7 @@ const unmarshalListContactPointsResponse = (data) => {
249
247
  );
250
248
  }
251
249
  return {
252
- contactPoints: unmarshalArrayOfObject(
253
- data.contact_points,
254
- unmarshalContactPoint
255
- ),
250
+ contactPoints: unmarshalArrayOfObject(data.contact_points, unmarshalContactPoint),
256
251
  hasAdditionalContactPoints: data.has_additional_contact_points,
257
252
  hasAdditionalReceivers: data.has_additional_receivers,
258
253
  totalCount: data.total_count
@@ -276,10 +271,7 @@ const unmarshalListGrafanaProductDashboardsResponse = (data) => {
276
271
  );
277
272
  }
278
273
  return {
279
- dashboards: unmarshalArrayOfObject(
280
- data.dashboards,
281
- unmarshalGrafanaProductDashboard
282
- ),
274
+ dashboards: unmarshalArrayOfObject(data.dashboards, unmarshalGrafanaProductDashboard),
283
275
  totalCount: data.total_count
284
276
  };
285
277
  };
@@ -290,10 +282,7 @@ const unmarshalListGrafanaUsersResponse = (data) => {
290
282
  );
291
283
  }
292
284
  return {
293
- grafanaUsers: unmarshalArrayOfObject(
294
- data.grafana_users,
295
- unmarshalGrafanaUser
296
- ),
285
+ grafanaUsers: unmarshalArrayOfObject(data.grafana_users, unmarshalGrafanaUser),
297
286
  totalCount: data.total_count
298
287
  };
299
288
  };
@@ -308,6 +297,30 @@ const unmarshalListPlansResponse = (data) => {
308
297
  totalCount: data.total_count
309
298
  };
310
299
  };
300
+ const unmarshalProduct = (data) => {
301
+ if (!isJSONObject(data)) {
302
+ throw new TypeError(
303
+ `Unmarshalling the type 'Product' failed as data isn't a dictionary.`
304
+ );
305
+ }
306
+ return {
307
+ displayName: data.display_name,
308
+ familyName: data.family_name,
309
+ name: data.name,
310
+ resourceTypes: data.resource_types
311
+ };
312
+ };
313
+ const unmarshalListProductsResponse = (data) => {
314
+ if (!isJSONObject(data)) {
315
+ throw new TypeError(
316
+ `Unmarshalling the type 'ListProductsResponse' failed as data isn't a dictionary.`
317
+ );
318
+ }
319
+ return {
320
+ productsList: unmarshalArrayOfObject(data.products_list, unmarshalProduct),
321
+ totalCount: data.total_count
322
+ };
323
+ };
311
324
  const unmarshalListTokensResponse = (data) => {
312
325
  if (!isJSONObject(data)) {
313
326
  throw new TypeError(
@@ -405,6 +418,9 @@ const marshalRegionalApiDisableAlertRulesRequest = (request, defaults) => ({
405
418
  project_id: request.projectId ?? defaults.defaultProjectId,
406
419
  rule_ids: request.ruleIds
407
420
  });
421
+ const marshalRegionalApiDisableManagedAlertsRequest = (request, defaults) => ({
422
+ project_id: request.projectId ?? defaults.defaultProjectId
423
+ });
408
424
  const marshalRegionalApiEnableAlertManagerRequest = (request, defaults) => ({
409
425
  project_id: request.projectId ?? defaults.defaultProjectId
410
426
  });
@@ -412,6 +428,9 @@ const marshalRegionalApiEnableAlertRulesRequest = (request, defaults) => ({
412
428
  project_id: request.projectId ?? defaults.defaultProjectId,
413
429
  rule_ids: request.ruleIds
414
430
  });
431
+ const marshalRegionalApiEnableManagedAlertsRequest = (request, defaults) => ({
432
+ project_id: request.projectId ?? defaults.defaultProjectId
433
+ });
415
434
  const marshalRegionalApiTriggerTestAlertRequest = (request, defaults) => ({
416
435
  project_id: request.projectId ?? defaults.defaultProjectId
417
436
  });
@@ -440,8 +459,10 @@ export {
440
459
  marshalRegionalApiDeleteContactPointRequest,
441
460
  marshalRegionalApiDisableAlertManagerRequest,
442
461
  marshalRegionalApiDisableAlertRulesRequest,
462
+ marshalRegionalApiDisableManagedAlertsRequest,
443
463
  marshalRegionalApiEnableAlertManagerRequest,
444
464
  marshalRegionalApiEnableAlertRulesRequest,
465
+ marshalRegionalApiEnableManagedAlertsRequest,
445
466
  marshalRegionalApiTriggerTestAlertRequest,
446
467
  marshalRegionalApiUpdateContactPointRequest,
447
468
  marshalRegionalApiUpdateDataSourceRequest,
@@ -461,6 +482,7 @@ export {
461
482
  unmarshalListGrafanaProductDashboardsResponse,
462
483
  unmarshalListGrafanaUsersResponse,
463
484
  unmarshalListPlansResponse,
485
+ unmarshalListProductsResponse,
464
486
  unmarshalListTokensResponse,
465
487
  unmarshalPlan,
466
488
  unmarshalToken,
@@ -7,6 +7,7 @@ export type GrafanaUserRole = 'unknown_role' | 'editor' | 'viewer';
7
7
  export type ListDataSourcesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc' | 'type_asc' | 'type_desc';
8
8
  export type ListGrafanaUsersRequestOrderBy = 'login_asc' | 'login_desc';
9
9
  export type ListPlansRequestOrderBy = 'name_asc' | 'name_desc';
10
+ export type ListProductsRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'display_name_asc' | 'display_name_desc' | 'family_name_asc' | 'family_name_desc';
10
11
  export type ListTokensRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
11
12
  export type PlanName = 'unknown_name' | 'free' | 'premium' | 'custom';
12
13
  export type TokenScope = 'unknown_scope' | 'read_only_metrics' | 'write_only_metrics' | 'full_access_metrics_rules' | 'read_only_logs' | 'write_only_logs' | 'full_access_logs_rules' | 'full_access_alert_manager' | 'read_only_traces' | 'write_only_traces';
@@ -170,6 +171,10 @@ export interface DataSource {
170
171
  * Region of the data source.
171
172
  */
172
173
  region: ScwRegion;
174
+ /**
175
+ * Usage of the month in bytes.
176
+ */
177
+ currentMonthUsage?: number;
173
178
  }
174
179
  /**
175
180
  * Grafana dashboard.
@@ -254,6 +259,12 @@ export interface Plan {
254
259
  */
255
260
  monthlyPrice: number;
256
261
  }
262
+ export interface Product {
263
+ name: string;
264
+ displayName: string;
265
+ familyName: string;
266
+ resourceTypes: string[];
267
+ }
257
268
  /**
258
269
  * Token.
259
270
  */
@@ -628,7 +639,7 @@ export interface ListGrafanaProductDashboardsResponse {
628
639
  dashboards: GrafanaProductDashboard[];
629
640
  }
630
641
  /**
631
- * Ouptut returned when listing Grafana users.
642
+ * Output returned when listing Grafana users.
632
643
  */
633
644
  export interface ListGrafanaUsersResponse {
634
645
  /**
@@ -653,6 +664,10 @@ export interface ListPlansResponse {
653
664
  */
654
665
  plans: Plan[];
655
666
  }
667
+ export interface ListProductsResponse {
668
+ productsList: Product[];
669
+ totalCount: number;
670
+ }
656
671
  /**
657
672
  * Response returned when listing tokens.
658
673
  */
@@ -807,6 +822,19 @@ export type RegionalApiDisableAlertRulesRequest = {
807
822
  */
808
823
  ruleIds?: string[];
809
824
  };
825
+ /**
826
+ * Disable the sending of managed alerts.
827
+ */
828
+ export type RegionalApiDisableManagedAlertsRequest = {
829
+ /**
830
+ * Region to target. If none is passed will use default region from the config.
831
+ */
832
+ region?: ScwRegion;
833
+ /**
834
+ * ID of the Project.
835
+ */
836
+ projectId?: string;
837
+ };
810
838
  /**
811
839
  * Enable the Alert manager.
812
840
  */
@@ -834,6 +862,19 @@ export type RegionalApiEnableAlertRulesRequest = {
834
862
  */
835
863
  ruleIds?: string[];
836
864
  };
865
+ /**
866
+ * Enable the sending of managed alerts.
867
+ */
868
+ export type RegionalApiEnableManagedAlertsRequest = {
869
+ /**
870
+ * Region to target. If none is passed will use default region from the config.
871
+ */
872
+ region?: ScwRegion;
873
+ /**
874
+ * ID of the Project.
875
+ */
876
+ projectId?: string;
877
+ };
837
878
  /**
838
879
  * Get the Alert manager.
839
880
  */
@@ -983,6 +1024,27 @@ export type RegionalApiListDataSourcesRequest = {
983
1024
  */
984
1025
  types?: DataSourceType[];
985
1026
  };
1027
+ /**
1028
+ * List all Scaleway products that send metrics and/or logs to Cockpit.
1029
+ */
1030
+ export type RegionalApiListProductsRequest = {
1031
+ /**
1032
+ * Region to target. If none is passed will use default region from the config.
1033
+ */
1034
+ region?: ScwRegion;
1035
+ /**
1036
+ * Page number to return from the paginated results.
1037
+ */
1038
+ page?: number;
1039
+ /**
1040
+ * Number of products to return per page.
1041
+ */
1042
+ pageSize?: number;
1043
+ /**
1044
+ * Sort order for products in the response.
1045
+ */
1046
+ orderBy?: ListProductsRequestOrderBy;
1047
+ };
986
1048
  /**
987
1049
  * List tokens.
988
1050
  */
@@ -35,6 +35,16 @@ export declare const RegionalApiListDataSourcesRequest: {
35
35
  lessThanOrEqual: number;
36
36
  };
37
37
  };
38
+ export declare const RegionalApiListProductsRequest: {
39
+ page: {
40
+ greaterThanOrEqual: number;
41
+ lessThanOrEqual: number;
42
+ };
43
+ pageSize: {
44
+ greaterThanOrEqual: number;
45
+ lessThanOrEqual: number;
46
+ };
47
+ };
38
48
  export declare const RegionalApiListTokensRequest: {
39
49
  page: {
40
50
  greaterThanOrEqual: number;
@@ -35,6 +35,16 @@ const RegionalApiListDataSourcesRequest = {
35
35
  lessThanOrEqual: 1e3
36
36
  }
37
37
  };
38
+ const RegionalApiListProductsRequest = {
39
+ page: {
40
+ greaterThanOrEqual: 1,
41
+ lessThanOrEqual: 1e4
42
+ },
43
+ pageSize: {
44
+ greaterThanOrEqual: 1,
45
+ lessThanOrEqual: 100
46
+ }
47
+ };
38
48
  const RegionalApiListTokensRequest = {
39
49
  page: {
40
50
  greaterThanOrEqual: 1
@@ -62,6 +72,7 @@ export {
62
72
  RegionalApiCreateTokenRequest,
63
73
  RegionalApiListContactPointsRequest,
64
74
  RegionalApiListDataSourcesRequest,
75
+ RegionalApiListProductsRequest,
65
76
  RegionalApiListTokensRequest,
66
77
  RegionalApiUpdateDataSourceRequest
67
78
  };
package/package.json CHANGED
@@ -1,23 +1,20 @@
1
1
  {
2
2
  "name": "@scaleway/sdk-cockpit",
3
- "version": "1.6.0",
3
+ "version": "2.1.1",
4
4
  "description": "Scaleway SDK cockpit",
5
5
  "license": "Apache-2.0",
6
6
  "files": [
7
+ "README.md",
7
8
  "dist"
8
9
  ],
9
10
  "type": "module",
10
11
  "exports": {
11
12
  ".": {
12
13
  "types": "./dist/index.gen.d.ts",
13
- "import": "./dist/index.gen.js",
14
- "require": "./dist/index.gen.cjs",
15
14
  "default": "./dist/index.gen.js"
16
15
  },
17
16
  "./*": {
18
17
  "types": "./dist/*/index.gen.d.ts",
19
- "import": "./dist/*/index.gen.js",
20
- "require": "./dist/*/index.gen.cjs",
21
18
  "default": "./dist/*/index.gen.js"
22
19
  }
23
20
  },
@@ -26,17 +23,17 @@
26
23
  "directory": "packages_generated/cockpit"
27
24
  },
28
25
  "engines": {
29
- "node": ">=20.19.4"
26
+ "node": ">=20.19.6"
30
27
  },
31
28
  "dependencies": {
32
29
  "@scaleway/random-name": "5.1.2",
33
- "@scaleway/sdk-std": "1.1.0"
30
+ "@scaleway/sdk-std": "2.1.0"
34
31
  },
35
32
  "peerDependencies": {
36
- "@scaleway/sdk-client": "^1.3.2"
33
+ "@scaleway/sdk-client": "^2.1.0"
37
34
  },
38
35
  "devDependencies": {
39
- "@scaleway/sdk-client": "^1.3.2"
36
+ "@scaleway/sdk-client": "^2.1.0"
40
37
  },
41
38
  "scripts": {
42
39
  "package:check": "pnpm publint",
@@ -1,4 +0,0 @@
1
- "use strict";
2
- Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
3
- const index_gen = require("./v1/index.gen.cjs");
4
- exports.Cockpitv1 = index_gen;