@scaleway/sdk 2.26.0 → 2.28.0

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

@@ -0,0 +1,385 @@
+import type { TimeSeries } from '../../../bridge';
+export type CockpitStatus = 'unknown_status' | 'creating' | 'ready' | 'deleting' | 'updating' | 'error';
+export type DatasourceType = 'unknown_datasource_type' | 'metrics' | 'logs' | 'traces' | 'alerts';
+export type GrafanaUserRole = 'unknown_role' | 'editor' | 'viewer';
+export type ListDatasourcesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+export type ListGrafanaUsersRequestOrderBy = 'login_asc' | 'login_desc';
+export type ListPlansRequestOrderBy = 'name_asc' | 'name_desc';
+export type ListTokensRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+export type PlanName = 'unknown_name' | 'free' | 'premium' | 'custom';
+export interface ContactPointEmail {
+    to: string;
+}
+export interface TokenScopes {
+    /** Permission to fetch metrics. */
+    queryMetrics: boolean;
+    /** Permission to write metrics. */
+    writeMetrics: boolean;
+    /** Permission to setup metrics rules. */
+    setupMetricsRules: boolean;
+    /** Permission to fetch logs. */
+    queryLogs: boolean;
+    /** Permission to write logs. */
+    writeLogs: boolean;
+    /** Permission to set up logs rules. */
+    setupLogsRules: boolean;
+    /** Permission to set up alerts. */
+    setupAlerts: boolean;
+    /** Permission to fetch traces. */
+    queryTraces: boolean;
+    /** Permission to write traces. */
+    writeTraces: boolean;
+}
+export interface CockpitEndpoints {
+    /** URL for metrics. */
+    metricsUrl: string;
+    /** URL for logs. */
+    logsUrl: string;
+    /** URL for traces. */
+    tracesUrl: string;
+    /** URL for the alert manager. */
+    alertmanagerUrl: string;
+    /** URL for the Grafana dashboard. */
+    grafanaUrl: string;
+}
+/** Pricing plan. */
+export interface Plan {
+    /** ID of a given pricing plan. */
+    id: string;
+    /** Name of a given pricing plan. */
+    name: PlanName;
+    /** Interval of time during which Scaleway's Cockpit keeps your metrics. */
+    retentionMetricsInterval?: string;
+    /** Interval of time during which Scaleway's Cockpit keeps your logs. */
+    retentionLogsInterval?: string;
+    /** Interval of time during which Scaleway's Cockpit keeps your traces. */
+    retentionTracesInterval?: string;
+    /** Ingestion price in cents for 1 million samples. */
+    sampleIngestionPrice: number;
+    /** Ingestion price in cents for 1 GB of logs. */
+    logsIngestionPrice: number;
+    /** Ingestion price in cents for 1 GB of traces. */
+    tracesIngestionPrice: number;
+    /** Retention price in euros per month. */
+    retentionPrice: number;
+}
+/** Contact point. */
+export interface ContactPoint {
+    /**
+     * Contact point configuration.
+     *
+     * One-of ('configuration'): at most one of 'email' could be set.
+     */
+    email?: ContactPointEmail;
+}
+/** Data source. */
+export interface Datasource {
+    /** ID of the data source. */
+    id: string;
+    /** ID of the Project the Cockpit belongs to. */
+    projectId: string;
+    /** Data source name. */
+    name: string;
+    /** Data source URL. */
+    url: string;
+    /** Data source type. */
+    type: DatasourceType;
+    /**
+     * Specifies that the data source receives data from Scaleway products and is
+     * managed by Scaleway.
+     */
+    isManagedByScaleway: boolean;
+}
+/** Grafana dashboard. */
+export interface GrafanaProductDashboard {
+    /** Name of the dashboard. */
+    dashboardName: string;
+    /** Title of the dashboard. */
+    title: string;
+    /** URL of the dashboard. */
+    url: string;
+    /** Tags of the dashboard. */
+    tags: string[];
+    /** Variables of the dashboard. */
+    variables: string[];
+}
+/** Grafana user. */
+export interface GrafanaUser {
+    /** ID of the Grafana user. */
+    id: number;
+    /** Username of the Grafana user. */
+    login: string;
+    /** Role assigned to the Grafana user. */
+    role: GrafanaUserRole;
+    /** The Grafana user's password. */
+    password?: string;
+}
+export interface Token {
+    /** ID of the token. */
+    id: string;
+    /** ID of the Project. */
+    projectId: string;
+    /** Name of the token. */
+    name: string;
+    /** Date and time of the token's creation. */
+    createdAt?: Date;
+    /** Date and time of the token's last update. */
+    updatedAt?: Date;
+    /** Token's permissions. */
+    scopes?: TokenScopes;
+    /** Token's secret key. */
+    secretKey?: string;
+}
+export type ActivateCockpitRequest = {
+    /** ID of the Project the Cockpit belongs to. */
+    projectId?: string;
+};
+/** Cockpit. */
+export interface Cockpit {
+    /** ID of the Project the Cockpit belongs to. */
+    projectId: string;
+    /** Date and time of the Cockpit's creation. */
+    createdAt?: Date;
+    /** Date and time of the Cockpit's last update. */
+    updatedAt?: Date;
+    /** Endpoints of the Cockpit. */
+    endpoints?: CockpitEndpoints;
+    /** Status of the Cockpit. */
+    status: CockpitStatus;
+    /** Specifies whether managed alerts are enabled or disabled. */
+    managedAlertsEnabled: boolean;
+    /** Pricing plan information. */
+    plan?: Plan;
+}
+/** Metrics for a given Cockpit. */
+export interface CockpitMetrics {
+    /** Time series array. */
+    timeseries: TimeSeries[];
+}
+/** Request to create a contact point. */
+export type CreateContactPointRequest = {
+    /** ID of the Project in which to create the contact point. */
+    projectId?: string;
+    /** Contact point to create. */
+    contactPoint?: ContactPoint;
+};
+/** Request to create a data source. */
+export type CreateDatasourceRequest = {
+    /** ID of the Project the Cockpit belongs to. */
+    projectId?: string;
+    /** Data source name. */
+    name: string;
+    /** Data source type. */
+    type?: DatasourceType;
+    /** Specifies that the returned output is the default data source per type. */
+    isDefault: boolean;
+};
+/** Request to create a Grafana user. */
+export type CreateGrafanaUserRequest = {
+    /** ID of the Project. */
+    projectId?: string;
+    /** Username of the Grafana user. */
+    login: string;
+    /** Role assigned to the Grafana user. */
+    role?: GrafanaUserRole;
+};
+export type CreateTokenRequest = {
+    /** ID of the Project. */
+    projectId?: string;
+    /** Name of the token. */
+    name?: string;
+    /** Token's permissions. */
+    scopes?: TokenScopes;
+};
+export type DeactivateCockpitRequest = {
+    /** ID of the Project the Cockpit belongs to. */
+    projectId?: string;
+};
+/** Request to delete a contact point. */
+export type DeleteContactPointRequest = {
+    /** ID of the Project. */
+    projectId?: string;
+    /** Contact point to delete. */
+    contactPoint?: ContactPoint;
+};
+/** Request to delete a data source. */
+export type DeleteDatasourceRequest = {
+    /** ID of the data source. */
+    datasourceId: string;
+};
+/** Request to delete a Grafana user. */
+export type DeleteGrafanaUserRequest = {
+    /** ID of the Grafana user. */
+    grafanaUserId: number;
+    /** ID of the Project. */
+    projectId?: string;
+};
+export type DeleteTokenRequest = {
+    /** ID of the token. */
+    tokenId: string;
+};
+/** Request to disable the sending of managed alerts. */
+export type DisableManagedAlertsRequest = {
+    /** ID of the Project. */
+    projectId?: string;
+};
+/** Request to enable the sending of managed alerts. */
+export type EnableManagedAlertsRequest = {
+    /** ID of the Project. */
+    projectId?: string;
+};
+/** Request to get a given Cockpit's metrics. */
+export type GetCockpitMetricsRequest = {
+    /** ID of the Project the Cockpit belongs to. */
+    projectId?: string;
+    /** Desired time range's start date for the metrics. */
+    startDate?: Date;
+    /** Desired time range's end date for the metrics. */
+    endDate?: Date;
+    /** Name of the metric requested. */
+    metricName?: string;
+};
+export type GetCockpitRequest = {
+    /** ID of the Project the Cockpit belongs to. */
+    projectId?: string;
+};
+/** Request to get a dashboard. */
+export type GetGrafanaProductDashboardRequest = {
+    /** Name of the dashboard. */
+    dashboardName: string;
+    /** ID of the Project. */
+    projectId?: string;
+};
+export type GetTokenRequest = {
+    /** ID of the token. */
+    tokenId: string;
+};
+/** Request to list all contact points. */
+export type ListContactPointsRequest = {
+    /** Page number. */
+    page?: number;
+    /** Page size. */
+    pageSize?: number;
+    /** ID of the Project from which to list the contact points. */
+    projectId?: string;
+};
+/** Response returned when listing contact points. */
+export interface ListContactPointsResponse {
+    /** Count of all contact points created. */
+    totalCount: number;
+    /** Array of contact points. */
+    contactPoints: ContactPoint[];
+    /**
+     * Specifies whether the contact point has other receivers than the default
+     * receiver.
+     */
+    hasAdditionalReceivers: boolean;
+    /** Specifies whether there are unmanaged contact points. */
+    hasAdditionalContactPoints: boolean;
+}
+export type ListDatasourcesRequest = {
+    /** Page number. */
+    page?: number;
+    /** Page size. */
+    pageSize?: number;
+    /** How the response is ordered. */
+    orderBy?: ListDatasourcesRequestOrderBy;
+    /** ID of the Project. */
+    projectId?: string;
+    /** Filter by datasource types. */
+    types?: DatasourceType[];
+    /** Filter by managed datasources. */
+    isManagedByScaleway?: boolean;
+};
+export interface ListDatasourcesResponse {
+    /** Count of all datasources corresponding to the request. */
+    totalCount: number;
+    /** List of the datasources within the pagination. */
+    datasources: Datasource[];
+}
+/** Request to get a list of dashboards. */
+export type ListGrafanaProductDashboardsRequest = {
+    /** ID of the Project. */
+    projectId?: string;
+    /** Page number. */
+    page?: number;
+    /** Page size. */
+    pageSize?: number;
+    /** Tags to filter the dashboards. */
+    tags?: string[];
+};
+/** Response returned when getting a list of dashboards. */
+export interface ListGrafanaProductDashboardsResponse {
+    /** Count of grafana dasboards. */
+    totalCount: number;
+    /** Information on grafana dashboards. */
+    dashboards: GrafanaProductDashboard[];
+}
+/** Request to list all Grafana users. */
+export type ListGrafanaUsersRequest = {
+    /** Page number. */
+    page?: number;
+    /** Page size. */
+    pageSize?: number;
+    orderBy?: ListGrafanaUsersRequestOrderBy;
+    /** ID of the Project. */
+    projectId?: string;
+};
+/** Response returned when listing Grafana users. */
+export interface ListGrafanaUsersResponse {
+    /** Count of all Grafana users. */
+    totalCount: number;
+    /** Information on all Grafana users. */
+    grafanaUsers: GrafanaUser[];
+}
+/** Request to list all pricing plans. */
+export type ListPlansRequest = {
+    /** Page number. */
+    page?: number;
+    /** Page size. */
+    pageSize?: number;
+    orderBy?: ListPlansRequestOrderBy;
+};
+/** Response returned when listing all pricing plans. */
+export interface ListPlansResponse {
+    /** Count of all pricing plans. */
+    totalCount: number;
+    /** Information on plans. */
+    plans: Plan[];
+}
+export type ListTokensRequest = {
+    /** Page number. */
+    page?: number;
+    /** Page size. */
+    pageSize?: number;
+    /** How the response is ordered. */
+    orderBy?: ListTokensRequestOrderBy;
+    /** ID of the Project. */
+    projectId?: string;
+};
+export interface ListTokensResponse {
+    /** Count of all tokens created. */
+    totalCount: number;
+    /** List of all tokens created. */
+    tokens: Token[];
+}
+/** Request to reset a Grafana user's password. */
+export type ResetGrafanaUserPasswordRequest = {
+    /** ID of the Grafana user. */
+    grafanaUserId: number;
+    /** ID of the Project. */
+    projectId?: string;
+};
+/** Request to select a specific pricing plan. */
+export type SelectPlanRequest = {
+    /** ID of the Project. */
+    projectId?: string;
+    /** ID of the pricing plan. */
+    planId: string;
+};
+/** Response returned when selecting a pricing plan. */
+export interface SelectPlanResponse {
+}
+export type TriggerTestAlertRequest = {
+    projectId?: string;
+};

package/dist/api/container/index.cjs

@@ -0,0 +1,4 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const index_gen = require("./v1beta1/index.gen.cjs");
+exports.v1beta1 = index_gen;

package/dist/api/container/index.d.ts

@@ -0,0 +1 @@
+export * as v1beta1 from './v1beta1/index.gen';

package/dist/api/container/index.js

@@ -1,2 +1,4 @@
-import * as index_gen from './v1beta1/index.gen.js';
-export { index_gen as v1beta1 };
+import * as index_gen from "./v1beta1/index.gen.js";
+export {
+  index_gen as v1beta1
+};