@gofynd/fdk-client-javascript 1.6.4 → 2.0.0

package/sdk/platform/Discount/DiscountPlatformModel.js

@@ -2,25 +2,26 @@ const Joi = require("joi");
 
 /**
  * @typedef ValidityObject
- * @property {string} start
- * @property {string} end
+ * @property {string} start - The start date and time of the discount period.
+ * @property {string} end - The end date and time of the discount period.
  */
 
 /**
  * @typedef CreateUpdateDiscount
- * @property {string} name
- * @property {number} company_id
- * @property {boolean} is_active
- * @property {string[]} app_ids
- * @property {string[]} [extension_ids]
- * @property {string} job_type
- * @property {string} discount_type
- * @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} name - The name of the discount.
+ * @property {number} company_id - The unique identifier for the company.
+ * @property {boolean} is_active - Indicates if the discount is currently active.
+ * @property {string[]} app_ids - List of application IDs associated with the discount.
+ * @property {string[]} [extension_ids] - List of extension IDs associated with
+ *   the discount.
+ * @property {string} job_type - The type of job associated with the discount.
+ * @property {string} discount_type - The type of discount being offered.
+ * @property {string} discount_level - The level at which the discount is applied.
+ * @property {number} [value] - The value of the discount.
+ * @property {string} [file_path] - The file path for discount file.
+ * @property {number[]} [brand_ids] - List of brand IDs associated with the discount.
+ * @property {number[]} [store_ids] - List of store IDs associated with the discount.
+ * @property {string[]} [zone_ids] - List of zone IDs associated with the discount.
  * @property {ValidityObject} validity
  * @property {DiscountMeta} [discount_meta]
  */
