@compassdigital/sdk.typescript 4.67.0 → 4.69.0

package/src/interface/partner.ts

@@ -1,213 +1,213 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface Error {
-  message?: string;
-  code?: number;
-  data?: Record<string, any>;
+	message?: string;
+	code?: number;
+	data?: Record<string, any>;
 }
 
 export interface ShoppingCartResponse {
-  // shoppingcart
-  id?: string;
-  // location
-  location?: string;
-  // menu
-  menu?: string;
-  // brand
-  brand?: string;
-  date?: Record<string, any>;
-  items?: ItemResponse[];
-  sub_total?: {
-    amount?: MonetaryValue;
-  };
-  promo?: {
-    code?: string;
-    provider?: "fp" | "voucherify";
-    amount_off?: MonetaryValue;
-    percent_off?: MonetaryValue;
-    amount?: MonetaryValue;
-    app?: string;
-    discount?: Record<string, any>;
-    provider_data?: FPValidationData;
-  };
-  //@deprecated
-  loyalty?: {
-    coupon?: {
-      code?: string;
-      amount_off?: MonetaryValue;
-      amount?: MonetaryValue;
-      name?: string;
-    };
-    // Points to be earned for this shopping cart total
-    order_loyalty_points?: boolean;
-  };
-  discount?: {
-    code?: string;
-    provider?: "fp" | "voucherify";
-    amount_off?: MonetaryValue;
-    percent_off?: MonetaryValue;
-    amount?: MonetaryValue;
-    discount?: Record<string, any>;
-    provider_data?: FPValidationData;
-  };
-  payment_method?: {
-    // Mealplan payment details
-    mealplan?: {
-      id?: string;
-      tender?: string;
-      total?: MonetaryValue;
-      type?: PaymentType;
-    };
-    // Credit Cart payment details
-    credit_card?: {
-      card_type?: string;
-      last4?: string;
-      total?: MonetaryValue;
-      type?: PaymentType;
-    };
-    // Digital Wallet Pay payment details
-    digital_wallet_pay?: {
-      wallet_type?: string;
-      total?: MonetaryValue;
-      type?: PaymentType;
-    };
-    // Meal Swipes payment details
-    meal_swipes?: {
-      id?: string;
-      tender?: string;
-      tender_type?: string;
-      tender_name?: string;
-      swipes?: MonetaryValue;
-      rate?: MonetaryValue;
-      total?: MonetaryValue;
-      type?: PaymentType;
-    };
-    // Meal Exchange payment details
-    meal_exchange?: {
-      id?: string;
-      tender?: string;
-      type?: PaymentType;
-    };
-    badge_pay?: CashlessTender;
-    stipend?: CashlessTender;
-    voucher?: CashlessTender;
-    coupon_voucher?: CashlessTender;
-  };
-  taxes?: Taxes;
-  total?: {
-    amount?: MonetaryValue;
-    meals?: MonetaryValue;
-  };
-  exemptions?: {
-    tax?: boolean;
-  };
-  order?: {
-    // order
-    id?: string;
-  };
-  service_fee?: {
-    amount?: MonetaryValue;
-  };
-  delivery_fee?: {
-    amount?: MonetaryValue;
-  };
-  is?: {
-    // Shoppingcart Type: delivery, pickup
-    type?: "delivery" | "pickup" | "scan_and_go" | "frictionless";
-    // If an order should be paid with meal exchange. If true, this will calculate meals total.
-    mx_cart?: boolean;
-    // If a user's email or email domain is a match in a sites list of tax exempt emails or domains
-    email_tax_exempt?: boolean;
-    // Indicates to clients that a tax recalculation is required
-    tax_calculation_required?: boolean;
-  };
-  meta?: {
-    // Raw request from any vendor integrated with CDL
-    vendor?: Record<string, any>;
-    [index: string]: any;
-  };
+	// shoppingcart
+	id?: string;
+	// location
+	location?: string;
+	// menu
+	menu?: string;
+	// brand
+	brand?: string;
+	date?: Record<string, any>;
+	items?: ItemResponse[];
+	sub_total?: {
+		amount?: MonetaryValue;
+	};
+	promo?: {
+		code?: string;
+		provider?: 'fp' | 'voucherify';
+		amount_off?: MonetaryValue;
+		percent_off?: MonetaryValue;
+		amount?: MonetaryValue;
+		app?: string;
+		discount?: Record<string, any>;
+		provider_data?: FPValidationData;
+	};
+	//@deprecated
+	loyalty?: {
+		coupon?: {
+			code?: string;
+			amount_off?: MonetaryValue;
+			amount?: MonetaryValue;
+			name?: string;
+		};
+		// Points to be earned for this shopping cart total
+		order_loyalty_points?: boolean;
+	};
+	discount?: {
+		code?: string;
+		provider?: 'fp' | 'voucherify';
+		amount_off?: MonetaryValue;
+		percent_off?: MonetaryValue;
+		amount?: MonetaryValue;
+		discount?: Record<string, any>;
+		provider_data?: FPValidationData;
+	};
+	payment_method?: {
+		// Mealplan payment details
+		mealplan?: {
+			id?: string;
+			tender?: string;
+			total?: MonetaryValue;
+			type?: PaymentType;
+		};
+		// Credit Cart payment details
+		credit_card?: {
+			card_type?: string;
+			last4?: string;
+			total?: MonetaryValue;
+			type?: PaymentType;
+		};
+		// Digital Wallet Pay payment details
+		digital_wallet_pay?: {
+			wallet_type?: string;
+			total?: MonetaryValue;
+			type?: PaymentType;
+		};
+		// Meal Swipes payment details
+		meal_swipes?: {
+			id?: string;
+			tender?: string;
+			tender_type?: string;
+			tender_name?: string;
+			swipes?: MonetaryValue;
+			rate?: MonetaryValue;
+			total?: MonetaryValue;
+			type?: PaymentType;
+		};
+		// Meal Exchange payment details
+		meal_exchange?: {
+			id?: string;
+			tender?: string;
+			type?: PaymentType;
+		};
+		badge_pay?: CashlessTender;
+		stipend?: CashlessTender;
+		voucher?: CashlessTender;
+		coupon_voucher?: CashlessTender;
+	};
+	taxes?: Taxes;
+	total?: {
+		amount?: MonetaryValue;
+		meals?: MonetaryValue;
+	};
+	exemptions?: {
+		tax?: boolean;
+	};
+	order?: {
+		// order
+		id?: string;
+	};
+	service_fee?: {
+		amount?: MonetaryValue;
+	};
+	delivery_fee?: {
+		amount?: MonetaryValue;
+	};
+	is?: {
+		// Shoppingcart Type: delivery, pickup
+		type?: 'delivery' | 'pickup' | 'scan_and_go' | 'frictionless';
+		// If an order should be paid with meal exchange. If true, this will calculate meals total.
+		mx_cart?: boolean;
+		// If a user's email or email domain is a match in a sites list of tax exempt emails or domains
+		email_tax_exempt?: boolean;
+		// Indicates to clients that a tax recalculation is required
+		tax_calculation_required?: boolean;
+	};
+	meta?: {
+		// Raw request from any vendor integrated with CDL
+		vendor?: Record<string, any>;
+		[index: string]: any;
+	};
 }
 
 export interface ItemResponse {
-  // can be cdl item id or stringified timestamp
-  id: string;
-  description?: Label;
-  // index based on cdl id or stringified timestamp
-  _index?: string;
-  quantity: Quantity;
-  unit?: number;
-  price?: Price;
-  // Final item price after LTO/Bundle/BOGO etc is applied on the item.
-  sale_price?: {
-    active?: boolean;
-    amount?: MonetaryValue;
-  };
-  // Subtotal of the item including all options
-  _subtotal?: {
-    amount?: MonetaryValue;
-  };
-  // Promo applied to this item
-  _promo?: {
-    amount?: MonetaryValue;
-  };
-  // discount applied to this item
-  _discount?: {
-    amount?: MonetaryValue;
-  };
-  meta?: {
-    // menu id
-    menu?: string;
-    // brand id
-    brand?: string;
-    brand_label?: Label;
-    taxes?: string[];
-    menu_tax_tags?: string[];
-    orderable?: boolean;
-    volante_id?: string;
-    [index: string]: any;
-  };
-  options?: {
-    id?: string;
-    label?: Label;
-    meta?: {
-      taxes?: string[];
-      original_label?: Label;
-    };
-    items?: {
-      // option/modifier
-      id?: string;
-      price?: Price;
-      quantity?: Quantity;
-      label?: Label;
-      // index
-      _index?: string;
-      meta?: {
-        sort_number?: number;
-        original_label?: Label;
-        taxes?: string[];
-      };
-      amount_off_exclusions?: AmountOffExclusion[];
-      is?: {
-        disabled?: boolean;
-      };
-    }[];
-    is?: {
-      disabled?: boolean;
-    };
-  }[];
-  // Details about discount like BOGO, LTO, Bundle etc.
-  item_discount?: Record<string, any>;
-  // user specified instructions for the item
-  special_instructions?: string;
-  amount_off_exclusions?: AmountOffExclusion[];
-  added_on?: string;
-  meal_value?: IntegerValue;
-  category?: Label;
-  tax_rate?: MonetaryValue;
-  label?: Label;
+	// can be cdl item id or stringified timestamp
+	id: string;
+	description?: Label;
+	// index based on cdl id or stringified timestamp
+	_index?: string;
+	quantity: Quantity;
+	unit?: number;
+	price?: Price;
+	// Final item price after LTO/Bundle/BOGO etc is applied on the item.
+	sale_price?: {
+		active?: boolean;
+		amount?: MonetaryValue;
+	};
+	// Subtotal of the item including all options
+	_subtotal?: {
+		amount?: MonetaryValue;
+	};
+	// Promo applied to this item
+	_promo?: {
+		amount?: MonetaryValue;
+	};
+	// discount applied to this item
+	_discount?: {
+		amount?: MonetaryValue;
+	};
+	meta?: {
+		// menu id
+		menu?: string;
+		// brand id
+		brand?: string;
+		brand_label?: Label;
+		taxes?: string[];
+		menu_tax_tags?: string[];
+		orderable?: boolean;
+		volante_id?: string;
+		[index: string]: any;
+	};
+	options?: {
+		id?: string;
+		label?: Label;
+		meta?: {
+			taxes?: string[];
+			original_label?: Label;
+		};
+		items?: {
+			// option/modifier
+			id?: string;
+			price?: Price;
+			quantity?: Quantity;
+			label?: Label;
+			// index
+			_index?: string;
+			meta?: {
+				sort_number?: number;
+				original_label?: Label;
+				taxes?: string[];
+			};
+			amount_off_exclusions?: AmountOffExclusion[];
+			is?: {
+				disabled?: boolean;
+			};
+		}[];
+		is?: {
+			disabled?: boolean;
+		};
+	}[];
+	// Details about discount like BOGO, LTO, Bundle etc.
+	item_discount?: Record<string, any>;
+	// user specified instructions for the item
+	special_instructions?: string;
+	amount_off_exclusions?: AmountOffExclusion[];
+	added_on?: string;
+	meal_value?: IntegerValue;
+	category?: Label;
+	tax_rate?: MonetaryValue;
+	label?: Label;
 }
 
 export type MonetaryValue = number;
