@scaleway/sdk 1.2.0 → 1.5.0

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

@@ -10,7 +10,7 @@ const jsonContentHeaders = {
   'Content-Type': 'application/json; charset=utf-8'
 };
 
-/** Database RDB API. */
+/** Managed Database for PostgreSQL and MySQL API. */
 class API extends API$1 {
   constructor() {
     var _this;
@@ -27,7 +27,8 @@ class API extends API$1 {
       }, unmarshalListDatabaseEnginesResponse);
     };
     /**
-     * List available database engines
+     * List available database engines. List the PostgreSQL and MySQL database
+     * engines available at Scaleway.
      *
      * @param request - The request {@link ListDatabaseEnginesRequest}
      * @returns A Promise of ListDatabaseEnginesResponse
@@ -44,7 +45,9 @@ class API extends API$1 {
       urlParams: urlParams(['include_disabled_types', request.includeDisabledTypes], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListNodeTypesResponse);
     /**
-     * List available node types
+     * List available node types. List all available node types. By default, the
+     * node types returned in the list are ordered by creation date in ascending
+     * order, though this can be modified via the `order_by` field.
      *
      * @param request - The request {@link ListNodeTypesRequest}
      * @returns A Promise of ListNodeTypesResponse
@@ -61,7 +64,10 @@ class API extends API$1 {
       }, unmarshalListDatabaseBackupsResponse);
     };
     /**
-     * List database backups
+     * List database backups. List all backups in a specified region, for a given
+     * Scaleway Organization or Scaleway Project. By default, the backups listed
+     * are ordered by creation date in ascending order. This can be modified via
+     * the `order_by` field.
      *
      * @param request - The request {@link ListDatabaseBackupsRequest}
      * @returns A Promise of ListDatabaseBackupsResponse
@@ -73,7 +79,8 @@ class API extends API$1 {
       return enrichForPagination('databaseBackups', _this.pageOfListDatabaseBackups, request);
     };
     /**
-     * Create a database backup
+     * Create a database backup. Create a new backup. You must set the
+     * `instance_id`, `database_name`, `name` and `expires_at` parameters.
      *
      * @param request - The request {@link CreateDatabaseBackupRequest}
      * @returns A Promise of DatabaseBackup
@@ -85,7 +92,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups`
     }, unmarshalDatabaseBackup);
     /**
-     * Get a database backup
+     * Get a database backup. Retrieve information about a given backup, specified
+     * by its database backup ID and region. Full details about the backup, like
+     * size, URL and expiration date, are returned in the response.
      *
      * @param request - The request {@link GetDatabaseBackupRequest}
      * @returns A Promise of DatabaseBackup
@@ -103,7 +112,8 @@ class API extends API$1 {
      */
     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
+     * Update a database backup. Update the parameters of a backup, including name
+     * and expiration date.
      *
      * @param request - The request {@link UpdateDatabaseBackupRequest}
      * @returns A Promise of DatabaseBackup
