@scaleway/sdk 2.17.0 → 2.18.0

package/dist/api/mnq/v1beta1/api.gen.js

@@ -16,7 +16,7 @@ const jsonContentHeaders = {
  */
 class NatsAPI extends API$1 {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ['fr-par'];
+  static LOCALITIES = ['fr-par', 'nl-ams'];
 
   /**
    * Create a NATS account. Create a NATS account associated with a Project.
@@ -152,7 +152,7 @@ class NatsAPI extends API$1 {
  */
 class SnsAPI extends API$1 {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ['fr-par'];
+  static LOCALITIES = ['fr-par', 'nl-ams'];
 
   /**
    * Activate SNS. Activate SNS for the specified Project ID. SNS must be
@@ -274,7 +274,7 @@ class SnsAPI extends API$1 {
  */
 class SqsAPI extends API$1 {
   /** Lists the available regions of the API. */
-  static LOCALITIES = ['fr-par'];
+  static LOCALITIES = ['fr-par', 'nl-ams'];
 
   /**
    * Activate SQS. Activate SQS for the specified Project ID. SQS must be

package/dist/api/secret/index.js

@@ -1,2 +1,4 @@
 import * as index_gen from './v1alpha1/index.gen.js';
 export { index_gen as v1alpha1 };
+import * as index_gen$1 from './v1beta1/index.gen.js';
+export { index_gen$1 as v1beta1 };

package/dist/api/secret/v1beta1/api.gen.js

@@ -0,0 +1,253 @@
+import { API as API$1 } from '../../../scw/api.js';
+import { validatePathParam, urlParams } from '../../../helpers/marshalling.js';
+import { enrichForPagination } from '../../../scw/fetch/resource-paginator.js';
+import { marshalCreateSecretRequest, unmarshalSecret, marshalUpdateSecretRequest, unmarshalListSecretsResponse, unmarshalBrowseSecretsResponse, marshalAddSecretOwnerRequest, marshalCreateSecretVersionRequest, unmarshalSecretVersion, marshalUpdateSecretVersionRequest, unmarshalListSecretVersionsResponse, unmarshalAccessSecretVersionResponse } from './marshalling.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const jsonContentHeaders = {
+  'Content-Type': 'application/json; charset=utf-8'
+};
+
+/**
+ * Secret Manager API.
+ *
+ * This API allows you to conveniently store, access and share sensitive data
+ * such as passwords, API keys and certificates.
+ */
+class API extends API$1 {
+  /** Lists the available regions of the API. */
+  static LOCALITIES = ['fr-par', 'nl-ams', 'pl-waw'];
+
+  /**
+   * Create a secret. You must specify the `region` to create a secret.
+   *
+   * @param request - The request {@link CreateSecretRequest}
+   * @returns A Promise of Secret
+   */
+  createSecret = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateSecretRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`
+  }, unmarshalSecret);
+
+  /**
+   * Get metadata using the secret's ID. Retrieve the metadata of a secret
+   * specified by the `region` and `secret_id` parameters.
+   *
+   * @param request - The request {@link GetSecretRequest}
+   * @returns A Promise of Secret
+   */
+  getSecret = request => this.client.fetch({
+    method: 'GET',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
+  }, unmarshalSecret);
+
+  /**
+   * Update metadata of a secret. Edit a secret's metadata such as name, tag(s),
+   * description and ephemeral policy. The secret to update is specified by the
+   * `secret_id` and `region` parameters.
+   *
+   * @param request - The request {@link UpdateSecretRequest}
+   * @returns A Promise of Secret
+   */
+  updateSecret = request => this.client.fetch({
+    body: JSON.stringify(marshalUpdateSecretRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'PATCH',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
+  }, unmarshalSecret);
+
+  /**
+   * Delete a secret. Delete a given secret specified by the `region` and
+   * `secret_id` parameters.
+   *
+   * @param request - The request {@link DeleteSecretRequest}
+   */
+  deleteSecret = request => this.client.fetch({
+    method: 'DELETE',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
+  });
+  pageOfListSecrets = (request = {}) => this.client.fetch({
+    method: 'GET',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`,
+    urlParams: urlParams(['ephemeral', request.ephemeral], ['name', request.name], ['order_by', request.orderBy], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['path', request.path], ['project_id', request.projectId], ['tags', request.tags])
+  }, unmarshalListSecretsResponse);
+
+  /**
+   * List secrets. Retrieve the list of secrets created within an Organization
+   * and/or Project. You must specify either the `organization_id` or the
+   * `project_id` and the `region`.
+   *
+   * @param request - The request {@link ListSecretsRequest}
+   * @returns A Promise of ListSecretsResponse
+   */
+  listSecrets = (request = {}) => enrichForPagination('secrets', this.pageOfListSecrets, request);
+
+  /**
+   * Browse secrets. Retrieve the list of secrets and folders for the given
+   * prefix. You must specify either the `organization_id` or the `project_id`
+   * and the `region`.
+   *
+   * @param request - The request {@link BrowseSecretsRequest}
+   * @returns A Promise of BrowseSecretsResponse
+   */
+  browseSecrets = request => this.client.fetch({
+    method: 'GET',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/browse`,
+    urlParams: urlParams(['order_by', request.orderBy], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['prefix', request.prefix], ['project_id', request.projectId])
+  }, unmarshalBrowseSecretsResponse);
+
+  /**
+   * Enable secret protection. Enable secret protection for a given secret
+   * specified by the `secret_id` parameter. Enabling secret protection means
+   * that your secret can be read and modified, but it cannot be deleted.
+   *
+   * @param request - The request {@link ProtectSecretRequest}
+   * @returns A Promise of Secret
+   */
+  protectSecret = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/protect`
+  }, unmarshalSecret);
+
+  /**
+   * Disable secret protection. Disable secret protection for a given secret
+   * specified by the `secret_id` parameter. Disabling secret protection means
+   * that your secret can be read, modified and deleted.
+   *
+   * @param request - The request {@link UnprotectSecretRequest}
+   * @returns A Promise of Secret
+   */
+  unprotectSecret = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/unprotect`
+  }, unmarshalSecret);
+
+  /**
+   * Allow a product to use the secret.
+   *
+   * @param request - The request {@link AddSecretOwnerRequest}
+   */
+  addSecretOwner = request => this.client.fetch({
+    body: JSON.stringify(marshalAddSecretOwnerRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/add-owner`
+  });
+
+  /**
+   * Create a version. Create a version of a given secret specified by the
+   * `region` and `secret_id` parameters.
+   *
+   * @param request - The request {@link CreateSecretVersionRequest}
+   * @returns A Promise of SecretVersion
+   */
+  createSecretVersion = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateSecretVersionRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions`
+  }, unmarshalSecretVersion);
+
+  /**
+   * Get metadata of a secret's version using the secret's ID. Retrieve the
+   * metadata of a secret's given version specified by the `region`, `secret_id`
+   * and `revision` parameters.
+   *
+   * @param request - The request {@link GetSecretVersionRequest}
+   * @returns A Promise of SecretVersion
+   */
+  getSecretVersion = request => this.client.fetch({
+    method: 'GET',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}`
+  }, unmarshalSecretVersion);
+
+  /**
+   * Update metadata of a version. Edit the metadata of a secret's given
+   * version, specified by the `region`, `secret_id` and `revision` parameters.
+   *
+   * @param request - The request {@link UpdateSecretVersionRequest}
+   * @returns A Promise of SecretVersion
+   */
+  updateSecretVersion = request => this.client.fetch({
+    body: JSON.stringify(marshalUpdateSecretVersionRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'PATCH',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}`
+  }, unmarshalSecretVersion);
+
+  /**
+   * Delete a version. Delete a secret's version and the sensitive data
+   * contained in it. Deleting a version is permanent and cannot be undone.
+   *
+   * @param request - The request {@link DeleteSecretVersionRequest}
+   */
+  deleteSecretVersion = request => this.client.fetch({
+    method: 'DELETE',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}`
+  });
+  pageOfListSecretVersions = request => this.client.fetch({
+    method: 'GET',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions`,
+    urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['status', request.status])
+  }, unmarshalListSecretVersionsResponse);
+
+  /**
+   * List versions of a secret using the secret's ID. Retrieve the list of a
+   * given secret's versions specified by the `secret_id` and `region`
+   * parameters.
+   *
+   * @param request - The request {@link ListSecretVersionsRequest}
+   * @returns A Promise of ListSecretVersionsResponse
+   */
+  listSecretVersions = request => enrichForPagination('versions', this.pageOfListSecretVersions, request);
+
+  /**
+   * Access a secret's version using the secret's ID. Access sensitive data in a
+   * secret's version specified by the `region`, `secret_id` and `revision`
+   * parameters.
+   *
+   * @param request - The request {@link AccessSecretVersionRequest}
+   * @returns A Promise of AccessSecretVersionResponse
+   */
+  accessSecretVersion = request => this.client.fetch({
+    method: 'GET',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/access`
+  }, unmarshalAccessSecretVersionResponse);
+
+  /**
+   * Enable a version. Make a specific version accessible. You must specify the
+   * `region`, `secret_id` and `revision` parameters.
+   *
+   * @param request - The request {@link EnableSecretVersionRequest}
+   * @returns A Promise of SecretVersion
+   */
+  enableSecretVersion = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/enable`
+  }, unmarshalSecretVersion);
+
+  /**
+   * Disable a version. Make a specific version inaccessible. You must specify
+   * the `region`, `secret_id` and `revision` parameters.
+   *
+   * @param request - The request {@link DisableSecretVersionRequest}
+   * @returns A Promise of SecretVersion
+   */
+  disableSecretVersion = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1beta1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/disable`
+  }, unmarshalSecretVersion);
+}
+
+export { API };

