@gofynd/fdk-client-javascript 1.4.2-beta.1 → 1.4.2-beta.3

package/sdk/platform/Discount/DiscountPlatformModel.js

@@ -1,261 +1,226 @@
 const Joi = require("joi");
 
 /**
- * @typedef BadRequestData
- * @property {string} [message]
- */
-
-/**
- * @typedef BadRequestObject
- * @property {string} message
- */
-
-/**
- * @typedef BadRequestObjectGet
- * @property {BadRequestData} [data]
- * @property {string} [error]
- * @property {string} [message]
- */
-
-/**
- * @typedef BulkDiscount
- * @property {number} company_id
- * @property {DiscountItems[]} items
- */
-
-/**
- * @typedef CancelJobResponse
- * @property {boolean} success
+ * @typedef ValidityObject
+ * @property {string} start
+ * @property {string} end
  */
 
 /**
  * @typedef CreateUpdateDiscount
- * @property {string[]} app_ids
- * @property {number[]} [brand_ids]
+ * @property {string} name
  * @property {number} company_id
- * @property {string} discount_level
- * @property {DiscountMeta} [discount_meta]
- * @property {string} discount_type
- * @property {string[]} [extension_ids]
- * @property {string} [file_path]
  * @property {boolean} is_active
+ * @property {string[]} app_ids
+ * @property {string[]} [extension_ids]
  * @property {string} job_type
- * @property {string} name
- * @property {number[]} [store_ids]
- * @property {ValidityObject} validity
+ * @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 {ValidityObject} validity
+ * @property {DiscountMeta} [discount_meta]
  */
 
 /**
- * @typedef DiscountItems
- * @property {string} [brand_name]
- * @property {DiscountMeta} [discount_meta]
- * @property {string} discount_type
- * @property {string} [item_code]
- * @property {string} [seller_identifier]
- * @property {number} value
+ * @typedef DiscountMeta
+ * @property {boolean} timer - Determines whether the discount countdown is
+ *   visible or not.
+ * @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.
  */
 
 /**
  * @typedef DiscountJob
  * @property {string} _id
- * @property {string[]} [app_ids]
- * @property {number[]} [brand_ids]
+ * @property {string} name
  * @property {number} company_id
- * @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
+ * @property {string[]} [app_ids]
  * @property {string} [job_type]
- * @property {Object} [meta]
- * @property {UserDetails} modified_by
- * @property {string} modified_on
- * @property {string} name
+ * @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 {DiscountMeta} [discount_meta]
  * @property {ValidityObject} validity
+ * @property {string} created_on
+ * @property {string} modified_on
+ * @property {UserDetails} created_by
+ * @property {UserDetails} modified_by
+ * @property {Object} [meta]
+ */
+
+/**
+ * @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 {DiscountMeta} [discount_meta]
+ * @property {ValidityObject} [validity]
+ * @property {string} [created_on]
+ * @property {string} [modified_on]
+ * @property {UserDetails} [created_by]
+ * @property {UserDetails} [modified_by]
+ * @property {Object} [meta]
  */
 
 /**
- * @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 ListOrCalender
+ * @property {DiscountJob[]} items
+ * @property {Page} page
  */
 
 /**
- * @typedef DownloadFileJob
- * @property {number[]} [brand_ids]
- * @property {number[]} [store_ids]
+ * @typedef DiscountItems
+ * @property {string} [item_code]
+ * @property {string} [brand_name]
+ * @property {string} [seller_identifier]
+ * @property {string} discount_type
+ * @property {number} value
+ * @property {DiscountMeta} [discount_meta]
  */
 
 /**
- * @typedef FileJobBody
- * @property {string[]} [app_ids]
- * @property {number[]} [brand_ids]
- * @property {number} [company_id]
- * @property {UserDetails} [created_by]
- * @property {string} [created_on]
- * @property {string} [discount_level]
- * @property {DiscountMeta} [discount_meta]
- * @property {string} [discount_type]
- * @property {string[]} [extension_ids]
+ * @typedef BulkDiscount
+ * @property {number} company_id
+ * @property {DiscountItems[]} items
+ */
+
+/**
+ * @typedef FileJobResponse
+ * @property {string} stage
+ * @property {number} total
+ * @property {number} failed
+ * @property {number} company_id
+ * @property {FileJobBody} [body]
+ * @property {string} type
+ * @property {string} [file_type]
+ * @property {string} _id - A unique identifier to distinguish and identify a job.
  * @property {string} [file_path]
- * @property {boolean} [is_active]
- * @property {string} [job_type]
- * @property {Object} [meta]
- * @property {UserDetails} [modified_by]
- * @property {string} [modified_on]
- * @property {string} [name]
- * @property {number[]} [store_ids]
- * @property {ValidityObject} [validity]
- * @property {number} [value]
+ * @property {number} [progress]
+ * @property {string[]} [extension_ids]
  * @property {string[]} [zone_ids]
+ * @property {string} [created_on]
+ * @property {string} [modified_on]
+ * @property {UserDetails} [created_by]
  */
 
 /**
  * @typedef FileJobRequest
- * @property {string[]} [app_ids]
- * @property {number[]} [brand_ids]
+ * @property {string} name
+ * @property {boolean} is_active
  * @property {number} company_id
- * @property {string} [discount_level]
+ * @property {string[]} [app_ids]
+ * @property {string} [job_type]
  * @property {string} [discount_type]
+ * @property {string} [discount_level]
  * @property {string} [file_path]
- * @property {boolean} is_active
- * @property {string} [job_type]
- * @property {Object} [meta]
- * @property {string} name
+ * @property {number[]} [brand_ids]
  * @property {number[]} [store_ids]
  * @property {ValidityObject} validity
+ * @property {Object} [meta]
  */
 
 /**
- * @typedef FileJobResponse
- * @property {string} _id - A unique identifier to distinguish and identify a job.
- * @property {FileJobBody} [body]
- * @property {number} company_id
- * @property {UserDetails} [created_by]
- * @property {string} [created_on]
- * @property {string[]} [extension_ids]
- * @property {number} failed
- * @property {string} [file_path]
- * @property {string} [file_type]
- * @property {string} [modified_on]
- * @property {number} [progress]
- * @property {string} stage
- * @property {number} total
- * @property {string} type
- * @property {string[]} [zone_ids]
+ * @typedef DownloadFileJob
+ * @property {number[]} [brand_ids]
+ * @property {number[]} [store_ids]
  */
 
 /**
- * @typedef ListOrCalender
- * @property {DiscountJob[]} items
- * @property {Page} page
+ * @typedef CancelJobResponse
+ * @property {boolean} success
  */
 
 /**
  * @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 {boolean} [has_previous]
+ * @property {boolean} [has_next]
+ * @property {number} [current]
  * @property {string} type
+ * @property {number} [size]
  */
 
 /**
  * @typedef UserDetails
- * @property {string} user_id
  * @property {string} username
+ * @property {string} user_id
  */
 
 /**
- * @typedef ValidityObject
- * @property {string} end
- * @property {string} start
+ * @typedef BadRequestObject
+ * @property {string} message
  */
 
