Class OrderDataService

Order default service

Index

Constructors

Methods

createOrder deleteOrder getOneOrder getPaginatedOrders getPaginatedOrdersByOrgId getPaginatedOrdersByUserId getProductCountStatsForOrders updateOrder

Properties

db orderRepository COLLECTION_ORDER

Constructors

constructor

new OrderDataService(db): OrderDataService
Parameters
- db: Db
Returns OrderDataService
- Defined in adapter/default/dataServices/order.dataService.ts:14

Methods

createOrder

createOrder(order): Promise<{
id: string;
}>
Create order in database
Parameters
- order: OrderCreation
Returns Promise<{
id: string;
}>
Promise<{id: string}> id of created order record
- Defined in adapter/default/dataServices/order.dataService.ts:26

deleteOrder

deleteOrder(id): Promise<boolean>
Delete order from database
Parameters
- id: string
Returns Promise<boolean>
id
- Defined in adapter/default/dataServices/order.dataService.ts:153

getOneOrder

getOneOrder(id?): Promise<null | OrderEntity>
Get order from database
Parameters
- Optional id: string
Returns Promise<null | OrderEntity>
Promise<Order | null> Order data if fetched successfully, or null if data not found by id
- Defined in adapter/default/dataServices/order.dataService.ts:39

getPaginatedOrders

getPaginatedOrders(filter, orderParams, paginationOptions): Promise<PaginatedFindResult<OrderEntity>>
Get order list from database
Parameters
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<OrderEntity>>
paginated order list query result
- Defined in adapter/default/dataServices/order.dataService.ts:55

getPaginatedOrdersByOrgId

getPaginatedOrdersByOrgId(orgId, filter, orderParams, paginationOptions): Promise<PaginatedFindResult<OrderEntity>>
Get order list by orgId from database
Parameters
- orgId: string
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<OrderEntity>>
paginated order list query result
- Defined in adapter/default/dataServices/order.dataService.ts:79

getPaginatedOrdersByUserId

getPaginatedOrdersByUserId(userId, filter, orderParams, paginationOptions): Promise<PaginatedFindResult<OrderEntity>>
Get order list by userId from database
Parameters
- userId: string
- filter: undefined | Expression
- orderParams: OrderParam<string>[]
- paginationOptions: PaginationOptions
Returns Promise<PaginatedFindResult<OrderEntity>>
paginated order list query result
- Defined in adapter/default/dataServices/order.dataService.ts:111

getProductCountStatsForOrders

getProductCountStatsForOrders(orgId, productIds): Promise<OrderStats[]>
Returns the total count of orders for each product in an organization. Pass the list of product ids to check and the organization to filter on.
Parameters
- orgId: string
- productIds: string[]
Returns Promise<OrderStats[]>
Array of stats for each product with the order count
- Defined in adapter/default/dataServices/order.dataService.ts:164

updateOrder

updateOrder(id, orderInfo): Promise<{
id: string;
}>
Update order in database
Parameters
- id: string
- orderInfo: OrderMutation
  data to update
Returns Promise<{
id: string;
}>
id
- Defined in adapter/default/dataServices/order.dataService.ts:141

Properties

`Private` db

db: Db

`Private` `Readonly` orderRepository

orderRepository: MongoRepository<OrderEntity>

`Static` `Private` `Readonly` COLLECTION_ORDER

COLLECTION_ORDER: "orders" = 'orders'

Generated using TypeDoc