@open-tender/types 0.4.156 → 0.4.158

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

@@ -1,55 +0,0 @@
-import { DateString } from '../../datetimes';
-import { OrderNotifications } from '../../global';
-import { Allergens } from '../allergens';
-import { Discounts } from '../discounts';
-import { Favorites } from '../favorite';
-import { Orders } from '../order';
-import { CustomerNotificationPrefs, NotificationChannel } from './communicationPreferences';
-import { GiftCards } from './giftCards';
-import { LoyaltyPrograms } from './loyalty';
-export interface CustomerCreate {
-    birth_date?: DateString | null;
-    communications?: NotificationChannel[];
-    company?: string;
-    email: string;
-    first_name: string;
-    last_name: string;
-    password?: string;
-    phone: string;
-    token?: string;
-    login_recaptcha?: string;
-}
-export interface Customer {
-    accepts_marketing: boolean;
-    allergens?: Allergens;
-    birth_date: DateString | null;
-    company: string;
-    customer_id: number;
-    customer_notification_preferences: CustomerNotificationPrefs;
-    email: string;
-    favorites?: Favorites;
-    first_name: string;
-    gift_cards?: GiftCards;
-    is_notification_set: boolean;
-    is_verified: boolean;
-    last_name: string;
-    order_notifications: OrderNotifications;
-    phone: string;
-}
-export interface Brand {
-    name: string;
-}
-export declare type Brands = Brand[];
-declare type CustomerEndpoint = 'ACCOUNT' | 'DEALS' | 'GIFT_CARDS' | 'FAVORITES' | 'LOYALTY' | 'REWARDS' | 'ORDERS';
-export declare type CustomerEndpoints = CustomerEndpoint[];
-export interface CustomerEntities {
-    ACCOUNT?: Customer;
-    DEALS?: Discounts;
-    GIFT_CARDS?: GiftCards;
-    FAVORITES?: Favorites;
-    LOYALTY?: LoyaltyPrograms;
-    REWARDS?: Discounts;
-    ORDERS?: Orders;
-    ALLERGENS?: Allergens;
-}
-export {};

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

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

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

@@ -1,37 +0,0 @@
-import { DateString, ISOStringOffset } from '../../datetimes';
-import { Money } from '../../global';
-import { CreditCardData, CreditCardSaved } from '../creditCards';
-export interface GiftCard {
-    balance: Money;
-    card_number: string;
-    expiration: DateString | null;
-    gift_card_id: number;
-    orders: number;
-    qr_code_url: string;
-    updated_at: ISOStringOffset;
-}
-export declare type GiftCards = GiftCard[];
-export interface GiftCardPurchased {
-    email: string;
-    balance: string;
-    card_number: string;
-}
-export declare type GiftCardsPurchased = GiftCardPurchased[];
-export interface GiftCardPurchaseData {
-    amount: string;
-    quantity: number;
-    email?: string;
-}
-export interface GiftCardsPurchase {
-    credit_card: CreditCardData | CreditCardSaved;
-    email: string;
-    gift_cards: GiftCardPurchaseData[];
-    name: string;
-    url: string;
-    token?: string;
-    kount_device_session_id?: string;
-}
-export interface GiftCardPurchase {
-    amount: string;
-    customer_card_id: number;
-}

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

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

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

