@scaleway/sdk 1.24.0 → 1.26.0

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

@@ -1,7 +1,7 @@
 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, marshalAddSecretOwnerRequest, marshalCreateSecretVersionRequest, unmarshalSecretVersion, marshalGeneratePasswordRequest, marshalUpdateSecretVersionRequest, unmarshalListSecretVersionsResponse, unmarshalAccessSecretVersionResponse, unmarshalListTagsResponse } from './marshalling.gen.js';
+import { marshalCreateSecretRequest, unmarshalSecret, marshalCreateFolderRequest, unmarshalFolder, marshalUpdateSecretRequest, unmarshalListSecretsResponse, unmarshalListFoldersResponse, marshalAddSecretOwnerRequest, marshalCreateSecretVersionRequest, unmarshalSecretVersion, marshalGeneratePasswordRequest, marshalUpdateSecretVersionRequest, unmarshalListSecretVersionsResponse, unmarshalAccessSecretVersionResponse, unmarshalListTagsResponse } 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.
@@ -20,7 +20,7 @@ class API extends API$1 {
   static LOCALITIES = ['fr-par'];
 
   /**
-   * Create a secret. You must sepcify the `region` to create a secret.
+   * Create a secret. You must specify the `region` to create a secret.
    *
    * @param request - The request {@link CreateSecretRequest}
    * @returns A Promise of Secret
@@ -32,6 +32,19 @@ class API extends API$1 {
     path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`
   }, unmarshalSecret);
 
+  /**
+   * Create folder.
+   *
+   * @param request - The request {@link CreateFolderRequest}
+   * @returns A Promise of Folder
+   */
+  createFolder = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateFolderRequest(request, this.client.settings)),
+    headers: jsonContentHeaders,
+    method: 'POST',
+    path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/folders`
+  }, unmarshalFolder);
+
   /**
    * Get metadata using the secret's ID. Retrieve the metadata of a secret
    * specified by the `region` and `secret_id` parameters.
@@ -48,6 +61,11 @@ class API extends API$1 {
    * 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 you to use ListSecrets with the `name` filter.
+   *
+   * @deprecated
    * @param request - The request {@link GetSecretByNameRequest}
    * @returns A Promise of Secret
    */
@@ -80,7 +98,7 @@ class API extends API$1 {
       return _this.client.fetch({
         method: 'GET',
         path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? _this.client.settings.defaultRegion)}/secrets`,
-        urlParams: urlParams(['is_managed', request.isManaged], ['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? _this.client.settings.defaultPageSize], ['project_id', request.projectId], ['tags', request.tags])
+        urlParams: urlParams(['is_managed', request.isManaged], ['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['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);
     };
   })();
@@ -102,6 +120,35 @@ class API extends API$1 {
       return enrichForPagination('secrets', _this2.pageOfListSecrets, request);
     };
   })();
+  pageOfListFolders = (() => {
+    var _this3 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return _this3.client.fetch({
+        method: 'GET',
+        path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? _this3.client.settings.defaultRegion)}/folders`,
+        urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? _this3.client.settings.defaultPageSize], ['path', request.path], ['project_id', request.projectId ?? _this3.client.settings.defaultProjectId])
+      }, unmarshalListFoldersResponse);
+    };
+  })();
+
+  /**
+   * List secrets. Retrieve the list of folders created within a Project.
+   *
+   * @param request - The request {@link ListFoldersRequest}
+   * @returns A Promise of ListFoldersResponse
+   */
+  listFolders = (() => {
+    var _this4 = this;
+    return function (request) {
+      if (request === void 0) {
+        request = {};
+      }
+      return enrichForPagination('folders', _this4.pageOfListFolders, request);
+    };
+  })();
 
   /**
    * Delete a secret. Delete a given secret specified by the `region` and
@@ -114,6 +161,16 @@ class API extends API$1 {
     path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
   });
 
+  /**
+   * Delete a given folder specified by the and `folder_id` parameter.
+   *
+   * @param request - The request {@link DeleteFolderRequest}
+   */
+  deleteFolder = request => this.client.fetch({
+    method: 'DELETE',
+    path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/folders/${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
@@ -324,15 +381,15 @@ class API extends API$1 {
     path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}/versions/${validatePathParam('revision', request.revision)}/destroy`
   }, unmarshalSecretVersion);
   pageOfListTags = (() => {
-    var _this3 = this;
+    var _this5 = this;
     return function (request) {
       if (request === void 0) {
         request = {};
       }
-      return _this3.client.fetch({
+      return _this5.client.fetch({
         method: 'GET',
-        path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? _this3.client.settings.defaultRegion)}/tags`,
-        urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? _this3.client.settings.defaultPageSize], ['project_id', request.projectId])
+        path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? _this5.client.settings.defaultRegion)}/tags`,
+        urlParams: urlParams(['page', request.page], ['page_size', request.pageSize ?? _this5.client.settings.defaultPageSize], ['project_id', request.projectId])
       }, unmarshalListTagsResponse);
     };
   })();
