@scaleway/sdk 2.73.0 → 2.75.0

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

@@ -1,486 +0,0 @@
-import "../../../client/dist/internal/logger/index.js";
-import { waitForResource } from "../../../client/dist/internal/async/interval-retrier.js";
-import { API as API$1 } from "../../../client/dist/scw/api.js";
-import { urlParams, validatePathParam } from "../../../client/dist/helpers/marshalling.js";
-import "../../../client/dist/vendor/base64/index.js";
-import { enrichForPagination } from "../../../client/dist/scw/fetch/resource-paginator.js";
-import { COCKPIT_TRANSIENT_STATUSES } from "./content.gen.js";
-import { marshalActivateCockpitRequest, unmarshalCockpit, unmarshalCockpitMetrics, marshalDeactivateCockpitRequest, marshalCreateDatasourceRequest, unmarshalDatasource, unmarshalListDatasourcesResponse, marshalCreateTokenRequest, unmarshalToken, unmarshalListTokensResponse, marshalCreateContactPointRequest, unmarshalContactPoint, unmarshalListContactPointsResponse, marshalDeleteContactPointRequest, marshalEnableManagedAlertsRequest, marshalDisableManagedAlertsRequest, marshalTriggerTestAlertRequest, marshalCreateGrafanaUserRequest, unmarshalGrafanaUser, unmarshalListGrafanaUsersResponse, marshalDeleteGrafanaUserRequest, marshalResetGrafanaUserPasswordRequest, unmarshalListPlansResponse, marshalSelectPlanRequest, unmarshalSelectPlanResponse, unmarshalListGrafanaProductDashboardsResponse, unmarshalGrafanaProductDashboard } from "./marshalling.gen.js";
-const jsonContentHeaders = {
-  "Content-Type": "application/json; charset=utf-8"
-};
-class API extends API$1 {
-  /**
-   * Activate the Cockpit of a given Project specified by the Project ID.
-   *
-   * @param request - The request {@link ActivateCockpitRequest}
-   * @returns A Promise of Cockpit
-   */
-  activateCockpit = (request = {}) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalActivateCockpitRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/activate`
-    },
-    unmarshalCockpit
-  );
-  /**
-   * Retrieve the Cockpit of a given Project specified by the Project ID.
-   *
-   * @param request - The request {@link GetCockpitRequest}
-   * @returns A Promise of Cockpit
-   */
-  getCockpit = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/cockpit`,
-      urlParams: urlParams([
-        "project_id",
-        request.projectId ?? this.client.settings.defaultProjectId
-      ])
-    },
-    unmarshalCockpit
-  );
-  /**
-   * Waits for {@link Cockpit} to be in a final state.
-   *
-   * @param request - The request {@link GetCockpitRequest}
-   * @param options - The waiting options
-   * @returns A Promise of Cockpit
-   */
-  waitForCockpit = (request = {}, options) => waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(!COCKPIT_TRANSIENT_STATUSES.includes(res.status))),
-    this.getCockpit,
-    request,
-    options
-  );
-  /**
-   * Retrieve metrics from your Cockpit specified by the ID of the Project the
-   * Cockpit belongs to.
-   *
-   * @param request - The request {@link GetCockpitMetricsRequest}
-   * @returns A Promise of CockpitMetrics
-   */
-  getCockpitMetrics = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/cockpit/metrics`,
-      urlParams: urlParams(
-        ["end_date", request.endDate],
-        ["metric_name", request.metricName],
-        [
-          "project_id",
-          request.projectId ?? this.client.settings.defaultProjectId
-        ],
-        ["start_date", request.startDate]
-      )
-    },
-    unmarshalCockpitMetrics
-  );
-  /**
-   * Deactivate the Cockpit of a given Project specified by the Project ID.
-   *
-   * @param request - The request {@link DeactivateCockpitRequest}
-   * @returns A Promise of Cockpit
-   */
-  deactivateCockpit = (request = {}) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalDeactivateCockpitRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/deactivate`
-    },
-    unmarshalCockpit
-  );
-  /**
-   * Create a data source for a given Project specified by the Project ID and
-   * the data source type.
-   *
-   * @param request - The request {@link CreateDatasourceRequest}
-   * @returns A Promise of Datasource
-   */
-  createDatasource = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalCreateDatasourceRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/datasources`
-    },
-    unmarshalDatasource
-  );
-  /**
-   * Delete a given data source specified by the data source ID.
-   *
-   * @param request - The request {@link DeleteDatasourceRequest}
-   */
-  deleteDatasource = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/cockpit/v1beta1/datasources/${validatePathParam("datasourceId", request.datasourceId)}`
-  });
-  pageOfListDatasources = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/datasources`,
-      urlParams: urlParams(
-        ["is_managed_by_scaleway", request.isManagedByScaleway],
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        [
-          "project_id",
-          request.projectId ?? this.client.settings.defaultProjectId
-        ],
-        ["types", request.types]
-      )
-    },
-    unmarshalListDatasourcesResponse
-  );
-  /**
-   * Get a list of data sources for the specified Project ID.
-   *
-   * @param request - The request {@link ListDatasourcesRequest}
-   * @returns A Promise of ListDatasourcesResponse
-   */
-  listDatasources = (request = {}) => enrichForPagination("datasources", this.pageOfListDatasources, request);
-  /**
-   * Create a token in a given Project specified by the Project ID.
-   *
-   * @param request - The request {@link CreateTokenRequest}
-   * @returns A Promise of Token
-   */
-  createToken = (request = {}) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalCreateTokenRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/tokens`
-    },
-    unmarshalToken
-  );
-  pageOfListTokens = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/tokens`,
-      urlParams: urlParams(
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        [
-          "project_id",
-          request.projectId ?? this.client.settings.defaultProjectId
-        ]
-      )
-    },
-    unmarshalListTokensResponse
-  );
-  /**
-   * Get a list of tokens in a given Project specified by the Project ID.
-   *
-   * @param request - The request {@link ListTokensRequest}
-   * @returns A Promise of ListTokensResponse
-   */
-  listTokens = (request = {}) => enrichForPagination("tokens", this.pageOfListTokens, request);
-  /**
-   * Retrieve a given token specified by the token ID.
-   *
-   * @param request - The request {@link GetTokenRequest}
-   * @returns A Promise of Token
-   */
-  getToken = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/tokens/${validatePathParam("tokenId", request.tokenId)}`
-    },
-    unmarshalToken
-  );
-  /**
-   * Delete a given token specified by the token ID.
-   *
-   * @param request - The request {@link DeleteTokenRequest}
-   */
-  deleteToken = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/cockpit/v1beta1/tokens/${validatePathParam("tokenId", request.tokenId)}`
-  });
-  /**
-   * Create a contact point associated with the default receiver, to receive
-   * alerts.
-   *
-   * @param request - The request {@link CreateContactPointRequest}
-   * @returns A Promise of ContactPoint
-   */
-  createContactPoint = (request = {}) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalCreateContactPointRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/contact-points`
-    },
-    unmarshalContactPoint
-  );
-  pageOfListContactPoints = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/contact-points`,
-      urlParams: urlParams(
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        [
-          "project_id",
-          request.projectId ?? this.client.settings.defaultProjectId
-        ]
-      )
-    },
-    unmarshalListContactPointsResponse
-  );
-  /**
-   * Get a list of contact points created for a given Cockpit, specified by the
-   * ID of the Project the Cockpit belongs to.
-   *
-   * @param request - The request {@link ListContactPointsRequest}
-   * @returns A Promise of ListContactPointsResponse
-   */
-  listContactPoints = (request = {}) => enrichForPagination("contactPoints", this.pageOfListContactPoints, request);
-  /**
-   * Delete a contact point associated with the default receiver.
-   *
-   * @param request - The request {@link DeleteContactPointRequest}
-   */
-  deleteContactPoint = (request = {}) => this.client.fetch({
-    body: JSON.stringify(
-      marshalDeleteContactPointRequest(request, this.client.settings)
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/cockpit/v1beta1/delete-contact-point`
-  });
-  /**
-   * Enable the sending of managed alerts for a given Cockpit, specified by the
-   * ID of the Project the Cockpit belongs to.
-   *
-   * @param request - The request {@link EnableManagedAlertsRequest}
-   */
-  enableManagedAlerts = (request = {}) => this.client.fetch({
-    body: JSON.stringify(
-      marshalEnableManagedAlertsRequest(request, this.client.settings)
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/cockpit/v1beta1/enable-managed-alerts`
-  });
-  /**
-   * Disable the sending of managed alerts for a given Cockpit, specified by the
-   * ID of the Project the Cockpit belongs to.
-   *
-   * @param request - The request {@link DisableManagedAlertsRequest}
-   */
-  disableManagedAlerts = (request = {}) => this.client.fetch({
-    body: JSON.stringify(
-      marshalDisableManagedAlertsRequest(request, this.client.settings)
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/cockpit/v1beta1/disable-managed-alerts`
-  });
-  /**
-   * Send a test alert to make sure your contact points get notified when an
-   * actual alert is triggered.
-   *
-   * @param request - The request {@link TriggerTestAlertRequest}
-   */
-  triggerTestAlert = (request = {}) => this.client.fetch({
-    body: JSON.stringify(
-      marshalTriggerTestAlertRequest(request, this.client.settings)
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/cockpit/v1beta1/trigger-test-alert`
-  });
-  /**
-   * Create a Grafana user for your Cockpit's Grafana. Make sure you save the
-   * automatically-generated password and the Grafana user ID.
-   *
-   * @param request - The request {@link CreateGrafanaUserRequest}
-   * @returns A Promise of GrafanaUser
-   */
-  createGrafanaUser = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalCreateGrafanaUserRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/grafana-users`
-    },
-    unmarshalGrafanaUser
-  );
-  pageOfListGrafanaUsers = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/grafana-users`,
-      urlParams: urlParams(
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        [
-          "project_id",
-          request.projectId ?? this.client.settings.defaultProjectId
-        ]
-      )
-    },
-    unmarshalListGrafanaUsersResponse
-  );
-  /**
-   * Get a list of all Grafana users created in your Cockpit's Grafana.
-   *
-   * @param request - The request {@link ListGrafanaUsersRequest}
-   * @returns A Promise of ListGrafanaUsersResponse
-   */
-  listGrafanaUsers = (request = {}) => enrichForPagination("grafanaUsers", this.pageOfListGrafanaUsers, request);
-  /**
-   * 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 DeleteGrafanaUserRequest}
-   */
-  deleteGrafanaUser = (request) => this.client.fetch({
-    body: JSON.stringify(
-      marshalDeleteGrafanaUserRequest(request, this.client.settings)
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/cockpit/v1beta1/grafana-users/${validatePathParam("grafanaUserId", request.grafanaUserId)}/delete`
-  });
-  /**
-   * 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.
-   *
-   * @param request - The request {@link ResetGrafanaUserPasswordRequest}
-   * @returns A Promise of GrafanaUser
-   */
-  resetGrafanaUserPassword = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalResetGrafanaUserPasswordRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/grafana-users/${validatePathParam("grafanaUserId", request.grafanaUserId)}/reset-password`
-    },
-    unmarshalGrafanaUser
-  );
-  pageOfListPlans = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/plans`,
-      urlParams: urlParams(
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ]
-      )
-    },
-    unmarshalListPlansResponse
-  );
-  /**
-   * Get a list of all pricing plans available.
-   *
-   * @param request - The request {@link ListPlansRequest}
-   * @returns A Promise of ListPlansResponse
-   */
-  listPlans = (request = {}) => enrichForPagination("plans", this.pageOfListPlans, request);
-  /**
-   * Select your chosen pricing plan for your Cockpit, specifying the Cockpit's
-   * Project ID and the pricing plan's ID in the request.
-   *
-   * @param request - The request {@link SelectPlanRequest}
-   * @returns A Promise of SelectPlanResponse
-   */
-  selectPlan = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalSelectPlanRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/cockpit/v1beta1/select-plan`
-    },
-    unmarshalSelectPlanResponse
-  );
-  pageOfListGrafanaProductDashboards = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/grafana-product-dashboards`,
-      urlParams: urlParams(
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        [
-          "project_id",
-          request.projectId ?? this.client.settings.defaultProjectId
-        ],
-        ["tags", request.tags]
-      )
-    },
-    unmarshalListGrafanaProductDashboardsResponse
-  );
-  /**
-   * List product dashboards. Get a list of available product dashboards.
-   *
-   * @param request - The request {@link ListGrafanaProductDashboardsRequest}
-   * @returns A Promise of ListGrafanaProductDashboardsResponse
-   */
-  listGrafanaProductDashboards = (request = {}) => enrichForPagination(
-    "dashboards",
-    this.pageOfListGrafanaProductDashboards,
-    request
-  );
-  /**
-   * Get a product dashboard. Get a product dashboard specified by the dashboard
-   * ID.
-   *
-   * @param request - The request {@link GetGrafanaProductDashboardRequest}
-   * @returns A Promise of GrafanaProductDashboard
-   */
-  getGrafanaProductDashboard = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/cockpit/v1beta1/grafana-product-dashboards/${validatePathParam("dashboardName", request.dashboardName)}`,
-      urlParams: urlParams([
-        "project_id",
-        request.projectId ?? this.client.settings.defaultProjectId
-      ])
-    },
-    unmarshalGrafanaProductDashboard
-  );
-}
-export {
-  API
-};

package/dist/api/cockpit/v1beta1/content.gen.cjs

@@ -1,8 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const COCKPIT_TRANSIENT_STATUSES = [
-  "creating",
-  "deleting",
-  "updating"
-];
-exports.COCKPIT_TRANSIENT_STATUSES = COCKPIT_TRANSIENT_STATUSES;

package/dist/api/cockpit/v1beta1/content.gen.d.ts

@@ -1,3 +0,0 @@
-import type { CockpitStatus } from './types.gen';
-/** Lists transient statutes of the enum {@link CockpitStatus}. */
-export declare const COCKPIT_TRANSIENT_STATUSES: CockpitStatus[];

package/dist/api/cockpit/v1beta1/content.gen.js

@@ -1,8 +0,0 @@
-const COCKPIT_TRANSIENT_STATUSES = [
-  "creating",
-  "deleting",
-  "updating"
-];
-export {
-  COCKPIT_TRANSIENT_STATUSES
-};

package/dist/api/cockpit/v1beta1/index.gen.cjs

@@ -1,6 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const content_gen = require("./content.gen.cjs");
-exports.API = api_gen.API;
-exports.COCKPIT_TRANSIENT_STATUSES = content_gen.COCKPIT_TRANSIENT_STATUSES;

package/dist/api/cockpit/v1beta1/index.gen.d.ts

@@ -1,3 +0,0 @@
-export { API } from './api.gen.js';
-export * from './content.gen.js';
-export type { ActivateCockpitRequest, Cockpit, CockpitEndpoints, CockpitMetrics, CockpitStatus, ContactPoint, ContactPointEmail, CreateContactPointRequest, CreateDatasourceRequest, CreateGrafanaUserRequest, CreateTokenRequest, Datasource, DatasourceType, DeactivateCockpitRequest, DeleteContactPointRequest, DeleteDatasourceRequest, DeleteGrafanaUserRequest, DeleteTokenRequest, DisableManagedAlertsRequest, EnableManagedAlertsRequest, GetCockpitMetricsRequest, GetCockpitRequest, GetGrafanaProductDashboardRequest, GetTokenRequest, GrafanaProductDashboard, GrafanaUser, GrafanaUserRole, ListContactPointsRequest, ListContactPointsResponse, ListDatasourcesRequest, ListDatasourcesRequestOrderBy, ListDatasourcesResponse, ListGrafanaProductDashboardsRequest, ListGrafanaProductDashboardsResponse, ListGrafanaUsersRequest, ListGrafanaUsersRequestOrderBy, ListGrafanaUsersResponse, ListPlansRequest, ListPlansRequestOrderBy, ListPlansResponse, ListTokensRequest, ListTokensRequestOrderBy, ListTokensResponse, Plan, PlanName, ResetGrafanaUserPasswordRequest, SelectPlanRequest, SelectPlanResponse, Token, TokenScopes, TriggerTestAlertRequest, } from './types.gen';

package/dist/api/cockpit/v1beta1/index.gen.js

@@ -1,6 +0,0 @@
-import { API } from "./api.gen.js";
-import { COCKPIT_TRANSIENT_STATUSES } from "./content.gen.js";
-export {
-  API,
-  COCKPIT_TRANSIENT_STATUSES
-};