@scaleway/sdk 1.0.0 → 1.2.0

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

@@ -3,7 +3,7 @@ import { API as API$1 } from '../../../scw/api.js';
 import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
 import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
 import { DATABASE_BACKUP_TRANSIENT_STATUSES, INSTANCE_TRANSIENT_STATUSES, READ_REPLICA_TRANSIENT_STATUSES, INSTANCE_LOG_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from './content.gen.js';
-import { unmarshalListDatabaseEnginesResponse, unmarshalListNodeTypesResponse, unmarshalListDatabaseBackupsResponse, marshalCreateDatabaseBackupRequest, unmarshalDatabaseBackup, marshalUpdateDatabaseBackupRequest, marshalRestoreDatabaseBackupRequest, marshalUpgradeInstanceRequest, unmarshalInstance, unmarshalListInstancesResponse, marshalCreateInstanceRequest, marshalUpdateInstanceRequest, marshalCloneInstanceRequest, unmarshalInstanceMetrics, marshalCreateReadReplicaRequest, unmarshalReadReplica, marshalCreateReadReplicaEndpointRequest, marshalPrepareInstanceLogsRequest, unmarshalPrepareInstanceLogsResponse, unmarshalListInstanceLogsResponse, unmarshalInstanceLog, marshalPurgeInstanceLogsRequest, unmarshalListInstanceLogsDetailsResponse, marshalAddInstanceSettingsRequest, unmarshalAddInstanceSettingsResponse, marshalDeleteInstanceSettingsRequest, unmarshalDeleteInstanceSettingsResponse, marshalSetInstanceSettingsRequest, unmarshalSetInstanceSettingsResponse, unmarshalListInstanceACLRulesResponse, marshalAddInstanceACLRulesRequest, unmarshalAddInstanceACLRulesResponse, marshalSetInstanceACLRulesRequest, unmarshalSetInstanceACLRulesResponse, marshalDeleteInstanceACLRulesRequest, unmarshalDeleteInstanceACLRulesResponse, unmarshalListUsersResponse, marshalCreateUserRequest, unmarshalUser, marshalUpdateUserRequest, unmarshalListDatabasesResponse, marshalCreateDatabaseRequest, unmarshalDatabase, unmarshalListPrivilegesResponse, marshalSetPrivilegeRequest, unmarshalPrivilege, unmarshalListSnapshotsResponse, unmarshalSnapshot, marshalCreateSnapshotRequest, marshalUpdateSnapshotRequest, marshalCreateInstanceFromSnapshotRequest, marshalCreateEndpointRequest, unmarshalEndpoint } from './marshalling.gen.js';
+import { unmarshalListDatabaseEnginesResponse, unmarshalListNodeTypesResponse, unmarshalListDatabaseBackupsResponse, marshalCreateDatabaseBackupRequest, unmarshalDatabaseBackup, marshalUpdateDatabaseBackupRequest, marshalRestoreDatabaseBackupRequest, marshalUpgradeInstanceRequest, unmarshalInstance, unmarshalListInstancesResponse, marshalCreateInstanceRequest, marshalUpdateInstanceRequest, marshalCloneInstanceRequest, unmarshalInstanceMetrics, marshalCreateReadReplicaRequest, unmarshalReadReplica, marshalCreateReadReplicaEndpointRequest, marshalPrepareInstanceLogsRequest, unmarshalPrepareInstanceLogsResponse, unmarshalListInstanceLogsResponse, unmarshalInstanceLog, marshalPurgeInstanceLogsRequest, unmarshalListInstanceLogsDetailsResponse, marshalAddInstanceSettingsRequest, unmarshalAddInstanceSettingsResponse, marshalDeleteInstanceSettingsRequest, unmarshalDeleteInstanceSettingsResponse, marshalSetInstanceSettingsRequest, unmarshalSetInstanceSettingsResponse, unmarshalListInstanceACLRulesResponse, marshalAddInstanceACLRulesRequest, unmarshalAddInstanceACLRulesResponse, marshalSetInstanceACLRulesRequest, unmarshalSetInstanceACLRulesResponse, marshalDeleteInstanceACLRulesRequest, unmarshalDeleteInstanceACLRulesResponse, unmarshalListUsersResponse, marshalCreateUserRequest, unmarshalUser, marshalUpdateUserRequest, unmarshalListDatabasesResponse, marshalCreateDatabaseRequest, unmarshalDatabase, unmarshalListPrivilegesResponse, marshalSetPrivilegeRequest, unmarshalPrivilege, unmarshalListSnapshotsResponse, unmarshalSnapshot, marshalCreateSnapshotRequest, marshalUpdateSnapshotRequest, marshalCreateInstanceFromSnapshotRequest, marshalCreateEndpointRequest, unmarshalEndpoint, marshalMigrateEndpointRequest } from './marshalling.gen.js';
 
 // This file was automatically generated. DO NOT EDIT.
 const jsonContentHeaders = {
@@ -26,6 +26,12 @@ class API extends API$1 {
         urlParams: urlParams(['name', request.name], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['version', request.version])
       }, unmarshalListDatabaseEnginesResponse);
     };