@@ -37,118 +38,120 @@ const Joi = require("joi");
 
 /**
  * @typedef DiscountJob
- * @property {string} _id
- * @property {string} name
- * @property {number} company_id
- * @property {boolean} is_active
- * @property {string[]} [app_ids]
- * @property {string} [job_type]
- * @property {string} [discount_type]
- * @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} _id - The unique identifier for the discount job.
+ * @property {string} name - The name of the discount job.
+ * @property {number} company_id - The unique identifier for the company.
+ * @property {boolean} is_active - Indicates if the discount job is currently active.
+ * @property {string[]} app_ids - List of application IDs associated with the
+ *   discount job.
+ * @property {string} job_type - The type of job associated with the discount job.
+ * @property {string} [discount_type] - The type of discount being offered.
+ * @property {string} discount_level - The level at which the discount is applied.
+ * @property {number} [value] - The value of the discount.
+ * @property {string} [file_path] - The file path for discount file.
+ * @property {number[]} [brand_ids] - List of brand IDs associated with the discount job.
+ * @property {number[]} [store_ids] - List of store IDs associated with the discount job.
+ * @property {string[]} [zone_ids] - List of zone IDs associated with the discount job.
  * @property {DiscountMeta} [discount_meta]
  * @property {ValidityObject} validity
- * @property {string} created_on
- * @property {string} modified_on
+ * @property {string} created_on - The date and time when the discount job was created.
+ * @property {string} modified_on - The date and time when the discount job was
+ *   last modified.
  * @property {UserDetails} created_by
  * @property {UserDetails} modified_by
- * @property {Object} [meta]
+ * @property {Object} [meta] - Additional metadata for the discount job.
  */
 
 /**
  * @typedef FileJobBody
- * @property {string} [name]
- * @property {number} [company_id]
- * @property {boolean} [is_active]
- * @property {string[]} [app_ids]
- * @property {string} [job_type]
- * @property {string} [discount_type]
- * @property {string} [discount_level]
- * @property {number} [value]
- * @property {string} [file_path]
- * @property {number[]} [brand_ids]
- * @property {number[]} [store_ids]
- * @property {string[]} [extension_ids]
- * @property {string[]} [zone_ids]
+ * @property {string} [name] - The name of the job.
+ * @property {number} [company_id] - Unique identifier for the company.
+ * @property {boolean} [is_active] - Indicates if the job is active.
+ * @property {string[]} [app_ids] - List of application identifiers.
+ * @property {string} [job_type] - Type of job being processed.
+ * @property {string} [discount_type] - Type of discount applied.
+ * @property {string} [discount_level] - Level at which the discount is applied.
+ * @property {number} [value] - Value of the discount.
+ * @property {string} [file_path] - Path to the discount file associated with the job.
+ * @property {number[]} [brand_ids] - List of brand identifiers.
+ * @property {number[]} [store_ids] - List of store identifiers.
+ * @property {string[]} [extension_ids] - List of extension identifiers.
+ * @property {string[]} [zone_ids] - List of zone identifiers.
  * @property {DiscountMeta} [discount_meta]
  * @property {ValidityObject} [validity]
- * @property {string} [created_on]
- * @property {string} [modified_on]
+ * @property {string} [created_on] - Timestamp when the job was created.
+ * @property {string} [modified_on] - Timestamp when the job was last modified.
  * @property {UserDetails} [created_by]
  * @property {UserDetails} [modified_by]
- * @property {Object} [meta]
+ * @property {Object} [meta] - Additional metadata for the job.
  */
 
 /**
  * @typedef ListOrCalender
- * @property {DiscountJob[]} items
+ * @property {DiscountJob[]} items - List of discount jobs.
  * @property {Page} page
  */
 
 /**
  * @typedef DiscountItems
- * @property {string} [item_code]
- * @property {string} [brand_name]
- * @property {string} [seller_identifier]
- * @property {string} discount_type
- * @property {number} value
+ * @property {string} [item_code] - Unique code for the item.
+ * @property {string} [brand_name] - Name of the brand.
+ * @property {string} [seller_identifier] - Unique Identifier for the size.
+ * @property {string} discount_type - Type of discount applied.
+ * @property {number} value - Value of the discount.
  * @property {DiscountMeta} [discount_meta]
  */
 
 /**
  * @typedef BulkDiscount
- * @property {number} company_id
- * @property {DiscountItems[]} items
+ * @property {number} company_id - Uinque Identifier for the company.
+ * @property {DiscountItems[]} items - List of discount items.
  */
 
 /**
  * @typedef FileJobResponseSchema
- * @property {string} stage
- * @property {number} total
- * @property {number} failed
- * @property {number} company_id
+ * @property {string} stage - Current stage of the file job.
+ * @property {number} total - Total number of items processed.
+ * @property {number} failed - Number of items that failed processing.
+ * @property {number} company_id - Identifier for the company.
  * @property {FileJobBody} [body]
- * @property {string} type
- * @property {string} [file_type]
+ * @property {string} type - Type of file job.
+ * @property {string} [file_type] - Type of file being processed.
  * @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 {string} [file_path] - Path to the disocunt file.
+ * @property {number} [progress] - Progress of the file job.
+ * @property {string[]} [extension_ids] - List of extension identifiers.
+ * @property {string[]} [zone_ids] - List of zone identifiers.
+ * @property {string} [created_on] - Timestamp when the job was created.
+ * @property {string} [modified_on] - Timestamp when the job was last modified.
  * @property {UserDetails} [created_by]
  */
 
 /**
  * @typedef FileJobRequestSchema
- * @property {string} name
- * @property {boolean} is_active
- * @property {number} company_id
- * @property {string[]} [app_ids]
- * @property {string} [job_type]
- * @property {string} [discount_type]
- * @property {string} [discount_level]
- * @property {string} [file_path]
- * @property {number[]} [brand_ids]
- * @property {number[]} [store_ids]
+ * @property {string} name - Name of the file job.
+ * @property {boolean} is_active - Indicates if the job is active.
+ * @property {number} company_id - Unique Identifier for the company.
+ * @property {string[]} app_ids - List of application identifiers.
+ * @property {string} job_type - Type of job.
+ * @property {string} [discount_type] - Type of discount.
+ * @property {string} discount_level - Level at which the discount is applied.
+ * @property {string} [file_path] - Path to the disocunt file.
+ * @property {number[]} [brand_ids] - List of brand identifiers.
+ * @property {number[]} [store_ids] - List of store identifiers.
  * @property {ValidityObject} validity
- * @property {Object} [meta]
+ * @property {Object} [meta] - Additional metadata for the disocunt.
  */
 
 /**
  * @typedef DownloadFileJob
- * @property {number[]} [brand_ids]
- * @property {number[]} [store_ids]
+ * @property {number[]} [brand_ids] - List of brand identifiers.
+ * @property {number[]} [store_ids] - List of store identifiers.
  */
 
 /**
  * @typedef CancelJobResponseSchema
- * @property {boolean} success
+ * @property {boolean} success - Indicates if the job cancellation was successful.
  */
 
 /**
@@ -160,28 +163,29 @@ const Joi = require("joi");
  * @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} [page_size] - The number of items per page.
  */
 
 /**
  * @typedef UserDetails
- * @property {string} username
- * @property {string} user_id
+ * @property {string} username - Username of the user.
+ * @property {string} user_id - Unique identifier for the user.
  */
 
 /**
  * @typedef BadRequestObject
- * @property {string} message
+ * @property {string} message - A brief description of the error encountered.
  */
 
 /**
  * @typedef BadRequestData
- * @property {string} [message]
+ * @property {string} [message] - Detailed information about the error.
  */
 
 /**
  * @typedef BadRequestObjectGet
- * @property {string} [message]
- * @property {string} [error]
+ * @property {string} [message] - A brief description of the error encountered.
+ * @property {string} [error] - Specific error code or identifier.
  * @property {BadRequestData} [data]
  */
 
