@compassdigital/sdk.typescript 4.67.0 → 4.68.0

package/src/interface/search.ts

@@ -1,153 +1,153 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface MetaResultsDto {
-  limit: number;
-  page: number;
-  sortBy?: Record<string, any>;
-  sortOrder?: Record<string, any>;
-  totalResults: number;
-  totalPages: number;
-  resultsCount: number;
+	limit: number;
+	page: number;
+	sortBy?: Record<string, any>;
+	sortOrder?: Record<string, any>;
+	totalResults: number;
+	totalPages: number;
+	resultsCount: number;
 }
 
 export interface GetShoppingcartDto {
-  id: string;
-  source_id: string;
-  menu: string;
-  location: string;
-  meta: {
-    [index: string]: any;
-  };
-  sub_total: Record<string, any>;
-  payment_method: Record<string, any>;
-  loyalty: Record<string, any>;
-  total: Record<string, any>;
-  exemptions: Record<string, any>;
-  brand: string;
-  is: Record<string, any>;
-  source_order_id: string;
-  items: Record<string, any>;
-  discount: Record<string, any>;
-  delivery_fee: Record<string, any>;
-  source_date_created: string;
-  source_date_modified: string;
-  promo: Record<string, any>;
-  taxes: Record<string, any>;
-  service_fee: Record<string, any>;
+	id: string;
+	source_id: string;
+	menu: string;
+	location: string;
+	meta: {
+		[index: string]: any;
+	};
+	sub_total: Record<string, any>;
+	payment_method: Record<string, any>;
+	loyalty: Record<string, any>;
+	total: Record<string, any>;
+	exemptions: Record<string, any>;
+	brand: string;
+	is: Record<string, any>;
+	source_order_id: string;
+	items: Record<string, any>;
+	discount: Record<string, any>;
+	delivery_fee: Record<string, any>;
+	source_date_created: string;
+	source_date_modified: string;
+	promo: Record<string, any>;
+	taxes: Record<string, any>;
+	service_fee: Record<string, any>;
 }
 
 export interface OrderGroupDetails {
-  source_id?: string;
-  name?: string;
+	source_id?: string;
+	name?: string;
 }
 
 export interface OrderBrandDetails {
-  source_id?: string;
-  name?: string;
+	source_id?: string;
+	name?: string;
 }
 
 export interface GetOrderDto {
-  source_id: string;
-  requested_date: string;
-  pickup_id: string;
-  pickup: string;
-  is: Record<string, any>;
-  mealplan: Record<string, any>;
-  shoppingcart: GetShoppingcartDto;
-  date: Record<string, any>;
-  pickup_name: string;
-  details: Record<string, any>;
-  payment: Record<string, any>;
-  meal_swipes: Record<string, any>;
-  meal_exchange: Record<string, any>;
-  issue: Record<string, any>;
-  source_group: OrderGroupDetails;
-  source_brand: OrderBrandDetails;
-  date_created: string;
-  refund_status: string;
-  payment_type: string;
-  payment_category: string;
-  market_place_stations: OrderBrandDetails[];
-  // Order original cart amount before refunds
-  total: string;
-  // Customer email
-  email: string;
-  // Order type: pickup/delivery/etc
-  order_type: string;
-  // Order status: accepted/in_progress/ready/etc
-  status: string;
+	source_id: string;
+	requested_date: string;
+	pickup_id: string;
+	pickup: string;
+	is: Record<string, any>;
+	mealplan: Record<string, any>;
+	shoppingcart: GetShoppingcartDto;
+	date: Record<string, any>;
+	pickup_name: string;
+	details: Record<string, any>;
+	payment: Record<string, any>;
+	meal_swipes: Record<string, any>;
+	meal_exchange: Record<string, any>;
+	issue: Record<string, any>;
+	source_group: OrderGroupDetails;
+	source_brand: OrderBrandDetails;
+	date_created: string;
+	refund_status: string;
+	payment_type: string;
+	payment_category: string;
+	market_place_stations: OrderBrandDetails[];
+	// Order original cart amount before refunds
+	total: string;
+	// Customer email
+	email: string;
+	// Order type: pickup/delivery/etc
+	order_type: string;
+	// Order status: accepted/in_progress/ready/etc
+	status: string;
 }
 
 export interface GetOrderPaginatedResult {
-  meta: MetaResultsDto;
-  results: GetOrderDto[];
+	meta: MetaResultsDto;
+	results: GetOrderDto[];
 }
 
 export interface GetLocationDto {
-  source_id: string;
-  source_type: string;
-  name: string;
+	source_id: string;
+	source_type: string;
+	name: string;
 }
 
 export interface GetLocationPaginatedResult {
-  meta: MetaResultsDto;
-  results: GetLocationDto[];
+	meta: MetaResultsDto;
+	results: GetLocationDto[];
 }
 
 // GET /search/order
 
 export interface GetSearchOrderQuery {
-  // Items to return in response
-  limit?: number;
-  // Pagination param
-  page?: number;
-  // Return items sorted by this column
-  sortBy?:
-    | "date_created"
-    | "destination"
-    | "id"
-    | "pickup"
-    | "pickup_id"
-    | "pickup_name"
-    | "source_id"
-    | "sub_total"
-    | "total"
-    | "site_name"
-    | "status"
-    | "order_type"
-    | "fulfillment_date";
-  sortOrder?: "ASC" | "DESC";
-  // Filter orders by site id
-  source_group_id?: string;
-  // Filter orders by station id
-  source_brand_id?: string;
-  // Filter orders with created date not earlier than
-  date_created_start?: string;
-  // Filter orders with created date not later than this date
-  date_created_end?: string;
-  // Filter orders having specific order number
-  pickup_id?: string;
-  // Filter orders by user pickup name
-  pickup_name?: string;
-  // Search order by order ID
-  source_id?: string;
-  // Search order by refund_status
-  refund_status?: ("" | "partial" | "full")[];
-  // Filter orders by payment type
-  payment_type?: string;
-  // Filter orders by payment category
-  payment_category?: ("digital wallet" | "badge pay" | "credit card" | "mealplan")[];
-  // Filter orders by customer email
-  email?: string;
-  // Filter orders by order type
-  order_type?: ("frictionless" | "delivery" | "pickup" | "scan_and_go")[];
-  // Filter orders by order status/progress
-  status?: ("ready" | "accepted" | "delivered" | "in_progress" | "out_for_delivery" | "created")[];
-  // Graphql query string
-  _query?: string;
+	// Items to return in response
+	limit?: number;
+	// Pagination param
+	page?: number;
+	// Return items sorted by this column
+	sortBy?:
+		| 'date_created'
+		| 'destination'
+		| 'id'
+		| 'pickup'
+		| 'pickup_id'
+		| 'pickup_name'
+		| 'source_id'
+		| 'sub_total'
+		| 'total'
+		| 'site_name'
+		| 'status'
+		| 'order_type'
+		| 'fulfillment_date';
+	sortOrder?: 'ASC' | 'DESC';
+	// Filter orders by site id
+	source_group_id?: string;
+	// Filter orders by station id
+	source_brand_id?: string;
+	// Filter orders with created date not earlier than
+	date_created_start?: string;
+	// Filter orders with created date not later than this date
+	date_created_end?: string;
+	// Filter orders having specific order number
+	pickup_id?: string;
+	// Filter orders by user pickup name
+	pickup_name?: string;
+	// Search order by order ID
+	source_id?: string;
+	// Search order by refund_status
+	refund_status?: ('' | 'partial' | 'full')[];
+	// Filter orders by payment type
+	payment_type?: string;
+	// Filter orders by payment category
+	payment_category?: ('digital wallet' | 'badge pay' | 'credit card' | 'mealplan')[];
+	// Filter orders by customer email
+	email?: string;
+	// Filter orders by order type
+	order_type?: ('frictionless' | 'delivery' | 'pickup' | 'scan_and_go')[];
+	// Filter orders by order status/progress
+	status?: ('ready' | 'accepted' | 'delivered' | 'in_progress' | 'out_for_delivery' | 'created')[];
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetSearchOrderResponse = GetOrderPaginatedResult;
@@ -157,24 +157,24 @@ export interface GetSearchOrderRequest extends BaseRequest, RequestQuery<GetSear
 // GET /search/location
 
 export interface GetSearchLocationQuery {
-  // Items to return in response
-  limit?: number;
-  // Pagination param
-  page?: number;
-  // Filter entities with names containing this value
-  name?: string;
-  // Filter entities with specific type
-  source_type?: "brand" | "location" | "group" | "multigroup" | "sector" | "company";
-  // Filter entities with specific group id as a parent
-  source_group_parent?: string;
-  // Filter entities with specific multigroup id as a parent
-  source_multigroup_parent?: string;
-  // Graphql query string
-  _query?: string;
+	// Items to return in response
+	limit?: number;
+	// Pagination param
+	page?: number;
+	// Filter entities with names containing this value
+	name?: string;
+	// Filter entities with specific type
+	source_type?: 'brand' | 'location' | 'group' | 'multigroup' | 'sector' | 'company';
+	// Filter entities with specific group id as a parent
+	source_group_parent?: string;
+	// Filter entities with specific multigroup id as a parent
+	source_multigroup_parent?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetSearchLocationResponse = GetLocationPaginatedResult;
 
 export interface GetSearchLocationRequest
-  extends BaseRequest,
-    RequestQuery<GetSearchLocationQuery> {}
+	extends BaseRequest,
+		RequestQuery<GetSearchLocationQuery> {}