@open-tender/types 0.4.158 → 0.4.159

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

@@ -0,0 +1,159 @@
+import { TimeString } from '../datetimes';
+import { Decimal, Money, PrepType, ServiceType, TenderType, Weekday } from '../global';
+export declare type PaymentProcessor = 'NONE' | 'CARDCONNECT' | 'VANTIV' | 'CLOVER' | 'NMI';
+export interface PaymentProcessing {
+    integration: PaymentProcessor;
+    is_testing: boolean;
+    merchant_api_key: string;
+    merchant_id: string;
+    merchant_password: string;
+    merchant_username: string;
+    offline_limit: Money | null;
+    saved_cards: boolean;
+    signature_threshold: Money | null;
+}
+export interface StoreTax {
+    amount: Decimal;
+    display_order: number;
+    is_optional: boolean;
+    name: string;
+    tax_id: number;
+    tax_type: number;
+}
+export interface StoreTenderTypes {
+    DELIVERY: TenderType[];
+    PICKUP: TenderType[];
+    WALKIN: TenderType[];
+}
+export interface StoreAddress {
+    city: string;
+    cross_streets: string;
+    directions_link: string;
+    fax: string | null;
+    latitude: string;
+    longitude: string;
+    phone: string | null;
+    postal_code: string;
+    state: string;
+    street: string;
+}
+export interface LevelUp {
+    discount_id: number;
+    location_id: number;
+    merchant_id: number;
+    merchant_token: string;
+    sandbox: boolean;
+}
+export interface StoreMessage {
+    pos_message_id: number;
+    name: string;
+    message_above: string | null;
+    message_below: string | null;
+    message_url: string | null;
+    is_active: boolean;
+}
+export interface StoreGratuity {
+    default_gratuity_percentage: number;
+    percentage_options: number[];
+}
+export declare type MenuType = 'SCROLLABLE' | 'PAGE';
+export declare type NavigationPageType = 'TOP' | 'LEFT' | 'RIGHT';
+export declare type PrepTypeAll = 'TAKE_OUT' | 'EAT_HERE' | 'ALL' | 'NEVER';
+export interface StoreHoursWeekday {
+    day: number;
+    end_min: number;
+    month: number;
+    name: string;
+    start_min: number;
+    weekday: Weekday;
+}
+export declare type StoreHours = StoreHoursWeekday[];
+export interface Store {
+    address: StoreAddress;
+    alert_minutes: number;
+    auth_type: 'PIN' | 'CARD';
+    credit: PaymentProcessing;
+    default_prep_type: PrepType | null;
+    delivery_minutes: number;
+    dine_in_prompt: boolean;
+    dine_in_show: boolean;
+    disable_complete: boolean;
+    display_allergens: boolean;
+    display_cals: boolean;
+    display_customize: boolean;
+    display_deals: boolean;
+    display_favorites: boolean;
+    display_featured: boolean;
+    display_gratuity: boolean;
+    display_guest_name: PrepTypeAll;
+    display_guest_phone: boolean;
+    display_ingredients: boolean;
+    display_made_for: boolean;
+    display_notes: boolean;
+    display_promised_at: boolean;
+    display_promo_code: boolean;
+    display_ready_at: boolean;
+    display_receipt_email: boolean;
+    display_receipt_sms: boolean;
+    display_recents: boolean;
+    display_revenue_center: boolean;
+    display_sign_in: boolean;
+    display_tags: boolean;
+    display_upsells_cart: boolean;
+    display_upsells_checkout: boolean;
+    display_upsells_item: boolean;
+    done_on_print: boolean;
+    end_of_day: TimeString;
+    gratuity: StoreGratuity;
+    greeting: string;
+    has_loyalty: boolean;
+    hide_default_mods: boolean;
+    hide_delay: boolean;
+    is_outpost: boolean;
+    item_discount_approval: boolean;
+    name: string;
+    number: string;
+    order_page_swipe: boolean;
+    overtime_threshold: number;
+    overtime_threshold_daily: number;
+    page_timeout: number;
+    pickup_minutes: number;
+    prep_minutes: number;
+    print_on_completed: boolean;
+    punch_type: 'PIN' | 'CARD';
+    receipt_footer: string;
+    receipt_header: string;
+    receipt_phone: boolean;
+    revenue_center_id: number;
+    service_types: ServiceType[];
+    short_name: string;
+    slug: string;
+    starting_cash: Decimal;
+    store_id: number;
+    tax_exempt_approval: boolean;
+    taxes: StoreTax[];
+    tender_types: StoreTenderTypes;
+    walkin_minutes: number;
+    walkin_prep_minutes: number;
+    warning_minutes: number;
+    week_start_day: Weekday;
+    display_category_nav_page: boolean;
+    guest_name_required: PrepTypeAll;
+    menu_type: MenuType;
+    navigation_page: NavigationPageType;
+    collect_table_number: boolean;
+    table_number_required: boolean;
+    phone_number_required: boolean;
+    gratuity_required: boolean;
+    take_out_custom_name: string | null;
+    eat_here_custom_name: string | null;
+    display_default_prep_type: boolean;
+    display_category_image: boolean;
+    display_descriptions: boolean;
+    disable_kiosk_message: string | null;
+    hours: StoreHours;
+    is_separate_auth_screen: boolean;
+    is_separate_service_type: boolean;
+    display_signup_checkout: boolean;
+}
+export declare type Stores = Store[];

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

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

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

@@ -0,0 +1,15 @@
+import { Money, SurchargeType } from '../global';
+export interface Surcharge {
+    amount: Money;
+    id: number;
+    is_active: boolean;
+    is_taxed: boolean;
+    max_amount: Money;
+    min_amount: Money;
+    name: string;
+    position: number;
+    requires_approval: boolean;
+    surcharge_type: SurchargeType;
+    version: number;
+}
+export declare type Surcharges = Surcharge[];

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

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

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

@@ -0,0 +1,13 @@
+import { Images } from '../global';
+export interface Tag {
+    tag_id: number;
+    description: string | null;
+    images: Images | null;
+    name: string;
+}
+export declare type Tags = Tag[];
+export declare type TagLookup = Record<string, Tag>;
+export interface TagEnhanced extends Tag {
+    imageUrl: string;
+}
+export declare type TagLookupEnhanced = Record<string, TagEnhanced>;

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

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

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

@@ -0,0 +1,15 @@
+import { Money, OrderType, ServiceType, TaxType } from '../global';
+export interface Tax {
+    amount: Money;
+    id: number;
+    max_amount: Money;
+    min_amount: Money;
+    name: string;
+    order_type: OrderType | null;
+    position: number;
+    requires_approval: boolean;
+    service_type: ServiceType | null;
+    tax_type: TaxType;
+    version: number;
+}
+export declare type Taxes = Tax[];

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

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