-class DiscountPlatformModel {
-  /** @returns {BadRequestData} */
-  static BadRequestData() {
-    return Joi.object({
-      message: Joi.string().allow(""),
-    });
-  }
-
-  /** @returns {BadRequestObject} */
-  static BadRequestObject() {
-    return Joi.object({
-      message: Joi.string().allow("").required(),
-    });
-  }
-
-  /** @returns {BadRequestObjectGet} */
-  static BadRequestObjectGet() {
-    return Joi.object({
-      data: DiscountPlatformModel.BadRequestData(),
-      error: Joi.string().allow(""),
-      message: Joi.string().allow(""),
-    });
-  }
+/**
+ * @typedef BadRequestData
+ * @property {string} [message]
+ */
 
-  /** @returns {BulkDiscount} */
-  static BulkDiscount() {
-    return Joi.object({
-      company_id: Joi.number().required(),
-      items: Joi.array()
-        .items(DiscountPlatformModel.DiscountItems())
-        .required(),
-    });
-  }
+/**
+ * @typedef BadRequestObjectGet
+ * @property {string} [message]
+ * @property {string} [error]
+ * @property {BadRequestData} [data]
+ */
 
-  /** @returns {CancelJobResponse} */
-  static CancelJobResponse() {
+class DiscountPlatformModel {
+  /** @returns {ValidityObject} */
+  static ValidityObject() {
     return Joi.object({
-      success: Joi.boolean().required(),
+      start: Joi.string().allow("").required(),
+      end: Joi.string().allow("").required(),
     });
   }
 
   /** @returns {CreateUpdateDiscount} */
   static CreateUpdateDiscount() {
     return Joi.object({
-      app_ids: Joi.array().items(Joi.string().allow("")).required(),
-      brand_ids: Joi.array().items(Joi.number()),
+      name: Joi.string().allow("").required(),
       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("")),
-      file_path: Joi.string().allow(""),
       is_active: Joi.boolean().required(),
+      app_ids: Joi.array().items(Joi.string().allow("")).required(),
+      extension_ids: Joi.array().items(Joi.string().allow("")),
       job_type: Joi.string().allow("").required(),
-      name: Joi.string().allow("").required(),
-      store_ids: Joi.array().items(Joi.number()),
-      validity: DiscountPlatformModel.ValidityObject().required(),
+      discount_type: Joi.string().allow("").required(),
+      discount_level: Joi.string().allow("").required(),
       value: Joi.number(),
+      file_path: Joi.string().allow(""),
+      brand_ids: Joi.array().items(Joi.number()),
+      store_ids: Joi.array().items(Joi.number()),
       zone_ids: Joi.array().items(Joi.string().allow("")),
+      validity: DiscountPlatformModel.ValidityObject().required(),
+      discount_meta: DiscountPlatformModel.DiscountMeta(),
     });
   }
 
-  /** @returns {DiscountItems} */
-  static DiscountItems() {
+  /** @returns {DiscountMeta} */
+  static DiscountMeta() {
     return Joi.object({
-      brand_name: Joi.string().allow(""),
-      discount_meta: DiscountPlatformModel.DiscountMeta(),
-      discount_type: Joi.string().allow("").required(),
-      item_code: Joi.string().allow(""),
-      seller_identifier: Joi.string().allow(""),
-      value: Joi.number().required(),
+      timer: Joi.boolean().required(),
+      hours: Joi.number(),
+      minutes: Joi.number(),
     });
   }
 
@@ -263,144 +228,179 @@ class DiscountPlatformModel {
   static DiscountJob() {
     return Joi.object({
       _id: Joi.string().allow("").required(),
-      app_ids: Joi.array().items(Joi.string().allow("")),
-      brand_ids: Joi.array().items(Joi.number()),
+      name: Joi.string().allow("").required(),
       company_id: Joi.number().required(),
-      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(),
+      app_ids: Joi.array().items(Joi.string().allow("")),
       job_type: Joi.string().allow(""),
-      meta: Joi.any(),
-      modified_by: DiscountPlatformModel.UserDetails().required(),
-      modified_on: Joi.string().allow("").required(),
-      name: Joi.string().allow("").required(),
+      discount_type: Joi.string().allow(""),
+      discount_level: Joi.string().allow(""),
+      value: Joi.number(),
+      file_path: Joi.string().allow(""),
+      brand_ids: Joi.array().items(Joi.number()),
       store_ids: Joi.array().items(Joi.number()),
+      zone_ids: Joi.array().items(Joi.string().allow("")),
+      discount_meta: DiscountPlatformModel.DiscountMeta(),
       validity: DiscountPlatformModel.ValidityObject().required(),
+      created_on: Joi.string().allow("").required(),
+      modified_on: Joi.string().allow("").required(),
+      created_by: DiscountPlatformModel.UserDetails().required(),
+      modified_by: DiscountPlatformModel.UserDetails().required(),
+      meta: Joi.any(),
+    });
+  }
+
+  /** @returns {FileJobBody} */
+  static FileJobBody() {
+    return Joi.object({
+      name: Joi.string().allow(""),
+      company_id: Joi.number(),
+      is_active: Joi.boolean(),
+      app_ids: Joi.array().items(Joi.string().allow("")),
+      job_type: Joi.string().allow(""),
+      discount_type: Joi.string().allow(""),
+      discount_level: Joi.string().allow(""),
       value: Joi.number(),
+      file_path: Joi.string().allow(""),
+      brand_ids: Joi.array().items(Joi.number()),
+      store_ids: Joi.array().items(Joi.number()),
+      extension_ids: Joi.array().items(Joi.string().allow("")),
       zone_ids: Joi.array().items(Joi.string().allow("")),
+      discount_meta: DiscountPlatformModel.DiscountMeta(),
+      validity: DiscountPlatformModel.ValidityObject(),
+      created_on: Joi.string().allow(""),
+      modified_on: Joi.string().allow(""),
+      created_by: DiscountPlatformModel.UserDetails(),
+      modified_by: DiscountPlatformModel.UserDetails(),
+      meta: Joi.any(),
     });
   }
 
-  /** @returns {DiscountMeta} */
-  static DiscountMeta() {
+  /** @returns {ListOrCalender} */
+  static ListOrCalender() {
     return Joi.object({
-      hours: Joi.number(),
-      minutes: Joi.number(),
-      timer: Joi.boolean().required(),
+      items: Joi.array().items(DiscountPlatformModel.DiscountJob()).required(),
+      page: DiscountPlatformModel.Page().required(),
     });
   }
 
-  /** @returns {DownloadFileJob} */
-  static DownloadFileJob() {
+  /** @returns {DiscountItems} */
+  static DiscountItems() {
     return Joi.object({
-      brand_ids: Joi.array().items(Joi.number()),
-      store_ids: Joi.array().items(Joi.number()),
+      item_code: Joi.string().allow(""),
+      brand_name: Joi.string().allow(""),
+      seller_identifier: Joi.string().allow(""),
+      discount_type: Joi.string().allow("").required(),
+      value: Joi.number().required(),
+      discount_meta: DiscountPlatformModel.DiscountMeta(),
     });
   }
 
-  /** @returns {FileJobBody} */
-  static FileJobBody() {
+  /** @returns {BulkDiscount} */
+  static BulkDiscount() {
     return Joi.object({
-      app_ids: Joi.array().items(Joi.string().allow("")),
-      brand_ids: Joi.array().items(Joi.number()),
-      company_id: Joi.number(),
-      created_by: DiscountPlatformModel.UserDetails(),
-      created_on: Joi.string().allow(""),
-      discount_level: Joi.string().allow(""),
-      discount_meta: DiscountPlatformModel.DiscountMeta(),
-      discount_type: Joi.string().allow(""),
-      extension_ids: Joi.array().items(Joi.string().allow("")),
+      company_id: Joi.number().required(),
+      items: Joi.array()
+        .items(DiscountPlatformModel.DiscountItems())
+        .required(),
+    });
+  }
+
+  /** @returns {FileJobResponse} */
+  static FileJobResponse() {
+    return Joi.object({
+      stage: Joi.string().allow("").required(),
+      total: Joi.number().required(),
+      failed: Joi.number().required(),
+      company_id: Joi.number().required(),
+      body: DiscountPlatformModel.FileJobBody(),
+      type: Joi.string().allow("").required(),
+      file_type: Joi.string().allow(""),
+      _id: Joi.string().allow("").required(),
       file_path: Joi.string().allow(""),
-      is_active: Joi.boolean(),
-      job_type: Joi.string().allow(""),
-      meta: Joi.any(),
-      modified_by: DiscountPlatformModel.UserDetails(),
-      modified_on: Joi.string().allow(""),
-      name: Joi.string().allow(""),
-      store_ids: Joi.array().items(Joi.number()),
-      validity: DiscountPlatformModel.ValidityObject(),
-      value: Joi.number(),
+      progress: Joi.number(),
+      extension_ids: Joi.array().items(Joi.string().allow("")),
       zone_ids: Joi.array().items(Joi.string().allow("")),
+      created_on: Joi.string().allow(""),
+      modified_on: Joi.string().allow(""),
+      created_by: DiscountPlatformModel.UserDetails(),
     });
   }
 
   /** @returns {FileJobRequest} */
   static FileJobRequest() {
     return Joi.object({
-      app_ids: Joi.array().items(Joi.string().allow("")),
-      brand_ids: Joi.array().items(Joi.number()),
+      name: Joi.string().allow("").required(),
+      is_active: Joi.boolean().required(),
       company_id: Joi.number().required(),
-      discount_level: Joi.string().allow(""),
+      app_ids: Joi.array().items(Joi.string().allow("")),
+      job_type: Joi.string().allow(""),
       discount_type: Joi.string().allow(""),
+      discount_level: Joi.string().allow(""),
       file_path: Joi.string().allow(""),
-      is_active: Joi.boolean().required(),
-      job_type: Joi.string().allow(""),
-      meta: Joi.any(),
-      name: Joi.string().allow("").required(),
+      brand_ids: Joi.array().items(Joi.number()),
       store_ids: Joi.array().items(Joi.number()),
       validity: DiscountPlatformModel.ValidityObject().required(),
+      meta: Joi.any(),
     });
   }
 
-  /** @returns {FileJobResponse} */
-  static FileJobResponse() {
+  /** @returns {DownloadFileJob} */
+  static DownloadFileJob() {
     return Joi.object({
-      _id: Joi.string().allow("").required(),
-      body: DiscountPlatformModel.FileJobBody(),
-      company_id: Joi.number().required(),
-      created_by: DiscountPlatformModel.UserDetails(),
-      created_on: Joi.string().allow(""),
-      extension_ids: Joi.array().items(Joi.string().allow("")),
-      failed: Joi.number().required(),
-      file_path: Joi.string().allow(""),
-      file_type: Joi.string().allow(""),
-      modified_on: Joi.string().allow(""),
-      progress: Joi.number(),
-      stage: Joi.string().allow("").required(),
-      total: Joi.number().required(),
-      type: Joi.string().allow("").required(),
-      zone_ids: Joi.array().items(Joi.string().allow("")),
+      brand_ids: Joi.array().items(Joi.number()),
+      store_ids: Joi.array().items(Joi.number()),
     });
   }
 
-  /** @returns {ListOrCalender} */
-  static ListOrCalender() {
+  /** @returns {CancelJobResponse} */
+  static CancelJobResponse() {
     return Joi.object({
-      items: Joi.array().items(DiscountPlatformModel.DiscountJob()).required(),
-      page: DiscountPlatformModel.Page().required(),
+      success: Joi.boolean().required(),
     });
   }
 
   /** @returns {Page} */
   static Page() {
     return Joi.object({
-      current: Joi.number(),
-      has_next: Joi.boolean(),
-      has_previous: Joi.boolean(),
       item_total: Joi.number(),
       next_id: Joi.string().allow(""),
-      size: Joi.number(),
+      has_previous: Joi.boolean(),
+      has_next: Joi.boolean(),
+      current: Joi.number(),
       type: Joi.string().allow("").required(),
+      size: Joi.number(),
     });
   }
 
   /** @returns {UserDetails} */
   static UserDetails() {
     return Joi.object({
-      user_id: Joi.string().allow("").required(),
       username: Joi.string().allow("").required(),
+      user_id: Joi.string().allow("").required(),
     });
   }
 
-  /** @returns {ValidityObject} */
-  static ValidityObject() {
+  /** @returns {BadRequestObject} */
+  static BadRequestObject() {
     return Joi.object({
-      end: Joi.string().allow("").required(),
-      start: Joi.string().allow("").required(),
+      message: Joi.string().allow("").required(),
+    });
+  }
+
+  /** @returns {BadRequestData} */
+  static BadRequestData() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+    });
+  }
+
+  /** @returns {BadRequestObjectGet} */
+  static BadRequestObjectGet() {
+    return Joi.object({
+      message: Joi.string().allow(""),
+      error: Joi.string().allow(""),
+      data: DiscountPlatformModel.BadRequestData(),
     });
   }
 }