@scaleway/sdk-serverless-sqldb 2.10.0 → 2.12.0

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

@@ -1,6 +1,6 @@
 import { API as ParentAPI } from '@scaleway/sdk-client';
 import type { WaitForOptions, ApiLocality } from '@scaleway/sdk-client';
-import type { CreateDatabaseRequest, Database, DatabaseBackup, DeleteDatabaseRequest, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetDatabaseRequest, ListDatabaseBackupsRequest, ListDatabaseBackupsResponse, ListDatabasesRequest, ListDatabasesResponse, RestoreDatabaseFromBackupRequest, UpdateDatabaseRequest } from './types.gen.js';
+import type { CreateDatabaseRequest, Database, DatabaseBackup, DeleteDatabaseRequest, ExportDatabaseBackupRequest, GetDatabaseBackupRequest, GetDatabaseRequest, ListDatabaseBackupsRequest, ListDatabaseBackupsResponse, ListDatabasesRequest, ListDatabasesResponse, ListVersionsRequest, ListVersionsResponse, RestoreDatabaseFromBackupRequest, UpdateDatabaseRequest } from './types.gen.js';
 /**
  * Serverless SQL Databases API.
 
@@ -91,4 +91,15 @@ export declare class API extends ParentAPI {
      * @returns A Promise of DatabaseBackup
      */
     exportDatabaseBackup: (request: Readonly<ExportDatabaseBackupRequest>) => Promise<DatabaseBackup>;