@@ -115,7 +125,8 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}`
     }, unmarshalDatabaseBackup);
     /**
-     * Delete a database backup
+     * Delete a database backup. Delete a backup, specified by its database backup
+     * ID and region. Deleting a backup is permanent, and cannot be undone.
      *
      * @param request - The request {@link DeleteDatabaseBackupRequest}
      * @returns A Promise of DatabaseBackup
@@ -125,7 +136,10 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}`
     }, unmarshalDatabaseBackup);
     /**
-     * Restore a database backup
+     * Restore a database backup. Launch the process of restoring database backup.
+     * You must specify the `instance_id` of the Database Instance of destination,
+     * where the backup will be restored. Note that large database backups can
+     * take up to several hours to restore.
      *
      * @param request - The request {@link RestoreDatabaseBackupRequest}
      * @returns A Promise of DatabaseBackup
@@ -137,7 +151,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/backups/${validatePathParam('databaseBackupId', request.databaseBackupId)}/restore`
     }, unmarshalDatabaseBackup);
     /**
-     * Export a database backup
+     * Export a database backup. Export a backup, specified by the
+     * `database_backup_id` and the `region` parameters. The download URL is
+     * returned in the response.
      *
      * @param request - The request {@link ExportDatabaseBackupRequest}
      * @returns A Promise of DatabaseBackup
@@ -149,8 +165,10 @@ class API extends API$1 {
       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.
+     * Upgrade a Database Instance. Upgrade your current Database Instance
+     * specifications like node type, high availability, volume, or the database
+     * engine version. Note that upon upgrade the `enable_ha` parameter can only
+     * be set to `true`.
      *
      * @param request - The request {@link UpgradeInstanceRequest}
      * @returns A Promise of Instance
@@ -172,7 +190,14 @@ class API extends API$1 {
       }, unmarshalListInstancesResponse);
     };
     /**
-     * List instances
+     * List Database Instances. List all Database Instances in the specified
+     * region, for a given Scaleway Organization or Scaleway Project. By default,
+     * the Database Instances returned in the list are ordered by creation date in
+     * ascending order, though this can be modified via the order_by field. You
+     * can define additional parameters for your query, such as `tags` and `name`.
+     * For the `name` parameter, the value you include will be checked against the
+     * whole name string to see if it includes the string you put in the
+     * parameter.
      *
      * @param request - The request {@link ListInstancesRequest}
      * @returns A Promise of ListInstancesResponse
@@ -184,7 +209,10 @@ class API extends API$1 {
       return enrichForPagination('instances', _this.pageOfListInstances, request);
     };
     /**
-     * Get an instance
+     * Get a Database Instance. Retrieve information about a given Database
+     * Instance, specified by the `region` and `instance_id` parameters. Its full
+     * details, including name, status, IP address and port, are returned in the
+     * response object.
      *
      * @param request - The request {@link GetInstanceRequest}
      * @returns A Promise of Instance
@@ -202,7 +230,9 @@ class API extends API$1 {
      */
     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
+     * Create a Database Instance. Create a new Database Instance. You must set
+     * the `engine`, `user_name`, `password` and `node_type` parameters.
+     * Optionally, you can specify the volume type and size.
      *
      * @param request - The request {@link CreateInstanceRequest}
      * @returns A Promise of Instance
@@ -214,7 +244,8 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances`
     }, unmarshalInstance);
     /**
-     * Update an instance
+     * Update a Database Instance. Update the parameters of a Database Instance,
+     * including name, tags and backup schedule details.
      *
      * @param request - The request {@link UpdateInstanceRequest}
      * @returns A Promise of Instance
@@ -226,7 +257,10 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}`
     }, unmarshalInstance);
     /**
-     * Delete an instance
+     * Delete a Database Instance. Delete a given Database Instance, specified by
+     * the `region` and `instance_id` parameters. Deleting a Database Instance is
+     * permanent, and cannot be undone. Note that upon deletion all your data will
+     * be lost.
      *
      * @param request - The request {@link DeleteInstanceRequest}
      * @returns A Promise of Instance
@@ -236,7 +270,11 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}`
     }, unmarshalInstance);
     /**
-     * Clone an instance
+     * Clone a Database Instance. Clone a given Database Instance, specified by
+     * the `region` and `instance_id` parameters. The clone feature allows you to
+     * create a new Database Instance from an existing one. The clone includes all
+     * existing databases, users and permissions. You can create a clone on a
+     * Database Instance bigger than your current one.
      *
      * @param request - The request {@link CloneInstanceRequest}
      * @returns A Promise of Instance
@@ -248,7 +286,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/clone`
     }, unmarshalInstance);
     /**
-     * Restart an instance
+     * Restart Database Instance. Restart a given Database Instance, specified by
+     * the `region` and `instance_id` parameters. The status of the Database
+     * Instance returned in the response.
      *
      * @param request - The request {@link RestartInstanceRequest}
      * @returns A Promise of Instance
@@ -260,7 +300,9 @@ class API extends API$1 {
       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
+     * Get the TLS certificate of a Database Instance. Retrieve information about
+     * the TLS certificate of a given Database Instance. Details like name and
+     * content are returned in the response.
      *
      * @param request - The request {@link GetInstanceCertificateRequest}
      * @returns A Promise of Blob
@@ -272,7 +314,11 @@ class API extends API$1 {
       responseType: 'blob'
     });
     /**
-     * Renew the TLS certificate of an instance
+     * Renew the TLS certificate of a Database Instance. Renew a TLS for a
+     * Database Instance. Renewing a certificate means that you will not be able
+     * to connect to your Database Instance using the previous certificate. You
+     * will also need to download and update the new certificate for all database
+     * clients.
      *
      * @param request - The request {@link RenewInstanceCertificateRequest}
      */