@@ -1,62 +0,0 @@
-import { ISOString, RequestedAt, TimezonePython } from '../../datetimes';
-import { ServiceType } from '../../global';
-import { SimpleCart } from '../checkout';
-import { RevenueCenterType } from '../revenueCenter';
-import { Address } from './addresses';
-export interface CartOwner {
-    customer_id: number;
-    first_name: string;
-    last_name: string;
-}
-export interface GroupOrderGuestCreate {
-    cart_id: number;
-    first_name: string;
-    last_name: string;
-}
-export interface GroupOrderGuest extends GroupOrderGuestCreate {
-    cart_guest_id: number;
-}
-export declare type GroupOrderGuests = GroupOrderGuest[];
-export interface GroupOrderRevenueCenter {
-    is_outpost: boolean;
-    name: string;
-    revenue_center_id: number;
-    revenue_center_type: RevenueCenterType;
-    timezone: TimezonePython;
-}
-export interface GroupOrder {
-    address: Address | null;
-    cart: SimpleCart;
-    cart_guests?: GroupOrderGuests;
-    cart_id: number;
-    closed: boolean;
-    customer?: CartOwner;
-    cutoff_at: ISOString | null;
-    guest_count: number;
-    guest_limit: number | null;
-    requested_at: RequestedAt;
-    revenue_center_id: number;
-    service_type: ServiceType;
-    spending_limit: string | null;
-    token: string;
-}
-export declare type GroupOrders = GroupOrder[];
-export interface GroupOrderExpanded extends GroupOrder {
-    revenue_center: GroupOrderRevenueCenter;
-}
-export declare type GroupOrdersExpanded = GroupOrderExpanded[];
-export interface GroupOrderTime {
-    isAdjusted: boolean;
-    firstIso: ISOString;
-    iso: ISOString;
-    date: Date;
-    dateStr: string;
-    cutoffIso: ISOString;
-    cutoffDate: Date;
-    cutoffDateStr: string;
-}
-export interface GroupOrderPrepTime {
-    prepTime: string;
-}
-export declare const isGroupOrderPrepTime: (orderTime: GroupOrderTime | GroupOrderPrepTime) => orderTime is GroupOrderPrepTime;
-export declare const isGroupOrderTime: (orderTime: GroupOrderTime | GroupOrderPrepTime) => orderTime is GroupOrderTime;

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

@@ -1,6 +0,0 @@
-export const isGroupOrderPrepTime = (orderTime) => {
-    return orderTime.prepTime !== undefined;
-};
-export const isGroupOrderTime = (orderTime) => {
-    return orderTime.isAdjusted !== undefined;
-};

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

@@ -1,21 +0,0 @@
-import { OrderType, ServiceType } from '../../global';
-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 | null;
-    house_account_id: number;
-    is_tax_exempt: boolean;
-    name: string;
-    order_type: OrderType | null;
-    pin: string;
-    revenue_centers: HouseAccountRevenueCenters;
-    service_type: ServiceType | null;
-    tax_exempt_id: string | null;
-}
-export declare type HouseAccounts = HouseAccount[];

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

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

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

@@ -1,46 +0,0 @@
-import { DiscountType, Money, OrderType } from '../../global';
-export interface CustomerIdentifier {
-    card_token?: string;
-    phone?: string;
-    qr_code?: string;
-}
-export interface CustomerIdentifyDiscount {
-    amount: Money;
-    before_surcharge: boolean;
-    customer_loyalty_id: number;
-    description: string;
-    discount_id: number;
-    discount_type: DiscountType;
-    is_auto: boolean;
-    is_loyalty: boolean;
-    is_promo_code: boolean;
-    is_taxed: boolean;
-    loyalty_program_id: number;
-    name: string;
-    order_type: OrderType;
-}
-export declare type CustomerIdentifyDiscounts = CustomerIdentifyDiscount[];
-export interface CustomerIdentifyReward {
-    amount: Money;
-    description: string;
-    discount_id: number;
-    discount_type: DiscountType;
-    name: string;
-    order_type: OrderType;
-    title: string;
-}
-export declare type CustomerIdentifyRewards = CustomerIdentifyReward[];
-export interface CustomerIdentifyCustomer {
-    customer_id: number;
-    email: string;
-    first_name: string;
-    last_name: string;
-    phone: string;
-}
-export interface CustomerIdentify {
-    customer: CustomerIdentifyCustomer;
-    discount: any;
-    discounts: CustomerIdentifyDiscounts;
-    points: Money;
-    rewards: CustomerIdentifyRewards;
-}

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

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

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

@@ -1,13 +0,0 @@
-export * from './allergens';
-export * from './account';
-export * from './addresses';
-export * from './communicationPreferences';
-export * from './customer';
-export * from './giftCards';
-export * from './groupOrders';
-export * from './houseAccounts';
-export * from './identify';
-export * from './loyalty';
-export * from './qrcode';
-export * from './thanx';
-export * from './tpls';

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

