@gofynd/fdk-client-javascript 1.1.6 → 1.2.0

package/sdk/application/FileStorage/FileStorageApplicationModel.js

@@ -1,25 +1,190 @@
 const Joi = require("joi");
 
-class FileStorageModel {
+/**
+ * @typedef BrowseResponse
+ * @property {DbRecord[]} items
+ * @property {Page} page
+ */
+
+/**
+ * @typedef BulkRequest
+ * @property {ReqConfiguration} [configuration]
+ * @property {Destination} destination
+ * @property {string[]} urls
+ */
+
+/**
+ * @typedef BulkUploadResponse
+ * @property {CopyFileTask} task
+ * @property {string} tracking_url
+ */
+
+/**
+ * @typedef CDN
+ * @property {string} absolute_url
+ * @property {string} relative_url
+ * @property {string} url
+ */
+
+/**
+ * @typedef CompleteResponse
+ * @property {string} _id
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} created_on
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} modified_on
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {boolean} success
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+
+/**
+ * @typedef CopyFileTask
+ * @property {number} attempts_made
+ * @property {BulkRequest} data
+ * @property {number} delay
+ * @property {number} finished_on
+ * @property {string} id
+ * @property {string} name
+ * @property {Opts} opts
+ * @property {number} processed_on
+ * @property {number} progress
+ * @property {string[]} [stacktrace]
+ * @property {number} timestamp
+ */
+
+/**
+ * @typedef DbRecord
+ * @property {string} _id
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} created_on
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} modified_on
+ * @property {string} namespace
+ * @property {string} [operation]
+ * @property {boolean} success
+ * @property {string[]} tags
+ * @property {Upload} upload
+ */
+
+/**
+ * @typedef Destination
+ * @property {string} [basepath]
+ * @property {string} namespace
+ * @property {string} rewrite
+ */
+
+/**
+ * @typedef FailedResponse
+ * @property {string} message
+ */
+
+/**
+ * @typedef Opts
+ * @property {number} [attempts]
+ * @property {number} [delay]
+ * @property {number} [timestamp]
+ */
+
+/**
+ * @typedef Page
+ * @property {number} [current]
+ * @property {boolean} [has_next]
+ * @property {boolean} [has_previous]
+ * @property {number} [item_total]
+ * @property {string} [next_id]
+ * @property {number} [size]
+ * @property {string} type
+ */
+
+/**
+ * @typedef ReqConfiguration
+ * @property {number} [concurrency]
+ */
+
+/**
+ * @typedef SignUrlRequest
+ * @property {number} expiry
+ * @property {string[]} urls
+ */
+
+/**
+ * @typedef SignUrlResponse
+ * @property {Urls[]} urls
+ */
+
+/**
+ * @typedef StartRequest
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {Object} [params]
+ * @property {number} size
+ * @property {string[]} [tags]
+ */
+
+/**
+ * @typedef StartResponse
+ * @property {CDN} cdn
+ * @property {string} content_type
+ * @property {string} file_name
+ * @property {string} file_path
+ * @property {string} [method]
+ * @property {string} namespace
+ * @property {string} operation
+ * @property {number} size
+ * @property {string[]} [tags]
+ * @property {Upload} upload
+ */
+
+/**
+ * @typedef Upload
+ * @property {number} expiry
+ * @property {string} url
+ */
+
+/**
+ * @typedef Urls
+ * @property {number} expiry
+ * @property {string} signed_url
+ * @property {string} url
+ */
+
+class FileStorageApplicationModel {
+  /** @returns {BrowseResponse} */
   static BrowseResponse() {
     return Joi.object({
-      items: Joi.array().items(FileStorageModel.DbRecord()).required(),
-      page: FileStorageModel.Page().required(),
+      items: Joi.array()
+        .items(FileStorageApplicationModel.DbRecord())
+        .required(),
+      page: FileStorageApplicationModel.Page().required(),
     });
   }
+
+  /** @returns {BulkRequest} */
   static BulkRequest() {
     return Joi.object({
-      configuration: FileStorageModel.ReqConfiguration(),
-      destination: FileStorageModel.Destination().required(),
+      configuration: FileStorageApplicationModel.ReqConfiguration(),
+      destination: FileStorageApplicationModel.Destination().required(),
       urls: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
+
+  /** @returns {BulkUploadResponse} */
   static BulkUploadResponse() {
     return Joi.object({
-      task: FileStorageModel.CopyFileTask().required(),
+      task: FileStorageApplicationModel.CopyFileTask().required(),
       tracking_url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CDN} */
   static CDN() {
     return Joi.object({
       absolute_url: Joi.string().allow("").required(),
@@ -27,10 +192,12 @@ class FileStorageModel {
       url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {CompleteResponse} */
   static CompleteResponse() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
-      cdn: FileStorageModel.CDN().required(),
+      cdn: FileStorageApplicationModel.CDN().required(),
       content_type: Joi.string().allow("").required(),
       created_on: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -41,28 +208,32 @@ class FileStorageModel {
       size: Joi.number().required(),
       success: Joi.boolean().required(),
       tags: Joi.array().items(Joi.string().allow("")),
-      upload: FileStorageModel.Upload().required(),
+      upload: FileStorageApplicationModel.Upload().required(),
     });
   }
+
+  /** @returns {CopyFileTask} */
   static CopyFileTask() {
     return Joi.object({
       attempts_made: Joi.number().required(),
-      data: FileStorageModel.BulkRequest().required(),
+      data: FileStorageApplicationModel.BulkRequest().required(),
       delay: Joi.number().required(),
       finished_on: Joi.number().required(),
       id: Joi.string().allow("").required(),
       name: Joi.string().allow("").required(),
-      opts: FileStorageModel.Opts().required(),
+      opts: FileStorageApplicationModel.Opts().required(),
       processed_on: Joi.number().required(),
       progress: Joi.number().required(),
       stacktrace: Joi.array().items(Joi.string().allow("")),
       timestamp: Joi.number().required(),
     });
   }
+
+  /** @returns {DbRecord} */
   static DbRecord() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
-      cdn: FileStorageModel.CDN().required(),
+      cdn: FileStorageApplicationModel.CDN().required(),
       content_type: Joi.string().allow("").required(),
       created_on: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
@@ -72,9 +243,11 @@ class FileStorageModel {
       operation: Joi.string().allow(""),
       success: Joi.boolean().required(),
       tags: Joi.array().items(Joi.string().allow("")).required(),
-      upload: FileStorageModel.Upload().required(),
+      upload: FileStorageApplicationModel.Upload().required(),
     });
   }
+
+  /** @returns {Destination} */
   static Destination() {
     return Joi.object({
       basepath: Joi.string().allow(""),
@@ -82,11 +255,15 @@ class FileStorageModel {
       rewrite: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {FailedResponse} */
   static FailedResponse() {
     return Joi.object({
       message: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {Opts} */
   static Opts() {
     return Joi.object({
       attempts: Joi.number(),
@@ -94,6 +271,8 @@ class FileStorageModel {
       timestamp: Joi.number(),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -105,22 +284,30 @@ class FileStorageModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ReqConfiguration} */
   static ReqConfiguration() {
     return Joi.object({
       concurrency: Joi.number(),
     });
   }
+
+  /** @returns {SignUrlRequest} */
   static SignUrlRequest() {
     return Joi.object({
       expiry: Joi.number().required(),
       urls: Joi.array().items(Joi.string().allow("")).required(),
     });
   }
+
+  /** @returns {SignUrlResponse} */
   static SignUrlResponse() {
     return Joi.object({
-      urls: Joi.array().items(FileStorageModel.Urls()).required(),
+      urls: Joi.array().items(FileStorageApplicationModel.Urls()).required(),
     });
   }
+
+  /** @returns {StartRequest} */
   static StartRequest() {
     return Joi.object({
       content_type: Joi.string().allow("").required(),
@@ -130,9 +317,11 @@ class FileStorageModel {
       tags: Joi.array().items(Joi.string().allow("")),
     });
   }
+
+  /** @returns {StartResponse} */
   static StartResponse() {
     return Joi.object({
-      cdn: FileStorageModel.CDN().required(),
+      cdn: FileStorageApplicationModel.CDN().required(),
       content_type: Joi.string().allow("").required(),
       file_name: Joi.string().allow("").required(),
       file_path: Joi.string().allow("").required(),
@@ -141,15 +330,19 @@ class FileStorageModel {
       operation: Joi.string().allow("").required(),
       size: Joi.number().required(),
       tags: Joi.array().items(Joi.string().allow("")),
-      upload: FileStorageModel.Upload().required(),
+      upload: FileStorageApplicationModel.Upload().required(),
     });
   }
+
+  /** @returns {Upload} */
   static Upload() {
     return Joi.object({
       expiry: Joi.number().required(),
       url: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {Urls} */
   static Urls() {
     return Joi.object({
       expiry: Joi.number().required(),
@@ -158,4 +351,4 @@ class FileStorageModel {
     });
   }
 }
-module.exports = FileStorageModel;
+module.exports = FileStorageApplicationModel;

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

@@ -1,6 +1,56 @@
-export = FileStorageValidator;
-declare class FileStorageValidator {
-    static completeUpload(): any;
-    static signUrls(): any;
-    static startUpload(): any;
+export = FileStorageApplicationValidator;
+/**
+ * @typedef CompleteUploadParam
+ * @property {string} namespace - Segregation of different types of
+ *   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.StartResponse} body
+ */
+/**
+ * @typedef SignUrlsParam
+ * @property {FileStorageApplicationModel.SignUrlRequest} body
+ */
+/**
+ * @typedef StartUploadParam
+ * @property {string} namespace - Segregation of different types of
+ *   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.StartRequest} body
+ */
+declare class FileStorageApplicationValidator {
+    /** @returns {CompleteUploadParam} */
+    static completeUpload(): CompleteUploadParam;
+    /** @returns {SignUrlsParam} */
+    static signUrls(): SignUrlsParam;
+    /** @returns {StartUploadParam} */
+    static startUpload(): StartUploadParam;
 }
+declare namespace FileStorageApplicationValidator {
+    export { CompleteUploadParam, SignUrlsParam, StartUploadParam };
+}
+type CompleteUploadParam = {
+    /**
+     * - Segregation of different types of
+     * 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.
+     */
+    namespace: string;
+    body: FileStorageApplicationModel.StartResponse;
+};
+type SignUrlsParam = {
+    body: FileStorageApplicationModel.SignUrlRequest;
+};
+type StartUploadParam = {
+    /**
+     * - Segregation of different types of
+     * 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.
+     */
+    namespace: string;
+    body: FileStorageApplicationModel.StartRequest;
+};
+import FileStorageApplicationModel = require("./FileStorageApplicationModel");

package/sdk/application/FileStorage/FileStorageApplicationValidator.js

@@ -1,26 +1,53 @@
 const Joi = require("joi");
 
-const FileStorageModel = require("./FileStorageApplicationModel");
-class FileStorageValidator {
+const FileStorageApplicationModel = require("./FileStorageApplicationModel");
+
+/**
+ * @typedef CompleteUploadParam
+ * @property {string} namespace - Segregation of different types of
+ *   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.StartResponse} body
+ */
+
+/**
+ * @typedef SignUrlsParam
+ * @property {FileStorageApplicationModel.SignUrlRequest} body
+ */
+
+/**
+ * @typedef StartUploadParam
+ * @property {string} namespace - Segregation of different types of
+ *   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.StartRequest} body
+ */
+
+class FileStorageApplicationValidator {
+  /** @returns {CompleteUploadParam} */
   static completeUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStorageModel.StartResponse().required(),
+      body: FileStorageApplicationModel.StartResponse().required(),
     }).required();
   }
 
+  /** @returns {SignUrlsParam} */
   static signUrls() {
     return Joi.object({
-      body: FileStorageModel.SignUrlRequest().required(),
+      body: FileStorageApplicationModel.SignUrlRequest().required(),
     }).required();
   }
 
+  /** @returns {StartUploadParam} */
   static startUpload() {
     return Joi.object({
       namespace: Joi.string().allow("").required(),
-      body: FileStorageModel.StartRequest().required(),
+      body: FileStorageApplicationModel.StartRequest().required(),
     }).required();
   }
 }
 
-module.exports = FileStorageValidator;
+module.exports = FileStorageApplicationValidator;

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

@@ -14,77 +14,74 @@ declare class Lead {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - Ticket ID for which history is created
-     * @param {TicketHistoryPayload} arg.body
-     * @returns {Promise<TicketHistory>} - Success response
+     * @param {LeadApplicationValidator.CreateHistoryParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LeadApplicationModel.TicketHistory>} - Success response
+     * @name createHistory
      * @summary: Create history for specific Ticket
-     * @description: Create history for specific Ticket, this history is seen on ticket detail page, this can be comment, log or rating.
+     * @description: Create history for specific Ticket, this history is seen on ticket detail page, this can be comment, log or rating. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createHistory/).
      */
-    createHistory({ id, body }?: {
-        id: string;
-        body: TicketHistoryPayload;
-    }): Promise<TicketHistory>;
+    createHistory({ id, body }?: LeadApplicationValidator.CreateHistoryParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<LeadApplicationModel.TicketHistory>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {AddTicketPayload} arg.body
-     * @returns {Promise<Ticket>} - Success response
+     * @param {LeadApplicationValidator.CreateTicketParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
+     * @name createTicket
      * @summary: Create Ticket
-     * @description: This is used to Create Ticket.
+     * @description: This is used to Create Ticket. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/createTicket/).
      */
-    createTicket({ body }?: {
-        body: AddTicketPayload;
-    }): Promise<Ticket>;
+    createTicket({ body }?: LeadApplicationValidator.CreateTicketParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<LeadApplicationModel.Ticket>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.slug - Slug of form whose response is getting submitted
-     * @returns {Promise<CustomForm>} - Success response
+     * @param {LeadApplicationValidator.GetCustomFormParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LeadApplicationModel.CustomForm>} - Success response
+     * @name getCustomForm
      * @summary: Get specific Custom Form using it's slug
-     * @description: Get specific Custom Form using it's slug, this is used to view the form.
+     * @description: Get specific Custom Form using it's slug, this is used to view the form. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getCustomForm/).
      */
-    getCustomForm({ slug }?: {
-        slug: string;
-    }): Promise<CustomForm>;
+    getCustomForm({ slug }?: LeadApplicationValidator.GetCustomFormParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<LeadApplicationModel.CustomForm>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.uniqueName - Unique name of Video Room
-     * @returns {Promise<GetParticipantsInsideVideoRoomResponse>} - Success response
+     * @param {LeadApplicationValidator.GetParticipantsInsideVideoRoomParam} arg
+     *   - Arg object.
+     *
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>}
+     *   - Success response
+     *
+     * @name getParticipantsInsideVideoRoom
      * @summary: Get participants of a specific Video Room using it's unique name
-     * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names.
+     * @description: Get participants of a specific Video Room using it's unique name, this can be used to check if people are already there in the room and also to show their names. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getParticipantsInsideVideoRoom/).
      */
-    getParticipantsInsideVideoRoom({ uniqueName }?: {
-        uniqueName: string;
-    }): Promise<GetParticipantsInsideVideoRoomResponse>;
+    getParticipantsInsideVideoRoom({ uniqueName }?: LeadApplicationValidator.GetParticipantsInsideVideoRoomParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<LeadApplicationModel.GetParticipantsInsideVideoRoomResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.id - ID of ticket to be retrieved
-     * @returns {Promise<Ticket>} - Success response
+     * @param {LeadApplicationValidator.GetTicketParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LeadApplicationModel.Ticket>} - Success response
+     * @name getTicket
      * @summary: Get Ticket with the specific id
-     * @description: Get Ticket with the specific id, this is used to view the ticket details
+     * @description: Get Ticket with the specific id, this is used to view the ticket details - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTicket/).
      */
-    getTicket({ id }?: {
-        id: string;
-    }): Promise<Ticket>;
+    getTicket({ id }?: LeadApplicationValidator.GetTicketParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<LeadApplicationModel.Ticket>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.uniqueName - Unique name of Video Room
-     * @returns {Promise<GetTokenForVideoRoomResponse>} - Success response
+     * @param {LeadApplicationValidator.GetTokenForVideoRoomParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>} -
+     *   Success response
+     * @name getTokenForVideoRoom
      * @summary: Get Token to join a specific Video Room using it's unqiue name
-     * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there.
+     * @description: Get Token to join a specific Video Room using it's unqiue name, this Token is your ticket to Room and also creates your identity there. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/getTokenForVideoRoom/).
      */
-    getTokenForVideoRoom({ uniqueName }?: {
-        uniqueName: string;
-    }): Promise<GetTokenForVideoRoomResponse>;
+    getTokenForVideoRoom({ uniqueName }?: LeadApplicationValidator.GetTokenForVideoRoomParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<LeadApplicationModel.GetTokenForVideoRoomResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.slug - Slug of form whose response is getting submitted
-     * @param {CustomFormSubmissionPayload} arg.body
-     * @returns {Promise<SubmitCustomFormResponse>} - Success response
+     * @param {LeadApplicationValidator.SubmitCustomFormParam} arg - Arg object.
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LeadApplicationModel.SubmitCustomFormResponse>} -
+     *   Success response
+     * @name submitCustomForm
      * @summary: Submit Response for a specific Custom Form using it's slug
-     * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user.
+     * @description: Submit Response for a specific Custom Form using it's slug, this response is then used to create a ticket on behalf of the user. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/lead/submitCustomForm/).
      */
-    submitCustomForm({ slug, body }?: {
-        slug: string;
-        body: CustomFormSubmissionPayload;
-    }): Promise<SubmitCustomFormResponse>;
+    submitCustomForm({ slug, body }?: LeadApplicationValidator.SubmitCustomFormParam, { headers }?: import("../ApplicationAPIClient").Options): Promise<LeadApplicationModel.SubmitCustomFormResponse>;
 }
+import LeadApplicationValidator = require("./LeadApplicationValidator");
+import LeadApplicationModel = require("./LeadApplicationModel");