+    protected pageOfListVersions: (request?: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse>;
+    /**
+     * List available PostgreSQL major versions.
+     *
+     * @param request - The request {@link ListVersionsRequest}
+     * @returns A Promise of ListVersionsResponse
+     */
+    listVersions: (request?: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse> & {
+        all: () => Promise<import("./types.gen.js").Version[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen.js").Version[], void, void>;
+    };
 }

package/dist/v1alpha1/api.gen.js

@@ -1,5 +1,5 @@
 import { DATABASE_TRANSIENT_STATUSES } from "./content.gen.js";
-import { marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse } from "./marshalling.gen.js";
+import { marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse, unmarshalListVersionsResponse } from "./marshalling.gen.js";
 import { API as API$1, enrichForPagination, toApiLocality, urlParams, validatePathParam, waitForResource } from "@scaleway/sdk-client";
 //#region src/v1alpha1/api.gen.ts
 const jsonContentHeaders = { "Content-Type": "application/json; charset=utf-8" };
@@ -60,6 +60,12 @@ var API = class extends API$1 {
 			method: "POST",
 			path: `/serverless-sqldb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam("backupId", request.backupId)}/export`
 		}, unmarshalDatabaseBackup);
+		this.pageOfListVersions = (request = {}) => this.client.fetch({
+			method: "GET",
+			path: `/serverless-sqldb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
+			urlParams: urlParams(["page", request.page], ["page_size", request.pageSize ?? this.client.settings.defaultPageSize], ["version", request.version])
+		}, unmarshalListVersionsResponse);
+		this.listVersions = (request = {}) => enrichForPagination("versions", this.pageOfListVersions, request);
 	}
 	static {
 		this.LOCALITY = toApiLocality({ regions: ["fr-par"] });

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

@@ -0,0 +1,9 @@
+import type { DatabaseBackupStatus, DatabaseStatus, ListDatabaseBackupsRequestOrderBy, ListDatabasesRequestOrderBy } from './types.gen.js';
+/** Lists all values of the enum {@link DatabaseBackupStatus}. */
+export declare const DATABASE_BACKUP_STATUSES: DatabaseBackupStatus[];
+/** Lists all values of the enum {@link DatabaseStatus}. */
+export declare const DATABASE_STATUSES: DatabaseStatus[];
+/** Lists all values of the enum {@link ListDatabaseBackupsRequestOrderBy}. */
+export declare const LIST_DATABASE_BACKUPS_REQUEST_ORDER_BIES: ListDatabaseBackupsRequestOrderBy[];
+/** Lists all values of the enum {@link ListDatabasesRequestOrderBy}. */
+export declare const LIST_DATABASES_REQUEST_ORDER_BIES: ListDatabasesRequestOrderBy[];

package/dist/v1alpha1/constants.gen.js

@@ -0,0 +1,29 @@
+//#region src/v1alpha1/constants.gen.ts
+/** Lists all values of the enum {@link DatabaseBackupStatus}. */
+const DATABASE_BACKUP_STATUSES = [
+	"unknown_status",
+	"error",
+	"ready",
+	"locked"
+];
+/** Lists all values of the enum {@link DatabaseStatus}. */
+const DATABASE_STATUSES = [
+	"unknown_status",
+	"error",
+	"creating",
+	"ready",
+	"deleting",
+	"restoring",
+	"locked"
+];
+/** Lists all values of the enum {@link ListDatabaseBackupsRequestOrderBy}. */
+const LIST_DATABASE_BACKUPS_REQUEST_ORDER_BIES = ["created_at_desc", "created_at_asc"];
+/** Lists all values of the enum {@link ListDatabasesRequestOrderBy}. */
+const LIST_DATABASES_REQUEST_ORDER_BIES = [
+	"created_at_asc",
+	"created_at_desc",
+	"name_asc",
+	"name_desc"
+];
+//#endregion
+export { DATABASE_BACKUP_STATUSES, DATABASE_STATUSES, LIST_DATABASES_REQUEST_ORDER_BIES, LIST_DATABASE_BACKUPS_REQUEST_ORDER_BIES };

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

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

package/dist/v1alpha1/index.gen.js

@@ -1,12 +1,17 @@
 import { __exportAll } from "../_virtual/_rolldown/runtime.js";
 import { DATABASE_TRANSIENT_STATUSES } from "./content.gen.js";
-import { marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse } from "./marshalling.gen.js";
+import { marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse, unmarshalListVersionsResponse } from "./marshalling.gen.js";
 import { API } from "./api.gen.js";
+import { DATABASE_BACKUP_STATUSES, DATABASE_STATUSES, LIST_DATABASES_REQUEST_ORDER_BIES, LIST_DATABASE_BACKUPS_REQUEST_ORDER_BIES } from "./constants.gen.js";
 import { validation_rules_gen_exports } from "./validation-rules.gen.js";
 //#region src/v1alpha1/index.gen.ts
 var index_gen_exports = /* @__PURE__ */ __exportAll({
 	API: () => API,
+	DATABASE_BACKUP_STATUSES: () => DATABASE_BACKUP_STATUSES,
+	DATABASE_STATUSES: () => DATABASE_STATUSES,
 	DATABASE_TRANSIENT_STATUSES: () => DATABASE_TRANSIENT_STATUSES,
+	LIST_DATABASES_REQUEST_ORDER_BIES: () => LIST_DATABASES_REQUEST_ORDER_BIES,
+	LIST_DATABASE_BACKUPS_REQUEST_ORDER_BIES: () => LIST_DATABASE_BACKUPS_REQUEST_ORDER_BIES,
 	ValidationRules: () => validation_rules_gen_exports,
 	marshalCreateDatabaseRequest: () => marshalCreateDatabaseRequest,
 	marshalRestoreDatabaseFromBackupRequest: () => marshalRestoreDatabaseFromBackupRequest,
@@ -14,7 +19,8 @@ var index_gen_exports = /* @__PURE__ */ __exportAll({
 	unmarshalDatabase: () => unmarshalDatabase,
 	unmarshalDatabaseBackup: () => unmarshalDatabaseBackup,
 	unmarshalListDatabaseBackupsResponse: () => unmarshalListDatabaseBackupsResponse,
-	unmarshalListDatabasesResponse: () => unmarshalListDatabasesResponse
+	unmarshalListDatabasesResponse: () => unmarshalListDatabasesResponse,
+	unmarshalListVersionsResponse: () => unmarshalListVersionsResponse
 });
 //#endregion
-export { API, DATABASE_TRANSIENT_STATUSES, validation_rules_gen_exports as ValidationRules, index_gen_exports, marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse };
+export { API, DATABASE_BACKUP_STATUSES, DATABASE_STATUSES, DATABASE_TRANSIENT_STATUSES, LIST_DATABASES_REQUEST_ORDER_BIES, LIST_DATABASE_BACKUPS_REQUEST_ORDER_BIES, validation_rules_gen_exports as ValidationRules, index_gen_exports, marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse, unmarshalListVersionsResponse };

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

@@ -1,9 +1,10 @@
 import type { DefaultValues } from '@scaleway/sdk-client';
-import type { DatabaseBackup, Database, ListDatabaseBackupsResponse, ListDatabasesResponse, CreateDatabaseRequest, RestoreDatabaseFromBackupRequest, UpdateDatabaseRequest } from './types.gen.js';
+import type { DatabaseBackup, Database, ListDatabaseBackupsResponse, ListDatabasesResponse, ListVersionsResponse, CreateDatabaseRequest, RestoreDatabaseFromBackupRequest, UpdateDatabaseRequest } from './types.gen.js';
 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 unmarshalListVersionsResponse: (data: unknown) => ListVersionsResponse;
 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

@@ -17,6 +17,14 @@ const unmarshalDatabaseBackup = (data) => {
 		status: data.status
 	};
 };
+const unmarshalVersion = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Version' failed as data isn't a dictionary.`);
+	return {
+		endOfLifeAt: unmarshalDate(data.end_of_life_at),
+		name: data.name,
+		region: data.region
+	};
+};
 const unmarshalDatabase = (data) => {
 	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'Database' failed as data isn't a dictionary.`);
 	return {
@@ -32,7 +40,8 @@ const unmarshalDatabase = (data) => {
 		projectId: data.project_id,
 		region: data.region,
 		started: data.started,
-		status: data.status
+		status: data.status,
+		version: data.version ? unmarshalVersion(data.version) : void 0
 	};
 };
 const unmarshalListDatabaseBackupsResponse = (data) => {
@@ -49,12 +58,20 @@ const unmarshalListDatabasesResponse = (data) => {
 		totalCount: data.total_count
 	};
 };
+const unmarshalListVersionsResponse = (data) => {
+	if (!isJSONObject(data)) throw new TypeError(`Unmarshalling the type 'ListVersionsResponse' failed as data isn't a dictionary.`);
+	return {
+		totalCount: data.total_count,
+		versions: unmarshalArrayOfObject(data.versions, unmarshalVersion)
+	};
+};
 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
+	project_id: request.projectId ?? defaults.defaultProjectId,
+	version: request.version
 });
 const marshalRestoreDatabaseFromBackupRequest = (request, defaults) => ({ backup_id: request.backupId });
 const marshalUpdateDatabaseRequest = (request, defaults) => ({
@@ -62,4 +79,4 @@ const marshalUpdateDatabaseRequest = (request, defaults) => ({
 	cpu_min: request.cpuMin
 });
 //#endregion
-export { marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse };
+export { marshalCreateDatabaseRequest, marshalRestoreDatabaseFromBackupRequest, marshalUpdateDatabaseRequest, unmarshalDatabase, unmarshalDatabaseBackup, unmarshalListDatabaseBackupsResponse, unmarshalListDatabasesResponse, unmarshalListVersionsResponse };

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

@@ -51,6 +51,19 @@ export declare const queriesMetadata: {
             readonly listItemTypeNamespace: '@scaleway-internal/sdk-serverless-sqldb/v1alpha1';
             readonly isPrivate: false;
             readonly description: '"';
+        }, {
+            readonly methodName: 'listVersions';
+            readonly protoName: 'ListVersions';
+            readonly paramsType: 'ListVersionsRequest';
+            readonly returnType: 'ListVersionsResponse';
+            readonly returnTypeNamespace: '@scaleway-internal/sdk-serverless-sqldb/v1alpha1';
+            readonly isList: true;
+            readonly paginationType: 'offset';
+            readonly pageParamKey: 'page';
+            readonly listItemType: 'Version';
+            readonly listItemTypeNamespace: '@scaleway-internal/sdk-serverless-sqldb/v1alpha1';
+            readonly isPrivate: false;
+            readonly description: '"';
         }];
     }];
 };