@@ -1,14 +0,0 @@
-export * from './allergens';
-export * from './account';
-export * from './addresses';
-export * from './communicationPreferences';
-export * from './customer';
-export * from './giftCards';
-export * from './groupOrders';
-export * from './houseAccounts';
-export * from './identify';
-export * from './loyalty';
-export * from './qrcode';
-// export * from './rewards'
-export * from './thanx';
-export * from './tpls';

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

@@ -1,70 +0,0 @@
-import { DiscountType, Money, OrderType } from '../../global';
-export declare type LoyaltyType = 'DOLLARS' | 'ORDERS' | 'POINTS';
-export interface LoyaltyThreshold {
-    description: string;
-    name: string;
-    points: number;
-}
-export declare type LoyaltyThresholds = LoyaltyThreshold[];
-export interface LoyaltyThresholdAugmented extends LoyaltyThreshold {
-    percentage: number;
-    isFilled: boolean;
-}
-export declare type LoyaltyThresholdsAugmented = LoyaltyThresholdAugmented[];
-export interface LoyaltyReward {
-    amount: string;
-    created_at?: string;
-    description: string;
-    discount_id: number;
-    discount_type: DiscountType;
-    expires_at?: string;
-    name: string;
-    title: string;
-}
-export declare type LoyaltyRewards = LoyaltyReward[];
-export interface LoyaltyTier {
-    description: string;
-    hex_code: string;
-    is_current_tier: boolean;
-    name: string;
-    reward: LoyaltyReward | null;
-    threshold: Money;
-    tier_no: number;
-}
-export declare type LoyaltyTiers = LoyaltyTier[];
-export interface LoyaltyStatus {
-    progress: Money;
-    tiers: LoyaltyTiers;
-}
-export declare type LoyaltyPerkType = 'BANKABLE_POINTS' | 'DISCRETE_REWARD' | 'DOLLARS_CREDIT';
-export interface LoyaltyPerk {
-    credit: Money | null;
-    loyalty_perk: LoyaltyPerkType;
-    progress: Money | null;
-    rewards?: LoyaltyRewards;
-    threshold: Money | null;
-    thresholds?: LoyaltyThresholds;
-}
-export interface LoyaltyProgram {
-    description: string;
-    earn_order_type: OrderType | null;
-    is_points_shop_enabled: boolean;
-    loyalty_program_id: number;
-    loyalty_type: LoyaltyType;
-    name: string;
-    perk: LoyaltyPerk | null;
-    redeem_order_type: OrderType | null;
-    reward_order_type: OrderType | null;
-    spend_name: string;
-    status: LoyaltyStatus | null;
-}
-export declare type LoyaltyPrograms = LoyaltyProgram[];
-export interface LoyaltyProgramSummary {
-    name: string;
-    perkType: LoyaltyPerkType;
-    points: number | null;
-    credit: string | null;
-    thresholds: LoyaltyThresholds;
-    progress: number | string | null;
-    tier: LoyaltyTier | null;
-}

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

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

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

@@ -1,3 +0,0 @@
-export interface QRCode {
-    qr_code_url: string;
-}

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

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

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

@@ -1,26 +0,0 @@
-import { DateString } from '../../datetimes';
-import { DiscountType, Money } from '../../global';
-export interface ThanxProgress {
-    percentage: string;
-    towards: string;
-}
-export interface ThanxReward {
-    amount: Money;
-    description: string;
-    discount_type: DiscountType;
-    ext_id: string;
-    items: number[];
-    max_amount: Money;
-    min_order_size: Money;
-    name: string;
-    retire_at: DateString | null;
-}
-export declare type ThanxRewards = ThanxReward[];
-export interface Thanx {
-    email: string;
-    ext_id: string;
-    first_name: string;
-    last_name: string;
-    progress: ThanxProgress;
-    rewards: ThanxRewards;
-}

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

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

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