@@ -231,10 +235,10 @@ class DiscountPlatformModel {
       name: Joi.string().allow("").required(),
       company_id: Joi.number().required(),
       is_active: Joi.boolean().required(),
-      app_ids: Joi.array().items(Joi.string().allow("")),
-      job_type: Joi.string().allow(""),
+      app_ids: Joi.array().items(Joi.string().allow("")).required(),
+      job_type: Joi.string().allow("").required(),
       discount_type: Joi.string().allow(""),
-      discount_level: Joi.string().allow(""),
+      discount_level: Joi.string().allow("").required(),
       value: Joi.number(),
       file_path: Joi.string().allow(""),
       brand_ids: Joi.array().items(Joi.number()),
@@ -333,10 +337,10 @@ class DiscountPlatformModel {
       name: Joi.string().allow("").required(),
       is_active: Joi.boolean().required(),
       company_id: Joi.number().required(),
-      app_ids: Joi.array().items(Joi.string().allow("")),
-      job_type: Joi.string().allow(""),
+      app_ids: Joi.array().items(Joi.string().allow("")).required(),
+      job_type: Joi.string().allow("").required(),
       discount_type: Joi.string().allow(""),
-      discount_level: Joi.string().allow(""),
+      discount_level: Joi.string().allow("").required(),
       file_path: Joi.string().allow(""),
       brand_ids: Joi.array().items(Joi.number()),
       store_ids: Joi.array().items(Joi.number()),
@@ -370,6 +374,7 @@ class DiscountPlatformModel {
       current: Joi.number(),
       type: Joi.string().allow("").required(),
       size: Joi.number(),
+      page_size: Joi.number(),
     });
   }
 

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