@@ -344,12 +401,12 @@ class API extends API$1 {
    * @returns A Promise of ListTagsResponse
    */
   listTags = (() => {
-    var _this4 = this;
+    var _this6 = this;
     return function (request) {
       if (request === void 0) {
         request = {};
       }
-      return enrichForPagination('tags', _this4.pageOfListTags, request);
+      return enrichForPagination('tags', _this6.pageOfListTags, request);
     };
   })();
 }

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

@@ -3,6 +3,18 @@ import { unmarshalDate, unmarshalArrayOfObject, resolveOneOf } from '../../../he
 
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
+const unmarshalFolder = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Folder' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    path: data.path,
+    projectId: data.project_id
+  };
+};
 const unmarshalSecret = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Secret' failed as data isn't a dictionary.`);
@@ -14,6 +26,7 @@ const unmarshalSecret = data => {
     isManaged: data.is_managed,
     isProtected: data.is_protected,
     name: data.name,
+    path: data.path,
     projectId: data.project_id,
     region: data.region,
     status: data.status,
@@ -48,6 +61,15 @@ const unmarshalAccessSecretVersionResponse = data => {
     secretId: data.secret_id
   };
 };
+const unmarshalListFoldersResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListFoldersResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    folders: unmarshalArrayOfObject(data.folders, unmarshalFolder),
+    totalCount: data.total_count
+  };
+};
 const unmarshalListSecretVersionsResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListSecretVersionsResponse' failed as data isn't a dictionary.`);
@@ -86,9 +108,15 @@ const marshalAddSecretOwnerRequest = (request, defaults) => ({
   product: request.product ?? 'unknown',
   product_name: request.productName
 });
