@gofynd/fdk-client-javascript 1.1.6 → 1.3.0

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

@@ -1,16 +1,282 @@
-export = DiscountModel;
-declare class DiscountModel {
-    static BadRequestObject(): any;
-    static BulkDiscount(): any;
-    static CancelJobResponse(): any;
-    static CreateUpdateDiscount(): any;
-    static DiscountItems(): any;
-    static DiscountJob(): any;
-    static DownloadFileJob(): any;
-    static FileJobRequest(): any;
-    static FileJobResponse(): any;
-    static ListOrCalender(): any;
-    static Page(): any;
-    static UserDetails(): any;
-    static ValidityObject(): any;
+export = DiscountPlatformModel;
+/**
+ * @typedef BadRequestObject
+ * @property {string} message
+ */
+/**
+ * @typedef BulkDiscount
+ * @property {number} company_id
+ * @property {DiscountItems[]} items
+ */
+/**
+ * @typedef CancelJobResponse
+ * @property {boolean} success
+ */
+/**
+ * @typedef CreateUpdateDiscount
+ * @property {string[]} app_ids
+ * @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]
+ * @property {boolean} is_active
+ * @property {string} job_type
+ * @property {string} name
+ * @property {number[]} [store_ids]
+ * @property {ValidityObject} validity
+ * @property {number} [value]
+ */
+/**
+ * @typedef DiscountItems
+ * @property {number} [brand_uid]
+ * @property {DiscountMeta} [discount_meta]
+ * @property {string} discount_type
+ * @property {string} [item_code]
+ * @property {string} [seller_identifier]
+ * @property {number} value
+ */
+/**
+ * @typedef DiscountJob
+ * @property {string} _id
+ * @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} [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]
+ */
+/**
+ * @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]
+ * @property {number[]} [store_ids]
+ */
+/**
+ * @typedef FileJobRequest
+ * @property {string[]} [app_ids]
+ * @property {number[]} [brand_ids]
+ * @property {string} [discount_level]
+ * @property {string} [discount_type]
+ * @property {string} [file_path]
+ * @property {boolean} is_active
+ * @property {string} [job_type]
+ * @property {Object} [meta]
+ * @property {string} name
+ * @property {number[]} [store_ids]
+ * @property {ValidityObject} validity
+ */
+/**
+ * @typedef FileJobResponse
+ * @property {string} _id - A unique identifier to distinguish and identify a job.
+ * @property {Object} [body]
+ * @property {number} company_id
+ * @property {number} failed
+ * @property {string} file_type
+ * @property {string} stage
+ * @property {number} total
+ * @property {string} type
+ */
+/**
+ * @typedef ListOrCalender
+ * @property {DiscountJob[]} items
+ * @property {Page} page
+ */
+/**
+ * @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 {string} type
+ */
+/**
+ * @typedef UserDetails
+ * @property {string} user_id
+ * @property {string} username
+ */
+/**
+ * @typedef ValidityObject
+ * @property {string} end
+ * @property {string} start
+ */
+declare class DiscountPlatformModel {
 }
+declare namespace DiscountPlatformModel {
+    export { BadRequestObject, BulkDiscount, CancelJobResponse, CreateUpdateDiscount, DiscountItems, DiscountJob, DiscountMeta, DownloadFileJob, FileJobRequest, FileJobResponse, ListOrCalender, Page, UserDetails, ValidityObject };
+}
+/** @returns {BadRequestObject} */
+declare function BadRequestObject(): BadRequestObject;
+type BadRequestObject = {
+    message: string;
+};
+/** @returns {BulkDiscount} */
+declare function BulkDiscount(): BulkDiscount;
+type BulkDiscount = {
+    company_id: number;
+    items: DiscountItems[];
+};
+/** @returns {CancelJobResponse} */
+declare function CancelJobResponse(): CancelJobResponse;
+type CancelJobResponse = {
+    success: boolean;
+};
+/** @returns {CreateUpdateDiscount} */
+declare function CreateUpdateDiscount(): CreateUpdateDiscount;
+type CreateUpdateDiscount = {
+    app_ids: string[];
+    brand_ids?: number[];
+    company_id: number;
+    discount_level: string;
+    discount_meta?: DiscountMeta;
+    discount_type: string;
+    extension_ids: string[];
+    file_path?: string;
+    is_active: boolean;
+    job_type: string;
+    name: string;
+    store_ids?: number[];
+    validity: ValidityObject;
+    value?: number;
+};
+/** @returns {DiscountItems} */
+declare function DiscountItems(): DiscountItems;
+type DiscountItems = {
+    brand_uid?: number;
+    discount_meta?: DiscountMeta;
+    discount_type: string;
+    item_code?: string;
+    seller_identifier?: string;
+    value: number;
+};
+/** @returns {DiscountJob} */
+declare function DiscountJob(): DiscountJob;
+type DiscountJob = {
+    _id: string;
+    app_ids?: string[];
+    brand_ids?: number[];
+    company_id: number;
+    created_by: UserDetails;
+    created_on: string;
+    discount_level?: string;
+    discount_meta?: DiscountMeta;
+    discount_type?: string;
+    file_path?: string;
+    is_active: boolean;
+    job_type?: string;
+    meta?: any;
+    modified_by: UserDetails;
+    modified_on: string;
+    name: string;
+    store_ids?: number[];
+    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 = {
+    brand_ids?: number[];
+    store_ids?: number[];
+};
+/** @returns {FileJobRequest} */
+declare function FileJobRequest(): FileJobRequest;
+type FileJobRequest = {
+    app_ids?: string[];
+    brand_ids?: number[];
+    discount_level?: string;
+    discount_type?: string;
+    file_path?: string;
+    is_active: boolean;
+    job_type?: string;
+    meta?: any;
+    name: string;
+    store_ids?: number[];
+    validity: ValidityObject;
+};
+/** @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;
+    file_type: string;
+    stage: string;
+    total: number;
+    type: string;
+};
+/** @returns {ListOrCalender} */
+declare function ListOrCalender(): ListOrCalender;
+type ListOrCalender = {
+    items: DiscountJob[];
+    page: Page;
+};
+/** @returns {Page} */
+declare function Page(): Page;
+type Page = {
+    current?: number;
+    has_next?: boolean;
+    has_previous?: boolean;
+    item_total?: number;
+    next_id?: string;
+    size?: number;
+    type: string;
+};
+/** @returns {UserDetails} */
+declare function UserDetails(): UserDetails;
+type UserDetails = {
+    user_id: string;
+    username: string;
+};
+/** @returns {ValidityObject} */
+declare function ValidityObject(): ValidityObject;
+type ValidityObject = {
+    end: string;
+    start: string;
+};

package/sdk/platform/Discount/DiscountPlatformModel.js

@@ -1,28 +1,177 @@
 const Joi = require("joi");
 
-class DiscountModel {
+/**
+ * @typedef BadRequestObject
+ * @property {string} message
+ */
+
+/**
+ * @typedef BulkDiscount
+ * @property {number} company_id
+ * @property {DiscountItems[]} items
+ */
+
+/**
+ * @typedef CancelJobResponse
+ * @property {boolean} success
+ */
+
+/**
+ * @typedef CreateUpdateDiscount
+ * @property {string[]} app_ids
+ * @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]
+ * @property {boolean} is_active
+ * @property {string} job_type
+ * @property {string} name
+ * @property {number[]} [store_ids]
+ * @property {ValidityObject} validity
+ * @property {number} [value]
+ */
+
+/**
+ * @typedef DiscountItems
+ * @property {number} [brand_uid]
+ * @property {DiscountMeta} [discount_meta]
+ * @property {string} discount_type
+ * @property {string} [item_code]
+ * @property {string} [seller_identifier]
+ * @property {number} value
+ */
+
+/**
+ * @typedef DiscountJob
+ * @property {string} _id
+ * @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} [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]
+ */
+
+/**
+ * @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]
+ * @property {number[]} [store_ids]
+ */
+
+/**
+ * @typedef FileJobRequest
+ * @property {string[]} [app_ids]
+ * @property {number[]} [brand_ids]
+ * @property {string} [discount_level]
+ * @property {string} [discount_type]
+ * @property {string} [file_path]
+ * @property {boolean} is_active
+ * @property {string} [job_type]
+ * @property {Object} [meta]
+ * @property {string} name
+ * @property {number[]} [store_ids]
+ * @property {ValidityObject} validity
+ */
+
+/**
+ * @typedef FileJobResponse
+ * @property {string} _id - A unique identifier to distinguish and identify a job.
+ * @property {Object} [body]
+ * @property {number} company_id
+ * @property {number} failed
+ * @property {string} file_type
+ * @property {string} stage
+ * @property {number} total
+ * @property {string} type
+ */
+
+/**
+ * @typedef ListOrCalender
+ * @property {DiscountJob[]} items
+ * @property {Page} page
+ */
+
+/**
+ * @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 {string} type
+ */
+
+/**
+ * @typedef UserDetails
+ * @property {string} user_id
+ * @property {string} username
+ */
+
+/**
+ * @typedef ValidityObject
+ * @property {string} end
+ * @property {string} start
+ */
+
+class DiscountPlatformModel {
+  /** @returns {BadRequestObject} */
   static BadRequestObject() {
     return Joi.object({
       message: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {BulkDiscount} */
   static BulkDiscount() {
     return Joi.object({
       company_id: Joi.number().required(),
-      items: Joi.array().items(DiscountModel.DiscountItems()).required(),
+      items: Joi.array()
+        .items(DiscountPlatformModel.DiscountItems())
+        .required(),
     });
   }
+
+  /** @returns {CancelJobResponse} */
   static CancelJobResponse() {
     return Joi.object({
       success: Joi.boolean().required(),
     });
   }
+
+  /** @returns {CreateUpdateDiscount} */
   static CreateUpdateDiscount() {
     return Joi.object({
       app_ids: Joi.array().items(Joi.string().allow("")).required(),
       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(""),
@@ -30,47 +179,66 @@ class DiscountModel {
       job_type: Joi.string().allow("").required(),
       name: Joi.string().allow("").required(),
       store_ids: Joi.array().items(Joi.number()),
-      validity: DiscountModel.ValidityObject().required(),
+      validity: DiscountPlatformModel.ValidityObject().required(),
       value: Joi.number(),
     });
   }
+
+  /** @returns {DiscountItems} */
   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(""),
       value: Joi.number().required(),
     });
   }
+
+  /** @returns {DiscountJob} */
   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()),
       company_id: Joi.number().required(),
-      created_by: DiscountModel.UserDetails().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(),
       job_type: Joi.string().allow(""),
       meta: Joi.any(),
-      modified_by: DiscountModel.UserDetails().required(),
+      modified_by: DiscountPlatformModel.UserDetails().required(),
       modified_on: Joi.string().allow("").required(),
       name: Joi.string().allow("").required(),
       store_ids: Joi.array().items(Joi.number()),
-      validity: DiscountModel.ValidityObject().required(),
+      validity: DiscountPlatformModel.ValidityObject().required(),
       value: Joi.number(),
     });
   }
+
+  /** @returns {DiscountMeta} */
+  static DiscountMeta() {
+    return Joi.object({
+      hours: Joi.number(),
+      minutes: Joi.number(),
+      timer: Joi.boolean().required(),
+    });
+  }
+
+  /** @returns {DownloadFileJob} */
   static DownloadFileJob() {
     return Joi.object({
       brand_ids: Joi.array().items(Joi.number()),
       store_ids: Joi.array().items(Joi.number()),
     });
   }
+
+  /** @returns {FileJobRequest} */
   static FileJobRequest() {
     return Joi.object({
       app_ids: Joi.array().items(Joi.string().allow("")),
@@ -83,11 +251,14 @@ class DiscountModel {
       meta: Joi.any(),
       name: Joi.string().allow("").required(),
       store_ids: Joi.array().items(Joi.number()),
-      validity: DiscountModel.ValidityObject().required(),
+      validity: DiscountPlatformModel.ValidityObject().required(),
     });
   }
+
+  /** @returns {FileJobResponse} */
   static FileJobResponse() {
     return Joi.object({
+      _id: Joi.string().allow("").required(),
       body: Joi.any(),
       company_id: Joi.number().required(),
       failed: Joi.number().required(),
@@ -97,12 +268,16 @@ class DiscountModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ListOrCalender} */
   static ListOrCalender() {
     return Joi.object({
-      items: Joi.array().items(DiscountModel.DiscountJob()).required(),
-      page: DiscountModel.Page().required(),
+      items: Joi.array().items(DiscountPlatformModel.DiscountJob()).required(),
+      page: DiscountPlatformModel.Page().required(),
     });
   }
+
+  /** @returns {Page} */
   static Page() {
     return Joi.object({
       current: Joi.number(),
@@ -114,12 +289,16 @@ class DiscountModel {
       type: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {UserDetails} */
   static UserDetails() {
     return Joi.object({
       user_id: Joi.string().allow("").required(),
       username: Joi.string().allow("").required(),
     });
   }
+
+  /** @returns {ValidityObject} */
   static ValidityObject() {
     return Joi.object({
       end: Joi.string().allow("").required(),
@@ -127,4 +306,4 @@ class DiscountModel {
     });
   }
 }
-module.exports = DiscountModel;
+module.exports = DiscountPlatformModel;