@scaleway/sdk 2.50.0 → 2.51.0

package/dist/api/mongodb/v1alpha1/api.gen.cjs

@@ -0,0 +1,385 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const intervalRetrier = require("../../../internal/async/interval-retrier.cjs");
+const api = require("../../../scw/api.cjs");
+const marshalling = require("../../../helpers/marshalling.cjs");
+require("../../../vendor/base64/index.cjs");
+const resourcePaginator = require("../../../scw/fetch/resource-paginator.cjs");
+const content_gen = require("./content.gen.cjs");
+const marshalling_gen = require("./marshalling.gen.cjs");
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends api.API {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ["fr-par", "nl-ams", "pl-waw"];
+  pageOfListNodeTypes = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-types`,
+      urlParams: marshalling.urlParams(
+        ["include_disabled_types", request.includeDisabledTypes],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListNodeTypesResponse
+  );
+  /**
+   * List available node types.
+   *
+   * @param request - The request {@link ListNodeTypesRequest}
+   * @returns A Promise of ListNodeTypesResponse
+   */
+  listNodeTypes = (request = {}) => resourcePaginator.enrichForPagination("nodeTypes", this.pageOfListNodeTypes, request);
+  pageOfListVersions = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
+      urlParams: marshalling.urlParams(
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["version", request.version]
+      )
+    },
+    marshalling_gen.unmarshalListVersionsResponse
+  );
+  /**
+   * List available MongoDB™ versions.
+   *
+   * @param request - The request {@link ListVersionsRequest}
+   * @returns A Promise of ListVersionsResponse
+   */
+  listVersions = (request = {}) => resourcePaginator.enrichForPagination("versions", this.pageOfListVersions, request);
+  pageOfListInstances = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances`,
+      urlParams: marshalling.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        [
+          "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]
+      )
+    },
+    marshalling_gen.unmarshalListInstancesResponse
+  );
+  /**
+   * List MongoDB™ Database Instances. List all MongoDB™ Database Instances in
+   * the specified region, for a given Scaleway Project. By default, the
+   * MongoDB™ 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
+   */
+  listInstances = (request = {}) => resourcePaginator.enrichForPagination("instances", this.pageOfListInstances, request);
+  /**
+   * Get a MongoDB™ Database Instance. Retrieve information about a given
+   * MongoDB™ 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
+   */
+  getInstance = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}`
+    },
+    marshalling_gen.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
+   */
+  waitForInstance = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.INSTANCE_TRANSIENT_STATUSES.includes(res.status))),
+    this.getInstance,
+    request,
+    options
+  );
+  /**
+   * Create a MongoDB™ Database Instance. Create a new MongoDB™ Database
+   * Instance.
+   *
+   * @param request - The request {@link CreateInstanceRequest}
+   * @returns A Promise of Instance
+   */
+  createInstance = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateInstanceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances`
+    },
+    marshalling_gen.unmarshalInstance
+  );
+  /**
+   * Update a MongoDB™ Database Instance. Update the parameters of a MongoDB™
+   * Database Instance.
+   *
+   * @param request - The request {@link UpdateInstanceRequest}
+   * @returns A Promise of Instance
+   */
+  updateInstance = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateInstanceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}`
+    },
+    marshalling_gen.unmarshalInstance
+  );
+  /**
+   * Delete a MongoDB™ Database Instance. Delete a given MongoDB™ Database
+   * Instance, specified by the `region` and `instance_id` parameters. Deleting
+   * a MongoDB™ 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
+   */
+  deleteInstance = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}`
+    },
+    marshalling_gen.unmarshalInstance
+  );
+  /**
+   * Upgrade a Database Instance. Upgrade your current Database Instance
+   * specifications like volume size.
+   *
+   * @param request - The request {@link UpgradeInstanceRequest}
+   * @returns A Promise of Instance
+   */
+  upgradeInstance = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpgradeInstanceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/upgrade`
+    },
+    marshalling_gen.unmarshalInstance
+  );
+  /**
+   * Get the certificate of a Database Instance. Retrieve the certificate of a
+   * given Database Instance, specified by the `instance_id` parameter.
+   *
+   * @param request - The request {@link GetInstanceCertificateRequest}
+   * @returns A Promise of Blob
+   */
+  getInstanceCertificate = (request) => this.client.fetch({
+    method: "GET",
+    path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/certificate`,
+    urlParams: marshalling.urlParams(["dl", 1]),
+    responseType: "blob"
+  });
+  /**
+   * Create a Database Instance snapshot. Create a new snapshot of a Database
+   * Instance. You must define the `name` and `instance_id` parameters in the
+   * request.
+   *
+   * @param request - The request {@link CreateSnapshotRequest}
+   * @returns A Promise of Snapshot
+   */
+  createSnapshot = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalCreateSnapshotRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/snapshots`
+    },
+    marshalling_gen.unmarshalSnapshot
+  );
+  /**
+   * Get a Database Instance snapshot. Retrieve information about a given
+   * snapshot of a Database Instance. You must specify, in the endpoint, the
+   * `snapshot_id` parameter of the snapshot you want to retrieve.
+   *
+   * @param request - The request {@link GetSnapshotRequest}
+   * @returns A Promise of Snapshot
+   */
+  getSnapshot = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${marshalling.validatePathParam("snapshotId", request.snapshotId)}`
+    },
+    marshalling_gen.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
+   */
+  waitForSnapshot = (request, options) => intervalRetrier.waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!content_gen.SNAPSHOT_TRANSIENT_STATUSES.includes(res.status))),
+    this.getSnapshot,
+    request,
+    options
+  );
+  updateSnapshot = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateSnapshotRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${marshalling.validatePathParam("snapshotId", request.snapshotId)}`
+    },
+    marshalling_gen.unmarshalSnapshot
+  );
+  /**
+   * Restore a Database Instance snapshot. Restore a given snapshot of a
+   * Database Instance. You must specify, in the endpoint, the `snapshot_id`
+   * parameter of the snapshot you want to restore, the `instance_name` of the
+   * new Database Instance, `node_type` of the new Database Instance and
+   * `node_number` of the new Database Instance.
+   *
+   * @param request - The request {@link RestoreSnapshotRequest}
+   * @returns A Promise of Instance
+   */
+  restoreSnapshot = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalRestoreSnapshotRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${marshalling.validatePathParam("snapshotId", request.snapshotId)}/restore`
+    },
+    marshalling_gen.unmarshalInstance
+  );
+  pageOfListSnapshots = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots`,
+      urlParams: marshalling.urlParams(
+        ["instance_id", request.instanceId],
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        [
+          "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
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListSnapshotsResponse
+  );
+  /**
+   * 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
+   */
+  listSnapshots = (request = {}) => resourcePaginator.enrichForPagination("snapshots", this.pageOfListSnapshots, request);
+  /**
+   * Delete a Database Instance snapshot. Delete a given snapshot of a Database
+   * Instance. You must specify, in the endpoint, the `snapshot_id` parameter of
+   * the snapshot you want to delete.
+   *
+   * @param request - The request {@link DeleteSnapshotRequest}
+   * @returns A Promise of Snapshot
+   */
+  deleteSnapshot = (request) => this.client.fetch(
+    {
+      method: "DELETE",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${marshalling.validatePathParam("snapshotId", request.snapshotId)}`
+    },
+    marshalling_gen.unmarshalSnapshot
+  );
+  pageOfListUsers = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/users`,
+      urlParams: marshalling.urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    marshalling_gen.unmarshalListUsersResponse
+  );
+  /**
+   * List users of a Database Instance. List all users of a given Database
+   * Instance.
+   *
+   * @param request - The request {@link ListUsersRequest}
+   * @returns A Promise of ListUsersResponse
+   */
+  listUsers = (request) => resourcePaginator.enrichForPagination("users", this.pageOfListUsers, request);
+  /**
+   * Update a user on a Database Instance. Update the parameters of a user on a
+   * Database Instance. You can update the `password` parameter, but you cannot
+   * change the name of the user.
+   *
+   * @param request - The request {@link UpdateUserRequest}
+   * @returns A Promise of User
+   */
+  updateUser = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalling_gen.marshalUpdateUserRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/mongodb/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${marshalling.validatePathParam("instanceId", request.instanceId)}/users/${marshalling.validatePathParam("name", request.name)}`
+    },
+    marshalling_gen.unmarshalUser
+  );
+}
+exports.API = API;

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