@@ -1,76 +0,0 @@
-import { DateString, ISOString } from '../../datetimes';
-import { DiscountType, Gender, Money } from '../../global';
-export interface TPLSCredit {
-    balance: Money;
-}
-export interface TPLSPoints {
-    balance: number;
-}
-export interface TPLSProgress {
-    percentage: string;
-    towards: string;
-}
-export interface TPLSReward {
-    amount: Money;
-    description: string;
-    discount_type: DiscountType;
-    expires_at: DateString | null;
-    ext_id: string;
-    image: string | null;
-    items: number[];
-    max_amount: Money | null;
-    min_order_size: Money | null;
-    name: string;
-}
-export declare type TPLSRewards = TPLSReward[];
-export interface TPLS {
-    birth_date: DateString | null;
-    credit: TPLSCredit | null;
-    email: string;
-    ext_id: string | null;
-    first_name: string;
-    gender: Gender | null;
-    is_verified?: boolean;
-    last_name: string;
-    membership_tier: string | null;
-    phone: string;
-    points: TPLSPoints | null;
-    progress: TPLSProgress | null;
-    rewards: TPLSRewards;
-}
-export interface TPLSPointsShopRewardV2 {
-    amount: Money;
-    created_at: DateString | null;
-    description: string | null;
-    discount_id: number;
-    discount_type: string;
-    expires_at: DateString | null;
-    name: string;
-    title: string;
-}
-export declare type TPLSPointsShopRewardsV2 = TPLSPointsShopRewardV2[];
-export interface TPLSPointsShopReward {
-    description: string | null;
-    expires_at: string;
-    id: string;
-    image: string | null;
-    is_available: boolean | null;
-    name: string;
-    points: number | null;
-    end_date: string | null;
-}
-export declare type TPLSPointsShopRewards = TPLSPointsShopReward[];
-export interface TPLSTerms {
-    loyalty_terms: string;
-    privacy_policy: string;
-    terms_of_use: string;
-}
-export interface TPLSHistoryEvent {
-    date: ISOString;
-    title: string;
-    value: string;
-    description: string;
-    points: number | null;
-    items: number | null;
-}
-export declare type TPLSHistory = TPLSHistoryEvent[];

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

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

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

@@ -1,96 +0,0 @@
-import { ISOString } from '../datetimes';
-export interface PosPrinter {
-    backup_pos_printer_v2_id: number;
-    description: string;
-    ipv4_address: string;
-    name: string;
-    pos_printer_v2_id: number;
-    use_beeper: boolean;
-}
-export declare type PosPrinters = PosPrinter[];
-export interface PosScanner {
-    description: string;
-    identifier: string;
-    name: string;
-    pos_scanner_id: number;
-}
-export declare type PosScanners = PosScanner[];
-export declare type PosTerminalPrintReceipt = 'never' | 'always' | 'prompt';
-export declare type PosScannerType = 'NONE' | 'USB' | 'CAMERA' | 'MORPHSTICK';
-export interface PosTerminal {
-    description: string;
-    name: string;
-    pos_chipdna_terminal_id: number | null;
-    pos_printer_v2_id: number | null;
-    pos_scanner: PosScanner;
-    pos_scanner_id: number | null;
-    pos_scanner_type: PosScannerType;
-    pos_terminal_id: number;
-    print_kds: boolean;
-    print_receipt: PosTerminalPrintReceipt;
-    printers: PosPrinters;
-    disable_kiosk_until: ISOString | null;
-}
-export declare type PosTerminals = PosTerminal[];
-export declare type PrepStationPrepType = 'ASSEMBLY' | 'EXPO';
-export interface PrepStation {
-    assembly_done: boolean;
-    assembly_print: boolean;
-    expo_complete: boolean;
-    expo_complete_all: boolean;
-    expo_done_only: boolean;
-    expo_print: boolean;
-    expo_reset: boolean;
-    item_type_ids: number[];
-    name: string;
-    prep_station_id: number;
-    prep_type: PrepStationPrepType;
-    show_counts: boolean;
-    show_groups: boolean;
-    show_modifiers: boolean;
-}
-export declare type PrepStations = PrepStation[];
-export interface KdsTerminal {
-    auto_print: boolean;
-    description: string;
-    kds_terminal_id: number;
-    name: string;
-    pos_printer_v2_id: number | null;
-    prep_stations: PrepStations;
-    printer: PosPrinters;
-}
-export declare type KdsTerminals = KdsTerminal[];
-export interface PosServer {
-    ipv4_address: string;
-    name: string;
-    pos_server_id: number;
-}
-export declare type PosServers = PosServer[];
-export interface PaymentTerminal {
-    api_key: string;
-    application_identifier: string;
-    description: string;
-    identifier: string;
-    is_active: boolean;
-    mac_address: string;
-    model: string;
-    name: string;
-    pos_chipdna_terminal_id: number;
-    revenue_center_id: number;
-    standby_message: string;
-    use_production: boolean;
-}
-export declare type PaymentTerminals = PaymentTerminal[];
-export interface Devices {
-    kds_terminals: KdsTerminals;
-    pos_chipdna_terminals: PaymentTerminals;
-    pos_scanners: PosScanners;
-    pos_terminals: PosTerminals;
-    prep_stations: PrepStations;
-    printers: PosPrinters;
-    servers: PosServers;
-}
-export declare type DevicesList = Devices[];
-export interface DeviceRead {
-    data: string;
-}

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

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

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

