@scaleway/sdk-mongodb 1.3.0 → 2.1.1

package/dist/v1alpha1/api.gen.cjs

@@ -1,421 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const sdkClient = require("@scaleway/sdk-client");
-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 sdkClient.API {
-  /**
-   * Locality of this API.
-   * type ∈ {'zone','region','global','unspecified'}
-   */
-  static LOCALITY = sdkClient.toApiLocality({
-    regions: ["fr-par"]
-  });
-  pageOfListNodeTypes = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/node-types`,
-      urlParams: sdkClient.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 = {}) => sdkClient.enrichForPagination("nodeTypes", this.pageOfListNodeTypes, request);
-  pageOfListVersions = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
-      urlParams: sdkClient.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 = {}) => sdkClient.enrichForPagination("versions", this.pageOfListVersions, request);
-  pageOfListInstances = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances`,
-      urlParams: sdkClient.urlParams(
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId],
-        ["tags", request.tags]
-      )
-    },
-    marshalling_gen.unmarshalListInstancesResponse
-  );
-  /**
-   * List MongoDB® Database Instances. List all MongoDB® Database Instances in the specified region. 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 = {}) => sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.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) => sdkClient.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/${sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/certificate`,
-    urlParams: sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.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) => sdkClient.waitForResource(
-    options?.stop ?? ((res) => Promise.resolve(
-      !content_gen.SNAPSHOT_TRANSIENT_STATUSES.includes(res.status)
-    )),
-    this.getSnapshot,
-    request,
-    options
-  );
-  /**
-   * 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
-   */
-  updateSnapshot = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalUpdateSnapshotRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.validatePathParam("snapshotId", request.snapshotId)}/restore`
-    },
-    marshalling_gen.unmarshalInstance
-  );
-  pageOfListSnapshots = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots`,
-      urlParams: sdkClient.urlParams(
-        ["instance_id", request.instanceId],
-        ["name", request.name],
-        ["order_by", request.orderBy],
-        ["organization_id", request.organizationId],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId]
-      )
-    },
-    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 = {}) => sdkClient.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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${sdkClient.validatePathParam("snapshotId", request.snapshotId)}`
-    },
-    marshalling_gen.unmarshalSnapshot
-  );
-  pageOfListUsers = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users`,
-      urlParams: sdkClient.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) => sdkClient.enrichForPagination("users", this.pageOfListUsers, request);
-  /**
-   * Create an user on a Database Instance. Create an user on a Database Instance. You must define the `name`, `password` of the user and `instance_id` parameters in the request.
-   *
-   * @param request - The request {@link CreateUserRequest}
-   * @returns A Promise of User
-   */
-  createUser = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateUserRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users`
-    },
-    marshalling_gen.unmarshalUser
-  );
-  /**
-   * 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/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users/${sdkClient.validatePathParam("name", request.name)}`
-    },
-    marshalling_gen.unmarshalUser
-  );
-  /**
-   * Delete a user on a Database Instance. Delete an existing user on a Database Instance.
-   *
-   * @param request - The request {@link DeleteUserRequest}
-   */
-  deleteUser = (request) => this.client.fetch({
-    body: "{}",
-    headers: jsonContentHeaders,
-    method: "DELETE",
-    path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/users/${sdkClient.validatePathParam("name", request.name)}`
-  });
-  /**
-   * Apply user roles. Apply preset roles for a user in a Database Instance.
-   *
-   * @param request - The request {@link SetUserRoleRequest}
-   * @returns A Promise of User
-   */
-  setUserRole = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalSetUserRoleRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PUT",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${sdkClient.validatePathParam("instanceId", request.instanceId)}/roles`
-    },
-    marshalling_gen.unmarshalUser
-  );
-  /**
-   * Delete a Database Instance endpoint. Delete the endpoint of a Database Instance. You must specify the `endpoint_id` parameter of the endpoint you want to delete. Note that you might need to update any environment configurations that point to the deleted endpoint.
-   *
-   * @param request - The request {@link DeleteEndpointRequest}
-   */
-  deleteEndpoint = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints/${sdkClient.validatePathParam("endpointId", request.endpointId)}`
-  });
-  /**
-   * Create a new Instance endpoint. Create a new endpoint for a MongoDB® Database Instance. You can add `public_network` or `private_network` specifications to the body of the request.
-   *
-   * @param request - The request {@link CreateEndpointRequest}
-   * @returns A Promise of Endpoint
-   */
-  createEndpoint = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateEndpointRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/mongodb/v1alpha1/regions/${sdkClient.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/endpoints`
-    },
-    marshalling_gen.unmarshalEndpoint
-  );
-}
-exports.API = API;