@@ -0,0 +1,195 @@
+import { API as ParentAPI } from '../../../bridge';
+import type { Region, WaitForOptions } from '../../../bridge';
+import type { CreateInstanceRequest, CreateSnapshotRequest, DeleteInstanceRequest, DeleteSnapshotRequest, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, ListInstancesRequest, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsResponse, ListUsersRequest, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, RestoreSnapshotRequest, Snapshot, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User } from './types.gen';
+/**
+ * Managed Database for MongoDB.
+ *
+ * This API allows you to manage your Managed Databases for MongoDB.
+ */
+export declare class API extends ParentAPI {
+    /** Lists the available regions of the API. */
+    static readonly LOCALITIES: Region[];
+    protected pageOfListNodeTypes: (request?: Readonly<ListNodeTypesRequest>) => Promise<ListNodeTypesResponse>;
+    /**
+     * List available node types.
+     *
+     * @param request - The request {@link ListNodeTypesRequest}
+     * @returns A Promise of ListNodeTypesResponse
+     */
+    listNodeTypes: (request?: Readonly<ListNodeTypesRequest>) => Promise<ListNodeTypesResponse> & {
+        all: () => Promise<import("./types.gen").NodeType[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").NodeType[], void, void>;
+    };
+    protected pageOfListVersions: (request?: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse>;
+    /**
+     * List available MongoDB™ versions.
+     *
+     * @param request - The request {@link ListVersionsRequest}
+     * @returns A Promise of ListVersionsResponse
+     */
+    listVersions: (request?: Readonly<ListVersionsRequest>) => Promise<ListVersionsResponse> & {
+        all: () => Promise<import("./types.gen").Version[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<import("./types.gen").Version[], void, void>;
+    };
+    protected pageOfListInstances: (request?: Readonly<ListInstancesRequest>) => Promise<ListInstancesResponse>;
+    /**
+     * List MongoDB™ Database Instances. List all MongoDB™ Database Instances in
+     * the specified region, for a given Scaleway Project. By default, the
+     * MongoDB™ 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
+     */
+    listInstances: (request?: Readonly<ListInstancesRequest>) => Promise<ListInstancesResponse> & {
+        all: () => Promise<Instance[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Instance[], void, void>;
+    };
+    /**
+     * Get a MongoDB™ Database Instance. Retrieve information about a given
+     * MongoDB™ 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
+     */
+    getInstance: (request: Readonly<GetInstanceRequest>) => Promise<Instance>;
+    /**
+     * 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
+     */
+    waitForInstance: (request: Readonly<GetInstanceRequest>, options?: Readonly<WaitForOptions<Instance>>) => Promise<Instance>;
+    /**
+     * Create a MongoDB™ Database Instance. Create a new MongoDB™ Database
+     * Instance.
+     *
+     * @param request - The request {@link CreateInstanceRequest}
+     * @returns A Promise of Instance
+     */
+    createInstance: (request: Readonly<CreateInstanceRequest>) => Promise<Instance>;
+    /**
+     * Update a MongoDB™ Database Instance. Update the parameters of a MongoDB™
+     * Database Instance.
+     *
+     * @param request - The request {@link UpdateInstanceRequest}
+     * @returns A Promise of Instance
+     */
+    updateInstance: (request: Readonly<UpdateInstanceRequest>) => Promise<Instance>;
+    /**
+     * Delete a MongoDB™ Database Instance. Delete a given MongoDB™ Database
+     * Instance, specified by the `region` and `instance_id` parameters. Deleting
+     * a MongoDB™ 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
+     */
+    deleteInstance: (request: Readonly<DeleteInstanceRequest>) => Promise<Instance>;
+    /**
+     * Upgrade a Database Instance. Upgrade your current Database Instance
+     * specifications like volume size.
+     *
+     * @param request - The request {@link UpgradeInstanceRequest}
+     * @returns A Promise of Instance
+     */
+    upgradeInstance: (request: Readonly<UpgradeInstanceRequest>) => Promise<Instance>;
+    /**
+     * Get the certificate of a Database Instance. Retrieve the certificate of a
+     * given Database Instance, specified by the `instance_id` parameter.
+     *
+     * @param request - The request {@link GetInstanceCertificateRequest}
+     * @returns A Promise of Blob
+     */
+    getInstanceCertificate: (request: Readonly<GetInstanceCertificateRequest>) => Promise<Blob>;
+    /**
+     * Create a Database Instance snapshot. Create a new snapshot of a Database
+     * Instance. You must define the `name` and `instance_id` parameters in the
+     * request.
+     *
+     * @param request - The request {@link CreateSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
+    createSnapshot: (request: Readonly<CreateSnapshotRequest>) => Promise<Snapshot>;
+    /**
+     * Get a Database Instance snapshot. Retrieve information about a given
+     * snapshot of a Database Instance. You must specify, in the endpoint, the
+     * `snapshot_id` parameter of the snapshot you want to retrieve.
+     *
+     * @param request - The request {@link GetSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
+    getSnapshot: (request: Readonly<GetSnapshotRequest>) => Promise<Snapshot>;
+    /**
+     * 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
+     */
+    waitForSnapshot: (request: Readonly<GetSnapshotRequest>, options?: Readonly<WaitForOptions<Snapshot>>) => Promise<Snapshot>;
+    updateSnapshot: (request: Readonly<UpdateSnapshotRequest>) => Promise<Snapshot>;
+    /**
+     * Restore a Database Instance snapshot. Restore a given snapshot of a
+     * Database Instance. You must specify, in the endpoint, the `snapshot_id`
+     * parameter of the snapshot you want to restore, the `instance_name` of the
+     * new Database Instance, `node_type` of the new Database Instance and
+     * `node_number` of the new Database Instance.
+     *
+     * @param request - The request {@link RestoreSnapshotRequest}
+     * @returns A Promise of Instance
+     */
+    restoreSnapshot: (request: Readonly<RestoreSnapshotRequest>) => Promise<Instance>;
+    protected pageOfListSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse>;
+    /**
+     * 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
+     */
+    listSnapshots: (request?: Readonly<ListSnapshotsRequest>) => Promise<ListSnapshotsResponse> & {
+        all: () => Promise<Snapshot[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<Snapshot[], void, void>;
+    };
+    /**
+     * Delete a Database Instance snapshot. Delete a given snapshot of a Database
+     * Instance. You must specify, in the endpoint, the `snapshot_id` parameter of
+     * the snapshot you want to delete.
+     *
+     * @param request - The request {@link DeleteSnapshotRequest}
+     * @returns A Promise of Snapshot
+     */
+    deleteSnapshot: (request: Readonly<DeleteSnapshotRequest>) => Promise<Snapshot>;
+    protected pageOfListUsers: (request: Readonly<ListUsersRequest>) => Promise<ListUsersResponse>;
+    /**
+     * List users of a Database Instance. List all users of a given Database
+     * Instance.
+     *
+     * @param request - The request {@link ListUsersRequest}
+     * @returns A Promise of ListUsersResponse
+     */
+    listUsers: (request: Readonly<ListUsersRequest>) => Promise<ListUsersResponse> & {
+        all: () => Promise<User[]>;
+        [Symbol.asyncIterator]: () => AsyncGenerator<User[], void, void>;
+    };
+    /**
+     * Update a user on a Database Instance. Update the parameters of a user on a
+     * Database Instance. You can update the `password` parameter, but you cannot
+     * change the name of the user.
+     *
+     * @param request - The request {@link UpdateUserRequest}
+     * @returns A Promise of User
+     */
+    updateUser: (request: Readonly<UpdateUserRequest>) => Promise<User>;
+}