+    /**
+     * List available database engines
+     *
+     * @param request - The request {@link ListDatabaseEnginesRequest}
+     * @returns A Promise of ListDatabaseEnginesResponse
+     */
     this.listDatabaseEngines = function (request) {
       if (request === void 0) {
         request = {};
@@ -37,6 +43,12 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/node-types`,
       urlParams: urlParams(['include_disabled_types', request.includeDisabledTypes], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListNodeTypesResponse);
+    /**
+     * List available node types
+     *
+     * @param request - The request {@link ListNodeTypesRequest}
+     * @returns A Promise of ListNodeTypesResponse
+     */
     this.listNodeTypes = request => enrichForPagination('nodeTypes', this.pageOfListNodeTypes, request);
     this.pageOfListDatabaseBackups = function (request) {
       if (request === void 0) {
@@ -45,48 +57,104 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/backups`,
-        urlParams: urlParams(['instance_id', request.instanceId], ['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+        urlParams: urlParams(['instance_id', request.instanceId], ['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId])
       }, unmarshalListDatabaseBackupsResponse);
     };
+    /**
+     * List database backups
+     *
+     * @param request - The request {@link ListDatabaseBackupsRequest}
+     * @returns A Promise of ListDatabaseBackupsResponse
+     */
     this.listDatabaseBackups = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('databaseBackups', _this.pageOfListDatabaseBackups, request);
     };
+    /**
+     * Create a database backup
+     *
+     * @param request - The request {@link CreateDatabaseBackupRequest}
+     * @returns A Promise of DatabaseBackup
+     */
     this.createDatabaseBackup = request => this.client.fetch({
       body: JSON.stringify(marshalCreateDatabaseBackupRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups`
     }, unmarshalDatabaseBackup);
+    /**
+     * Get a database backup
+     *
+     * @param request - The request {@link GetDatabaseBackupRequest}
+     * @returns A Promise of DatabaseBackup
+     */
     this.getDatabaseBackup = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}`
     }, unmarshalDatabaseBackup);
+    /**
+     * Waits for {@link DatabaseBackup} to be in a final state.
+     *
+     * @param request - The request {@link GetDatabaseBackupRequest}
+     * @param options - The waiting options
+     * @returns A Promise of DatabaseBackup
+     */
     this.waitForDatabaseBackup = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!DATABASE_BACKUP_TRANSIENT_STATUSES.includes(res.status))), this.getDatabaseBackup, request, options);
+    /**
+     * Update a database backup
+     *
+     * @param request - The request {@link UpdateDatabaseBackupRequest}
+     * @returns A Promise of DatabaseBackup
+     */
     this.updateDatabaseBackup = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateDatabaseBackupRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}`
     }, unmarshalDatabaseBackup);
+    /**
+     * Delete a database backup
+     *
+     * @param request - The request {@link DeleteDatabaseBackupRequest}
+     * @returns A Promise of DatabaseBackup
+     */
     this.deleteDatabaseBackup = request => this.client.fetch({
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}`
     }, unmarshalDatabaseBackup);
+    /**
+     * Restore a database backup
+     *
+     * @param request - The request {@link RestoreDatabaseBackupRequest}
+     * @returns A Promise of DatabaseBackup
+     */
     this.restoreDatabaseBackup = request => this.client.fetch({
       body: JSON.stringify(marshalRestoreDatabaseBackupRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}/restore`
     }, unmarshalDatabaseBackup);
+    /**
+     * Export a database backup
+     *
+     * @param request - The request {@link ExportDatabaseBackupRequest}
+     * @returns A Promise of DatabaseBackup
+     */
     this.exportDatabaseBackup = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}/export`
     }, unmarshalDatabaseBackup);
