@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,10 +1,92 @@
-export = LeadValidator;
-declare class LeadValidator {
-    static createHistory(): any;
-    static createTicket(): any;
-    static getCustomForm(): any;
-    static getParticipantsInsideVideoRoom(): any;
-    static getTicket(): any;
-    static getTokenForVideoRoom(): any;
-    static submitCustomForm(): any;
+export = LeadApplicationValidator;
+/**
+ * @typedef CreateHistoryParam
+ * @property {string} id - Ticket ID for which history is created
+ * @property {LeadApplicationModel.TicketHistoryPayload} body
+ */
+/**
+ * @typedef CreateTicketParam
+ * @property {LeadApplicationModel.AddTicketPayload} body
+ */
+/**
+ * @typedef GetCustomFormParam
+ * @property {string} slug - Slug of form whose response is getting submitted
+ */
+/**
+ * @typedef GetParticipantsInsideVideoRoomParam
+ * @property {string} uniqueName - Unique name of Video Room
+ */
+/**
+ * @typedef GetTicketParam
+ * @property {string} id - ID of ticket to be retrieved
+ */
+/**
+ * @typedef GetTokenForVideoRoomParam
+ * @property {string} uniqueName - Unique name of Video Room
+ */
+/**
+ * @typedef SubmitCustomFormParam
+ * @property {string} slug - Slug of form whose response is getting submitted
+ * @property {LeadApplicationModel.CustomFormSubmissionPayload} body
+ */
+declare class LeadApplicationValidator {
+    /** @returns {CreateHistoryParam} */
+    static createHistory(): CreateHistoryParam;
+    /** @returns {CreateTicketParam} */
+    static createTicket(): CreateTicketParam;
+    /** @returns {GetCustomFormParam} */
+    static getCustomForm(): GetCustomFormParam;
+    /** @returns {GetParticipantsInsideVideoRoomParam} */
+    static getParticipantsInsideVideoRoom(): GetParticipantsInsideVideoRoomParam;
+    /** @returns {GetTicketParam} */
+    static getTicket(): GetTicketParam;
+    /** @returns {GetTokenForVideoRoomParam} */
+    static getTokenForVideoRoom(): GetTokenForVideoRoomParam;
+    /** @returns {SubmitCustomFormParam} */
+    static submitCustomForm(): SubmitCustomFormParam;
 }
+declare namespace LeadApplicationValidator {
+    export { CreateHistoryParam, CreateTicketParam, GetCustomFormParam, GetParticipantsInsideVideoRoomParam, GetTicketParam, GetTokenForVideoRoomParam, SubmitCustomFormParam };
+}
+type CreateHistoryParam = {
+    /**
+     * - Ticket ID for which history is created
+     */
+    id: string;
+    body: LeadApplicationModel.TicketHistoryPayload;
+};
+type CreateTicketParam = {
+    body: LeadApplicationModel.AddTicketPayload;
+};
+type GetCustomFormParam = {
+    /**
+     * - Slug of form whose response is getting submitted
+     */
+    slug: string;
+};
+type GetParticipantsInsideVideoRoomParam = {
+    /**
+     * - Unique name of Video Room
+     */
+    uniqueName: string;
+};
+type GetTicketParam = {
+    /**
+     * - ID of ticket to be retrieved
+     */
+    id: string;
+};
+type GetTokenForVideoRoomParam = {
+    /**
+     * - Unique name of Video Room
+     */
+    uniqueName: string;
+};
+type SubmitCustomFormParam = {
+    /**
+     * - Slug of form whose response is getting submitted
+     */
+    slug: string;
+    body: LeadApplicationModel.CustomFormSubmissionPayload;
+};
+import LeadApplicationModel = require("./LeadApplicationModel");

package/sdk/application/Lead/LeadApplicationValidator.js

@@ -1,50 +1,95 @@
 const Joi = require("joi");
 
-const LeadModel = require("./LeadApplicationModel");
-class LeadValidator {
+const LeadApplicationModel = require("./LeadApplicationModel");
+
+/**
+ * @typedef CreateHistoryParam
+ * @property {string} id - Ticket ID for which history is created
+ * @property {LeadApplicationModel.TicketHistoryPayload} body
+ */
+
+/**
+ * @typedef CreateTicketParam
+ * @property {LeadApplicationModel.AddTicketPayload} body
+ */
+
+/**
+ * @typedef GetCustomFormParam
+ * @property {string} slug - Slug of form whose response is getting submitted
+ */
+
+/**
+ * @typedef GetParticipantsInsideVideoRoomParam
+ * @property {string} uniqueName - Unique name of Video Room
+ */
+
+/**
+ * @typedef GetTicketParam
+ * @property {string} id - ID of ticket to be retrieved
+ */
+
+/**
+ * @typedef GetTokenForVideoRoomParam
+ * @property {string} uniqueName - Unique name of Video Room
+ */
+
+/**
+ * @typedef SubmitCustomFormParam
+ * @property {string} slug - Slug of form whose response is getting submitted
+ * @property {LeadApplicationModel.CustomFormSubmissionPayload} body
+ */
+
+class LeadApplicationValidator {
+  /** @returns {CreateHistoryParam} */
   static createHistory() {
     return Joi.object({
       id: Joi.string().allow("").required(),
-      body: LeadModel.TicketHistoryPayload().required(),
+      body: LeadApplicationModel.TicketHistoryPayload().required(),
     }).required();
   }
 
+  /** @returns {CreateTicketParam} */
   static createTicket() {
     return Joi.object({
-      body: LeadModel.AddTicketPayload().required(),
+      body: LeadApplicationModel.AddTicketPayload().required(),
     }).required();
   }
 
+  /** @returns {GetCustomFormParam} */
   static getCustomForm() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetParticipantsInsideVideoRoomParam} */
   static getParticipantsInsideVideoRoom() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetTicketParam} */
   static getTicket() {
     return Joi.object({
       id: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {GetTokenForVideoRoomParam} */
   static getTokenForVideoRoom() {
     return Joi.object({
       uniqueName: Joi.string().allow("").required(),
     }).required();
   }
 
+  /** @returns {SubmitCustomFormParam} */
   static submitCustomForm() {
     return Joi.object({
       slug: Joi.string().allow("").required(),
-      body: LeadModel.CustomFormSubmissionPayload().required(),
+      body: LeadApplicationModel.CustomFormSubmissionPayload().required(),
     }).required();
   }
 }
 
-module.exports = LeadValidator;
+module.exports = LeadApplicationValidator;

package/sdk/application/Logistic/LogisticApplicationClient.d.ts

@@ -12,51 +12,58 @@ declare class Logistic {
     _urls: {};
     updateUrls(urls: any): void;
     /**
-     * @param {Object} arg - Arg object.
-     * @returns {Promise<CountryListResponse>} - Success response
+     * @param {LogisticApplicationValidator.GetAllCountriesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.CountryListResponse>} - Success response
+     * @name getAllCountries
      * @summary: Get Country List
-     * @description: Get all countries
+     * @description: Get all countries - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getAllCountries/).
      */
-    getAllCountries({}?: any): Promise<CountryListResponse>;
+    getAllCountries({ requestHeaders }?: any, { responseHeaders }?: object): Promise<LogisticApplicationModel.CountryListResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {ReAssignStoreRequest} arg.body
-     * @returns {Promise<ReAssignStoreResponse>} - Success response
+     * @param {LogisticApplicationValidator.GetOptimalLocationsParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.ReAssignStoreResponse>} -
+     *   Success response
+     * @name getOptimalLocations
      * @summary: GET zone from the Pincode.
-     * @description: This API returns zone from the Pincode View.
+     * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getOptimalLocations/).
      */
-    getOptimalLocations({ body }?: {
-        body: ReAssignStoreRequest;
-    }): Promise<ReAssignStoreResponse>;
+    getOptimalLocations({ body, requestHeaders }?: LogisticApplicationValidator.GetOptimalLocationsParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.ReAssignStoreResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {string} arg.pincode - A `pincode` contains a specific address of
-     *   a location.
-     * @returns {Promise<PincodeApiResponse>} - Success response
+     * @param {LogisticApplicationValidator.GetPincodeCityParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.PincodeApiResponse>} - Success response
+     * @name getPincodeCity
      * @summary: Get Pincode API
-     * @description: Get pincode data
+     * @description: Get pincode data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeCity/).
      */
-    getPincodeCity({ pincode }?: {
-        pincode: string;
-    }): Promise<PincodeApiResponse>;
+    getPincodeCity({ pincode, requestHeaders }?: LogisticApplicationValidator.GetPincodeCityParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.PincodeApiResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {GetZoneFromPincodeViewRequest} arg.body
-     * @returns {Promise<GetZoneFromPincodeViewResponse>} - Success response
+     * @param {LogisticApplicationValidator.GetPincodeZonesParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>}
+     *   - Success response
+     *
+     * @name getPincodeZones
      * @summary: GET zone from the Pincode.
-     * @description: This API returns zone from the Pincode View.
+     * @description: This API returns zone from the Pincode View. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getPincodeZones/).
      */
-    getPincodeZones({ body }?: {
-        body: GetZoneFromPincodeViewRequest;
-    }): Promise<GetZoneFromPincodeViewResponse>;
+    getPincodeZones({ body, requestHeaders }?: LogisticApplicationValidator.GetPincodeZonesParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.GetZoneFromPincodeViewResponse>;
     /**
-     * @param {Object} arg - Arg object.
-     * @param {TATViewRequest} arg.body
-     * @returns {Promise<TATViewResponse>} - Success response
+     * @param {LogisticApplicationValidator.GetTatProductParam} arg - Arg object.
+     * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
+     * @param {import("../ApplicationAPIClient").Options} - Options
+     * @returns {Promise<LogisticApplicationModel.TATViewResponse>} - Success response
+     * @name getTatProduct
      * @summary: Get TAT API
-     * @description: Get TAT data
+     * @description: Get TAT data - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/application/logistic/getTatProduct/).
      */
-    getTatProduct({ body }?: {
-        body: TATViewRequest;
-    }): Promise<TATViewResponse>;
+    getTatProduct({ body, requestHeaders }?: LogisticApplicationValidator.GetTatProductParam, { responseHeaders }?: object): Promise<LogisticApplicationModel.TATViewResponse>;
 }
+import LogisticApplicationModel = require("./LogisticApplicationModel");
+import LogisticApplicationValidator = require("./LogisticApplicationValidator");