@scaleway/sdk-cockpit 1.6.0 → 2.1.1

package/README.md

@@ -0,0 +1,96 @@
+# @scaleway/sdk-cockpit
+
+[![npm version](https://img.shields.io/npm/v/@scaleway/sdk-cockpit.svg)](https://www.npmjs.com/package/@scaleway/sdk-cockpit)
+[![npm downloads](https://img.shields.io/npm/dm/@scaleway/sdk-cockpit.svg)](https://www.npmjs.com/package/@scaleway/sdk-cockpit)
+[![license](https://img.shields.io/npm/l/@scaleway/sdk-cockpit.svg)](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE)
+
+Scaleway SDK for Cockpit API.
+
+> **Note**  
+> This is an automatically generated package that is part of the [Scaleway SDK for JavaScript](https://github.com/scaleway/scaleway-sdk-js).
+
+## Installation
+
+```bash
+npm install @scaleway/sdk-cockpit @scaleway/sdk-client
+```
+
+or with pnpm:
+
+```bash
+pnpm add @scaleway/sdk-cockpit @scaleway/sdk-client
+```
+
+or with yarn:
+
+```bash
+yarn add @scaleway/sdk-cockpit @scaleway/sdk-client
+```
+
+## Getting Started
+
+You'll need a pair of access and secret keys to connect to Scaleway API. Please check the [documentation](https://www.scaleway.com/en/docs/identity-and-access-management/iam/how-to/create-api-keys/) on how to retrieve them.
+
+### Basic Usage
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { Cockpit } from '@scaleway/sdk-cockpit'
+
+const client = createClient({
+  accessKey: 'SCWXXXXXXXXXXXXXXXXX',
+  secretKey: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultProjectId: 'xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx',
+  defaultRegion: 'fr-par',
+  defaultZone: 'fr-par-1',
+})
+
+const api = new Cockpit.v1.API(client)
+
+// Use the API
+// Example: await api.listServers()
+```
+
+### Using Configuration Loader
+
+For a simpler setup, you can load credentials from the configuration file or environment variables:
+
+```typescript
+import { createClient } from '@scaleway/sdk-client'
+import { loadProfileFromConfigurationFile } from '@scaleway/configuration-loader'
+import { Cockpit } from '@scaleway/sdk-cockpit'
+
+const profile = loadProfileFromConfigurationFile()
+const client = createClient(profile)
+const api = new Cockpit.v1.API(client)
+```
+
+## Documentation
+
+- 📚 [Scaleway SDK Reference Documentation](https://scaleway.github.io/scaleway-sdk-js)
+- 🌐 [Scaleway Cockpit API Documentation](https://www.scaleway.com/en/developers/api/cockpit/)
+- 📖 [Main Repository](https://github.com/scaleway/scaleway-sdk-js)
+- 💡 [Example Projects](https://github.com/scaleway/scaleway-sdk-js/tree/master/examples)
+
+## Features
+
+- ✅ Full TypeScript support with complete type definitions
+- ✅ Promise-based API
+- ✅ Automatic pagination helpers
+- ✅ Built-in error handling
+- ✅ Compatible with Node.js ≥ 20
+
+## Support
+
+We love feedback! Feel free to reach us on:
+- [Scaleway Slack community](https://slack.scaleway.com/) - Join us on [#opensource](https://scaleway-community.slack.com/app_redirect?channel=opensource)
+- [GitHub Issues](https://github.com/scaleway/scaleway-sdk-js/issues)
+
+## Contributing
+
+This repository is at its early stage and is still in active development. If you are looking for a way to contribute, please read [CONTRIBUTING.md](https://github.com/scaleway/scaleway-sdk-js/blob/master/CONTRIBUTING.md).
+
+## License
+
+This project is Apache 2.0 licensed. See the [LICENSE](https://github.com/scaleway/scaleway-sdk-js/blob/master/LICENSE) file for details.
+

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

@@ -1,6 +1,6 @@
-import { API as ParentAPI } from '@scaleway/sdk-client';
 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, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetRulesCountRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, Token, UsageOverview } from './types.gen.js';
+import { API as ParentAPI } 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, ListProductsResponse, ListTokensResponse, Plan, 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, Token, UsageOverview } from './types.gen.js';
 /**
  * Cockpit Global API.
 
@@ -22,17 +22,21 @@ export declare class GlobalAPI extends ParentAPI {
      */
     syncGrafanaDataSources: (request?: Readonly<GlobalApiSyncGrafanaDataSourcesRequest>) => Promise<void>;
     /**
-     * Create a Grafana user. 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.
+     * (Deprecated) EOL 2026-01-20. Create a Grafana user
+  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.
   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.
      *
+     * @deprecated
      * @param request - The request {@link GlobalApiCreateGrafanaUserRequest}
      * @returns A Promise of GrafanaUser
      */
     createGrafanaUser: (request: Readonly<GlobalApiCreateGrafanaUserRequest>) => Promise<GrafanaUser>;
     protected pageOfListGrafanaUsers: (request?: Readonly<GlobalApiListGrafanaUsersRequest>) => Promise<ListGrafanaUsersResponse>;
     /**
-     * List Grafana users. List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
+     * (Deprecated) EOL 2026-01-20. List Grafana users
+  List all Grafana users created in your Cockpit's Grafana. By default, the Grafana users returned in the list are ordered in ascending order.
      *
+     * @deprecated
      * @param request - The request {@link GlobalApiListGrafanaUsersRequest}
      * @returns A Promise of ListGrafanaUsersResponse
      */
@@ -41,15 +45,19 @@ export declare class GlobalAPI extends ParentAPI {
         [Symbol.asyncIterator]: () => AsyncGenerator<GrafanaUser[], void, void>;
     };
     /**
-     * Delete a Grafana user. 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.
+     * (Deprecated) EOL 2026-01-20. Delete a Grafana user
+  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.
      *
+     * @deprecated
      * @param request - The request {@link GlobalApiDeleteGrafanaUserRequest}
      */
     deleteGrafanaUser: (request: Readonly<GlobalApiDeleteGrafanaUserRequest>) => Promise<void>;
     /**
-     * Reset a Grafana user password. 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.
+     * (Deprecated) EOL 2026-01-20. Reset a Grafana user password
+  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.
   A new password regenerates and only displays once. Make sure that you save it.
      *
+     * @deprecated
      * @param request - The request {@link GlobalApiResetGrafanaUserPasswordRequest}
      * @returns A Promise of GrafanaUser
      */
@@ -75,7 +83,7 @@ export declare class GlobalAPI extends ParentAPI {
     protected pageOfListPlans: (request?: Readonly<GlobalApiListPlansRequest>) => Promise<ListPlansResponse>;
     /**
      * List plan types. Retrieve a list of available pricing plan types.
-  Deprecated: retention is now managed at the data source level.
+  Deprecated due to retention now being managed at the data source level.
      *
      * @deprecated
      * @param request - The request {@link GlobalApiListPlansRequest}
@@ -87,7 +95,7 @@ export declare class GlobalAPI extends ParentAPI {
     };
     /**
      * 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.
-  Deprecated: retention is now managed at the data source level.
+  Deprecated due to retention now being managed at the data source level.
      *
      * @deprecated
      * @param request - The request {@link GlobalApiSelectPlanRequest}
@@ -96,7 +104,7 @@ export declare class GlobalAPI extends ParentAPI {
     selectPlan: (request?: Readonly<GlobalApiSelectPlanRequest>) => Promise<Plan>;
     /**
      * Get current plan. Retrieve a pricing plan for the given Project, specified by the ID of the Project.
-  Deprecated: retention is now managed at the data source level.
+  Deprecated due to retention now being managed at the data source level.
      *
      * @deprecated
      * @param request - The request {@link GlobalApiGetCurrentPlanRequest}
@@ -201,6 +209,17 @@ export declare class RegionalAPI extends ParentAPI {
      * @param request - The request {@link RegionalApiDeleteTokenRequest}
      */
     deleteToken: (request: Readonly<RegionalApiDeleteTokenRequest>) => Promise<void>;
+    protected pageOfListProducts: (request?: Readonly<RegionalApiListProductsRequest>) => Promise<ListProductsResponse>;
+    /**
+     * List all Scaleway products that send metrics and/or logs to Cockpit.. List all Scaleway products that send metrics and/or logs to Cockpit.
+     *
+     * @param request - The request {@link RegionalApiListProductsRequest}
+     * @returns A Promise of ListProductsResponse
+     */
+    listProducts: (request?: Readonly<RegionalApiListProductsRequest>) => Promise<ListProductsResponse> & {
+        all: () => Promise<import("./types.gen.js").Product[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").Product[], void, void>;
+    };
     /**
      * Get the Alert manager. Retrieve information about the Alert manager which is unique per Project and region. By default the Alert manager is disabled.
   The output returned displays a URL to access the Alert manager, and whether the Alert manager and managed alerts are enabled.
@@ -224,7 +243,7 @@ export declare class RegionalAPI extends ParentAPI {
      */
     disableAlertManager: (request?: Readonly<RegionalApiDisableAlertManagerRequest>) => Promise<AlertManager>;
     /**
-     * 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.. 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.
+     * 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.
      *
      * @param request - The request {@link RegionalApiGetRulesCountRequest}
      * @returns A Promise of GetRulesCountResponse
@@ -264,6 +283,22 @@ export declare class RegionalAPI extends ParentAPI {
      * @returns A Promise of ListAlertsResponse
      */
     listAlerts: (request?: Readonly<RegionalApiListAlertsRequest>) => Promise<ListAlertsResponse>;
+    /**
+     * 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.
+     *
+     * @deprecated
+     * @param request - The request {@link RegionalApiEnableManagedAlertsRequest}
+     * @returns A Promise of AlertManager
+     */
+    enableManagedAlerts: (request?: Readonly<RegionalApiEnableManagedAlertsRequest>) => Promise<AlertManager>;
+    /**
+     * Disable managed alerts. Disable the sending of managed alerts for the specified Project.
+     *
+     * @deprecated
+     * @param request - The request {@link RegionalApiDisableManagedAlertsRequest}
+     * @returns A Promise of AlertManager
+     */
+    disableManagedAlerts: (request?: Readonly<RegionalApiDisableManagedAlertsRequest>) => Promise<AlertManager>;
     /**
      * Enable preconfigured alert rules. Enable alert rules from the list of available preconfigured rules.
      *