@gofynd/fdk-client-javascript 1.0.1 → 1.0.3

package/documentation/platform/DISCOUNT.md

@@ -8,17 +8,17 @@
 ## Discount Methods
 Discount
 
-* [getDiscounts](#getdiscounts)
+* [cancelDownloadJob](#canceldownloadjob)
+* [cancelValidationJob](#cancelvalidationjob)
 * [createDiscount](#creatediscount)
+* [downloadDiscountFile](#downloaddiscountfile)
 * [getDiscount](#getdiscount)
+* [getDiscounts](#getdiscounts)
+* [getDownloadJob](#getdownloadjob)
+* [getValidationJob](#getvalidationjob)
 * [updateDiscount](#updatediscount)
 * [upsertDiscountItems](#upsertdiscountitems)
 * [validateDiscountFile](#validatediscountfile)
-* [downloadDiscountFile](#downloaddiscountfile)
-* [getValidationJob](#getvalidationjob)
-* [cancelValidationJob](#cancelvalidationjob)
-* [getDownloadJob](#getdownloadjob)
-* [cancelDownloadJob](#canceldownloadjob)
 
 
 
@@ -27,33 +27,17 @@ Discount
 
 
 
-### getDiscounts
-Fetch discount list.
+### cancelDownloadJob
+Cancel Download Job.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.getDiscounts({  view : value,
- q : value,
- pageNo : value,
- pageSize : value,
- archived : value,
- month : value,
- year : value,
- type : value,
- appIds : value });
+const promise = client.discount.cancelDownloadJob({  id : value });
 
 // Async/Await
-const data = await client.discount.getDiscounts({  view : value,
- q : value,
- pageNo : value,
- pageSize : value,
- archived : value,
- month : value,
- year : value,
- type : value,
- appIds : value });
+const data = await client.discount.cancelDownloadJob({  id : value });
 ```
 
 
@@ -61,27 +45,19 @@ const data = await client.discount.getDiscounts({  view : value,
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| view | string | no | listing or calender.  Default is listing. |    
-| q | string | no | The search query. This can be a partial or complete name of a discount. |    
-| pageNo | number | no | page number. Default is 1. |    
-| pageSize | number | no | page size. Default is 12. |    
-| archived | boolean | no | archived. Default is false. |    
-| month | number | no | month. Default is current month. |    
-| year | number | no | year. Default is current year. |    
-| type | string | no | basic or custom. |    
-| appIds | Array<string> | no | application ids. |  
+| --------- | -----  | -------- | ----------- | 
+| id | string | yes | id |  
 
 
 
-Fetch discount list.
+Cancel Download Job.
 
 *Returned Response:*
 
 
 
 
-[ListOrCalender](#ListOrCalender)
+[CancelJobResponse](#CancelJobResponse)
 
 Success
 
@@ -107,17 +83,17 @@ Success
 ---
 
 
-### createDiscount
-Create Discount.
+### cancelValidationJob
+Cancel Validation Job.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.createDiscount({  body : value });
+const promise = client.discount.cancelValidationJob({  id : value });
 
 // Async/Await
-const data = await client.discount.createDiscount({  body : value });
+const data = await client.discount.cancelValidationJob({  id : value });
 ```
 
 
@@ -125,18 +101,19 @@ const data = await client.discount.createDiscount({  body : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [CreateUpdateDiscount](#CreateUpdateDiscount) | yes | Request body |
+| --------- | -----  | -------- | ----------- | 
+| id | string | yes | id |  
 
 
-Create Discount.
+
+Cancel Validation Job.
 
 *Returned Response:*
 
 
 
 
-[DiscountJob](#DiscountJob)
+[CancelJobResponse](#CancelJobResponse)
 
 Success
 
@@ -162,17 +139,17 @@ Success
 ---
 
 
-### getDiscount
-Fetch discount.
+### createDiscount
+Create Discount.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.getDiscount({  id : value });
+const promise = client.discount.createDiscount({  body : value });
 
 // Async/Await
-const data = await client.discount.getDiscount({  id : value });
+const data = await client.discount.createDiscount({  body : value });
 ```
 
 
@@ -180,12 +157,11 @@ const data = await client.discount.getDiscount({  id : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| id | string | yes | unique id. |  
-
+| --------- | -----  | -------- | ----------- |
+| body | [CreateUpdateDiscount](#CreateUpdateDiscount) | yes | Request body |
 
 
-Fetch discount.
+Create Discount.
 
 *Returned Response:*
 
@@ -218,18 +194,18 @@ Success
 ---
 
 
-### updateDiscount
-Create Discount.
+### downloadDiscountFile
+Validate File.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.updateDiscount({  id : value,
+const promise = client.discount.downloadDiscountFile({  type : value,
  body : value });
 
 // Async/Await
-const data = await client.discount.updateDiscount({  id : value,
+const data = await client.discount.downloadDiscountFile({  type : value,
  body : value });
 ```
 
@@ -239,18 +215,18 @@ const data = await client.discount.updateDiscount({  id : value,
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| id | string | yes | id |  
-| body | [CreateUpdateDiscount](#CreateUpdateDiscount) | yes | Request body |
+| type | string | yes | type |  
+| body | [DownloadFileJob](#DownloadFileJob) | yes | Request body |
 
 
-Create Discount.
+Validate File.
 
 *Returned Response:*
 
 
 
 
-[DiscountJob](#DiscountJob)
+[FileJobResponse](#FileJobResponse)
 
 Success
 
@@ -276,19 +252,17 @@ Success
 ---
 
 
-### upsertDiscountItems
-Create custom discount from bulk.
+### getDiscount
+Fetch discount.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.upsertDiscountItems({  id : value,
- body : value });
+const promise = client.discount.getDiscount({  id : value });
 
 // Async/Await
-const data = await client.discount.upsertDiscountItems({  id : value,
- body : value });
+const data = await client.discount.getDiscount({  id : value });
 ```
 
 
@@ -297,18 +271,18 @@ const data = await client.discount.upsertDiscountItems({  id : value,
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| id | string | yes | Job ID of the discount. |  
-| body | [BulkDiscount](#BulkDiscount) | yes | Request body |
+| id | string | yes | unique id. |  
 
 
-Create custom discounts through API.
+
+Fetch discount.
 
 *Returned Response:*
 
 
 
 
-[Object](#Object)
+[DiscountJob](#DiscountJob)
 
 Success
 
@@ -334,19 +308,33 @@ Success
 ---
 
 
-### validateDiscountFile
-Validate File.
+### getDiscounts
+Fetch discount list.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.validateDiscountFile({  body : value,
- discount : value });
+const promise = client.discount.getDiscounts({  view : value,
+ q : value,
+ pageNo : value,
+ pageSize : value,
+ archived : value,
+ month : value,
+ year : value,
+ type : value,
+ appIds : value });
 
 // Async/Await
-const data = await client.discount.validateDiscountFile({  body : value,
- discount : value });
+const data = await client.discount.getDiscounts({  view : value,
+ q : value,
+ pageNo : value,
+ pageSize : value,
+ archived : value,
+ month : value,
+ year : value,
+ type : value,
+ appIds : value });
 ```
 
 
@@ -355,18 +343,26 @@ const data = await client.discount.validateDiscountFile({  body : value,
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- |  
-| discount | string | no | discount |  
-| body | [DiscountJob](#DiscountJob) | yes | Request body |
+| view | string | no | listing or calender.  Default is listing. |    
+| q | string | no | The search query. This can be a partial or complete name of a discount. |    
+| pageNo | number | no | page number. Default is 1. |    
+| pageSize | number | no | page size. Default is 12. |    
+| archived | boolean | no | archived. Default is false. |    
+| month | number | no | month. Default is current month. |    
+| year | number | no | year. Default is current year. |    
+| type | string | no | basic or custom. |    
+| appIds | Array<string> | no | application ids. |  
 
 
-Validate File.
+
+Fetch discount list.
 
 *Returned Response:*
 
 
 
 
-[FileJobResponse](#FileJobResponse)
+[ListOrCalender](#ListOrCalender)
 
 Success
 
@@ -392,19 +388,17 @@ Success
 ---
 
 
-### downloadDiscountFile
-Validate File.
+### getDownloadJob
+Download File Job.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.downloadDiscountFile({  type : value,
- body : value });
+const promise = client.discount.getDownloadJob({  id : value });
 
 // Async/Await
-const data = await client.discount.downloadDiscountFile({  type : value,
- body : value });
+const data = await client.discount.getDownloadJob({  id : value });
 ```
 
 
@@ -413,11 +407,11 @@ const data = await client.discount.downloadDiscountFile({  type : value,
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| type | string | yes | type |  
-| body | [DownloadFileJob](#DownloadFileJob) | yes | Request body |
+| id | string | yes | id |  
 
 
-Validate File.
+
+Download File Job.
 
 *Returned Response:*
 
@@ -506,17 +500,19 @@ Success
 ---
 
 
-### cancelValidationJob
-Cancel Validation Job.
+### updateDiscount
+Create Discount.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.cancelValidationJob({  id : value });
+const promise = client.discount.updateDiscount({  id : value,
+ body : value });
 
 // Async/Await
-const data = await client.discount.cancelValidationJob({  id : value });
+const data = await client.discount.updateDiscount({  id : value,
+ body : value });
 ```
 
 
@@ -526,17 +522,17 @@ const data = await client.discount.cancelValidationJob({  id : value });
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
 | id | string | yes | id |  
+| body | [CreateUpdateDiscount](#CreateUpdateDiscount) | yes | Request body |
 
 
-
-Cancel Validation Job.
+Create Discount.
 
 *Returned Response:*
 
 
 
 
-[CancelJobResponse](#CancelJobResponse)
+[DiscountJob](#DiscountJob)
 
 Success
 
@@ -562,17 +558,19 @@ Success
 ---
 
 
-### getDownloadJob
-Download File Job.
+### upsertDiscountItems
+Create custom discount from bulk.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.getDownloadJob({  id : value });
+const promise = client.discount.upsertDiscountItems({  id : value,
+ body : value });
 
 // Async/Await
-const data = await client.discount.getDownloadJob({  id : value });
+const data = await client.discount.upsertDiscountItems({  id : value,
+ body : value });
 ```
 
 
@@ -581,18 +579,18 @@ const data = await client.discount.getDownloadJob({  id : value });
 
 | Argument  |  Type  | Required | Description |
 | --------- | -----  | -------- | ----------- | 
-| id | string | yes | id |  
-
+| id | string | yes | Job ID of the discount. |  
+| body | [BulkDiscount](#BulkDiscount) | yes | Request body |
 
 
-Download File Job.
+Create custom discounts through API.
 
 *Returned Response:*
 
 
 
 
-[FileJobResponse](#FileJobResponse)
+[Object](#Object)
 
 Success
 
@@ -618,17 +616,19 @@ Success
 ---
 
 
-### cancelDownloadJob
-Cancel Download Job.
+### validateDiscountFile
+Validate File.
 
 
 
 ```javascript
 // Promise
-const promise = client.discount.cancelDownloadJob({  id : value });
+const promise = client.discount.validateDiscountFile({  body : value,
+ discount : value });
 
 // Async/Await
-const data = await client.discount.cancelDownloadJob({  id : value });
+const data = await client.discount.validateDiscountFile({  body : value,
+ discount : value });
 ```
 
 
@@ -636,19 +636,19 @@ const data = await client.discount.cancelDownloadJob({  id : value });
 
 
 | Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| id | string | yes | id |  
-
+| --------- | -----  | -------- | ----------- |  
+| discount | string | no | discount |  
+| body | [DiscountJob](#DiscountJob) | yes | Request body |
 
 
-Cancel Download Job.
+Validate File.
 
 *Returned Response:*
 
 
 
 
-[CancelJobResponse](#CancelJobResponse)
+[FileJobResponse](#FileJobResponse)
 
 Success
 
@@ -677,184 +677,88 @@ Success
 
 ### Schemas
 
- 
- 
- #### [ValidityObject](#ValidityObject)
+
+#### [BadRequestObject](#BadRequestObject)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | start | string |  yes  |  |
- | end | string |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || message | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [CreateUpdateDiscount](#CreateUpdateDiscount)
+#### [BulkDiscount](#BulkDiscount)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | name | string |  yes  |  |
- | company_id | number |  yes  |  |
- | is_active | boolean |  yes  |  |
- | app_ids | [string] |  yes  |  |
- | extension_ids | [string] |  yes  |  |
- | job_type | string |  yes  |  |
- | discount_type | string |  yes  |  |
- | discount_level | string |  yes  |  |
- | value | number |  no  |  |
- | file_path | string |  no  |  |
- | brand_ids | [number] |  no  |  |
- | store_ids | [number] |  no  |  |
- | validity | [ValidityObject](#ValidityObject) |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || company_id | number |  yes  |  || items | [[DiscountItems](#DiscountItems)] |  yes  |  |
 
 ---
 
-
- 
- 
- #### [DiscountJob](#DiscountJob)
+#### [CancelJobResponse](#CancelJobResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  yes  |  |
- | name | string |  yes  |  |
- | company_id | number |  yes  |  |
- | is_active | boolean |  yes  |  |
- | app_ids | [string] |  no  |  |
- | job_type | string |  no  |  |
- | discount_type | string |  no  |  |
- | discount_level | string |  no  |  |
- | value | number |  no  |  |
- | file_path | string |  no  |  |
- | brand_ids | [number] |  no  |  |
- | store_ids | [number] |  no  |  |
- | validity | [ValidityObject](#ValidityObject) |  yes  |  |
- | created_on | string |  yes  |  |
- | modified_on | string |  yes  |  |
- | created_by | [UserDetails](#UserDetails) |  yes  |  |
- | modified_by | [UserDetails](#UserDetails) |  yes  |  |
- | meta | string |  no  |  |
+ | ---------- | ---- | -------- | ----------- || success | boolean |  yes  |  |
 
 ---
 
-
- 
- 
- #### [ListOrCalender](#ListOrCalender)
+#### [CreateUpdateDiscount](#CreateUpdateDiscount)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | items | [[DiscountJob](#DiscountJob)] |  yes  |  |
- | page | [Page](#Page) |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || app_ids | [string] |  yes  |  || brand_ids | [number] |  no  |  || company_id | number |  yes  |  || discount_level | string |  yes  |  || discount_type | string |  yes  |  || extension_ids | [string] |  yes  |  || file_path | string |  no  |  || is_active | boolean |  yes  |  || job_type | string |  yes  |  || name | string |  yes  |  || store_ids | [number] |  no  |  || validity | [ValidityObject](#ValidityObject) |  yes  |  || value | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [DiscountItems](#DiscountItems)
+#### [DiscountItems](#DiscountItems)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | item_code | string |  no  |  |
- | brand_uid | number |  no  |  |
- | seller_identifier | string |  no  |  |
- | discount_type | string |  yes  |  |
- | value | number |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || brand_uid | number |  no  |  || discount_type | string |  yes  |  || item_code | string |  no  |  || seller_identifier | string |  no  |  || value | number |  yes  |  |
 
 ---
 
-
- 
- 
- #### [BulkDiscount](#BulkDiscount)
+#### [DiscountJob](#DiscountJob)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | company_id | number |  yes  |  |
- | items | [[DiscountItems](#DiscountItems)] |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || _id | string |  yes  |  || app_ids | [string] |  no  |  || brand_ids | [number] |  no  |  || company_id | number |  yes  |  || created_by | [UserDetails](#UserDetails) |  yes  |  || created_on | string |  yes  |  || discount_level | string |  no  |  || discount_type | string |  no  |  || file_path | string |  no  |  || is_active | boolean |  yes  |  || job_type | string |  no  |  || meta | string |  no  |  || modified_by | [UserDetails](#UserDetails) |  yes  |  || modified_on | string |  yes  |  || name | string |  yes  |  || store_ids | [number] |  no  |  || validity | [ValidityObject](#ValidityObject) |  yes  |  || value | number |  no  |  |
 
 ---
 
-
- 
- 
- #### [FileJobResponse](#FileJobResponse)
+#### [DownloadFileJob](#DownloadFileJob)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | stage | string |  yes  |  |
- | total | number |  yes  |  |
- | failed | number |  yes  |  |
- | company_id | number |  yes  |  |
- | body | string |  no  |  |
- | type | string |  yes  |  |
- | file_type | string |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || brand_ids | [number] |  no  |  || store_ids | [number] |  no  |  |
 
 ---
 
-
- 
- 
- #### [DownloadFileJob](#DownloadFileJob)
+#### [FileJobResponse](#FileJobResponse)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | brand_ids | [number] |  no  |  |
- | store_ids | [number] |  no  |  |
+ | ---------- | ---- | -------- | ----------- || body | string |  no  |  || company_id | number |  yes  |  || failed | number |  yes  |  || file_type | string |  yes  |  || stage | string |  yes  |  || total | number |  yes  |  || type | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [CancelJobResponse](#CancelJobResponse)
+#### [ListOrCalender](#ListOrCalender)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | success | boolean |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || items | [[DiscountJob](#DiscountJob)] |  yes  |  || page | [Page](#Page) |  yes  |  |
 
 ---
 
-
- 
- 
- #### [Page](#Page)
+#### [Page](#Page)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | item_total | number |  no  |  |
- | next_id | string |  no  |  |
- | has_previous | boolean |  no  |  |
- | has_next | boolean |  no  |  |
- | current | number |  no  |  |
- | type | number |  yes  |  |
- | size | number |  no  |  |
+ | ---------- | ---- | -------- | ----------- || current | number |  no  |  || has_next | boolean |  no  |  || has_previous | boolean |  no  |  || item_total | number |  no  |  || next_id | string |  no  |  || size | number |  no  |  || type | number |  yes  |  |
 
 ---
 
-
- 
- 
- #### [UserDetails](#UserDetails)
+#### [UserDetails](#UserDetails)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | username | string |  yes  |  |
- | user_id | string |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || user_id | string |  yes  |  || username | string |  yes  |  |
 
 ---
 
-
- 
- 
- #### [BadRequestObject](#BadRequestObject)
+#### [ValidityObject](#ValidityObject)
 
  | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | message | string |  yes  |  |
+ | ---------- | ---- | -------- | ----------- || end | string |  yes  |  || start | string |  yes  |  |
 
 ---