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

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

@@ -1,261 +1,210 @@
 export = DiscountPlatformModel;
 /**
- * @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 {number} [value]
- * @property {string[]} [zone_ids]
- */
-/**
- * @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 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} discount_level
+ * @property {number} [value]
  * @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[]} [brand_ids]
  * @property {number[]} [store_ids]
- * @property {ValidityObject} validity
- * @property {number} [value]
  * @property {string[]} [zone_ids]
+ * @property {ValidityObject} validity
+ * @property {DiscountMeta} [discount_meta]
  */
 /**
  * @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.
- * @property {boolean} timer - Determines whether the discount countdown is
- *   visible or not.
  */
 /**
- * @typedef DownloadFileJob
+ * @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 {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[]} [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[]} [extension_ids]
- * @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[]} [extension_ids]
+ * @property {string[]} [zone_ids]
+ * @property {DiscountMeta} [discount_meta]
  * @property {ValidityObject} [validity]
- * @property {number} [value]
+ * @property {string} [created_on]
+ * @property {string} [modified_on]
+ * @property {UserDetails} [created_by]
+ * @property {UserDetails} [modified_by]
+ * @property {Object} [meta]
+ */
+/**
+ * @typedef ListOrCalender
+ * @property {DiscountJob[]} items
+ * @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 {DiscountMeta} [discount_meta]
+ */
+/**
+ * @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 {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
+ */
+/**
+ * @typedef BadRequestData
+ * @property {string} [message]
+ */
+/**
+ * @typedef BadRequestObjectGet
+ * @property {string} [message]
+ * @property {string} [error]
+ * @property {BadRequestData} [data]
  */
 declare class DiscountPlatformModel {
 }
 declare namespace DiscountPlatformModel {
-    export { BadRequestData, BadRequestObject, BadRequestObjectGet, BulkDiscount, CancelJobResponse, CreateUpdateDiscount, DiscountItems, DiscountJob, DiscountMeta, DownloadFileJob, FileJobBody, FileJobRequest, FileJobResponse, ListOrCalender, Page, UserDetails, ValidityObject };
+    export { ValidityObject, CreateUpdateDiscount, DiscountMeta, DiscountJob, FileJobBody, ListOrCalender, DiscountItems, BulkDiscount, FileJobResponse, FileJobRequest, DownloadFileJob, CancelJobResponse, Page, UserDetails, BadRequestObject, BadRequestData, BadRequestObjectGet };
 }