@@ -283,7 +329,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/renew-certificate`
     });
     /**
-     * Get database instance metrics.
+     * Get Database Instance metrics. Retrieve the time series metrics of a given
+     * Database Instance. You can define the period from which to retrieve metrics
+     * by specifying the `start_date` and `end_date`.
      *
      * @param request - The request {@link GetInstanceMetricsRequest}
      * @returns A Promise of InstanceMetrics
@@ -294,7 +342,9 @@ class API extends API$1 {
       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.
+     * Create a Read Replica. Create a new Read Replica of a Database Instance.
+     * You must specify the `region` and the `instance_id`. You can only create a
+     * maximum of 3 Read Replicas per Database Instance.
      *
      * @param request - The request {@link CreateReadReplicaRequest}
      * @returns A Promise of ReadReplica
@@ -306,7 +356,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/read-replicas`
     }, unmarshalReadReplica);
     /**
-     * Get a read replica
+     * Get a Read Replica. Retrieve information about a Database Instance Read
+     * Replica. Full details about the Read Replica, like `endpoints`, `status`
+     * and `region` are returned in the response.
      *
      * @param request - The request {@link GetReadReplicaRequest}
      * @returns A Promise of ReadReplica
@@ -324,7 +376,9 @@ class API extends API$1 {
      */
     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
+     * Delete a Read Replica. Delete a Read Replica of a Database Instance. You
+     * must specify the `region` and `read_replica_id` parameters of the Read
+     * Replica you want to delete.
      *
      * @param request - The request {@link DeleteReadReplicaRequest}
      * @returns A Promise of ReadReplica