+const marshalCreateFolderRequest = (request, defaults) => ({
+  name: request.name,
+  path: request.path,
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
 const marshalCreateSecretRequest = (request, defaults) => ({
   description: request.description,
   name: request.name,
+  path: request.path,
   project_id: request.projectId ?? defaults.defaultProjectId,
   tags: request.tags,
   type: request.type ?? 'unknown_secret_type'
@@ -115,10 +143,11 @@ const marshalGeneratePasswordRequest = (request, defaults) => ({
 const marshalUpdateSecretRequest = (request, defaults) => ({
   description: request.description,
   name: request.name,
+  path: request.path,
   tags: request.tags
 });
 const marshalUpdateSecretVersionRequest = (request, defaults) => ({
   description: request.description
 });
 
-export { marshalAddSecretOwnerRequest, marshalCreateSecretRequest, marshalCreateSecretVersionRequest, marshalGeneratePasswordRequest, marshalUpdateSecretRequest, marshalUpdateSecretVersionRequest, unmarshalAccessSecretVersionResponse, unmarshalListSecretVersionsResponse, unmarshalListSecretsResponse, unmarshalListTagsResponse, unmarshalSecret, unmarshalSecretVersion };
+export { marshalAddSecretOwnerRequest, marshalCreateFolderRequest, marshalCreateSecretRequest, marshalCreateSecretVersionRequest, marshalGeneratePasswordRequest, marshalUpdateSecretRequest, marshalUpdateSecretVersionRequest, unmarshalAccessSecretVersionResponse, unmarshalFolder, unmarshalListFoldersResponse, unmarshalListSecretVersionsResponse, unmarshalListSecretsResponse, unmarshalListTagsResponse, unmarshalSecret, unmarshalSecretVersion };

package/dist/index.cjs

@@ -497,7 +497,7 @@ const assertValidSettings = obj => {
   }
 };
 
-const version = 'v1.23.0';
+const version = 'v1.25.0';
 const userAgent = `scaleway-sdk-js/${version}`;
 
 const isBrowser = () => typeof window !== 'undefined' && typeof window.document !== 'undefined';
@@ -20288,6 +20288,18 @@ var index$6 = /*#__PURE__*/Object.freeze({
 
 // This file was automatically generated. DO NOT EDIT.
 // If you have any remark or suggestion do not hesitate to open an issue.
+const unmarshalFolder = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'Folder' failed as data isn't a dictionary.`);
+  }
+  return {
+    createdAt: unmarshalDate(data.created_at),
+    id: data.id,
+    name: data.name,
+    path: data.path,
+    projectId: data.project_id
+  };
+};
 const unmarshalSecret = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'Secret' failed as data isn't a dictionary.`);
@@ -20299,6 +20311,7 @@ const unmarshalSecret = data => {
     isManaged: data.is_managed,
     isProtected: data.is_protected,
     name: data.name,
+    path: data.path,
     projectId: data.project_id,
     region: data.region,
     status: data.status,
@@ -20333,6 +20346,15 @@ const unmarshalAccessSecretVersionResponse = data => {
     secretId: data.secret_id
   };
 };
+const unmarshalListFoldersResponse = data => {
+  if (!isJSONObject(data)) {
+    throw new TypeError(`Unmarshalling the type 'ListFoldersResponse' failed as data isn't a dictionary.`);
+  }
+  return {
+    folders: unmarshalArrayOfObject(data.folders, unmarshalFolder),
+    totalCount: data.total_count
+  };
+};
 const unmarshalListSecretVersionsResponse = data => {
   if (!isJSONObject(data)) {
     throw new TypeError(`Unmarshalling the type 'ListSecretVersionsResponse' failed as data isn't a dictionary.`);
@@ -20371,9 +20393,15 @@ const marshalAddSecretOwnerRequest = (request, defaults) => ({
   product: request.product ?? 'unknown',
   product_name: request.productName
 });
+const marshalCreateFolderRequest = (request, defaults) => ({
+  name: request.name,
+  path: request.path,
+  project_id: request.projectId ?? defaults.defaultProjectId
+});
 const marshalCreateSecretRequest = (request, defaults) => ({
   description: request.description,
   name: request.name,
+  path: request.path,
   project_id: request.projectId ?? defaults.defaultProjectId,
   tags: request.tags,
   type: request.type ?? 'unknown_secret_type'
@@ -20400,6 +20428,7 @@ const marshalGeneratePasswordRequest = (request, defaults) => ({
 const marshalUpdateSecretRequest = (request, defaults) => ({
   description: request.description,
   name: request.name,
+  path: request.path,
   tags: request.tags
 });
 const marshalUpdateSecretVersionRequest = (request, defaults) => ({
@@ -20423,7 +20452,7 @@ let API$6 = class API extends API$s {
   static LOCALITIES = ['fr-par'];
 
   /**
-   * Create a secret. You must sepcify the `region` to create a secret.
+   * Create a secret. You must specify the `region` to create a secret.
    *
    * @param request - The request {@link CreateSecretRequest}
    * @returns A Promise of Secret
@@ -20435,6 +20464,19 @@ let API$6 = class API extends API$s {
     path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`
   }, unmarshalSecret);
 
+  /**
+   * Create folder.
+   *
+   * @param request - The request {@link CreateFolderRequest}
+   * @returns A Promise of Folder
+   */
+  createFolder = request => this.client.fetch({
+    body: JSON.stringify(marshalCreateFolderRequest(request, this.client.settings)),
+    headers: jsonContentHeaders$6,
+    method: 'POST',
+    path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/folders`
+  }, unmarshalFolder);
+
   /**
    * Get metadata using the secret's ID. Retrieve the metadata of a secret
    * specified by the `region` and `secret_id` parameters.
@@ -20451,6 +20493,11 @@ let API$6 = class API extends API$s {
    * 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 you to use ListSecrets with the `name` filter.
+   *
+   * @deprecated
    * @param request - The request {@link GetSecretByNameRequest}
    * @returns A Promise of Secret
    */
@@ -20477,7 +20524,7 @@ let API$6 = class API extends API$s {
   pageOfListSecrets = (request = {}) => this.client.fetch({
     method: 'GET',
     path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets`,
-    urlParams: urlParams(['is_managed', request.isManaged], ['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['organization_id', request.organizationId], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['project_id', request.projectId], ['tags', request.tags])
+    urlParams: urlParams(['is_managed', request.isManaged], ['name', request.name], ['order_by', request.orderBy ?? 'name_asc'], ['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);
 
   /**
@@ -20489,6 +20536,19 @@ let API$6 = class API extends API$s {
    * @returns A Promise of ListSecretsResponse
    */
   listSecrets = (request = {}) => enrichForPagination('secrets', this.pageOfListSecrets, request);
+  pageOfListFolders = (request = {}) => this.client.fetch({
+    method: 'GET',
+    path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/folders`,
+    urlParams: urlParams(['order_by', request.orderBy ?? 'created_at_asc'], ['page', request.page], ['page_size', request.pageSize ?? this.client.settings.defaultPageSize], ['path', request.path], ['project_id', request.projectId ?? this.client.settings.defaultProjectId])
+  }, unmarshalListFoldersResponse);
+
+  /**
+   * List secrets. Retrieve the list of folders created within a Project.
+   *
+   * @param request - The request {@link ListFoldersRequest}
+   * @returns A Promise of ListFoldersResponse
+   */
+  listFolders = (request = {}) => enrichForPagination('folders', this.pageOfListFolders, request);
 
   /**
    * Delete a secret. Delete a given secret specified by the `region` and
@@ -20501,6 +20561,16 @@ let API$6 = class API extends API$s {
     path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/secrets/${validatePathParam('secretId', request.secretId)}`
   });
 
+  /**
+   * Delete a given folder specified by the and `folder_id` parameter.
+   *
+   * @param request - The request {@link DeleteFolderRequest}
+   */
+  deleteFolder = request => this.client.fetch({
+    method: 'DELETE',
+    path: `/secret-manager/v1alpha1/regions/${validatePathParam('region', request.region ?? this.client.settings.defaultRegion)}/folders/${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