@open-tender/types 0.1.4 → 0.1.6

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

@@ -1,39 +1,9 @@
-import { ISOString, TimezonePython } from '../datetimes';
-import { DiscountType, GratuityType, Money, OrderType, ServiceType, TenderType } from '../global';
-import { Address, Customer, CustomerGiftCard, LoyaltyPoints } from './customer';
-import { OrderDetails, OrderDiscounts, OrderFulfillment, OrderItem, OrderRevenueCenter, OrderShipment, OrderSurcharges, OrderTaxes, OrderTenders, OrderTotals } from './order';
-export interface CustomerIdentifier {
-    card_token?: string;
-    phone?: string;
-    qr_code?: string;
-}
-export interface IdentifyCustomer {
-    data: CustomerIdentifier;
-    callback?: () => void;
-    showError?: boolean;
-}
-export interface CustomerDiscount {
-    customer_loyalty_id: number;
-    loyalty_program_id: number;
-    order_type: OrderType;
-    amount: Money;
-    name: string;
-    discount_id: number;
-    discount_type: DiscountType;
-    description: string;
-    before_surcharge: boolean;
-    is_taxed: boolean;
-    is_promo_code: boolean;
-    is_auto: boolean;
-    is_loyalty: boolean;
-}
-export declare type CustomerDiscounts = Array<CustomerDiscount>;
-export interface CustomerCheckout {
-    customer: Customer;
-    discounts: CustomerDiscounts;
-    points: any;
-    discount: any;
-}
+import { RequestedAt } from '../datetimes';
+import { CardType, CardTypeName, DeviceType, DiscountType, Money, OrderType, PrepType, ServiceType, TenderType } from '../global';
+import { RequestErrorParams } from '../request';
+import { Cart } from './cart';
+import { Address, Customer } from './customer';
+import { Order, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
 export interface SimpleCartOption {
     id: number;
     quantity: number;
@@ -61,13 +31,70 @@ export interface SimpleCartLookupOption {
 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: number;
+    name: string;
+    per: 5;
+    remaining: number;
+}
+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;
+    required: CheckoutConfigFields;
+    surcharges: CheckoutConfigSurcharges;
+    tender_types: TenderType[];
+}
+export interface CheckoutCheck extends Order {
+    config: CheckoutConfig;
+    errors: RequestErrorParams;
+}
 export interface OrderCreateDetails {
+    cart_id?: number | null;
+    device_type?: DeviceType | null;
     eating_utensils?: boolean;
-    serving_utensils?: boolean;
-    person_count?: number | null;
     notes?: string | null;
+    notes_internal?: string | null;
+    person_count?: number | null;
+    serving_utensils?: boolean;
     tax_exempt_id?: string | null;
-    cart_id?: number | null;
 }
 export interface OrderCreateGiftCard {
     id: number;
@@ -80,108 +107,157 @@ export interface 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 interface OrderCreatePoints {
+export declare type OrderCreateTaxes = OrderCreateTax[];
+export interface OrderCreatePointsItem {
     index: number;
     points: number;
 }
-export interface Tender {
+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;
+    phone?: string;
+    last_name?: string;
+}
+export interface CheckoutTenderCreditGuest {
+    acct: string;
+    cvv: string;
+    amount: Money;
+    card_type_name: CardTypeName;
+    exp: string;
+    is_default: false;
+    last4: string;
+    masked: string;
+    tender_type: TenderType;
+    zip: string;
+}
+export interface CheckoutTenderCreditCustomer {
+    tender_type: TenderType;
+    amount: Money;
+    card_type: CardType;
+    card_type_name: CardTypeName;
+    customer_card_id: number;
+    last4: string;
+    masked: string;
+    is_default: false;
+}
+export interface CheckoutTenderGiftCard {
+    amount: Money;
+    balance?: Money;
+    card_number: string;
+    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_type: TenderType;
-    amount?: Money;
-    cash_back?: Money;
-    customer_card_id?: string;
-    acct?: string;
-    cvv?: string;
-    exp?: string;
-    zip?: string;
-    save?: boolean;
+}
+export declare type CheckoutTender = CheckoutTenderCreditGuest | CheckoutTenderCreditCustomer | CheckoutTenderGiftCard | CheckoutTenderHouseAccount;
+export declare type CheckoutTenders = CheckoutTender[];
+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;
+}
+export interface OrderData {
+    address: Address | null;
+    cart: Cart;
+    cartId: number | null;
+    customer: CheckoutFormCustomer;
+    details: OrderCreateDetails | null;
+    deviceType: DeviceType | null;
+    discounts: OrderCreateDiscounts | null;
+    orderId: number | null;
+    points: OrderCreatePoints | null;
+    prepType: PrepType | null;
+    promoCodes: CheckoutPromoCodes | null;
+    requestedAt: RequestedAt;
+    revenueCenterId: number;
+    serviceType: ServiceType;
+    surcharges: OrderCreateSurcharges | null;
+    table: string | null;
+    tenders: CheckoutTenders | null;
+    tip: Money | null;
 }
 export interface OrderCreate {
     address?: Address | null;
     cart: SimpleCart;
-    customer?: Customer | null;
+    cart_id?: number;
+    customer?: CheckoutFormCustomer | null;
     details?: OrderCreateDetails | null;
-    discounts?: Array<OrderCreateDiscount>;
-    gift_cards?: Array<OrderCreateGiftCard>;
-    is_tax_exempt?: boolean;
-    made_for?: string;
-    order_type?: OrderType;
-    order_uuid?: string;
-    points?: Array<OrderCreatePoints>;
-    promo_codes?: string[];
-    requested_at: ISOString | 'asap';
-    revenue_center_id?: number;
+    discounts?: OrderCreateDiscounts;
+    order_id?: number;
+    points?: OrderCreatePoints;
+    promo_codes?: CheckoutPromoCodes;
+    requested_at: RequestedAt;
+    revenue_center_id: number;
     service_type: ServiceType;
     shipment_id?: string;
-    surcharges?: Array<OrderCreateSurcharge>;
-    taxes?: Array<OrderCreateTax>;
-    tenders?: Array<Tender>;
+    surcharges?: OrderCreateSurcharges;
+    taxes?: OrderCreateTaxes;
+    tenders?: CheckoutTenders;
     tip?: Money;
 }
-export interface CheckoutConfigDisplayed {
-    address: string[];
-    customer: string[];
-    details: string[];
-}
-export interface CheckoutConfigGratuity {
-    default: {
-        [key in GratuityType]: string;
-    } | null;
-    has_tip: boolean;
-    max_gratuity: {
-        [key in GratuityType]: string;
-    } | null;
-    options: {
-        [key in GratuityType]: string;
-    }[];
+export interface CustomerIdentifier {
+    card_token?: string;
+    phone?: string;
+    qr_code?: string;
 }
-export interface CheckoutConfig {
-    allow_tax_exempt: boolean;
-    discounts: OrderDiscounts;
-    displayed: CheckoutConfigDisplayed;
-    gratuity: CheckoutConfigGratuity;
-    order_fulfillment: OrderFulfillment;
-    points: LoyaltyPoints | null;
-    promo_code_limit: number;
-    required: CheckoutConfigDisplayed;
-    surcharges: OrderSurcharges;
-    tender_types: Array<TenderType>;
+export interface IdentifyCustomer {
+    data: CustomerIdentifier;
+    callback?: () => void;
+    showError?: boolean;
 }
-export interface CheckoutForm {
-    address: Partial<Address> | null;
-    customer: Customer;
-    details: Partial<OrderDetails>;
-    discounts: OrderDiscounts;
-    points: Array<LoyaltyPoints>;
-    promoCodes: any;
-    surcharges: OrderSurcharges;
-    tenders: OrderTenders;
-    tip: any;
+export interface CustomerDiscount {
+    customer_loyalty_id: number;
+    loyalty_program_id: number;
+    order_type: OrderType;
+    amount: Money;
+    name: string;
+    discount_id: number;
+    discount_type: DiscountType;
+    description: string;
+    before_surcharge: boolean;
+    is_taxed: boolean;
+    is_promo_code: boolean;
+    is_auto: boolean;
+    is_loyalty: boolean;
 }
-export interface CheckoutCheck {
-    address: Address | null;
-    order_id?: string | number;
-    cart: Array<OrderItem>;
-    config: CheckoutConfig;
+export declare type CustomerDiscounts = Array<CustomerDiscount>;
+export interface CustomerCheckout {
     customer: Customer;
-    details: OrderDetails;
-    discounts: OrderDiscounts;
-    order_type: OrderType;
-    requested_at: ISOString;
-    revenue_center: OrderRevenueCenter;
-    service_type: ServiceType;
-    shipment: OrderShipment | null;
-    surcharges: OrderSurcharges;
-    taxes: OrderTaxes;
-    tenders: OrderTenders;
-    timezone: TimezonePython;
-    totals: OrderTotals;
-    gift_cards: Array<Partial<CustomerGiftCard>>;
-    errors: any;
+    discounts: CustomerDiscounts;
+    points: any;
+    discount: any;
 }

package/dist/cjs/types/api/config.d.ts

@@ -528,6 +528,9 @@ export interface ConfigCountColors {
     weight: string;
 }
 export declare type ConfigFontSizes = 'big' | 'giga' | 'h1' | 'h2' | 'h3' | 'h4' | 'h5' | 'h6' | 'main' | 'mega' | 'small' | 'tera' | 'xBig' | 'xSmall' | 'xxBig' | 'xxSmall';
+export declare type ConfigThemeFontSizes = Record<string, string> & {
+    [keys in ConfigFontSizes]: string;
+};
 export interface ConfigFont {
     color: string;
     family: string;
@@ -535,9 +538,7 @@ export interface ConfigFont {
     fontSmoothing: string;
     letterSpacing: string;
     lineHeight: number;
-    lineHeights: {
-        [keys in ConfigFontSizes]: string;
-    };
+    lineHeights: ConfigThemeFontSizes;
     textTransform: string;
     url: string;
     weight: string;
@@ -559,13 +560,10 @@ export interface ConfigThemeFont {
     body: ConfigFont;
     headings: ConfigFont;
     headline: ConfigFont;
-    lineHeights: {
-        [keys in ConfigFontSizes]: string;
-    };
+    lineHeights: ConfigThemeFontSizes;
     preface: ConfigFont;
-    sizes: {
-        [keys in ConfigFontSizes]: string;
-    };
+    sizes: ConfigThemeFontSizes;
+    sizesMobile: ConfigThemeFontSizes;
 }
 export interface ConfigThemeInputLabel {
     fontSize: string;
@@ -705,24 +703,25 @@ export interface ConfigThemeWelcome {
     titleSize: string;
     mobile?: ConfigThemeWelcome;
 }
+export interface ConfigThemeColors extends Record<string, string> {
+    alert: string;
+    allergens: string;
+    dark: string;
+    error: string;
+    highlight: string;
+    light: string;
+    primary: string;
+    secondary: string;
+    success: string;
+    tertiary: string;
+    toast: string;
+}
 export interface ConfigTheme {
     alert: {
         bgColor: string;
         color: string;
     };
-    bgColors: {
-        alert: string;
-        allergens: string;
-        dark: string;
-        error: string;
-        highlight: string;
-        light: string;
-        primary: string;
-        secondary: string;
-        success: string;
-        tertiary: string;
-        toast: string;
-    };
+    bgColors: ConfigThemeColors;
     boldWeight: string;
     border: ConfigThemeBorder;
     boxShadow: {
@@ -739,20 +738,7 @@ export interface ConfigTheme {
     };
     buttons: ConfigThemeButtons;
     cards: ConfigThemeCards;
-    colors: {
-        alert: string;
-        allergens: string;
-        dark: string;
-        error: string;
-        light: string;
-        primary: string;
-        secondary: string;
-        success: string;
-        tags: string;
-        tertiary: string;
-        title: string;
-        toast: string;
-    };
+    colors: ConfigThemeColors;
     counts: ConfigThemeCounts;
     error: {
         bgColor: string;

package/dist/cjs/types/api/creditCards.d.ts

@@ -1,12 +1,12 @@
-import { CardType } from '../global';
+import { CardType, CardTypeName } from '../global';
 export interface CreditCard {
-    card_type?: CardType;
-    card_type_name?: string;
-    customer_card_id?: number;
+    card_type: CardType;
+    card_type_name: CardTypeName;
+    customer_card_id: number;
     has_profile?: boolean;
     is_default?: boolean;
-    last4?: string;
-    masked?: string;
+    last4: string;
+    masked: string;
 }
 export declare type CreditCards = Array<CreditCard>;
 export interface CreditCardData {

package/dist/cjs/types/api/customer/addresses.d.ts

@@ -1,15 +1,19 @@
+import { ISOStringOffset } from '../../datetimes';
 export interface Address {
-    city?: string;
+    city: string;
     company?: string;
     contact?: string;
-    created_at?: string;
+    country?: string;
+    created_at?: ISOStringOffset;
     customer_address_id?: number;
+    customer_id?: number;
     description?: string;
     formatted_address?: string;
+    is_active?: boolean;
     is_default?: boolean;
-    last_used_at?: string;
-    lat: number | null;
-    lng: number | null;
+    last_used_at?: ISOStringOffset;
+    lat: number;
+    lng: number;
     notes?: string;
     phone?: string;
     postal_code: string;
@@ -17,4 +21,4 @@ export interface Address {
     street: string;
     unit?: string;
 }
-export declare type Addresses = Array<Address>;
+export declare type Addresses = Address[];

package/dist/cjs/types/api/kds.d.ts

@@ -1,4 +1,4 @@
-import { OrdersKds } from './order';
+import { OrdersKds } from './pos';
 export declare type PrepStatus = 'TODO' | 'IN_PROGRESS' | 'DONE' | 'COMPLETED' | 'FULFILLED' | 'TAKE_OUT';
 export declare type PrepStatusMap = {
     [Property in PrepStatus]: PrepStatus;

package/dist/cjs/types/api/menu.d.ts

@@ -122,16 +122,29 @@ export interface MenuCategory {
     small_image_url: string | null;
 }
 export declare type MenuCategories = MenuCategory[];
+export interface MenuRevenueCenter {
+    app_image_url: string;
+    description: string;
+    display_order: number;
+    hours_desc: string;
+    large_image_url: string;
+    name: string;
+    revenue_center_id: number;
+    short_name: string;
+    small_image_url: string;
+}
+export declare type MenuRevenueCenters = MenuRevenueCenter[];
+export declare type SoldOut = number[];
 export interface Menu {
     menu: MenuCategories;
-    service_type: ServiceType;
+    revenue_centers: MenuRevenueCenters | null;
+    sold_out_items: SoldOut;
 }
 export interface MenuVars {
     revenueCenterId: number;
     serviceType: ServiceType;
     requestedAt: RequestedAt;
 }
-export declare type SoldOut = number[];
 export interface DiscountedItem {
     id: number;
     category_id: number;
@@ -139,6 +152,6 @@ export interface DiscountedItem {
     short_name: string;
 }
 export interface DiscountedItems {
-    items: Array<DiscountedItem>;
+    items: DiscountedItem[];
     quantity: number;
 }

package/dist/cjs/types/api/messages.d.ts

@@ -2,4 +2,4 @@ export interface Message {
     message: string;
     id: string;
 }
-export declare type Messages = Array<Message>;
+export declare type Messages = Message[];