@@ -215,674 +215,674 @@ export type MonetaryValue = number;
 export type PaymentType = string;
 
 export interface FPValidationData {
-  discountIncentives?: {
-    id?: string;
-    program?: {
-      code?: string;
-    };
-    [index: string]: any;
-  }[];
-  [index: string]: any;
+	discountIncentives?: {
+		id?: string;
+		program?: {
+			code?: string;
+		};
+		[index: string]: any;
+	}[];
+	[index: string]: any;
 }
 
-export type AmountOffExclusion = "discount" | "promo";
+export type AmountOffExclusion = 'discount' | 'promo';
 
 export interface Label {
-  en?: string;
-  fr?: string;
+	en?: string;
+	fr?: string;
 }
 
 export type IntegerValue = number;
 
 export interface Price {
-  amount?: MonetaryValue;
+	amount?: MonetaryValue;
 }
 
 export type Quantity = number;
 
 export interface CashlessTender {
-  id?: string;
-  total?: MonetaryValue;
-  tender?: string;
-  name?: string;
-  type?: PaymentType;
+	id?: string;
+	total?: MonetaryValue;
+	tender?: string;
+	name?: string;
+	type?: PaymentType;
 }
 
 export interface Taxes {
-  amount?: MonetaryValue;
-  rate?: MonetaryValue;
-  breakdown?: {
-    taxable_amount?: MonetaryValue;
-    tax_collectable?: MonetaryValue;
-    combined_tax_rate?: MonetaryValue;
-    gst?: MonetaryValue;
-    pst?: MonetaryValue;
-    [index: string]: any;
-  };
+	amount?: MonetaryValue;
+	rate?: MonetaryValue;
+	breakdown?: {
+		taxable_amount?: MonetaryValue;
+		tax_collectable?: MonetaryValue;
+		combined_tax_rate?: MonetaryValue;
+		gst?: MonetaryValue;
+		pst?: MonetaryValue;
+		[index: string]: any;
+	};
 }
 
 export interface LocationGroup {
-  // group
-  id?: string;
-  name?: string;
-  label?: {
-    en?: string;
-    fr?: string;
-  };
-  // Distance in meters from the group
-  distance?: number;
-  locations?: Location[];
-  address?: Address;
-  meta?: {
-    [index: string]: any;
-  };
-  style?: Record<string, any>;
-  timezone?: string;
-  [index: string]: any;
+	// group
+	id?: string;
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	// Distance in meters from the group
+	distance?: number;
+	locations?: Location[];
+	address?: Address;
+	meta?: {
+		[index: string]: any;
+	};
+	style?: Record<string, any>;
+	timezone?: string;
+	[index: string]: any;
 }
 
 export interface Location {
-  // location
-  id?: string;
-  operation_id?: number;
-  name?: string;
-  label?: {
-    en?: string;
-    fr?: string;
-  };
-  search?: string[];
-  app?: string;
-  address?: Address;
-  latitude?: number;
-  longitude?: number;
-  brands?: Brand[];
-  meta?: {
-    [index: string]: any;
-  };
-  phone?: string;
-  // group
-  location_group?: string;
-  // multigroup
-  location_multigroup?: string;
-  // sector
-  sector?: string;
-  date?: {
-    deleted?: string;
-    created?: string;
-    modified?: string;
-  };
-  market_place?: {
-    label?: {
-      en?: string;
-      fr?: string;
-    };
-    location_description?: {
-      en?: string;
-      fr?: string;
-    };
-    logo?: string;
-    is?: {
-      pickup_supported?: boolean;
-      delivery_supported?: boolean;
-    };
-    delivery_details?: {
-      show_single_timeslot?: boolean;
-      show_instructions?: boolean;
-      runner_app_enabled?: boolean;
-    };
-    delivery_destinations?: string[];
-    pickup_instruction?: {
-      en?: string;
-      fr?: string;
-    };
-    hours?: Hours[];
-    deliveryHours?: DeliveryHours[];
-    service_fee?: {
-      type?: string;
-      value?: number;
-    };
-    [index: string]: any;
-  };
-  [index: string]: any;
+	// location
+	id?: string;
+	operation_id?: number;
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	search?: string[];
+	app?: string;
+	address?: Address;
+	latitude?: number;
+	longitude?: number;
+	brands?: Brand[];
+	meta?: {
+		[index: string]: any;
+	};
+	phone?: string;
+	// group
+	location_group?: string;
+	// multigroup
+	location_multigroup?: string;
+	// sector
+	sector?: string;
+	date?: {
+		deleted?: string;
+		created?: string;
+		modified?: string;
+	};
+	market_place?: {
+		label?: {
+			en?: string;
+			fr?: string;
+		};
+		location_description?: {
+			en?: string;
+			fr?: string;
+		};
+		logo?: string;
+		is?: {
+			pickup_supported?: boolean;
+			delivery_supported?: boolean;
+		};
+		delivery_details?: {
+			show_single_timeslot?: boolean;
+			show_instructions?: boolean;
+			runner_app_enabled?: boolean;
+		};
+		delivery_destinations?: string[];
+		pickup_instruction?: {
+			en?: string;
+			fr?: string;
+		};
+		hours?: Hours[];
+		deliveryHours?: DeliveryHours[];
+		service_fee?: {
+			type?: string;
+			value?: number;
+		};
+		[index: string]: any;
+	};
+	[index: string]: any;
 }
 
 export interface Brand {
-  // brand
-  id?: string;
-  // sector
-  sector?: string;
-  name?: string;
-  label?: {
-    en?: string;
-    fr?: string;
-  };
-  timezone?: string;
-  description?: string;
-  //@deprecated
-  latitude?: number;
-  //@deprecated
-  longitude?: number;
-  address?: Address;
-  menus?: MenuHours[];
-  date?: {
-    deleted?: string;
-    created?: string;
-  };
-  hours?: Hours[];
-  deliveryHours?: DeliveryHours[];
-  style?: Record<string, any>;
-  // pos
-  pos?: string;
-  terminals?: Record<string, any>[];
-  device_mapping?: {
-    [index: string]: {
-      device_type: string;
-      site_device_id: string;
-      business_units: string[];
-    }[];
-  };
-  timeslots?: {
-    time?: string;
-    averagePrepTime?: string;
-    duration_minutes?: number;
-    customers_per_slot?: number;
-    menu_items_per_slot?: number;
-    delivery_time?: string;
-    delivery_customers_per_slot?: number;
-    delivery_menu_items_per_slot?: number;
-    delivery_prep_time?: string;
-    delivery_is_user_defined?: boolean;
-    delivery_user_defined?: {
-      start_time: string;
-      end_time: string;
-      delivery_destinations?: string[];
-    }[];
-  };
-  is?: {
-    pickup_supported?: boolean;
-    delivery_supported?: boolean;
-    plu_enabled?: boolean;
-    promo_exemptions_enabled?: boolean;
-    local_images_enabled?: boolean;
-    hidden?: boolean;
-    show_in_kiosk?: boolean;
-    show_in_pos?: boolean;
-    item_desc_edit_enabled?: boolean;
-    scan_and_go_supported?: boolean;
-    calories_edit_enabled?: boolean;
-    // admin panel toggle
-    special_instructions?: boolean;
-    dining_hall?: boolean;
-    [index: string]: any;
-  };
-  // brand
-  brand?: string;
-  // location
-  location?: string;
-  // location group
-  group?: string;
-  // payment
-  payment_provider?: string;
-  //@deprecated
-  location_description?: string;
-  // company
-  company?: string;
-  config?: {
-    private?: Record<string, any>;
-    public?: Record<string, any>;
-  };
-  tax_rate?: number;
-  meta?: {
-    scout?: {
-      user_id?: string;
-      name?: {
-        first?: string;
-        last?: string;
-      };
-    };
-    partner?: {
-      user_id?: string;
-      name?: {
-        first?: string;
-        last?: string;
-      };
-    };
-    contact?: {
-      name?: string;
-      role?: string;
-      email?: string;
-      phone?: string;
-    };
-    market_id?: string;
-    partner_type?: string;
-    business_number?: number;
-    website?: string;
-    cuisine_types?: string[];
-    status?: "await_partner" | "await_scout" | "completed";
-    active?: boolean;
-    max_showcase_items?: number;
-    jde_category?: string;
-    software_integrations?: {
-      system365?: string;
-      jwo?: string;
-    };
-    [index: string]: any;
-  };
-  descriptions?: {
-    location?: {
-      en?: string;
-      fr?: string;
-    };
-  };
-  estimated_wait_time?: {
-    delivery?: WaitTime;
-    pickup?: WaitTime;
-  };
-  state?: {
-    pickup?: MenuHours["state"];
-    delivery?: MenuHours["state"];
-  };
-  [index: string]: any;
+	// brand
+	id?: string;
+	// sector
+	sector?: string;
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	timezone?: string;
+	description?: string;
+	//@deprecated
+	latitude?: number;
+	//@deprecated
+	longitude?: number;
+	address?: Address;
+	menus?: MenuHours[];
+	date?: {
+		deleted?: string;
+		created?: string;
+	};
+	hours?: Hours[];
+	deliveryHours?: DeliveryHours[];
+	style?: Record<string, any>;
+	// pos
+	pos?: string;
+	terminals?: Record<string, any>[];
+	device_mapping?: {
+		[index: string]: {
+			device_type: string;
+			site_device_id: string;
+			business_units: string[];
+		}[];
+	};
+	timeslots?: {
+		time?: string;
+		averagePrepTime?: string;
+		duration_minutes?: number;
+		customers_per_slot?: number;
+		menu_items_per_slot?: number;
+		delivery_time?: string;
+		delivery_customers_per_slot?: number;
+		delivery_menu_items_per_slot?: number;
+		delivery_prep_time?: string;
+		delivery_is_user_defined?: boolean;
+		delivery_user_defined?: {
+			start_time: string;
+			end_time: string;
+			delivery_destinations?: string[];
+		}[];
+	};
+	is?: {
+		pickup_supported?: boolean;
+		delivery_supported?: boolean;
+		plu_enabled?: boolean;
+		promo_exemptions_enabled?: boolean;
+		local_images_enabled?: boolean;
+		hidden?: boolean;
+		show_in_kiosk?: boolean;
+		show_in_pos?: boolean;
+		item_desc_edit_enabled?: boolean;
+		scan_and_go_supported?: boolean;
+		calories_edit_enabled?: boolean;
+		// admin panel toggle
+		special_instructions?: boolean;
+		dining_hall?: boolean;
+		[index: string]: any;
+	};
+	// brand
+	brand?: string;
+	// location
+	location?: string;
+	// location group
+	group?: string;
+	// payment
+	payment_provider?: string;
+	//@deprecated
+	location_description?: string;
+	// company
+	company?: string;
+	config?: {
+		private?: Record<string, any>;
+		public?: Record<string, any>;
+	};
+	tax_rate?: number;
+	meta?: {
+		scout?: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
+			};
+		};
+		partner?: {
+			user_id?: string;
+			name?: {
+				first?: string;
+				last?: string;
+			};
+		};
+		contact?: {
+			name?: string;
+			role?: string;
+			email?: string;
+			phone?: string;
+		};
+		market_id?: string;
+		partner_type?: string;
+		business_number?: number;
+		website?: string;
+		cuisine_types?: string[];
+		status?: 'await_partner' | 'await_scout' | 'completed';
+		active?: boolean;
+		max_showcase_items?: number;
+		jde_category?: string;
+		software_integrations?: {
+			system365?: string;
+			jwo?: string;
+		};
+		[index: string]: any;
+	};
+	descriptions?: {
+		location?: {
+			en?: string;
+			fr?: string;
+		};
+	};
+	estimated_wait_time?: {
+		delivery?: WaitTime;
+		pickup?: WaitTime;
+	};
+	state?: {
+		pickup?: MenuHours['state'];
+		delivery?: MenuHours['state'];
+	};
+	[index: string]: any;
 }
 
 export interface Address {
-  // Suite number of the address, if applicable
-  suite?: string;
-  // First line of the address, should include street number
-  address?: string;
-  // City of the address
-  city?: string;
-  // State of the address, also province in Canada
-  state?: string;
-  // Country of the address
-  country?: string;
-  // Zip code or postal code of the address
-  zip?: string;
-  coordinates?: {
-    // latitude of the the address
-    latitude?: number;
-    // longitude of the the address
-    longitude?: number;
-  };
+	// Suite number of the address, if applicable
+	suite?: string;
+	// First line of the address, should include street number
+	address?: string;
+	// City of the address
+	city?: string;
+	// State of the address, also province in Canada
+	state?: string;
+	// Country of the address
+	country?: string;
+	// Zip code or postal code of the address
+	zip?: string;
+	coordinates?: {
+		// latitude of the the address
+		latitude?: number;
+		// longitude of the the address
+		longitude?: number;
+	};
 }
 
 export interface MenuHours {
-  // menu
-  id?: string;
-  label?: {
-    en?: string;
-  };
-  hours?: Hours[];
-  is_pickup?: boolean;
-  is_delivery?: boolean;
-  is_frictionless?: boolean;
-  // Identifies a brand or menu state, i.e open, closed or accepting preorders
-  state?: "open" | "closed" | "preorder";
+	// menu
+	id?: string;
+	label?: {
+		en?: string;
+	};
+	hours?: Hours[];
+	is_pickup?: boolean;
+	is_delivery?: boolean;
+	is_frictionless?: boolean;
+	// Identifies a brand or menu state, i.e open, closed or accepting preorders
+	state?: 'open' | 'closed' | 'preorder';
 }
 
 export interface Hours {
-  // hours
-  id?: string;
-  date?: {
-    deleted?: string;
-    start?: string;
-    end?: string;
-  };
-  day?: {
-    start?: number;
-    end?: number;
-  };
-  hours?: string;
+	// hours
+	id?: string;
+	date?: {
+		deleted?: string;
+		start?: string;
+		end?: string;
+	};
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
 }
 
 export interface DeliveryHours {
-  // hours
-  id?: string;
-  day?: {
-    start?: number;
-    end?: number;
-  };
-  hours?: string;
+	// hours
+	id?: string;
+	day?: {
+		start?: number;
+		end?: number;
+	};
+	hours?: string;
 }
 
 export interface WaitTime {
-  // maxium wait time to the next time slot in minutes
-  max: number;
-  // minimum wait time to the next time slot in minutes
-  min: number;
-  // the epoch timestamp of the next available ready time for a station
-  ready_time: number;
+	// maxium wait time to the next time slot in minutes
+	max: number;
+	// minimum wait time to the next time slot in minutes
+	min: number;
+	// the epoch timestamp of the next available ready time for a station
+	ready_time: number;
 }
 
 export interface Menu {
-  // menu
-  id?: string;
-  date?: {
-    created?: string;
-    modified?: string;
-    published?: string;
-  };
-  label?: {
-    en?: string;
-  };
-  groups?: Group[];
-  // menu
-  parent_id?: string;
-  // brand
-  location_brand?: string;
-  // company
-  company?: string;
-  // sector
-  sector?: string;
-  is?: {
-    disabled?: boolean;
-    hidden?: boolean;
-    linked?: boolean;
-    promo_exemptions_enabled?: boolean;
-    plu_enabled?: boolean;
-    item_images_enabled?: boolean;
-    item_showcase_enabled?: boolean;
-    item_desc_edit_enabled?: boolean;
-    calories_edit_enabled?: boolean;
-    item_label_edit_enabled?: boolean;
-    frictionless?: boolean;
-    category_images_enabled?: boolean;
-  };
-  meta?: {
-    // User ID
-    locked_by_user?: string;
-    // User ID
-    last_modified_user?: string;
-    centricos?: boolean;
-    version?: number;
-    [index: string]: any;
-  };
+	// menu
+	id?: string;
+	date?: {
+		created?: string;
+		modified?: string;
+		published?: string;
+	};
+	label?: {
+		en?: string;
+	};
+	groups?: Group[];
+	// menu
+	parent_id?: string;
+	// brand
+	location_brand?: string;
+	// company
+	company?: string;
+	// sector
+	sector?: string;
+	is?: {
+		disabled?: boolean;
+		hidden?: boolean;
+		linked?: boolean;
+		promo_exemptions_enabled?: boolean;
+		plu_enabled?: boolean;
+		item_images_enabled?: boolean;
+		item_showcase_enabled?: boolean;
+		item_desc_edit_enabled?: boolean;
+		calories_edit_enabled?: boolean;
+		item_label_edit_enabled?: boolean;
+		frictionless?: boolean;
+		category_images_enabled?: boolean;
+	};
+	meta?: {
+		// User ID
+		locked_by_user?: string;
+		// User ID
+		last_modified_user?: string;
+		centricos?: boolean;
+		version?: number;
+		[index: string]: any;
+	};
 }
 
 export interface Group {
-  // group
-  id?: string;
-  name?: string;
-  label?: {
-    en?: string;
-    fr?: string;
-  };
-  items?: {
-    // item
-    id?: string;
-    label?: {
-      en?: string;
-    };
-    name?: string;
-    description?: {
-      en?: string;
-    };
-    price?: {
-      amount?: number;
-      currency?: string;
-    };
-    // Meal exchange value of the item
-    meal_value?: number;
-    sale_price?: {
-      amount?: number;
-      currency?: string;
-    };
-    // The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
-    unit?: number;
-    ingredients?: Record<string, any>[];
-    amount_off_exclusions?: AmountOffExclusionTypes[];
-    nutrition?: {
-      //@deprecated
-      kcal?: number;
-      calories?: Nutrition;
-      serving_size?: Nutrition;
-      total_fat?: Nutrition;
-      saturated_fat?: Nutrition;
-      trans_fat?: Nutrition;
-      cholesterol?: Nutrition;
-      sodium?: Nutrition;
-      total_carbohydrate?: Nutrition;
-      dietary_fiber?: Nutrition;
-      sugars?: Nutrition;
-      protein?: Nutrition;
-      well_being?: Nutrition;
-      [index: string]: any;
-    };
-    certified?: {
-      vegan?: boolean;
-      vegetarian?: boolean;
-      seafood_watch?: boolean;
-      wellbeing?: boolean;
-      farm_to_fork?: boolean;
-      in_balance?: boolean;
-      organic?: boolean;
-      no_gluten_ingredients?: boolean;
-      halal?: boolean;
-      kosher?: boolean;
-      humane?: boolean;
-      locally_crafted?: boolean;
-      nuts?: boolean;
-      oracle_garden_grown?: boolean;
-      oracle_oyes?: boolean;
-      peanut_free?: boolean;
-      tree_nut_free?: boolean;
-      wheat_free?: boolean;
-      non_gmo?: boolean;
-      milk_free?: boolean;
-      egg_free?: boolean;
-      soy_free?: boolean;
-      fair_trade?: boolean;
-      rainforest_alliance?: boolean;
-      salt_free?: boolean;
-    };
-    options?: {
-      // modifier_group
-      id?: string;
-      label?: {
-        en?: string;
-      };
-      unique_name?: string;
-      name?: string;
-      items?: {
-        // option
-        id?: string;
-        label?: {
-          en?: string;
-        };
-        name?: string;
-        description?: {
-          en?: string;
-        };
-        price?: {
-          amount?: number;
-          currency?: string;
-        };
-        reporting?: {
-          category?: {
-            primary?: string;
-            secondary?: string;
-          };
-        };
-        weight?: {
-          unit?: string;
-          amount?: number;
-        };
-        image?: {
-          src?: string;
-          sizes?: {
-            original?: string;
-            thumbnail_80_80?: string;
-          };
-        };
-        sku?: number;
-        nutrition?: {
-          //@deprecated
-          kcal?: number;
-          calories?: Nutrition;
-        };
-        certified?: {
-          vegan?: boolean;
-        };
-        modifier_sets?: {
-          category?: string;
-          list?: string[];
-        }[];
-        meta?: {
-          // chit sort order
-          sort_number?: number;
-          // menu sort order
-          menu_sort_number?: number;
-          plu?: string;
-          sizing?: {
-            name?: string;
-            posid?: string;
-            price?: number;
-          }[];
-          tax?: {
-            tax_tag_code?: string;
-          };
-          [index: string]: any;
-        };
-        is?: {
-          disabled?: boolean;
-          hidden?: boolean;
-          out_of_stock?: boolean;
-        };
-        amount_off_exclusions?: AmountOffExclusionTypes[];
-      }[];
-      min?: number;
-      max?: number;
-      is?: {
-        disabled?: boolean;
-        hidden?: boolean;
-        out_of_stock?: boolean;
-        incremental?: boolean;
-      };
-      meta?: {
-        // chit sort order
-        sort_number?: number;
-        // menu sort order
-        menu_sort_number?: number;
-        [index: string]: any;
-      };
-      limit?: number;
-      [index: string]: any;
-    }[];
-    required?: boolean;
-    special?: boolean;
-    meta?: {
-      superplate?: {
-        type_id?: number;
-        type?: string;
-      };
-      featured?: {
-        sort_number?: number;
-        dates?: {
-          start?: string;
-          end?: string;
-        };
-      };
-      // chit sort order
-      sort_number?: number;
-      // menu sort order
-      menu_sort_number?: number;
-      // barcodes of the item
-      barcodes?: string[];
-      tax?: {
-        tax_tag_code?: string;
-      };
-    };
-    category?: {
-      en?: string;
-    };
-    location?: string;
-    sku?: number;
-    item_number?: number;
-    image?: {
-      src?: string;
-      sizes?: {
-        original?: string;
-        thumbnail_80_80?: string;
-      };
-    };
-    weight?: {
-      unit?: string;
-      amount?: number;
-    };
-    line_route?: string;
-    reporting?: {
-      category?: {
-        primary?: string;
-        secondary?: string;
-      };
-    };
-    //@deprecated
-    is_deleted?: boolean;
-    is?: {
-      disabled?: boolean;
-      hidden?: boolean;
-      meq_eligible?: boolean;
-      out_of_stock?: boolean;
-      deleted?: boolean;
-      featured?: boolean;
-    };
-  }[];
-  //@deprecated
-  is_disabled?: boolean;
-  is?: {
-    disabled?: boolean;
-    hidden?: boolean;
-    item_images_enabled?: boolean;
-  };
-  meta?: {
-    // chit sort order
-    sort_number?: number;
-    // menu sort order
-    menu_sort_number?: number;
-    [index: string]: any;
-  };
-  image?: {
-    src?: string;
-    sizes?: {
-      original?: string;
-      thumbnail_80_80?: string;
-    };
-  };
+	// group
+	id?: string;
+	name?: string;
+	label?: {
+		en?: string;
+		fr?: string;
+	};
+	items?: {
+		// item
+		id?: string;
+		label?: {
+			en?: string;
+		};
+		name?: string;
+		description?: {
+			en?: string;
+		};
+		price?: {
+			amount?: number;
+			currency?: string;
+		};
+		// Meal exchange value of the item
+		meal_value?: number;
+		sale_price?: {
+			amount?: number;
+			currency?: string;
+		};
+		// The number of units that belong to this item. For example, a dozen doughnuts should have a unit value of 12
+		unit?: number;
+		ingredients?: Record<string, any>[];
+		amount_off_exclusions?: AmountOffExclusionTypes[];
+		nutrition?: {
+			//@deprecated
+			kcal?: number;
+			calories?: Nutrition;
+			serving_size?: Nutrition;
+			total_fat?: Nutrition;
+			saturated_fat?: Nutrition;
+			trans_fat?: Nutrition;
+			cholesterol?: Nutrition;
+			sodium?: Nutrition;
+			total_carbohydrate?: Nutrition;
+			dietary_fiber?: Nutrition;
+			sugars?: Nutrition;
+			protein?: Nutrition;
+			well_being?: Nutrition;
+			[index: string]: any;
+		};
+		certified?: {
+			vegan?: boolean;
+			vegetarian?: boolean;
+			seafood_watch?: boolean;
+			wellbeing?: boolean;
+			farm_to_fork?: boolean;
+			in_balance?: boolean;
+			organic?: boolean;
+			no_gluten_ingredients?: boolean;
+			halal?: boolean;
+			kosher?: boolean;
+			humane?: boolean;
+			locally_crafted?: boolean;
+			nuts?: boolean;
+			oracle_garden_grown?: boolean;
+			oracle_oyes?: boolean;
+			peanut_free?: boolean;
+			tree_nut_free?: boolean;
+			wheat_free?: boolean;
+			non_gmo?: boolean;
+			milk_free?: boolean;
+			egg_free?: boolean;
+			soy_free?: boolean;
+			fair_trade?: boolean;
+			rainforest_alliance?: boolean;
+			salt_free?: boolean;
+		};
+		options?: {
+			// modifier_group
+			id?: string;
+			label?: {
+				en?: string;
+			};
+			unique_name?: string;
+			name?: string;
+			items?: {
+				// option
+				id?: string;
+				label?: {
+					en?: string;
+				};
+				name?: string;
+				description?: {
+					en?: string;
+				};
+				price?: {
+					amount?: number;
+					currency?: string;
+				};
+				reporting?: {
+					category?: {
+						primary?: string;
+						secondary?: string;
+					};
+				};
+				weight?: {
+					unit?: string;
+					amount?: number;
+				};
+				image?: {
+					src?: string;
+					sizes?: {
+						original?: string;
+						thumbnail_80_80?: string;
+					};
+				};
+				sku?: number;
+				nutrition?: {
+					//@deprecated
+					kcal?: number;
+					calories?: Nutrition;
+				};
+				certified?: {
+					vegan?: boolean;
+				};
+				modifier_sets?: {
+					category?: string;
+					list?: string[];
+				}[];
+				meta?: {
+					// chit sort order
+					sort_number?: number;
+					// menu sort order
+					menu_sort_number?: number;
+					plu?: string;
+					sizing?: {
+						name?: string;
+						posid?: string;
+						price?: number;
+					}[];
+					tax?: {
+						tax_tag_code?: string;
+					};
+					[index: string]: any;
+				};
+				is?: {
+					disabled?: boolean;
+					hidden?: boolean;
+					out_of_stock?: boolean;
+				};
+				amount_off_exclusions?: AmountOffExclusionTypes[];
+			}[];
+			min?: number;
+			max?: number;
+			is?: {
+				disabled?: boolean;
+				hidden?: boolean;
+				out_of_stock?: boolean;
+				incremental?: boolean;
+			};
+			meta?: {
+				// chit sort order
+				sort_number?: number;
+				// menu sort order
+				menu_sort_number?: number;
+				[index: string]: any;
+			};
+			limit?: number;
+			[index: string]: any;
+		}[];
+		required?: boolean;
+		special?: boolean;
+		meta?: {
+			superplate?: {
+				type_id?: number;
+				type?: string;
+			};
+			featured?: {
+				sort_number?: number;
+				dates?: {
+					start?: string;
+					end?: string;
+				};
+			};
+			// chit sort order
+			sort_number?: number;
+			// menu sort order
+			menu_sort_number?: number;
+			// barcodes of the item
+			barcodes?: string[];
+			tax?: {
+				tax_tag_code?: string;
+			};
+		};
+		category?: {
+			en?: string;
+		};
+		location?: string;
+		sku?: number;
+		item_number?: number;
+		image?: {
+			src?: string;
+			sizes?: {
+				original?: string;
+				thumbnail_80_80?: string;
+			};
+		};
+		weight?: {
+			unit?: string;
+			amount?: number;
+		};
+		line_route?: string;
+		reporting?: {
+			category?: {
+				primary?: string;
+				secondary?: string;
+			};
+		};
+		//@deprecated
+		is_deleted?: boolean;
+		is?: {
+			disabled?: boolean;
+			hidden?: boolean;
+			meq_eligible?: boolean;
+			out_of_stock?: boolean;
+			deleted?: boolean;
+			featured?: boolean;
+		};
+	}[];
+	//@deprecated
+	is_disabled?: boolean;
+	is?: {
+		disabled?: boolean;
+		hidden?: boolean;
+		item_images_enabled?: boolean;
+	};
+	meta?: {
+		// chit sort order
+		sort_number?: number;
+		// menu sort order
+		menu_sort_number?: number;
+		[index: string]: any;
+	};
+	image?: {
+		src?: string;
+		sizes?: {
+			original?: string;
+			thumbnail_80_80?: string;
+		};
+	};
 }
 
 export interface Nutrition {
-  amount?: number;
-  unit?: string;
+	amount?: number;
+	unit?: string;
 }
 
