@gofynd/fdk-client-javascript 1.4.14 → 1.4.15-beta.1

package/sdk/application/FileStorage/FileStorageApplicationModel.d.ts

@@ -11,7 +11,7 @@ export = FileStorageApplicationModel;
  * @property {string} url - The signed URL for uploading the file.
  */
 /**
- * @typedef FileUpload
+ * @typedef StartResponse
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
  * @property {string} content_type - The content type of the file.
@@ -20,6 +20,7 @@ export = FileStorageApplicationModel;
  * @property {string} operation - The operation to be performed on the storage service.
  * @property {number} size - The size of the file in bytes.
  * @property {Upload} upload
+ * @property {CDN} cdn
  * @property {string[]} [tags] - Tags associated with the file.
  */
 /**
@@ -28,7 +29,7 @@ export = FileStorageApplicationModel;
  *   within the storage structure where the file should be placed or is located.
  */
 /**
- * @typedef FileUploadStart
+ * @typedef StartRequest
  * @property {string} file_name - The name of the file to be uploaded.
  * @property {string} content_type - The name of the file to be uploaded.
  * @property {number} size - The size of the file in bytes.
@@ -40,7 +41,7 @@ export = FileStorageApplicationModel;
  * @property {string} [username] - The username of the user who created the file.
  */
 /**
- * @typedef FileUploadComplete
+ * @typedef CompleteResponse
  * @property {string} _id - The unique identifier of the uploaded file.
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
@@ -64,18 +65,18 @@ export = FileStorageApplicationModel;
  * @property {number} expiry - The expiration time for the signed URL.
  */
 /**
- * @typedef SignUrlResult
+ * @typedef SignUrlResponse
  * @property {Urls[]} urls - Signed URL object.
  */
 /**
- * @typedef SignUrl
+ * @typedef SignUrlRequest
  * @property {number} expiry - The expiration time for the signed URL.
- * @property {string[]} urls - List of asset URLs to be signed.
+ * @property {string[]} urls - List of asset URLs to be signed. .
  */
 declare class FileStorageApplicationModel {
 }
 declare namespace FileStorageApplicationModel {
-    export { CDN, Upload, FileUpload, Params, FileUploadStart, CreatedBy, FileUploadComplete, Urls, SignUrlResult, SignUrl };
+    export { CDN, Upload, StartResponse, Params, StartRequest, CreatedBy, CompleteResponse, Urls, SignUrlResponse, SignUrlRequest };
 }
 /** @returns {CDN} */
 declare function CDN(): CDN;
@@ -105,9 +106,9 @@ type Upload = {
      */
     url: string;
 };
-/** @returns {FileUpload} */
-declare function FileUpload(): FileUpload;
-type FileUpload = {
+/** @returns {StartResponse} */
+declare function StartResponse(): StartResponse;
+type StartResponse = {
     /**
      * - The name of the file that was uploaded.
      */
@@ -137,6 +138,7 @@ type FileUpload = {
      */
     size: number;
     upload: Upload;
+    cdn: CDN;
     /**
      * - Tags associated with the file.
      */
@@ -151,9 +153,9 @@ type Params = {
      */
     subpath?: string;
 };
-/** @returns {FileUploadStart} */
-declare function FileUploadStart(): FileUploadStart;
-type FileUploadStart = {
+/** @returns {StartRequest} */
+declare function StartRequest(): StartRequest;
+type StartRequest = {
     /**
      * - The name of the file to be uploaded.
      */
@@ -180,9 +182,9 @@ type CreatedBy = {
      */
     username?: string;
 };
-/** @returns {FileUploadComplete} */
-declare function FileUploadComplete(): FileUploadComplete;
-type FileUploadComplete = {
+/** @returns {CompleteResponse} */
+declare function CompleteResponse(): CompleteResponse;
+type CompleteResponse = {
     /**
      * - The unique identifier of the uploaded file.
      */
@@ -248,23 +250,23 @@ type Urls = {
      */
     expiry: number;
 };
-/** @returns {SignUrlResult} */
-declare function SignUrlResult(): SignUrlResult;
-type SignUrlResult = {
+/** @returns {SignUrlResponse} */
+declare function SignUrlResponse(): SignUrlResponse;
+type SignUrlResponse = {
     /**
      * - Signed URL object.
      */
     urls: Urls[];
 };
-/** @returns {SignUrl} */
-declare function SignUrl(): SignUrl;
-type SignUrl = {
+/** @returns {SignUrlRequest} */
+declare function SignUrlRequest(): SignUrlRequest;
+type SignUrlRequest = {
     /**
      * - The expiration time for the signed URL.
      */
     expiry: number;
     /**
-     * - List of asset URLs to be signed.
+     * - List of asset URLs to be signed. .
      */
     urls: string[];
 };

package/sdk/application/FileStorage/FileStorageApplicationModel.js

@@ -14,7 +14,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef FileUpload
+ * @typedef StartResponse
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
  * @property {string} content_type - The content type of the file.
@@ -23,6 +23,7 @@ const Joi = require("joi");
  * @property {string} operation - The operation to be performed on the storage service.
  * @property {number} size - The size of the file in bytes.
  * @property {Upload} upload
+ * @property {CDN} cdn
  * @property {string[]} [tags] - Tags associated with the file.
  */
 
@@ -33,7 +34,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef FileUploadStart
+ * @typedef StartRequest
  * @property {string} file_name - The name of the file to be uploaded.
  * @property {string} content_type - The name of the file to be uploaded.
  * @property {number} size - The size of the file in bytes.
@@ -47,7 +48,7 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef FileUploadComplete
+ * @typedef CompleteResponse
  * @property {string} _id - The unique identifier of the uploaded file.
  * @property {string} file_name - The name of the file that was uploaded.
  * @property {string} file_path - The path to the file in the storage location.
@@ -73,14 +74,14 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef SignUrlResult
+ * @typedef SignUrlResponse
  * @property {Urls[]} urls - Signed URL object.
  */
 
 /**
- * @typedef SignUrl
+ * @typedef SignUrlRequest
  * @property {number} expiry - The expiration time for the signed URL.
- * @property {string[]} urls - List of asset URLs to be signed.
+ * @property {string[]} urls - List of asset URLs to be signed. .
  */
 
 class FileStorageApplicationModel {
@@ -101,8 +102,8 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {FileUpload} */
-  static FileUpload() {
+  /** @returns {StartResponse} */
+  static StartResponse() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
@@ -112,6 +113,7 @@ class FileStorageApplicationModel {
       operation: Joi.string().allow("").required(),
       size: Joi.number().required(),
       upload: FileStorageApplicationModel.Upload().required(),
+      cdn: FileStorageApplicationModel.CDN().required(),
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
@@ -123,8 +125,8 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {FileUploadStart} */
-  static FileUploadStart() {
+  /** @returns {StartRequest} */
+  static StartRequest() {
     return Joi.object({
       file_name: Joi.string().allow("").required(),
       content_type: Joi.string().allow("").required(),
@@ -141,8 +143,8 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {FileUploadComplete} */
-  static FileUploadComplete() {
+  /** @returns {CompleteResponse} */
+  static CompleteResponse() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -170,15 +172,15 @@ class FileStorageApplicationModel {
     });
   }
 
-  /** @returns {SignUrlResult} */
-  static SignUrlResult() {
+  /** @returns {SignUrlResponse} */
+  static SignUrlResponse() {
     return Joi.object({
       urls: Joi.array().items(FileStorageApplicationModel.Urls()).required(),
     });
   }
 
-  /** @returns {SignUrl} */
-  static SignUrl() {
+  /** @returns {SignUrlRequest} */
+  static SignUrlRequest() {
     return Joi.object({
       expiry: Joi.number().required(),
       urls: Joi.array().items(Joi.string().allow("")).required(),

package/sdk/application/FileStorage/FileStorageApplicationValidator.d.ts

@@ -5,11 +5,11 @@ export = FileStorageApplicationValidator;
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStorageApplicationModel.FileUpload} body
+ * @property {FileStorageApplicationModel.StartResponse} body
  */
 /**
  * @typedef SignUrlsParam
- * @property {FileStorageApplicationModel.SignUrl} body
+ * @property {FileStorageApplicationModel.SignUrlRequest} body
  */
 /**
  * @typedef StartUploadParam
@@ -17,7 +17,7 @@ export = FileStorageApplicationValidator;
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStorageApplicationModel.FileUploadStart} body
+ * @property {FileStorageApplicationModel.StartRequest} body
  */
 declare class FileStorageApplicationValidator {
     /** @returns {CompleteUploadParam} */
@@ -38,10 +38,10 @@ type CompleteUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStorageApplicationModel.FileUpload;
+    body: FileStorageApplicationModel.StartResponse;
 };
 type SignUrlsParam = {
-    body: FileStorageApplicationModel.SignUrl;
+    body: FileStorageApplicationModel.SignUrlRequest;
 };
 type StartUploadParam = {
     /**
@@ -51,6 +51,6 @@ type StartUploadParam = {
      * inside the storage bucket.
      */
     namespace: string;
-    body: FileStorageApplicationModel.FileUploadStart;
+    body: FileStorageApplicationModel.StartRequest;
 };
 import FileStorageApplicationModel = require("./FileStorageApplicationModel");

package/sdk/application/FileStorage/FileStorageApplicationValidator.js

@@ -8,12 +8,12 @@ const FileStorageApplicationModel = require("./FileStorageApplicationModel");
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStorageApplicationModel.FileUpload} body
+ * @property {FileStorageApplicationModel.StartResponse} body
  */
 
 /**
  * @typedef SignUrlsParam
- * @property {FileStorageApplicationModel.SignUrl} body
+ * @property {FileStorageApplicationModel.SignUrlRequest} body
  */
 
 /**
@@ -22,7 +22,7 @@ const FileStorageApplicationModel = require("./FileStorageApplicationModel");
  *   files(products, orders, logistics etc), Required for validating the data of
  *   the file being uploaded, decides where exactly the file will be stored
  *   inside the storage bucket.
- * @property {FileStorageApplicationModel.FileUploadStart} body
+ * @property {FileStorageApplicationModel.StartRequest} body
  */
 
 class FileStorageApplicationValidator {
@@ -30,14 +30,14 @@ class FileStorageApplicationValidator {
   static completeUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStorageApplicationModel.FileUpload().required(),
+      body: FileStorageApplicationModel.StartResponse().required(),
     }).required();
   }
 
   /** @returns {SignUrlsParam} */
   static signUrls() {
     return Joi.object({
-      body: FileStorageApplicationModel.SignUrl().required(),
+      body: FileStorageApplicationModel.SignUrlRequest().required(),
     }).required();
   }
 
@@ -45,7 +45,7 @@ class FileStorageApplicationValidator {
   static startUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStorageApplicationModel.FileUploadStart().required(),
+      body: FileStorageApplicationModel.StartRequest().required(),
     }).required();
   }
 }

package/sdk/application/Lead/LeadApplicationClient.d.ts

@@ -55,12 +55,13 @@ declare class Lead {
      * @param {LeadApplicationValidator.SubmitCustomFormParam} arg - Arg object.
      * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
      * @param {import("../ApplicationAPIClient").Options} - Options
-     * @returns {Promise<LeadApplicationModel.SubmitCustomFormDetails>} - Success response
+     * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
+     *   Success response
      * @name submitCustomForm
      * @summary: Submits form data
      * @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
      */
-    submitCustomForm({ slug, body, requestHeaders }?: LeadApplicationValidator.SubmitCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.SubmitCustomFormDetails>;
+    submitCustomForm({ slug, body, requestHeaders }?: LeadApplicationValidator.SubmitCustomFormParam, { responseHeaders }?: object): Promise<LeadApplicationModel.SubmitCustomFormResponse>;
 }
 import LeadApplicationValidator = require("./LeadApplicationValidator");
 import LeadApplicationModel = require("./LeadApplicationModel");

package/sdk/application/Lead/LeadApplicationClient.js

@@ -350,7 +350,8 @@ class Lead {
    * @param {LeadApplicationValidator.SubmitCustomFormParam} arg - Arg object.
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../ApplicationAPIClient").Options} - Options
-   * @returns {Promise<LeadApplicationModel.SubmitCustomFormDetails>} - Success response
+   * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
+   *   Success response
    * @name submitCustomForm
    * @summary: Submits form data
    * @description: Create user-entered data from a custom form for processing. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
@@ -405,7 +406,7 @@ class Lead {
 
     const {
       error: res_error,
-    } = LeadApplicationModel.SubmitCustomFormDetails().validate(responseData, {
+    } = LeadApplicationModel.SubmitCustomFormResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

package/sdk/application/Lead/LeadApplicationModel.d.ts

@@ -10,13 +10,13 @@ export = LeadApplicationModel;
  * @property {TicketAsset[]} [attachments] - List of all attachments related to the form.
  */
 /**
- * @typedef SubmitCustomFormDetails
+ * @typedef SubmitCustomFormResponse
  * @property {string} message - Success message for form submission.
  * @property {Ticket} [ticket]
- * @property {FormFieldDetails} [response]
+ * @property {FormFieldResponse} [response]
  */
 /**
- * @typedef FormFieldDetails
+ * @typedef FormFieldResponse
  * @property {string} [_id] - Unique identifier for a custom form response.
  * @property {number} [__v] - Version of the form.
  * @property {string} [application_id] - Unique identifier for a Sales channel.
@@ -174,7 +174,7 @@ export = LeadApplicationModel;
 declare class LeadApplicationModel {
 }
 declare namespace LeadApplicationModel {
-    export { TicketHistoryPayload, CustomFormSubmissionPayload, SubmitCustomFormDetails, FormFieldDetails, FormFieldResponseValues, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
+    export { TicketHistoryPayload, CustomFormSubmissionPayload, SubmitCustomFormResponse, FormFieldResponse, FormFieldResponseValues, TicketContext, CreatedOn, TicketAsset, TicketContent, AddTicketPayload, Priority, Status, SubmitButton, PollForAssignment, CustomForm, FeedbackForm, TicketCategory, TicketHistory, Ticket, PriorityEnum, HistoryTypeEnum, TicketAssetTypeEnum, TicketSourceEnum };
 }
 /** @returns {TicketHistoryPayload} */
 declare function TicketHistoryPayload(): TicketHistoryPayload;
@@ -197,19 +197,19 @@ type CustomFormSubmissionPayload = {
      */
     attachments?: TicketAsset[];
 };
-/** @returns {SubmitCustomFormDetails} */
-declare function SubmitCustomFormDetails(): SubmitCustomFormDetails;
-type SubmitCustomFormDetails = {
+/** @returns {SubmitCustomFormResponse} */
+declare function SubmitCustomFormResponse(): SubmitCustomFormResponse;
+type SubmitCustomFormResponse = {
     /**
      * - Success message for form submission.
      */
     message: string;
     ticket?: Ticket;
-    response?: FormFieldDetails;
+    response?: FormFieldResponse;
 };
-/** @returns {FormFieldDetails} */
-declare function FormFieldDetails(): FormFieldDetails;
-type FormFieldDetails = {
+/** @returns {FormFieldResponse} */
+declare function FormFieldResponse(): FormFieldResponse;
+type FormFieldResponse = {
     /**
      * - Unique identifier for a custom form response.
      */

package/sdk/application/Lead/LeadApplicationModel.js

@@ -13,14 +13,14 @@ const Joi = require("joi");
  */
 
 /**
- * @typedef SubmitCustomFormDetails
+ * @typedef SubmitCustomFormResponse
  * @property {string} message - Success message for form submission.
  * @property {Ticket} [ticket]
- * @property {FormFieldDetails} [response]
+ * @property {FormFieldResponse} [response]
  */
 
 /**
- * @typedef FormFieldDetails
+ * @typedef FormFieldResponse
  * @property {string} [_id] - Unique identifier for a custom form response.
  * @property {number} [__v] - Version of the form.
  * @property {string} [application_id] - Unique identifier for a Sales channel.
@@ -199,7 +199,7 @@ class LeadApplicationModel {
   /** @returns {TicketHistoryPayload} */
   static TicketHistoryPayload() {
     return Joi.object({
-      value: Joi.object().pattern(/\S/, Joi.any()).required(),
+      value: Joi.any().required(),
       type: LeadApplicationModel.HistoryTypeEnum().required(),
     });
   }
@@ -212,17 +212,17 @@ class LeadApplicationModel {
     });
   }
 
-  /** @returns {SubmitCustomFormDetails} */
-  static SubmitCustomFormDetails() {
+  /** @returns {SubmitCustomFormResponse} */
+  static SubmitCustomFormResponse() {
     return Joi.object({
       message: Joi.string().allow("").required(),
       ticket: LeadApplicationModel.Ticket(),
-      response: LeadApplicationModel.FormFieldDetails(),
+      response: LeadApplicationModel.FormFieldResponse(),
     });
   }
 
-  /** @returns {FormFieldDetails} */
-  static FormFieldDetails() {
+  /** @returns {FormFieldResponse} */
+  static FormFieldResponse() {
     return Joi.object({
       _id: Joi.string().allow(""),
       __v: Joi.number(),
@@ -278,12 +278,12 @@ class LeadApplicationModel {
   /** @returns {AddTicketPayload} */
   static AddTicketPayload() {
     return Joi.object({
-      created_by: Joi.object().pattern(/\S/, Joi.any()),
+      created_by: Joi.any(),
       status: Joi.string().allow(""),
       priority: LeadApplicationModel.PriorityEnum(),
       category: Joi.string().allow("").required(),
       content: LeadApplicationModel.TicketContent().required(),
-      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
+      _custom_json: Joi.any(),
       subscribers: Joi.array().items(Joi.string().allow("")),
     });
   }
@@ -348,9 +348,9 @@ class LeadApplicationModel {
   /** @returns {FeedbackForm} */
   static FeedbackForm() {
     return Joi.object({
-      inputs: Joi.object().pattern(/\S/, Joi.any()),
+      inputs: Joi.any(),
       title: Joi.string().allow(""),
-      timestamps: Joi.object().pattern(/\S/, Joi.any()),
+      timestamps: Joi.any(),
     });
   }
 
@@ -369,10 +369,10 @@ class LeadApplicationModel {
   static TicketHistory() {
     return Joi.object({
       type: Joi.string().allow("").required(),
-      value: Joi.object().pattern(/\S/, Joi.any()).required(),
+      value: Joi.any().required(),
       ticket_id: Joi.string().allow("").required(),
       created_on: LeadApplicationModel.CreatedOn(),
-      created_by: Joi.object().pattern(/\S/, Joi.any()),
+      created_by: Joi.any(),
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),
@@ -391,12 +391,12 @@ class LeadApplicationModel {
       source: LeadApplicationModel.TicketSourceEnum().required(),
       status: LeadApplicationModel.Status().required(),
       priority: LeadApplicationModel.Priority().required(),
-      created_by: Joi.object().pattern(/\S/, Joi.any()),
-      assigned_to: Joi.object().pattern(/\S/, Joi.any()),
+      created_by: Joi.any(),
+      assigned_to: Joi.any(),
       tags: Joi.array().items(Joi.string().allow("")),
-      _custom_json: Joi.object().pattern(/\S/, Joi.any()),
+      _custom_json: Joi.any(),
       is_feedback_pending: Joi.boolean(),
-      integration: Joi.object().pattern(/\S/, Joi.any()),
+      integration: Joi.any(),
       _id: Joi.string().allow("").required(),
       updated_at: Joi.string().allow(""),
       created_at: Joi.string().allow(""),