Class OrderDefaultAdapter

Order default adapter

Implements

OrderAdapter

Index

Constructors

HandlerAndValidators

calculateOrderStatisticsForProducts createOrder deleteOrder getOrder listOrders listOrdersForOrganization listOrdersForUser updateOrder

Properties

adapterName authSecrets dataServices dependencies opts

Constructors

constructor

new OrderDefaultAdapter(opts, dependencies): OrderDefaultAdapter
Parameters
- opts: OrderDefaultAdapterOptions
- dependencies: OrderDefaultAdapterDependencies
Returns OrderDefaultAdapter
- Defined in adapter/default/adapter.ts:213

HandlerAndValidators

calculateOrderStatisticsForProducts

calculateOrderStatisticsForProducts: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    organizationExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get order count from product ids handler and validators

handler: calculateOrderStatisticsForProductsHandler

validators:

authentication: createIsAuthenticatedValidator
authorization: isUserOrganizationOwnerOrAdmin || UserDefaultAdapterRestSdk.createIsAdminUserValidator
organizationExists: isOrganizationExists

createOrder

createOrder: HandlerAndValidators<{
isValidOrderStatus: undefined | Predicate;
validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Create order handler and validators

handler: createOrderHandler

validators:

validBody: createValidRequestPredicate

deleteOrder

deleteOrder: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    orderBelongsToOrganization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Delete order handler and validators

handler: deleteOrderHandler

validators:

authentication: createIsAuthenticatedValidator
authorization: isUserOrganizationOwnerOrAdmin || UserDefaultAdapterRestSdk.createIsAdminUserValidator
orderBelongsToOrganization: orderBelongsToOrganization

getOrder

getOrder: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    orderBelongsToOrganization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get order handler and validators

handler: getOrderHandler

validators:

authentication: createIsAuthenticatedValidator
authorization: isUserOrganizationOwnerOrAdmin || UserDefaultAdapterRestSdk.createIsAdminUserValidator || isOrderMadeBySelf
orderBelongsToOrganization: orderBelongsToOrganization

listOrders

listOrders: HandlerAndValidators<{
authentication: undefined | Predicate;
authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get all orders across all users/orgs

handler: listOrdersHandler

validators:

authentication: createIsAuthenticatedValidator
authorization UserDefaultAdapterRestSdk.createIsAdminUserValidator

listOrdersForOrganization

listOrdersForOrganization: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    organizationExists: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get orders for organization handler and validators

handler: listOrdersForOrganizationHandler

validators:

authentication: createIsAuthenticatedValidator
authorization: isUserOrganizationOwnerOrAdmin || UserDefaultAdapterRestSdk.createIsAdminUserValidator
organizationExist: isOrganizationExists

listOrdersForUser

listOrdersForUser: HandlerAndValidators<{
authentication: undefined | Predicate;
authorization: undefined | Predicate;
} & Record<string, Predicate>>

Description

Get orders for user handler and validators

handler: listOrdersForUserHandler

validators:

authentication: createIsAuthenticatedValidator
authorization: hasPermissionForUserResource || UserDefaultAdapterRestSdk.createIsAdminUserValidator

updateOrder

updateOrder: HandlerAndValidators<{
    authentication: undefined | Predicate;
    authorization: undefined | Predicate;
    isValidOrderStatus: undefined | Predicate;
    orderBelongsToOrganization: undefined | Predicate;
    validBody: undefined | Predicate;
} & Record<string, Predicate>>

Description

Update order handler and validators

handler: updateOrderHandler

validators:

authentication: createIsAuthenticatedValidator
authorization: isUserOrganizationOwnerOrAdmin || UserDefaultAdapterRestSdk.createIsAdminUserValidator
orderBelongsToOrganization: orderBelongsToOrganization
isValidOrderStatus: isValidOrderStatus
validOrderPayload: createValidRequestPredicate

Properties

adapterName

adapterName: string = ADAPTER_NAME

authSecrets

authSecrets: AuthSecrets

dataServices

dataServices: {
order: OrderDataService;
}

Type declaration

order: OrderDataService

dependencies

dependencies: OrderDefaultAdapterDependencies

opts

opts: Required<Omit<OrderDefaultAdapterOptions, (keyof AuthSecrets) | "taxPercent">> & {
taxRate: Decimal;
}

Type declaration

taxRate: Decimal

Class OrderDefaultAdapter

Implements

Index

Constructors

HandlerAndValidators

Properties

Constructors

constructor

Parameters

opts: OrderDefaultAdapterOptions

dependencies: OrderDefaultAdapterDependencies

Returns OrderDefaultAdapter

HandlerAndValidators

calculateOrderStatisticsForProducts

Description

createOrder

Description

deleteOrder

Description

getOrder

Description

listOrders

Description

listOrdersForOrganization

Description

listOrdersForUser

Description

updateOrder

Description

Properties

adapterName

authSecrets

dataServices

Type declaration

order: OrderDataService

dependencies

opts

Type declaration

taxRate: Decimal

Settings

Member Visibility

Theme

On This Page