package/dist/api/secret/v1beta1/index.gen.js

@@ -0,0 +1,4 @@
+export { API } from './api.gen.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.

package/dist/api/secret/v1beta1/marshalling.gen.js

@@ -0,0 +1,173 @@
+import { isJSONObject } from '../../../helpers/json.js';
+import { unmarshalDate, unmarshalArrayOfObject } from '../../../helpers/marshalling.js';
+
+// This file was automatically generated. DO NOT EDIT.
+// If you have any remark or suggestion do not hesitate to open an issue.
+const unmarshalEphemeralProperties = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'EphemeralProperties' failed as data isn't a dictionary.`);
+  }
+  return {
+    action: data.action,
+    expiresAt: unmarshalDate(data.expires_at),
+    expiresOnceAccessed: data.expires_once_accessed
+  };
+};
+const unmarshalSecretVersion = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'SecretVersion' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    description: data.description,
+    ephemeralProperties: data.ephemeral_properties ? unmarshalEphemeralProperties(data.ephemeral_properties) : undefined,
+    latest: data.latest,
+    revision: data.revision,
+    secretId: data.secret_id,
+    status: data.status,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalEphemeralPolicy = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'EphemeralPolicy' failed as data isn't a dictionary.`);
+  }
+  return {
+    action: data.action,
+    expiresOnceAccessed: data.expires_once_accessed,
+    timeToLive: data.time_to_live
+  };
+};
+const unmarshalSecret = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Secret' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    description: data.description,
+    ephemeralPolicy: data.ephemeral_policy ? unmarshalEphemeralPolicy(data.ephemeral_policy) : undefined,
+    id: data.id,
+    managed: data.managed,
+    name: data.name,
+    path: data.path,
+    projectId: data.project_id,
+    protected: data.protected,
+    region: data.region,
+    status: data.status,
+    tags: data.tags,
+    type: data.type,
+    updatedAt: unmarshalDate(data.updated_at),
+    versionCount: data.version_count
+  };
+};
+const unmarshalAccessSecretVersionResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'AccessSecretVersionResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    data: data.data,
+    dataCrc32: data.data_crc32,
+    revision: data.revision,
+    secretId: data.secret_id
+  };
+};
+const unmarshalBrowseSecretsResponseItemFolderDetails = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'BrowseSecretsResponseItemFolderDetails' failed as data isn't a dictionary.`);
+  }
+  return {};
+};
+const unmarshalBrowseSecretsResponseItemSecretDetails = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'BrowseSecretsResponseItemSecretDetails' failed as data isn't a dictionary.`);
+  }
+  return {
+    ephemeralPolicy: data.ephemeral_policy ? unmarshalEphemeralPolicy(data.ephemeral_policy) : undefined,
+    id: data.id,
+    protected: data.protected,
+    tags: data.tags,
+    versionCount: data.version_count
+  };
+};
+const unmarshalBrowseSecretsResponseItem = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'BrowseSecretsResponseItem' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    folder: data.folder ? unmarshalBrowseSecretsResponseItemFolderDetails(data.folder) : undefined,
+    name: data.name,
+    secret: data.secret ? unmarshalBrowseSecretsResponseItemSecretDetails(data.secret) : undefined,
+    updatedAt: unmarshalDate(data.updated_at)
+  };
+};
+const unmarshalBrowseSecretsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'BrowseSecretsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    currentPath: data.current_path,
+    items: unmarshalArrayOfObject(data.items, unmarshalBrowseSecretsResponseItem),
+    totalCount: data.total_count
+  };
+};
+const unmarshalListSecretVersionsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListSecretVersionsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    totalCount: data.total_count,
+    versions: unmarshalArrayOfObject(data.versions, unmarshalSecretVersion)
+  };
+};
+const unmarshalListSecretsResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListSecretsResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    secrets: unmarshalArrayOfObject(data.secrets, unmarshalSecret),
+    totalCount: data.total_count
+  };
+};
+const marshalAddSecretOwnerRequest = (request, defaults) => ({
+  product: request.product
+});
+const marshalEphemeralPolicy = (request, defaults) => ({
+  action: request.action,
+  expires_once_accessed: request.expiresOnceAccessed,
+  time_to_live: request.timeToLive
+});
+const marshalCreateSecretRequest = (request, defaults) => ({
+  description: request.description,
+  ephemeral_policy: request.ephemeralPolicy !== undefined ? marshalEphemeralPolicy(request.ephemeralPolicy) : undefined,
+  name: request.name,
+  path: request.path,
+  project_id: request.projectId ?? defaults.defaultProjectId,
+  protected: request.protected,
+  tags: request.tags,
+  type: request.type
+});
+const marshalCreateSecretVersionRequest = (request, defaults) => ({
+  data: request.data,
+  data_crc32: request.dataCrc32,
+  description: request.description,
+  disable_previous: request.disablePrevious
+});
+const marshalUpdateSecretRequest = (request, defaults) => ({
+  description: request.description,
+  ephemeral_policy: request.ephemeralPolicy !== undefined ? marshalEphemeralPolicy(request.ephemeralPolicy) : undefined,
+  name: request.name,
+  path: request.path,
+  tags: request.tags
+});
+const marshalEphemeralProperties = (request, defaults) => ({
+  action: request.action,
+  expires_at: request.expiresAt,
+  expires_once_accessed: request.expiresOnceAccessed
+});
+const marshalUpdateSecretVersionRequest = (request, defaults) => ({
+  description: request.description,
+  ephemeral_properties: request.ephemeralProperties !== undefined ? marshalEphemeralProperties(request.ephemeralProperties) : undefined
+});
+
+export { marshalAddSecretOwnerRequest, marshalCreateSecretRequest, marshalCreateSecretVersionRequest, marshalUpdateSecretRequest, marshalUpdateSecretVersionRequest, unmarshalAccessSecretVersionResponse, unmarshalBrowseSecretsResponse, unmarshalListSecretVersionsResponse, unmarshalListSecretsResponse, unmarshalSecret, unmarshalSecretVersion };

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

