## Constants
getOrdersWithFiltersAsync ⇒ object

Get Order with filters for Dashboard

getOrderCountsAsync ⇒ object

Retrieve All Order Counts

createDeliveryWindow ⇒ object

Create delivery window

getDeliveryWindows ⇒ object

Retrieve delivery window

fileUploadForOrderAsync ⇒ object

Upload Excel file for orders

getUploadedOrderProgressionAsync ⇒ object

Check the progress of order file uplading process

getOrderAsync ⇒ object

Retrieve single order

getOrdersBasedOnSearchResult ⇒ object

Retrieve orders based on search result

getOrdersGroupByPickUpAddressAsync ⇒ object

Retrieve All Order Counts

mergeOldAndNewOrderRecords ⇒ object

Merge Order Records

concatDuplicateObjects

Merge Two Objects which has the same id

findDuplicateIndexes ⇒ object

Find duplicate indexes

getRemainingOrdersAsync ⇒ object

Get Remanining Orders

getOrdersAsync ⇒ object

Get orders

getErrorOrderContentsAsync ⇒ object

Get upload order's error contents from Dynamodb

updateAndTruncateOrderErrorsAsync ⇒ promise

Fixed error records in RDS and Truncate existing error records from Dynamodb This function call 2 API endpoints one after another Call editOrdersAsync to edit the error grouping locations if it's success, call removeOrderErrorRecordsAsync to truncate records from Dynamodb if both API call is success, it will return isUpdatedOrder and isTruncateErrorReords as true

removeErrorOrderRecordAsync ⇒ promise

Remove Order Error Record (single record) from Dynamodb

removeOrderErrorRecordsAsync ⇒ promise

Remove Order Error Records (multiple records) from Dynamodb

getUniquePickupAddressesAsync ⇒ object

Get pickup group

createOrderAsync ⇒ object

Create single order

editOrderAsync ⇒ object

Edit single order

editOrdersAsync ⇒ object

Edit multiple orders

deleteOrderAsync ⇒ object

Delete single order

deleteOrdersAsync ⇒ object

Delete Multiple Orders

cancelBatchFileProcessAsync ⇒ object

API isn't ready yet Cancel Batch File Process

getUpdatedJobLiveData ⇒ object

Get Updated Job Live Data for Dashboard

categoriesCustomerOrders ⇒ object

Categories Customer Orders

groupLocations ⇒ object

Group Locations with error contents

mergeLocationDataWithErrors ⇒ array

Merge Location data with Errors

## Functions
calculateCustomerOrderCounts(data) ⇒ object

Calculate Customer Order Counts

groupLocationByPickUpAddress(groups, location, errorContents) ⇒ object

Group Order by Pickup Address

