@scaleway/sdk-cockpit 1.3.0 → 1.3.2

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
@@ -570,7 +567,7 @@ class RegionalAPI extends sdkClient.API {
     path: `/cockpit/v1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/contact-points/delete`
   });
   /**
-   * List alerts. List preconfigured and/or custom alerts for the specified Project.
+   * List alerts. List preconfigured and/or custom alerts for the specified Project and data source.
    *
    * @param request - The request {@link RegionalApiListAlertsRequest}
    * @returns A Promise of ListAlertsResponse

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

@@ -1,5 +1,5 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
-import type { Region as ScwRegion } from '@scaleway/sdk-client';
+import type { ApiLocality } 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';
 /**
  * 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
@@ -252,7 +251,7 @@ export declare class RegionalAPI extends ParentAPI {
      */
     deleteContactPoint: (request?: Readonly<RegionalApiDeleteContactPointRequest>) => Promise<void>;
     /**
-     * List alerts. List preconfigured and/or custom alerts for the specified Project.
+     * List alerts. List preconfigured and/or custom alerts for the specified Project and data source.
      *
      * @param request - The request {@link RegionalApiListAlertsRequest}
      * @returns A Promise of ListAlertsResponse

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, 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
@@ -568,7 +565,7 @@ class RegionalAPI extends API {
     path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/alert-manager/contact-points/delete`
   });
   /**
-   * List alerts. List preconfigured and/or custom alerts for the specified Project.
+   * List alerts. List preconfigured and/or custom alerts for the specified Project and data source.
    *
    * @param request - The request {@link RegionalApiListAlertsRequest}
    * @returns A Promise of ListAlertsResponse

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

@@ -148,7 +148,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 +334,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[];
 }
 /**
@@ -669,7 +681,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 +769,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 +809,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[];
 };
 /**
@@ -888,7 +912,7 @@ export type RegionalApiListAlertsRequest = {
      */
     state?: AlertState;
     /**
-     * If omitted, only alerts from the default scaleway data source will be listed.
+     * If omitted, only alerts from the default Scaleway metrics data source will be listed.
      */
     dataSourceId?: string;
 };
@@ -938,11 +962,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 +1052,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.0",
+  "version": "1.3.2",
   "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",