@teemill/orders 1.0.0 → 1.0.3

package/dist/api.d.ts

@@ -1,750 +0,0 @@
-/**
- * Orders API
- * Manage Teemill Orders  For full documentation on functionality and account settings go to [teemill.com](https://teemill.com)
- *
- * The version of the OpenAPI document: 1.0.0
- * 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, AxiosRequestConfig } 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 ConfirmOrderRequest
- */
-export interface ConfirmOrderRequest {
-    /**
-     *
-     * @type {Array<ConfirmOrderRequestFulfillmentsInner>}
-     * @memberof ConfirmOrderRequest
-     */
-    'fulfillments': Array<ConfirmOrderRequestFulfillmentsInner>;
-}
-/**
- *
- * @export
- * @interface ConfirmOrderRequestFulfillmentsInner
- */
-export interface ConfirmOrderRequestFulfillmentsInner {
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof ConfirmOrderRequestFulfillmentsInner
-     */
-    'fulfillmentId': string;
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof ConfirmOrderRequestFulfillmentsInner
-     */
-    'shippingMethodId': string;
-}
-/**
- *
- * @export
- * @interface Fulfillment
- */
-export interface Fulfillment {
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof Fulfillment
-     */
-    'id'?: string;
-    /**
-     *
-     * @type {Status}
-     * @memberof Fulfillment
-     */
-    'status'?: Status;
-    /**
-     *
-     * @type {Array<FulfillmentItemsInner>}
-     * @memberof Fulfillment
-     */
-    'items'?: Array<FulfillmentItemsInner>;
-    /**
-     *
-     * @type {Tracking}
-     * @memberof Fulfillment
-     */
-    'tracking'?: Tracking | null;
-    /**
-     * Shipping method currently set
-     * @type {ShippingMethod}
-     * @memberof Fulfillment
-     */
-    'shippingMethod'?: ShippingMethod;
-    /**
-     *
-     * @type {Array<ShippingMethod>}
-     * @memberof Fulfillment
-     */
-    'availableShippingMethods'?: Array<ShippingMethod>;
-    /**
-     * Weight of the package being shipped in grams
-     * @type {number}
-     * @memberof Fulfillment
-     */
-    'packageWeight'?: number;
-}
-/**
- *
- * @export
- * @interface FulfillmentItemsInner
- */
-export interface FulfillmentItemsInner {
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof FulfillmentItemsInner
-     */
-    'id'?: string;
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof FulfillmentItemsInner
-     */
-    'itemId'?: string;
-    /**
-     * Number of this item being fulfilled
-     * @type {number}
-     * @memberof FulfillmentItemsInner
-     */
-    'quantity'?: number;
-}
-/**
- *
- * @export
- * @interface ModelError
- */
-export interface ModelError {
-    /**
-     *
-     * @type {string}
-     * @memberof ModelError
-     */
-    'code'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof ModelError
-     */
-    'message': string;
-}
-/**
- *
- * @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 {OrderContactInformation}
-     * @memberof Order
-     */
-    'contactInformation': OrderContactInformation;
-    /**
-     * Order recipient\'s address
-     * @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 {OrderOrigin}
-     * @memberof Order
-     */
-    'origin'?: OrderOrigin;
-}
-/**
- * Order recipient contact information, used only for courier tracking/updates.
- * @export
- * @interface OrderContactInformation
- */
-export interface OrderContactInformation {
-    /**
-     *
-     * @type {string}
-     * @memberof OrderContactInformation
-     */
-    'email': string;
-    /**
-     *
-     * @type {string}
-     * @memberof OrderContactInformation
-     */
-    'phone'?: string | null;
-}
-/**
- *
- * @export
- * @interface OrderItem
- */
-export interface OrderItem {
-    /**
-     * Unique object identifier
-     * @type {string}
-     * @memberof OrderItem
-     */
-    'id'?: string;
-    /**
-     * A reference to the resource location
-     * @type {string}
-     * @memberof OrderItem
-     */
-    'variantRef': string;
-    /**
-     *
-     * @type {number}
-     * @memberof OrderItem
-     */
-    'quantity': number;
-    /**
-     *
-     * @type {OrderItemTotalPrice}
-     * @memberof OrderItem
-     */
-    'totalPrice'?: OrderItemTotalPrice;
-    /**
-     *
-     * @type {OrderItemTaxPrice}
-     * @memberof OrderItem
-     */
-    'taxPrice'?: OrderItemTaxPrice;
-    /**
-     *
-     * @type {OrderItemTotalPrice}
-     * @memberof OrderItem
-     */
-    'subtotalPrice'?: OrderItemTotalPrice;
-    /**
-     *
-     * @type {OrderItemTotalPrice}
-     * @memberof OrderItem
-     */
-    'discountPrice'?: OrderItemTotalPrice;
-    /**
-     *
-     * @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 OrderItemTotalPrice
- */
-export interface OrderItemTotalPrice {
-    /**
-     * Price including tax in the specified currency.
-     * @type {string}
-     * @memberof OrderItemTotalPrice
-     */
-    'amount'?: string;
-    /**
-     * Currency code for the currency the price is valued in.
-     * @type {string}
-     * @memberof OrderItemTotalPrice
-     */
-    'currencyCode'?: string;
-}
-/**
- *
- * @export
- * @interface OrderOrigin
- */
-export interface OrderOrigin {
-    /**
-     *
-     * @type {string}
-     * @memberof OrderOrigin
-     */
-    'code'?: string;
-    /**
-     *
-     * @type {boolean}
-     * @memberof OrderOrigin
-     */
-    '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 {ShippingMethodDeliveryEstimates}
-     * @memberof ShippingMethod
-     */
-    'deliveryEstimates'?: ShippingMethodDeliveryEstimates;
-    /**
-     *
-     * @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
- * @interface ShippingMethodDeliveryEstimates
- */
-export interface ShippingMethodDeliveryEstimates {
-    /**
-     * ISO 8601 Timestamp
-     * @type {string}
-     * @memberof ShippingMethodDeliveryEstimates
-     */
-    'min'?: string;
-    /**
-     * ISO 8601 Timestamp
-     * @type {string}
-     * @memberof ShippingMethodDeliveryEstimates
-     */
-    'max'?: string;
-}
-/**
- *
- * @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 Tracking
- */
-export interface Tracking {
-    /**
-     *
-     * @type {string}
-     * @memberof Tracking
-     */
-    'courier'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tracking
-     */
-    'code'?: string;
-    /**
-     *
-     * @type {string}
-     * @memberof Tracking
-     */
-    'url'?: string;
-}
-/**
- * OrdersApi - axios parameter creator
- * @export
- */
-export declare const OrdersApiAxiosParamCreator: (configuration?: Configuration) => {
-    /**
-     * Confirms and order, and submits it as ready to take payment and begin processing.
-     * @summary Confirm order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    confirmOrder: (project: any, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Creates a new order for the provided variants.
-     * @summary Create order
-     * @param {any} project What project it is
-     * @param {Order} order Order schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createOrder: (project: any, order: Order, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Get an order
-     * @summary Get order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrder: (project: any, orderId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-    /**
-     * Lists all orders available paginated into chunks
-     * @summary List orders
-     * @param {any} [pageToken] Page reference token
-     * @param {any} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {any} [start] Start of date range to filter by when orders were placed
-     * @param {any} [end] End of date range to filter by when orders were placed
-     * @param {any} [search] Search term to filter based on order reference, customer name and email
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrders: (pageToken?: any, pageSize?: any, start?: any, end?: any, search?: any, options?: AxiosRequestConfig) => Promise<RequestArgs>;
-};
-/**
- * OrdersApi - functional programming interface
- * @export
- */
-export declare const OrdersApiFp: (configuration?: Configuration) => {
-    /**
-     * Confirms and order, and submits it as ready to take payment and begin processing.
-     * @summary Confirm order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    confirmOrder(project: any, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Creates a new order for the provided variants.
-     * @summary Create order
-     * @param {any} project What project it is
-     * @param {Order} order Order schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createOrder(project: any, order: Order, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Get an order
-     * @summary Get order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrder(project: any, orderId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-    /**
-     * Lists all orders available paginated into chunks
-     * @summary List orders
-     * @param {any} [pageToken] Page reference token
-     * @param {any} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {any} [start] Start of date range to filter by when orders were placed
-     * @param {any} [end] End of date range to filter by when orders were placed
-     * @param {any} [search] Search term to filter based on order reference, customer name and email
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrders(pageToken?: any, pageSize?: any, start?: any, end?: any, search?: any, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
-};
-/**
- * OrdersApi - factory interface
- * @export
- */
-export declare const OrdersApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
-    /**
-     * Confirms and order, and submits it as ready to take payment and begin processing.
-     * @summary Confirm order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    confirmOrder(project: any, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: any): AxiosPromise<void>;
-    /**
-     * Creates a new order for the provided variants.
-     * @summary Create order
-     * @param {any} project What project it is
-     * @param {Order} order Order schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    createOrder(project: any, order: Order, options?: any): AxiosPromise<void>;
-    /**
-     * Get an order
-     * @summary Get order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrder(project: any, orderId: string, options?: any): AxiosPromise<void>;
-    /**
-     * Lists all orders available paginated into chunks
-     * @summary List orders
-     * @param {any} [pageToken] Page reference token
-     * @param {any} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {any} [start] Start of date range to filter by when orders were placed
-     * @param {any} [end] End of date range to filter by when orders were placed
-     * @param {any} [search] Search term to filter based on order reference, customer name and email
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     */
-    getOrders(pageToken?: any, pageSize?: any, start?: any, end?: any, search?: any, options?: any): AxiosPromise<void>;
-};
-/**
- * OrdersApi - object-oriented interface
- * @export
- * @class OrdersApi
- * @extends {BaseAPI}
- */
-export declare class OrdersApi extends BaseAPI {
-    /**
-     * Confirms and order, and submits it as ready to take payment and begin processing.
-     * @summary Confirm order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {ConfirmOrderRequest} confirmOrderRequest ConfirmFulfillment schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrdersApi
-     */
-    confirmOrder(project: any, orderId: string, confirmOrderRequest: ConfirmOrderRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
-    /**
-     * Creates a new order for the provided variants.
-     * @summary Create order
-     * @param {any} project What project it is
-     * @param {Order} order Order schema
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrdersApi
-     */
-    createOrder(project: any, order: Order, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
-    /**
-     * Get an order
-     * @summary Get order
-     * @param {any} project What project it is
-     * @param {string} orderId Unique identifier of an order
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrdersApi
-     */
-    getOrder(project: any, orderId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
-    /**
-     * Lists all orders available paginated into chunks
-     * @summary List orders
-     * @param {any} [pageToken] Page reference token
-     * @param {any} [pageSize] Max page size. This is the maximum page size that will be returned, but it might be smaller.
-     * @param {any} [start] Start of date range to filter by when orders were placed
-     * @param {any} [end] End of date range to filter by when orders were placed
-     * @param {any} [search] Search term to filter based on order reference, customer name and email
-     * @param {*} [options] Override http request option.
-     * @throws {RequiredError}
-     * @memberof OrdersApi
-     */
-    getOrders(pageToken?: any, pageSize?: any, start?: any, end?: any, search?: any, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
-}