@open-tender/types 0.4.157 → 0.4.158

package/dist/esm/types/api/checkout.d.ts

@@ -1,376 +0,0 @@
-import { ISOString, RequestedAt } from '../datetimes';
-import { CardType, CardTypeName, DeviceType, Money, OrderType, PrepType, ServiceType, TenderStatus, TenderType } from '../global';
-import { CheckoutErrorParams } from '../request';
-import { Cart, CartItemWithPoints } from './cart';
-import { Address, CustomerIdentify } from './customer';
-import { Order, OrderCustomer, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
-export interface SimpleCartOption {
-    id: number;
-    quantity: number;
-    groups: SimpleCartGroups;
-}
-export interface SimpleCartGroup {
-    id: number;
-    options: SimpleCartOption[];
-}
-export declare type SimpleCartGroups = SimpleCartGroup[];
-export interface SimpleCartItem {
-    id: number;
-    quantity: number;
-    groups: SimpleCartGroups;
-    made_for?: string | null;
-    notes?: string | null;
-    cart_guest_id?: number;
-    customer_id?: number;
-}
-export declare type SimpleCart = SimpleCartItem[];
-export interface SimpleCartLookupOption {
-    quantity: number;
-    groupsLookup: Record<string, SimpleCartLookupGroup> | null;
-}
-export interface SimpleCartLookupGroup {
-    options: Record<string, SimpleCartLookupOption>;
-}
-export declare type CheckoutConfigFieldAddress = 'company' | 'contact' | 'phone' | 'unit';
-export declare type CheckoutConfigFieldCustomer = 'company';
-export declare type CheckoutConfigFieldDetails = 'count' | 'eatingUtensils' | 'notes' | 'servingUtensils';
-export interface CheckoutConfigFields {
-    address: CheckoutConfigFieldAddress[];
-    customer: CheckoutConfigFieldCustomer[];
-    details: CheckoutConfigFieldDetails[];
-}
-export interface CheckoutConfigGratuityAmount {
-    amount: Money;
-    percent: Money;
-}
-export interface CheckoutConfigGratuity {
-    default: CheckoutConfigGratuityAmount | null;
-    has_tip: boolean;
-    max_gratuity: CheckoutConfigGratuityAmount | null;
-    options: CheckoutConfigGratuityAmount[];
-}
-export interface CheckoutConfigCurbsideField {
-    label: string;
-    name: keyof OrderFulfillment;
-    placeholder: string;
-}
-export declare type CheckoutConfigCurbsideFields = CheckoutConfigCurbsideField[];
-export interface CheckoutConfigCurbside {
-    description: string;
-    fields: CheckoutConfigCurbsideFields;
-    title: string;
-}
-export interface CheckoutConfigLoyalty {
-    balance: Money;
-    name: string;
-    per: number;
-    remaining: Money;
-}
-export interface CheckoutConfigSurcharge extends OrderSurcharge {
-    label: string;
-}
-export declare type CheckoutConfigSurcharges = CheckoutConfigSurcharge[];
-export interface CheckoutConfig {
-    allow_tax_exempt: boolean;
-    discounts: OrderDiscounts;
-    displayed: CheckoutConfigFields;
-    gratuity: CheckoutConfigGratuity;
-    order_fulfillment: CheckoutConfigCurbside | null;
-    points: CheckoutConfigLoyalty | null;
-    promo_code_limit: number;
-    require_address: boolean;
-    require_cardholder_name: boolean;
-    required: CheckoutConfigFields;
-    surcharges: CheckoutConfigSurcharges;
-    tender_types: TenderType[];
-}
-export interface CheckoutCheck extends Omit<Order, 'customer'> {
-    config: CheckoutConfig;
-    customer: OrderCustomer | null;
-    errors: CheckoutErrorParams;
-}
-export interface OrderCreateDetails {
-    arrival_info?: string | null;
-    cart_id?: number | null;
-    device_type?: DeviceType | null;
-    eating_utensils?: boolean;
-    has_arrived?: boolean;
-    is_tax_exempt?: boolean;
-    notes?: string | null;
-    notes_internal?: string | null;
-    person_count?: number | null;
-    serving_utensils?: boolean;
-    tax_exempt_id?: string | null;
-    order_fulfillment?: boolean;
-    vehicle_color?: string | null;
-    vehicle_id?: string | null;
-    vehicle_type?: string | null;
-}
-export interface OrderCreateGiftCard {
-    id: number;
-    gift_card_id?: number;
-    code?: string;
-    card_number: string;
-    amount: Money;
-    employee_id?: number;
-}
-export declare type OrderCreateGiftCards = OrderCreateGiftCard[];
-export interface OrderCreateSurcharge {
-    id: number;
-}
-export declare type OrderCreateSurcharges = OrderCreateSurcharge[];
-export interface OrderCreateDiscount {
-    id: number;
-    ext_id?: string | null;
-}
-export declare type OrderCreateDiscounts = OrderCreateDiscount[];
-export interface OrderCreateTax {
-    id: number;
-}
-export declare type OrderCreateTaxes = OrderCreateTax[];
-export interface OrderCreatePointsItem {
-    index: number;
-    points: number;
-}
-export declare type OrderCreatePoints = OrderCreatePointsItem[];
-export interface CheckoutFormAddress {
-    company?: string;
-    contact?: string;
-    phone?: string;
-    unit?: string;
-}
-export interface CheckoutFormCustomer {
-    company?: string;
-    customer_id?: number;
-    email?: string;
-    first_name?: string;
-    password?: string;
-    phone?: string;
-    last_name?: string;
-}
-export interface CheckoutTenderCreditGuest {
-    acct: string;
-    addr?: string;
-    amount: Money;
-    card_type_name: CardTypeName;
-    cardholder_name?: string;
-    cvv: string;
-    exp: string;
-    is_default: boolean;
-    last4: string;
-    masked: string;
-    tender_status?: TenderStatus;
-    tender_type: TenderType;
-    zip: string;
-}
-export interface CheckoutTenderCreditCustomer {
-    amount: Money;
-    card_type?: CardType;
-    card_type_name?: CardTypeName;
-    customer_card_id: number;
-    is_default?: boolean;
-    last4?: string;
-    masked?: string;
-    tender_status?: TenderStatus;
-    tender_type: TenderType;
-}
-export interface CheckoutTenderGiftCard {
-    amount: Money;
-    balance?: Money;
-    card_number: string;
-    pin?: string;
-    tender_status?: TenderStatus;
-    tender_type: TenderType;
-}
-export interface CheckoutTenderHouseAccount {
-    amount: Money;
-    approved_contact?: boolean;
-    domain?: string | null;
-    house_account_id: number;
-    name: string;
-    order_type?: OrderType | null;
-    pin?: string;
-    revenue_centers?: number[];
-    service_type?: ServiceType | null;
-    tender_status?: TenderStatus;
-    tender_type?: TenderType;
-}
-export interface CheckoutTenderApplePay {
-    amount: Money;
-    tender_status?: TenderStatus;
-    tender_type: TenderType;
-    token: any;
-}
-export interface CheckoutTenderGooglePay {
-    amount: Money;
-    tender_status?: TenderStatus;
-    tender_type: TenderType;
-    token: any;
-}
-export declare type CheckoutTender = CheckoutTenderCreditGuest | CheckoutTenderCreditCustomer | CheckoutTenderGiftCard | CheckoutTenderHouseAccount | CheckoutTenderApplePay | CheckoutTenderGooglePay;
-export declare type CheckoutTenders = CheckoutTender[];
-export declare const isCreditCustomerCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderCreditCustomer;
-export declare const isCreditGuestCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderCreditGuest;
-export declare const isGiftCardCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderGiftCard;
-export declare const isHouseAccountCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderHouseAccount;
-export declare const isApplePayCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderApplePay;
-export declare const isGooglePayCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderGooglePay;
-export declare type CheckoutPromoCodes = string[];
-export interface CheckoutForm {
-    address: CheckoutFormAddress;
-    customer: CheckoutFormCustomer;
-    details: OrderCreateDetails;
-    discounts: OrderCreateDiscounts;
-    points: OrderCreatePoints;
-    promoCodes: CheckoutPromoCodes;
-    surcharges: OrderCreateSurcharges;
-    tenders: CheckoutTenders;
-    tip: Money | null;
-    token?: string | null;
-    kount_device_session_id?: string;
-}
-export interface OrderData {
-    address: Address | null;
-    cart: Cart;
-    cartId: number | null;
-    customer: CheckoutFormCustomer | null;
-    deposit: Money | null;
-    details: OrderCreateDetails | null;
-    deviceType: DeviceType | null;
-    discounts: OrderCreateDiscounts | null;
-    discountsInternal?: OrderCreateDiscounts | null;
-    orderId: number | null;
-    points: OrderCreatePoints | null;
-    prepType: PrepType | null;
-    promoCodes: CheckoutPromoCodes | null;
-    requestedAt: RequestedAt;
-    revenueCenterId: number;
-    save?: boolean;
-    serviceType: ServiceType;
-    surcharges: OrderCreateSurcharges | null;
-    table: string | null;
-    tenders: CheckoutTenders | null;
-    tip: Money | null;
-    token?: string | null;
-    kount_device_session_id?: string;
-}
-export interface OrderCreate {
-    address?: Address | null;
-    cart: SimpleCart;
-    cart_id?: number;
-    customer?: CheckoutFormCustomer | null;
-    deposit?: Money | null;
-    details?: OrderCreateDetails | null;
-    discounts?: OrderCreateDiscounts;
-    discounts_internal?: OrderCreateDiscounts | null;
-    order_id?: number;
-    order_uuid?: string;
-    points?: OrderCreatePoints;
-    promo_codes?: CheckoutPromoCodes;
-    requested_at: RequestedAt;
-    revenue_center_id: number;
-    save?: boolean;
-    service_type: ServiceType;
-    shipment_id?: string;
-    surcharges?: OrderCreateSurcharges;
-    taxes?: OrderCreateTaxes;
-    tenders?: CheckoutTenders;
-    tip?: Money;
-    token?: string | null;
-    kount_device_session_id?: string;
-}
-export interface CheckoutPoints {
-    points: CheckoutConfigLoyalty;
-    applied: OrderCreatePoints;
-    apply: (item: CartItemWithPoints) => void;
-    remove: (item: CartItemWithPoints) => void;
-}
-export interface CheckoutTenderPos {
-    acct?: string;
-    addr?: string;
-    amount?: Money;
-    cash_back?: Money;
-    customer_card_id?: string;
-    cardholder_name?: string;
-    cvv?: string;
-    exp?: string;
-    gift_card_code?: string | number;
-    house_account_pin?: string;
-    save?: boolean;
-    tender_type: TenderType;
-    track_data?: string;
-    zip?: string;
-}
-export interface ChipDNA {
-    ACCOUNT_TYPE: string;
-    ACQUIRER_RESPONSE_CODE: string;
-    AID: string;
-    AUTH_CODE: string;
-    AUTH_DATE_TIME: string;
-    CARDEASE_REFERENCE: string;
-    CARDHOLDER_VERIFICATION: string;
-    CARD_HASH: string;
-    CARD_HASH_COLLECTION: string;
-    ource: string;
-    CARD_HOLDER_LAST_NAME: string;
-    CARD_REFERENCE: string;
-    CARD_SCHEME: string;
-    CARD_SCHEME_ID: string;
-    EXPIRY_DATE: string;
-    MERCHANT_ID_MASKED: string;
-    MERCHANT_NAME: string;
-    PAN_MASKED: string;
-    PAN_SEQUENCE: string;
-    RECEIPT_DATA: string;
-    REFERENCE: string;
-    SIGNATURE_CAPTURED: string;
-    SIGNATURE_VERIFICATION_REQUIRED: string;
-    TERMINAL_ID_MASKED: string;
-    TOTAL_AMOUNT: string;
-    TRANSACTION_ID: string;
-    TRANSACTION_RESULT: string;
-    TRANSACTION_SOURCE: string;
-    TRANSACTION_TYPE: string;
-}
-export interface ChipDNACreditCard {
-    authcode: string;
-    card_type: CardType;
-    charged_at: ISOString;
-    entry_mode: string;
-    external_api_id: number;
-    last4: string;
-    masked: string;
-    merchant_id: string;
-    processor_id: string;
-    profileid: string;
-    retref: string;
-    token: string;
-}
-export interface CheckoutTenderChipDNA {
-    amount: Money;
-    chipdna: ChipDNA;
-    created_at: ISOString;
-    credit_card: ChipDNACreditCard;
-    is_replaced: boolean;
-    tender_status: TenderStatus;
-    tender_type: TenderType;
-    tender_uuid: string;
-}
-export interface OrderCreatePos extends Omit<OrderCreate, 'customer'> {
-    customer: CustomerIdentify | null;
-    made_for?: string | null;
-    phone?: string | null;
-    prep_type?: PrepType | null;
-    notes_internal?: string | null;
-    device_type?: DeviceType | null;
-}
-export interface OrderCreateSendReceipt {
-    email: string | null;
-    phone: string | null;
-}
-export interface GratuityIncrement {
-    amount?: Money;
-    isDefault: boolean;
-    percentage: string;
-}
-export declare type GratuityIncrements = GratuityIncrement[];

package/dist/esm/types/api/checkout.js

@@ -1,20 +0,0 @@
-export const isCreditCustomerCheckoutTender = (tender) => {
-    return (tender.tender_type === 'CREDIT' &&
-        tender.customer_card_id !== undefined);
-};
-export const isCreditGuestCheckoutTender = (tender) => {
-    return (tender.tender_type === 'CREDIT' &&
-        tender.acct !== undefined);
-};
-export const isGiftCardCheckoutTender = (tender) => {
-    return tender.tender_type === 'GIFT_CARD';
-};
-export const isHouseAccountCheckoutTender = (tender) => {
-    return tender.tender_type === 'HOUSE_ACCOUNT';
-};
-export const isApplePayCheckoutTender = (tender) => {
-    return tender.tender_type === 'APPLE_PAY';
-};
-export const isGooglePayCheckoutTender = (tender) => {
-    return tender.tender_type === 'GOOGLE_PAY';
-};

package/dist/esm/types/api/completedOrders.d.ts

@@ -1,42 +0,0 @@
-import { ISOString, Timezone } from '../datetimes';
-import { Money, OrderType, ServiceType, TenderType } from '../global';
-import { RequestError } from '../request';
-import { CreditCard } from './creditCards';
-import { Address, Customer, HouseAccount } from './customer';
-import { OrderDelivery, OrderDetails, OrderDiscounts, OrderFulfillment, OrderRating, OrderRevenueCenter, OrderShipment, OrderSurcharges, OrderTaxes, OrderTotals } from './order';
-export interface CompletedOrderConfig {
-    discounts: OrderDiscounts | [];
-    surcharges: OrderSurcharges | [];
-}
-export interface OrderRefund {
-    amount: Money;
-    credit_card: CreditCard | null;
-    house_account: HouseAccount | null;
-    tender_type: TenderType;
-}
-export interface CompletedOrder {
-    address: Address | null;
-    config: CompletedOrderConfig;
-    created_at: ISOString;
-    customer: Customer;
-    delivery: OrderDelivery | null;
-    details: OrderDetails | null;
-    errors: RequestError;
-    estimated_at: ISOString;
-    is_asap: boolean;
-    is_editable: boolean;
-    is_future: boolean;
-    order_fulfillment: OrderFulfillment | null;
-    rating: OrderRating;
-    refunds: Array<OrderRefund>;
-    requested_at: ISOString;
-    requested_time: string;
-    revenue_center: OrderRevenueCenter;
-    service_type: ServiceType;
-    shipment: OrderShipment;
-    texes: OrderTaxes;
-    timezone: Timezone;
-    totals: OrderTotals;
-    order_type: OrderType;
-}
-export declare type CompletedOrders = Array<CompletedOrder>;

package/dist/esm/types/api/completedOrders.js

@@ -1 +0,0 @@
-export {};