@@ -1,65 +0,0 @@
-import { DateString, ISOString, TimeString } from '../datetimes';
-import { ChannelType, DiscountAuthType, DiscountType, Images, Money, OrderType, ServiceType } from '../global';
-export interface DiscountDaypart {
-    daypart_id: number;
-    end_time: TimeString;
-    name: string;
-    order_type: OrderType;
-    start_time: TimeString;
-}
-export declare type DiscountDayparts = DiscountDaypart[];
-export interface DiscountItem {
-    id: number;
-    category_id: number;
-    name: string;
-    short_name: string;
-}
-export interface DiscountItems {
-    items: DiscountItem[];
-    quantity: number;
-}
-export interface DiscountRevenueCenter {
-    name: string;
-    revenue_center_id: number;
-}
-export declare type DiscountRevenueCenters = DiscountRevenueCenter[];
-export interface Discount {
-    amount: Money;
-    auth_type: DiscountAuthType;
-    channel_type: ChannelType | null;
-    dayparts: DiscountDayparts;
-    description: string;
-    discount_id: number;
-    discount_type: DiscountType;
-    discounted_items: DiscountItems;
-    end_date: DateString | null;
-    expires_at: ISOString | null;
-    images: Images;
-    max_amount: Money | null;
-    max_order_size: Money | null;
-    max_redemptions: number | null;
-    max_redemptions_per: number | null;
-    min_amount: Money | null;
-    min_order_size: Money | null;
-    name: string;
-    order_type: OrderType | null;
-    position?: number;
-    per_order: number | null;
-    points_shop_cost?: Money | null;
-    required_items: DiscountItems;
-    requires_approval?: boolean;
-    revenue_centers: DiscountRevenueCenters;
-    service_type: ServiceType | null;
-    short_description: string;
-    start_date: DateString | null;
-    title: string;
-    end_at: DateString | null;
-}
-export declare type Discounts = Discount[];
-export interface DiscountEnhanced extends Discount {
-    expiration: string | null;
-    imageUrl: string | null;
-    limitations: string;
-    todayOnly: boolean;
-}
-export declare type DiscountsEnhanced = DiscountEnhanced[];

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

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

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

@@ -1,13 +0,0 @@
-import { Money } from '../global';
-import { CreditCardData, CreditCardSaved } from './creditCards';
-export interface DonationPurchase {
-    amount: Money;
-    credit_card: CreditCardData | CreditCardSaved;
-    email: string;
-    token?: string;
-    kount_device_session_id?: string;
-}
-export interface Donation {
-    email: string;
-    amount: Money;
-}

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

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