@scaleway/sdk-cockpit 1.3.1 → 1.4.0

package/dist/v1/api.gen.cjs

@@ -232,12 +232,13 @@ class GlobalAPI extends sdkClient.API {
   );
 }
 class RegionalAPI extends sdkClient.API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = sdkClient.toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Get the Cockpit configuration.
    *
@@ -252,10 +253,7 @@ class RegionalAPI extends sdkClient.API {
     marshalling_gen.unmarshalGetConfigResponse
   );
   /**
-     * Create a data source. You must specify the data source type upon creation. Available data source types include:
-    - metrics
-    - logs
-    - traces
+     * Create a data source. You must specify the data source name and type (metrics, logs, traces) upon creation.
   The name of the data source will then be used as reference to name the associated Grafana data source.
      *
      * @param request - The request {@link RegionalApiCreateDataSourceRequest}
@@ -289,7 +287,7 @@ class RegionalAPI extends sdkClient.API {
     marshalling_gen.unmarshalDataSource
   );
   /**
-   * Delete a data source. Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
+   * Delete a data source. Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.
    *
    * @param request - The request {@link RegionalApiDeleteDataSourceRequest}
    */
@@ -319,15 +317,14 @@ class RegionalAPI extends sdkClient.API {
     marshalling_gen.unmarshalListDataSourcesResponse
   );
   /**
-     * List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
-  You can list data sources by Project, type and origin.
-     *
-     * @param request - The request {@link RegionalApiListDataSourcesRequest}
-     * @returns A Promise of ListDataSourcesResponse
-     */
+   * List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
+   *
+   * @param request - The request {@link RegionalApiListDataSourcesRequest}
+   * @returns A Promise of ListDataSourcesResponse
+   */
   listDataSources = (request = {}) => sdkClient.enrichForPagination("dataSources", this.pageOfListDataSources, request);
   /**
-   * Update a data source. Update a given data source name, specified by the data source ID.
+   * Update a data source. Update a given data source attributes (name and/or retention_days).
    *
    * @param request - The request {@link RegionalApiUpdateDataSourceRequest}
    * @returns A Promise of DataSource
@@ -347,7 +344,7 @@ class RegionalAPI extends sdkClient.API {
     marshalling_gen.unmarshalDataSource
   );
   /**
-   * Get data source usage overview. Retrieve the data source usage overview per type for the specified Project.
+   * Get data source usage overview. Retrieve the volume of data ingested for each of your data sources in the specified project and region.
    *
    * @param request - The request {@link RegionalApiGetUsageOverviewRequest}
    * @returns A Promise of UsageOverview
@@ -492,6 +489,23 @@ class RegionalAPI extends sdkClient.API {
     },
     marshalling_gen.unmarshalAlertManager
   );
+  /**
+   * Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.. Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
+   *
+   * @param request - The request {@link RegionalApiGetRulesCountRequest}
+   * @returns A Promise of GetRulesCountResponse
+   */
+  getRulesCount = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/cockpit/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/rules/count`,
+      urlParams: sdkClient.urlParams([
+        "project_id",
+        request.projectId ?? this.client.settings.defaultProjectId
+      ])
+    },
+    marshalling_gen.unmarshalGetRulesCountResponse
+  );
   /**
      * Create a contact point. Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to.
   The source of the alerts are data sources within the same Project and region as the Alert manager.

package/dist/v1/api.gen.d.ts

@@ -1,6 +1,6 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { Region as ScwRegion } from '@scaleway/sdk-client';
-import type { AlertManager, ContactPoint, DataSource, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
+import type { ApiLocality } from '@scaleway/sdk-client';
+import type { AlertManager, ContactPoint, DataSource, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GetRulesCountResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetRulesCountRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
 /**
  * Cockpit Global API.
 
@@ -110,8 +110,11 @@ export declare class GlobalAPI extends ParentAPI {
 The Cockpit API allows you to create data sources and Cockpit tokens to store and query data types such as metrics, logs, and traces. You can also push your data into Cockpit, and send alerts to your contact points when your resources may require your attention, using the regional Alert manager.
  */
 export declare class RegionalAPI extends ParentAPI {
-    /** Lists the available regions of the API. */
-    static readonly LOCALITIES: ScwRegion[];
+    /**
+     * Locality of this API.
+     * type ∈ {'zone','region','global','unspecified'}
+     */
+    static readonly LOCALITY: ApiLocality;
     /**
      * Get the Cockpit configuration.
      *
@@ -120,10 +123,7 @@ export declare class RegionalAPI extends ParentAPI {
      */
     getConfig: (request?: Readonly<RegionalApiGetConfigRequest>) => Promise<GetConfigResponse>;
     /**
-     * Create a data source. You must specify the data source type upon creation. Available data source types include:
-    - metrics
-    - logs
-    - traces
+     * Create a data source. You must specify the data source name and type (metrics, logs, traces) upon creation.
   The name of the data source will then be used as reference to name the associated Grafana data source.
      *
      * @param request - The request {@link RegionalApiCreateDataSourceRequest}
@@ -138,7 +138,7 @@ export declare class RegionalAPI extends ParentAPI {
      */
     getDataSource: (request: Readonly<RegionalApiGetDataSourceRequest>) => Promise<DataSource>;
     /**
-     * Delete a data source. Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
+     * Delete a data source. Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.
      *
      * @param request - The request {@link RegionalApiDeleteDataSourceRequest}
      */
@@ -146,7 +146,6 @@ export declare class RegionalAPI extends ParentAPI {
     protected pageOfListDataSources: (request?: Readonly<RegionalApiListDataSourcesRequest>) => Promise<ListDataSourcesResponse>;
     /**
      * List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
-  You can list data sources by Project, type and origin.
      *
      * @param request - The request {@link RegionalApiListDataSourcesRequest}
      * @returns A Promise of ListDataSourcesResponse
@@ -156,14 +155,14 @@ export declare class RegionalAPI extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<DataSource[], void, void>;
     };
     /**
-     * Update a data source. Update a given data source name, specified by the data source ID.
+     * Update a data source. Update a given data source attributes (name and/or retention_days).
      *
      * @param request - The request {@link RegionalApiUpdateDataSourceRequest}
      * @returns A Promise of DataSource
      */
     updateDataSource: (request: Readonly<RegionalApiUpdateDataSourceRequest>) => Promise<DataSource>;
     /**
-     * Get data source usage overview. Retrieve the data source usage overview per type for the specified Project.
+     * Get data source usage overview. Retrieve the volume of data ingested for each of your data sources in the specified project and region.
      *
      * @param request - The request {@link RegionalApiGetUsageOverviewRequest}
      * @returns A Promise of UsageOverview
@@ -224,6 +223,13 @@ export declare class RegionalAPI extends ParentAPI {
      * @returns A Promise of AlertManager
      */
     disableAlertManager: (request?: Readonly<RegionalApiDisableAlertManagerRequest>) => Promise<AlertManager>;
+    /**
+     * Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.. Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
+     *
+     * @param request - The request {@link RegionalApiGetRulesCountRequest}
+     * @returns A Promise of GetRulesCountResponse
+     */
+    getRulesCount: (request?: Readonly<RegionalApiGetRulesCountRequest>) => Promise<GetRulesCountResponse>;
     /**
      * Create a contact point. Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to.
   The source of the alerts are data sources within the same Project and region as the Alert manager.

package/dist/v1/api.gen.js

@@ -1,5 +1,5 @@
-import { API, urlParams, enrichForPagination, validatePathParam } from "@scaleway/sdk-client";
-import { unmarshalGrafana, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalGlobalApiCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalGlobalApiResetGrafanaUserPasswordRequest, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard, unmarshalListPlansResponse, marshalGlobalApiSelectPlanRequest, unmarshalPlan, unmarshalGetConfigResponse, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, marshalRegionalApiUpdateDataSourceRequest, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, unmarshalAlertManager, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiDeleteContactPointRequest, unmarshalListAlertsResponse, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiEnableAlertRulesRequest, unmarshalEnableAlertRulesResponse, marshalRegionalApiDisableAlertRulesRequest, unmarshalDisableAlertRulesResponse, marshalRegionalApiTriggerTestAlertRequest } from "./marshalling.gen.js";
+import { API, toApiLocality, validatePathParam, urlParams, enrichForPagination } from "@scaleway/sdk-client";
+import { unmarshalGetConfigResponse, marshalRegionalApiCreateDataSourceRequest, unmarshalDataSource, unmarshalListDataSourcesResponse, marshalRegionalApiUpdateDataSourceRequest, unmarshalUsageOverview, marshalRegionalApiCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, 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";
 const jsonContentHeaders = {
   "Content-Type": "application/json; charset=utf-8"
 };
@@ -230,12 +230,13 @@ class GlobalAPI extends API {
   );
 }
 class RegionalAPI extends API {
-  /** Lists the available regions of the API. */
-  static LOCALITIES = [
-    "fr-par",
-    "nl-ams",
-    "pl-waw"
-  ];
+  /**
+   * Locality of this API.
+   * type ∈ {'zone','region','global','unspecified'}
+   */
+  static LOCALITY = toApiLocality({
+    regions: ["fr-par", "nl-ams", "pl-waw"]
+  });
   /**
    * Get the Cockpit configuration.
    *
@@ -250,10 +251,7 @@ class RegionalAPI extends API {
     unmarshalGetConfigResponse
   );
   /**
-     * Create a data source. You must specify the data source type upon creation. Available data source types include:
-    - metrics
-    - logs
-    - traces
+     * Create a data source. You must specify the data source name and type (metrics, logs, traces) upon creation.
   The name of the data source will then be used as reference to name the associated Grafana data source.
      *
      * @param request - The request {@link RegionalApiCreateDataSourceRequest}
@@ -287,7 +285,7 @@ class RegionalAPI extends API {
     unmarshalDataSource
   );
   /**
-   * Delete a data source. Delete a given data source, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
+   * Delete a data source. Delete a given data source. Note that this action will permanently delete this data source and any data associated with it.
    *
    * @param request - The request {@link RegionalApiDeleteDataSourceRequest}
    */
@@ -317,15 +315,14 @@ class RegionalAPI extends API {
     unmarshalListDataSourcesResponse
   );
   /**
-     * List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
-  You can list data sources by Project, type and origin.
-     *
-     * @param request - The request {@link RegionalApiListDataSourcesRequest}
-     * @returns A Promise of ListDataSourcesResponse
-     */
+   * List data sources. Retrieve the list of data sources available in the specified region. By default, the data sources returned in the list are ordered by creation date, in ascending order.
+   *
+   * @param request - The request {@link RegionalApiListDataSourcesRequest}
+   * @returns A Promise of ListDataSourcesResponse
+   */
   listDataSources = (request = {}) => enrichForPagination("dataSources", this.pageOfListDataSources, request);
   /**
-   * Update a data source. Update a given data source name, specified by the data source ID.
+   * Update a data source. Update a given data source attributes (name and/or retention_days).
    *
    * @param request - The request {@link RegionalApiUpdateDataSourceRequest}
    * @returns A Promise of DataSource
@@ -345,7 +342,7 @@ class RegionalAPI extends API {
     unmarshalDataSource
   );
   /**
-   * Get data source usage overview. Retrieve the data source usage overview per type for the specified Project.
+   * Get data source usage overview. Retrieve the volume of data ingested for each of your data sources in the specified project and region.
    *
    * @param request - The request {@link RegionalApiGetUsageOverviewRequest}
    * @returns A Promise of UsageOverview
@@ -490,6 +487,23 @@ class RegionalAPI extends API {
     },
     unmarshalAlertManager
   );
+  /**
+   * Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.. Get a detailed count of enabled rules in the specified Project. Includes preconfigured and custom alerting and recording rules.
+   *
+   * @param request - The request {@link RegionalApiGetRulesCountRequest}
+   * @returns A Promise of GetRulesCountResponse
+   */
+  getRulesCount = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/rules/count`,
+      urlParams: urlParams([
+        "project_id",
+        request.projectId ?? this.client.settings.defaultProjectId
+      ])
+    },
+    unmarshalGetRulesCountResponse
+  );
   /**
      * Create a contact point. Contact points are email addresses associated with the default receiver, that the Alert manager sends alerts to.
   The source of the alerts are data sources within the same Project and region as the Alert manager.

package/dist/v1/index.gen.cjs

@@ -28,6 +28,7 @@ exports.unmarshalDataSource = marshalling_gen.unmarshalDataSource;
 exports.unmarshalDisableAlertRulesResponse = marshalling_gen.unmarshalDisableAlertRulesResponse;
 exports.unmarshalEnableAlertRulesResponse = marshalling_gen.unmarshalEnableAlertRulesResponse;
 exports.unmarshalGetConfigResponse = marshalling_gen.unmarshalGetConfigResponse;
+exports.unmarshalGetRulesCountResponse = marshalling_gen.unmarshalGetRulesCountResponse;
 exports.unmarshalGrafana = marshalling_gen.unmarshalGrafana;
 exports.unmarshalGrafanaProductDashboard = marshalling_gen.unmarshalGrafanaProductDashboard;
 exports.unmarshalGrafanaUser = marshalling_gen.unmarshalGrafanaUser;

package/dist/v1/index.gen.d.ts

@@ -1,4 +1,4 @@
 export { GlobalAPI, RegionalAPI, } from './api.gen';
 export * from './marshalling.gen';
-export type { Alert, AlertManager, AlertState, ContactPoint, ContactPointEmail, DataSource, DataSourceOrigin, DataSourceType, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GetConfigResponseRetention, 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, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen';
+export type { Alert, AlertManager, AlertState, 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, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetRulesCountRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, RulesCount, Token, TokenScope, Usage, UsageOverview, UsageUnit, } from './types.gen';
 export * as ValidationRules from './validation-rules.gen';

package/dist/v1/index.gen.js

@@ -1,5 +1,5 @@
 import { GlobalAPI, RegionalAPI } from "./api.gen.js";
-import { marshalGlobalApiCreateGrafanaUserRequest, marshalGlobalApiResetGrafanaUserPasswordRequest, marshalGlobalApiSelectPlanRequest, marshalGlobalApiSyncGrafanaDataSourcesRequest, marshalRegionalApiCreateContactPointRequest, marshalRegionalApiCreateDataSourceRequest, marshalRegionalApiCreateTokenRequest, marshalRegionalApiDeleteContactPointRequest, marshalRegionalApiDisableAlertManagerRequest, marshalRegionalApiDisableAlertRulesRequest, marshalRegionalApiDisableManagedAlertsRequest, marshalRegionalApiEnableAlertManagerRequest, marshalRegionalApiEnableAlertRulesRequest, marshalRegionalApiEnableManagedAlertsRequest, marshalRegionalApiTriggerTestAlertRequest, marshalRegionalApiUpdateContactPointRequest, marshalRegionalApiUpdateDataSourceRequest, unmarshalAlertManager, unmarshalContactPoint, unmarshalDataSource, unmarshalDisableAlertRulesResponse, unmarshalEnableAlertRulesResponse, unmarshalGetConfigResponse, unmarshalGrafana, unmarshalGrafanaProductDashboard, unmarshalGrafanaUser, unmarshalListAlertsResponse, unmarshalListContactPointsResponse, unmarshalListDataSourcesResponse, unmarshalListGrafanaProductDashboardsResponse, unmarshalListGrafanaUsersResponse, unmarshalListPlansResponse, unmarshalListTokensResponse, unmarshalPlan, unmarshalToken, unmarshalUsageOverview } from "./marshalling.gen.js";
+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, unmarshalListTokensResponse, unmarshalPlan, unmarshalToken, unmarshalUsageOverview } from "./marshalling.gen.js";
 import * as validationRules_gen from "./validation-rules.gen.js";
 export {
   GlobalAPI,
@@ -28,6 +28,7 @@ export {
   unmarshalDisableAlertRulesResponse,
   unmarshalEnableAlertRulesResponse,
   unmarshalGetConfigResponse,
+  unmarshalGetRulesCountResponse,
   unmarshalGrafana,
   unmarshalGrafanaProductDashboard,
   unmarshalGrafanaUser,

package/dist/v1/marshalling.gen.cjs

@@ -163,6 +163,33 @@ const unmarshalGetConfigResponse = (data) => {
     productMetricsRetention: data.product_metrics_retention ? unmarshalGetConfigResponseRetention(data.product_metrics_retention) : void 0
   };
 };
+const unmarshalRulesCount = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'RulesCount' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    dataSourceId: data.data_source_id,
+    dataSourceName: data.data_source_name,
+    rulesCount: data.rules_count
+  };
+};
+const unmarshalGetRulesCountResponse = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'GetRulesCountResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    customRulesCount: data.custom_rules_count,
+    preconfiguredRulesCount: data.preconfigured_rules_count,
+    rulesCountByDatasource: sdkClient.unmarshalArrayOfObject(
+      data.rules_count_by_datasource,
+      unmarshalRulesCount
+    )
+  };
+};
 const unmarshalGrafana = (data) => {
   if (!sdkClient.isJSONObject(data)) {
     throw new TypeError(
@@ -433,6 +460,7 @@ exports.unmarshalDataSource = unmarshalDataSource;
 exports.unmarshalDisableAlertRulesResponse = unmarshalDisableAlertRulesResponse;
 exports.unmarshalEnableAlertRulesResponse = unmarshalEnableAlertRulesResponse;
 exports.unmarshalGetConfigResponse = unmarshalGetConfigResponse;
+exports.unmarshalGetRulesCountResponse = unmarshalGetRulesCountResponse;
 exports.unmarshalGrafana = unmarshalGrafana;
 exports.unmarshalGrafanaProductDashboard = unmarshalGrafanaProductDashboard;
 exports.unmarshalGrafanaUser = unmarshalGrafanaUser;

package/dist/v1/marshalling.gen.d.ts

@@ -1,5 +1,5 @@
 import type { DefaultValues } from '@scaleway/sdk-client';
-import type { AlertManager, ContactPoint, DataSource, DisableAlertRulesResponse, EnableAlertRulesResponse, GetConfigResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
+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, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen';
 export declare const unmarshalContactPoint: (data: unknown) => ContactPoint;
 export declare const unmarshalDataSource: (data: unknown) => DataSource;
 export declare const unmarshalGrafanaProductDashboard: (data: unknown) => GrafanaProductDashboard;
@@ -10,6 +10,7 @@ export declare const unmarshalAlertManager: (data: unknown) => AlertManager;
 export declare const unmarshalDisableAlertRulesResponse: (data: unknown) => DisableAlertRulesResponse;
 export declare const unmarshalEnableAlertRulesResponse: (data: unknown) => EnableAlertRulesResponse;
 export declare const unmarshalGetConfigResponse: (data: unknown) => GetConfigResponse;
+export declare const unmarshalGetRulesCountResponse: (data: unknown) => GetRulesCountResponse;
 export declare const unmarshalGrafana: (data: unknown) => Grafana;
 export declare const unmarshalListAlertsResponse: (data: unknown) => ListAlertsResponse;
 export declare const unmarshalListContactPointsResponse: (data: unknown) => ListContactPointsResponse;

package/dist/v1/marshalling.gen.js

@@ -161,6 +161,33 @@ const unmarshalGetConfigResponse = (data) => {
     productMetricsRetention: data.product_metrics_retention ? unmarshalGetConfigResponseRetention(data.product_metrics_retention) : void 0
   };
 };
+const unmarshalRulesCount = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'RulesCount' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    dataSourceId: data.data_source_id,
+    dataSourceName: data.data_source_name,
+    rulesCount: data.rules_count
+  };
+};
+const unmarshalGetRulesCountResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'GetRulesCountResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    customRulesCount: data.custom_rules_count,
+    preconfiguredRulesCount: data.preconfigured_rules_count,
+    rulesCountByDatasource: unmarshalArrayOfObject(
+      data.rules_count_by_datasource,
+      unmarshalRulesCount
+    )
+  };
+};
 const unmarshalGrafana = (data) => {
   if (!isJSONObject(data)) {
     throw new TypeError(
@@ -432,6 +459,7 @@ export {
   unmarshalDisableAlertRulesResponse,
   unmarshalEnableAlertRulesResponse,
   unmarshalGetConfigResponse,
+  unmarshalGetRulesCountResponse,
   unmarshalGrafana,
   unmarshalGrafanaProductDashboard,
   unmarshalGrafanaUser,

package/dist/v1/types.gen.d.ts

@@ -43,6 +43,20 @@ export interface GetConfigResponseRetention {
     maxDays: number;
     defaultDays: number;
 }
+export interface RulesCount {
+    /**
+     * ID of the data source.
+     */
+    dataSourceId: string;
+    /**
+     * Name of the data source.
+     */
+    dataSourceName: string;
+    /**
+     * Total count of rules associated with this data source.
+     */
+    rulesCount: number;
+}
 /**
  * Structure representing an alert.
  */
