@scaleway/sdk 2.72.0 → 2.73.0

package/dist/api/cockpit/v1/api.gen.js

@@ -9,13 +9,12 @@ const jsonContentHeaders = {
 };
 class GlobalAPI extends API$1 {
   /**
-   * Get your Cockpit's Grafana. Retrieve information on your Cockpit's Grafana,
-   * specified by the ID of the Project the Cockpit belongs to. The output
-   * returned displays the URL to access your Cockpit's Grafana.
-   *
-   * @param request - The request {@link GlobalApiGetGrafanaRequest}
-   * @returns A Promise of Grafana
-   */
+     * Get your Cockpit's Grafana. Retrieve information on your Cockpit's Grafana, specified by the ID of the Project the Cockpit belongs to.
+  The output returned displays the URL to access your Cockpit's Grafana.
+     *
+     * @param request - The request {@link GlobalApiGetGrafanaRequest}
+     * @returns A Promise of Grafana
+     */
   getGrafana = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -28,9 +27,7 @@ class GlobalAPI extends API$1 {
     unmarshalGrafana
   );
   /**
-   * Synchronize Grafana data sources. Trigger the synchronization of all your
-   * data sources and the alert manager in the relevant regions. The alert
-   * manager will only be synchronized if you have enabled it.
+   * Synchronize Grafana data sources. Trigger the synchronization of all your data sources and the alert manager in the relevant regions. The alert manager will only be synchronized if you have enabled it.
    *
    * @param request - The request {@link GlobalApiSyncGrafanaDataSourcesRequest}
    */
@@ -46,16 +43,12 @@ class GlobalAPI extends API$1 {
     path: `/cockpit/v1/grafana/sync-data-sources`
   });
   /**
-   * 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.
-   *
-   * @param request - The request {@link GlobalApiCreateGrafanaUserRequest}
-   * @returns A Promise of GrafanaUser
-   */
+     * 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.
+     *
+     * @param request - The request {@link GlobalApiCreateGrafanaUserRequest}
+     * @returns A Promise of GrafanaUser
+     */
   createGrafanaUser = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -90,18 +83,14 @@ class GlobalAPI extends API$1 {
     unmarshalListGrafanaUsersResponse
   );
   /**
-   * 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.
+   * 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.
    *
    * @param request - The request {@link GlobalApiListGrafanaUsersRequest}
    * @returns A Promise of ListGrafanaUsersResponse
    */
   listGrafanaUsers = (request = {}) => enrichForPagination("grafanaUsers", this.pageOfListGrafanaUsers, request);
   /**
-   * 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.
+   * 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.
    *
    * @param request - The request {@link GlobalApiDeleteGrafanaUserRequest}
    */
