@teemill/orders 1.6.0 → 1.6.2

package/dist/esm/api.d.ts

@@ -0,0 +1,1116 @@
+/**
+ * Orders API
+ * Use this API to create and retrieve updates for print-on-demand orders. Use it to request fulfillment for variants of products attached to the given project. You can fetch details and references to these products and variants from the Product Catalog API.  For full documentation on functionality and account auth settings go to [teemill.com](https://teemill.com/api-docs/orders)
+ *
+ * The version of the OpenAPI document: 1.6.2
+ * Contact: hello@teemill.com
+ *
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
+ * https://openapi-generator.tech
+ * Do not edit the class manually.
+ */
+import type { Configuration } from './configuration';
+import type { AxiosPromise, AxiosInstance, RawAxiosRequestConfig } from 'axios';
+import type { RequestArgs } from './base';
+import { BaseAPI } from './base';
+/**
+ * A person\'s address.
+ * @export
+ * @interface Address
+ */
+export interface Address {
+    /**
+     *
+     * @type {string}
+     * @memberof Address
+     */
+    'contactName': string;
+    /**
+     *
+     * @type {string}
+     * @memberof Address
+     */
+    'company'?: string;
+    /**
+     * First line of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'line1': string;
+    /**
+     * Second line of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'line2'?: string;
+    /**
+     * City of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'city': string;
+    /**
+     * Postal code of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'postalCode'?: string;
+    /**
+     * Country of the address (ISO 3166-1 alpha-2).
+     * @type {string}
+     * @memberof Address
+     */
+    'country': string;
+    /**
+     * State of the address.
+     * @type {string}
+     * @memberof Address
+     */
+    'state'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ApiError
+ */
+export interface ApiError {
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ApiError
+     */
+    'message': string;
+}
+/**
+ *
+ * @export
+ * @interface ConfirmOrderFulfillment
+ */
+export interface ConfirmOrderFulfillment {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ConfirmOrderFulfillment
+     */
+    'fulfillmentId': string;
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ConfirmOrderFulfillment
+     */
+    'shippingMethodId': string;
+}
+/**
+ *
+ * @export
+ * @interface ConfirmOrderRequest
+ */
+export interface ConfirmOrderRequest {
+    /**
+     *
+     * @type {Array<ConfirmOrderFulfillment>}
+     * @memberof ConfirmOrderRequest
+     */
+    'fulfillments': Array<ConfirmOrderFulfillment>;
+}
+/**
+ *
+ * @export
+ * @interface ConfirmOrderValidationError
+ */
+export interface ConfirmOrderValidationError {
+    /**
+     *
+     * @type {string}
+     * @memberof ConfirmOrderValidationError
+     */
+    'code': ConfirmOrderValidationErrorCodeEnum;
+    /**
+     *
+     * @type {string}
+     * @memberof ConfirmOrderValidationError
+     */
+    'message': string;
+}
+export declare const ConfirmOrderValidationErrorCodeEnum: {
+    readonly BadRequest: "BAD_REQUEST";
+    readonly PaymentFailed: "PAYMENT_FAILED";
+    readonly Conflict: "CONFLICT";
+    readonly ActionRequired: "ACTION_REQUIRED";
+};
+export type ConfirmOrderValidationErrorCodeEnum = typeof ConfirmOrderValidationErrorCodeEnum[keyof typeof ConfirmOrderValidationErrorCodeEnum];
+/**
+ * Order recipient contact information, used only for courier tracking/updates.
+ * @export
+ * @interface ContactInformation
+ */
+export interface ContactInformation {
+    /**
+     *
+     * @type {string}
+     * @memberof ContactInformation
+     */
+    'email': string;
+    /**
+     *
+     * @type {string}
+     * @memberof ContactInformation
+     */
+    'phone'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface DeliveryEstimates
+ */
+export interface DeliveryEstimates {
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof DeliveryEstimates
+     */
+    'min'?: string;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof DeliveryEstimates
+     */
+    'max'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ExportOrders202Response
+ */
+export interface ExportOrders202Response {
+    /**
+     * A message describing the export status
+     * @type {string}
+     * @memberof ExportOrders202Response
+     */
+    'message'?: string;
+}
+/**
+ *
+ * @export
+ * @interface Fulfillment
+ */
+export interface Fulfillment {
+    /**
+     * Unique fulfillment id
+     * @type {string}
+     * @memberof Fulfillment
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {Status}
+     * @memberof Fulfillment
+     */
+    'status'?: Status;
+    /**
+     *
+     * @type {FulfillmentFulfiller}
+     * @memberof Fulfillment
+     */
+    'fulfiller'?: FulfillmentFulfiller;
+    /**
+     *
+     * @type {Array<FulfillmentItem>}
+     * @memberof Fulfillment
+     */
+    'items'?: Array<FulfillmentItem>;
+    /**
+     *
+     * @type {OrderTracking}
+     * @memberof Fulfillment
+     */
+    'tracking'?: OrderTracking | null;
+    /**
+     * Shipping method currently set
+     * @type {ShippingMethod}
+     * @memberof Fulfillment
+     */
+    'shippingMethod'?: ShippingMethod;
+    /**
+     * Shipping methods available for this fulfillment. One of these should be used to confirm the fulfillment.
+     * @type {Array<ShippingMethod>}
+     * @memberof Fulfillment
+     */
+    'availableShippingMethods'?: Array<ShippingMethod>;
+    /**
+     * Weight of the package being shipped in grams
+     * @type {number}
+     * @memberof Fulfillment
+     */
+    'packageWeight'?: number;
+}
+/**
+ * The fulfiller that will be processing this order.
+ * @export
+ * @interface FulfillmentFulfiller
+ */
+export interface FulfillmentFulfiller {
+    /**
+     *
+     * @type {FulfillmentFulfillerLocation}
+     * @memberof FulfillmentFulfiller
+     */
+    'location'?: FulfillmentFulfillerLocation;
+}
+/**
+ *
+ * @export
+ * @interface FulfillmentFulfillerLocation
+ */
+export interface FulfillmentFulfillerLocation {
+    /**
+     *
+     * @type {string}
+     * @memberof FulfillmentFulfillerLocation
+     */
+    'city'?: string | null;
+    /**
+     *
+     * @type {string}
+     * @memberof FulfillmentFulfillerLocation
+     */
+    'country'?: string | null;
+}
+/**
+ *
+ * @export
+ * @interface FulfillmentItem
+ */
+export interface FulfillmentItem {
+    /**
+     * Unique fulfillment item id
+     * @type {string}
+     * @memberof FulfillmentItem
+     */
+    'id'?: string;
+    /**
+     * Id of the order item being fulfilled
+     * @type {string}
+     * @memberof FulfillmentItem
+     */
+    'itemId'?: string;
+    /**
+     * Number of this item being fulfilled
+     * @type {number}
+     * @memberof FulfillmentItem
+     */
+    'quantity'?: number;
+}
+/**
+ *
+ * @export
+ * @interface Order
+ */
+export interface Order {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof Order
+     */
+    'id'?: string;
+    /**
+     * A reference to the resource location
+     * @type {string}
+     * @memberof Order
+     */
+    'ref'?: string;
+    /**
+     *
+     * @type {Status}
+     * @memberof Order
+     */
+    'status'?: Status;
+    /**
+     *
+     * @type {ContactInformation}
+     * @memberof Order
+     */
+    'contactInformation': ContactInformation;
+    /**
+     *
+     * @type {Address}
+     * @memberof Order
+     */
+    'shippingAddress': Address;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof Order
+     */
+    'createdAt'?: string;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof Order
+     */
+    'updatedAt'?: string;
+    /**
+     * A custom reference to the merchant\'s order that will be displayed on the shipping label.
+     * @type {string}
+     * @memberof Order
+     */
+    'merchantReference'?: string | null;
+    /**
+     *
+     * @type {Array<Fulfillment>}
+     * @memberof Order
+     */
+    'fulfillments'?: Array<Fulfillment>;
+    /**
+     *
+     * @type {Array<OrderItem>}
+     * @memberof Order
+     */
+    'items': Array<OrderItem>;
+    /**
+     *
+     * @type {Price}
+     * @memberof Order
+     */
+    'totalPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Order
+     */
+    'taxPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Order
+     */
+    'subtotalPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Order
+     */
+    'discountPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof Order
+     */
+    'shippingPrice'?: Price;
+    /**
+     *
+     * @type {Origin}
+     * @memberof Order
+     */
+    'origin'?: Origin;
+    /**
+     *
+     * @type {Array<StatusHistoryItem>}
+     * @memberof Order
+     */
+    'statusHistory'?: Array<StatusHistoryItem>;
+}
+/**
+ *
+ * @export
+ * @interface OrderItem
+ */
+export interface OrderItem {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'id'?: string;
+    /**
+     * Reference URL to the order item variant
+     * @type {string}
+     * @memberof OrderItem
+     */
+    'variantRef': string;
+    /**
+     *
+     * @type {number}
+     * @memberof OrderItem
+     */
+    'quantity': number;
+    /**
+     *
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'totalPrice'?: Price;
+    /**
+     *
+     * @type {OrderItemTaxPrice}
+     * @memberof OrderItem
+     */
+    'taxPrice'?: OrderItemTaxPrice;
+    /**
+     *
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'subtotalPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'discountPrice'?: Price;
+    /**
+     * The price you charged the recipient for each item. It\'s highly recommended if you have international orders as it aids customs issues.
+     * @type {Price}
+     * @memberof OrderItem
+     */
+    'recipientCost'?: Price;
+}
+/**
+ * This is an estimate until the order has been confirmed
+ * @export
+ * @interface OrderItemTaxPrice
+ */
+export interface OrderItemTaxPrice {
+    /**
+     * Price including tax in the specified currency.
+     * @type {string}
+     * @memberof OrderItemTaxPrice
+     */
+    'amount'?: string;
+    /**
+     * Currency code for the currency the price is valued in.
+     * @type {string}
+     * @memberof OrderItemTaxPrice
+     */
+    'currencyCode'?: string;
+}
+/**
+ *
+ * @export
+ * @interface OrderTracking
+ */
+export interface OrderTracking {
+    /**
+     *
+     * @type {string}
+     * @memberof OrderTracking
+     */
+    'courier'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderTracking
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof OrderTracking
+     */
+    'url'?: string;
+}
+/**
+ *
+ * @export
+ * @interface OrdersResponse
+ */
+export interface OrdersResponse {
+    /**
+     *
+     * @type {Array<Order>}
+     * @memberof OrdersResponse
+     */
+    'orders'?: Array<Order>;
+    /**
+     *
+     * @type {number}
+     * @memberof OrdersResponse
+     */
+    'nextPageToken'?: number;
+}
+/**
+ *
+ * @export
+ * @interface Origin
+ */
+export interface Origin {
+    /**
+     *
+     * @type {string}
+     * @memberof Origin
+     */
+    'code'?: string;
+    /**
+     *
+     * @type {boolean}
+     * @memberof Origin
+     */
+    'isPaid'?: boolean;
+}
+/**
+ * Standard price definition that defines the amount and currency.
+ * @export
+ * @interface Price
+ */
+export interface Price {
+    /**
+     * Price including tax in the specified currency.
+     * @type {string}
+     * @memberof Price
+     */
+    'amount'?: string;
+    /**
+     * Currency code for the currency the price is valued in.
+     * @type {string}
+     * @memberof Price
+     */
+    'currencyCode'?: string;
+}
+/**
+ *
+ * @export
+ * @interface ShippingMethod
+ */
+export interface ShippingMethod {
+    /**
+     * Unique object identifier
+     * @type {string}
+     * @memberof ShippingMethod
+     */
+    'id'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ShippingMethod
+     */
+    'name'?: string;
+    /**
+     *
+     * @type {string}
+     * @memberof ShippingMethod
+     */
+    'description'?: string;
+    /**
+     *
+     * @type {DeliveryEstimates}
+     * @memberof ShippingMethod
+     */
+    'deliveryEstimates'?: DeliveryEstimates;
+    /**
+     *
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'totalPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'taxPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'subtotalPrice'?: Price;
+    /**
+     *
+     * @type {Price}
+     * @memberof ShippingMethod
+     */
+    'discountPrice'?: Price;
+}
+/**
+ *
+ * @export
+ * @enum {string}
+ */
+export declare const Status: {
+    readonly New: "new";
+    readonly Paid: "paid";
+    readonly Processing: "processing";
+    readonly Complete: "complete";
+    readonly Refunded: "refunded";
+};
+export type Status = typeof Status[keyof typeof Status];
+/**
+ *
+ * @export
+ * @interface StatusHistoryItem
+ */
+export interface StatusHistoryItem {
+    /**
+     *
+     * @type {Status}
+     * @memberof StatusHistoryItem
+     */
+    'status'?: Status;
+    /**
+     * ISO 8601 Timestamp
+     * @type {string}
+     * @memberof StatusHistoryItem
+     */
+    'createdAt'?: string;
+}
+/**
+ * OrdersApi - axios parameter creator
+ * @export
+ */
+export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
+    /**
+     * Cancels an order if it has not yet started processing.
+     * @summary Cancel order
+     * @param {string} project What project it is
+     * @param {string} orderId Unique identifier of an order
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrder: (project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Confirms an order, and submits it as ready to take payment and begin processing.
+     * @summary Confirm order
+     * @param {string} project What project it is
+     * @param {string} orderId Unique identifier of an order
+     * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmOrder: (project: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
+     * @summary Create order
+     * @param {string} project What project it is
+     * @param {Order} order Order schema
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder: (project: string, order: Order, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Export orders as a CSV file
+     * @summary Export orders
+     * @param {string} project What project it is
+     * @param {string} start Start of date range to filter by when orders were placed
+     * @param {string} [end] End of date range to filter by when orders were placed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportOrders: (project: string, start: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Get an order by a given ID.
+     * @summary Get order
+     * @param {string} project What project it is
+     * @param {string} orderId Unique identifier of an order
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrder: (project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+    /**
+     * Lists all orders placed on this project, paginated into configurable chunks.
+     * @summary List orders
+     * @param {string} project What project it is
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search term to filter based on order reference, customer name and email
+     * @param {Array<string>} [ids] Specify fulfillment IDs to list
+     * @param {Array<Status>} [statuses] Filter by fulfillment status
+     * @param {string} [start] Start of date range to filter by when orders were placed
+     * @param {string} [end] End of date range to filter by when orders were placed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrders: (project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, options?: RawAxiosRequestConfig) => Promise<RequestArgs>;
+};
+/**
+ * OrdersApi - functional programming interface
+ * @export
+ */
+export declare const OrdersApiFp: (configuration?: Configuration) => {
+    /**
+     * Cancels an order if it has not yet started processing.
+     * @summary Cancel order
+     * @param {string} project What project it is
+     * @param {string} orderId Unique identifier of an order
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrder(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
+    /**
+     * Confirms an order, and submits it as ready to take payment and begin processing.
+     * @summary Confirm order
+     * @param {string} project What project it is
+     * @param {string} orderId Unique identifier of an order
+     * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmOrder(project: string, orderId: string, confirmOrderRequest: ConfirmOrderRequest, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
+     * @summary Create order
+     * @param {string} project What project it is
+     * @param {Order} order Order schema
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder(project: string, order: Order, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     * Export orders as a CSV file
+     * @summary Export orders
+     * @param {string} project What project it is
+     * @param {string} start Start of date range to filter by when orders were placed
+     * @param {string} [end] End of date range to filter by when orders were placed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportOrders(project: string, start: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
+    /**
+     * Get an order by a given ID.
+     * @summary Get order
+     * @param {string} project What project it is
+     * @param {string} orderId Unique identifier of an order
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrder(project: string, orderId: string, fields?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Order>>;
+    /**
+     * Lists all orders placed on this project, paginated into configurable chunks.
+     * @summary List orders
+     * @param {string} project What project it is
+     * @param {string} [fields] Specifies which fields to return, separated by commas
+     * @param {number} [pageToken] Page reference token
+     * @param {number} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @param {string} [search] Search term to filter based on order reference, customer name and email
+     * @param {Array<string>} [ids] Specify fulfillment IDs to list
+     * @param {Array<Status>} [statuses] Filter by fulfillment status
+     * @param {string} [start] Start of date range to filter by when orders were placed
+     * @param {string} [end] End of date range to filter by when orders were placed
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrders(project: string, fields?: string, pageToken?: number, pageSize?: number, search?: string, ids?: Array<string>, statuses?: Array<Status>, start?: string, end?: string, options?: RawAxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrdersResponse>>;
+};
+/**
+ * OrdersApi - factory interface
+ * @export
+ */
+export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
+    /**
+     * Cancels an order if it has not yet started processing.
+     * @summary Cancel order
+     * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<void>;
+    /**
+     * Confirms an order, and submits it as ready to take payment and begin processing.
+     * @summary Confirm order
+     * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
+     * @summary Create order
+     * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     * Export orders as a CSV file
+     * @summary Export orders
+     * @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<File>;
+    /**
+     * Get an order by a given ID.
+     * @summary Get order
+     * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): AxiosPromise<Order>;
+    /**
+     * Lists all orders placed on this project, paginated into configurable chunks.
+     * @summary List orders
+     * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     */
+    getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): AxiosPromise<OrdersResponse>;
+};
+/**
+ * Request parameters for cancelOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiCancelOrderRequest
+ */
+export interface OrdersApiCancelOrderRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof OrdersApiCancelOrder
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of an order
+     * @type {string}
+     * @memberof OrdersApiCancelOrder
+     */
+    readonly orderId: string;
+    /**
+     * Specifies which fields to return, separated by commas
+     * @type {string}
+     * @memberof OrdersApiCancelOrder
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for confirmOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiConfirmOrderRequest
+ */
+export interface OrdersApiConfirmOrderRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of an order
+     * @type {string}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly orderId: string;
+    /**
+     * ConfirmFulfillment schema
+     * @type {ConfirmOrderRequest}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly confirmOrderRequest: ConfirmOrderRequest;
+    /**
+     * Specifies which fields to return, separated by commas
+     * @type {string}
+     * @memberof OrdersApiConfirmOrder
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for createOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiCreateOrderRequest
+ */
+export interface OrdersApiCreateOrderRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof OrdersApiCreateOrder
+     */
+    readonly project: string;
+    /**
+     * Order schema
+     * @type {Order}
+     * @memberof OrdersApiCreateOrder
+     */
+    readonly order: Order;
+    /**
+     * Specifies which fields to return, separated by commas
+     * @type {string}
+     * @memberof OrdersApiCreateOrder
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for exportOrders operation in OrdersApi.
+ * @export
+ * @interface OrdersApiExportOrdersRequest
+ */
+export interface OrdersApiExportOrdersRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof OrdersApiExportOrders
+     */
+    readonly project: string;
+    /**
+     * Start of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiExportOrders
+     */
+    readonly start: string;
+    /**
+     * End of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiExportOrders
+     */
+    readonly end?: string;
+}
+/**
+ * Request parameters for getOrder operation in OrdersApi.
+ * @export
+ * @interface OrdersApiGetOrderRequest
+ */
+export interface OrdersApiGetOrderRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof OrdersApiGetOrder
+     */
+    readonly project: string;
+    /**
+     * Unique identifier of an order
+     * @type {string}
+     * @memberof OrdersApiGetOrder
+     */
+    readonly orderId: string;
+    /**
+     * Specifies which fields to return, separated by commas
+     * @type {string}
+     * @memberof OrdersApiGetOrder
+     */
+    readonly fields?: string;
+}
+/**
+ * Request parameters for getOrders operation in OrdersApi.
+ * @export
+ * @interface OrdersApiGetOrdersRequest
+ */
+export interface OrdersApiGetOrdersRequest {
+    /**
+     * What project it is
+     * @type {string}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly project: string;
+    /**
+     * Specifies which fields to return, separated by commas
+     * @type {string}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly fields?: string;
+    /**
+     * Page reference token
+     * @type {number}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly pageToken?: number;
+    /**
+     * Max page size. This is the maximum page size that will be returned, but it might be smaller.
+     * @type {number}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly pageSize?: number;
+    /**
+     * Search term to filter based on order reference, customer name and email
+     * @type {string}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly search?: string;
+    /**
+     * Specify fulfillment IDs to list
+     * @type {Array<string>}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly ids?: Array<string>;
+    /**
+     * Filter by fulfillment status
+     * @type {Array<Status>}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly statuses?: Array<Status>;
+    /**
+     * Start of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly start?: string;
+    /**
+     * End of date range to filter by when orders were placed
+     * @type {string}
+     * @memberof OrdersApiGetOrders
+     */
+    readonly end?: string;
+}
+/**
+ * OrdersApi - object-oriented interface
+ * @export
+ * @class OrdersApi
+ * @extends {BaseAPI}
+ */
+export declare class OrdersApi extends BaseAPI {
+    /**
+     * Cancels an order if it has not yet started processing.
+     * @summary Cancel order
+     * @param {OrdersApiCancelOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    cancelOrder(requestParameters: OrdersApiCancelOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
+    /**
+     * Confirms an order, and submits it as ready to take payment and begin processing.
+     * @summary Confirm order
+     * @param {OrdersApiConfirmOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    confirmOrder(requestParameters: OrdersApiConfirmOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
+    /**
+     * Creates a new order for the provided variants. You can fetch details and references to the given project\'s variants from the Product Catalog API.
+     * @summary Create order
+     * @param {OrdersApiCreateOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    createOrder(requestParameters: OrdersApiCreateOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
+    /**
+     * Export orders as a CSV file
+     * @summary Export orders
+     * @param {OrdersApiExportOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    exportOrders(requestParameters: OrdersApiExportOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any>>;
+    /**
+     * Get an order by a given ID.
+     * @summary Get order
+     * @param {OrdersApiGetOrderRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getOrder(requestParameters: OrdersApiGetOrderRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<Order, any>>;
+    /**
+     * Lists all orders placed on this project, paginated into configurable chunks.
+     * @summary List orders
+     * @param {OrdersApiGetOrdersRequest} requestParameters Request parameters.
+     * @param {*} [options] Override http request option.
+     * @throws {RequiredError}
+     * @memberof OrdersApi
+     */
+    getOrders(requestParameters: OrdersApiGetOrdersRequest, options?: RawAxiosRequestConfig): Promise<import("axios").AxiosResponse<OrdersResponse, any>>;
+}