@open-tender/types 0.2.3 → 0.2.5

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

@@ -3,7 +3,7 @@ import { CardType, CardTypeName, DeviceType, DiscountType, Money, OrderType, Pre
 import { RequestErrorParams } from '../request';
 import { Cart } from './cart';
 import { Address, Customer } from './customer';
-import { Order, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
+import { Order, OrderCustomer, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
 export interface SimpleCartOption {
     id: number;
     quantity: number;
@@ -82,8 +82,9 @@ export interface CheckoutConfig {
     surcharges: CheckoutConfigSurcharges;
     tender_types: TenderType[];
 }
-export interface CheckoutCheck extends Order {
+export interface CheckoutCheck extends Omit<Order, 'customer'> {
     config: CheckoutConfig;
+    customer: OrderCustomer | null;
     errors: RequestErrorParams;
 }
 export interface OrderCreateDetails {
@@ -179,6 +180,10 @@ export interface CheckoutTenderHouseAccount {
 }
 export declare type CheckoutTender = CheckoutTenderCreditGuest | CheckoutTenderCreditCustomer | CheckoutTenderGiftCard | CheckoutTenderHouseAccount;
 export declare type CheckoutTenders = CheckoutTender[];
+export declare const isCreditCustomerCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderCreditGuest;
+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 type CheckoutPromoCodes = string[];
 export interface CheckoutForm {
     address: CheckoutFormAddress;

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

@@ -1,2 +1,21 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+exports.isHouseAccountCheckoutTender = exports.isGiftCardCheckoutTender = exports.isCreditGuestCheckoutTender = exports.isCreditCustomerCheckoutTender = void 0;
+const isCreditCustomerCheckoutTender = (tender) => {
+    return (tender.tender_type === 'CREDIT' &&
+        tender.customer_card_id !== undefined);
+};
+exports.isCreditCustomerCheckoutTender = isCreditCustomerCheckoutTender;
+const isCreditGuestCheckoutTender = (tender) => {
+    return (tender.tender_type === 'CREDIT' &&
+        tender.acct !== undefined);
+};
+exports.isCreditGuestCheckoutTender = isCreditGuestCheckoutTender;
+const isGiftCardCheckoutTender = (tender) => {
+    return tender.tender_type === 'GIFT_CARD';
+};
+exports.isGiftCardCheckoutTender = isGiftCardCheckoutTender;
+const isHouseAccountCheckoutTender = (tender) => {
+    return tender.tender_type === 'HOUSE_ACCOUNT';
+};
+exports.isHouseAccountCheckoutTender = isHouseAccountCheckoutTender;

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

@@ -4,18 +4,6 @@ export interface Auth {
     refresh_token: string;
     token_type: string;
 }
-export interface Profile {
-    birth_date: string | null;
-    company: string;
-    customer_id: number;
-    email: string;
-    first_name: string;
-    gender: string | null;
-    is_notification_set: boolean;
-    is_verified: boolean;
-    last_name: string;
-    phone: string;
-}
 export interface LoginData {
     email: string;
     password: string;

package/dist/cjs/types/api/customer/account.js

@@ -1,2 +1,5 @@
 "use strict";
+// import { DateString } from '../../datetimes'
+// import { Gender, OrderNotifications } from '../../global'
+// import { CustomerNotificationPrefs } from './communicationPreferences'
 Object.defineProperty(exports, "__esModule", { value: true });

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

@@ -7,4 +7,4 @@ export interface CustomerNotificationPref {
     notification_area: NotificationArea;
     notification_channel: NotificationChannel;
 }
-export declare type CustomerNotificationPrefs = Array<Partial<CustomerNotificationPref>>;
+export declare type CustomerNotificationPrefs = CustomerNotificationPref[];

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

@@ -1,34 +1,34 @@
 import { DateString } from '../../datetimes';
 import { Gender, OrderNotifications } from '../../global';
 import { Allergens } from '../allergens';
-import { CreditCards } from '../creditCards';
 import { Favorites } from '../favorite';
 import { CustomerNotificationPrefs } from './communicationPreferences';
-import { CustomerGiftCard, CustomerGiftCards } from './giftCards';
-import { HouseAccounts } from './houseAccounts';
-export interface Customer {
-    accepts_marketing?: boolean;
+import { GiftCards } from './giftCards';
+export interface CustomerCreate {
     birth_date?: DateString | null;
-    company?: boolean;
-    customer_id?: number;
-    email?: string;
-    first_name?: string;
-    gender?: Gender;
-    is_guest?: boolean;
-    is_notification_set?: boolean;
-    is_verified?: boolean;
-    last_name?: string;
-    order_notifications?: OrderNotifications;
-    phone?: string | null;
+    company?: string;
+    email: string;
+    first_name: string;
+    gender?: string | null;
+    last_name: string;
     password?: string;
-    credit_cards?: CreditCards;
-    gift_cards?: Array<Partial<CustomerGiftCard>>;
-    house_accounts?: HouseAccounts;
+    phone: string;
 }
-export interface CustomerWithRelated extends Customer {
+export interface Customer {
+    accepts_marketing: boolean;
     allergens?: Allergens;
-    customer_notification_preferences?: CustomerNotificationPrefs;
+    birth_date: DateString | null;
+    company: string;
+    customer_id: number;
+    customer_notification_preferences: CustomerNotificationPrefs;
+    email: string;
     favorites?: Favorites;
-    gift_cards?: CustomerGiftCards;
-    levelup?: [] | null;
+    first_name: string;
+    gender: Gender | null;
+    gift_cards?: GiftCards;
+    is_notification_set: boolean;
+    is_verified: boolean;
+    last_name: string;
+    order_notifications: OrderNotifications;
+    phone: string;
 }

package/dist/cjs/types/api/customer/customer.js

@@ -1,2 +1,7 @@
 "use strict";
 Object.defineProperty(exports, "__esModule", { value: true });
+// export interface CustomerWithRelated extends Customer {
+//   allergens?: Allergens
+//   favorites?: Favorites
+//   gift_cards?: GiftCards
+// }

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

@@ -1,7 +1,7 @@
 import { DateString, ISOStringOffset } from '../../datetimes';
 import { Money } from '../../global';
 import { CreditCardData, CreditCardSaved } from '../creditCards';
-export interface CustomerGiftCard {
+export interface GiftCard {
     balance: Money;
     card_number: string;
     expiration: DateString | null;
@@ -9,10 +9,8 @@ export interface CustomerGiftCard {
     orders: number;
     qr_code_url: string;
     updated_at: ISOStringOffset;
-    amount?: number;
-    customer_card_id?: string | number;
 }
-export declare type CustomerGiftCards = CustomerGiftCard[];
+export declare type GiftCards = GiftCard[];
 export interface GiftCardPurchased {
     email: string;
     balance: string;
@@ -31,3 +29,7 @@ export interface GiftCardsPurchase {
     url: string;
     token?: string;
 }
+export interface GiftCardPurchase {
+    amount: string;
+    customer_card_id: number;
+}

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

@@ -1,15 +1,19 @@
 import { OrderType, ServiceType } from '../../global';
-import { RevenueCenter, RevenueCenterType } from '../revenueCenter';
+import { RevenueCenterType } from '../revenueCenter';
+export interface HouseAccountRevenueCenter {
+    name: string;
+    revenue_center_id: number;
+    revenue_center_type: RevenueCenterType;
+}
+export declare type HouseAccountRevenueCenters = HouseAccountRevenueCenter[];
 export interface HouseAccount {
     approved_contact: boolean;
-    domain: string;
+    domain: string | null;
     house_account_id: number;
     name: string;
-    order_type: OrderType;
+    order_type: OrderType | null;
     pin: string;
-    revenue_centers: Array<RevenueCenter>;
-    service_type: ServiceType;
-    revenue_center_type?: RevenueCenterType;
-    qr_code_url?: string;
+    revenue_centers: HouseAccountRevenueCenters;
+    service_type: ServiceType | null;
 }
-export declare type HouseAccounts = Array<HouseAccount>;
+export declare type HouseAccounts = HouseAccount[];

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

@@ -1,7 +1,7 @@
-import { ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
-import { CardType, CardTypeName, ChannelType, DiscountAuthType, DiscountType, Images, Money, NegativeMoney, OrderNotifications, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
-import { CreditCard } from './creditCards';
-import { Address } from './customer';
+import { DateString, ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
+import { CardType, CardTypeName, ChannelType, DiscountAuthType, DiscountType, Gender, Images, Money, NegativeMoney, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
+import { CreditCard, CreditCards } from './creditCards';
+import { Address, Customer, GiftCard, HouseAccounts } from './customer';
 import { PrepStatus } from './kds';
 import { NutritionalInfo } from './menu';
 export interface OrderItemPoints {
@@ -48,32 +48,21 @@ export interface OrderCustomerCreditCard {
     masked: string;
 }
 export declare type OrderCustomerCreditCards = OrderCustomerCreditCard[];
-export interface OrderCustomerGiftCard {
-    balance: Money;
-    card_number: string;
-    expiration: ISOStringOffset | null;
-    orders: number;
-    updated_at: ISOStringOffset;
-}
+export declare type OrderCustomerGiftCard = Omit<GiftCard, 'gift_card_id' | 'qr_code_url'>;
 export declare type OrderCustomerGiftCards = OrderCustomerGiftCard[];
 export interface OrderCustomerSso {
     connected: boolean;
     service: string;
 }
-export interface OrderCustomer {
-    accepts_marketing: boolean;
-    company: string | null;
-    credit_cards?: OrderCustomerCreditCards;
-    customer_id: number;
-    email: string;
-    first_name: string;
+export interface OrderCustomer extends Omit<Customer, 'allergens' | 'birth_date' | 'customer_id' | 'customer_notification_preferences' | 'favorites' | 'gender' | 'gift_cards' | 'is_notification_set'> {
+    birth_date?: DateString | null;
+    credit_cards?: CreditCards;
+    customer_id?: number;
+    gender?: Gender | null;
     gift_cards?: OrderCustomerGiftCards;
+    house_accounts?: HouseAccounts;
     is_guest: boolean;
-    is_verified: boolean;
-    last_name: string;
-    order_notifications: OrderNotifications;
-    phone: string;
-    sso?: OrderCustomerSso;
+    sso: OrderCustomerSso;
 }
 export interface OrderDineInGuest {
     company: string | null;
@@ -230,7 +219,7 @@ export interface Order {
     address: Address | null;
     cart: OrderCart;
     created_at: ISOStringOffset;
-    customer: OrderCustomer | OrderDineInGuest;
+    customer: OrderCustomer;
     delivery: OrderDelivery | null;
     details: OrderDetails | null;
     discounts: OrderDiscounts;

package/dist/cjs/types/inputs.d.ts

@@ -78,3 +78,4 @@ export declare const isSelect: (field: FormFieldType) => field is Select;
 export declare const isSwitch: (field: FormFieldType) => field is Switch;
 export declare const isTextarea: (field: FormFieldType) => field is Textarea;
 export declare const isInput: (field: FormFieldType) => field is Input;
+export declare type FormFields = FormFieldType[];

package/dist/cjs/types/request.d.ts

@@ -5,7 +5,7 @@ export interface IndexedError {
 export interface RequestErrorMessage {
     code: string;
     detail: string;
-    message: string;
+    message?: string;
     title: string;
 }
 export declare type RequestErrorParams = Record<string, string>;

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

@@ -3,7 +3,7 @@ import { CardType, CardTypeName, DeviceType, DiscountType, Money, OrderType, Pre
 import { RequestErrorParams } from '../request';
 import { Cart } from './cart';
 import { Address, Customer } from './customer';
-import { Order, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
+import { Order, OrderCustomer, OrderDiscounts, OrderFulfillment, OrderSurcharge } from './order';
 export interface SimpleCartOption {
     id: number;
     quantity: number;
@@ -82,8 +82,9 @@ export interface CheckoutConfig {
     surcharges: CheckoutConfigSurcharges;
     tender_types: TenderType[];
 }
-export interface CheckoutCheck extends Order {
+export interface CheckoutCheck extends Omit<Order, 'customer'> {
     config: CheckoutConfig;
+    customer: OrderCustomer | null;
     errors: RequestErrorParams;
 }
 export interface OrderCreateDetails {
@@ -179,6 +180,10 @@ export interface CheckoutTenderHouseAccount {
 }
 export declare type CheckoutTender = CheckoutTenderCreditGuest | CheckoutTenderCreditCustomer | CheckoutTenderGiftCard | CheckoutTenderHouseAccount;
 export declare type CheckoutTenders = CheckoutTender[];
+export declare const isCreditCustomerCheckoutTender: (tender: CheckoutTender) => tender is CheckoutTenderCreditGuest;
+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 type CheckoutPromoCodes = string[];
 export interface CheckoutForm {
     address: CheckoutFormAddress;

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

@@ -1 +1,14 @@
-export {};
+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';
+};

package/dist/esm/types/api/customer/account.d.ts

@@ -4,18 +4,6 @@ export interface Auth {
     refresh_token: string;
     token_type: string;
 }
-export interface Profile {
-    birth_date: string | null;
-    company: string;
-    customer_id: number;
-    email: string;
-    first_name: string;
-    gender: string | null;
-    is_notification_set: boolean;
-    is_verified: boolean;
-    last_name: string;
-    phone: string;
-}
 export interface LoginData {
     email: string;
     password: string;

package/dist/esm/types/api/customer/account.js

@@ -1 +1,4 @@
+// import { DateString } from '../../datetimes'
+// import { Gender, OrderNotifications } from '../../global'
+// import { CustomerNotificationPrefs } from './communicationPreferences'
 export {};

package/dist/esm/types/api/customer/communicationPreferences.d.ts

@@ -7,4 +7,4 @@ export interface CustomerNotificationPref {
     notification_area: NotificationArea;
     notification_channel: NotificationChannel;
 }
-export declare type CustomerNotificationPrefs = Array<Partial<CustomerNotificationPref>>;
+export declare type CustomerNotificationPrefs = CustomerNotificationPref[];

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

@@ -1,34 +1,34 @@
 import { DateString } from '../../datetimes';
 import { Gender, OrderNotifications } from '../../global';
 import { Allergens } from '../allergens';
-import { CreditCards } from '../creditCards';
 import { Favorites } from '../favorite';
 import { CustomerNotificationPrefs } from './communicationPreferences';
-import { CustomerGiftCard, CustomerGiftCards } from './giftCards';
-import { HouseAccounts } from './houseAccounts';
-export interface Customer {
-    accepts_marketing?: boolean;
+import { GiftCards } from './giftCards';
+export interface CustomerCreate {
     birth_date?: DateString | null;
-    company?: boolean;
-    customer_id?: number;
-    email?: string;
-    first_name?: string;
-    gender?: Gender;
-    is_guest?: boolean;
-    is_notification_set?: boolean;
-    is_verified?: boolean;
-    last_name?: string;
-    order_notifications?: OrderNotifications;
-    phone?: string | null;
+    company?: string;
+    email: string;
+    first_name: string;
+    gender?: string | null;
+    last_name: string;
     password?: string;
-    credit_cards?: CreditCards;
-    gift_cards?: Array<Partial<CustomerGiftCard>>;
-    house_accounts?: HouseAccounts;
+    phone: string;
 }
-export interface CustomerWithRelated extends Customer {
+export interface Customer {
+    accepts_marketing: boolean;
     allergens?: Allergens;
-    customer_notification_preferences?: CustomerNotificationPrefs;
+    birth_date: DateString | null;
+    company: string;
+    customer_id: number;
+    customer_notification_preferences: CustomerNotificationPrefs;
+    email: string;
     favorites?: Favorites;
-    gift_cards?: CustomerGiftCards;
-    levelup?: [] | null;
+    first_name: string;
+    gender: Gender | null;
+    gift_cards?: GiftCards;
+    is_notification_set: boolean;
+    is_verified: boolean;
+    last_name: string;
+    order_notifications: OrderNotifications;
+    phone: string;
 }

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

@@ -1 +1,6 @@
 export {};
+// export interface CustomerWithRelated extends Customer {
+//   allergens?: Allergens
+//   favorites?: Favorites
+//   gift_cards?: GiftCards
+// }

package/dist/esm/types/api/customer/giftCards.d.ts

@@ -1,7 +1,7 @@
 import { DateString, ISOStringOffset } from '../../datetimes';
 import { Money } from '../../global';
 import { CreditCardData, CreditCardSaved } from '../creditCards';
-export interface CustomerGiftCard {
+export interface GiftCard {
     balance: Money;
     card_number: string;
     expiration: DateString | null;
@@ -9,10 +9,8 @@ export interface CustomerGiftCard {
     orders: number;
     qr_code_url: string;
     updated_at: ISOStringOffset;
-    amount?: number;
-    customer_card_id?: string | number;
 }
-export declare type CustomerGiftCards = CustomerGiftCard[];
+export declare type GiftCards = GiftCard[];
 export interface GiftCardPurchased {
     email: string;
     balance: string;
@@ -31,3 +29,7 @@ export interface GiftCardsPurchase {
     url: string;
     token?: string;
 }
+export interface GiftCardPurchase {
+    amount: string;
+    customer_card_id: number;
+}

package/dist/esm/types/api/customer/houseAccounts.d.ts

@@ -1,15 +1,19 @@
 import { OrderType, ServiceType } from '../../global';
-import { RevenueCenter, RevenueCenterType } from '../revenueCenter';
+import { RevenueCenterType } from '../revenueCenter';
+export interface HouseAccountRevenueCenter {
+    name: string;
+    revenue_center_id: number;
+    revenue_center_type: RevenueCenterType;
+}
+export declare type HouseAccountRevenueCenters = HouseAccountRevenueCenter[];
 export interface HouseAccount {
     approved_contact: boolean;
-    domain: string;
+    domain: string | null;
     house_account_id: number;
     name: string;
-    order_type: OrderType;
+    order_type: OrderType | null;
     pin: string;
-    revenue_centers: Array<RevenueCenter>;
-    service_type: ServiceType;
-    revenue_center_type?: RevenueCenterType;
-    qr_code_url?: string;
+    revenue_centers: HouseAccountRevenueCenters;
+    service_type: ServiceType | null;
 }
-export declare type HouseAccounts = Array<HouseAccount>;
+export declare type HouseAccounts = HouseAccount[];

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

@@ -1,7 +1,7 @@
-import { ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
-import { CardType, CardTypeName, ChannelType, DiscountAuthType, DiscountType, Images, Money, NegativeMoney, OrderNotifications, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
-import { CreditCard } from './creditCards';
-import { Address } from './customer';
+import { DateString, ISOStringOffset, RequestedAt, TimeHuman, TimezonePython } from '../datetimes';
+import { CardType, CardTypeName, ChannelType, DiscountAuthType, DiscountType, Gender, Images, Money, NegativeMoney, OrderStatus, OrderType, ServiceType, TenderType } from '../global';
+import { CreditCard, CreditCards } from './creditCards';
+import { Address, Customer, GiftCard, HouseAccounts } from './customer';
 import { PrepStatus } from './kds';
 import { NutritionalInfo } from './menu';
 export interface OrderItemPoints {
@@ -48,32 +48,21 @@ export interface OrderCustomerCreditCard {
     masked: string;
 }
 export declare type OrderCustomerCreditCards = OrderCustomerCreditCard[];
-export interface OrderCustomerGiftCard {
-    balance: Money;
-    card_number: string;
-    expiration: ISOStringOffset | null;
-    orders: number;
-    updated_at: ISOStringOffset;
-}
+export declare type OrderCustomerGiftCard = Omit<GiftCard, 'gift_card_id' | 'qr_code_url'>;
 export declare type OrderCustomerGiftCards = OrderCustomerGiftCard[];
 export interface OrderCustomerSso {
     connected: boolean;
     service: string;
 }
-export interface OrderCustomer {
-    accepts_marketing: boolean;
-    company: string | null;
-    credit_cards?: OrderCustomerCreditCards;
-    customer_id: number;
-    email: string;
-    first_name: string;
+export interface OrderCustomer extends Omit<Customer, 'allergens' | 'birth_date' | 'customer_id' | 'customer_notification_preferences' | 'favorites' | 'gender' | 'gift_cards' | 'is_notification_set'> {
+    birth_date?: DateString | null;
+    credit_cards?: CreditCards;
+    customer_id?: number;
+    gender?: Gender | null;
     gift_cards?: OrderCustomerGiftCards;
+    house_accounts?: HouseAccounts;
     is_guest: boolean;
-    is_verified: boolean;
-    last_name: string;
-    order_notifications: OrderNotifications;
-    phone: string;
-    sso?: OrderCustomerSso;
+    sso: OrderCustomerSso;
 }
 export interface OrderDineInGuest {
     company: string | null;
@@ -230,7 +219,7 @@ export interface Order {
     address: Address | null;
     cart: OrderCart;
     created_at: ISOStringOffset;
-    customer: OrderCustomer | OrderDineInGuest;
+    customer: OrderCustomer;
     delivery: OrderDelivery | null;
     details: OrderDetails | null;
     discounts: OrderDiscounts;

package/dist/esm/types/inputs.d.ts

@@ -78,3 +78,4 @@ export declare const isSelect: (field: FormFieldType) => field is Select;
 export declare const isSwitch: (field: FormFieldType) => field is Switch;
 export declare const isTextarea: (field: FormFieldType) => field is Textarea;
 export declare const isInput: (field: FormFieldType) => field is Input;
+export declare type FormFields = FormFieldType[];

package/dist/esm/types/request.d.ts

@@ -5,7 +5,7 @@ export interface IndexedError {
 export interface RequestErrorMessage {
     code: string;
     detail: string;
-    message: string;
+    message?: string;
     title: string;
 }
 export declare type RequestErrorParams = Record<string, string>;

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@open-tender/types",
-  "version": "0.2.3",
+  "version": "0.2.5",
   "description": "A library of types for use with Open Tender applications that utilize our cloud-based Order API.",
   "main": "./dist/cjs/index.js",
   "module": "./dist/esm/index.js",