@@ -148,7 +162,7 @@ export interface DataSource {
      */
     synchronizedWithGrafana: boolean;
     /**
-     * BETA - Duration for which the data will be retained in the data source.
+     * Duration for which the data will be retained in the data source.
      */
     retentionDays: number;
     /**
@@ -334,10 +348,22 @@ export interface AlertManager {
      */
     region: ScwRegion;
 }
+/**
+ * Output returned when alert rules are disabled.
+ */
 export interface DisableAlertRulesResponse {
+    /**
+     * Only newly disabled rules are listed. Rules that were already disabled are not returned in the output.
+     */
     disabledRuleIds: string[];
 }
+/**
+ * Output returned when alert rules are enabled.
+ */
 export interface EnableAlertRulesResponse {
+    /**
+     * Only newly enabled rules are listed. Rules that were already enabled are not returned in the output.
+     */
     enabledRuleIds: string[];
 }
 /**
@@ -365,6 +391,20 @@ export interface GetConfigResponse {
      */
     productLogsRetention?: GetConfigResponseRetention;
 }
+export interface GetRulesCountResponse {
+    /**
+     * Total count of rules grouped by data source.
+     */
+    rulesCountByDatasource: RulesCount[];
+    /**
+     * Total count of preconfigured rules.
+     */
+    preconfiguredRulesCount: number;
+    /**
+     * Total count of custom rules.
+     */
+    customRulesCount: number;
+}
 /**
  * Create a Grafana user.
  */