+    /**
+     * Upgrade your current instance specifications like node type, high
+     * availability, volume, or db engine version.
+     *
+     * @param request - The request {@link UpgradeInstanceRequest}
+     * @returns A Promise of Instance
+     */
     this.upgradeInstance = request => this.client.fetch({
       body: JSON.stringify(marshalUpgradeInstanceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -100,130 +168,292 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/instances`,
-        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId], ['tags', request.tags])
+        urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['tags', request.tags])
       }, unmarshalListInstancesResponse);
     };
+    /**
+     * List instances
+     *
+     * @param request - The request {@link ListInstancesRequest}
+     * @returns A Promise of ListInstancesResponse
+     */
     this.listInstances = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('instances', _this.pageOfListInstances, request);
     };
+    /**
+     * Get an instance
+     *
+     * @param request - The request {@link GetInstanceRequest}
+     * @returns A Promise of Instance
+     */
     this.getInstance = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}`
     }, unmarshalInstance);
+    /**
+     * Waits for {@link Instance} to be in a final state.
+     *
+     * @param request - The request {@link GetInstanceRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Instance
+     */
     this.waitForInstance = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!INSTANCE_TRANSIENT_STATUSES.includes(res.status))), this.getInstance, request, options);
+    /**
+     * Create an instance
+     *
+     * @param request - The request {@link CreateInstanceRequest}
+     * @returns A Promise of Instance
+     */
     this.createInstance = request => this.client.fetch({
       body: JSON.stringify(marshalCreateInstanceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances`
     }, unmarshalInstance);
+    /**
+     * Update an instance
+     *
+     * @param request - The request {@link UpdateInstanceRequest}
+     * @returns A Promise of Instance
+     */
     this.updateInstance = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateInstanceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}`
     }, unmarshalInstance);
+    /**
+     * Delete an instance
+     *
+     * @param request - The request {@link DeleteInstanceRequest}
+     * @returns A Promise of Instance
+     */
     this.deleteInstance = request => this.client.fetch({
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}`
     }, unmarshalInstance);
+    /**
+     * Clone an instance
+     *
+     * @param request - The request {@link CloneInstanceRequest}
+     * @returns A Promise of Instance
+     */
     this.cloneInstance = request => this.client.fetch({
       body: JSON.stringify(marshalCloneInstanceRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/clone`
     }, unmarshalInstance);
+    /**
+     * Restart an instance
+     *
+     * @param request - The request {@link RestartInstanceRequest}
+     * @returns A Promise of Instance
+     */
     this.restartInstance = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/restart`
     }, unmarshalInstance);
+    /**
+     * Get the TLS certificate of an instance
+     *
+     * @param request - The request {@link GetInstanceCertificateRequest}
+     * @returns A Promise of Blob
+     */
     this.getInstanceCertificate = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/certificate`,
       urlParams: urlParams(['dl', 1]),
       responseType: 'blob'
     });
+    /**
+     * Renew the TLS certificate of an instance
+     *
+     * @param request - The request {@link RenewInstanceCertificateRequest}
+     */
     this.renewInstanceCertificate = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/renew-certificate`
     });
+    /**
+     * Get database instance metrics.
+     *
+     * @param request - The request {@link GetInstanceMetricsRequest}
+     * @returns A Promise of InstanceMetrics
+     */
     this.getInstanceMetrics = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/metrics`,
       urlParams: urlParams(['end_date', request.endDate], ['metric_name', request.metricName], ['start_date', request.startDate])
     }, unmarshalInstanceMetrics);
+    /**
+     * You can only create a maximum of 3 read replicas for one instance.
+     *
+     * @param request - The request {@link CreateReadReplicaRequest}
+     * @returns A Promise of ReadReplica
+     */
     this.createReadReplica = request => this.client.fetch({
       body: JSON.stringify(marshalCreateReadReplicaRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/read-replicas`
     }, unmarshalReadReplica);
+    /**
+     * Get a read replica
+     *
+     * @param request - The request {@link GetReadReplicaRequest}
+     * @returns A Promise of ReadReplica
+     */
     this.getReadReplica = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/read-replicas/${validatePathParam('readReplicaId', request.readReplicaId)}`
     }, unmarshalReadReplica);
+    /**
+     * Waits for {@link ReadReplica} to be in a final state.
+     *
+     * @param request - The request {@link GetReadReplicaRequest}
+     * @param options - The waiting options
+     * @returns A Promise of ReadReplica
+     */
     this.waitForReadReplica = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!READ_REPLICA_TRANSIENT_STATUSES.includes(res.status))), this.getReadReplica, request, options);