-/** @returns {BadRequestData} */
-declare function BadRequestData(): BadRequestData;
-type BadRequestData = {
-    message?: string;
-};
-/** @returns {BadRequestObject} */
-declare function BadRequestObject(): BadRequestObject;
-type BadRequestObject = {
-    message: string;
-};
-/** @returns {BadRequestObjectGet} */
-declare function BadRequestObjectGet(): BadRequestObjectGet;
-type BadRequestObjectGet = {
-    data?: BadRequestData;
-    error?: string;
-    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 {ValidityObject} */
+declare function ValidityObject(): ValidityObject;
+type ValidityObject = {
+    start: string;
+    end: string;
 };
 /** @returns {CreateUpdateDiscount} */
 declare function CreateUpdateDiscount(): CreateUpdateDiscount;
 type CreateUpdateDiscount = {
-    app_ids: string[];
-    brand_ids?: number[];
+    name: string;
     company_id: number;
-    discount_level: string;
-    discount_meta?: DiscountMeta;
-    discount_type: string;
-    extension_ids?: string[];
-    file_path?: string;
     is_active: boolean;
+    app_ids: string[];
+    extension_ids?: string[];
     job_type: string;
-    name: string;
-    store_ids?: number[];
-    validity: ValidityObject;
-    value?: number;
-    zone_ids?: string[];
-};
-/** @returns {DiscountItems} */
-declare function DiscountItems(): DiscountItems;
-type DiscountItems = {
-    brand_name?: string;
-    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;
+    discount_level: string;
+    value?: number;
     file_path?: string;
-    is_active: boolean;
-    job_type?: string;
-    meta?: any;
-    modified_by: UserDetails;
-    modified_on: string;
-    name: string;
+    brand_ids?: number[];
     store_ids?: number[];
-    validity: ValidityObject;
-    value?: number;
     zone_ids?: string[];
+    validity: ValidityObject;
+    discount_meta?: DiscountMeta;
 };
 /** @returns {DiscountMeta} */
 declare function DiscountMeta(): DiscountMeta;
 type DiscountMeta = {
+    /**
+     * - Determines whether the discount countdown is
+     * visible or not.
+     */
+    timer: boolean;
     /**
      * - The time in hours before the discount ends when
      * the countdown timer should start.
@@ -266,106 +215,157 @@ type DiscountMeta = {
      * 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 = {
+/** @returns {DiscountJob} */
+declare function DiscountJob(): DiscountJob;
+type DiscountJob = {
+    _id: string;
+    name: string;
+    company_id: number;
+    is_active: boolean;
+    app_ids?: string[];
+    job_type?: string;
+    discount_type?: string;
+    discount_level?: string;
+    value?: number;
+    file_path?: string;
     brand_ids?: number[];
     store_ids?: number[];
+    zone_ids?: string[];
+    discount_meta?: DiscountMeta;
+    validity: ValidityObject;
+    created_on: string;
+    modified_on: string;
+    created_by: UserDetails;
+    modified_by: UserDetails;
+    meta?: any;
 };
 /** @returns {FileJobBody} */
 declare function FileJobBody(): FileJobBody;
 type FileJobBody = {
-    app_ids?: string[];
-    brand_ids?: number[];
+    name?: string;
     company_id?: number;
-    created_by?: UserDetails;
-    created_on?: string;
-    discount_level?: string;
-    discount_meta?: DiscountMeta;
-    discount_type?: string;
-    extension_ids?: string[];
-    file_path?: string;
     is_active?: boolean;
+    app_ids?: string[];
     job_type?: string;
-    meta?: any;
-    modified_by?: UserDetails;
-    modified_on?: string;
-    name?: string;
-    store_ids?: number[];
-    validity?: ValidityObject;
+    discount_type?: string;
+    discount_level?: string;
     value?: number;
+    file_path?: string;
+    brand_ids?: number[];
+    store_ids?: number[];
+    extension_ids?: string[];
     zone_ids?: string[];
+    discount_meta?: DiscountMeta;
+    validity?: ValidityObject;
+    created_on?: string;
+    modified_on?: string;
+    created_by?: UserDetails;
+    modified_by?: UserDetails;
+    meta?: any;
 };
-/** @returns {FileJobRequest} */
-declare function FileJobRequest(): FileJobRequest;
-type FileJobRequest = {
-    app_ids?: string[];
-    brand_ids?: number[];
+/** @returns {ListOrCalender} */
+declare function ListOrCalender(): ListOrCalender;
+type ListOrCalender = {
+    items: DiscountJob[];
+    page: Page;
+};
+/** @returns {DiscountItems} */
+declare function DiscountItems(): DiscountItems;
+type DiscountItems = {
+    item_code?: string;
+    brand_name?: string;
+    seller_identifier?: string;
+    discount_type: string;
+    value: number;
+    discount_meta?: DiscountMeta;
+};
+/** @returns {BulkDiscount} */
+declare function BulkDiscount(): BulkDiscount;
+type BulkDiscount = {
     company_id: 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;
+    items: DiscountItems[];
 };
 /** @returns {FileJobResponse} */
 declare function FileJobResponse(): FileJobResponse;
 type FileJobResponse = {
+    stage: string;
+    total: number;
+    failed: number;
+    company_id: number;
+    body?: FileJobBody;
+    type: string;
+    file_type?: string;
     /**
      * - A unique identifier to distinguish and identify a job.
      */
     _id: string;
-    body?: FileJobBody;
-    company_id: number;
-    created_by?: UserDetails;
-    created_on?: string;
-    extension_ids?: string[];
-    failed: number;
     file_path?: string;
-    file_type?: string;
-    modified_on?: string;
     progress?: number;
-    stage: string;
-    total: number;
-    type: string;
+    extension_ids?: string[];
     zone_ids?: string[];
+    created_on?: string;
+    modified_on?: string;
+    created_by?: UserDetails;
 };
-/** @returns {ListOrCalender} */
-declare function ListOrCalender(): ListOrCalender;
-type ListOrCalender = {
-    items: DiscountJob[];
-    page: Page;
+/** @returns {FileJobRequest} */
+declare function FileJobRequest(): FileJobRequest;
+type FileJobRequest = {
+    name: string;
+    is_active: boolean;
+    company_id: number;
+    app_ids?: string[];
+    job_type?: string;
+    discount_type?: string;
+    discount_level?: string;
+    file_path?: string;
+    brand_ids?: number[];
+    store_ids?: number[];
+    validity: ValidityObject;
+    meta?: any;
+};
+/** @returns {DownloadFileJob} */
+declare function DownloadFileJob(): DownloadFileJob;
+type DownloadFileJob = {
+    brand_ids?: number[];
+    store_ids?: number[];
+};
+/** @returns {CancelJobResponse} */
+declare function CancelJobResponse(): CancelJobResponse;
+type CancelJobResponse = {
+    success: boolean;
 };
 /** @returns {Page} */
 declare function Page(): Page;
 type Page = {
-    current?: number;
-    has_next?: boolean;
-    has_previous?: boolean;
     item_total?: number;
     next_id?: string;
-    size?: number;
+    has_previous?: boolean;
+    has_next?: boolean;
+    current?: number;
     type: string;
+    size?: number;
 };
 /** @returns {UserDetails} */
 declare function UserDetails(): UserDetails;
 type UserDetails = {
-    user_id: string;
     username: string;
+    user_id: string;
 };
-/** @returns {ValidityObject} */
-declare function ValidityObject(): ValidityObject;
-type ValidityObject = {
-    end: string;
-    start: string;
+/** @returns {BadRequestObject} */
+declare function BadRequestObject(): BadRequestObject;
+type BadRequestObject = {
+    message: string;
+};
+/** @returns {BadRequestData} */
+declare function BadRequestData(): BadRequestData;
+type BadRequestData = {
+    message?: string;
+};
+/** @returns {BadRequestObjectGet} */
+declare function BadRequestObjectGet(): BadRequestObjectGet;
+type BadRequestObjectGet = {
+    message?: string;
+    error?: string;
+    data?: BadRequestData;
 };