package/dist/v1alpha1/metadata.gen.js

@@ -56,6 +56,20 @@ const queriesMetadata = {
 				listItemTypeNamespace: "@scaleway-internal/sdk-serverless-sqldb/v1alpha1",
 				isPrivate: false,
 				description: "\""
+			},
+			{
+				methodName: "listVersions",
+				protoName: "ListVersions",
+				paramsType: "ListVersionsRequest",
+				returnType: "ListVersionsResponse",
+				returnTypeNamespace: "@scaleway-internal/sdk-serverless-sqldb/v1alpha1",
+				isList: true,
+				paginationType: "offset",
+				pageParamKey: "page",
+				listItemType: "Version",
+				listItemTypeNamespace: "@scaleway-internal/sdk-serverless-sqldb/v1alpha1",
+				isPrivate: false,
+				description: "\""
 			}
 		]
 	}]

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

@@ -3,6 +3,20 @@ export type DatabaseBackupStatus = 'unknown_status' | 'error' | 'ready' | 'locke
 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 Version {
+    /**
+     * Major number of the PostgreSQL engine.
+     */
+    name: string;
+    /**
+     * Date of End Of Life.
+     */
+    endOfLifeAt?: Date;
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region: ScwRegion;
+}
 export interface DatabaseBackup {
     /**
      * UUID that uniquely identifies a Serverless SQL Database backup.
@@ -102,10 +116,14 @@ export interface Database {
      * Whether your Serverless SQL Database is running or not.
      */
     started: boolean;
+    /**
+     * @deprecated The major version of the underlying database engine. (deprecated in favor of `version`).
+     */
+    engineMajorVersion?: number;
     /**
      * The major version of the underlying database engine.
      */
-    engineMajorVersion: number;
+    version?: Version;
 }
 export type CreateDatabaseRequest = {
     /**
@@ -132,6 +150,10 @@ export type CreateDatabaseRequest = {
      * The ID of the backup to create the database from.
      */
     fromBackupId?: string;
+    /**
+     * The major version of the postgreSQL requested.
+     */
+    version: string;
 };
 export type DeleteDatabaseRequest = {
     /**
@@ -253,6 +275,25 @@ export interface ListDatabasesResponse {
      */
     totalCount: number;
 }