@@ -669,7 +709,7 @@ export type RegionalApiCreateDataSourceRequest = {
      */
     type?: DataSourceType;
     /**
-     * Default values are 30 days for metrics, 7 days for logs and traces.
+     * Default values are 31 days for metrics, 7 days for logs and traces.
      */
     retentionDays?: number;
 };
@@ -757,7 +797,13 @@ export type RegionalApiDisableAlertRulesRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * ID of the Project.
+     */
     projectId?: string;
+    /**
+     * List of IDs of the rules to enable. If empty, disables all preconfigured rules.
+     */
     ruleIds?: string[];
 };
 /**
@@ -791,7 +837,13 @@ export type RegionalApiEnableAlertRulesRequest = {
      * Region to target. If none is passed will use default region from the config.
      */
     region?: ScwRegion;
+    /**
+     * ID of the Project.
+     */
     projectId?: string;
+    /**
+     * List of IDs of the rules to enable. If empty, enables all preconfigured rules.
+     */
     ruleIds?: string[];
 };
 /**
@@ -842,6 +894,16 @@ export type RegionalApiGetDataSourceRequest = {
      */
     dataSourceId: string;
 };
+export type RegionalApiGetRulesCountRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * ID of the Project to retrieve the rule count for.
+     */
+    projectId?: string;
+};
 /**
  * Get a token.
  */
