Interface OrderApi<CustomFields>

interface OrderApi {
    calculateOrderStatisticsForProducts(input): Promise<OrderStatisticsResponse>;
    createOrder<T>(input): Promise<OrderResponse<T>>;
    deleteOrder(input): Promise<void>;
    getOrder<T>(input): Promise<OrderResponse<T>>;
    getRequiredVersion(): string;
    listOrders<T>(input): Promise<PaginatedResponse<OrderResponse<T>>>;
    listOrdersForOrganization<T>(input): Promise<PaginatedResponse<OrderResponse<T>>>;
    listOrdersForUsers<T>(input): Promise<PaginatedResponse<OrderResponse<T>>>;
    ping(): Promise<PingResponse>;
    updateOrder<T>(input): Promise<OrderResponse<T>>;
}

Type Parameters

  • CustomFields = unknown

Hierarchy

Implemented by

Methods

calculateOrderStatisticsForProducts createOrder deleteOrder getOrder getRequiredVersion listOrders listOrdersForOrganization listOrdersForUsers ping updateOrder

Methods

calculateOrderStatisticsForProducts

createOrder

deleteOrder

getOrder

getRequiredVersion

  • getRequiredVersion(): string

  • On setup, we can call getRequiredVersion and ping() to confirm that the service exists and that it is of a matching version semantically E.g. if required version is ~2.5 and the api returns 2.6.3, then no issue If returns 3.0.1, should log a warning If returns 1.0.2, should throw error saying it isn't new enough

    Returns string

listOrders

listOrdersForOrganization

listOrdersForUsers

ping

updateOrder

Settings

Member Visibility

Theme

On This Page

Generated using TypeDoc