+    /**
+     * Delete a read replica
+     *
+     * @param request - The request {@link DeleteReadReplicaRequest}
+     * @returns A Promise of ReadReplica
+     */
     this.deleteReadReplica = request => this.client.fetch({
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/read-replicas/${validatePathParam('readReplicaId', request.readReplicaId)}`
     }, unmarshalReadReplica);
+    /**
+     * When you resync a read replica, first it is reset, and then its data is
+     * resynchronized from the primary node. Your read replica will be unavailable
+     * during the resync process. The duration of this process is proportional to
+     * your Database Instance size. The configured endpoints will not change.
+     *
+     * @param request - The request {@link ResetReadReplicaRequest}
+     * @returns A Promise of ReadReplica
+     */
     this.resetReadReplica = request => this.client.fetch({
       body: '{}',
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/read-replicas/${validatePathParam('readReplicaId', request.readReplicaId)}/reset`
     }, unmarshalReadReplica);
+    /**
+     * A read replica can have at most one direct access and one private network
+     * endpoint.
+     *
+     * @param request - The request {@link CreateReadReplicaEndpointRequest}
+     * @returns A Promise of ReadReplica
+     */
     this.createReadReplicaEndpoint = request => this.client.fetch({
       body: JSON.stringify(marshalCreateReadReplicaEndpointRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/read-replicas/${validatePathParam('readReplicaId', request.readReplicaId)}/endpoints`
     }, unmarshalReadReplica);
+    /**
+     * Prepare your instance logs. Logs will be grouped on a minimum interval of a
+     * day.
+     *
+     * @param request - The request {@link PrepareInstanceLogsRequest}
+     * @returns A Promise of PrepareInstanceLogsResponse
+     */
     this.prepareInstanceLogs = request => this.client.fetch({
       body: JSON.stringify(marshalPrepareInstanceLogsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/prepare-logs`
     }, unmarshalPrepareInstanceLogsResponse);
+    /**
+     * List available logs of a given instance
+     *
+     * @param request - The request {@link ListInstanceLogsRequest}
+     * @returns A Promise of ListInstanceLogsResponse
+     */
     this.listInstanceLogs = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/logs`,
       urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'])
     }, unmarshalListInstanceLogsResponse);
+    /**
+     * Get specific logs of a given instance
+     *
+     * @param request - The request {@link GetInstanceLogRequest}
+     * @returns A Promise of InstanceLog
+     */
     this.getInstanceLog = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/logs/${validatePathParam('instanceLogId', request.instanceLogId)}`
     }, unmarshalInstanceLog);
+    /**
+     * Waits for {@link InstanceLog} to be in a final state.
+     *
+     * @param request - The request {@link GetInstanceLogRequest}
+     * @param options - The waiting options
+     * @returns A Promise of InstanceLog
+     */
     this.waitForInstanceLog = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!INSTANCE_LOG_TRANSIENT_STATUSES.includes(res.status))), this.getInstanceLog, request, options);