@@ -110,6 +110,21 @@ class API extends API$1 {
     method: 'POST',
     path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam('gatewayId', request.gatewayId)}/upgrade`
   }, unmarshalGateway);
+
+  /**
+   * Upgrade a Public Gateway to IP mobility. Upgrade a Public Gateway to IP
+   * mobility (move from NAT IP to routed IP). This is idempotent: repeated
+   * calls after the first will return no error but have no effect.
+   *
+   * @param request - The request {@link EnableIPMobilityRequest}
+   * @returns A Promise of Gateway
+   */
+  enableIPMobility = request => this.client.fetch({
+    body: '{}',
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateways/${validatePathParam('gatewayId', request.gatewayId)}/enable-ip-mobility`
+  }, unmarshalGateway);
   pageOfListGatewayNetworks = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/vpc-gw/v1/zones/${validatePathParam('zone', request.zone ?? this.client.settings.defaultZone)}/gateway-networks`,

package/dist/api/vpcgw/v1/marshalling.gen.js

@@ -114,6 +114,7 @@ const unmarshalGateway = data => {
     gatewayNetworks: unmarshalArrayOfObject(data.gateway_networks, unmarshalGatewayNetwork),
     id: data.id,
     ip: data.ip ? unmarshalIP(data.ip) : undefined,
+    ipMobilityEnabled: data.ip_mobility_enabled,
     isLegacy: data.is_legacy,
     name: data.name,
     organizationId: data.organization_id,