@gofynd/fdk-client-javascript 3.1.0-beta.1 → 3.2.0

package/sdk/partner/FileStorage/FileStoragePartnerClient.js

@@ -14,156 +14,6 @@ class FileStorage {
     this.config = config;
   }
 
-  /**
-   * @param {FileStoragePartnerValidator.GetAllNamespaceDetailsParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.AllNamespaceDetails>} - Success response
-   * @name getAllNamespaceDetails
-   * @summary: Get details of all namespaces
-   * @description: Retrieve information about all available namespaces - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/getAllNamespaceDetails/).
-   */
-  async getAllNamespaceDetails(
-    { requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const {
-      error,
-    } = FileStoragePartnerValidator.getAllNamespaceDetails().validate(
-      {},
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = FileStoragePartnerValidator.getAllNamespaceDetails().validate(
-      {},
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for partner > FileStorage > getAllNamespaceDetails \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PartnerAPIClient.execute(
-      this.config,
-      "get",
-      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/namespaces`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = FileStoragePartnerModel.AllNamespaceDetails().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for partner > FileStorage > getAllNamespaceDetails \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {FileStoragePartnerValidator.GetNamespaceDetailParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.NamespaceDetails>} - Success response
-   * @name getNamespaceDetail
-   * @summary: Get details of a namespace
-   * @description: Retrieve information about a specific namespace - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/getNamespaceDetail/).
-   */
-  async getNamespaceDetail(
-    { namespace, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = FileStoragePartnerValidator.getNamespaceDetail().validate(
-      {
-        namespace,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = FileStoragePartnerValidator.getNamespaceDetail().validate(
-      { namespace },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for partner > FileStorage > getNamespaceDetail \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-
-    const response = await PartnerAPIClient.execute(
-      this.config,
-      "get",
-      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/namespaces/${namespace}`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = FileStoragePartnerModel.NamespaceDetails().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for partner > FileStorage > getNamespaceDetail \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -360,92 +210,6 @@ class FileStorage {
     return response;
   }
 
-  /**
-   * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<Object>} - Success response
-   * @name browse
-   * @summary: Browse Files
-   * @description: Browse Files - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/browse/).
-   */
-  async browse(
-    { namespace, applicationId, companyId, page, limit, requestHeaders } = {
-      requestHeaders: {},
-    },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = FileStoragePartnerValidator.browse().validate(
-      {
-        namespace,
-        applicationId,
-        companyId,
-        page,
-        limit,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const { error: warrning } = FileStoragePartnerValidator.browse().validate(
-      {
-        namespace,
-
-        applicationId,
-        companyId,
-        page,
-        limit,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for partner > FileStorage > browse \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["page"] = page;
-    query_params["limit"] = limit;
-
-    const response = await PartnerAPIClient.execute(
-      this.config,
-      "get",
-      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/namespaces/${namespace}/browse`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const { error: res_error } = Joi.any().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for partner > FileStorage > browse \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
   /**
    * @param {FileStoragePartnerValidator.BrowseFilesParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -529,26 +293,20 @@ class FileStorage {
   }
 
   /**
-   * @param {FileStoragePartnerValidator.OrganizationLevelFetchProxyParam} arg
-   *   - Arg object.
-   *
+   * @param {FileStoragePartnerValidator.FetchProxyParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
    * @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
-   * @name organizationLevelFetchProxy
+   * @name fetchProxy
    * @summary: Proxy
-   * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/organizationLevelFetchProxy/).
+   * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/fetchProxy/).
    */
-  async organizationLevelFetchProxy(
-    { applicationId, companyId, url, requestHeaders } = { requestHeaders: {} },
+  async fetchProxy(
+    { url, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const {
-      error,
-    } = FileStoragePartnerValidator.organizationLevelFetchProxy().validate(
+    const { error } = FileStoragePartnerValidator.fetchProxy().validate(
       {
-        applicationId,
-        companyId,
         url,
       },
       { abortEarly: false, allowUnknown: true }
@@ -560,10 +318,8 @@ class FileStorage {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = FileStoragePartnerValidator.organizationLevelFetchProxy().validate(
+    } = FileStoragePartnerValidator.fetchProxy().validate(
       {
-        applicationId,
-        companyId,
         url,
       },
       { abortEarly: false, allowUnknown: false }
@@ -571,7 +327,7 @@ class FileStorage {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for partner > FileStorage > organizationLevelFetchProxy \n ${warrning}`,
+        message: `Parameter Validation warrnings for partner > FileStorage > fetchProxy \n ${warrning}`,
       });
     }
 
@@ -581,7 +337,7 @@ class FileStorage {
     const response = await PartnerAPIClient.execute(
       this.config,
       "get",
-      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/proxy/fetch`,
+      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/proxy/fetch`,
       query_params,
       undefined,
       requestHeaders,
@@ -606,7 +362,7 @@ class FileStorage {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for partner > FileStorage > organizationLevelFetchProxy \n ${res_error}`,
+          message: `Response Validation Warnings for partner > FileStorage > fetchProxy \n ${res_error}`,
         });
       }
     }
@@ -615,26 +371,20 @@ class FileStorage {
   }
 
   /**
-   * @param {FileStoragePartnerValidator.SaveOrganizationLevelProxyParam} arg
-   *   - Arg object.
-   *
+   * @param {FileStoragePartnerValidator.SaveProxyDetailsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
    * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
-   * @name saveOrganizationLevelProxy
+   * @name saveProxyDetails
    * @summary: Proxy
-   * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveOrganizationLevelProxy/).
+   * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveProxyDetails/).
    */
-  async saveOrganizationLevelProxy(
-    { applicationId, companyId, body, requestHeaders } = { requestHeaders: {} },
+  async saveProxyDetails(
+    { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const {
-      error,
-    } = FileStoragePartnerValidator.saveOrganizationLevelProxy().validate(
+    const { error } = FileStoragePartnerValidator.saveProxyDetails().validate(
       {
-        applicationId,
-        companyId,
         body,
       },
       { abortEarly: false, allowUnknown: true }
@@ -646,10 +396,8 @@ class FileStorage {
     // Showing warrnings if extra unknown parameters are found
     const {
       error: warrning,
-    } = FileStoragePartnerValidator.saveOrganizationLevelProxy().validate(
+    } = FileStoragePartnerValidator.saveProxyDetails().validate(
       {
-        applicationId,
-        companyId,
         body,
       },
       { abortEarly: false, allowUnknown: false }
@@ -657,7 +405,7 @@ class FileStorage {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for partner > FileStorage > saveOrganizationLevelProxy \n ${warrning}`,
+        message: `Parameter Validation warrnings for partner > FileStorage > saveProxyDetails \n ${warrning}`,
       });
     }
 
@@ -666,7 +414,7 @@ class FileStorage {
     const response = await PartnerAPIClient.execute(
       this.config,
       "post",
-      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/company/${companyId}/application/${applicationId}/proxy/fetch`,
+      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/proxy/fetch`,
       query_params,
       body,
       requestHeaders,
@@ -691,85 +439,7 @@ class FileStorage {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for partner > FileStorage > saveOrganizationLevelProxy \n ${res_error}`,
-        });
-      }
-    }
-
-    return response;
-  }
-
-  /**
-   * @param {FileStoragePartnerValidator.FetchProxyParam} arg - Arg object.
-   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
-   * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
-   * @name fetchProxy
-   * @summary: Proxy
-   * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/fetchProxy/).
-   */
-  async fetchProxy(
-    { url, requestHeaders } = { requestHeaders: {} },
-    { responseHeaders } = { responseHeaders: false }
-  ) {
-    const { error } = FileStoragePartnerValidator.fetchProxy().validate(
-      {
-        url,
-      },
-      { abortEarly: false, allowUnknown: true }
-    );
-    if (error) {
-      return Promise.reject(new FDKClientValidationError(error));
-    }
-
-    // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = FileStoragePartnerValidator.fetchProxy().validate(
-      {
-        url,
-      },
-      { abortEarly: false, allowUnknown: false }
-    );
-    if (warrning) {
-      Logger({
-        level: "WARN",
-        message: `Parameter Validation warrnings for partner > FileStorage > fetchProxy \n ${warrning}`,
-      });
-    }
-
-    const query_params = {};
-    query_params["url"] = url;
-
-    const response = await PartnerAPIClient.execute(
-      this.config,
-      "get",
-      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/proxy/fetch`,
-      query_params,
-      undefined,
-      requestHeaders,
-      { responseHeaders }
-    );
-
-    let responseData = response;
-    if (responseHeaders) {
-      responseData = response[0];
-    }
-
-    const {
-      error: res_error,
-    } = FileStoragePartnerModel.FetchProxyDetails().validate(responseData, {
-      abortEarly: false,
-      allowUnknown: true,
-    });
-
-    if (res_error) {
-      if (this.config.options.strictResponseCheck === true) {
-        return Promise.reject(new FDKResponseValidationError(res_error));
-      } else {
-        Logger({
-          level: "WARN",
-          message: `Response Validation Warnings for partner > FileStorage > fetchProxy \n ${res_error}`,
+          message: `Response Validation Warnings for partner > FileStorage > saveProxyDetails \n ${res_error}`,
         });
       }
     }
@@ -778,19 +448,19 @@ class FileStorage {
   }
 
   /**
-   * @param {FileStoragePartnerValidator.SaveProxyDetailsParam} arg - Arg object.
+   * @param {FileStoragePartnerValidator.SignUrlsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
-   * @name saveProxyDetails
-   * @summary: Proxy
-   * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveProxyDetails/).
+   * @returns {Promise<FileStoragePartnerModel.SignUrlResult>} - Success response
+   * @name signUrls
+   * @summary: Get signed URLs.
+   * @description: Generates secure, signed URLs that is valid for certain expiry time for accessing stored files. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/signUrls/).
    */
-  async saveProxyDetails(
+  async signUrls(
     { body, requestHeaders } = { requestHeaders: {} },
     { responseHeaders } = { responseHeaders: false }
   ) {
-    const { error } = FileStoragePartnerValidator.saveProxyDetails().validate(
+    const { error } = FileStoragePartnerValidator.signUrls().validate(
       {
         body,
       },
@@ -801,9 +471,7 @@ class FileStorage {
     }
 
     // Showing warrnings if extra unknown parameters are found
-    const {
-      error: warrning,
-    } = FileStoragePartnerValidator.saveProxyDetails().validate(
+    const { error: warrning } = FileStoragePartnerValidator.signUrls().validate(
       {
         body,
       },
@@ -812,7 +480,7 @@ class FileStorage {
     if (warrning) {
       Logger({
         level: "WARN",
-        message: `Parameter Validation warrnings for partner > FileStorage > saveProxyDetails \n ${warrning}`,
+        message: `Parameter Validation warrnings for partner > FileStorage > signUrls \n ${warrning}`,
       });
     }
 
@@ -821,7 +489,7 @@ class FileStorage {
     const response = await PartnerAPIClient.execute(
       this.config,
       "post",
-      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/proxy/fetch`,
+      `/service/partner/assets/v1.0/organization/${this.config.organizationId}/sign-urls`,
       query_params,
       body,
       requestHeaders,
@@ -835,7 +503,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePartnerModel.SaveProxy().validate(responseData, {
+    } = FileStoragePartnerModel.SignUrlResult().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -846,7 +514,7 @@ class FileStorage {
       } else {
         Logger({
           level: "WARN",
-          message: `Response Validation Warnings for partner > FileStorage > saveProxyDetails \n ${res_error}`,
+          message: `Response Validation Warnings for partner > FileStorage > signUrls \n ${res_error}`,
         });
       }
     }

package/sdk/partner/FileStorage/FileStoragePartnerModel.d.ts

@@ -95,10 +95,26 @@ export = FileStoragePartnerModel;
  * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
+/**
+ * @typedef SignedUrl
+ * @property {string} url - This is the original asset URL provided in the
+ *   request. This is the URL for which a signed URL has been generated.
+ * @property {string} signed_url - Generated signed URL.
+ * @property {number} expiry - The expiration time for the signed URL in seconds.
+ */
+/**
+ * @typedef SignUrlResult
+ * @property {SignedUrl[]} urls - Signed URL object.
+ */
+/**
+ * @typedef SignUrl
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string[]} urls - List of asset URLs to be signed.
+ */
 declare class FileStoragePartnerModel {
 }
 declare namespace FileStoragePartnerModel {
-    export { SizeConstraints, SaveProxy, ProxyFileData, ProxyFile, FetchProxyDetails, NamespaceDetails, AllNamespaceDetails, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, FailedBrowseFilesResult };
+    export { SizeConstraints, SaveProxy, ProxyFileData, ProxyFile, FetchProxyDetails, NamespaceDetails, AllNamespaceDetails, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, FailedBrowseFilesResult, SignedUrl, SignUrlResult, SignUrl };
 }
 /** @returns {SizeConstraints} */
 declare function SizeConstraints(): SizeConstraints;
@@ -222,3 +238,40 @@ declare function FailedBrowseFilesResult(): FailedBrowseFilesResult;
 type FailedBrowseFilesResult = {
     message: string;
 };
+/** @returns {SignedUrl} */
+declare function SignedUrl(): SignedUrl;
+type SignedUrl = {
+    /**
+     * - This is the original asset URL provided in the
+     * request. This is the URL for which a signed URL has been generated.
+     */
+    url: string;
+    /**
+     * - Generated signed URL.
+     */
+    signed_url: string;
+    /**
+     * - The expiration time for the signed URL in seconds.
+     */
+    expiry: number;
+};
+/** @returns {SignUrlResult} */
+declare function SignUrlResult(): SignUrlResult;
+type SignUrlResult = {
+    /**
+     * - Signed URL object.
+     */
+    urls: SignedUrl[];
+};
+/** @returns {SignUrl} */
+declare function SignUrl(): SignUrl;
+type SignUrl = {
+    /**
+     * - The expiration time for the signed URL.
+     */
+    expiry: number;
+    /**
+     * - List of asset URLs to be signed.
+     */
+    urls: string[];
+};

package/sdk/partner/FileStorage/FileStoragePartnerModel.js

@@ -110,6 +110,25 @@ const Joi = require("joi");
  * @property {string} message
  */
 
+/**
+ * @typedef SignedUrl
+ * @property {string} url - This is the original asset URL provided in the
+ *   request. This is the URL for which a signed URL has been generated.
+ * @property {string} signed_url - Generated signed URL.
+ * @property {number} expiry - The expiration time for the signed URL in seconds.
+ */
+
+/**
+ * @typedef SignUrlResult
+ * @property {SignedUrl[]} urls - Signed URL object.
+ */
+
+/**
+ * @typedef SignUrl
+ * @property {number} expiry - The expiration time for the signed URL.
+ * @property {string[]} urls - List of asset URLs to be signed.
+ */
+
 class FileStoragePartnerModel {
   /** @returns {SizeConstraints} */
   static SizeConstraints() {
@@ -249,5 +268,29 @@ class FileStoragePartnerModel {
       message: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {SignedUrl} */
+  static SignedUrl() {
+    return Joi.object({
+      url: Joi.string().allow("").required(),
+      signed_url: Joi.string().allow("").required(),
+      expiry: Joi.number().required(),
+    });
+  }
+
+  /** @returns {SignUrlResult} */
+  static SignUrlResult() {
+    return Joi.object({
+      urls: Joi.array().items(FileStoragePartnerModel.SignedUrl()).required(),
+    });
+  }
+
+  /** @returns {SignUrl} */
+  static SignUrl() {
+    return Joi.object({
+      expiry: Joi.number().required(),
+      urls: Joi.array().items(Joi.string().allow("")).required(),
+    });
+  }
 }
 module.exports = FileStoragePartnerModel;

package/sdk/partner/FileStorage/FileStoragePartnerValidator.d.ts

@@ -1,13 +1,9 @@
 export = FileStorageValidator;
 declare class FileStorageValidator {
-    static getAllNamespaceDetails(): any;
-    static getNamespaceDetail(): any;
     static completeUpload(): any;
     static startUpload(): any;
-    static browse(): any;
     static browseFiles(): any;
-    static organizationLevelFetchProxy(): any;
-    static saveOrganizationLevelProxy(): any;
     static fetchProxy(): any;
     static saveProxyDetails(): any;
+    static signUrls(): any;
 }