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

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,29 @@ export = FileStoragePartnerModel;
  * @property {CreatedBy} [created_by]
  */
 /**
- * @typedef FailedResponse
+ * @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, 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, SignedUrl, SignUrlResult, SignUrl };
 }
 /** @returns {SizeConstraints} */
 declare function SizeConstraints(): SizeConstraints;
@@ -102,24 +124,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 +188,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 +201,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 +215,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 +233,45 @@ 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;
 };
+/** @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

@@ -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,10 +106,29 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef FailedResponse
+ * @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.
+ */
+
 class FileStoragePartnerModel {
   /** @returns {SizeConstraints} */
   static SizeConstraints() {
@@ -111,27 +137,36 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {FetchProxyResponse} */
-  static FetchProxyResponse() {
+  /** @returns {SaveProxy} */
+  static SaveProxy() {
     return Joi.object({
-      id: Joi.string().allow(""),
-      created_at: Joi.string().allow(""),
+      id: Joi.number(),
+      token: Joi.string().allow(""),
     });
   }
 
-  /** @returns {FetchProxyRequest} */
-  static FetchProxyRequest() {
+  /** @returns {ProxyFileData} */
+  static ProxyFileData() {
+    return Joi.object({
+      email: Joi.string().allow(""),
+      password: Joi.string().allow(""),
+    });
+  }
+
+  /** @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 +209,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 +224,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 +242,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,11 +262,35 @@ class FileStoragePartnerModel {
     });
   }
 
-  /** @returns {FailedResponse} */
-  static FailedResponse() {
+  /** @returns {FailedBrowseFilesResult} */
+  static FailedBrowseFilesResult() {
     return Joi.object({
       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;
 }

package/sdk/partner/FileStorage/FileStoragePartnerValidator.js

@@ -2,21 +2,11 @@ const Joi = require("joi");
 
 const FileStorageModel = require("./FileStoragePartnerModel");
 class FileStorageValidator {
-  static getAllNamespaceDetails() {
-    return Joi.object({}).required();
-  }
-
-  static getNamespaceDetail() {
-    return Joi.object({
-      namespace: Joi.string().allow("").required(),
-    }).required();
-  }
-
   static completeUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartResponse().required(),
+      body: FileStorageModel.FileUpload().required(),
     }).required();
   }
 
@@ -24,18 +14,7 @@ class FileStorageValidator {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
 
-      body: FileStorageModel.StartRequest().required(),
-    }).required();
-  }
-
-  static browse() {
-    return Joi.object({
-      namespace: Joi.string().allow("").required(),
-
-      applicationId: Joi.string().allow("").required(),
-      companyId: Joi.number().required(),
-      page: Joi.number(),
-      limit: Joi.number(),
+      body: FileStorageModel.FileUploadStart().required(),
     }).required();
   }
 
@@ -48,31 +27,21 @@ class FileStorageValidator {
     }).required();
   }
 
-  static organizationLevelFetchProxy() {
+  static fetchProxy() {
     return Joi.object({
-      applicationId: Joi.string().allow("").required(),
-      companyId: Joi.number().required(),
       url: Joi.string().allow("").required(),
     }).required();
   }
 
-  static saveOrganizationLevelProxy() {
-    return Joi.object({
-      applicationId: Joi.string().allow("").required(),
-      companyId: Joi.number().required(),
-      body: FileStorageModel.FetchProxyRequest().required(),
-    }).required();
-  }
-
-  static fetchProxy() {
+  static saveProxyDetails() {
     return Joi.object({
-      url: Joi.string().allow("").required(),
+      body: FileStorageModel.ProxyFile().required(),
     }).required();
   }
 
-  static saveProxyDetails() {
+  static signUrls() {
     return Joi.object({
-      body: FileStorageModel.FetchProxyRequest().required(),
+      body: FileStorageModel.SignUrl().required(),
     }).required();
   }
 }

package/sdk/partner/Lead/LeadPartnerClient.d.ts

@@ -20,7 +20,7 @@ declare class Lead {
      *   the ticket filters
      * @param {string} [arg.q] - Search through ticket titles and description
      * @param {string} [arg.status] - Filter tickets on status
-     * @param {string} [arg.priority] - Filter tickets on priority
+     * @param {LeadPartnerModel.PriorityEnum} [arg.priority] - Filter tickets on priority
      * @param {string} [arg.category] - Filter tickets on category
      * @param {number} [arg.pageSize] - Number of items to retrieve in each
      *   page. Default is 12.
@@ -33,7 +33,7 @@ declare class Lead {
         filters?: boolean;
         q?: string;
         status?: string;
-        priority?: string;
+        priority?: LeadPartnerModel.PriorityEnum;
         category?: string;
         pageSize?: number;
     }): Paginator<LeadPartnerModel.TicketList>;
@@ -91,12 +91,12 @@ declare class Lead {
      * @param {LeadPartnerValidator.GetGeneralConfigParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../PartnerAPIClient").Options} - Options
-     * @returns {Promise<LeadPartnerModel.GeneralConfigResponse>} - Success response
+     * @returns {Promise<LeadPartnerModel.GeneralConfigDetails>} - Success response
      * @name getGeneralConfig
-     * @summary: Get general support configuration.
+     * @summary: Get general support configuration
      * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getGeneralConfig/).
      */
-    getGeneralConfig({ requestHeaders }?: LeadPartnerValidator.GetGeneralConfigParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GeneralConfigResponse>;
+    getGeneralConfig({ requestHeaders }?: LeadPartnerValidator.GetGeneralConfigParam, { responseHeaders }?: object): Promise<LeadPartnerModel.GeneralConfigDetails>;
 }
 import LeadPartnerModel = require("./LeadPartnerModel");
 import Paginator = require("../../common/Paginator");

package/sdk/partner/Lead/LeadPartnerClient.js

@@ -129,7 +129,7 @@ class Lead {
    *   the ticket filters
    * @param {string} [arg.q] - Search through ticket titles and description
    * @param {string} [arg.status] - Filter tickets on status
-   * @param {string} [arg.priority] - Filter tickets on priority
+   * @param {LeadPartnerModel.PriorityEnum} [arg.priority] - Filter tickets on priority
    * @param {string} [arg.category] - Filter tickets on category
    * @param {number} [arg.pageSize] - Number of items to retrieve in each
    *   page. Default is 12.
@@ -556,9 +556,9 @@ class Lead {
    * @param {LeadPartnerValidator.GetGeneralConfigParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PartnerAPIClient").Options} - Options
-   * @returns {Promise<LeadPartnerModel.GeneralConfigResponse>} - Success response
+   * @returns {Promise<LeadPartnerModel.GeneralConfigDetails>} - Success response
    * @name getGeneralConfig
-   * @summary: Get general support configuration.
+   * @summary: Get general support configuration
    * @description: Get general support configuration. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/partner/lead/getGeneralConfig/).
    */
   async getGeneralConfig(
@@ -606,7 +606,7 @@ class Lead {
 
     const {
       error: res_error,
-    } = LeadPartnerModel.GeneralConfigResponse().validate(responseData, {
+    } = LeadPartnerModel.GeneralConfigDetails().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });