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

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

@@ -26,7 +26,7 @@ declare class FileStorage {
      * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.CompleteResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FileUploadComplete>} - Success response
      * @name completeUpload
      * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
      * @description: Uploads an arbitrarily sized buffer or blob.
@@ -49,12 +49,12 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/completeUpload/).
      */
-    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.CompleteResponse>;
+    completeUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.CompleteUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUploadComplete>;
     /**
      * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.StartResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FileUpload>} - Success response
      * @name startUpload
      * @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.
@@ -77,7 +77,7 @@ declare class FileStorage {
      * This operation will return the url for the uploaded file.
      *  - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/startUpload/).
      */
-    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.StartResponse>;
+    startUpload({ namespace, body, requestHeaders }?: FileStoragePartnerValidator.StartUploadParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FileUpload>;
     /**
      * @param {FileStoragePartnerValidator.BrowseParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
@@ -104,43 +104,43 @@ declare class FileStorage {
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
      * @name organizationLevelFetchProxy
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/organizationLevelFetchProxy/).
      */
-    organizationLevelFetchProxy({ applicationId, companyId, url, requestHeaders }?: FileStoragePartnerValidator.OrganizationLevelFetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.ProxyResponse>;
+    organizationLevelFetchProxy({ applicationId, companyId, url, requestHeaders }?: FileStoragePartnerValidator.OrganizationLevelFetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyDetails>;
     /**
      * @param {FileStoragePartnerValidator.SaveOrganizationLevelProxyParam} arg
      *   - Arg object.
      *
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
+     * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
      * @name saveOrganizationLevelProxy
      * @summary: Proxy
      * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveOrganizationLevelProxy/).
      */
-    saveOrganizationLevelProxy({ applicationId, companyId, body, requestHeaders }?: FileStoragePartnerValidator.SaveOrganizationLevelProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyResponse>;
+    saveOrganizationLevelProxy({ applicationId, companyId, body, requestHeaders }?: FileStoragePartnerValidator.SaveOrganizationLevelProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SaveProxy>;
     /**
      * @param {FileStoragePartnerValidator.FetchProxyParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
+     * @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/).
      */
-    fetchProxy({ url, requestHeaders }?: FileStoragePartnerValidator.FetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.ProxyResponse>;
+    fetchProxy({ url, requestHeaders }?: FileStoragePartnerValidator.FetchProxyParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyDetails>;
     /**
      * @param {FileStoragePartnerValidator.SaveProxyDetailsParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
+     * @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/).
      */
-    saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.FetchProxyResponse>;
+    saveProxyDetails({ body, requestHeaders }?: FileStoragePartnerValidator.SaveProxyDetailsParam, { responseHeaders }?: object): Promise<FileStoragePartnerModel.SaveProxy>;
 }
 import FileStoragePartnerModel = require("./FileStoragePartnerModel");

package/sdk/partner/FileStorage/FileStoragePartnerClient.js

@@ -168,7 +168,7 @@ class FileStorage {
    * @param {FileStoragePartnerValidator.CompleteUploadParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.CompleteResponse>} - Success response
+   * @returns {Promise<FileStoragePartnerModel.FileUploadComplete>} - Success response
    * @name completeUpload
    * @summary: This will complete the upload process. After successfully uploading file, you can call this operation to complete the upload process.
    * @description: Uploads an arbitrarily sized buffer or blob.
@@ -243,7 +243,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePartnerModel.CompleteResponse().validate(responseData, {
+    } = FileStoragePartnerModel.FileUploadComplete().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -266,7 +266,7 @@ class FileStorage {
    * @param {FileStoragePartnerValidator.StartUploadParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.StartResponse>} - Success response
+   * @returns {Promise<FileStoragePartnerModel.FileUpload>} - Success response
    * @name startUpload
    * @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.
@@ -341,7 +341,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePartnerModel.StartResponse().validate(responseData, {
+    } = FileStoragePartnerModel.FileUpload().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -534,7 +534,7 @@ class FileStorage {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
+   * @returns {Promise<FileStoragePartnerModel.FetchProxyDetails>} - Success response
    * @name organizationLevelFetchProxy
    * @summary: Proxy
    * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/organizationLevelFetchProxy/).
@@ -595,7 +595,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePartnerModel.ProxyResponse().validate(responseData, {
+    } = FileStoragePartnerModel.FetchProxyDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -620,7 +620,7 @@ class FileStorage {
    *
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
+   * @returns {Promise<FileStoragePartnerModel.SaveProxy>} - Success response
    * @name saveOrganizationLevelProxy
    * @summary: Proxy
    * @description: Proxy - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/filestorage/saveOrganizationLevelProxy/).
@@ -680,7 +680,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePartnerModel.FetchProxyResponse().validate(responseData, {
+    } = FileStoragePartnerModel.SaveProxy().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -703,7 +703,7 @@ class FileStorage {
    * @param {FileStoragePartnerValidator.FetchProxyParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.ProxyResponse>} - Success response
+   * @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/).
@@ -758,7 +758,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePartnerModel.ProxyResponse().validate(responseData, {
+    } = FileStoragePartnerModel.FetchProxyDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -781,7 +781,7 @@ class FileStorage {
    * @param {FileStoragePartnerValidator.SaveProxyDetailsParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<FileStoragePartnerModel.FetchProxyResponse>} - Success response
+   * @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/).
@@ -835,7 +835,7 @@ class FileStorage {
 
     const {
       error: res_error,
-    } = FileStoragePartnerModel.FetchProxyResponse().validate(responseData, {
+    } = FileStoragePartnerModel.SaveProxy().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

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

@@ -4,20 +4,26 @@ export = FileStoragePartnerModel;
  * @property {number} [max] - Maximum allowed size (in bytes) for files in the namespace
  */
 /**
- * @typedef FetchProxyResponse
- * @property {string} [id]
- * @property {string} [created_at]
+ * @typedef SaveProxy
+ * @property {number} [id]
+ * @property {string} [token]
+ */
+/**
+ * @typedef ProxyFileData
+ * @property {string} [email]
+ * @property {string} [password]
  */
 /**
- * @typedef FetchProxyRequest
+ * @typedef ProxyFile
  * @property {number} [id]
  * @property {string} [customer]
  * @property {number} [quantity]
  * @property {number} [price]
+ * @property {ProxyFileData} [data]
  * @property {string} [url]
  */
 /**
- * @typedef ProxyResponse
+ * @typedef FetchProxyDetails
  * @property {Object} [data]
  * @property {Object} [support]
  */
@@ -45,7 +51,7 @@ export = FileStoragePartnerModel;
  * @property {string} url
  */
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name
  * @property {string} file_path
  * @property {string} content_type
@@ -57,7 +63,7 @@ export = FileStoragePartnerModel;
  * @property {string[]} [tags]
  */
 /**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name
  * @property {string} content_type
  * @property {number} size
@@ -69,7 +75,7 @@ export = FileStoragePartnerModel;
  * @property {string} [username]
  */
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id
  * @property {string} file_name
  * @property {string} file_path
@@ -86,13 +92,13 @@ export = FileStoragePartnerModel;
  * @property {CreatedBy} [created_by]
  */
 /**
- * @typedef FailedResponse
+ * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
 declare class FileStoragePartnerModel {
 }
 declare namespace FileStoragePartnerModel {
-    export { SizeConstraints, FetchProxyResponse, FetchProxyRequest, ProxyResponse, NamespaceDetails, AllNamespaceDetails, CDN, Upload, StartResponse, StartRequest, CreatedBy, CompleteResponse, FailedResponse };
+    export { SizeConstraints, SaveProxy, ProxyFileData, ProxyFile, FetchProxyDetails, NamespaceDetails, AllNamespaceDetails, CDN, Upload, FileUpload, FileUploadStart, CreatedBy, FileUploadComplete, FailedBrowseFilesResult };
 }
 /** @returns {SizeConstraints} */
 declare function SizeConstraints(): SizeConstraints;
@@ -102,24 +108,31 @@ type SizeConstraints = {
      */
     max?: number;
 };
-/** @returns {FetchProxyResponse} */
-declare function FetchProxyResponse(): FetchProxyResponse;
-type FetchProxyResponse = {
-    id?: string;
-    created_at?: string;
+/** @returns {SaveProxy} */
+declare function SaveProxy(): SaveProxy;
+type SaveProxy = {
+    id?: number;
+    token?: string;
+};
+/** @returns {ProxyFileData} */
+declare function ProxyFileData(): ProxyFileData;
+type ProxyFileData = {
+    email?: string;
+    password?: string;
 };
-/** @returns {FetchProxyRequest} */
-declare function FetchProxyRequest(): FetchProxyRequest;
-type FetchProxyRequest = {
+/** @returns {ProxyFile} */
+declare function ProxyFile(): ProxyFile;
+type ProxyFile = {
     id?: number;
     customer?: string;
     quantity?: number;
     price?: number;
+    data?: ProxyFileData;
     url?: string;
 };
-/** @returns {ProxyResponse} */
-declare function ProxyResponse(): ProxyResponse;
-type ProxyResponse = {
+/** @returns {FetchProxyDetails} */
+declare function FetchProxyDetails(): FetchProxyDetails;
+type FetchProxyDetails = {
     data?: any;
     support?: any;
 };
@@ -159,9 +172,9 @@ type Upload = {
     expiry: number;
     url: string;
 };
-/** @returns {StartResponse} */
-declare function StartResponse(): StartResponse;
-type StartResponse = {
+/** @returns {FileUpload} */
+declare function FileUpload(): FileUpload;
+type FileUpload = {
     file_name: string;
     file_path: string;
     content_type: string;
@@ -172,9 +185,9 @@ type StartResponse = {
     upload: Upload;
     tags?: string[];
 };
-/** @returns {StartRequest} */
-declare function StartRequest(): StartRequest;
-type StartRequest = {
+/** @returns {FileUploadStart} */
+declare function FileUploadStart(): FileUploadStart;
+type FileUploadStart = {
     file_name: string;
     content_type: string;
     size: number;
@@ -186,9 +199,9 @@ declare function CreatedBy(): CreatedBy;
 type CreatedBy = {
     username?: string;
 };
-/** @returns {CompleteResponse} */
-declare function CompleteResponse(): CompleteResponse;
-type CompleteResponse = {
+/** @returns {FileUploadComplete} */
+declare function FileUploadComplete(): FileUploadComplete;
+type FileUploadComplete = {
     _id: string;
     file_name: string;
     file_path: string;
@@ -204,8 +217,8 @@ type CompleteResponse = {
     modified_on: string;
     created_by?: CreatedBy;
 };
-/** @returns {FailedResponse} */
-declare function FailedResponse(): FailedResponse;
-type FailedResponse = {
+/** @returns {FailedBrowseFilesResult} */
+declare function FailedBrowseFilesResult(): FailedBrowseFilesResult;
+type FailedBrowseFilesResult = {
     message: string;
 };

package/sdk/partner/FileStorage/FileStoragePartnerModel.js

@@ -6,22 +6,29 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef FetchProxyResponse
- * @property {string} [id]
- * @property {string} [created_at]
+ * @typedef SaveProxy
+ * @property {number} [id]
+ * @property {string} [token]
  */
 
 /**
- * @typedef FetchProxyRequest
+ * @typedef ProxyFileData
+ * @property {string} [email]
+ * @property {string} [password]
+ */
+
+/**
+ * @typedef ProxyFile
  * @property {number} [id]
  * @property {string} [customer]
  * @property {number} [quantity]
  * @property {number} [price]
+ * @property {ProxyFileData} [data]
  * @property {string} [url]
  */
 
 /**
- * @typedef ProxyResponse
+ * @typedef FetchProxyDetails
  * @property {Object} [data]
  * @property {Object} [support]
  */
@@ -54,7 +61,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef StartResponse
+ * @typedef FileUpload
  * @property {string} file_name
  * @property {string} file_path
  * @property {string} content_type
@@ -67,7 +74,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef StartRequest
+ * @typedef FileUploadStart
  * @property {string} file_name
  * @property {string} content_type
  * @property {number} size
@@ -81,7 +88,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef CompleteResponse
+ * @typedef FileUploadComplete
  * @property {string} _id
  * @property {string} file_name
  * @property {string} file_path
@@ -99,7 +106,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef FailedResponse
+ * @typedef FailedBrowseFilesResult
  * @property {string} message
  */
 
@@ -111,27 +118,36 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {FetchProxyResponse} */
-  static FetchProxyResponse() {
+  /** @returns {SaveProxy} */
+  static SaveProxy() {
+    return Joi.object({
+      id: Joi.number(),
+      token: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {ProxyFileData} */
+  static ProxyFileData() {
     return Joi.object({
-      id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
+      email: Joi.string().allow(""),
+      password: Joi.string().allow(""),
     });
   }
 
-  /** @returns {FetchProxyRequest} */
-  static FetchProxyRequest() {
+  /** @returns {ProxyFile} */
+  static ProxyFile() {
     return Joi.object({
       id: Joi.number(),
       customer: Joi.string().allow(""),
       quantity: Joi.number(),
       price: Joi.number(),
+      data: FileStoragePartnerModel.ProxyFileData(),
       url: Joi.string().allow(""),
     });
   }
 
-  /** @returns {ProxyResponse} */
-  static ProxyResponse() {
+  /** @returns {FetchProxyDetails} */
+  static FetchProxyDetails() {
     return Joi.object({
       data: Joi.object().pattern(/\S/, Joi.any()),
       support: Joi.object().pattern(/\S/, Joi.any()),
@@ -174,8 +190,8 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {StartResponse} */
-  static StartResponse() {
+  /** @returns {FileUpload} */
+  static FileUpload() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
@@ -189,8 +205,8 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {StartRequest} */
-  static StartRequest() {
+  /** @returns {FileUploadStart} */
+  static FileUploadStart() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       content_type: Joi.string().allow("").required(),
@@ -207,8 +223,8 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {CompleteResponse} */
-  static CompleteResponse() {
+  /** @returns {FileUploadComplete} */
+  static FileUploadComplete() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -227,8 +243,8 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {FailedResponse} */
-  static FailedResponse() {
+  /** @returns {FailedBrowseFilesResult} */
+  static FailedBrowseFilesResult() {
     return Joi.object({
       message: Joi.string().allow("").required(),
     });

package/sdk/partner/FileStorage/FileStoragePartnerValidator.js

@@ -16,7 +16,7 @@ class FileStorageValidator {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartResponse().required(),
+      body: FileStorageModel.FileUpload().required(),
     }).required();
   }
 
@@ -24,7 +24,7 @@ class FileStorageValidator {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartRequest().required(),
+      body: FileStorageModel.FileUploadStart().required(),
     }).required();
   }
 
@@ -60,7 +60,7 @@ class FileStorageValidator {
     return Joi.object({
       applicationId: Joi.string().allow("").required(),
       companyId: Joi.number().required(),
-      body: FileStorageModel.FetchProxyRequest().required(),
+      body: FileStorageModel.ProxyFile().required(),
     }).required();
   }
 
@@ -72,7 +72,7 @@ class FileStorageValidator {
 
   static saveProxyDetails() {
     return Joi.object({
-      body: FileStorageModel.FetchProxyRequest().required(),
+      body: FileStorageModel.ProxyFile().required(),
     }).required();
   }
 }