@gofynd/fdk-client-javascript 1.2.0 → 1.3.0

package/sdk/platform/Discount/DiscountPlatformClient.js

@@ -13,13 +13,17 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.CancelDownloadJobParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
    * @name cancelDownloadJob
    * @summary: Cancel Download Job.
    * @description: Cancel Download Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelDownloadJob/).
    */
-  async cancelDownloadJob({ id } = {}, { headers } = { headers: false }) {
+  async cancelDownloadJob(
+    { id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = DiscountPlatformValidator.cancelDownloadJob().validate(
       {
         id,
@@ -56,12 +60,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/file/download/${id}/`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -84,13 +88,17 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.CancelValidationJobParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
    * @name cancelValidationJob
    * @summary: Cancel Validation Job.
    * @description: Cancel Validation Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
    */
-  async cancelValidationJob({ id } = {}, { headers } = { headers: false }) {
+  async cancelValidationJob(
+    { id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = DiscountPlatformValidator.cancelValidationJob().validate(
       {
         id,
@@ -127,12 +135,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/file/validation/${id}/`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -155,13 +163,17 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.CreateDiscountParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
    * @name createDiscount
    * @summary: Create Discount.
    * @description: Create Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
    */
-  async createDiscount({ body } = {}, { headers } = { headers: false }) {
+  async createDiscount(
+    { body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = DiscountPlatformValidator.createDiscount().validate(
       {
         body,
@@ -198,12 +210,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/job/`,
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -226,6 +238,7 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.DownloadDiscountFileParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name downloadDiscountFile
@@ -233,8 +246,8 @@ class Discount {
    * @description: Validate File. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
    */
   async downloadDiscountFile(
-    { type, body } = {},
-    { headers } = { headers: false }
+    { type, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = DiscountPlatformValidator.downloadDiscountFile().validate(
       {
@@ -274,12 +287,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/file/${type}/download/`,
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -302,13 +315,17 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.GetDiscountParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
    * @name getDiscount
    * @summary: Fetch discount.
    * @description: Fetch discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
    */
-  async getDiscount({ id } = {}, { headers } = { headers: false }) {
+  async getDiscount(
+    { id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = DiscountPlatformValidator.getDiscount().validate(
       {
         id,
@@ -345,12 +362,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/job/${id}/`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -373,6 +390,7 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.GetDiscountsParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
    * @name getDiscounts
@@ -380,8 +398,19 @@ class Discount {
    * @description: Fetch discount list. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
    */
   async getDiscounts(
-    { view, q, pageNo, pageSize, archived, month, year, type, appIds } = {},
-    { headers } = { headers: false }
+    {
+      view,
+      q,
+      pageNo,
+      pageSize,
+      archived,
+      month,
+      year,
+      type,
+      appIds,
+      requestHeaders,
+    } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = DiscountPlatformValidator.getDiscounts().validate(
       {
@@ -444,12 +473,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/job/`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -470,15 +499,70 @@ class Discount {
     return response;
   }
 
+  /**
+   * @param {Object} arg - Arg object.
+   * @param {string} [arg.view] - Listing or calender. Default is listing.
+   * @param {string} [arg.q] - The search query. This can be a partial or
+   *   complete name of a discount.
+   * @param {number} [arg.pageSize] - Page size. Default is 12.
+   * @param {boolean} [arg.archived] - Archived. Default is false.
+   * @param {number} [arg.month] - Month. Default is current month.
+   * @param {number} [arg.year] - Year. Default is current year.
+   * @param {string} [arg.type] - Basic or custom.
+   * @param {string[]} [arg.appIds] - Application ids.
+   * @returns {Paginator<DiscountPlatformModel.ListOrCalender>}
+   * @summary: Fetch discount list.
+   * @description: Fetch discount list.
+   */
+  getDiscountsPaginator({
+    view,
+    q,
+    pageSize,
+    archived,
+    month,
+    year,
+    type,
+    appIds,
+  } = {}) {
+    const paginator = new Paginator();
+    const callback = async () => {
+      const pageId = paginator.nextId;
+      const pageNo = paginator.pageNo;
+      const pageType = "number";
+      const data = await this.getDiscounts({
+        view: view,
+        q: q,
+        pageNo: pageNo,
+        pageSize: pageSize,
+        archived: archived,
+        month: month,
+        year: year,
+        type: type,
+        appIds: appIds,
+      });
+      paginator.setPaginator({
+        hasNext: data.page.has_next ? true : false,
+        nextId: data.page.next_id,
+      });
+      return data;
+    };
+    paginator.setCallback(callback.bind(this));
+    return paginator;
+  }
+
   /**
    * @param {DiscountPlatformValidator.GetDownloadJobParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name getDownloadJob
    * @summary: Download File Job.
    * @description: Download File Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
    */
-  async getDownloadJob({ id } = {}, { headers } = { headers: false }) {
+  async getDownloadJob(
+    { id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = DiscountPlatformValidator.getDownloadJob().validate(
       {
         id,
@@ -515,12 +599,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/file/download/${id}/`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -543,13 +627,17 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.GetValidationJobParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name getValidationJob
    * @summary: Validate File Job.
    * @description: Validate File Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
    */
-  async getValidationJob({ id } = {}, { headers } = { headers: false }) {
+  async getValidationJob(
+    { id, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = DiscountPlatformValidator.getValidationJob().validate(
       {
         id,
@@ -586,12 +674,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/file/validation/${id}/`,
       query_params,
       undefined,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -614,13 +702,17 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.UpdateDiscountParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
    * @name updateDiscount
    * @summary: Create Discount.
    * @description: Create Discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
    */
-  async updateDiscount({ id, body } = {}, { headers } = { headers: false }) {
+  async updateDiscount(
+    { id, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
+  ) {
     const { error } = DiscountPlatformValidator.updateDiscount().validate(
       {
         id,
@@ -659,12 +751,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/job/${id}/`,
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -687,6 +779,7 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.UpsertDiscountItemsParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<Object>} - Success response
    * @name upsertDiscountItems
@@ -694,8 +787,8 @@ class Discount {
    * @description: Create custom discounts through API. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
    */
   async upsertDiscountItems(
-    { id, body } = {},
-    { headers } = { headers: false }
+    { id, body, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = DiscountPlatformValidator.upsertDiscountItems().validate(
       {
@@ -735,12 +828,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/job/${id}/items/`,
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 
@@ -761,6 +854,7 @@ class Discount {
 
   /**
    * @param {DiscountPlatformValidator.ValidateDiscountFileParam} arg - Arg object
+   * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name validateDiscountFile
@@ -768,8 +862,8 @@ class Discount {
    * @description: Validate File. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
    */
   async validateDiscountFile(
-    { body, discount } = {},
-    { headers } = { headers: false }
+    { body, discount, requestHeaders } = { requestHeaders: {} },
+    { responseHeaders } = { responseHeaders: false }
   ) {
     const { error } = DiscountPlatformValidator.validateDiscountFile().validate(
       {
@@ -810,12 +904,12 @@ class Discount {
       `/service/platform/discount/v1.0/company/${this.config.companyId}/file/validation/`,
       query_params,
       body,
-      xHeaders,
-      { headers }
+      { ...xHeaders, ...requestHeaders },
+      { responseHeaders }
     );
 
     let responseData = response;
-    if (headers) {
+    if (responseHeaders) {
       responseData = response[0];
     }
 

package/sdk/platform/Discount/DiscountPlatformModel.d.ts

@@ -18,6 +18,7 @@ export = DiscountPlatformModel;
  * @property {number[]} [brand_ids]
  * @property {number} company_id
  * @property {string} discount_level
+ * @property {DiscountMeta} [discount_meta]
  * @property {string} discount_type
  * @property {string[]} extension_ids
  * @property {string} [file_path]
@@ -31,6 +32,7 @@ export = DiscountPlatformModel;
 /**
  * @typedef DiscountItems
  * @property {number} [brand_uid]
+ * @property {DiscountMeta} [discount_meta]
  * @property {string} discount_type
  * @property {string} [item_code]
  * @property {string} [seller_identifier]
@@ -45,6 +47,7 @@ export = DiscountPlatformModel;
  * @property {UserDetails} created_by
  * @property {string} created_on
  * @property {string} [discount_level]
+ * @property {DiscountMeta} [discount_meta]
  * @property {string} [discount_type]
  * @property {string} [file_path]
  * @property {boolean} is_active
@@ -57,6 +60,15 @@ export = DiscountPlatformModel;
  * @property {ValidityObject} validity
  * @property {number} [value]
  */
+/**
+ * @typedef DiscountMeta
+ * @property {number} [hours] - The time in hours before the discount ends when
+ *   the countdown timer should start.
+ * @property {number} [minutes] - The time in minutes before the discount ends
+ *   when the countdown timer should start.
+ * @property {boolean} timer - Determines whether the discount countdown is
+ *   visible or not.
+ */
 /**
  * @typedef DownloadFileJob
  * @property {number[]} [brand_ids]
@@ -78,6 +90,7 @@ export = DiscountPlatformModel;
  */
 /**
  * @typedef FileJobResponse
+ * @property {string} _id - A unique identifier to distinguish and identify a job.
  * @property {Object} [body]
  * @property {number} company_id
  * @property {number} failed
@@ -114,7 +127,7 @@ export = DiscountPlatformModel;
 declare class DiscountPlatformModel {
 }
 declare namespace DiscountPlatformModel {
-    export { BadRequestObject, BulkDiscount, CancelJobResponse, CreateUpdateDiscount, DiscountItems, DiscountJob, DownloadFileJob, FileJobRequest, FileJobResponse, ListOrCalender, Page, UserDetails, ValidityObject };
+    export { BadRequestObject, BulkDiscount, CancelJobResponse, CreateUpdateDiscount, DiscountItems, DiscountJob, DiscountMeta, DownloadFileJob, FileJobRequest, FileJobResponse, ListOrCalender, Page, UserDetails, ValidityObject };
 }
 /** @returns {BadRequestObject} */
 declare function BadRequestObject(): BadRequestObject;
@@ -139,6 +152,7 @@ type CreateUpdateDiscount = {
     brand_ids?: number[];
     company_id: number;
     discount_level: string;
+    discount_meta?: DiscountMeta;
     discount_type: string;
     extension_ids: string[];
     file_path?: string;
@@ -153,6 +167,7 @@ type CreateUpdateDiscount = {
 declare function DiscountItems(): DiscountItems;
 type DiscountItems = {
     brand_uid?: number;
+    discount_meta?: DiscountMeta;
     discount_type: string;
     item_code?: string;
     seller_identifier?: string;
@@ -168,6 +183,7 @@ type DiscountJob = {
     created_by: UserDetails;
     created_on: string;
     discount_level?: string;
+    discount_meta?: DiscountMeta;
     discount_type?: string;
     file_path?: string;
     is_active: boolean;
@@ -180,6 +196,25 @@ type DiscountJob = {
     validity: ValidityObject;
     value?: number;
 };
+/** @returns {DiscountMeta} */
+declare function DiscountMeta(): DiscountMeta;
+type DiscountMeta = {
+    /**
+     * - The time in hours before the discount ends when
+     * the countdown timer should start.
+     */
+    hours?: number;
+    /**
+     * - The time in minutes before the discount ends
+     * when the countdown timer should start.
+     */
+    minutes?: number;
+    /**
+     * - Determines whether the discount countdown is
+     * visible or not.
+     */
+    timer: boolean;
+};
 /** @returns {DownloadFileJob} */
 declare function DownloadFileJob(): DownloadFileJob;
 type DownloadFileJob = {
@@ -204,6 +239,10 @@ type FileJobRequest = {
 /** @returns {FileJobResponse} */
 declare function FileJobResponse(): FileJobResponse;
 type FileJobResponse = {
+    /**
+     * - A unique identifier to distinguish and identify a job.
+     */
+    _id: string;
     body?: any;
     company_id: number;
     failed: number;

package/sdk/platform/Discount/DiscountPlatformModel.js

@@ -22,6 +22,7 @@ const Joi = require("joi");
  * @property {number[]} [brand_ids]
  * @property {number} company_id
  * @property {string} discount_level
+ * @property {DiscountMeta} [discount_meta]
  * @property {string} discount_type
  * @property {string[]} extension_ids
  * @property {string} [file_path]
@@ -36,6 +37,7 @@ const Joi = require("joi");
 /**
  * @typedef DiscountItems
  * @property {number} [brand_uid]
+ * @property {DiscountMeta} [discount_meta]
  * @property {string} discount_type
  * @property {string} [item_code]
  * @property {string} [seller_identifier]
@@ -51,6 +53,7 @@ const Joi = require("joi");
  * @property {UserDetails} created_by
  * @property {string} created_on
  * @property {string} [discount_level]
+ * @property {DiscountMeta} [discount_meta]
  * @property {string} [discount_type]
  * @property {string} [file_path]
  * @property {boolean} is_active
@@ -64,6 +67,16 @@ const Joi = require("joi");
  * @property {number} [value]
  */
 
+/**
+ * @typedef DiscountMeta
+ * @property {number} [hours] - The time in hours before the discount ends when
+ *   the countdown timer should start.
+ * @property {number} [minutes] - The time in minutes before the discount ends
+ *   when the countdown timer should start.
+ * @property {boolean} timer - Determines whether the discount countdown is
+ *   visible or not.
+ */
+
 /**
  * @typedef DownloadFileJob
  * @property {number[]} [brand_ids]
@@ -87,6 +100,7 @@ const Joi = require("joi");
 
 /**
  * @typedef FileJobResponse
+ * @property {string} _id - A unique identifier to distinguish and identify a job.
  * @property {Object} [body]
  * @property {number} company_id
  * @property {number} failed
@@ -157,6 +171,7 @@ class DiscountPlatformModel {
       brand_ids: Joi.array().items(Joi.number()),
       company_id: Joi.number().required(),
       discount_level: Joi.string().allow("").required(),
+      discount_meta: DiscountPlatformModel.DiscountMeta(),
       discount_type: Joi.string().allow("").required(),
       extension_ids: Joi.array().items(Joi.string().allow("")).required(),
       file_path: Joi.string().allow(""),
@@ -173,6 +188,7 @@ class DiscountPlatformModel {
   static DiscountItems() {
     return Joi.object({
       brand_uid: Joi.number(),
+      discount_meta: DiscountPlatformModel.DiscountMeta(),
       discount_type: Joi.string().allow("").required(),
       item_code: Joi.string().allow(""),
       seller_identifier: Joi.string().allow(""),
@@ -190,6 +206,7 @@ class DiscountPlatformModel {
       created_by: DiscountPlatformModel.UserDetails().required(),
       created_on: Joi.string().allow("").required(),
       discount_level: Joi.string().allow(""),
+      discount_meta: DiscountPlatformModel.DiscountMeta(),
       discount_type: Joi.string().allow(""),
       file_path: Joi.string().allow(""),
       is_active: Joi.boolean().required(),
@@ -204,6 +221,15 @@ class DiscountPlatformModel {
     });
   }
 
+  /** @returns {DiscountMeta} */
+  static DiscountMeta() {
+    return Joi.object({
+      hours: Joi.number(),
+      minutes: Joi.number(),
+      timer: Joi.boolean().required(),
+    });
+  }
+
   /** @returns {DownloadFileJob} */
   static DownloadFileJob() {
     return Joi.object({
@@ -232,6 +258,7 @@ class DiscountPlatformModel {
   /** @returns {FileJobResponse} */
   static FileJobResponse() {
     return Joi.object({
+      _id: Joi.string().allow("").required(),
       body: Joi.any(),
       company_id: Joi.number().required(),
       failed: Joi.number().required(),