@apideck/node/dist/gen/models/Order.d.ts

Apideck Node.js SDK

/**
 * Apideck
 * The Apideck OpenAPI Spec: SDK Optimized
 *
 * The version of the OpenAPI document: 10.13.0
 * Contact: support@apideck.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 { Currency } from './Currency';
import { OrderCustomers } from './OrderCustomers';
import { OrderDiscounts } from './OrderDiscounts';
import { OrderFulfillments } from './OrderFulfillments';
import { OrderLineItems } from './OrderLineItems';
import { OrderPayments } from './OrderPayments';
import { OrderRefunds } from './OrderRefunds';
import { OrderTenders } from './OrderTenders';
import { PassThroughBody } from './PassThroughBody';
import { ServiceCharges } from './ServiceCharges';
/**
 *
 * @export
 * @interface Order
 */
export interface Order {
    /**
     *
     * @type {string}
     * @memberof Order
     */
    merchant_id: string;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    location_id: string;
    /**
     * A unique identifier for an object.
     * @type {string}
     * @memberof Order
     */
    readonly id?: string;
    /**
     * A value you specify that uniquely identifies this request among requests you have sent.
     * @type {string}
     * @memberof Order
     */
    idempotency_key?: string;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    order_number?: string;
    /**
     *
     * @type {Date}
     * @memberof Order
     */
    order_date?: Date | null;
    /**
     *
     * @type {Date}
     * @memberof Order
     */
    closed_date?: Date | null;
    /**
     * An optional user-defined reference ID that associates this record with another entity in an external system. For example, a customer ID from an external customer management system.
     * @type {string}
     * @memberof Order
     */
    reference_id?: string | null;
    /**
     * Order status. Clover specific: If no value is set, the status defaults to hidden, which indicates a hidden order. A hidden order is not displayed in user interfaces and can only be retrieved by its id. When creating an order via the REST API the value must be manually set to 'open'. More info [https://docs.clover.com/reference/orderupdateorder]()
     * @type {string}
     * @memberof Order
     */
    status?: OrderStatus;
    /**
     * Is this order paid or not?
     * @type {string}
     * @memberof Order
     */
    payment_status?: OrderPaymentStatus;
    /**
     *
     * @type {Currency}
     * @memberof Order
     */
    currency?: Currency | null;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    title?: string;
    /**
     * A note with information about this order, may be printed on the order receipt and displayed in apps
     * @type {string}
     * @memberof Order
     */
    note?: string;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    customer_id?: string;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    employee_id?: string;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    order_type_id?: string;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    table?: string;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    seat?: string;
    /**
     *
     * @type {number}
     * @memberof Order
     */
    total_amount?: number | null;
    /**
     *
     * @type {number}
     * @memberof Order
     */
    total_tip?: number | null;
    /**
     *
     * @type {number}
     * @memberof Order
     */
    total_tax?: number | null;
    /**
     *
     * @type {number}
     * @memberof Order
     */
    total_discount?: number | null;
    /**
     *
     * @type {number}
     * @memberof Order
     */
    total_refund?: number | null;
    /**
     *
     * @type {number}
     * @memberof Order
     */
    total_service_charge?: number | null;
    /**
     *
     * @type {boolean}
     * @memberof Order
     */
    refunded?: boolean;
    /**
     *
     * @type {Array<OrderCustomers>}
     * @memberof Order
     */
    customers?: Array<OrderCustomers>;
    /**
     *
     * @type {Array<OrderFulfillments>}
     * @memberof Order
     */
    fulfillments?: Array<OrderFulfillments>;
    /**
     *
     * @type {Array<OrderLineItems>}
     * @memberof Order
     */
    line_items?: Array<OrderLineItems>;
    /**
     *
     * @type {Array<OrderPayments>}
     * @memberof Order
     */
    payments?: Array<OrderPayments>;
    /**
     *
     * @type {ServiceCharges}
     * @memberof Order
     */
    service_charges?: ServiceCharges;
    /**
     *
     * @type {Array<OrderRefunds>}
     * @memberof Order
     */
    refunds?: Array<OrderRefunds>;
    /**
     *
     * @type {Array<object>}
     * @memberof Order
     */
    taxes?: Array<object>;
    /**
     *
     * @type {Array<OrderDiscounts>}
     * @memberof Order
     */
    discounts?: Array<OrderDiscounts>;
    /**
     *
     * @type {Array<OrderTenders>}
     * @memberof Order
     */
    tenders?: Array<OrderTenders>;
    /**
     * Source of order. Indicates the way that the order was placed.
     * @type {string}
     * @memberof Order
     */
    readonly source?: OrderSource;
    /**
     *
     * @type {boolean}
     * @memberof Order
     */
    voided?: boolean;
    /**
     *
     * @type {Date}
     * @memberof Order
     */
    readonly voided_at?: Date;
    /**
     * When custom mappings are configured on the resource, the result is included here.
     * @type {object}
     * @memberof Order
     */
    readonly custom_mappings?: object | null;
    /**
     *
     * @type {string}
     * @memberof Order
     */
    version?: string | null;
    /**
     * The user who last updated the object.
     * @type {string}
     * @memberof Order
     */
    readonly updated_by?: string | null;
    /**
     * The user who created the object.
     * @type {string}
     * @memberof Order
     */
    readonly created_by?: string | null;
    /**
     * The date and time when the object was last updated.
     * @type {Date}
     * @memberof Order
     */
    readonly updated_at?: Date | null;
    /**
     * The date and time when the object was created.
     * @type {Date}
     * @memberof Order
     */
    readonly created_at?: Date | null;
    /**
     *
     * @type {PassThroughBody}
     * @memberof Order
     */
    pass_through?: PassThroughBody;
}
/**
 * @export
 * @enum {string}
 */
export declare enum OrderStatus {
    open = "open",
    draft = "draft",
    delivered = "delivered",
    delayed = "delayed",
    voided = "voided",
    completed = "completed",
    hidden = "hidden"
}
/**
 * @export
 * @enum {string}
 */
export declare enum OrderPaymentStatus {
    open = "open",
    paid = "paid",
    refunded = "refunded",
    credited = "credited",
    partially_paid = "partially_paid",
    partially_refunded = "partially_refunded",
    unknown = "unknown"
}
/**
 * @export
 * @enum {string}
 */
export declare enum OrderSource {
    in_store = "in-store",
    online = "online",
    opt = "opt",
    api = "api",
    kiosk = "kiosk",
    caller_id = "caller-id",
    google = "google",
    invoice = "invoice"
}
export declare function OrderFromJSON(json: any): Order;
export declare function OrderFromJSONTyped(json: any, ignoreDiscriminator: boolean): Order;
export declare function OrderToJSON(value?: Order | null): any;