@@ -1,11 +1,11 @@
 export = DiscountPlatformValidator;
 /**
  * @typedef CancelDownloadJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount
  */
 /**
  * @typedef CancelValidationJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 /**
  * @typedef CreateDiscountParam
@@ -13,47 +13,57 @@ export = DiscountPlatformValidator;
  */
 /**
  * @typedef DownloadDiscountFileParam
- * @property {string} type - Type
+ * @property {string} type - The type of discount file to download, either
+ *   'product' or 'inventory'.
  * @property {DiscountPlatformModel.DownloadFileJob} body
  */
 /**
  * @typedef GetDiscountParam
- * @property {string} id - Unique id.
+ * @property {string} id - Unique identifier for the discount.
  */
 /**
  * @typedef GetDiscountsParam
- * @property {string} [view] - Listing or calender. Default is listing.
+ * @property {string} [view] - Specifies the format in which the discounts are
+ *   displayed. Options are 'listing' for a list view or 'calendar' for a
+ *   calendar view. Defaults to 'listing'.
  * @property {string} [q] - The search query. This can be a partial or complete
  *   name of a discount.
- * @property {number} [pageNo] - Page number. Default is 1.
- * @property {number} [pageSize] - Page size. Default is 12.
- * @property {boolean} [archived] - Archived. Default is false.
- * @property {number} [month] - Month. Default is current month.
- * @property {number} [year] - Year. Default is current year.
- * @property {string} [type] - Basic or custom.
- * @property {string[]} [appIds] - Application ids.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default is 1.
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 12.
+ * @property {boolean} [archived] - Indicates whether to include expired
+ *   discounts in the results. Defaults to false.
+ * @property {number} [month] - The month for which discounts is requested.
+ *   Defaults to the current month if not specified.
+ * @property {number} [year] - The year for which discounts is requested.
+ *   Defaults to the current year if not specified.
+ * @property {string} [type] - Specifies the type of disocunt to list, either
+ *   'basic' or 'custom'.
+ * @property {string[]} [appIds] - A `application_id` is a unique identifier for
+ *   a particular sales channel.
  */
 /**
  * @typedef GetDownloadJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 /**
  * @typedef GetValidationJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 /**
  * @typedef UpdateDiscountParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  * @property {DiscountPlatformModel.CreateUpdateDiscount} body
  */
 /**
  * @typedef UpsertDiscountItemsParam
- * @property {string} id - Job ID of the discount.
+ * @property {string} id - Unique identifier for the discount.
  * @property {DiscountPlatformModel.BulkDiscount} body
  */
 /**
  * @typedef ValidateDiscountFileParam
- * @property {string} [discount] - Discount
+ * @property {string} [discount] - Unique identifier for the discount.
  * @property {DiscountPlatformModel.FileJobRequestSchema} body
  */
 declare class DiscountPlatformValidator {
@@ -85,13 +95,13 @@ declare namespace DiscountPlatformValidator {
 }
 type CancelDownloadJobParam = {
     /**
-     * - Id
+     * - Unique identifier for the discount
      */
     id: string;
 };
 type CancelValidationJobParam = {
     /**
-     * - Id
+     * - Unique identifier for the discount.
      */
     id: string;
 };
@@ -100,20 +110,23 @@ type CreateDiscountParam = {
 };
 type DownloadDiscountFileParam = {
     /**
-     * - Type
+     * - The type of discount file to download, either
+     * 'product' or 'inventory'.
      */
     type: string;
     body: DiscountPlatformModel.DownloadFileJob;
 };
 type GetDiscountParam = {
     /**
-     * - Unique id.
+     * - Unique identifier for the discount.
      */
     id: string;
 };
 type GetDiscountsParam = {
     /**
-     * - Listing or calender. Default is listing.
+     * - Specifies the format in which the discounts are
+     * displayed. Options are 'listing' for a list view or 'calendar' for a
+     * calendar view. Defaults to 'listing'.
      */
     view?: string;
     /**
@@ -122,63 +135,70 @@ type GetDiscountsParam = {
      */
     q?: string;
     /**
-     * - Page number. Default is 1.
+     * - The page number to navigate through the given
+     * set of results. Default is 1.
      */
     pageNo?: number;
     /**
-     * - Page size. Default is 12.
+     * - Number of items to retrieve in each page.
+     * Default is 12.
      */
     pageSize?: number;
     /**
-     * - Archived. Default is false.
+     * - Indicates whether to include expired
+     * discounts in the results. Defaults to false.
      */
     archived?: boolean;
     /**
-     * - Month. Default is current month.
+     * - The month for which discounts is requested.
+     * Defaults to the current month if not specified.
      */
     month?: number;
     /**
-     * - Year. Default is current year.
+     * - The year for which discounts is requested.
+     * Defaults to the current year if not specified.
      */
     year?: number;
     /**
-     * - Basic or custom.
+     * - Specifies the type of disocunt to list, either
+     * 'basic' or 'custom'.
      */
     type?: string;
     /**
-     * - Application ids.
+     * - A `application_id` is a unique identifier for
+     * a particular sales channel.
      */
     appIds?: string[];
 };
 type GetDownloadJobParam = {
     /**
-     * - Id
+     * - Unique identifier for the discount.
      */
     id: string;
 };
 type GetValidationJobParam = {
     /**
-     * - Id
+     * - Unique identifier for the discount.
      */
     id: string;
 };
 type UpdateDiscountParam = {
     /**
-     * - Id
+     * - Unique identifier for the discount.
      */
     id: string;
     body: DiscountPlatformModel.CreateUpdateDiscount;
 };
 type UpsertDiscountItemsParam = {
     /**
-     * - Job ID of the discount.
+     * - Unique identifier for the discount.
      */
     id: string;
     body: DiscountPlatformModel.BulkDiscount;
 };
 type ValidateDiscountFileParam = {
     /**
-     * - Discount
+     * - Unique identifier for the discount.
      */
     discount?: string;
     body: DiscountPlatformModel.FileJobRequestSchema;

package/sdk/platform/Discount/DiscountPlatformValidator.js

@@ -4,12 +4,12 @@ const DiscountPlatformModel = require("./DiscountPlatformModel");
 
 /**
  * @typedef CancelDownloadJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount
  */
 
 /**
  * @typedef CancelValidationJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
@@ -19,54 +19,64 @@ const DiscountPlatformModel = require("./DiscountPlatformModel");
 
 /**
  * @typedef DownloadDiscountFileParam
- * @property {string} type - Type
+ * @property {string} type - The type of discount file to download, either
+ *   'product' or 'inventory'.
  * @property {DiscountPlatformModel.DownloadFileJob} body
  */
 
 /**
  * @typedef GetDiscountParam
- * @property {string} id - Unique id.
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
  * @typedef GetDiscountsParam
- * @property {string} [view] - Listing or calender. Default is listing.
+ * @property {string} [view] - Specifies the format in which the discounts are
+ *   displayed. Options are 'listing' for a list view or 'calendar' for a
+ *   calendar view. Defaults to 'listing'.
  * @property {string} [q] - The search query. This can be a partial or complete
  *   name of a discount.
- * @property {number} [pageNo] - Page number. Default is 1.
- * @property {number} [pageSize] - Page size. Default is 12.
- * @property {boolean} [archived] - Archived. Default is false.
- * @property {number} [month] - Month. Default is current month.
- * @property {number} [year] - Year. Default is current year.
- * @property {string} [type] - Basic or custom.
- * @property {string[]} [appIds] - Application ids.
+ * @property {number} [pageNo] - The page number to navigate through the given
+ *   set of results. Default is 1.
+ * @property {number} [pageSize] - Number of items to retrieve in each page.
+ *   Default is 12.
+ * @property {boolean} [archived] - Indicates whether to include expired
+ *   discounts in the results. Defaults to false.
+ * @property {number} [month] - The month for which discounts is requested.
+ *   Defaults to the current month if not specified.
+ * @property {number} [year] - The year for which discounts is requested.
+ *   Defaults to the current year if not specified.
+ * @property {string} [type] - Specifies the type of disocunt to list, either
+ *   'basic' or 'custom'.
+ * @property {string[]} [appIds] - A `application_id` is a unique identifier for
+ *   a particular sales channel.
  */
 
 /**
  * @typedef GetDownloadJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
  * @typedef GetValidationJobParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  */
 
 /**
  * @typedef UpdateDiscountParam
- * @property {string} id - Id
+ * @property {string} id - Unique identifier for the discount.
  * @property {DiscountPlatformModel.CreateUpdateDiscount} body
  */
 
 /**
  * @typedef UpsertDiscountItemsParam
- * @property {string} id - Job ID of the discount.
+ * @property {string} id - Unique identifier for the discount.
  * @property {DiscountPlatformModel.BulkDiscount} body
  */
 
 /**
  * @typedef ValidateDiscountFileParam
- * @property {string} [discount] - Discount
+ * @property {string} [discount] - Unique identifier for the discount.
  * @property {DiscountPlatformModel.FileJobRequestSchema} body
  */