@@ -114,15 +103,12 @@ class GlobalAPI extends API$1 {
     ])
   });
   /**
-   * 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.
-   *
-   * @param request - The request
-   *   {@link GlobalApiResetGrafanaUserPasswordRequest}
-   * @returns A Promise of GrafanaUser
-   */
+     * 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.
+     *
+     * @param request - The request {@link GlobalApiResetGrafanaUserPasswordRequest}
+     * @returns A Promise of GrafanaUser
+     */
   resetGrafanaUserPassword = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -157,11 +143,9 @@ class GlobalAPI extends API$1 {
     unmarshalListGrafanaProductDashboardsResponse
   );
   /**
-   * List Scaleway resources dashboards. Retrieve a list of available dashboards
-   * in Grafana, for all Scaleway resources which are integrated with Cockpit.
+   * List Scaleway resources dashboards. Retrieve a list of available dashboards in Grafana, for all Scaleway resources which are integrated with Cockpit.
    *
-   * @param request - The request
-   *   {@link GlobalApiListGrafanaProductDashboardsRequest}
+   * @param request - The request {@link GlobalApiListGrafanaProductDashboardsRequest}
    * @returns A Promise of ListGrafanaProductDashboardsResponse
    */
   listGrafanaProductDashboards = (request = {}) => enrichForPagination(
@@ -170,12 +154,9 @@ class GlobalAPI extends API$1 {
     request
   );
   /**
-   * Get Scaleway resource dashboard. Retrieve information about the dashboard
-   * of a Scaleway resource in Grafana, specified by the ID of the Project the
-   * Cockpit belongs to, and the name of the dashboard.
+   * Get Scaleway resource dashboard. Retrieve information about the dashboard of a Scaleway resource in Grafana, specified by the ID of the Project the Cockpit belongs to, and the name of the dashboard.
    *
-   * @param request - The request
-   *   {@link GlobalApiGetGrafanaProductDashboardRequest}
+   * @param request - The request {@link GlobalApiGetGrafanaProductDashboardRequest}
    * @returns A Promise of GrafanaProductDashboard
    */
   getGrafanaProductDashboard = (request) => this.client.fetch(
@@ -205,24 +186,22 @@ class GlobalAPI extends API$1 {
     unmarshalListPlansResponse
   );
   /**
-   * List plan types. Retrieve a list of available pricing plan types.
-   * Deprecated, retention is now managed at the data source level.
-   *
-   * @deprecated
-   * @param request - The request {@link GlobalApiListPlansRequest}
-   * @returns A Promise of ListPlansResponse
-   */
+     * List plan types. Retrieve a list of available pricing plan types.
+  Deprecated, retention is now managed at the data source level.
+     *
+     * @deprecated
+     * @param request - The request {@link GlobalApiListPlansRequest}
+     * @returns A Promise of ListPlansResponse
+     */
   listPlans = (request = {}) => enrichForPagination("plans", this.pageOfListPlans, request);
   /**
-   * 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
-   * @param request - The request {@link GlobalApiSelectPlanRequest}
-   * @returns A Promise of Plan
-   */
+     * 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
+     * @param request - The request {@link GlobalApiSelectPlanRequest}
+     * @returns A Promise of Plan
+     */
   selectPlan = (request = {}) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -235,14 +214,13 @@ class GlobalAPI extends API$1 {
     unmarshalPlan
   );
   /**
-   * 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
-   * @param request - The request {@link GlobalApiGetCurrentPlanRequest}
-   * @returns A Promise of 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
+     * @param request - The request {@link GlobalApiGetCurrentPlanRequest}
+     * @returns A Promise of Plan
+     */
   getCurrentPlan = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -276,17 +254,15 @@ class RegionalAPI extends API$1 {
     unmarshalGetConfigResponse
   );
   /**
-   * Create a data source. You must specify the data source type upon creation.
-   * Available data source types include:
-   *
-   * - Metrics
-   * - Logs
-   * - Traces 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}
-   * @returns A Promise of DataSource
-   */
+     * Create a data source. You must specify the data source type upon creation. Available data source types include:
+    - metrics
+    - logs
+    - traces
+  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}
+     * @returns A Promise of DataSource
+     */
   createDataSource = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -302,9 +278,7 @@ class RegionalAPI extends API$1 {
     unmarshalDataSource
   );
   /**
-   * Get a data source. Retrieve information about a given data source,
-   * specified by the data source ID. The data source's information such as its
-   * name, type, URL, origin, and retention period, is returned.
+   * Get a data source. Retrieve information about a given data source, specified by the data source ID. The data source's information such as its name, type, URL, origin, and retention period, is returned.
    *
    * @param request - The request {@link RegionalApiGetDataSourceRequest}
    * @returns A Promise of DataSource
@@ -317,9 +291,7 @@ class RegionalAPI extends API$1 {
     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, specified by the data source ID. Note that deleting a data source is irreversible, and cannot be undone.
    *
    * @param request - The request {@link RegionalApiDeleteDataSourceRequest}
    */
@@ -349,18 +321,15 @@ class RegionalAPI extends API$1 {
     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.
+  You can list data sources by Project, type and origin.
+     *
+     * @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 name, specified by the data source ID.
    *
    * @param request - The request {@link RegionalApiUpdateDataSourceRequest}
    * @returns A Promise of DataSource
@@ -380,8 +349,7 @@ class RegionalAPI extends API$1 {
     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 data source usage overview per type for the specified Project.
    *
    * @param request - The request {@link RegionalApiGetUsageOverviewRequest}
    * @returns A Promise of UsageOverview
@@ -401,15 +369,12 @@ class RegionalAPI extends API$1 {
     unmarshalUsageOverview
   );
   /**
-   * Create a token. Give your token the relevant scopes to ensure it has the
-   * right permissions to interact with your data sources and the Alert manager.
-   * Make sure that you create your token in the same regions as the data
-   * sources you want to use it for. Upon creation, your token's secret key
-   * display only once. Make sure that you save it.
-   *
-   * @param request - The request {@link RegionalApiCreateTokenRequest}
-   * @returns A Promise of Token
-   */
+     * Create a token. Give your token the relevant scopes to ensure it has the right permissions to interact with your data sources and the Alert manager. Make sure that you create your token in the same regions as the data sources you want to use it for.
+  Upon creation, your token's secret key display only once. Make sure that you save it.
+     *
+     * @param request - The request {@link RegionalApiCreateTokenRequest}
+     * @returns A Promise of Token
+     */
   createToken = (request) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -442,17 +407,15 @@ class RegionalAPI extends API$1 {
     unmarshalListTokensResponse
   );
   /**
-   * List tokens. Retrieve a list of all tokens in the specified region. By
-   * default, tokens returned in the list are ordered by creation date, in
-   * ascending order. You can filter tokens by Project ID and token scopes.
-   *
-   * @param request - The request {@link RegionalApiListTokensRequest}
-   * @returns A Promise of ListTokensResponse
-   */
+     * List tokens. Retrieve a list of all tokens in the specified region. By default, tokens returned in the list are ordered by creation date, in ascending order.
+  You can filter tokens by Project ID and token scopes.
+     *
+     * @param request - The request {@link RegionalApiListTokensRequest}
+     * @returns A Promise of ListTokensResponse
+     */
   listTokens = (request = {}) => enrichForPagination("tokens", this.pageOfListTokens, request);
   /**
-   * Get a token. Retrieve information about a given token, specified by the
-   * token ID. The token's information such as its scopes, is returned.
+   * Get a token. Retrieve information about a given token, specified by the token ID. The token's information such as its scopes, is returned.
    *
    * @param request - The request {@link RegionalApiGetTokenRequest}
    * @returns A Promise of Token
@@ -465,8 +428,7 @@ class RegionalAPI extends API$1 {
     unmarshalToken
   );
   /**
-   * Delete a token. Delete a given token, specified by the token ID. Deleting a
-   * token is irreversible and cannot be undone.
+   * Delete a token. Delete a given token, specified by the token ID. Deleting a token is irreversible and cannot be undone.
    *
    * @param request - The request {@link RegionalApiDeleteTokenRequest}
    */
@@ -475,14 +437,12 @@ class RegionalAPI extends API$1 {
     path: `/cockpit/v1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/tokens/${validatePathParam("tokenId", request.tokenId)}`
   });
   /**
-   * 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.
-   *
-   * @param request - The request {@link RegionalApiGetAlertManagerRequest}
-   * @returns A Promise of AlertManager
-   */
+     * 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.
+     *
+     * @param request - The request {@link RegionalApiGetAlertManagerRequest}
+     * @returns A Promise of AlertManager
+     */
   getAlertManager = (request = {}) => this.client.fetch(
     {
       method: "GET",
@@ -495,10 +455,7 @@ class RegionalAPI extends API$1 {
     unmarshalAlertManager
   );
   /**
-   * Enable the Alert manager. Enabling the Alert manager allows you to enable
-   * managed alerts and create contact points in the specified Project and
-   * region, to be notified when your Scaleway resources may require your
-   * attention.
+   * Enable the Alert manager. Enabling the Alert manager allows you to enable managed alerts and create contact points in the specified Project and region, to be notified when your Scaleway resources may require your attention.
    *
    * @param request - The request {@link RegionalApiEnableAlertManagerRequest}
    * @returns A Promise of AlertManager
@@ -518,9 +475,7 @@ class RegionalAPI extends API$1 {
     unmarshalAlertManager
   );
   /**
-   * Disable the Alert manager. Disabling the Alert manager deletes the contact
-   * points you have created and disables managed alerts in the specified
-   * Project and region.
+   * Disable the Alert manager. Disabling the Alert manager deletes the contact points you have created and disables managed alerts in the specified Project and region.
    *
    * @param request - The request {@link RegionalApiDisableAlertManagerRequest}
    * @returns A Promise of AlertManager
@@ -540,16 +495,13 @@ class RegionalAPI extends API$1 {
     unmarshalAlertManager
   );
   /**
-   * 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. If you need to receive alerts for other receivers, you can create
-   * additional contact points and receivers in Grafana. Make sure that you
-   * select the Scaleway Alert manager.
-   *
-   * @param request - The request {@link RegionalApiCreateContactPointRequest}
-   * @returns A Promise of ContactPoint
-   */
+     * 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.
+  If you need to receive alerts for other receivers, you can create additional contact points and receivers in Grafana. Make sure that you select the Scaleway Alert manager.
+     *
+     * @param request - The request {@link RegionalApiCreateContactPointRequest}
+     * @returns A Promise of ContactPoint
+     */
   createContactPoint = (request = {}) => this.client.fetch(
     {
       body: JSON.stringify(
@@ -583,9 +535,7 @@ class RegionalAPI extends API$1 {
     unmarshalListContactPointsResponse
   );
   /**
-   * List contact points. Retrieve a list of contact points for the specified
-   * Project. The response lists all contact points and receivers created in
-   * Grafana or via the API.
+   * List contact points. Retrieve a list of contact points for the specified Project. The response lists all contact points and receivers created in Grafana or via the API.
    *
    * @param request - The request {@link RegionalApiListContactPointsRequest}
    * @returns A Promise of ListContactPointsResponse
@@ -606,8 +556,7 @@ class RegionalAPI extends API$1 {
     unmarshalContactPoint
   );
   /**
-   * Delete a contact point. Delete a contact point associated with the default
-   * receiver.
+   * Delete a contact point. Delete a contact point associated with the default receiver.
    *
    * @param request - The request {@link RegionalApiDeleteContactPointRequest}
    */
@@ -623,8 +572,7 @@ class RegionalAPI extends API$1 {
     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.
    *
    * @param request - The request {@link RegionalApiListAlertsRequest}
    * @returns A Promise of ListAlertsResponse
@@ -646,9 +594,7 @@ class RegionalAPI extends API$1 {
     unmarshalListAlertsResponse
   );
   /**
-   * Enable managed alerts. Enable the sending of managed alerts for the
-   * specified Project. Managed alerts are predefined alerts that apply to
-   * Scaleway recources integrated with Cockpit by default.
+   * Enable managed alerts. Enable the sending of managed alerts for the specified Project. Managed alerts are predefined alerts that apply to Scaleway recources integrated with Cockpit by default.
    *
    * @param request - The request {@link RegionalApiEnableManagedAlertsRequest}
    * @returns A Promise of AlertManager
@@ -668,8 +614,7 @@ class RegionalAPI extends API$1 {
     unmarshalAlertManager
   );
   /**
-   * Disable managed alerts. Disable the sending of managed alerts for the
-   * specified Project.
+   * Disable managed alerts. Disable the sending of managed alerts for the specified Project.
    *
    * @param request - The request {@link RegionalApiDisableManagedAlertsRequest}
    * @returns A Promise of AlertManager
@@ -689,8 +634,7 @@ class RegionalAPI extends API$1 {
     unmarshalAlertManager
   );
   /**
-   * Trigger a test alert. Send a test alert to the Alert manager to make sure
-   * your contact points get notified.
+   * Trigger a test alert. Send a test alert to the Alert manager to make sure your contact points get notified.
    *
    * @param request - The request {@link RegionalApiTriggerTestAlertRequest}
    */