@@ -334,10 +388,11 @@ class API extends API$1 {
       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.
+     * Resync a Read Replica. When you resync a Read Replica, first it is reset,
+     * then its data is resynchronized from the primary node. Your Read Replica
+     * remains unavailable during the resync process. The duration of this process
+     * is proportional to the size of your Database Instance. The configured
+     * endpoints do not change.
      *
      * @param request - The request {@link ResetReadReplicaRequest}
      * @returns A Promise of ReadReplica
@@ -349,8 +404,9 @@ class API extends API$1 {
       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.
+     * Create an endpoint for a Read Replica. Create a new endpoint for a Read
+     * Replica. Read Replicas can have at most one direct access and one Private
+     * Network endpoint.
      *
      * @param request - The request {@link CreateReadReplicaEndpointRequest}
      * @returns A Promise of ReadReplica
@@ -362,8 +418,12 @@ class API extends API$1 {
       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.
+     * Prepare logs of a Database Instance. Prepare your Database Instance logs.
+     * You can define the `start_date` and `end_date` parameters for your query.
+     * The download URL is returned in the response. Logs are recorded from 00h00
+     * to 23h59 and then aggregated in a `.log` file once a day. Therefore, even
+     * if you specify a timeframe from which you want to get the logs, you will
+     * receive logs from the full 24 hours.
      *
      * @param request - The request {@link PrepareInstanceLogsRequest}
      * @returns A Promise of PrepareInstanceLogsResponse
@@ -375,7 +435,10 @@ class API extends API$1 {
       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
+     * List available logs of a Database Instance. List the available logs of a
+     * Database Instance. By default, the logs returned in the list are ordered by
+     * creation date in ascending order, though this can be modified via the
+     * order_by field.
      *
      * @param request - The request {@link ListInstanceLogsRequest}
      * @returns A Promise of ListInstanceLogsResponse
@@ -386,7 +449,10 @@ class API extends API$1 {
       urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'])
     }, unmarshalListInstanceLogsResponse);
     /**
-     * Get specific logs of a given instance
+     * Get given logs of a Database Instance. Retrieve information about the logs
+     * of a Database Instance. Specify the `instance_log_id` and `region` in your
+     * request to get information such as `download_url`, `status`, `expires_at`
+     * and `created_at` about your logs in the response.
      *
      * @param request - The request {@link GetInstanceLogRequest}
      * @returns A Promise of InstanceLog
@@ -404,7 +470,9 @@ class API extends API$1 {
      */
     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
+     * Purge remote Database Instance logs. Purge a given remote log from a
+     * Database Instance. You can specify the `log_name` of the log you wish to
+     * clean from your Database Instance.
      *
      * @param request - The request {@link PurgeInstanceLogsRequest}
      */
@@ -415,7 +483,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/purge-logs`
     });
     /**
-     * List remote instances logs details
+     * List remote Database Instance logs details. List remote log details. By
+     * default, the details returned in the list are ordered by creation date in
+     * ascending order, though this can be modified via the order_by field.
      *
      * @param request - The request {@link ListInstanceLogsDetailsRequest}
      * @returns A Promise of ListInstanceLogsDetailsResponse
@@ -425,7 +495,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/logs-details`
     }, unmarshalListInstanceLogsDetailsResponse);
     /**
-     * Add an instance setting
+     * Add Database Instance advanced settings. Add an advanced setting to a
+     * Database Instance. You must set the `name` and the `value` of each
+     * setting.
      *
      * @param request - The request {@link AddInstanceSettingsRequest}
      * @returns A Promise of AddInstanceSettingsResponse
@@ -437,7 +509,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/settings`
     }, unmarshalAddInstanceSettingsResponse);
     /**
-     * Delete an instance setting
+     * Delete Database Instance advanced settings. Delete an advanced setting in a
+     * Database Instance. You must specify the names of the settings you want to
+     * delete in the request.
      *
      * @param request - The request {@link DeleteInstanceSettingsRequest}
      * @returns A Promise of DeleteInstanceSettingsResponse
@@ -449,7 +523,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/settings`
     }, unmarshalDeleteInstanceSettingsResponse);
     /**
-     * Set a given instance setting
+     * Set Database Instance advanced settings. Update an advanced setting for a
+     * Database Instance. Settings added upon database engine initalization can
+     * only be defined once, and cannot, therefore, be updated.
      *
      * @param request - The request {@link SetInstanceSettingsRequest}
      * @returns A Promise of SetInstanceSettingsResponse
@@ -466,14 +542,18 @@ class API extends API$1 {
       urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize])
     }, unmarshalListInstanceACLRulesResponse);
     /**
-     * List ACL rules of a given instance
+     * List ACL rules of a Database Instance. List the ACL rules for a given
+     * Database Instance. The response is an array of ACL objects, each one
+     * representing an ACL that denies, allows or redirects traffic based on
+     * certain conditions.
      *
      * @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.
+     * Add an ACL rule to a Database Instance. Add an additional ACL rule to a
+     * Database Instance.
      *
      * @param request - The request {@link AddInstanceACLRulesRequest}
      * @returns A Promise of AddInstanceACLRulesResponse
@@ -485,7 +565,8 @@ class API extends API$1 {
       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.
+     * Set ACL rules for a Database Instance. Replace all the ACL rules of a
+     * Database Instance.
      *
      * @param request - The request {@link SetInstanceACLRulesRequest}
      * @returns A Promise of SetInstanceACLRulesResponse
@@ -497,7 +578,8 @@ class API extends API$1 {
       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
+     * Delete ACL rules of a Database Instance. Delete one or more ACL rules of a
+     * Database Instance.
      *
      * @param request - The request {@link DeleteInstanceACLRulesRequest}
      * @returns A Promise of DeleteInstanceACLRulesResponse
@@ -514,14 +596,19 @@ class API extends API$1 {
       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
+     * List users of a Database Instance. List all users of a given Database
+     * Instance. By default, the users returned in the list are ordered by
+     * creation date in ascending order, though this can be modified via the
+     * order_by field.
      *
      * @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
+     * Create a user for a Database Instance. Create a new user for a Database
+     * Instance. You must define the `name`, `password` and `is_admin`
+     * parameters.
      *
      * @param request - The request {@link CreateUserRequest}
      * @returns A Promise of User
@@ -533,7 +620,9 @@ class API extends API$1 {
       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
+     * Update a user on a Database Instance. Update the parameters of a user on a
+     * Database Instance. You can update the `password` and `is_admin` parameters,
+     * but you cannot change the name of the user.
      *
      * @param request - The request {@link UpdateUserRequest}
      * @returns A Promise of User
@@ -545,7 +634,9 @@ class API extends API$1 {
       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
+     * Delete a user on a Database Instance. Delete a given user on a Database
+     * Instance. You must specify, in the endpoint, the `region`, `instance_id`
+     * and `name` parameters of the user you want to delete.
      *
      * @param request - The request {@link DeleteUserRequest}
      */
@@ -559,14 +650,19 @@ class API extends API$1 {
       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
+     * List databases in a Database Instance. List all databases of a given
+     * Database Instance. By default, the databases returned in the list are
+     * ordered by creation date in ascending order, though this can be modified
+     * via the order_by field. You can define additional parameters for your
+     * query, such as `name`, `managed` and `owner`.
      *
      * @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
+     * Create a database in a Database Instance. Create a new database. You must
+     * define the `name` parameter in the request.
      *
      * @param request - The request {@link CreateDatabaseRequest}
      * @returns A Promise of Database
@@ -578,7 +674,9 @@ class API extends API$1 {
       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
+     * Delete a database in a Database Instance. Delete a given database on a
+     * Database Instance. You must specify, in the endpoint, the `region`,
+     * `instance_id` and `name` parameters of the database you want to delete.
      *
      * @param request - The request {@link DeleteDatabaseRequest}
      */
@@ -592,14 +690,20 @@ class API extends API$1 {
       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
+     * List user privileges for a database. List privileges of a user on a
+     * database. By default, the details returned in the list are ordered by
+     * creation date in ascending order, though this can be modified via the
+     * order_by field. You can define additional parameters for your query, such
+     * as `database_name` and `user_name`.
      *
      * @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
+     * Set user privileges for a database. Set the privileges of a user on a
+     * database. You must define `database_name`, `user_name` and `permission` in
+     * the request body.
      *
      * @param request - The request {@link SetPrivilegeRequest}
      * @returns A Promise of Privilege
@@ -621,7 +725,11 @@ class API extends API$1 {
       }, unmarshalListSnapshotsResponse);
     };
     /**
-     * List instance snapshots
+     * List snapshots. List snapshots. You can include the `instance_id` or
+     * `project_id` in your query to get the list of snapshots for specific
+     * Database Instances and/or Projects. By default, the details returned in the
+     * list are ordered by creation date in ascending order, though this can be
+     * modified via the `order_by` field.
      *
      * @param request - The request {@link ListSnapshotsRequest}
      * @returns A Promise of ListSnapshotsResponse
@@ -633,7 +741,9 @@ class API extends API$1 {
       return enrichForPagination('snapshots', _this.pageOfListSnapshots, request);
     };
     /**
-     * Get an instance snapshot
+     * Get a Database Instance snapshot. Retrieve information about a given
+     * snapshot, specified by its `snapshot_id` and `region`. Full details about
+     * the snapshot, like size and expiration date, are returned in the response.
      *
      * @param request - The request {@link GetSnapshotRequest}
      * @returns A Promise of Snapshot
@@ -651,7 +761,8 @@ class API extends API$1 {
      */
     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
+     * Create a Database Instance snapshot. Create a new snapshot of a Database
+     * Instance. You must define the `name` parameter in the request.
      *
      * @param request - The request {@link CreateSnapshotRequest}
      * @returns A Promise of Snapshot
@@ -663,7 +774,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/snapshots`
     }, unmarshalSnapshot);
     /**
-     * Update an instance snapshot
+     * Update a Database Instance snapshot. Update the parameters of a snapshot of
+     * a Database Instance. You can update the `name` and `expires_at`
+     * parameters.
      *
      * @param request - The request {@link UpdateSnapshotRequest}
      * @returns A Promise of Snapshot
@@ -675,7 +788,9 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam('snapshotId', request.snapshotId)}`
     }, unmarshalSnapshot);
     /**
-     * Delete an instance snapshot
+     * Delete a Database Instance snapshot. Delete a given snapshot of a Database
+     * Instance. You must specify, in the endpoint, the `region` and `snapshot_id`
+     * parameters of the snapshot you want to delete.
      *
      * @param request - The request {@link DeleteSnapshotRequest}
      * @returns A Promise of Snapshot
@@ -685,7 +800,14 @@ class API extends API$1 {
       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
+     * Create a new Database Instance from a snapshot. Restore a snapshot. When
+     * you restore a snapshot, a new Instance is created and billed to your
+     * account. Note that is possible to select a larger node type for your new
+     * Database Instance. However, the Block volume size will be the same as the
+     * size of the restored snapshot. All Instance settings will be restored if
+     * you chose a node type with the same or more memory size than the initial
+     * Instance. Settings will be reset to the default if your node type has less
+     * memory.
      *
      * @param request - The request {@link CreateInstanceFromSnapshotRequest}
      * @returns A Promise of Instance
@@ -697,7 +819,11 @@ class API extends API$1 {
       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
+     * Create a new Database Instance endpoint. Create a new endpoint for a
+     * Database Instance. You can add `load_balancer` and `private_network`
+     * specifications to the body of the request. Note that this action replaces
+     * your current endpoint, which means you might need to update any environment
+     * configurations that point to the old endpoint.
      *
      * @param request - The request {@link CreateEndpointRequest}
      * @returns A Promise of Endpoint
@@ -709,7 +835,10 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam('instanceId', request.instanceId)}/endpoints`
     }, unmarshalEndpoint);
     /**
-     * Delete an instance endpoint
+     * Delete a Database Instance endpoint. Delete the endpoint of a Database
+     * Instance. You must specify the `region` and `endpoint_id` parameters of the
+     * endpoint you want to delete. Note that might need to update any environment
+     * configurations that point to the deleted endpoint.
      *
      * @param request - The request {@link DeleteEndpointRequest}
      */
@@ -718,7 +847,10 @@ class API extends API$1 {
       path: `/rdb/v1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/endpoints/${validatePathParam('endpointId', request.endpointId)}`
     });
     /**
-     * Get an instance endpoint
+     * Get a Database Instance endpoint. Retrieve information about a Database
+     * Instance endpoint. Full details about the endpoint, like `ip`, `port`,
+     * `private_network` and `load_balancer` specifications are returned in the
+     * response.
      *
      * @param request - The request {@link GetEndpointRequest}
      * @returns A Promise of Endpoint
@@ -728,7 +860,7 @@ class API extends API$1 {
       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
+     * Migrate an existing instance endpoint to another instance.
      *
      * @param request - The request {@link MigrateEndpointRequest}
      * @returns A Promise of Endpoint