+    /**
+     * Purge remote instances logs
+     *
+     * @param request - The request {@link PurgeInstanceLogsRequest}
+     */
     this.purgeInstanceLogs = request => this.client.fetch({
       body: JSON.stringify(marshalPurgeInstanceLogsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/purge-logs`
     });
+    /**
+     * List remote instances logs details
+     *
+     * @param request - The request {@link ListInstanceLogsDetailsRequest}
+     * @returns A Promise of ListInstanceLogsDetailsResponse
+     */
     this.listInstanceLogsDetails = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/logs-details`
     }, unmarshalListInstanceLogsDetailsResponse);
+    /**
+     * Add an instance setting
+     *
+     * @param request - The request {@link AddInstanceSettingsRequest}
+     * @returns A Promise of AddInstanceSettingsResponse
+     */
     this.addInstanceSettings = request => this.client.fetch({
       body: JSON.stringify(marshalAddInstanceSettingsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/settings`
     }, unmarshalAddInstanceSettingsResponse);
+    /**
+     * Delete an instance setting
+     *
+     * @param request - The request {@link DeleteInstanceSettingsRequest}
+     * @returns A Promise of DeleteInstanceSettingsResponse
+     */
     this.deleteInstanceSettings = request => this.client.fetch({
       body: JSON.stringify(marshalDeleteInstanceSettingsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/settings`
     }, unmarshalDeleteInstanceSettingsResponse);
+    /**
+     * Set a given instance setting
+     *
+     * @param request - The request {@link SetInstanceSettingsRequest}
+     * @returns A Promise of SetInstanceSettingsResponse
+     */
     this.setInstanceSettings = request => this.client.fetch({
       body: JSON.stringify(marshalSetInstanceSettingsRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -235,19 +465,43 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/acls`,
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListInstanceACLRulesResponse);
+    /**
+     * List ACL rules of a given instance
+     *
+     * @param request - The request {@link ListInstanceACLRulesRequest}
+     * @returns A Promise of ListInstanceACLRulesResponse
+     */
     this.listInstanceACLRules = request => enrichForPagination('rules', this.pageOfListInstanceACLRules, request);
+    /**
+     * Add an additional ACL rule to a database instance.
+     *
+     * @param request - The request {@link AddInstanceACLRulesRequest}
+     * @returns A Promise of AddInstanceACLRulesResponse
+     */
     this.addInstanceACLRules = request => this.client.fetch({
       body: JSON.stringify(marshalAddInstanceACLRulesRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/acls`
     }, unmarshalAddInstanceACLRulesResponse);
+    /**
+     * Replace all the ACL rules of a database instance.
+     *
+     * @param request - The request {@link SetInstanceACLRulesRequest}
+     * @returns A Promise of SetInstanceACLRulesResponse
+     */
     this.setInstanceACLRules = request => this.client.fetch({
       body: JSON.stringify(marshalSetInstanceACLRulesRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PUT',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/acls`
     }, unmarshalSetInstanceACLRulesResponse);
+    /**
+     * Delete ACL rules of a given instance
+     *
+     * @param request - The request {@link DeleteInstanceACLRulesRequest}
+     * @returns A Promise of DeleteInstanceACLRulesResponse
+     */
     this.deleteInstanceACLRules = request => this.client.fetch({
       body: JSON.stringify(marshalDeleteInstanceACLRulesRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -259,19 +513,42 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/users`,
       urlParams: urlParams(['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListUsersResponse);
+    /**
+     * List users of a given instance
+     *
+     * @param request - The request {@link ListUsersRequest}
+     * @returns A Promise of ListUsersResponse
+     */
     this.listUsers = request => enrichForPagination('users', this.pageOfListUsers, request);
+    /**
+     * Create a user on a given instance
+     *
+     * @param request - The request {@link CreateUserRequest}
+     * @returns A Promise of User
+     */
     this.createUser = request => this.client.fetch({
       body: JSON.stringify(marshalCreateUserRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/users`
     }, unmarshalUser);
+    /**
+     * Update a user on a given instance
+     *
+     * @param request - The request {@link UpdateUserRequest}
+     * @returns A Promise of User
+     */
     this.updateUser = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateUserRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/users/${validatePathParam('name', request.name)}`
     }, unmarshalUser);
+    /**
+     * Delete a user on a given instance
+     *
+     * @param request - The request {@link DeleteUserRequest}
+     */
     this.deleteUser = request => this.client.fetch({
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/users/${validatePathParam('name', request.name)}`
@@ -281,13 +558,30 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/databases`,
       urlParams: urlParams(['managed', request.managed], ['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['owner', request.owner], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListDatabasesResponse);
+    /**
+     * List all database in a given instance
+     *
+     * @param request - The request {@link ListDatabasesRequest}
+     * @returns A Promise of ListDatabasesResponse
+     */
     this.listDatabases = request => enrichForPagination('databases', this.pageOfListDatabases, request);
+    /**
+     * Create a database in a given instance
+     *
+     * @param request - The request {@link CreateDatabaseRequest}
+     * @returns A Promise of Database
+     */
     this.createDatabase = request => this.client.fetch({
       body: JSON.stringify(marshalCreateDatabaseRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/databases`
     }, unmarshalDatabase);
+    /**
+     * Delete a database in a given instance
+     *
+     * @param request - The request {@link DeleteDatabaseRequest}
+     */
     this.deleteDatabase = request => this.client.fetch({
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/databases/${validatePathParam('name', request.name)}`
@@ -297,7 +591,19 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/privileges`,
       urlParams: urlParams(['database_name', request.databaseName], ['order_by', request.orderBy ?? 'user_name_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['user_name', request.userName])
     }, unmarshalListPrivilegesResponse);
+    /**
+     * List privileges of a given user for a given database on a given instance
+     *
+     * @param request - The request {@link ListPrivilegesRequest}
+     * @returns A Promise of ListPrivilegesResponse
+     */
     this.listPrivileges = request => enrichForPagination('privileges', this.pageOfListPrivileges, request);
+    /**
+     * Set privileges of a given user for a given database on a given instance
+     *
+     * @param request - The request {@link SetPrivilegeRequest}
+     * @returns A Promise of Privilege
+     */
     this.setPrivilege = request => this.client.fetch({
       body: JSON.stringify(marshalSetPrivilegeRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
@@ -311,58 +617,131 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/snapshots`,
-        urlParams: urlParams(['instance_id', request.instanceId], ['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId ?? _this.client.settings.defaultOrganizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId ?? _this.client.settings.defaultProjectId])
+        urlParams: urlParams(['instance_id', request.instanceId], ['name', request.name], ['order_by', request.orderBy ?? 'created_at_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId])
       }, unmarshalListSnapshotsResponse);
     };
+    /**
+     * List instance snapshots
+     *
+     * @param request - The request {@link ListSnapshotsRequest}
+     * @returns A Promise of ListSnapshotsResponse
+     */
     this.listSnapshots = function (request) {
       if (request === void 0) {
         request = {};
       }
       return enrichForPagination('snapshots', _this.pageOfListSnapshots, request);
     };
+    /**
+     * Get an instance snapshot
+     *
+     * @param request - The request {@link GetSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
     this.getSnapshot = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
     }, unmarshalSnapshot);
+    /**
+     * Waits for {@link Snapshot} to be in a final state.
+     *
+     * @param request - The request {@link GetSnapshotRequest}
+     * @param options - The waiting options
+     * @returns A Promise of Snapshot
+     */
     this.waitForSnapshot = (request, options) => waitForResource((options == null ? void 0 : options.stop) ?? (res => Promise.resolve(!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status))), this.getSnapshot, request, options);
+    /**
+     * Create an instance snapshot
+     *
+     * @param request - The request {@link CreateSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
     this.createSnapshot = request => this.client.fetch({
       body: JSON.stringify(marshalCreateSnapshotRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/snapshots`
     }, unmarshalSnapshot);
+    /**
+     * Update an instance snapshot
+     *
+     * @param request - The request {@link UpdateSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
     this.updateSnapshot = request => this.client.fetch({
       body: JSON.stringify(marshalUpdateSnapshotRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'PATCH',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
     }, unmarshalSnapshot);
+    /**
+     * Delete an instance snapshot
+     *
+     * @param request - The request {@link DeleteSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
     this.deleteSnapshot = request => this.client.fetch({
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
     }, unmarshalSnapshot);
+    /**
+     * Create a new instance from a given snapshot
+     *
+     * @param request - The request {@link CreateInstanceFromSnapshotRequest}
+     * @returns A Promise of Instance
+     */
     this.createInstanceFromSnapshot = request => this.client.fetch({
       body: JSON.stringify(marshalCreateInstanceFromSnapshotRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}/create-instance`
     }, unmarshalInstance);
+    /**
+     * Create a new instance endpoint
+     *
+     * @param request - The request {@link CreateEndpointRequest}
+     * @returns A Promise of Endpoint
+     */
     this.createEndpoint = request => this.client.fetch({
       body: JSON.stringify(marshalCreateEndpointRequest(request, this.client.settings)),
       headers: jsonContentHeaders,
       method: 'POST',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/endpoints`
     }, unmarshalEndpoint);
+    /**
+     * Delete an instance endpoint
+     *
+     * @param request - The request {@link DeleteEndpointRequest}
+     */
     this.deleteEndpoint = request => this.client.fetch({
       method: 'DELETE',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
     });
+    /**
+     * Get an instance endpoint
+     *
+     * @param request - The request {@link GetEndpointRequest}
+     * @returns A Promise of Endpoint
+     */
     this.getEndpoint = request => this.client.fetch({
       method: 'GET',
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
     }, unmarshalEndpoint);
+    /**
+     * Migrate an existing instance endpoint to another instance
+     *
+     * @param request - The request {@link MigrateEndpointRequest}
+     * @returns A Promise of Endpoint
+     */
+    this.migrateEndpoint = request => this.client.fetch({
+      body: JSON.stringify(marshalMigrateEndpointRequest(request, this.client.settings)),
+      headers: jsonContentHeaders,
+      method: 'POST',
+      path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam('endpointId', request.endpointId)}/migrate`
+    }, unmarshalEndpoint);
   }
 }
+/** Lists the available regions of the API. */
 API.LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
 
 export { API };