@scaleway/sdk 2.73.0 → 2.75.0

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

@@ -1,485 +0,0 @@
-"use strict";
-Object.defineProperty(exports, Symbol.toStringTag, { value: "Module" });
-require("../../../client/dist/internal/logger/index.cjs");
-const api = require("../../../client/dist/scw/api.cjs");
-const marshalling = require("../../../client/dist/helpers/marshalling.cjs");
-require("../../../client/dist/vendor/base64/index.cjs");
-const resourcePaginator = require("../../../client/dist/scw/fetch/resource-paginator.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"];
-  /**
-   * 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(
-        marshalling_gen.marshalCreateSecretRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`
-    },
-    marshalling_gen.unmarshalSecret
-  );
-  /**
-   * Create folder.
-   *
-   * @param request - The request {@link CreateFolderRequest}
-   * @returns A Promise of Folder
-   */
-  createFolder = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalCreateFolderRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/folders`
-    },
-    marshalling_gen.unmarshalFolder
-  );
-  /**
-   * 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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}`
-    },
-    marshalling_gen.unmarshalSecret
-  );
-  /**
-   * Get metadata using the secret's name. Retrieve the metadata of a secret
-   * specified by the `region` and `secret_name` parameters.
-   *
-   * GetSecretByName usage is now deprecated.
-   *
-   * Scaleway recommends that you use the `ListSecrets` request with the `name`
-   * filter.
-   *
-   * @deprecated
-   * @param request - The request {@link GetSecretByNameRequest}
-   * @returns A Promise of Secret
-   */
-  getSecretByName = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${marshalling.validatePathParam("secretName", request.secretName)}`,
-      urlParams: marshalling.urlParams(["project_id", request.projectId])
-    },
-    marshalling_gen.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(
-        marshalling_gen.marshalUpdateSecretRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}`
-    },
-    marshalling_gen.unmarshalSecret
-  );
-  pageOfListSecrets = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets`,
-      urlParams: marshalling.urlParams(
-        ["is_ephemeral", request.isEphemeral],
-        ["is_managed", request.isManaged],
-        ["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]
-      )
-    },
-    marshalling_gen.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 = {}) => resourcePaginator.enrichForPagination("secrets", this.pageOfListSecrets, request);
-  pageOfListFolders = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/folders`,
-      urlParams: marshalling.urlParams(
-        ["order_by", request.orderBy],
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["path", request.path],
-        ["project_id", request.projectId]
-      )
-    },
-    marshalling_gen.unmarshalListFoldersResponse
-  );
-  /**
-   * List folders. Retrieve the list of folders created within a Project.
-   *
-   * @param request - The request {@link ListFoldersRequest}
-   * @returns A Promise of ListFoldersResponse
-   */
-  listFolders = (request = {}) => resourcePaginator.enrichForPagination("folders", this.pageOfListFolders, request);
-  /**
-   * 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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}`
-  });
-  /**
-   * Delete a given folder specified by the `region` and `folder_id` parameters.
-   *
-   * @param request - The request {@link DeleteFolderRequest}
-   */
-  deleteFolder = (request) => this.client.fetch({
-    method: "DELETE",
-    path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/folders/${marshalling.validatePathParam("folderId", request.folderId)}`
-  });
-  /**
-   * Protect a secret. Protect a given secret specified by the `secret_id`
-   * parameter. A protected secret can be read and modified but 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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/protect`
-    },
-    marshalling_gen.unmarshalSecret
-  );
-  /**
-   * Unprotect a secret. Unprotect a given secret specified by the `secret_id`
-   * parameter. An unprotected 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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/unprotect`
-    },
-    marshalling_gen.unmarshalSecret
-  );
-  /**
-   * Allow a product to use the secret.
-   *
-   * @param request - The request {@link AddSecretOwnerRequest}
-   */
-  addSecretOwner = (request) => this.client.fetch({
-    body: JSON.stringify(
-      marshalling_gen.marshalAddSecretOwnerRequest(request, this.client.settings)
-    ),
-    headers: jsonContentHeaders,
-    method: "POST",
-    path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.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(
-        marshalling_gen.marshalCreateSecretVersionRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions`
-    },
-    marshalling_gen.unmarshalSecretVersion
-  );
-  /**
-   * Generate a password in a new version. Generate a password for the given
-   * secret specified by the `region` and `secret_id` parameters. This will also
-   * create a new version of the secret that will store the password.
-   *
-   * @param request - The request {@link GeneratePasswordRequest}
-   * @returns A Promise of SecretVersion
-   */
-  generatePassword = (request) => this.client.fetch(
-    {
-      body: JSON.stringify(
-        marshalling_gen.marshalGeneratePasswordRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/generate-password`
-    },
-    marshalling_gen.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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions/${marshalling.validatePathParam("revision", request.revision)}`
-    },
-    marshalling_gen.unmarshalSecretVersion
-  );
-  /**
-   * Get metadata of a secret's version using the secret's name. Retrieve the
-   * metadata of a secret's given version specified by the `region`,
-   * `secret_name`, `revision` and `project_id` parameters.
-   *
-   * This method is deprecated.
-   *
-   * Scaleway recommends that you use the `ListSecrets` request with the `name`
-   * filter to specify the secret version desired, then use the
-   * `GetSecretVersion` request.
-   *
-   * @deprecated
-   * @param request - The request {@link GetSecretVersionByNameRequest}
-   * @returns A Promise of SecretVersion
-   */
-  getSecretVersionByName = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${marshalling.validatePathParam("secretName", request.secretName)}/versions/${marshalling.validatePathParam("revision", request.revision)}`,
-      urlParams: marshalling.urlParams(["project_id", request.projectId])
-    },
-    marshalling_gen.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(
-        marshalling_gen.marshalUpdateSecretVersionRequest(request, this.client.settings)
-      ),
-      headers: jsonContentHeaders,
-      method: "PATCH",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions/${marshalling.validatePathParam("revision", request.revision)}`
-    },
-    marshalling_gen.unmarshalSecretVersion
-  );
-  pageOfListSecretVersions = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions`,
-      urlParams: marshalling.urlParams(
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["status", request.status]
-      )
-    },
-    marshalling_gen.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) => resourcePaginator.enrichForPagination("versions", this.pageOfListSecretVersions, request);
-  pageOfListSecretVersionsByName = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${marshalling.validatePathParam("secretName", request.secretName)}/versions`,
-      urlParams: marshalling.urlParams(
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId],
-        ["status", request.status]
-      )
-    },
-    marshalling_gen.unmarshalListSecretVersionsResponse
-  );
-  /**
-   * List versions of a secret using the secret's name. Retrieve the list of a
-   * given secret's versions specified by the `secret_name`,`region` and
-   * `project_id` parameters.
-   *
-   * This method is deprecated.
-   *
-   * Scaleway recommends that you use the `ListSecrets` request with the `name`
-   * filter to specify the secret version desired, then use the
-   * `ListSecretVersions` request.
-   *
-   * @deprecated
-   * @param request - The request {@link ListSecretVersionsByNameRequest}
-   * @returns A Promise of ListSecretVersionsResponse
-   */
-  listSecretVersionsByName = (request) => resourcePaginator.enrichForPagination(
-    "versions",
-    this.pageOfListSecretVersionsByName,
-    request
-  );
-  /**
-   * 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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions/${marshalling.validatePathParam("revision", request.revision)}/enable`
-    },
-    marshalling_gen.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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions/${marshalling.validatePathParam("revision", request.revision)}/disable`
-    },
-    marshalling_gen.unmarshalSecretVersion
-  );
-  /**
-   * 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/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions/${marshalling.validatePathParam("revision", request.revision)}/access`
-    },
-    marshalling_gen.unmarshalAccessSecretVersionResponse
-  );
-  /**
-   * Access a secret's version using the secret's name. Access sensitive data in
-   * a secret's version specified by the `region`, `secret_name`, `revision` and
-   * `project_id` parameters.
-   *
-   * This method is deprecated.
-   *
-   * Scaleway recommends that you use the `ListSecrets` request with the `name`
-   * filter to specify the secret version desired, then use the
-   * `AccessSecretVersion` request.
-   *
-   * @deprecated
-   * @param request - The request {@link AccessSecretVersionByNameRequest}
-   * @returns A Promise of AccessSecretVersionResponse
-   */
-  accessSecretVersionByName = (request) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets-by-name/${marshalling.validatePathParam("secretName", request.secretName)}/versions/${marshalling.validatePathParam("revision", request.revision)}/access`,
-      urlParams: marshalling.urlParams(["project_id", request.projectId])
-    },
-    marshalling_gen.unmarshalAccessSecretVersionResponse
-  );
-  /**
-   * 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 DestroySecretVersionRequest}
-   * @returns A Promise of SecretVersion
-   */
-  destroySecretVersion = (request) => this.client.fetch(
-    {
-      body: "{}",
-      headers: jsonContentHeaders,
-      method: "POST",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/secrets/${marshalling.validatePathParam("secretId", request.secretId)}/versions/${marshalling.validatePathParam("revision", request.revision)}/destroy`
-    },
-    marshalling_gen.unmarshalSecretVersion
-  );
-  pageOfListTags = (request = {}) => this.client.fetch(
-    {
-      method: "GET",
-      path: `/secret-manager/v1alpha1/regions/${marshalling.validatePathParam("region", request.region ?? this.client.settings.defaultRegion)}/tags`,
-      urlParams: marshalling.urlParams(
-        ["page", request.page],
-        [
-          "page_size",
-          request.pageSize ?? this.client.settings.defaultPageSize
-        ],
-        ["project_id", request.projectId]
-      )
-    },
-    marshalling_gen.unmarshalListTagsResponse
-  );
-  /**
-   * List tags. List all tags associated with secrets within a given Project.
-   *
-   * @param request - The request {@link ListTagsRequest}
-   * @returns A Promise of ListTagsResponse
-   */
-  listTags = (request = {}) => resourcePaginator.enrichForPagination("tags", this.pageOfListTags, request);
-}
-exports.API = API;