UNPKG

kiolyn-api-specs

Version:
2,506 lines (2,502 loc) 1.15 MB
// tslint:disable /** * Kiolyn POS API * Kiolyn POS API * * The version of the OpenAPI document: v2 * Contact: chinh@willbe.vn * * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech). * https://openapi-generator.tech * Do not edit the class manually. */ import * as globalImportUrl from 'url'; import { Configuration } from './configuration'; import globalAxios, { AxiosPromise, AxiosInstance } from 'axios'; // Some imports not used depending on template conditions // @ts-ignore import { BASE_PATH, COLLECTION_FORMATS, RequestArgs, BaseAPI, RequiredError } from './base'; /** * * @export * @interface Admin */ export interface Admin extends BaseModel { /** * * @type {string} * @memberof Admin */ email?: string; /** * * @type {string} * @memberof Admin */ first_name?: string; /** * * @type {string} * @memberof Admin */ last_name?: string; /** * * @type {string} * @memberof Admin */ password?: string; /** * * @type {string} * @memberof Admin */ passkey?: string; /** * * @type {boolean} * @memberof Admin */ access_all_stores?: boolean; /** * * @type {AdminPermissions} * @memberof Admin */ permissions?: AdminPermissions; } /** * * @export * @interface AdminAllOf */ export interface AdminAllOf { /** * * @type {string} * @memberof AdminAllOf */ email?: string; /** * * @type {string} * @memberof AdminAllOf */ first_name?: string; /** * * @type {string} * @memberof AdminAllOf */ last_name?: string; /** * * @type {string} * @memberof AdminAllOf */ password?: string; /** * * @type {string} * @memberof AdminAllOf */ passkey?: string; /** * * @type {boolean} * @memberof AdminAllOf */ access_all_stores?: boolean; /** * * @type {AdminPermissions} * @memberof AdminAllOf */ permissions?: AdminPermissions; } /** * * @export * @interface AdminPermissions */ export interface AdminPermissions { /** * * @type {boolean} * @memberof AdminPermissions */ access_partners?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ access_reports?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ all_stations?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ app_setting?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ billings?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ error_log_list?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ invoices?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ partners?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ reports?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ shop_items?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ shop_orders?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ stores?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ store_info?: boolean; /** * * @type {boolean} * @memberof AdminPermissions */ holidays?: boolean; } /** * * @export * @interface AppSettings */ export interface AppSettings extends BaseModel { /** * * @type {number} * @memberof AppSettings */ masterPickupRate?: number; /** * * @type {number} * @memberof AppSettings */ masterDeliveryRate?: number; /** * * @type {number} * @memberof AppSettings */ masterPickupFlatFee?: number; /** * * @type {number} * @memberof AppSettings */ masterDeliveryFlatFee?: number; /** * * @type {number} * @memberof AppSettings */ master_pin?: number; /** * list of support email * @type {Array<SuperAdminSupportEmail>} * @memberof AppSettings */ support_emails?: Array<SuperAdminSupportEmail>; /** * * @type {GoEConfig} * @memberof AppSettings */ goemerchant?: GoEConfig; /** * * @type {DoorDashConfig} * @memberof AppSettings */ doordash?: DoorDashConfig; /** * * @type {Array<AppSettingsAllOfHolidays>} * @memberof AppSettings */ holidays?: Array<AppSettingsAllOfHolidays>; } /** * * @export * @interface AppSettingsAllOf */ export interface AppSettingsAllOf { /** * * @type {number} * @memberof AppSettingsAllOf */ masterPickupRate?: number; /** * * @type {number} * @memberof AppSettingsAllOf */ masterDeliveryRate?: number; /** * * @type {number} * @memberof AppSettingsAllOf */ masterPickupFlatFee?: number; /** * * @type {number} * @memberof AppSettingsAllOf */ masterDeliveryFlatFee?: number; /** * * @type {number} * @memberof AppSettingsAllOf */ master_pin?: number; /** * list of support email * @type {Array<SuperAdminSupportEmail>} * @memberof AppSettingsAllOf */ support_emails?: Array<SuperAdminSupportEmail>; /** * * @type {GoEConfig} * @memberof AppSettingsAllOf */ goemerchant?: GoEConfig; /** * * @type {DoorDashConfig} * @memberof AppSettingsAllOf */ doordash?: DoorDashConfig; /** * * @type {Array<AppSettingsAllOfHolidays>} * @memberof AppSettingsAllOf */ holidays?: Array<AppSettingsAllOfHolidays>; } /** * * @export * @interface AppSettingsAllOfHolidays */ export interface AppSettingsAllOfHolidays { /** * * @type {string} * @memberof AppSettingsAllOfHolidays */ name?: string; /** * * @type {string} * @memberof AppSettingsAllOfHolidays */ date?: string; /** * * @type {string} * @memberof AppSettingsAllOfHolidays */ country?: string; } /** * * @export * @interface Area */ export interface Area extends BaseModel { /** * Area Type * @type {string} * @memberof Area */ area_type?: string; /** * * @type {Array<Table>} * @memberof Area */ layout?: Array<Table>; /** * True if this area is for delivery * @type {boolean} * @memberof Area */ delivery_auto_increment?: boolean; /** * True if this area should prompt for customer info * @type {boolean} * @memberof Area */ customer_info?: boolean; /** * The order in which this area will be displayed in POS app * @type {number} * @memberof Area */ order?: number; /** * True if this created order for this area should have tax by default * @type {boolean} * @memberof Area */ apply_tax?: boolean; /** * Item price type * @type {string} * @memberof Area */ item_price_type?: string; /** * True if apply quick pay * @type {boolean} * @memberof Area */ quick_pay?: boolean; /** * quick payment type * @type {string} * @memberof Area */ quick_payment_type?: string; /** * True if order belongs to this area should pay when send/save * @type {boolean} * @memberof Area */ pay_with_save_send?: boolean; /** * True if auto claim * @type {boolean} * @memberof Area */ auto_claim?: boolean; /** * True if show time lapsed * @type {boolean} * @memberof Area */ show_time_lapsed?: boolean; /** * True if order belongs to this area should print check when send/save * @type {boolean} * @memberof Area */ print_check_with_save_send?: boolean; /** * True if this area should prompt for number of guest * @type {boolean} * @memberof Area */ no_of_guest?: boolean; /** * True if this area should prompt for service fee inputs * @type {boolean} * @memberof Area */ service_fee_prompt?: boolean; /** * True if this area should prompt for delivery fee inputs * @type {boolean} * @memberof Area */ delivery_fee_prompt?: boolean; /** * True if this area should prompt for misc prompt * @type {boolean} * @memberof Area */ misc_prompt?: boolean; /** * True if this area should prompt for condiments * @type {boolean} * @memberof Area */ condiments?: boolean; /** * True if this area should prompt for plastic utensils * @type {boolean} * @memberof Area */ plastic_utensils?: boolean; /** * True if this area should prompt for pickup/delivery time inputs * @type {boolean} * @memberof Area */ pickup_delivery_prompt?: boolean; /** * Pickup/delivery time inputs * @type {number} * @memberof Area */ time_delay?: number; /** * True if this area is for TOGO * @type {boolean} * @memberof Area */ togo_auto_increment?: boolean; /** * * @type {string} * @memberof Area */ check_copies?: string; /** * * @type {Array<ReceiptSettings>} * @memberof Area */ receipt_settings?: Array<ReceiptSettings>; /** * * @type {Array<string>} * @memberof Area */ kitchen_receipts?: Array<string>; /** * * @type {Array<string>} * @memberof Area */ payment_types?: Array<string>; /** * * @type {boolean} * @memberof Area */ auto_assign?: boolean; /** * * @type {string} * @memberof Area */ assigned_employee?: string; /** * * @type {string} * @memberof Area */ payment_type_for_order_pay?: string; /** * * @type {Array<AreaAllOfPrinterGroupItems>} * @memberof Area */ printer_group_items?: Array<AreaAllOfPrinterGroupItems>; /** * * @type {boolean} * @memberof Area */ pay_first_send_later?: boolean; } /** * * @export * @interface AreaAllOf */ export interface AreaAllOf { /** * Area Type * @type {string} * @memberof AreaAllOf */ area_type?: string; /** * * @type {Array<Table>} * @memberof AreaAllOf */ layout?: Array<Table>; /** * True if this area is for delivery * @type {boolean} * @memberof AreaAllOf */ delivery_auto_increment?: boolean; /** * True if this area should prompt for customer info * @type {boolean} * @memberof AreaAllOf */ customer_info?: boolean; /** * The order in which this area will be displayed in POS app * @type {number} * @memberof AreaAllOf */ order?: number; /** * True if this created order for this area should have tax by default * @type {boolean} * @memberof AreaAllOf */ apply_tax?: boolean; /** * Item price type * @type {string} * @memberof AreaAllOf */ item_price_type?: string; /** * True if apply quick pay * @type {boolean} * @memberof AreaAllOf */ quick_pay?: boolean; /** * quick payment type * @type {string} * @memberof AreaAllOf */ quick_payment_type?: string; /** * True if order belongs to this area should pay when send/save * @type {boolean} * @memberof AreaAllOf */ pay_with_save_send?: boolean; /** * True if auto claim * @type {boolean} * @memberof AreaAllOf */ auto_claim?: boolean; /** * True if show time lapsed * @type {boolean} * @memberof AreaAllOf */ show_time_lapsed?: boolean; /** * True if order belongs to this area should print check when send/save * @type {boolean} * @memberof AreaAllOf */ print_check_with_save_send?: boolean; /** * True if this area should prompt for number of guest * @type {boolean} * @memberof AreaAllOf */ no_of_guest?: boolean; /** * True if this area should prompt for service fee inputs * @type {boolean} * @memberof AreaAllOf */ service_fee_prompt?: boolean; /** * True if this area should prompt for delivery fee inputs * @type {boolean} * @memberof AreaAllOf */ delivery_fee_prompt?: boolean; /** * True if this area should prompt for misc prompt * @type {boolean} * @memberof AreaAllOf */ misc_prompt?: boolean; /** * True if this area should prompt for condiments * @type {boolean} * @memberof AreaAllOf */ condiments?: boolean; /** * True if this area should prompt for plastic utensils * @type {boolean} * @memberof AreaAllOf */ plastic_utensils?: boolean; /** * True if this area should prompt for pickup/delivery time inputs * @type {boolean} * @memberof AreaAllOf */ pickup_delivery_prompt?: boolean; /** * Pickup/delivery time inputs * @type {number} * @memberof AreaAllOf */ time_delay?: number; /** * True if this area is for TOGO * @type {boolean} * @memberof AreaAllOf */ togo_auto_increment?: boolean; /** * * @type {string} * @memberof AreaAllOf */ check_copies?: string; /** * * @type {Array<ReceiptSettings>} * @memberof AreaAllOf */ receipt_settings?: Array<ReceiptSettings>; /** * * @type {Array<string>} * @memberof AreaAllOf */ kitchen_receipts?: Array<string>; /** * * @type {Array<string>} * @memberof AreaAllOf */ payment_types?: Array<string>; /** * * @type {boolean} * @memberof AreaAllOf */ auto_assign?: boolean; /** * * @type {string} * @memberof AreaAllOf */ assigned_employee?: string; /** * * @type {string} * @memberof AreaAllOf */ payment_type_for_order_pay?: string; /** * * @type {Array<AreaAllOfPrinterGroupItems>} * @memberof AreaAllOf */ printer_group_items?: Array<AreaAllOfPrinterGroupItems>; /** * * @type {boolean} * @memberof AreaAllOf */ pay_first_send_later?: boolean; } /** * * @export * @interface AreaAllOfPrinterGroupItems */ export interface AreaAllOfPrinterGroupItems { /** * * @type {string} * @memberof AreaAllOfPrinterGroupItems */ printer_id?: string; /** * * @type {Array<number>} * @memberof AreaAllOfPrinterGroupItems */ items?: Array<number>; } /** * * @export * @interface AuthenticateRequest */ export interface AuthenticateRequest { /** * * @type {string} * @memberof AuthenticateRequest */ username: string; /** * * @type {string} * @memberof AuthenticateRequest */ password: string; } /** * auto close batch settings * @export * @interface AutoCloseBatchSettings */ export interface AutoCloseBatchSettings { /** * true if auto close batch enable. * @type {boolean} * @memberof AutoCloseBatchSettings */ enable?: boolean; /** * The time start to auto close batch. * @type {string} * @memberof AutoCloseBatchSettings */ start_time?: string; /** * The time end to auto close batch. * @type {string} * @memberof AutoCloseBatchSettings */ end_time?: string; /** * The number to retry. * @type {number} * @memberof AutoCloseBatchSettings */ retry_interval?: number; } /** * * @export * @interface BaseModel */ export interface BaseModel { /** * Object ID in timestamp format to 10 milliseconds * @type {string} * @memberof BaseModel */ id: string; /** * * @type {string} * @memberof BaseModel */ type: string; /** * name of the object. * @type {string} * @memberof BaseModel */ name: string; /** * extra name of the object (normally for naming in different language). * @type {string} * @memberof BaseModel */ name2?: string; /** * The ID of the merchant that this model belong to * @type {string} * @memberof BaseModel */ merchantid?: string; /** * The ID of the store that this model belong to * @type {string} * @memberof BaseModel */ storeid?: string; /** * The timestamp of last updated time * @type {string} * @memberof BaseModel */ updated_at?: string; /** * The ID of user who made the last updated * @type {string} * @memberof BaseModel */ updated_by?: string; } /** * * @export * @interface BaseOrderingStore */ export interface BaseOrderingStore { /** * id of the store. * @type {string} * @memberof BaseOrderingStore */ id?: string; /** * name of the store. * @type {string} * @memberof BaseOrderingStore */ name?: string; /** * * @type {string} * @memberof BaseOrderingStore */ image_url?: string; /** * address of the store. * @type {string} * @memberof BaseOrderingStore */ address?: string; /** * email of the store. * @type {string} * @memberof BaseOrderingStore */ email?: string; /** * phone of the store. * @type {string} * @memberof BaseOrderingStore */ phone?: string; /** * description of the store. * @type {string} * @memberof BaseOrderingStore */ description?: string; /** * true if this store accept order if it is false, then all the Submit Order must be disabled. * @type {boolean} * @memberof BaseOrderingStore */ accept_order?: boolean; /** * true if the default view is thumbnail mode. If false, it is list mode. * @type {boolean} * @memberof BaseOrderingStore */ default_view?: boolean; /** * * @type {Tax} * @memberof BaseOrderingStore */ tax?: Tax; /** * all categories available for ordering. * @type {Array<OrderingCategory>} * @memberof BaseOrderingStore */ categories?: Array<OrderingCategory>; /** * all modifiers available for selecting. * @type {Array<OrderingModifier>} * @memberof BaseOrderingStore */ modifiers?: Array<OrderingModifier>; /** * all promotions available when ordering. * @type {Array<Promotion>} * @memberof BaseOrderingStore */ promotions?: Array<Promotion>; /** * list of from/to working hours in weeks * @type {Array<OrderingBizHour>} * @memberof BaseOrderingStore */ biz_hours?: Array<OrderingBizHour>; /** * list of holidays in year * @type {Array<OrderingHoliday>} * @memberof BaseOrderingStore */ holidays?: Array<OrderingHoliday>; /** * * @type {OrderingLocale} * @memberof BaseOrderingStore */ locale?: OrderingLocale; /** * true to show category types, false otherwise. * @type {boolean} * @memberof BaseOrderingStore */ show_category_types?: boolean; /** * all category types of store that user has arranged the order. * @type {Array<string>} * @memberof BaseOrderingStore */ all_category_types?: Array<string>; /** * true to show special note and special note amount, false otherwise. * @type {boolean} * @memberof BaseOrderingStore */ show_special_note?: boolean; /** * true if auto move/send is enabled. * @type {boolean} * @memberof BaseOrderingStore */ auto_move_send?: boolean; /** * the auto move/send time in minutes for pickup order. * @type {number} * @memberof BaseOrderingStore */ delay_pickup_time?: number; /** * the auto move/send time in minutes for delay dinein time. * @type {number} * @memberof BaseOrderingStore */ delay_dinein_time?: number; /** * the auto move/send time in minutes for delivery order. * @type {number} * @memberof BaseOrderingStore */ delay_delivery_time?: number; /** * the time that we delivery. * @type {number} * @memberof BaseOrderingStore */ delivery_time?: number; /** * timezone of the store. * @type {string} * @memberof BaseOrderingStore */ timezone?: string; } /** * * @export * @interface BillReport */ export interface BillReport { /** * * @type {number} * @memberof BillReport */ custom_fee?: number; /** * * @type {number} * @memberof BillReport */ custom_service_fee_amount?: number; /** * * @type {number} * @memberof BillReport */ delivery_fee_amount?: number; /** * * @type {DiscountReport} * @memberof BillReport */ discount?: DiscountReport; } /** * * @export * @interface BillingReport */ export interface BillingReport extends BaseModel { /** * * @type {string} * @memberof BillingReport */ billingType?: string; /** * * @type {string} * @memberof BillingReport */ description?: string; /** * * @type {number} * @memberof BillingReport */ amount?: number; /** * * @type {string} * @memberof BillingReport */ date?: string; /** * * @type {string} * @memberof BillingReport */ storeid?: string; } /** * * @export * @interface BillingReportAllOf */ export interface BillingReportAllOf { /** * * @type {string} * @memberof BillingReportAllOf */ billingType?: string; /** * * @type {string} * @memberof BillingReportAllOf */ description?: string; /** * * @type {number} * @memberof BillingReportAllOf */ amount?: number; /** * * @type {string} * @memberof BillingReportAllOf */ date?: string; /** * * @type {string} * @memberof BillingReportAllOf */ storeid?: string; } /** * * @export * @interface BillingStation */ export interface BillingStation extends BaseModel { /** * The type of station can be PC or iPad * @type {string} * @memberof BillingStation */ stationType?: string; /** * True if this station is Main. * @type {boolean} * @memberof BillingStation */ main?: boolean; /** * * @type {number} * @memberof BillingStation */ quantity?: number; /** * * @type {string} * @memberof BillingStation */ storeName?: string; /** * * @type {number} * @memberof BillingStation */ fee?: number; /** * * @type {number} * @memberof BillingStation */ flatFee?: number; /** * * @type {number} * @memberof BillingStation */ rate?: number; /** * * @type {number} * @memberof BillingStation */ total?: number; } /** * * @export * @interface BillingStationAllOf */ export interface BillingStationAllOf { /** * The type of station can be PC or iPad * @type {string} * @memberof BillingStationAllOf */ stationType?: string; /** * True if this station is Main. * @type {boolean} * @memberof BillingStationAllOf */ main?: boolean; /** * * @type {number} * @memberof BillingStationAllOf */ quantity?: number; /** * * @type {string} * @memberof BillingStationAllOf */ storeName?: string; /** * * @type {number} * @memberof BillingStationAllOf */ fee?: number; /** * * @type {number} * @memberof BillingStationAllOf */ flatFee?: number; /** * * @type {number} * @memberof BillingStationAllOf */ rate?: number; /** * * @type {number} * @memberof BillingStationAllOf */ total?: number; } /** * * @export * @interface BillingSubscription */ export interface BillingSubscription { /** * * @type {Array<BillingSubscriptionData>} * @memberof BillingSubscription */ data?: Array<BillingSubscriptionData>; /** * * @type {number} * @memberof BillingSubscription */ total?: number; } /** * * @export * @interface BillingSubscriptionData */ export interface BillingSubscriptionData { /** * * @type {string} * @memberof BillingSubscriptionData */ id?: string; /** * * @type {string} * @memberof BillingSubscriptionData */ billingType?: string; /** * * @type {number} * @memberof BillingSubscriptionData */ amount?: number; /** * * @type {string} * @memberof BillingSubscriptionData */ date?: string; /** * * @type {string} * @memberof BillingSubscriptionData */ storeid?: string; /** * * @type {string} * @memberof BillingSubscriptionData */ storeName?: string; /** * * @type {string} * @memberof BillingSubscriptionData */ description?: string; /** * * @type {string} * @memberof BillingSubscriptionData */ transformedDescription?: string; /** * * @type {number} * @memberof BillingSubscriptionData */ ofOrders?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ rate?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ fee?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ flatFee?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ tip?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ tipForStaff?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ tipForDriver?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ total?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ secondFee?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ percent?: number; /** * * @type {number} * @memberof BillingSubscriptionData */ subtotal?: number; } /** * * @export * @interface CCDevice */ export interface CCDevice extends BaseModel { /** * True if this device still be connected. * @type {boolean} * @memberof CCDevice */ enabled?: boolean; /** * This is location that device belong to * @type {string} * @memberof CCDevice */ location?: string; /** * This is cc device type. * @type {string} * @memberof CCDevice */ ccdevice_type?: string; /** * * @type {string} * @memberof CCDevice */ ip_address?: string; /** * * @type {string} * @memberof CCDevice */ mac_address?: string; /** * * @type {string} * @memberof CCDevice */ serial_number?: string; /** * * @type {boolean} * @memberof CCDevice */ show_tip_guide_on_pax_device?: boolean; } /** * * @export * @interface CCDeviceAllOf */ export interface CCDeviceAllOf { /** * True if this device still be connected. * @type {boolean} * @memberof CCDeviceAllOf */ enabled?: boolean; /** * This is location that device belong to * @type {string} * @memberof CCDeviceAllOf */ location?: string; /** * This is cc device type. * @type {string} * @memberof CCDeviceAllOf */ ccdevice_type?: string; /** * * @type {string} * @memberof CCDeviceAllOf */ ip_address?: string; /** * * @type {string} * @memberof CCDeviceAllOf */ mac_address?: string; /** * * @type {string} * @memberof CCDeviceAllOf */ serial_number?: string; /** * * @type {boolean} * @memberof CCDeviceAllOf */ show_tip_guide_on_pax_device?: boolean; } /** * * @export * @interface CCPoint */ export interface CCPoint extends BaseModel { /** * * @type {string} * @memberof CCPoint */ description?: string; /** * * @type {number} * @memberof CCPoint */ percent?: number; /** * * @type {number} * @memberof CCPoint */ point?: number; /** * * @type {string} * @memberof CCPoint */ subtype?: string; /** * * @type {string} * @memberof CCPoint */ time?: string; /** * * @type {number} * @memberof CCPoint */ total?: number; /** * * @type {number} * @memberof CCPoint */ balance?: number; } /** * * @export * @interface CCPointAllOf */ export interface CCPointAllOf { /** * * @type {string} * @memberof CCPointAllOf */ description?: string; /** * * @type {number} * @memberof CCPointAllOf */ percent?: number; /** * * @type {number} * @memberof CCPointAllOf */ point?: number; /** * * @type {string} * @memberof CCPointAllOf */ subtype?: string; /** * * @type {string} * @memberof CCPointAllOf */ time?: string; /** * * @type {number} * @memberof CCPointAllOf */ total?: number; /** * * @type {number} * @memberof CCPointAllOf */ balance?: number; } /** * * @export * @interface Category */ export interface Category extends BaseModel { /** * True if this category should not be displayed in POS app for ordering * @type {boolean} * @memberof Category */ hidden?: boolean; /** * True if this category should be displayed in web order * @type {boolean} * @memberof Category */ show_on_web_order?: boolean; /** * The types of category to be grouped in POS app * @type {Array<string>} * @memberof Category */ category_types?: Array<string>; /** * The bucket of category * @type {Array<string>} * @memberof Category */ category_buckets?: Array<string>; /** * * @type {Array<PrinterReceipt>} * @memberof Category */ printers?: Array<PrinterReceipt>; /** * * @type {Array<KitchenDisplay>} * @memberof Category */ kitchen_displays?: Array<KitchenDisplay>; /** * The display color on menu of POS app * @type {string} * @memberof Category */ color?: string; /** * The display order inside a category group * @type {string} * @memberof Category */ order?: string; /** * True if this category can open new item when ordering on PC/iPad * @type {boolean} * @memberof Category */ open_item?: boolean; /** * Category description * @type {string} * @memberof Category */ description?: string; /** * * @type {CategorySchedules} * @memberof Category */ schedules?: CategorySchedules; /** * True if user can create gift cards for this category * @type {boolean} * @memberof Category */ gift_card?: boolean; /** * True if user can create gift certificates for this category * @type {boolean} * @memberof Category */ gift_certificate?: boolean; /** * The display order of this category in online ordering. * @type {number} * @memberof Category */ display_order?: number; /** * * @type {number} * @memberof Category */ max_display_count?: number; } /** * * @export * @interface CategoryAllOf */ export interface CategoryAllOf { /** * True if this category should not be displayed in POS app for ordering * @type {boolean} * @memberof CategoryAllOf */ hidden?: boolean; /** * True if this category should be displayed in web order * @type {boolean} * @memberof CategoryAllOf */ show_on_web_order?: boolean; /** * The types of category to be grouped in POS app * @type {Array<string>} * @memberof CategoryAllOf */ category_types?: Array<string>; /** * The bucket of category * @type {Array<string>} * @memberof CategoryAllOf */ category_buckets?: Array<string>; /** * * @type {Array<PrinterReceipt>} * @memberof CategoryAllOf */ printers?: Array<PrinterReceipt>; /** * * @type {Array<KitchenDisplay>} * @memberof CategoryAllOf */ kitchen_displays?: Array<KitchenDisplay>; /** * The display color on menu of POS app * @type {string} * @memberof CategoryAllOf */ color?: string; /** * The display order inside a category group * @type {string} * @memberof CategoryAllOf */ order?: string; /** * True if this category can open new item when ordering on PC/iPad * @type {boolean} * @memberof CategoryAllOf */ open_item?: boolean; /** * Category description * @type {string} * @memberof CategoryAllOf */ description?: string; /** * * @type {CategorySchedules} * @memberof CategoryAllOf */ schedules?: CategorySchedules; /** * True if user can create gift cards for this category * @type {boolean} * @memberof CategoryAllOf */ gift_card?: boolean; /** * True if user can create gift certificates for this category * @type {boolean} * @memberof CategoryAllOf */ gift_certificate?: boolean; /** * The display order of this category in online ordering. * @type {number} * @memberof CategoryAllOf */ display_order?: number; /** * * @type {number} * @memberof CategoryAllOf */ max_display_count?: number; } /** * * @export * @interface CategoryScheduleHour */ export interface CategoryScheduleHour { /** * date of week in number. * @type {number} * @memberof CategoryScheduleHour */ day_of_week?: number; /** * true if it this is a available day, false otherwise. * @type {boolean} * @memberof CategoryScheduleHour */ is_available?: boolean; /** * first period start time. * @type {string} * @memberof CategoryScheduleHour */ from_1?: string; /** * first period end time. * @type {string} * @memberof CategoryScheduleHour */ to_1?: string; /** * second period start time. * @type {string} * @memberof CategoryScheduleHour */ from_2?: string; /** * second period end time. * @type {string} * @memberof CategoryScheduleHour */ to_2?: string; } /** * * @export * @interface CategorySchedules */ export interface CategorySchedules { /** * True if this category is always available to order * @type {boolean} * @memberof CategorySchedules */ always_available?: boolean; /** * The message show in web order when category is not available. * @type {string} * @memberof CategorySchedules */ unavailable_message?: string; /** * list of from/to available hours in weeks. * @type {Array<CategoryScheduleHour>} * @memberof CategorySchedules */ available_hours?: Array<CategoryScheduleHour>; } /** * * @export * @interface CategorySummary */ export interface CategorySummary { /** * the Category\'s ID * @type {string} * @memberof CategorySummary */ id?: string; /** * the Category\'s Name * @type {string} * @memberof CategorySummary */ name?: string; /** * the number of Items belongs to this Category * @type {number} * @memberof CategorySummary */ item_count?: number; } /** * * @export * @interface ChangePasswordRequest */ export interface ChangePasswordRequest { /** * * @type {string} * @memberof ChangePasswordRequest */ password: string; } /** * * @export * @interface ClockOutReason */ export interface ClockOutReason { /** * * @type {string} * @memberof ClockOutReason */ id?: string; /** * * @type {string} * @memberof ClockOutReason */ duration?: string; /** * * @type {string} * @memberof ClockOutReason */ time?: string; /** * * @type {string} * @memberof ClockOutReason */ name?: string; } /** * the payment card used for paying online order * @export * @interface CreditCard */ export interface CreditCard { /** * card holder name. * @type {string} * @memberof CreditCard */ name?: string; /** * card code. * @type {string} * @memberof CreditCard */ cvc?: string; /** * card number (no space). * @type {string} * @memberof CreditCard */ number?: string; /** * card expiration in MMYY format. * @type {string} * @memberof CreditCard */ expiry?: string; } /** * * @export * @interface CustomFeePercent */ export interface CustomFeePercent { /** * * @type {string} * @memberof CustomFeePercent */ name?: string; /** * the percent to be applied to the subtotal amount. * @type {number} * @memberof CustomFeePercent */ percent?: number; } /** * * @export * @interface Customer */ export interface Customer extends BaseModel { /** * * @type {string} * @memberof Customer */ address?: string; /** * * @type {string} * @memberof Customer */ city?: string; /** * * @type {string} * @memberof Customer */ country?: string; /** * * @type {string} * @memberof Customer */ email?: string; /** * * @type {string} * @memberof Customer */ note?: string; /** * * @type {string} * @memberof Customer */ state?: string; /** * * @type {string} * @memberof Customer */ zip?: string; /** * * @type {string} * @memberof Customer */ mobilephone?: string; /** * * @type {string} * @memberof Customer */ company?: string; /** * * @type {number} * @memberof Customer */ customer_no?: number; /** * * @type {number} * @memberof Customer */ reward_points?: number; /** * * @type {number} * @memberof Customer */ deposit_amount?: number; } /** * * @export * @interface CustomerAllOf */ export interface CustomerAllOf { /** * * @type {string} * @memberof CustomerAllOf */ address?: string; /** * * @type {string} * @memberof CustomerAllOf */ city?: string; /** * * @type {string} * @memberof CustomerAllOf */ country?: string; /** * * @type {string} * @memberof CustomerAllOf */ email?: string; /** * * @type {string} * @memberof CustomerAllOf */ note?: string; /** * * @type {string} * @memberof CustomerAllOf */ state?: string; /** * * @type {string} * @memberof CustomerAllOf */ zip?: string; /** * * @type {string} * @memberof CustomerAllOf */ mobilephone?: string; /** * * @type {string} * @memberof CustomerAllOf */ company?: string; /** * * @type {number} * @memberof CustomerAllOf */ customer_no?: number; /** * * @type {number} * @memberof CustomerAllOf */ reward_points?: number; /** * * @type {number} * @memberof CustomerAllOf */ deposit_amount?: number; } /** * Wrap all necessary information for displaying of a screen * @export * @interface DSScreen */ export interface DSScreen { /** * id of this screen * @type {string} * @memberof DSScreen */ id?: string; /** * nameof this screen * @type {string} * @memberof DSScreen */ name?: string; /** * the background of the screen * @type {string} * @memberof DSScreen */ background?: string; /** * true to have no spacing between items * @type {boolean} * @memberof DSScreen */ dense?: boolean; /** * the font size used to display category * @type {number} * @memberof DSScreen */ category_font_size?: number; /** * the color used to display category * @type {string} * @memberof DSScreen */ category_color?: string; /** * the font size used to display item * @type {number} * @memberof DSScreen */ item_font_size?: number; /** * the color used to display item * @type {string} * @memberof DSScreen */ item_color?: string; /** * the font size used to display item\'s description * @type {number} * @memberof DSScreen */ description_font_size?: number; /** * the color used to display item\'s description * @type {string} * @memberof DSScreen */ description_color?: string; /** * the image to be displayed as top image * @type {string} * @memberof DSScreen */ top_image_url?: string; /** * the height of top image banner * @type {number} * @memberof DSScreen */ top_image_height?: number; /** * the image to be displayed as bottom image * @type {string} * @memberof DSScreen */ bottom_image_url?: string; /** * the height of bottom image banner * @type {number} * @memberof DSScreen */ bottom_image_height?: number; /** * true to show name 2 of item * @type {boolean} * @memberof DSScreen */ show_name_2?: boolean; /** * The list of columns to be displayed (should have 1-3 elements only). This property only makes sense when the screen type is menu. * @type {Array<DSScreenColumn>} * @memberof DSScreen */ columns?: Array<DSScreenColumn>; } /** * a cell inside a digital signage screen * @export * @interface DSScreenCell */ export interface DSScreenCell { /** * The type of of object, currently support category and slideshow. * @type {string} * @memberof DSScreenCell */ type: string; /** * show on tv * @type {boolean} * @memberof DSScreenCell */ show_on_tv?: boolean; } /** * a column inside a digital signage screen * @export * @interface DSScreenColumn */ export interface DSScreenColumn { /** * The list of categories/slides to be displayed on this column * @type {Array<DSScreenMenuCell | DSScreenSlideshowCell>} * @memberof DSScreenColumn */ cells?: Array<DSScreenMenuCell | DSScreenSlideshowCell>; /** * set list or thumbnail for columns * @type {string} * @memberof DSScreenColumn */ list_thumbnail?: string; } /** * * @export * @interface DSScreenMenuCell */ export interface DSScreenMenuCell extends DSScreenCell { /** * The category name * @type {string} * @memberof DSScreenMenuCell */ name?: string; /** * The list of items in this category * @type {Array<DSScreenMenuCellItem>} * @memberof DSScreenMenuCell */ items?: Array<DSScreenMenuCellItem>; /** * set list or thumbnail for screencell * @type {string} * @memberof DSScreenMenuCell */ list_thumbnail?: string; /** * true to show name 2 of item * @type {boolean} * @memberof DSScreenMenuCell */ show_name_2?: boolean; } /** * a single menu item to be displayed in digital signage. * @export * @interface DSScreenMenuCellItem */ export interface DSScreenMenuCellItem { /** * The item name * @type {string} * @memberof DSScreenMenuCellItem */ name?: string; /** * The item name2 * @type {string} * @memberof DSScreenMenuCellItem */ name2?: string; /** * The item description * @type {string} * @memberof DSScreenMenuCellItem */ description?: string; /** * The item price * @type {number} * @memberof DSScreenMenuCellItem */ price?: number; /** * the full URL of the item\'s image * @type {string} * @memberof DSScreenMenuCellItem */ imageURL?: string; /** * true to show item on tv * @type {boolean} * @memberof DSScreenMenuCellItem */ show_hide_on_tv?: boolean; } /** * * @export * @interface DSScreenSlideshowCell */ export interface DSScreenSlideshowCell extends DSScreenCell { /** * fullscreen or not fullscreen * @type {boolean} * @memberof DSScreenSlideshowCell */ fullscreen?: boolean; /** * heigh of the cell * @type {number} * @memberof DSScreenSlideshowCell */ height?: number; /** * * @type {Array<string>} * @memberof DSScreenSlideshowCell */ images?: Array<string>; } /** * * @export * @interface DSScreenStatusBoardCell */ export interface DSScreenStatusBoardCell extends DSScreenCell { /** * True if this status board is full height * @type {boolean} * @memberof DSScreenStatusBoardCell */ is_full_height?: boolean; /** * height of the cell * @type {number} * @memberof DSScreenStatusBoardCell */ height?: number; /** * content font size of the cell * @type {number} * @memberof DSScreenStatusBoardCell */ font_size?: number; } /** * * @export * @interface DailyReportQueryResult */ export interface DailyReportQueryResult { /** * * @type {Array<DailyReportRow>} * @memberof DailyReportQueryResult */ data: Array<DailyReportRow>; /** * * @type {SummaryDailyReport} * @memberof DailyReportQueryResult */ summary: SummaryDailyReport; } /** * * @export * @interface DailyReportQueryResultAllOf */ export interface DailyReportQueryResultAllOf { /** * * @type {Array<DailyReportRow>} * @memberof DailyReportQueryResultAllOf */ data?: Array<DailyReportRow>; /** * * @type {SummaryDailyReport} * @memberof DailyReportQueryResultAllOf */ summary?: SummaryDailyReport; } /** * * @export * @interface DailyReportRow */ export interface DailyReportRow { /** * The total value of the report data * @type {number} * @memberof DailyReportRow */ total: number; /** * The date of sale * @type {string} * @memberof DailyReportRow */ date: string; /** * The shift of sale * @type {number} * @memberof DailyReportRow */ shift?: number; /** * The service_fee of sale * @type {number} * @memberof DailyReportRow */ service_fee?: number; /** * The service_fee_tax of sale * @type {number} * @memberof DailyReportRow */ service_fee_tax?: number; /** * The tax of sale * @type {number} * @memberof DailyReportRow */ tax?: number; /** * The net of sale * @type {number} * @memberof DailyReportRow */ net?: number; /** * The cc_sales of sale * @type {number} * @memberof DailyReportRow */ cc_sales?: number; /** * The cc_sales_with_tip of sale * @type {number} * @memberof DailyReportRow */ cc_sales_with_tip?: number; /** * The gift_card_sales of sale * @type {number} * @memberof DailyReportRow */ gift_card_sales?: number; /** * The gift_certificate_sales of sale * @type {number} * @memberof DailyReportRow */ gift_certificate_sales?: number; } /** * The row contains daily report * @export * @interface DailyReportRowAllOf */ export interface DailyReportRowAllOf { /** * The date of sale * @type {string} * @memberof DailyReportRowAllOf */ date: string; /** * The shift of sale * @type {number}