@gofynd/fdk-client-javascript 1.0.2 → 1.0.4

package/documentation/public/INVENTORY.md

@@ -1,690 +0,0 @@
-
-
-
-
-
-##### [Back to Public docs](./README.md)
-
-## Inventory Methods
-
-
-* [getJobCodesMetrics](#getjobcodesmetrics)
-* [saveJobCodesMetrics](#savejobcodesmetrics)
-* [getConfigByApiKey](#getconfigbyapikey)
-* [getApiKey](#getapikey)
-* [getJobByCode](#getjobbycode)
-* [getJobConfigByIntegrationType](#getjobconfigbyintegrationtype)
-
-
-
-## Methods with example and description
-
-
-
-
-### getJobCodesMetrics
-Find all the JobCodes from Metrics Collection based on the field Values
-
-
-
-```javascript
-// Promise
-const promise = inventory.getJobCodesMetrics({  dailyJob : value,
- jobCode : value });
-
-// Async/Await
-const data = await inventory.getJobCodesMetrics({  dailyJob : value,
- jobCode : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |  
-| dailyJob | boolean | no | Daily Job Flag |    
-| jobCode | string | no | Email Job Code |  
-
-
-
-Endpoint to return all JobCodes present in Metrics Collection
-
-*Returned Response:*
-
-
-
-
-[ResponseEnvelopeObject](#ResponseEnvelopeObject)
-
-Successful operation
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### saveJobCodesMetrics
-Save JobCode Metrics
-
-
-
-```javascript
-// Promise
-const promise = inventory.saveJobCodesMetrics({  body : value });
-
-// Async/Await
-const data = await inventory.saveJobCodesMetrics({  body : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- |
-| body | [EmailJobMetrics](#EmailJobMetrics) | yes | Request body |
-
-
-Endpoint to save JobCode Metrics
-
-*Returned Response:*
-
-
-
-
-[ResponseEnvelopeEmailJobMetrics](#ResponseEnvelopeEmailJobMetrics)
-
-JobCode Metrics entry Created Successfully
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### getConfigByApiKey
-Get Slingshot Configuration Of  A Company using API key
-
-
-
-```javascript
-// Promise
-const promise = inventory.getConfigByApiKey({  apikey : value });
-
-// Async/Await
-const data = await inventory.getConfigByApiKey({  apikey : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| apikey | string | yes | Api key |  
-
-
-
-REST Endpoint that returns all configuration detail of a company
-
-*Returned Response:*
-
-
-
-
-[ResponseEnvelopeSlingshotConfigurationDetail](#ResponseEnvelopeSlingshotConfigurationDetail)
-
-Successful operation
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### getApiKey
-Get apikey  for  Company  to call other Slingshot Configuration APIs 
-
-
-
-```javascript
-// Promise
-const promise = inventory.getApiKey({  userName : value,
- password : value });
-
-// Async/Await
-const data = await inventory.getApiKey({  userName : value,
- password : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| userName | string | yes | Integration id |   
-| password | string | yes | company/store token |  
-
-
-
-REST Endpoint that returns apikey by username by password
-
-*Returned Response:*
-
-
-
-
-[ResponseEnvelopeApikeyModel](#ResponseEnvelopeApikeyModel)
-
-Successful operation
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### getJobByCode
-Get Job Config By Code
-
-
-
-```javascript
-// Promise
-const promise = inventory.getJobByCode({  code : value });
-
-// Async/Await
-const data = await inventory.getJobByCode({  code : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| code | string | yes | Job Code |  
-
-
-
-REST Endpoint that returns job config by code
-
-*Returned Response:*
-
-
-
-
-[ResponseEnvelopeJobConfigDTO](#ResponseEnvelopeJobConfigDTO)
-
-Successful operation
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-### getJobConfigByIntegrationType
-Get Job Configs By Integration Type
-
-
-
-```javascript
-// Promise
-const promise = inventory.getJobConfigByIntegrationType({  integrationType : value,
- disable : value });
-
-// Async/Await
-const data = await inventory.getJobConfigByIntegrationType({  integrationType : value,
- disable : value });
-```
-
-
-
-
-
-| Argument  |  Type  | Required | Description |
-| --------- | -----  | -------- | ----------- | 
-| integrationType | string | yes | Integration Type |    
-| disable | boolean | no | JobConfig current state |  
-
-
-
-REST Endpoint that returns all job Configs by Integration Type
-
-*Returned Response:*
-
-
-
-
-[ResponseEnvelopeListJobConfigDTO](#ResponseEnvelopeListJobConfigDTO)
-
-Successful operation
-
-
-
-
-<details>
-<summary><i>&nbsp; Example:</i></summary>
-
-```json
-
-```
-</details>
-
-
-
-
-
-
-
-
-
----
-
-
-
-### Schemas
-
- 
- 
- #### [EmailJobMetrics](#EmailJobMetrics)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | executed | boolean |  no  |  |
- | id | string |  no  |  |
- | job_code | string |  no  |  |
- | daily_job | boolean |  no  |  |
- | last_executed_on | string |  no  |  |
-
----
-
-
- 
- 
- #### [Page](#Page)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | type | string |  yes  |  |
- | size | number |  no  |  |
- | current | number |  no  |  |
- | has_next | boolean |  no  |  |
- | item_total | number |  no  |  |
- | next_id | string |  no  |  |
- | has_previous | boolean |  no  |  |
-
----
-
-
- 
- 
- #### [ResponseEnvelopeEmailJobMetrics](#ResponseEnvelopeEmailJobMetrics)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | timestamp | string |  no  |  |
- | status | number |  no  |  |
- | error | string |  no  |  |
- | exception | string |  no  |  |
- | message | string |  no  |  |
- | total_time_taken_in_millis | number |  no  |  |
- | http_status | string |  no  |  |
- | items | [EmailJobMetrics](#EmailJobMetrics) |  no  |  |
- | payload | [EmailJobMetrics](#EmailJobMetrics) |  no  |  |
- | trace_id | string |  no  |  |
- | page | [Page](#Page) |  no  |  |
-
----
-
-
- 
- 
- #### [GCompany](#GCompany)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | integration | string |  no  |  |
- | level | string |  no  |  |
- | uid | number |  no  |  |
- | opted | boolean |  no  |  |
- | permissions | [string] |  no  |  |
- | token | string |  no  |  |
- | name | string |  no  |  |
- | stores | [[GStore](#GStore)] |  no  |  |
-
----
-
-
- 
- 
- #### [GStore](#GStore)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | integration | string |  no  |  |
- | level | string |  no  |  |
- | uid | number |  no  |  |
- | opted | boolean |  no  |  |
- | permissions | [string] |  no  |  |
- | token | string |  no  |  |
- | code | string |  no  |  |
- | name | string |  no  |  |
- | data | [StoreData](#StoreData) |  no  |  |
-
----
-
-
- 
- 
- #### [Metum](#Metum)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | name | string |  no  |  |
- | value | string |  no  |  |
-
----
-
-
- 
- 
- #### [ResponseEnvelopeSlingshotConfigurationDetail](#ResponseEnvelopeSlingshotConfigurationDetail)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | timestamp | string |  no  |  |
- | status | number |  no  |  |
- | error | string |  no  |  |
- | exception | string |  no  |  |
- | message | string |  no  |  |
- | total_time_taken_in_millis | number |  no  |  |
- | http_status | string |  no  |  |
- | items | [SlingshotConfigurationDetail](#SlingshotConfigurationDetail) |  no  |  |
- | payload | [SlingshotConfigurationDetail](#SlingshotConfigurationDetail) |  no  |  |
- | trace_id | string |  no  |  |
- | page | [Page](#Page) |  no  |  |
-
----
-
-
- 
- 
- #### [SlingshotConfigurationDetail](#SlingshotConfigurationDetail)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | integration | [SlingshotIntegration](#SlingshotIntegration) |  no  |  |
- | companies | [[GCompany](#GCompany)] |  no  |  |
-
----
-
-
- 
- 
- #### [SlingshotIntegration](#SlingshotIntegration)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | _id | string |  no  |  |
- | description | string |  no  |  |
- | name | string |  no  |  |
- | slug | string |  no  |  |
- | meta | [[Metum](#Metum)] |  no  |  |
-
----
-
-
- 
- 
- #### [StoreData](#StoreData)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | location_id | string |  no  |  |
-
----
-
-
- 
- 
- #### [ApikeyModel](#ApikeyModel)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | session_id | string |  no  |  |
- | error_message | string |  no  |  |
-
----
-
-
- 
- 
- #### [ResponseEnvelopeApikeyModel](#ResponseEnvelopeApikeyModel)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | timestamp | string |  no  |  |
- | status | number |  no  |  |
- | error | string |  no  |  |
- | exception | string |  no  |  |
- | message | string |  no  |  |
- | total_time_taken_in_millis | number |  no  |  |
- | http_status | string |  no  |  |
- | items | [ApikeyModel](#ApikeyModel) |  no  |  |
- | payload | [ApikeyModel](#ApikeyModel) |  no  |  |
- | trace_id | string |  no  |  |
- | page | [Page](#Page) |  no  |  |
-
----
-
-
- 
- 
- #### [DataTresholdDTO](#DataTresholdDTO)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | min_price | number |  no  |  |
- | safe_stock | number |  no  |  |
- | period_threshold | number |  no  |  |
- | period_threshold_type | string |  no  |  |
- | period_type_list | [[GenericDTO](#GenericDTO)] |  no  |  |
-
----
-
-
- 
- 
- #### [GenericDTO](#GenericDTO)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | text | string |  no  |  |
- | value | string |  no  |  |
-
----
-
-
- 
- 
- #### [JobConfigDTO](#JobConfigDTO)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | integration_data | string |  no  |  |
- | company_name | string |  no  |  |
- | integration | string |  yes  |  |
- | company_id | number |  yes  |  |
- | task_details | [TaskDTO](#TaskDTO) |  no  |  |
- | threshold_details | [DataTresholdDTO](#DataTresholdDTO) |  no  |  |
- | job_code | string |  no  |  |
- | alias | string |  no  |  |
-
----
-
-
- 
- 
- #### [ResponseEnvelopeJobConfigDTO](#ResponseEnvelopeJobConfigDTO)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | timestamp | string |  no  |  |
- | status | number |  no  |  |
- | error | string |  no  |  |
- | exception | string |  no  |  |
- | message | string |  no  |  |
- | total_time_taken_in_millis | number |  no  |  |
- | http_status | string |  no  |  |
- | items | [JobConfigDTO](#JobConfigDTO) |  no  |  |
- | payload | [JobConfigDTO](#JobConfigDTO) |  no  |  |
- | trace_id | string |  no  |  |
- | page | [Page](#Page) |  no  |  |
-
----
-
-
- 
- 
- #### [TaskDTO](#TaskDTO)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | type | number |  no  |  |
- | group_list | [[GenericDTO](#GenericDTO)] |  no  |  |
-
----
-
-
- 
- 
- #### [ResponseEnvelopeListJobConfigDTO](#ResponseEnvelopeListJobConfigDTO)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | timestamp | string |  no  |  |
- | status | number |  no  |  |
- | error | string |  no  |  |
- | exception | string |  no  |  |
- | message | string |  no  |  |
- | total_time_taken_in_millis | number |  no  |  |
- | http_status | string |  no  |  |
- | items | [[JobConfigDTO](#JobConfigDTO)] |  no  |  |
- | payload | [[JobConfigDTO](#JobConfigDTO)] |  no  |  |
- | trace_id | string |  no  |  |
- | page | [Page](#Page) |  no  |  |
-
----
-
-
- 
- 
- #### [ResponseEnvelopeObject](#ResponseEnvelopeObject)
-
- | Properties | Type | Nullable | Description |
- | ---------- | ---- | -------- | ----------- |
- | timestamp | string |  no  |  |
- | status | number |  no  |  |
- | error | string |  no  |  |
- | exception | string |  no  |  |
- | message | string |  no  |  |
- | total_time_taken_in_millis | number |  no  |  |
- | http_status | string |  no  |  |
- | items | string |  no  |  |
- | payload | string |  no  |  |
- | trace_id | string |  no  |  |
- | page | [Page](#Page) |  no  |  |
-
----
-
-
-
-