+export type ListVersionsRequest = {
+    /**
+     * Region to target. If none is passed will use default region from the config.
+     */
+    region?: ScwRegion;
+    version?: string;
+    page?: number;
+    pageSize?: number;
+};
+export interface ListVersionsResponse {
+    /**
+     * Available PostgreSQL versions.
+     */
+    versions: Version[];
+    /**
+     * Total count of versions available.
+     */
+    totalCount: number;
+}
 export type RestoreDatabaseFromBackupRequest = {
     /**
      * Region to target. If none is passed will use default region from the config.

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

@@ -44,6 +44,15 @@ export declare const ListDatabasesRequest: {
         lessThanOrEqual: number;
     };
 };
+export declare const ListVersionsRequest: {
+    page: {
+        greaterThanOrEqual: number;
+    };
+    pageSize: {
+        greaterThanOrEqual: number;
+        lessThanOrEqual: number;
+    };
+};
 export declare const UpdateDatabaseRequest: {
     cpuMax: {
         greaterThanOrEqual: number;

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

@@ -5,6 +5,7 @@ var validation_rules_gen_exports = /* @__PURE__ */ __exportAll({
 	Database: () => Database,
 	ListDatabaseBackupsRequest: () => ListDatabaseBackupsRequest,
 	ListDatabasesRequest: () => ListDatabasesRequest,
+	ListVersionsRequest: () => ListVersionsRequest,
 	UpdateDatabaseRequest: () => UpdateDatabaseRequest
 });
 const CreateDatabaseRequest = {
@@ -41,6 +42,13 @@ const ListDatabasesRequest = {
 		lessThanOrEqual: 1e3
 	}
 };
+const ListVersionsRequest = {
+	page: { greaterThanOrEqual: 1 },
+	pageSize: {
+		greaterThanOrEqual: 1,
+		lessThanOrEqual: 100
+	}
+};
 const UpdateDatabaseRequest = {
 	cpuMax: {
 		greaterThanOrEqual: 1,
@@ -49,4 +57,4 @@ const UpdateDatabaseRequest = {
 	cpuMin: { lessThanOrEqual: 15 }
 };
 //#endregion
-export { CreateDatabaseRequest, Database, ListDatabaseBackupsRequest, ListDatabasesRequest, UpdateDatabaseRequest, validation_rules_gen_exports };
+export { CreateDatabaseRequest, Database, ListDatabaseBackupsRequest, ListDatabasesRequest, ListVersionsRequest, UpdateDatabaseRequest, validation_rules_gen_exports };

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@scaleway/sdk-serverless-sqldb",
-  "version": "2.10.0",
+  "version": "2.12.0",
   "description": "Scaleway SDK serverless-sqldb",
   "license": "Apache-2.0",
   "repository": {
@@ -33,14 +33,14 @@
   },
   "dependencies": {
     "@scaleway/random-name": "6.0.2",
-    "@scaleway/sdk-std": "2.6.0"
+    "@scaleway/sdk-std": "2.7.1"
   },
   "devDependencies": {
     "@repo/configs": "^0.1.1",
-    "@scaleway/sdk-client": "^2.6.0"
+    "@scaleway/sdk-client": "^2.7.0"
   },
   "peerDependencies": {
-    "@scaleway/sdk-client": "^2.6.0"
+    "@scaleway/sdk-client": "^2.7.0"
   },
   "engines": {
     "node": ">=20.20.2"