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

package/sdk/platform/Discount/DiscountPlatformClient.js

@@ -18,11 +18,10 @@ class Discount {
    * @param {DiscountPlatformValidator.CancelDownloadJobParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<DiscountPlatformModel.CancelJobResponseSchema>} -
-   *   Success response
+   * @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
    * @name cancelDownloadJob
-   * @summary: delete discount download job
-   * @description: Cancel a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/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, requestHeaders } = { requestHeaders: {} },
@@ -75,7 +74,7 @@ class Discount {
 
     const {
       error: res_error,
-    } = DiscountPlatformModel.CancelJobResponseSchema().validate(responseData, {
+    } = DiscountPlatformModel.CancelJobResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -98,11 +97,10 @@ class Discount {
    * @param {DiscountPlatformValidator.CancelValidationJobParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<DiscountPlatformModel.CancelJobResponseSchema>} -
-   *   Success response
+   * @returns {Promise<DiscountPlatformModel.CancelJobResponse>} - Success response
    * @name cancelValidationJob
-   * @summary: deletel validation job discount
-   * @description: Cancel validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
+   * @summary: Cancel validation job.
+   * @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/cancelValidationJob/).
    */
   async cancelValidationJob(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -155,7 +153,7 @@ class Discount {
 
     const {
       error: res_error,
-    } = DiscountPlatformModel.CancelJobResponseSchema().validate(responseData, {
+    } = DiscountPlatformModel.CancelJobResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -180,8 +178,8 @@ class Discount {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
    * @name createDiscount
-   * @summary: Create discount
-   * @description: Creates a discount. There are additional optional parameters that can be specified in the body of the request when creating a discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
+   * @summary: Create discount.
+   * @description: Create discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/createDiscount/).
    */
   async createDiscount(
     { body, requestHeaders } = { requestHeaders: {} },
@@ -257,10 +255,10 @@ class Discount {
    * @param {DiscountPlatformValidator.DownloadDiscountFileParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
+   * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name downloadDiscountFile
-   * @summary: Get discount file
-   * @description: Retrieve a discount file by its type, it could be product or inventory. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
+   * @summary: Download discount file.
+   * @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/downloadDiscountFile/).
    */
   async downloadDiscountFile(
     { type, body, requestHeaders } = { requestHeaders: {} },
@@ -315,7 +313,7 @@ class Discount {
 
     const {
       error: res_error,
-    } = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
+    } = DiscountPlatformModel.FileJobResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -340,8 +338,8 @@ class Discount {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
    * @name getDiscount
-   * @summary: Get discount
-   * @description: Retrieve a single discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
+   * @summary: Get discount by ID.
+   * @description: Retrieve detailed information about a specific discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscount/).
    */
   async getDiscount(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -419,8 +417,8 @@ class Discount {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.ListOrCalender>} - Success response
    * @name getDiscounts
-   * @summary: List discounts
-   * @description: Retrieve a list of discounts. You can also retrieve discounts using filter query parameters. There are additional optional parameters that can be specified in the parameters of the request when retrieving discount - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
+   * @summary: Get discounts.
+   * @description: Retrieve a list of available discounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDiscounts/).
    */
   async getDiscounts(
     {
@@ -528,14 +526,65 @@ 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: Get discounts.
+   * @description: Retrieve a list of available discounts.
+   */
+  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.FileJobResponseSchema>} - Success response
+   * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name getDownloadJob
-   * @summary: List discount download job
-   * @description: Retrieve a discount download job by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
+   * @summary: Get download job.
+   * @description: Download file Job. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getDownloadJob/).
    */
   async getDownloadJob(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -588,7 +637,7 @@ class Discount {
 
     const {
       error: res_error,
-    } = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
+    } = DiscountPlatformModel.FileJobResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -611,10 +660,10 @@ class Discount {
    * @param {DiscountPlatformValidator.GetValidationJobParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
+   * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name getValidationJob
-   * @summary: List validation job discount
-   * @description: Retrieve a validation job of a discount by its id. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
+   * @summary: Get validation job.
+   * @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/getValidationJob/).
    */
   async getValidationJob(
     { id, requestHeaders } = { requestHeaders: {} },
@@ -667,7 +716,7 @@ class Discount {
 
     const {
       error: res_error,
-    } = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
+    } = DiscountPlatformModel.FileJobResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });
@@ -692,8 +741,8 @@ class Discount {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<DiscountPlatformModel.DiscountJob>} - Success response
    * @name updateDiscount
-   * @summary: Update discount
-   * @description: Update an existing discount by its id. Discount can only be updated after 5 min from last updated time stamp (modified_on). - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
+   * @summary: Update discount.
+   * @description: Create discount. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/updateDiscount/).
    */
   async updateDiscount(
     { id, body, requestHeaders } = { requestHeaders: {} },
@@ -773,8 +822,8 @@ class Discount {
    * @param {import("../PlatformAPIClient").Options} - Options
    * @returns {Promise<Object>} - Success response
    * @name upsertDiscountItems
-   * @summary: Upsert discount items
-   * @description: Enables users to create custom discounts in bulk by providing the multiple products in requestBody. It allows for the efficient creation of multiple discounts simultaneously, streamlining the discount management process. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
+   * @summary: Upsert discount items.
+   * @description: Create custom discounts. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/upsertDiscountItems/).
    */
   async upsertDiscountItems(
     { id, body, requestHeaders } = { requestHeaders: {} },
@@ -850,10 +899,10 @@ class Discount {
    * @param {DiscountPlatformValidator.ValidateDiscountFileParam} arg - Arg object
    * @param {object} [arg.requestHeaders={}] - Request headers. Default is `{}`
    * @param {import("../PlatformAPIClient").Options} - Options
-   * @returns {Promise<DiscountPlatformModel.FileJobResponseSchema>} - Success response
+   * @returns {Promise<DiscountPlatformModel.FileJobResponse>} - Success response
    * @name validateDiscountFile
-   * @summary: Validate discount file
-   * @description: Validates the discount file for any discrepancies. like item should be valid etc.. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
+   * @summary: Validate discount file.
+   * @description: Validate file. - Check out [method documentation](https://partners.fynd.com/help/docs/sdk/platform/discount/validateDiscountFile/).
    */
   async validateDiscountFile(
     { body, discount, requestHeaders } = { requestHeaders: {} },
@@ -909,7 +958,7 @@ class Discount {
 
     const {
       error: res_error,
-    } = DiscountPlatformModel.FileJobResponseSchema().validate(responseData, {
+    } = DiscountPlatformModel.FileJobResponse().validate(responseData, {
       abortEarly: false,
       allowUnknown: true,
     });

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

@@ -9,8 +9,7 @@ export = DiscountPlatformModel;
  * @property {string} name
  * @property {number} company_id
  * @property {boolean} is_active
- * @property {string[]} app_ids
- * @property {string[]} [extension_ids]
+ * @property {string} app_id
  * @property {string} job_type
  * @property {string} discount_type
  * @property {string} discount_level
@@ -18,7 +17,7 @@ export = DiscountPlatformModel;
  * @property {string} [file_path]
  * @property {number[]} [brand_ids]
  * @property {number[]} [store_ids]
- * @property {string[]} [zone_ids]
+ * @property {string[]} [factory_type_ids]
  * @property {ValidityObject} validity
  * @property {DiscountMeta} [discount_meta]
  */
@@ -37,15 +36,15 @@ export = DiscountPlatformModel;
  * @property {string} name
  * @property {number} company_id
  * @property {boolean} is_active
- * @property {string[]} [app_ids]
- * @property {string} [job_type]
+ * @property {string} app_id
+ * @property {string} job_type
  * @property {string} [discount_type]
- * @property {string} [discount_level]
+ * @property {string} discount_level
  * @property {number} [value]
  * @property {string} [file_path]
  * @property {number[]} [brand_ids]
  * @property {number[]} [store_ids]
- * @property {string[]} [zone_ids]
+ * @property {string[]} [factory_type_ids]
  * @property {DiscountMeta} [discount_meta]
  * @property {ValidityObject} validity
  * @property {string} created_on
@@ -59,7 +58,7 @@ export = DiscountPlatformModel;
  * @property {string} [name]
  * @property {number} [company_id]
  * @property {boolean} [is_active]
- * @property {string[]} [app_ids]
+ * @property {string} [app_id]
  * @property {string} [job_type]
  * @property {string} [discount_type]
  * @property {string} [discount_level]
@@ -67,8 +66,7 @@ export = DiscountPlatformModel;
  * @property {string} [file_path]
  * @property {number[]} [brand_ids]
  * @property {number[]} [store_ids]
- * @property {string[]} [extension_ids]
- * @property {string[]} [zone_ids]
+ * @property {string[]} [factory_type_ids]
  * @property {DiscountMeta} [discount_meta]
  * @property {ValidityObject} [validity]
  * @property {string} [created_on]
@@ -87,6 +85,8 @@ export = DiscountPlatformModel;
  * @property {string} [item_code]
  * @property {string} [brand_name]
  * @property {string} [seller_identifier]
+ * @property {string} [store_code]
+ * @property {string} [price_zone]
  * @property {string} discount_type
  * @property {number} value
  * @property {DiscountMeta} [discount_meta]
@@ -97,7 +97,7 @@ export = DiscountPlatformModel;
  * @property {DiscountItems[]} items
  */
 /**
- * @typedef FileJobResponseSchema
+ * @typedef FileJobResponse
  * @property {string} stage
  * @property {number} total
  * @property {number} failed
@@ -108,21 +108,19 @@ export = DiscountPlatformModel;
  * @property {string} _id - A unique identifier to distinguish and identify a job.
  * @property {string} [file_path]
  * @property {number} [progress]
- * @property {string[]} [extension_ids]
- * @property {string[]} [zone_ids]
  * @property {string} [created_on]
  * @property {string} [modified_on]
  * @property {UserDetails} [created_by]
  */
 /**
- * @typedef FileJobRequestSchema
+ * @typedef FileJobRequest
  * @property {string} name
  * @property {boolean} is_active
  * @property {number} company_id
- * @property {string[]} [app_ids]
- * @property {string} [job_type]
+ * @property {string} app_id
+ * @property {string} job_type
  * @property {string} [discount_type]
- * @property {string} [discount_level]
+ * @property {string} discount_level
  * @property {string} [file_path]
  * @property {number[]} [brand_ids]
  * @property {number[]} [store_ids]
@@ -131,11 +129,10 @@ export = DiscountPlatformModel;
  */
 /**
  * @typedef DownloadFileJob
- * @property {number[]} [brand_ids]
- * @property {number[]} [store_ids]
+ * @property {string} app_id
  */
 /**
- * @typedef CancelJobResponseSchema
+ * @typedef CancelJobResponse
  * @property {boolean} success
  */
 /**
@@ -147,6 +144,7 @@ export = DiscountPlatformModel;
  * @property {number} [current] - The current page number.
  * @property {string} type - The type of the page, such as 'PageType'.
  * @property {number} [size] - The number of items per page.
+ * @property {number} [total] - Total number of items.
  */
 /**
  * @typedef UserDetails
@@ -170,7 +168,7 @@ export = DiscountPlatformModel;
 declare class DiscountPlatformModel {
 }
 declare namespace DiscountPlatformModel {
-    export { ValidityObject, CreateUpdateDiscount, DiscountMeta, DiscountJob, FileJobBody, ListOrCalender, DiscountItems, BulkDiscount, FileJobResponseSchema, FileJobRequestSchema, DownloadFileJob, CancelJobResponseSchema, Page, UserDetails, BadRequestObject, BadRequestData, BadRequestObjectGet };
+    export { ValidityObject, CreateUpdateDiscount, DiscountMeta, DiscountJob, FileJobBody, ListOrCalender, DiscountItems, BulkDiscount, FileJobResponse, FileJobRequest, DownloadFileJob, CancelJobResponse, Page, UserDetails, BadRequestObject, BadRequestData, BadRequestObjectGet };
 }
 /** @returns {ValidityObject} */
 declare function ValidityObject(): ValidityObject;
@@ -184,8 +182,7 @@ type CreateUpdateDiscount = {
     name: string;
     company_id: number;
     is_active: boolean;
-    app_ids: string[];
-    extension_ids?: string[];
+    app_id: string;
     job_type: string;
     discount_type: string;
     discount_level: string;
@@ -193,7 +190,7 @@ type CreateUpdateDiscount = {
     file_path?: string;
     brand_ids?: number[];
     store_ids?: number[];
-    zone_ids?: string[];
+    factory_type_ids?: string[];
     validity: ValidityObject;
     discount_meta?: DiscountMeta;
 };
@@ -223,15 +220,15 @@ type DiscountJob = {
     name: string;
     company_id: number;
     is_active: boolean;
-    app_ids?: string[];
-    job_type?: string;
+    app_id: string;
+    job_type: string;
     discount_type?: string;
-    discount_level?: string;
+    discount_level: string;
     value?: number;
     file_path?: string;
     brand_ids?: number[];
     store_ids?: number[];
-    zone_ids?: string[];
+    factory_type_ids?: string[];
     discount_meta?: DiscountMeta;
     validity: ValidityObject;
     created_on: string;
@@ -246,7 +243,7 @@ type FileJobBody = {
     name?: string;
     company_id?: number;
     is_active?: boolean;
-    app_ids?: string[];
+    app_id?: string;
     job_type?: string;
     discount_type?: string;
     discount_level?: string;
@@ -254,8 +251,7 @@ type FileJobBody = {
     file_path?: string;
     brand_ids?: number[];
     store_ids?: number[];
-    extension_ids?: string[];
-    zone_ids?: string[];
+    factory_type_ids?: string[];
     discount_meta?: DiscountMeta;
     validity?: ValidityObject;
     created_on?: string;
@@ -276,6 +272,8 @@ type DiscountItems = {
     item_code?: string;
     brand_name?: string;
     seller_identifier?: string;
+    store_code?: string;
+    price_zone?: string;
     discount_type: string;
     value: number;
     discount_meta?: DiscountMeta;
@@ -286,9 +284,9 @@ type BulkDiscount = {
     company_id: number;
     items: DiscountItems[];
 };
-/** @returns {FileJobResponseSchema} */
-declare function FileJobResponseSchema(): FileJobResponseSchema;
-type FileJobResponseSchema = {
+/** @returns {FileJobResponse} */
+declare function FileJobResponse(): FileJobResponse;
+type FileJobResponse = {
     stage: string;
     total: number;
     failed: number;
@@ -302,22 +300,20 @@ type FileJobResponseSchema = {
     _id: string;
     file_path?: string;
     progress?: number;
-    extension_ids?: string[];
-    zone_ids?: string[];
     created_on?: string;
     modified_on?: string;
     created_by?: UserDetails;
 };
-/** @returns {FileJobRequestSchema} */
-declare function FileJobRequestSchema(): FileJobRequestSchema;
-type FileJobRequestSchema = {
+/** @returns {FileJobRequest} */
+declare function FileJobRequest(): FileJobRequest;
+type FileJobRequest = {
     name: string;
     is_active: boolean;
     company_id: number;
-    app_ids?: string[];
-    job_type?: string;
+    app_id: string;
+    job_type: string;
     discount_type?: string;
-    discount_level?: string;
+    discount_level: string;
     file_path?: string;
     brand_ids?: number[];
     store_ids?: number[];
@@ -327,12 +323,11 @@ type FileJobRequestSchema = {
 /** @returns {DownloadFileJob} */
 declare function DownloadFileJob(): DownloadFileJob;
 type DownloadFileJob = {
-    brand_ids?: number[];
-    store_ids?: number[];
+    app_id: string;
 };
-/** @returns {CancelJobResponseSchema} */
-declare function CancelJobResponseSchema(): CancelJobResponseSchema;
-type CancelJobResponseSchema = {
+/** @returns {CancelJobResponse} */
+declare function CancelJobResponse(): CancelJobResponse;
+type CancelJobResponse = {
     success: boolean;
 };
 /** @returns {Page} */
@@ -366,6 +361,10 @@ type Page = {
      * - The number of items per page.
      */
     size?: number;
+    /**
+     * - Total number of items.
+     */
+    total?: number;
 };
 /** @returns {UserDetails} */
 declare function UserDetails(): UserDetails;