@gofynd/fdk-client-javascript 1.0.2 → 1.0.3

package/sdk/platform/FileStorage/FileStoragePlatformClient.js

@@ -13,33 +13,16 @@ class FileStorage {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
-   * @param {StartRequest} arg.body
-   * @returns {Promise<StartResponse>} - Success response
-   * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
-   * @description: Uploads an arbitrarily sized buffer or blob.
-   *
-   * It has three Major Steps:
-   * Start
-   * Upload
-   * Complete
-   *
-   * ### Start
-   * Initiates the assets upload using `startUpload`.
-   * It returns the storage link in response.
-   *
-   * ### Upload
-   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
-   * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
-   *
-   * ### Complete
-   * After successfully upload, call `completeUpload` api to complete the upload process.
-   * This operation will return the url for the uploaded file.
+   * @param {number} [arg.pageNo] - Page no
+   * @returns {Promise<BrowseResponse>} - Success response
+   * @summary: Browse Files
+   * @description: Browse Files
    */
-  async startUpload({ namespace, body } = {}) {
-    const { error } = FileStorageValidator.startUpload().validate(
+  async browse({ namespace, pageNo } = {}) {
+    const { error } = FileStorageValidator.browse().validate(
       {
         namespace,
-        body,
+        pageNo,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -48,37 +31,38 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.startUpload().validate(
+    const { error: warrning } = FileStorageValidator.browse().validate(
       {
         namespace,
-        body,
+        pageNo,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for startUpload",
+        message: "Parameter Validation warrnings for browse",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["page_no"] = pageNo;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "post",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/start/`,
+      "get",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/browse/`,
       query_params,
-      body,
+      undefined,
       xHeaders
     );
 
     const {
       error: res_error,
-    } = FileStorageModel.StartResponse().validate(response, {
+    } = FileStorageModel.BrowseResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -86,7 +70,7 @@ class FileStorage {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for startUpload",
+        message: "Response Validation Warnnings for browse",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -94,6 +78,32 @@ class FileStorage {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} arg.namespace - Bucket name
+   * @summary: Browse Files
+   * @description: Browse Files
+   */
+  browsePaginator({ namespace } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.browse({
+        namespace: namespace,
+        pageNo: pageNo,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback);
+    return paginator;
+  }
+
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
@@ -180,15 +190,17 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {SignUrlRequest} arg.body
-   * @returns {Promise<SignUrlResponse>} - Success response
-   * @summary: Gives signed urls to access private files
-   * @description: Describe here
+   * @param {boolean} [arg.sync] - Sync
+   * @param {BulkRequest} arg.body
+   * @returns {Promise<BulkUploadResponse>} - Success response
+   * @summary: Copy Files
+   * @description: Copy Files
    */
-  async getSignUrls({ body } = {}) {
-    const { error } = FileStorageValidator.getSignUrls().validate(
+  async copyFiles({ body, sync } = {}) {
+    const { error } = FileStorageValidator.copyFiles().validate(
       {
         body,
+        sync,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -197,28 +209,30 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.getSignUrls().validate(
+    const { error: warrning } = FileStorageValidator.copyFiles().validate(
       {
         body,
+        sync,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for getSignUrls",
+        message: "Parameter Validation warrnings for copyFiles",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
+    query_params["sync"] = sync;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/sign-urls/`,
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/uploads/copy/`,
       query_params,
       body,
       xHeaders
@@ -226,7 +240,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStorageModel.SignUrlResponse().validate(response, {
+    } = FileStorageModel.BulkUploadResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -234,7 +248,7 @@ class FileStorage {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for getSignUrls",
+        message: "Response Validation Warnnings for copyFiles",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -244,17 +258,15 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {boolean} [arg.sync] - Sync
-   * @param {BulkRequest} arg.body
-   * @returns {Promise<BulkUploadResponse>} - Success response
-   * @summary: Copy Files
-   * @description: Copy Files
+   * @param {SignUrlRequest} arg.body
+   * @returns {Promise<SignUrlResponse>} - Success response
+   * @summary: Gives signed urls to access private files
+   * @description: Describe here
    */
-  async copyFiles({ body, sync } = {}) {
-    const { error } = FileStorageValidator.copyFiles().validate(
+  async getSignUrls({ body } = {}) {
+    const { error } = FileStorageValidator.getSignUrls().validate(
       {
         body,
-        sync,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -263,30 +275,28 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.copyFiles().validate(
+    const { error: warrning } = FileStorageValidator.getSignUrls().validate(
       {
         body,
-        sync,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for copyFiles",
+        message: "Parameter Validation warrnings for getSignUrls",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["sync"] = sync;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/uploads/copy/`,
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/sign-urls/`,
       query_params,
       body,
       xHeaders
@@ -294,7 +304,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStorageModel.BulkUploadResponse().validate(response, {
+    } = FileStorageModel.SignUrlResponse().validate(response, {
       abortEarly: false,
       allowUnknown: false,
     });
@@ -302,7 +312,7 @@ class FileStorage {
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for copyFiles",
+        message: "Response Validation Warnnings for getSignUrls",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -312,17 +322,15 @@ class FileStorage {
 
   /**
    * @param {Object} arg - Arg object.
-   * @param {string} arg.namespace - Bucket name
-   * @param {number} [arg.pageNo] - Page no
-   * @returns {Promise<BrowseResponse>} - Success response
-   * @summary: Browse Files
-   * @description: Browse Files
+   * @param {string} arg.url - Url
+   * @returns {Promise<string>} - Success response
+   * @summary: Proxy
+   * @description: Proxy
    */
-  async browse({ namespace, pageNo } = {}) {
-    const { error } = FileStorageValidator.browse().validate(
+  async proxy({ url } = {}) {
+    const { error } = FileStorageValidator.proxy().validate(
       {
-        namespace,
-        pageNo,
+        url,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -331,46 +339,42 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.browse().validate(
+    const { error: warrning } = FileStorageValidator.proxy().validate(
       {
-        namespace,
-        pageNo,
+        url,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for browse",
+        message: "Parameter Validation warrnings for proxy",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["page_no"] = pageNo;
+    query_params["url"] = url;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
-      "get",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/browse/`,
+      "post",
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/proxy/`,
       query_params,
       undefined,
       xHeaders
     );
 
-    const {
-      error: res_error,
-    } = FileStorageModel.BrowseResponse().validate(response, {
-      abortEarly: false,
-      allowUnknown: false,
-    });
+    const { error: res_error } = Joi.string()
+      .allow("")
+      .validate(response, { abortEarly: false, allowUnknown: false });
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for browse",
+        message: "Response Validation Warnnings for proxy",
       });
       Logger({ level: "WARN", message: res_error });
     }
@@ -381,40 +385,33 @@ class FileStorage {
   /**
    * @param {Object} arg - Arg object.
    * @param {string} arg.namespace - Bucket name
-   * @summary: Browse Files
-   * @description: Browse Files
-   */
-  browsePaginator({ namespace } = {}) {
-    const paginator = new Paginator();
-    const callback = async () => {
-      const pageId = paginator.nextId;
-      const pageNo = paginator.pageNo;
-      const pageType = "number";
-      const data = await this.browse({
-        namespace: namespace,
-        pageNo: pageNo,
-      });
-      paginator.setPaginator({
-        hasNext: data.page.has_next ? true : false,
-        nextId: data.page.next_id,
-      });
-      return data;
-    };
-    paginator.setCallback(callback);
-    return paginator;
-  }
-
-  /**
-   * @param {Object} arg - Arg object.
-   * @param {string} arg.url - Url
-   * @returns {Promise<string>} - Success response
-   * @summary: Proxy
-   * @description: Proxy
+   * @param {StartRequest} arg.body
+   * @returns {Promise<StartResponse>} - Success response
+   * @summary: This operation initiates upload and returns storage link which is valid for 30 Minutes. You can use that storage link to make subsequent upload request with file buffer or blob.
+   * @description: Uploads an arbitrarily sized buffer or blob.
+   *
+   * It has three Major Steps:
+   * Start
+   * Upload
+   * Complete
+   *
+   * ### Start
+   * Initiates the assets upload using `startUpload`.
+   * It returns the storage link in response.
+   *
+   * ### Upload
+   * Use the storage link to upload a file (Buffer or Blob) to the File Storage.
+   * Make a `PUT` request on storage link received from `startUpload` api with file (Buffer or Blob) as a request body.
+   *
+   * ### Complete
+   * After successfully upload, call `completeUpload` api to complete the upload process.
+   * This operation will return the url for the uploaded file.
    */
-  async proxy({ url } = {}) {
-    const { error } = FileStorageValidator.proxy().validate(
+  async startUpload({ namespace, body } = {}) {
+    const { error } = FileStorageValidator.startUpload().validate(
       {
-        url,
+        namespace,
+        body,
       },
       { abortEarly: false, allowUnknown: true }
     );
@@ -423,42 +420,45 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStorageValidator.proxy().validate(
+    const { error: warrning } = FileStorageValidator.startUpload().validate(
       {
-        url,
+        namespace,
+        body,
       },
       { abortEarly: false, allowUnknown: false }
     );
     if (warrning) {
       Logger({
         level: "WARN",
-        message: "Parameter Validation warrnings for proxy",
+        message: "Parameter Validation warrnings for startUpload",
       });
       Logger({ level: "WARN", message: warrning });
     }
 
     const query_params = {};
-    query_params["url"] = url;
 
     const xHeaders = {};
 
     const response = await PlatformAPIClient.execute(
       this.config,
       "post",
-      `/service/platform/assets/v1.0/company/${this.config.companyId}/proxy/`,
+      `/service/platform/assets/v1.0/company/${this.config.companyId}/namespaces/${namespace}/upload/start/`,
       query_params,
-      undefined,
+      body,
       xHeaders
     );
 
-    const { error: res_error } = Joi.string()
-      .allow("")
-      .validate(response, { abortEarly: false, allowUnknown: false });
+    const {
+      error: res_error,
+    } = FileStorageModel.StartResponse().validate(response, {
+      abortEarly: false,
+      allowUnknown: false,
+    });
 
     if (res_error) {
       Logger({
         level: "WARN",
-        message: "Response Validation Warnnings for proxy",
+        message: "Response Validation Warnnings for startUpload",
       });
       Logger({ level: "WARN", message: res_error });
     }

package/sdk/platform/FileStorage/FileStoragePlatformModel.d.ts

@@ -1,21 +1,21 @@
 export = FileStorageModel;
 declare class FileStorageModel {
-    static FailedResponse(): any;
+    static BrowseResponse(): any;
+    static BulkRequest(): any;
+    static BulkUploadResponse(): any;
     static CDN(): any;
-    static Upload(): any;
-    static StartResponse(): any;
-    static StartRequest(): any;
     static CompleteResponse(): any;
-    static Opts(): any;
     static CopyFileTask(): any;
-    static BulkUploadResponse(): any;
-    static ReqConfiguration(): any;
+    static DbRecord(): any;
     static Destination(): any;
-    static BulkRequest(): any;
-    static Urls(): any;
-    static SignUrlResponse(): any;
-    static SignUrlRequest(): any;
+    static FailedResponse(): any;
+    static Opts(): any;
     static Page(): any;
-    static DbRecord(): any;
-    static BrowseResponse(): any;
+    static ReqConfiguration(): any;
+    static SignUrlRequest(): any;
+    static SignUrlResponse(): any;
+    static StartRequest(): any;
+    static StartResponse(): any;
+    static Upload(): any;
+    static Urls(): any;
 }