brinkcommerce-dev-mcp 0.1.0-beta.1

package/dist/generated/order-management/src/apis/OrdersApi.d.ts

@@ -0,0 +1,825 @@
+/**
+ * OrderManagement
+ * No description provided (generated by Openapi Generator https://github.com/openapitools/openapi-generator)
+ *
+ * The version of the OpenAPI document: 1
+ *
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import * as runtime from '../runtime.js';
+import type { CancellationDetails, CancellationRequest, Comment, CompensationDetails, CompensationRequest, DeliveryDetails, DeliveryRequest, Order, OrderAddressesModificationDetails, OrderAddressesModificationRequest, OrderCancellations, OrderComment, OrderCompensations, OrderDeliveries, OrderHistory, OrderLinesModificationDetails, OrderLinesModificationRequest, OrderModifications, OrderRefunds, OrderReleases, OrderStockReservation, OrderSummaries, RefundDetails, RefundRequest, ReleaseDetails, ReleaseRequest, ShippingFeesModificationDetails, ShippingFeesModificationRequest } from '../models/index.js';
+export interface AddOrderCustomStateRequest {
+    xApiKey: string;
+    orderId: string;
+    stateId: string;
+}
+export interface CreateOrderAddressesModificationRequest {
+    xApiKey: string;
+    orderId: string;
+    orderAddressesModificationRequest?: OrderAddressesModificationRequest;
+}
+export interface CreateOrderCancellationRequest {
+    xApiKey: string;
+    orderId: string;
+    cancellationRequest?: CancellationRequest;
+}
+export interface CreateOrderCommentRequest {
+    xApiKey: string;
+    orderId: string;
+    comment?: Comment;
+}
+export interface CreateOrderCompensationRequest {
+    xApiKey: string;
+    orderId: string;
+    compensationRequest?: CompensationRequest;
+}
+export interface CreateOrderDeliveryRequest {
+    xApiKey: string;
+    orderId: string;
+    deliveryRequest?: DeliveryRequest;
+}
+export interface CreateOrderLinesModificationRequest {
+    xApiKey: string;
+    orderId: string;
+    orderLinesModificationRequest?: OrderLinesModificationRequest;
+}
+export interface CreateOrderRefundRequest {
+    xApiKey: string;
+    orderId: string;
+    refundRequest?: RefundRequest;
+}
+export interface CreateOrderReleaseRequest {
+    xApiKey: string;
+    orderId: string;
+    releaseRequest?: ReleaseRequest;
+}
+export interface CreateShippingFeesModificationRequest {
+    xApiKey: string;
+    orderId: string;
+    shippingFeesModificationRequest?: ShippingFeesModificationRequest;
+}
+export interface DeleteOrderRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface DeleteOrderCommentRequest {
+    xApiKey: string;
+    orderId: string;
+    commentId: string;
+}
+export interface GetOrderRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderByReferenceRequest {
+    xApiKey: string;
+    reference: string;
+}
+export interface GetOrderCancellationsRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderCompensationsRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderDeliveriesRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderHistoryRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderModificationsRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderRefundsRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderReleasesRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderStatusRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrderStockReservationRequest {
+    xApiKey: string;
+    orderId: string;
+}
+export interface GetOrdersByEmailRequest {
+    xApiKey: string;
+    email: string;
+    from?: Date;
+    to?: Date;
+}
+export interface GetOrdersByMerchantReference1Request {
+    xApiKey: string;
+    merchantRef1: string;
+    from?: Date;
+    to?: Date;
+}
+export interface RemoveOrderCustomStateRequest {
+    xApiKey: string;
+    orderId: string;
+    stateId: string;
+}
+export interface UpdateOrderCommentRequest {
+    xApiKey: string;
+    orderId: string;
+    commentId: string;
+    comment?: Comment;
+}
+/**
+ * OrdersApi - interface
+ *
+ * @export
+ * @interface OrdersApiInterface
+ */
+export interface OrdersApiInterface {
+    /**
+     *
+     * @summary Add custom state to order
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {string} stateId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    addOrderCustomStateRaw(requestParameters: AddOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Add custom state to order
+     */
+    addOrderCustomState(requestParameters: AddOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a modification to update order addresses on an order.  This can be used to update billing and/or shipping address on orders that haven\'t been delivered yet.  An order can have max 4 addresses modifications.
+     * @summary Create an order addresses modification
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {OrderAddressesModificationRequest} [orderAddressesModificationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderAddressesModificationRaw(requestParameters: CreateOrderAddressesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAddressesModificationDetails>>;
+    /**
+     * Create a modification to update order addresses on an order.  This can be used to update billing and/or shipping address on orders that haven\'t been delivered yet.  An order can have max 4 addresses modifications.
+     * Create an order addresses modification
+     */
+    createOrderAddressesModification(requestParameters: CreateOrderAddressesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAddressesModificationDetails>;
+    /**
+     * Create a cancellation for an order
+     * @summary Create order cancellation
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {CancellationRequest} [cancellationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderCancellationRaw(requestParameters: CreateOrderCancellationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CancellationDetails>>;
+    /**
+     * Create a cancellation for an order
+     * Create order cancellation
+     */
+    createOrderCancellation(requestParameters: CreateOrderCancellationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancellationDetails>;
+    /**
+     *
+     * @summary Create order comment
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {Comment} [comment]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderCommentRaw(requestParameters: CreateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderComment>>;
+    /**
+     * Create order comment
+     */
+    createOrderComment(requestParameters: CreateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderComment>;
+    /**
+     * Create a compensation for an order, can only be done once deliveries exists and no refunds
+     * @summary Create order compensation
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {CompensationRequest} [compensationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderCompensationRaw(requestParameters: CreateOrderCompensationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompensationDetails>>;
+    /**
+     * Create a compensation for an order, can only be done once deliveries exists and no refunds
+     * Create order compensation
+     */
+    createOrderCompensation(requestParameters: CreateOrderCompensationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompensationDetails>;
+    /**
+     * Create a delivery for an order. Cannot be done if order has a cancellation
+     * @summary Create order delivery
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {DeliveryRequest} [deliveryRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderDeliveryRaw(requestParameters: CreateOrderDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeliveryDetails>>;
+    /**
+     * Create a delivery for an order. Cannot be done if order has a cancellation
+     * Create order delivery
+     */
+    createOrderDelivery(requestParameters: CreateOrderDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeliveryDetails>;
+    /**
+     * Create a modification to the list of order lines on an order.  This can be used to either create, update, or delete order lines on orders that haven\'t been delivered yet.  An order can have max 4 order lines modifications.
+     * @summary Create an order lines modification
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {OrderLinesModificationRequest} [orderLinesModificationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderLinesModificationRaw(requestParameters: CreateOrderLinesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderLinesModificationDetails>>;
+    /**
+     * Create a modification to the list of order lines on an order.  This can be used to either create, update, or delete order lines on orders that haven\'t been delivered yet.  An order can have max 4 order lines modifications.
+     * Create an order lines modification
+     */
+    createOrderLinesModification(requestParameters: CreateOrderLinesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderLinesModificationDetails>;
+    /**
+     * Create a refund for an order, can only be done once deliveries exists
+     * @summary Create order refund
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {RefundRequest} [refundRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderRefundRaw(requestParameters: CreateOrderRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RefundDetails>>;
+    /**
+     * Create a refund for an order, can only be done once deliveries exists
+     * Create order refund
+     */
+    createOrderRefund(requestParameters: CreateOrderRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefundDetails>;
+    /**
+     * Create a release for an order
+     * @summary Create order release
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {ReleaseRequest} [releaseRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createOrderReleaseRaw(requestParameters: CreateOrderReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseDetails>>;
+    /**
+     * Create a release for an order
+     * Create order release
+     */
+    createOrderRelease(requestParameters: CreateOrderReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseDetails>;
+    /**
+     * Create a modification to the list of shipping fees on an order.  This can be used to update shipping fees amounts on orders that haven\'t been delivered yet.  An order can have max 4 shipping fees modifications.
+     * @summary Create a shipping fees modification
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {ShippingFeesModificationRequest} [shippingFeesModificationRequest]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    createShippingFeesModificationRaw(requestParameters: CreateShippingFeesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShippingFeesModificationDetails>>;
+    /**
+     * Create a modification to the list of shipping fees on an order.  This can be used to update shipping fees amounts on orders that haven\'t been delivered yet.  An order can have max 4 shipping fees modifications.
+     * Create a shipping fees modification
+     */
+    createShippingFeesModification(requestParameters: CreateShippingFeesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShippingFeesModificationDetails>;
+    /**
+     *
+     * @summary Delete an order, can only delete order older than 30 days
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    deleteOrderRaw(requestParameters: DeleteOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete an order, can only delete order older than 30 days
+     */
+    deleteOrder(requestParameters: DeleteOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Delete order comment
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {string} commentId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    deleteOrderCommentRaw(requestParameters: DeleteOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete order comment
+     */
+    deleteOrderComment(requestParameters: DeleteOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Get order by id
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderRaw(requestParameters: GetOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Order>>;
+    /**
+     * Get order by id
+     */
+    getOrder(requestParameters: GetOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Order>;
+    /**
+     *
+     * @summary Get order by reference
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} reference
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderByReferenceRaw(requestParameters: GetOrderByReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Order>>;
+    /**
+     * Get order by reference
+     */
+    getOrderByReference(requestParameters: GetOrderByReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Order>;
+    /**
+     * List of cancellations made for an order
+     * @summary Get order cancellations
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderCancellationsRaw(requestParameters: GetOrderCancellationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCancellations>>;
+    /**
+     * List of cancellations made for an order
+     * Get order cancellations
+     */
+    getOrderCancellations(requestParameters: GetOrderCancellationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCancellations>;
+    /**
+     * Get all compensations made for an order
+     * @summary Get order compensations
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderCompensationsRaw(requestParameters: GetOrderCompensationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCompensations>>;
+    /**
+     * Get all compensations made for an order
+     * Get order compensations
+     */
+    getOrderCompensations(requestParameters: GetOrderCompensationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCompensations>;
+    /**
+     * Get deliveries made for an order
+     * @summary Get order deliveries
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderDeliveriesRaw(requestParameters: GetOrderDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderDeliveries>>;
+    /**
+     * Get deliveries made for an order
+     * Get order deliveries
+     */
+    getOrderDeliveries(requestParameters: GetOrderDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderDeliveries>;
+    /**
+     * Get history of operations performed on the order
+     * @summary Get order history
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderHistoryRaw(requestParameters: GetOrderHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderHistory>>;
+    /**
+     * Get history of operations performed on the order
+     * Get order history
+     */
+    getOrderHistory(requestParameters: GetOrderHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderHistory>;
+    /**
+     * Get all modifications made for an order
+     * @summary Get order modifications
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderModificationsRaw(requestParameters: GetOrderModificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderModifications>>;
+    /**
+     * Get all modifications made for an order
+     * Get order modifications
+     */
+    getOrderModifications(requestParameters: GetOrderModificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderModifications>;
+    /**
+     * Get all refunds made for an order
+     * @summary Get order refunds
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderRefundsRaw(requestParameters: GetOrderRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefunds>>;
+    /**
+     * Get all refunds made for an order
+     * Get order refunds
+     */
+    getOrderRefunds(requestParameters: GetOrderRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefunds>;
+    /**
+     * List of releases made for an order
+     * @summary Get order releases
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderReleasesRaw(requestParameters: GetOrderReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderReleases>>;
+    /**
+     * List of releases made for an order
+     * Get order releases
+     */
+    getOrderReleases(requestParameters: GetOrderReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderReleases>;
+    /**
+     * Deprecated: use GetOrderHistory instead
+     * @summary Get order status
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @deprecated
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderStatusRaw(requestParameters: GetOrderStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderHistory>>;
+    /**
+     * Deprecated: use GetOrderHistory instead
+     * Get order status
+     * @deprecated
+     */
+    getOrderStatus(requestParameters: GetOrderStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderHistory>;
+    /**
+     * Get information about the stock that was reserved when this order was placed
+     * @summary Get order stock reservation
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrderStockReservationRaw(requestParameters: GetOrderStockReservationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderStockReservation>>;
+    /**
+     * Get information about the stock that was reserved when this order was placed
+     * Get order stock reservation
+     */
+    getOrderStockReservation(requestParameters: GetOrderStockReservationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderStockReservation>;
+    /**
+     * Max 100 orders are returned
+     * @summary Get orders by billing address email
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} email
+     * @param {Date} [from] RFC3339 time stamp in UTC
+     * @param {Date} [to] RFC3339 time stamp in UTC
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrdersByEmailRaw(requestParameters: GetOrdersByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderSummaries>>;
+    /**
+     * Max 100 orders are returned
+     * Get orders by billing address email
+     */
+    getOrdersByEmail(requestParameters: GetOrdersByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderSummaries>;
+    /**
+     * Max 100 orders are returned
+     * @summary Get orders by merchant reference 1
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} merchantRef1
+     * @param {Date} [from] RFC3339 timestamp in UTC
+     * @param {Date} [to] RFC3339 timestamp in UTC
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    getOrdersByMerchantReference1Raw(requestParameters: GetOrdersByMerchantReference1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderSummaries>>;
+    /**
+     * Max 100 orders are returned
+     * Get orders by merchant reference 1
+     */
+    getOrdersByMerchantReference1(requestParameters: GetOrdersByMerchantReference1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderSummaries>;
+    /**
+     *
+     * @summary Remove custom state from order
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {string} stateId
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    removeOrderCustomStateRaw(requestParameters: RemoveOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove custom state from order
+     */
+    removeOrderCustomState(requestParameters: RemoveOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     *
+     * @summary Update order comment
+     * @param {string} xApiKey Key generated by Brinkcommerce
+     * @param {string} orderId
+     * @param {string} commentId
+     * @param {Comment} [comment]
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApiInterface
+     */
+    updateOrderCommentRaw(requestParameters: UpdateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderComment>>;
+    /**
+     * Update order comment
+     */
+    updateOrderComment(requestParameters: UpdateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderComment>;
+}
+/**
+ *
+ */
+export declare class OrdersApi extends runtime.BaseAPI implements OrdersApiInterface {
+    /**
+     * Add custom state to order
+     */
+    addOrderCustomStateRaw(requestParameters: AddOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Add custom state to order
+     */
+    addOrderCustomState(requestParameters: AddOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Create a modification to update order addresses on an order.  This can be used to update billing and/or shipping address on orders that haven\'t been delivered yet.  An order can have max 4 addresses modifications.
+     * Create an order addresses modification
+     */
+    createOrderAddressesModificationRaw(requestParameters: CreateOrderAddressesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderAddressesModificationDetails>>;
+    /**
+     * Create a modification to update order addresses on an order.  This can be used to update billing and/or shipping address on orders that haven\'t been delivered yet.  An order can have max 4 addresses modifications.
+     * Create an order addresses modification
+     */
+    createOrderAddressesModification(requestParameters: CreateOrderAddressesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderAddressesModificationDetails>;
+    /**
+     * Create a cancellation for an order
+     * Create order cancellation
+     */
+    createOrderCancellationRaw(requestParameters: CreateOrderCancellationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CancellationDetails>>;
+    /**
+     * Create a cancellation for an order
+     * Create order cancellation
+     */
+    createOrderCancellation(requestParameters: CreateOrderCancellationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CancellationDetails>;
+    /**
+     * Create order comment
+     */
+    createOrderCommentRaw(requestParameters: CreateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderComment>>;
+    /**
+     * Create order comment
+     */
+    createOrderComment(requestParameters: CreateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderComment>;
+    /**
+     * Create a compensation for an order, can only be done once deliveries exists and no refunds
+     * Create order compensation
+     */
+    createOrderCompensationRaw(requestParameters: CreateOrderCompensationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<CompensationDetails>>;
+    /**
+     * Create a compensation for an order, can only be done once deliveries exists and no refunds
+     * Create order compensation
+     */
+    createOrderCompensation(requestParameters: CreateOrderCompensationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<CompensationDetails>;
+    /**
+     * Create a delivery for an order. Cannot be done if order has a cancellation
+     * Create order delivery
+     */
+    createOrderDeliveryRaw(requestParameters: CreateOrderDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<DeliveryDetails>>;
+    /**
+     * Create a delivery for an order. Cannot be done if order has a cancellation
+     * Create order delivery
+     */
+    createOrderDelivery(requestParameters: CreateOrderDeliveryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<DeliveryDetails>;
+    /**
+     * Create a modification to the list of order lines on an order.  This can be used to either create, update, or delete order lines on orders that haven\'t been delivered yet.  An order can have max 4 order lines modifications.
+     * Create an order lines modification
+     */
+    createOrderLinesModificationRaw(requestParameters: CreateOrderLinesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderLinesModificationDetails>>;
+    /**
+     * Create a modification to the list of order lines on an order.  This can be used to either create, update, or delete order lines on orders that haven\'t been delivered yet.  An order can have max 4 order lines modifications.
+     * Create an order lines modification
+     */
+    createOrderLinesModification(requestParameters: CreateOrderLinesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderLinesModificationDetails>;
+    /**
+     * Create a refund for an order, can only be done once deliveries exists
+     * Create order refund
+     */
+    createOrderRefundRaw(requestParameters: CreateOrderRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<RefundDetails>>;
+    /**
+     * Create a refund for an order, can only be done once deliveries exists
+     * Create order refund
+     */
+    createOrderRefund(requestParameters: CreateOrderRefundRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<RefundDetails>;
+    /**
+     * Create a release for an order
+     * Create order release
+     */
+    createOrderReleaseRaw(requestParameters: CreateOrderReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ReleaseDetails>>;
+    /**
+     * Create a release for an order
+     * Create order release
+     */
+    createOrderRelease(requestParameters: CreateOrderReleaseRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ReleaseDetails>;
+    /**
+     * Create a modification to the list of shipping fees on an order.  This can be used to update shipping fees amounts on orders that haven\'t been delivered yet.  An order can have max 4 shipping fees modifications.
+     * Create a shipping fees modification
+     */
+    createShippingFeesModificationRaw(requestParameters: CreateShippingFeesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<ShippingFeesModificationDetails>>;
+    /**
+     * Create a modification to the list of shipping fees on an order.  This can be used to update shipping fees amounts on orders that haven\'t been delivered yet.  An order can have max 4 shipping fees modifications.
+     * Create a shipping fees modification
+     */
+    createShippingFeesModification(requestParameters: CreateShippingFeesModificationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<ShippingFeesModificationDetails>;
+    /**
+     * Delete an order, can only delete order older than 30 days
+     */
+    deleteOrderRaw(requestParameters: DeleteOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete an order, can only delete order older than 30 days
+     */
+    deleteOrder(requestParameters: DeleteOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Delete order comment
+     */
+    deleteOrderCommentRaw(requestParameters: DeleteOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Delete order comment
+     */
+    deleteOrderComment(requestParameters: DeleteOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Get order by id
+     */
+    getOrderRaw(requestParameters: GetOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Order>>;
+    /**
+     * Get order by id
+     */
+    getOrder(requestParameters: GetOrderRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Order>;
+    /**
+     * Get order by reference
+     */
+    getOrderByReferenceRaw(requestParameters: GetOrderByReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<Order>>;
+    /**
+     * Get order by reference
+     */
+    getOrderByReference(requestParameters: GetOrderByReferenceRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<Order>;
+    /**
+     * List of cancellations made for an order
+     * Get order cancellations
+     */
+    getOrderCancellationsRaw(requestParameters: GetOrderCancellationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCancellations>>;
+    /**
+     * List of cancellations made for an order
+     * Get order cancellations
+     */
+    getOrderCancellations(requestParameters: GetOrderCancellationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCancellations>;
+    /**
+     * Get all compensations made for an order
+     * Get order compensations
+     */
+    getOrderCompensationsRaw(requestParameters: GetOrderCompensationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderCompensations>>;
+    /**
+     * Get all compensations made for an order
+     * Get order compensations
+     */
+    getOrderCompensations(requestParameters: GetOrderCompensationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderCompensations>;
+    /**
+     * Get deliveries made for an order
+     * Get order deliveries
+     */
+    getOrderDeliveriesRaw(requestParameters: GetOrderDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderDeliveries>>;
+    /**
+     * Get deliveries made for an order
+     * Get order deliveries
+     */
+    getOrderDeliveries(requestParameters: GetOrderDeliveriesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderDeliveries>;
+    /**
+     * Get history of operations performed on the order
+     * Get order history
+     */
+    getOrderHistoryRaw(requestParameters: GetOrderHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderHistory>>;
+    /**
+     * Get history of operations performed on the order
+     * Get order history
+     */
+    getOrderHistory(requestParameters: GetOrderHistoryRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderHistory>;
+    /**
+     * Get all modifications made for an order
+     * Get order modifications
+     */
+    getOrderModificationsRaw(requestParameters: GetOrderModificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderModifications>>;
+    /**
+     * Get all modifications made for an order
+     * Get order modifications
+     */
+    getOrderModifications(requestParameters: GetOrderModificationsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderModifications>;
+    /**
+     * Get all refunds made for an order
+     * Get order refunds
+     */
+    getOrderRefundsRaw(requestParameters: GetOrderRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderRefunds>>;
+    /**
+     * Get all refunds made for an order
+     * Get order refunds
+     */
+    getOrderRefunds(requestParameters: GetOrderRefundsRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderRefunds>;
+    /**
+     * List of releases made for an order
+     * Get order releases
+     */
+    getOrderReleasesRaw(requestParameters: GetOrderReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderReleases>>;
+    /**
+     * List of releases made for an order
+     * Get order releases
+     */
+    getOrderReleases(requestParameters: GetOrderReleasesRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderReleases>;
+    /**
+     * Deprecated: use GetOrderHistory instead
+     * Get order status
+     * @deprecated
+     */
+    getOrderStatusRaw(requestParameters: GetOrderStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderHistory>>;
+    /**
+     * Deprecated: use GetOrderHistory instead
+     * Get order status
+     * @deprecated
+     */
+    getOrderStatus(requestParameters: GetOrderStatusRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderHistory>;
+    /**
+     * Get information about the stock that was reserved when this order was placed
+     * Get order stock reservation
+     */
+    getOrderStockReservationRaw(requestParameters: GetOrderStockReservationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderStockReservation>>;
+    /**
+     * Get information about the stock that was reserved when this order was placed
+     * Get order stock reservation
+     */
+    getOrderStockReservation(requestParameters: GetOrderStockReservationRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderStockReservation>;
+    /**
+     * Max 100 orders are returned
+     * Get orders by billing address email
+     */
+    getOrdersByEmailRaw(requestParameters: GetOrdersByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderSummaries>>;
+    /**
+     * Max 100 orders are returned
+     * Get orders by billing address email
+     */
+    getOrdersByEmail(requestParameters: GetOrdersByEmailRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderSummaries>;
+    /**
+     * Max 100 orders are returned
+     * Get orders by merchant reference 1
+     */
+    getOrdersByMerchantReference1Raw(requestParameters: GetOrdersByMerchantReference1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderSummaries>>;
+    /**
+     * Max 100 orders are returned
+     * Get orders by merchant reference 1
+     */
+    getOrdersByMerchantReference1(requestParameters: GetOrdersByMerchantReference1Request, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderSummaries>;
+    /**
+     * Remove custom state from order
+     */
+    removeOrderCustomStateRaw(requestParameters: RemoveOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<void>>;
+    /**
+     * Remove custom state from order
+     */
+    removeOrderCustomState(requestParameters: RemoveOrderCustomStateRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<void>;
+    /**
+     * Update order comment
+     */
+    updateOrderCommentRaw(requestParameters: UpdateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<runtime.ApiResponse<OrderComment>>;
+    /**
+     * Update order comment
+     */
+    updateOrderComment(requestParameters: UpdateOrderCommentRequest, initOverrides?: RequestInit | runtime.InitOverrideFunction): Promise<OrderComment>;
+}