## getOrdersWithFiltersAsync ⇒ object Get Order with filters for Dashboard **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ---------------- | -------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | filterObject | object | # {pickupDate (mandatory), routeStatusIds, includeOrders, limit, offset} | | customerId | int | # {pickupDate (mandatory), routeStatusIds, includeOrders, limit, offset} | | token | string | # {pickupDate (mandatory), routeStatusIds, includeOrders, limit, offset} | | validationStatus | boolean | pickupDate (optional)(string) = '2018-02-28' routeStatusIds (optional)(int) = 1,2 (csv) includeOrders (optional)(bollean) = true/false limit = 20 (optional)(int) page = 0 (optional)(int) | ## getOrderCountsAsync ⇒ object Retrieve All Order Counts **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | filterObject | object | # {pickupDate, limit, offset} pickupDate (optional)(string) = '2018-02-28' limit = 20 (optional)(int) offset = 0 (optional)(int) | | customerId | int | | | token | string | | ## createDeliveryWindow ⇒ object Create delivery window **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | payload | object | {customerId, identityId, productTypeId, transactionGroupId, displayName, startTime, endTime} customerId (optional)(string) = '2018-02-28' identityId (optional)(int) = 20 productTypeId (optional)(int) = 20 transactionGroupId (optional)(int) = 20 displayName (optional)(string) = 20 startTime (optional)(string) = 20 endTime (optional)(string) = 0 | | token | string | | ## getDeliveryWindows ⇒ object Retrieve delivery window **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | | ------------------- | ------------------- | | customerId | int | | identityId | int | | productTypeId | int | | transactionGroupIds | array | | token | string | ## fileUploadForOrderAsync ⇒ object Upload Excel file for orders **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | | ---------- | ------------------- | | fileObject | object | | token | string | ## getUploadedOrderProgressionAsync ⇒ object Check the progress of order file uplading process **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | | ---------- | ------------------- | | customerId | int | | token | string | ## getOrderAsync ⇒ object Retrieve single order **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | | ------------------ | ------------------- | | groupingLocationId | object | | token | string | ## getOrdersBasedOnSearchResult ⇒ object Retrieve orders based on search result **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------ | | customerId | int | | | filterObject | object | {pickupDate, limit, offset} pickupDate (optional)(string) = '2018-02-28' limit = 20 (optional)(int) offset = 0 (optional)(int) | | searchResult | int | | | token | string | | ## getOrdersGroupByPickUpAddressAsync ⇒ object Retrieve All Order Counts **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------------ | ------------------- | -------------------------------------------------------------------------------------------------------------------------------- | | filterObject | object | # {pickupDate, limit, offset} pickupDate (optional)(string) = '2018-02-28' limit = 20 (optional)(int) offset = 0 (optional)(int) | | customerId | int | | | token | string | | ## mergeOldAndNewOrderRecords ⇒ object Merge Order Records **Kind**: global constant **Returns**: object - Promise resolve/reject Response merged order object | Param | Type | | --------- | ------------------ | | oldValues | array | | newValues | array | ## concatDuplicateObjects Merge Two Objects which has the same id **Kind**: global constant | Param | Type | | --------- | ------------------- | | oldValues | object | | newValues | object | | data | object | ## findDuplicateIndexes ⇒ object Find duplicate indexes **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ----------- | ------------------- | ---------------------------------------- | | newValues | object | | | accumulator | array | Example [{oldIndex: i, newIndex: index}] | | oldValues | object | | | i | int | # iterator | ## getRemainingOrdersAsync ⇒ object Get Remanining Orders **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------ | | filterObject | object | # {statusIds, pickupDate (mandatory), withOrder, withDriver, withRoute, sort, limit, offset} StatusIds = 1/2/3/4. 1 for 'pending', 2 for 'validated', 3 for 'grouped', 4 for 'failed' pickupDate (mandatory) = '2018-02-28' withOrder (optional) = 1 OR 0 driverId (optional) = 1234 sort (optional) = fieldName,asc OR desc limit = 20 (optional) offset = 0 (optional) | | token | string | | ## getOrdersAsync ⇒ object Get orders **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------ | | filterObject | object | # {pickupDate (mandatory), limit, offset} pickupDate (optional)(string) = '2018-02-28' limit = 20 (optional)(int) page = 0 (optional)(int) | | token | string | | ## getErrorOrderContentsAsync ⇒ object Get upload order's error contents from Dynamodb **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ---------- | ------------------- | ----------------------------------------------------------------------- | | pickupDate | object | # {pickupDate (mandatory)} pickupDate (optional)(string) = '2018-02-28' | | customerId | int | | | token | string | | ## updateAndTruncateOrderErrorsAsync ⇒ promise Fixed error records in RDS and Truncate existing error records from Dynamodb This function call 2 API endpoints one after another Call editOrdersAsync to edit the error grouping locations if it's success, call removeOrderErrorRecordsAsync to truncate records from Dynamodb if both API call is success, it will return isUpdatedOrder and isTruncateErrorReords as true **Kind**: global constant **Returns**: promise - reject/resolve In resolve, it will return object. Example. {data, isUpdatedOrder, isTruncateErrorReords} data = response object from edit endpoint isUpdatedOrder = true means successfullly edited the orders isTruncateErrorReords = true means successfully truncated errors | Param | Type | | ---------------- | ------------------- | | errorIds | array | | locationDataList | array | | token | string | ## removeErrorOrderRecordAsync ⇒ promise Remove Order Error Record (single record) from Dynamodb **Kind**: global constant **Returns**: promise - reject/resolve if resolve, will return {data: true} | Param | Type | | ------------------ | ------------------- | | groupingLocationId | int | | token | string | ## removeOrderErrorRecordsAsync ⇒ promise Remove Order Error Records (multiple records) from Dynamodb **Kind**: global constant **Returns**: promise - reject/resolve if resolve, will return {data: true} | Param | Type | Description | | -------- | ------------------- | ------------------------------------------------ | | errorIds | array | Example ['56c719b7-93aa-420a-b9b1-140c4e03397b'] | | token | string | | ## getUniquePickupAddressesAsync ⇒ object Get pickup group **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------------ | ------------------- | ---------------------------------------------------------------------------------------------------------------- | | filterObject | object | # {pickupDate (mandatory), withOrder} pickupDate (optional)(string) = '2018-02-28' withOrder (optional)(int) = 0 | | token | string | | ## createOrderAsync ⇒ object Create single order **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | -------------- | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | locationObject | object | { pickupLocationAddress: '22 Gim moh road', deliveryAddress: 'Holland Close', pickupDate: '28-02-2018', pickupTimeWindow: '14:35-16:00', deliveryDate: '28-02-2018', deliveryTimeWindow: '17:00-17:00', driverEmailId: null, }, | | token | string | | ## editOrderAsync ⇒ object Edit single order **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ------------------ | ------------------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | groupingLocationId | int | | | locationObject | object | { pickupLocationAddress: '22 Gim moh road', deliveryAddress: 'Holland Close', pickupDate: '28-02-2018', pickupTimeWindow: '14:35-16:00', deliveryDate: '28-02-2018', deliveryTimeWindow: '17:00-17:00', driverEmailId: null, }, | | token | string | | ## editOrdersAsync ⇒ object Edit multiple orders **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ---------------- | ------------------- | --------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | locationDataList | array | [ { groupingLocationId: 27318, locationData: { pickupLocationAddress: '22 Gim moh road', deliveryAddress: 'Holland Close', pickupDate: '28-02-2018', pickupTimeWindow: '14:35-16:00', deliveryDate: '28-02-2018', deliveryTimeWindow: '17:00-17:00', driverEmailId: null, }, }, ] | | token | string | | ## deleteOrderAsync ⇒ object Delete single order **Kind**: global constant **Returns**: object - Promise resolve/reject return {data: true} if deleting is success | Param | Type | | ------------------ | ------------------- | | groupingLocationId | array | | token | string | ## deleteOrdersAsync ⇒ object Delete Multiple Orders **Kind**: global constant **Returns**: object - Promise resolve/reject return {data: true} if deleting is success | Param | Type | | ------------------- | ------------------- | | groupingLocationIds | array | | token | string | ## cancelBatchFileProcessAsync ⇒ object API isn't ready yet Cancel Batch File Process **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | | ------- | ------------------- | | batchId | int | | token | string | ## getUpdatedJobLiveData ⇒ object Get Updated Job Live Data for Dashboard **Kind**: global constant **Returns**: object - Promise resolve/reject | Param | Type | Description | | ---------------- | ------------------- | ---------------------------------------------------------- | | originalJobDatum | object | | | pubSubPayload | object | | | filterObject | string | {pickupDate, routeStatusIds, includeOrders, limit, offset} | ## categoriesCustomerOrders ⇒ object Categories Customer Orders **Kind**: global constant **Returns**: object - data | Param | Type | | ------ | ------------------- | | orders | object | ## groupLocations ⇒ object Group Locations with error contents **Kind**: global constant **Returns**: object - { data: [0], groupId: [2]} | Param | Type | | ------------- | ------------------- | | locations | object | | errorContents | object | ## mergeLocationDataWithErrors ⇒ array Merge Location data with Errors **Kind**: global constant **Returns**: array - errorList if there's no error for this location, it will response empty array. | Param | Type | Description | | ------------- | ------------------- | ----------------- | | errorContents | object | # Error object | | location | object | # location object | ## calculateCustomerOrderCounts(data) ⇒ object Calculate Customer Order Counts **Kind**: global function **Returns**: object - data # retrun count of data object | Param | Type | | ----- | ------------------- | | data | object | ## groupLocationByPickUpAddress(groups, location, errorContents) ⇒ object Group Order by Pickup Address **Kind**: global function **Returns**: object - groupped addresses | Param | Type | Description | | ------------- | ------------------- | ------------------------ | | groups | object | | | location | object | | | errorContents | object | The errorContent number. |