-export type AmountOffExclusionTypes = "loyalty" | "discount" | "promo";
+export type AmountOffExclusionTypes = 'loyalty' | 'discount' | 'promo';
 
 export interface CognitionStore {
-  // UUID for external store
-  uuid?: string;
-  // Store name
-  name?: string;
-  // Full address
-  address?: string;
-  city?: string;
-  state?: string;
-  // Abbreviated address
-  street_address?: string;
-  // ISO code for currency
-  currency_code?: string;
-  latitude?: number;
-  longitude?: number;
+	// UUID for external store
+	uuid?: string;
+	// Store name
+	name?: string;
+	// Full address
+	address?: string;
+	city?: string;
+	state?: string;
+	// Abbreviated address
+	street_address?: string;
+	// ISO code for currency
+	currency_code?: string;
+	latitude?: number;
+	longitude?: number;
 }
 
 export interface Success {
-  success?: boolean;
+	success?: boolean;
 }
 
 // POST /partner/event/{id} - Send an event from 3rd party to our system
 
 export interface PostPartnerEventPath {
-  // provider
-  id: string;
+	// provider
+	id: string;
 }
 
 export type PostPartnerEventBody = Record<string, any>;
@@ -890,46 +890,46 @@ export type PostPartnerEventBody = Record<string, any>;
 export type PostPartnerEventResponse = Success;
 
 export interface PostPartnerEventRequest extends BaseRequest, PostPartnerEventPath {
-  body: PostPartnerEventBody;
+	body: PostPartnerEventBody;
 }
 
 // GET /partner/swagger.json
 
 export interface GetPartnerSwaggerQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export interface GetPartnerSwaggerResponse {
-  [index: string]: any;
+	[index: string]: any;
 }
 
 export interface GetPartnerSwaggerRequest
