@scaleway/sdk 2.50.0 → 2.51.0

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

@@ -0,0 +1,385 @@
+import { waitForResource } from "../../../internal/async/interval-retrier.js";
+import { API as API$1 } from "../../../scw/api.js";
+import { validatePathParam, urlParams } from "../../../helpers/marshalling.js";
+import "../../../vendor/base64/index.js";
+import { enrichForPagination } from "../../../scw/fetch/resource-paginator.js";
+import { INSTANCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from "./content.gen.js";
+import { unmarshalListNodeTypesResponse, unmarshalListVersionsResponse, unmarshalListInstancesResponse, unmarshalInstance, marshalCreateInstanceRequest, marshalUpdateInstanceRequest, marshalUpgradeInstanceRequest, marshalCreateSnapshotRequest, unmarshalSnapshot, marshalUpdateSnapshotRequest, marshalRestoreSnapshotRequest, unmarshalListSnapshotsResponse, unmarshalListUsersResponse, marshalUpdateUserRequest, unmarshalUser } from "./marshalling.gen.js";
+const jsonContentHeaders = {
+  "Content-Type": "application/json; charset=utf-8"
+};
+class API extends API$1 {
+  /** 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/${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
+   */
+  listNodeTypes = (request = {}) => enrichForPagination("nodeTypes", this.pageOfListNodeTypes, request);
+  pageOfListVersions = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/versions`,
+      urlParams: urlParams(
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ],
+        ["version", request.version]
+      )
+    },
+    unmarshalListVersionsResponse
+  );
+  /**
+   * List available MongoDB™ versions.
+   *
+   * @param request - The request {@link ListVersionsRequest}
+   * @returns A Promise of ListVersionsResponse
+   */
+  listVersions = (request = {}) => enrichForPagination("versions", this.pageOfListVersions, request);
+  pageOfListInstances = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances`,
+      urlParams: 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]
+      )
+    },
+    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 = {}) => 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/${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
+   */
+  waitForInstance = (request, options) => waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!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(
+        marshalCreateInstanceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances`
+    },
+    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(
+        marshalUpdateInstanceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}`
+    },
+    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/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}`
+    },
+    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(
+        marshalUpgradeInstanceRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/upgrade`
+    },
+    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/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/certificate`,
+    urlParams: 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(
+        marshalCreateSnapshotRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/snapshots`
+    },
+    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/${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
+   */
+  waitForSnapshot = (request, options) => waitForResource(
+    options?.stop ?? ((res) => Promise.resolve(!SNAPSHOT_TRANSIENT_STATUSES.includes(res.status))),
+    this.getSnapshot,
+    request,
+    options
+  );
+  updateSnapshot = (request) => this.client.fetch(
+    {
+      body: JSON.stringify(
+        marshalUpdateSnapshotRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam("snapshotId", request.snapshotId)}`
+    },
+    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(
+        marshalRestoreSnapshotRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "POST",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam("snapshotId", request.snapshotId)}/restore`
+    },
+    unmarshalInstance
+  );
+  pageOfListSnapshots = (request = {}) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots`,
+      urlParams: 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
+        ]
+      )
+    },
+    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 = {}) => 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/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/snapshots/${validatePathParam("snapshotId", request.snapshotId)}`
+    },
+    unmarshalSnapshot
+  );
+  pageOfListUsers = (request) => this.client.fetch(
+    {
+      method: "GET",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/users`,
+      urlParams: urlParams(
+        ["name", request.name],
+        ["order_by", request.orderBy],
+        ["page", request.page],
+        [
+          "page_size",
+          request.pageSize ?? this.client.settings.defaultPageSize
+        ]
+      )
+    },
+    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) => 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(
+        marshalUpdateUserRequest(request, this.client.settings)
+      ),
+      headers: jsonContentHeaders,
+      method: "PATCH",
+      path: `/mongodb/v1alpha1/regions/${validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/instances/${validatePathParam("instanceId", request.instanceId)}/users/${validatePathParam("name", request.name)}`
+    },
+    unmarshalUser
+  );
+}
+export {
+  API
+};

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

@@ -0,0 +1,16 @@
+"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/api/mongodb/v1alpha1/content.gen.d.ts

@@ -0,0 +1,5 @@
+import type { InstanceStatus, SnapshotStatus } from './types.gen';
+/** Lists transient statutes of the enum {@link InstanceStatus}. */
+export declare const INSTANCE_TRANSIENT_STATUSES: InstanceStatus[];
+/** Lists transient statutes of the enum {@link SnapshotStatus}. */
+export declare const SNAPSHOT_TRANSIENT_STATUSES: SnapshotStatus[];

package/dist/api/mongodb/v1alpha1/content.gen.js

@@ -0,0 +1,16 @@
+const INSTANCE_TRANSIENT_STATUSES = [
+  "provisioning",
+  "configuring",
+  "deleting",
+  "initializing",
+  "snapshotting"
+];
+const SNAPSHOT_TRANSIENT_STATUSES = [
+  "creating",
+  "restoring",
+  "deleting"
+];
+export {
+  INSTANCE_TRANSIENT_STATUSES,
+  SNAPSHOT_TRANSIENT_STATUSES
+};

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

@@ -0,0 +1,9 @@
+"use strict";
+Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
+const api_gen = require("./api.gen.cjs");
+const content_gen = require("./content.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.ValidationRules = validationRules_gen;

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

@@ -0,0 +1,4 @@
+export { API } from './api.gen';
+export * from './content.gen';
+export type { CreateInstanceRequest, CreateInstanceRequestVolumeDetails, CreateSnapshotRequest, DeleteInstanceRequest, DeleteSnapshotRequest, Endpoint, EndpointPrivateNetworkDetails, EndpointPublicDetails, EndpointSpec, EndpointSpecPrivateNetworkDetails, EndpointSpecPublicDetails, GetInstanceCertificateRequest, GetInstanceRequest, GetSnapshotRequest, Instance, InstanceSetting, InstanceStatus, ListInstancesRequest, ListInstancesRequestOrderBy, ListInstancesResponse, ListNodeTypesRequest, ListNodeTypesResponse, ListSnapshotsRequest, ListSnapshotsRequestOrderBy, ListSnapshotsResponse, ListUsersRequest, ListUsersRequestOrderBy, ListUsersResponse, ListVersionsRequest, ListVersionsResponse, NodeType, NodeTypeStock, NodeTypeVolumeType, RestoreSnapshotRequest, RestoreSnapshotRequestVolumeDetails, Setting, SettingPropertyType, Snapshot, SnapshotStatus, SnapshotVolumeType, UpdateInstanceRequest, UpdateSnapshotRequest, UpdateUserRequest, UpgradeInstanceRequest, User, Version, Volume, VolumeType, } from './types.gen';
+export * as ValidationRules from './validation-rules.gen';

package/dist/api/mongodb/v1alpha1/index.gen.js

@@ -0,0 +1,9 @@
+import { API } from "./api.gen.js";
+import { INSTANCE_TRANSIENT_STATUSES, SNAPSHOT_TRANSIENT_STATUSES } from "./content.gen.js";
+import * as validationRules_gen from "./validation-rules.gen.js";
+export {
+  API,
+  INSTANCE_TRANSIENT_STATUSES,
+  SNAPSHOT_TRANSIENT_STATUSES,
+  validationRules_gen as ValidationRules
+};