@scaleway/sdk-serverless-sqldb 1.0.1

package/dist/v1alpha1/content.gen.cjs

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

package/dist/v1alpha1/content.gen.d.ts

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

package/dist/v1alpha1/content.gen.js

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

package/dist/v1alpha1/index.gen.cjs

@@ -0,0 +1,16 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_gen = require("./api.gen.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const validationRules_gen = require("./validation-rules.gen.cjs");
+exports.API = api_gen.API;
+exports.DATABASE_TRANSIENT_STATUSES = content_gen.DATABASE_TRANSIENT_STATUSES;
+exports.marshalCreateDatabaseRequest = marshalling_gen.marshalCreateDatabaseRequest;
+exports.marshalRestoreDatabaseFromBackupRequest = marshalling_gen.marshalRestoreDatabaseFromBackupRequest;
+exports.marshalUpdateDatabaseRequest = marshalling_gen.marshalUpdateDatabaseRequest;
+exports.unmarshalDatabase = marshalling_gen.unmarshalDatabase;
+exports.unmarshalDatabaseBackup = marshalling_gen.unmarshalDatabaseBackup;
+exports.unmarshalListDatabaseBackupsResponse = marshalling_gen.unmarshalListDatabaseBackupsResponse;
+exports.unmarshalListDatabasesResponse = marshalling_gen.unmarshalListDatabasesResponse;
+exports.ValidationRules = validationRules_gen;

package/dist/v1alpha1/index.gen.d.ts

@@ -0,0 +1,5 @@
+export { API } from './api.gen';
+export * from './content.gen';
+export * from './marshalling.gen';
+export type { CreateDatabaseRequest, Database, DatabaseBackup, DatabaseBackupStatus, DatabaseStatus, DeleteDatabaseRequest, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetDatabaseRequest, ListDatabaseBackupsRequest, ListDatabaseBackupsRequestOrderBy, ListDatabaseBackupsResponse, ListDatabasesRequest, ListDatabasesRequestOrderBy, ListDatabasesResponse, RestoreDatabaseFromBackupRequest, UpdateDatabaseRequest, } from './types.gen';
+export * as ValidationRules from './validation-rules.gen';

package/dist/v1alpha1/index.gen.js

@@ -0,0 +1,16 @@
+import { API } from "./api.gen.js";
+import { DATABASE_TRANSIENT_STATUSES } from "./content.gen.js";
+import { marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse } from "./marshalling.gen.js";
+import * as validationRules_gen from "./validation-rules.gen.js";
+export {
+  API,
+  DATABASE_TRANSIENT_STATUSES,
+  validationRules_gen as ValidationRules,
+  marshalCreateDatabaseRequest,
+  marshalRestoreDatabaseFromBackupRequest,
+  marshalUpdateDatabaseRequest,
+  unmarshalDatabase,
+  unmarshalDatabaseBackup,
+  unmarshalListDatabaseBackupsResponse,
+  unmarshalListDatabasesResponse
+};

package/dist/v1alpha1/marshalling.gen.cjs

@@ -0,0 +1,89 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const sdkClient = require("@scaleway/sdk-client");
+const unmarshalDatabaseBackup = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DatabaseBackup' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: sdkClient.unmarshalDate(data.created_at),
+    databaseId: data.database_id,
+    dbSize: data.db_size,
+    downloadUrl: data.download_url,
+    downloadUrlExpiresAt: sdkClient.unmarshalDate(data.download_url_expires_at),
+    expiresAt: sdkClient.unmarshalDate(data.expires_at),
+    id: data.id,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    region: data.region,
+    size: data.size,
+    status: data.status
+  };
+};
+const unmarshalDatabase = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Database' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    cpuCurrent: data.cpu_current,
+    cpuMax: data.cpu_max,
+    cpuMin: data.cpu_min,
+    createdAt: sdkClient.unmarshalDate(data.created_at),
+    endpoint: data.endpoint,
+    engineMajorVersion: data.engine_major_version,
+    id: data.id,
+    name: data.name,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    region: data.region,
+    started: data.started,
+    status: data.status
+  };
+};
+const unmarshalListDatabaseBackupsResponse = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListDatabaseBackupsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    backups: sdkClient.unmarshalArrayOfObject(data.backups, unmarshalDatabaseBackup),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListDatabasesResponse = (data) => {
+  if (!sdkClient.isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListDatabasesResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    databases: sdkClient.unmarshalArrayOfObject(data.databases, unmarshalDatabase),
+    totalCount: data.total_count
+  };
+};
+const marshalCreateDatabaseRequest = (request, defaults) => ({
+  cpu_max: request.cpuMax,
+  cpu_min: request.cpuMin,
+  from_backup_id: request.fromBackupId,
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalRestoreDatabaseFromBackupRequest = (request, defaults) => ({
+  backup_id: request.backupId
+});
+const marshalUpdateDatabaseRequest = (request, defaults) => ({
+  cpu_max: request.cpuMax,
+  cpu_min: request.cpuMin
+});
+exports.marshalCreateDatabaseRequest = marshalCreateDatabaseRequest;
+exports.marshalRestoreDatabaseFromBackupRequest = marshalRestoreDatabaseFromBackupRequest;
+exports.marshalUpdateDatabaseRequest = marshalUpdateDatabaseRequest;
+exports.unmarshalDatabase = unmarshalDatabase;
+exports.unmarshalDatabaseBackup = unmarshalDatabaseBackup;
+exports.unmarshalListDatabaseBackupsResponse = unmarshalListDatabaseBackupsResponse;
+exports.unmarshalListDatabasesResponse = unmarshalListDatabasesResponse;

package/dist/v1alpha1/marshalling.gen.d.ts

@@ -0,0 +1,9 @@
+import type { DefaultValues } from '@scaleway/sdk-client';
+import type { CreateDatabaseRequest, Database, DatabaseBackup, ListDatabaseBackupsResponse, ListDatabasesResponse, RestoreDatabaseFromBackupRequest, UpdateDatabaseRequest } from './types.gen';
+export declare const unmarshalDatabaseBackup: (data: unknown) => DatabaseBackup;
+export declare const unmarshalDatabase: (data: unknown) => Database;
+export declare const unmarshalListDatabaseBackupsResponse: (data: unknown) => ListDatabaseBackupsResponse;
+export declare const unmarshalListDatabasesResponse: (data: unknown) => ListDatabasesResponse;
+export declare const marshalCreateDatabaseRequest: (request: CreateDatabaseRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalRestoreDatabaseFromBackupRequest: (request: RestoreDatabaseFromBackupRequest, defaults: DefaultValues) => Record<string, unknown>;
+export declare const marshalUpdateDatabaseRequest: (request: UpdateDatabaseRequest, defaults: DefaultValues) => Record<string, unknown>;

package/dist/v1alpha1/marshalling.gen.js

@@ -0,0 +1,89 @@
+import { isJSONObject, unmarshalDate, unmarshalArrayOfObject } from "@scaleway/sdk-client";
+const unmarshalDatabaseBackup = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'DatabaseBackup' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    databaseId: data.database_id,
+    dbSize: data.db_size,
+    downloadUrl: data.download_url,
+    downloadUrlExpiresAt: unmarshalDate(data.download_url_expires_at),
+    expiresAt: unmarshalDate(data.expires_at),
+    id: data.id,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    region: data.region,
+    size: data.size,
+    status: data.status
+  };
+};
+const unmarshalDatabase = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'Database' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    cpuCurrent: data.cpu_current,
+    cpuMax: data.cpu_max,
+    cpuMin: data.cpu_min,
+    createdAt: unmarshalDate(data.created_at),
+    endpoint: data.endpoint,
+    engineMajorVersion: data.engine_major_version,
+    id: data.id,
+    name: data.name,
+    organizationId: data.organization_id,
+    projectId: data.project_id,
+    region: data.region,
+    started: data.started,
+    status: data.status
+  };
+};
+const unmarshalListDatabaseBackupsResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListDatabaseBackupsResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    backups: unmarshalArrayOfObject(data.backups, unmarshalDatabaseBackup),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListDatabasesResponse = (data) => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(
+      `Unmarshalling the type 'ListDatabasesResponse' failed as data isn't a dictionary.`
+    );
+  }
+  return {
+    databases: unmarshalArrayOfObject(data.databases, unmarshalDatabase),
+    totalCount: data.total_count
+  };
+};
+const marshalCreateDatabaseRequest = (request, defaults) => ({
+  cpu_max: request.cpuMax,
+  cpu_min: request.cpuMin,
+  from_backup_id: request.fromBackupId,
+  name: request.name,
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
+const marshalRestoreDatabaseFromBackupRequest = (request, defaults) => ({
+  backup_id: request.backupId
+});
+const marshalUpdateDatabaseRequest = (request, defaults) => ({
+  cpu_max: request.cpuMax,
+  cpu_min: request.cpuMin
+});
+export {
+  marshalCreateDatabaseRequest,
+  marshalRestoreDatabaseFromBackupRequest,
+  marshalUpdateDatabaseRequest,
+  unmarshalDatabase,
+  unmarshalDatabaseBackup,
+  unmarshalListDatabaseBackupsResponse,
+  unmarshalListDatabasesResponse
+};

package/dist/v1alpha1/types.gen.d.ts

@@ -0,0 +1,287 @@
+import type { Region as ScwRegion } from '@scaleway/sdk-client';
+export type DatabaseBackupStatus = 'unknown_status' | 'error' | 'ready' | 'locked';
+export type DatabaseStatus = 'unknown_status' | 'error' | 'creating' | 'ready' | 'deleting' | 'restoring' | 'locked';
+export type ListDatabaseBackupsRequestOrderBy = 'created_at_desc' | 'created_at_asc';
+export type ListDatabasesRequestOrderBy = 'created_at_asc' | 'created_at_desc' | 'name_asc' | 'name_desc';
+export interface DatabaseBackup {
+    /**
+     * UUID that uniquely identifies a Serverless SQL Database backup.
+     */
+    id: string;
+    /**
+     * Status of the Serverless SQL Database backup. One of `unknown_status` | `error` | `ready` | `locked`.
+     */
+    status: DatabaseBackupStatus;
+    /**
+     * The ID of your Scaleway organization.
+     */
+    organizationId: string;
+    /**
+     * UUID of the Scaleway project.
+     */
+    projectId: string;
+    /**
+     * UUID of the source Serverless SQL Database the backup is created from.
+     */
+    databaseId: string;
+    /**
+     * Creation date.
+     */
+    createdAt?: Date;
+    /**
+     * Expiration date.
+     */
+    expiresAt?: Date;
+    /**
+     * Size (in bytes) of the database backup file.
+     */
+    size?: number;
+    /**
+     * Size (in bytes) of the database when backup has been done.
+     */
+    dbSize?: number;
+    /**
+     * Download URL of the exported database backup.
+     */
+    downloadUrl?: string;
+    /**
+     * Expiration date of the download URL.
+     */
+    downloadUrlExpiresAt?: Date;
+    /**
+     * Region of the database backup.
+     */
+    region: ScwRegion;
+}
+export interface Database {
+    /**
+     * UUID that uniquely identifies your Serverless SQL DB Database.
+     */
+    id: string;
+    /**
+     * Name of the database.
+     */
+    name: string;
+    /**
+     * Status of the Serverless SQL Ddatabase. One of `unknown_status` | `ready` | `creating` | `deleting` | `error` | `restoring` | `locked`.
+     */
+    status: DatabaseStatus;
+    /**
+     * Endpoint of the database.
+     */
+    endpoint: string;
+    /**
+     * The ID of your Scaleway organization.
+     */
+    organizationId: string;
+    /**
+     * Project ID the database belongs to.
+     */
+    projectId: string;
+    /**
+     * Region of the database.
+     */
+    region: ScwRegion;
+    /**
+     * Creation date.
+     */
+    createdAt?: Date;
+    /**
+     * The minimum number of CPU units for your Serverless SQL Database.
+     */
+    cpuMin: number;
+    /**
+     * The maximum number of CPU units for your Serverless SQL Database.
+     */
+    cpuMax: number;
+    /**
+     * The current number of CPU units allocated to your Serverless SQL Database.
+     */
+    cpuCurrent: number;
+    /**
+     * Whether your Serverless SQL Database is running or not.
+     */
+    started: boolean;
+    /**
+     * The major version of the underlying database engine.
+     */
+    engineMajorVersion: number;
+}
+export type CreateDatabaseRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * The ID of your Scaleway project.
+     */
+    projectId?: string;
+    /**
+     * The name of the Serverless SQL Database to be created.
+     */
+    name: string;
+    /**
+     * The minimum number of CPU units for your Serverless SQL Database.
+     */
+    cpuMin: number;
+    /**
+     * The maximum number of CPU units for your Serverless SQL Database.
+     */
+    cpuMax: number;
+    /**
+     * The ID of the backup to create the database from.
+     */
+    fromBackupId?: string;
+};
+export type DeleteDatabaseRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Serverless SQL Database.
+     */
+    databaseId: string;
+};
+export type ExportDatabaseBackupRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Serverless SQL Database backup.
+     */
+    backupId: string;
+};
+export type GetDatabaseBackupRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Serverless SQL Database backup.
+     */
+    backupId: string;
+};
+export type GetDatabaseRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Serverless SQL DB database.
+     */
+    databaseId: string;
+};
+export type ListDatabaseBackupsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Filter by the UUID of the Scaleway organization.
+     */
+    organizationId?: string;
+    /**
+     * Filter by the UUID of the Scaleway project.
+     */
+    projectId?: string;
+    /**
+     * Filter by the UUID of the Serverless SQL Database.
+     */
+    databaseId: string;
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Page size.
+     */
+    pageSize?: number;
+    /**
+     * Sorting criteria. One of `created_at_asc`, `created_at_desc`.
+     */
+    orderBy?: ListDatabaseBackupsRequestOrderBy;
+};
+export interface ListDatabaseBackupsResponse {
+    /**
+     * List of the backups.
+     */
+    backups: DatabaseBackup[];
+    /**
+     * Length of the backups list.
+     */
+    totalCount: number;
+}
+export type ListDatabasesRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * Filter by the UUID of the Scaleway organization.
+     */
+    organizationId?: string;
+    /**
+     * UUID of the Scaleway project.
+     */
+    projectId?: string;
+    /**
+     * Page number.
+     */
+    page?: number;
+    /**
+     * Page size.
+     */
+    pageSize?: number;
+    /**
+     * Filter by the name of the database.
+     */
+    name?: string;
+    /**
+     * Sorting criteria. One of `created_at_asc`, `created_at_desc`, `name_asc`, `name_desc`.
+     */
+    orderBy?: ListDatabasesRequestOrderBy;
+};
+export interface ListDatabasesResponse {
+    /**
+     * List of the databases.
+     */
+    databases: Database[];
+    /**
+     * Total count of Serverless SQL Databases.
+     */
+    totalCount: number;
+}
+export type RestoreDatabaseFromBackupRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Serverless SQL Database.
+     */
+    databaseId: string;
+    /**
+     * UUID of the Serverless SQL Database backup to restore.
+     */
+    backupId: string;
+};
+export type UpdateDatabaseRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    /**
+     * UUID of the Serverless SQL Database.
+     */
+    databaseId: string;
+    /**
+     * The minimum number of CPU units for your Serverless SQL Database.
+     */
+    cpuMin?: number;
+    /**
+     * The maximum number of CPU units for your Serverless SQL Database.
+     */
+    cpuMax?: number;
+};

