@scaleway/sdk-cockpit 2.1.1 → 2.2.1

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

@@ -1,6 +1,6 @@
-import type { ApiLocality } from '@scaleway/sdk-client';
+import type { ApiLocality, WaitForOptions } from '@scaleway/sdk-client';
 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';
+import type { AlertManager, ContactPoint, DataSource, DisableAlertRulesResponse, EnableAlertRulesResponse, Exporter, GetConfigResponse, GetRulesCountResponse, GlobalApiCreateGrafanaUserRequest, GlobalApiDeleteGrafanaUserRequest, GlobalApiGetCurrentPlanRequest, GlobalApiGetGrafanaProductDashboardRequest, GlobalApiGetGrafanaRequest, GlobalApiListGrafanaProductDashboardsRequest, GlobalApiListGrafanaUsersRequest, GlobalApiListPlansRequest, GlobalApiResetGrafanaUserPasswordRequest, GlobalApiSelectPlanRequest, GlobalApiSyncGrafanaDataSourcesRequest, Grafana, GrafanaProductDashboard, GrafanaUser, ListAlertsResponse, ListContactPointsResponse, ListDataSourcesResponse, ListExportersResponse, ListGrafanaProductDashboardsResponse, ListGrafanaUsersResponse, ListPlansResponse, ListProductsResponse, ListTokensResponse, Plan, RegionalApiCreateContactPointRequest, RegionalApiCreateDataSourceRequest, RegionalApiCreateExporterRequest, RegionalApiCreateTokenRequest, RegionalApiDeleteContactPointRequest, RegionalApiDeleteDataSourceRequest, RegionalApiDeleteExporterRequest, RegionalApiDeleteTokenRequest, RegionalApiDisableAlertManagerRequest, RegionalApiDisableAlertRulesRequest, RegionalApiDisableManagedAlertsRequest, RegionalApiEnableAlertManagerRequest, RegionalApiEnableAlertRulesRequest, RegionalApiEnableManagedAlertsRequest, RegionalApiGetAlertManagerRequest, RegionalApiGetConfigRequest, RegionalApiGetDataSourceRequest, RegionalApiGetExporterRequest, RegionalApiGetRulesCountRequest, RegionalApiGetTokenRequest, RegionalApiGetUsageOverviewRequest, RegionalApiListAlertsRequest, RegionalApiListContactPointsRequest, RegionalApiListDataSourcesRequest, RegionalApiListExportersRequest, RegionalApiListProductsRequest, RegionalApiListTokensRequest, RegionalApiTriggerTestAlertRequest, RegionalApiUpdateContactPointRequest, RegionalApiUpdateDataSourceRequest, RegionalApiUpdateExporterRequest, Token, UsageOverview } from './types.gen.js';
 /**
  * Cockpit Global API.
 
@@ -130,6 +130,57 @@ export declare class RegionalAPI extends ParentAPI {
      * @returns A Promise of GetConfigResponse
      */
     getConfig: (request?: Readonly<RegionalApiGetConfigRequest>) => Promise<GetConfigResponse>;
+    /**
+     * Create a data export. Create an export to send your metrics/logs from a Scaleway data source to an external destination.
+  Current supported destination for data exports are Datadog and OTLP endpoints.
+  This feature is in Beta phase. During Beta phase, exporter can take up to 30 min to be effectively active.
+     *
+     * @param request - The request {@link RegionalApiCreateExporterRequest}
+     * @returns A Promise of Exporter
+     */
+    createExporter: (request: Readonly<RegionalApiCreateExporterRequest>) => Promise<Exporter>;
+    protected pageOfListExporters: (request?: Readonly<RegionalApiListExportersRequest>) => Promise<ListExportersResponse>;
+    /**
+     * List data exports. List all data exports within a given Scaleway Project, specified by its ID.
+  Optionally, specify a Scaleway data source ID to retrieve only data exports associated with that data source.
+     *
+     * @param request - The request {@link RegionalApiListExportersRequest}
+     * @returns A Promise of ListExportersResponse
+     */
+    listExporters: (request?: Readonly<RegionalApiListExportersRequest>) => Promise<ListExportersResponse> & {
+        all: () => Promise<Exporter[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Exporter[], void, void>;
+    };
+    /**
+     * Get a data export. Retrieve information about a given data export, specified by its ID.
+     *
+     * @param request - The request {@link RegionalApiGetExporterRequest}
+     * @returns A Promise of Exporter
+     */
+    getExporter: (request: Readonly<RegionalApiGetExporterRequest>) => Promise<Exporter>;
+    /**
+     * Waits for {@link Exporter} to be in a final state.
+     *
+     * @param request - The request {@link RegionalApiGetExporterRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Exporter
+     */
+    waitForExporter: (request: Readonly<RegionalApiGetExporterRequest>, options?: Readonly<WaitForOptions<Exporter>>) => Promise<Exporter>;
+    /**
+     * Delete a data export. Delete a given data export, specified by its ID.
+  Note that this action will immediatly and permanently delete this data exports.
+     *
+     * @param request - The request {@link RegionalApiDeleteExporterRequest}
+     */
+    deleteExporter: (request: Readonly<RegionalApiDeleteExporterRequest>) => Promise<void>;
+    /**
+     * Update a data export. Update a data export attributes. Changes are effective immediatly even during Beta phase.
+  Note that you can not change the data source linked to the export. If you need to do so, you will need to re-create the export.
+     *
+     * @param request - The request {@link RegionalApiUpdateExporterRequest}
+     * @returns A Promise of Exporter
+     */
+    updateExporter: (request: Readonly<RegionalApiUpdateExporterRequest>) => Promise<Exporter>;
     /**
      * 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.
@@ -211,7 +262,9 @@ export declare class RegionalAPI extends ParentAPI {
     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.
+     * List Scaleway products. List all Scaleway products that send metrics and/or logs to Cockpit.
+  Note that all of those products send at least metrics, but only a subset send logs to Cockpit.
+  For more information, see https://www.scaleway.com/en/docs/cockpit/reference-content/cockpit-product-integration/.
      *
      * @param request - The request {@link RegionalApiListProductsRequest}
      * @returns A Promise of ListProductsResponse