-  extends BaseRequest,
-    RequestQuery<GetPartnerSwaggerQuery> {}
+	extends BaseRequest,
+		RequestQuery<GetPartnerSwaggerQuery> {}
 
 // POST /partner/{id}/menu - Create a Partner menu from files(only xls for now)
 
 export interface PostPartnerMenuPath {
-  // partner
-  id: string;
+	// partner
+	id: string;
 }
 
 export interface PostPartnerMenuBody {
-  // Link for S3 menu file(file is uploaded to S3 before it gets processed)
-  s3_link: string;
-  // CDL Id of a location group units of which being updated
-  location_group: string;
-  // Should make items visible in local menu by default
-  default_items_visible?: boolean;
+	// Link for S3 menu file(file is uploaded to S3 before it gets processed)
+	s3_link: string;
+	// CDL Id of a location group units of which being updated
+	location_group: string;
+	// Should make items visible in local menu by default
+	default_items_visible?: boolean;
 }
 
 export interface PostPartnerMenuResponse {
-  menus?: {
-    id: string;
-  }[];
+	menus?: {
+		id: string;
+	}[];
 }
 
 export interface PostPartnerMenuRequest extends BaseRequest, PostPartnerMenuPath {
-  body: PostPartnerMenuBody;
+	body: PostPartnerMenuBody;
 }