package/dist/v1alpha1/validation-rules.gen.cjs

@@ -0,0 +1,62 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const CreateDatabaseRequest = {
+  cpuMax: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 15
+  },
+  cpuMin: {
+    lessThanOrEqual: 15
+  },
+  fromBackupId: {
+    ignoreEmpty: true
+  },
+  name: {
+    maxLength: 63,
+    minLength: 1
+  }
+};
+const Database = {
+  cpuCurrent: {
+    lessThanOrEqual: 15
+  },
+  cpuMax: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 15
+  },
+  cpuMin: {
+    lessThanOrEqual: 15
+  }
+};
+const ListDatabaseBackupsRequest = {
+  page: {
+    greaterThanOrEqual: 1
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 1e3
+  }
+};
+const ListDatabasesRequest = {
+  page: {
+    greaterThanOrEqual: 1
+  },
+  pageSize: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 1e3
+  }
+};
+const UpdateDatabaseRequest = {
+  cpuMax: {
+    greaterThanOrEqual: 1,
+    lessThanOrEqual: 15
+  },
+  cpuMin: {
+    lessThanOrEqual: 15
+  }
+};
+exports.CreateDatabaseRequest = CreateDatabaseRequest;
+exports.Database = Database;
+exports.ListDatabaseBackupsRequest = ListDatabaseBackupsRequest;
+exports.ListDatabasesRequest = ListDatabasesRequest;
+exports.UpdateDatabaseRequest = UpdateDatabaseRequest;

package/dist/v1alpha1/validation-rules.gen.d.ts

@@ -0,0 +1,55 @@
+export declare const CreateDatabaseRequest: {
+    cpuMax: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    cpuMin: {
+        lessThanOrEqual: number;
+    };
+    fromBackupId: {
+        ignoreEmpty: boolean;
+    };
+    name: {
+        maxLength: number;
+        minLength: number;
+    };
+};
+export declare const Database: {
+    cpuCurrent: {
+        lessThanOrEqual: number;
+    };
+    cpuMax: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    cpuMin: {
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListDatabaseBackupsRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const ListDatabasesRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
+export declare const UpdateDatabaseRequest: {
+    cpuMax: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+    cpuMin: {
+        lessThanOrEqual: number;
+    };
+};