@@ -938,11 +1000,11 @@ export type RegionalApiListDataSourcesRequest = {
      */
     projectId?: string;
     /**
-     * Origin to filter for, only data sources with matching origin will be returned.
+     * Origin to filter for, only data sources with matching origin will be returned. If omitted, all types will be returned.
      */
     origin?: DataSourceOrigin;
     /**
-     * Types to filter for, only data sources with matching types will be returned.
+     * Types to filter for (metrics, logs, traces), only data sources with matching types will be returned. If omitted, all types will be returned.
      */
     types?: DataSourceType[];
 };
@@ -1028,7 +1090,7 @@ export type RegionalApiUpdateDataSourceRequest = {
      */
     name?: string;
     /**
-     * BETA - Duration for which the data will be retained in the data source.
+     * Duration for which the data will be retained in the data source.
      */
     retentionDays?: number;
 };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-cockpit",
-  "version": "1.3.1",
+  "version": "1.4.0",
   "description": "Scaleway SDK cockpit",
   "license": "Apache-2.0",
   "files": [
@@ -30,13 +30,13 @@
   },
   "dependencies": {
     "@scaleway/random-name": "5.1.1",
-    "@scaleway/sdk-std": "1.0.4"
+    "@scaleway/sdk-std": "1.0.5"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^1.2.3"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "devDependencies": {
-    "@scaleway/sdk-client": "^1.2.3"
+    "@scaleway/sdk-client": "^1.3.0"
   },
   "scripts": {
     "package:check": "pnpm publint",