package/dist/v1alpha1/content.gen.cjs

@@ -1,16 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const INSTANCE_TRANSIENT_STATUSES = [
-  "provisioning",
-  "configuring",
-  "deleting",
-  "initializing",
-  "snapshotting"
-];
-const SNAPSHOT_TRANSIENT_STATUSES = [
-  "creating",
-  "restoring",
-  "deleting"
-];
-exports.INSTANCE_TRANSIENT_STATUSES = INSTANCE_TRANSIENT_STATUSES;
-exports.SNAPSHOT_TRANSIENT_STATUSES = SNAPSHOT_TRANSIENT_STATUSES;

package/dist/v1alpha1/index.gen.cjs

@@ -1,31 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-const api_gen = require("./api.gen.cjs");
-const content_gen = require("./content.gen.cjs");
-const marshalling_gen = require("./marshalling.gen.cjs");
-const validationRules_gen = require("./validation-rules.gen.cjs");
-exports.API = api_gen.API;
-exports.INSTANCE_TRANSIENT_STATUSES = content_gen.INSTANCE_TRANSIENT_STATUSES;
-exports.SNAPSHOT_TRANSIENT_STATUSES = content_gen.SNAPSHOT_TRANSIENT_STATUSES;
-exports.marshalCreateEndpointRequest = marshalling_gen.marshalCreateEndpointRequest;
-exports.marshalCreateInstanceRequest = marshalling_gen.marshalCreateInstanceRequest;
-exports.marshalCreateSnapshotRequest = marshalling_gen.marshalCreateSnapshotRequest;
-exports.marshalCreateUserRequest = marshalling_gen.marshalCreateUserRequest;
-exports.marshalRestoreSnapshotRequest = marshalling_gen.marshalRestoreSnapshotRequest;
-exports.marshalSetUserRoleRequest = marshalling_gen.marshalSetUserRoleRequest;
-exports.marshalUpdateInstanceRequest = marshalling_gen.marshalUpdateInstanceRequest;
-exports.marshalUpdateSnapshotRequest = marshalling_gen.marshalUpdateSnapshotRequest;
-exports.marshalUpdateUserRequest = marshalling_gen.marshalUpdateUserRequest;
-exports.marshalUpgradeInstanceRequest = marshalling_gen.marshalUpgradeInstanceRequest;
-exports.unmarshalEndpoint = marshalling_gen.unmarshalEndpoint;
-exports.unmarshalInstance = marshalling_gen.unmarshalInstance;
-exports.unmarshalInstanceSetting = marshalling_gen.unmarshalInstanceSetting;
-exports.unmarshalListInstancesResponse = marshalling_gen.unmarshalListInstancesResponse;
-exports.unmarshalListNodeTypesResponse = marshalling_gen.unmarshalListNodeTypesResponse;
-exports.unmarshalListSnapshotsResponse = marshalling_gen.unmarshalListSnapshotsResponse;
-exports.unmarshalListUsersResponse = marshalling_gen.unmarshalListUsersResponse;
-exports.unmarshalListVersionsResponse = marshalling_gen.unmarshalListVersionsResponse;
-exports.unmarshalSnapshot = marshalling_gen.unmarshalSnapshot;
-exports.unmarshalUser = marshalling_gen.unmarshalUser;
-exports.unmarshalVolume = marshalling_gen.unmarshalVolume;
-exports.ValidationRules = validationRules_gen;