@compassdigital/sdk.typescript 4.66.0 → 4.68.0

package/src/interface/task.ts

@@ -1,164 +1,164 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface TaskLocation {
-  // Location ID
-  location_id: string;
-  // Location latitude
-  latitude: number;
-  // Location Longitude
-  longitude: number;
-  // Location Address
-  address: string;
-  // Pickup or Dropoff time
-  action_time: string;
-  // optional details
-  details?: Record<string, any>;
-  [index: string]: any;
+	// Location ID
+	location_id: string;
+	// Location latitude
+	latitude: number;
+	// Location Longitude
+	longitude: number;
+	// Location Address
+	address: string;
+	// Pickup or Dropoff time
+	action_time: string;
+	// optional details
+	details?: Record<string, any>;
+	[index: string]: any;
 }
 
 export interface Error {
-  code?: number;
-  message?: string;
-  data?: Record<string, any>;
+	code?: number;
+	message?: string;
+	data?: Record<string, any>;
 }
 
 export interface Task {
-  // task
-  id?: string;
-  // order id
-  order_id?: string;
-  // shoppingcart id
-  shoppingcart_id?: string;
-  // customer id
-  customer_id?: string;
-  // location id for this task
-  location_id?: string;
-  // type of location id
-  location_type?: "brand" | "group";
-  order?: TaskOrder;
-  pickup_details?: TaskLocation;
-  dropoff_details?: TaskLocation;
-  status?: TaskStatus;
-  // Any related metadata information about this Task
-  meta?: {
-    [index: string]: any;
-  };
-  // Date when Task was created
-  created?: string;
-  // Date when Task expires
-  expires?: string;
-  // Date when task was last modified
-  modified?: string;
-  // Date when Task is scheduled to start
-  scheduled_start?: string;
-  // Date when task is out for delivery
-  started?: string;
-  // Date when task was delivered
-  completed?: string;
-  // runnerid
-  assignee?: string;
-  // Task Type
-  type?: "bolter" | "kds";
+	// task
+	id?: string;
+	// order id
+	order_id?: string;
+	// shoppingcart id
+	shoppingcart_id?: string;
+	// customer id
+	customer_id?: string;
+	// location id for this task
+	location_id?: string;
+	// type of location id
+	location_type?: 'brand' | 'group';
+	order?: TaskOrder;
+	pickup_details?: TaskLocation;
+	dropoff_details?: TaskLocation;
+	status?: TaskStatus;
+	// Any related metadata information about this Task
+	meta?: {
+		[index: string]: any;
+	};
+	// Date when Task was created
+	created?: string;
+	// Date when Task expires
+	expires?: string;
+	// Date when task was last modified
+	modified?: string;
+	// Date when Task is scheduled to start
+	scheduled_start?: string;
+	// Date when task is out for delivery
+	started?: string;
+	// Date when task was delivered
+	completed?: string;
+	// runnerid
+	assignee?: string;
+	// Task Type
+	type?: 'bolter' | 'kds';
 }
 
 export interface Tasks {
-  tasks?: Task[];
+	tasks?: Task[];
 }
 
 export interface TaskCreate {
-  // order id
-  order_id: string;
-  // shoppingcart id
-  shoppingcart_id: string;
-  // customer id
-  customer_id: string;
-  // location id for this task
-  location_id: string;
-  // type of location id
-  location_type: "brand" | "group";
-  order: TaskOrder;
-  pickup_details: TaskLocation;
-  dropoff_details: TaskLocation;
-  status: TaskStatus;
-  // Any related metadata information about this Task
-  meta?: {
-    [index: string]: any;
-  };
-  // Task Type
-  type: "bolter" | "kds";
+	// order id
+	order_id: string;
+	// shoppingcart id
+	shoppingcart_id: string;
+	// customer id
+	customer_id: string;
+	// location id for this task
+	location_id: string;
+	// type of location id
+	location_type: 'brand' | 'group';
+	order: TaskOrder;
+	pickup_details: TaskLocation;
+	dropoff_details: TaskLocation;
+	status: TaskStatus;
+	// Any related metadata information about this Task
+	meta?: {
+		[index: string]: any;
+	};
+	// Task Type
+	type: 'bolter' | 'kds';
 }
 
 export interface TaskUpdate {
-  order_id?: string;
-  shoppingcart_id?: string;
-  // customer id
-  customer_id?: string;
-  // location id for this task
-  location_id?: string;
-  unit_id?: string;
-  // type of location id
-  location_type?: "brand" | "group";
-  order?: TaskOrder;
-  pickup_details?: TaskLocation;
-  dropoff_details?: TaskLocation;
-  status?: TaskStatus;
-  assignee?: string;
-  // Any related metadata information about this Task
-  meta?: {
-    [index: string]: any;
-  };
+	order_id?: string;
+	shoppingcart_id?: string;
+	// customer id
+	customer_id?: string;
+	// location id for this task
+	location_id?: string;
+	unit_id?: string;
+	// type of location id
+	location_type?: 'brand' | 'group';
+	order?: TaskOrder;
+	pickup_details?: TaskLocation;
+	dropoff_details?: TaskLocation;
+	status?: TaskStatus;
+	assignee?: string;
+	// Any related metadata information about this Task
+	meta?: {
+		[index: string]: any;
+	};
 }
 
 export interface OrderUpdate {
-  // This is the new status of the order that you are trying to update
-  order_status: "ready";
+	// This is the new status of the order that you are trying to update
+	order_status: 'ready';
 }
 
 export interface ActionResponse {
-  success?: boolean;
+	success?: boolean;
 }
 
 export interface TaskOrder {
-  order_id?: string;
-  customer_id?: string;
-  customer?: Record<string, any>;
-  order_details?: Record<string, any>;
-  delivery_instructions?: string;
-  issue?: OrderIssue;
-  past_issues?: OrderIssue[];
-  [index: string]: any;
+	order_id?: string;
+	customer_id?: string;
+	customer?: Record<string, any>;
+	order_details?: Record<string, any>;
+	delivery_instructions?: string;
+	issue?: OrderIssue;
+	past_issues?: OrderIssue[];
+	[index: string]: any;
 }
 
 export interface OrderIssue {
-  // issue
-  id?: string;
-  type?: string;
-  //@deprecated
-  item?: {
-    [index: string]: any;
-  };
-  // Array of Items with issues
-  items?: Record<string, any>[];
-  // Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues
-  reason?: string;
-  meta?: {
-    created_at?: string;
-    [index: string]: any;
-  };
-  [index: string]: any;
+	// issue
+	id?: string;
+	type?: string;
+	//@deprecated
+	item?: {
+		[index: string]: any;
+	};
+	// Array of Items with issues
+	items?: Record<string, any>[];
+	// Optional additional explanation for issue: 5,10,15 for late issues, SOLD_OUT, MODIFICATION, DIETARY_RESTRICTION for see kitchen issues
+	reason?: string;
+	meta?: {
+		created_at?: string;
+		[index: string]: any;
+	};
+	[index: string]: any;
 }
 
 export type TaskStatus =
-  | "new"
-  | "in_progress"
-  | "ready"
-  | "out_for_delivery"
-  | "delivered"
-  | "order_is_ready"
-  | "accepted";
+	| 'new'
+	| 'in_progress'
+	| 'ready'
+	| 'out_for_delivery'
+	| 'delivered'
+	| 'order_is_ready'
+	| 'accepted';
 
 // POST /task - Create new Task
 
@@ -167,19 +167,19 @@ export type PostTaskBody = TaskCreate;
 export type PostTaskResponse = Task;
 
 export interface PostTaskRequest extends BaseRequest {
-  body: PostTaskBody;
+	body: PostTaskBody;
 }
 
 // GET /task/{id} - Get task based on passed ID
 
 export interface GetTaskPath {
-  // Task ID
-  id: string;
+	// Task ID
+	id: string;
 }
 
 export interface GetTaskQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetTaskResponse = Task;
@@ -189,8 +189,8 @@ export interface GetTaskRequest extends BaseRequest, RequestQuery<GetTaskQuery>,
 // PATCH /task/{id} - Update Task
 
 export interface PatchTaskPath {
-  // Task ID
-  id: string;
+	// Task ID
+	id: string;
 }
 
 export type PatchTaskBody = TaskUpdate;
@@ -198,14 +198,14 @@ export type PatchTaskBody = TaskUpdate;
 export type PatchTaskResponse = Task;
 
 export interface PatchTaskRequest extends BaseRequest, PatchTaskPath {
-  body: PatchTaskBody;
+	body: PatchTaskBody;
 }
 
 // DELETE /task/{id} - Delete Task
 
 export interface DeleteTaskPath {
-  // Task ID
-  id: string;
+	// Task ID
+	id: string;
 }
 
 export type DeleteTaskResponse = ActionResponse;
@@ -215,46 +215,46 @@ export interface DeleteTaskRequest extends BaseRequest, DeleteTaskPath {}
 // GET /task/order/{id} - Get task based on passed order ID
 
 export interface GetTaskOrderPath {
-  // Order ID
-  id: string;
+	// Order ID
+	id: string;
 }
 
 export interface GetTaskOrderQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetTaskOrderResponse = Task;
 
 export interface GetTaskOrderRequest
-  extends BaseRequest,
-    RequestQuery<GetTaskOrderQuery>,
-    GetTaskOrderPath {}
+	extends BaseRequest,
+		RequestQuery<GetTaskOrderQuery>,
+		GetTaskOrderPath {}
 
 // GET /task/order/{id}/kds - Get KDS tasks based on passed order ID
 
 export interface GetTaskOrderKdsPath {
-  // Order ID
-  id: string;
+	// Order ID
+	id: string;
 }
 
 export interface GetTaskOrderKdsQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetTaskOrderKdsResponse = Tasks;
 
 export interface GetTaskOrderKdsRequest
-  extends BaseRequest,
-    RequestQuery<GetTaskOrderKdsQuery>,
-    GetTaskOrderKdsPath {}
+	extends BaseRequest,
+		RequestQuery<GetTaskOrderKdsQuery>,
+		GetTaskOrderKdsPath {}
 
 // PATCH /task/order/{id}/kds - Update an order and its associated tasks
 
 export interface PatchTaskOrderKdsPath {
-  // Order ID
-  id: string;
+	// Order ID
+	id: string;
 }
 
 export type PatchTaskOrderKdsBody = OrderUpdate;
@@ -262,100 +262,100 @@ export type PatchTaskOrderKdsBody = OrderUpdate;
 export type PatchTaskOrderKdsResponse = Tasks;
 
 export interface PatchTaskOrderKdsRequest extends BaseRequest, PatchTaskOrderKdsPath {
-  body: PatchTaskOrderKdsBody;
+	body: PatchTaskOrderKdsBody;
 }
 
 // GET /task/assignee/{id} - Get Assignee tasks
 
 export interface GetTaskAssigneePath {
-  // Assignee ID
-  id: string;
+	// Assignee ID
+	id: string;
 }
 
 export interface GetTaskAssigneeQuery {
-  // Task Status
-  status?: string;
-  // Task Location ID
-  location_id?: string;
-  // Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
-  created?: number;
-  // Filter tasks by their started date. Only return tasks that have a date greater than or equal to the date.
-  started?: number;
-  // Filter tasks by their completed date. Only return tasks that have a completed date less than or equal to the date.
-  completed?: number;
-  // Graphql query string
-  _query?: string;
+	// Task Status
+	status?: string;
+	// Task Location ID
+	location_id?: string;
+	// Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
+	created?: number;
+	// Filter tasks by their started date. Only return tasks that have a date greater than or equal to the date.
+	started?: number;
+	// Filter tasks by their completed date. Only return tasks that have a completed date less than or equal to the date.
+	completed?: number;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetTaskAssigneeResponse = Tasks;
 
 export interface GetTaskAssigneeRequest
-  extends BaseRequest,
-    RequestQuery<GetTaskAssigneeQuery>,
-    GetTaskAssigneePath {}
+	extends BaseRequest,
+		RequestQuery<GetTaskAssigneeQuery>,
+		GetTaskAssigneePath {}
 
 // GET /task/location/brand/{id} - Get location brand tasks
 
 export interface GetTaskLocationBrandPath {
-  // location brand ID
-  id: string;
+	// location brand ID
+	id: string;
 }
 
 export interface GetTaskLocationBrandQuery {
-  // Task Status
-  status?: string;
-  // Task Location ID
-  location_id?: string;
-  // Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
-  created?: number;
-  // Filter tasks by their started date. Only return tasks that have a date greater than or equal to the date.
-  started?: number;
-  // Filter tasks by their completed date. Only return tasks that have a completed date less than or equal to the date.
-  completed?: number;
-  // Filter tasks by the action_time in pickup_details. Only return tasks that have a pickup_time date greater than or equal to the date.
-  pickup_time?: number;
-  // The type of task that will be searched on. The default is: 'bolter'
-  query_type?: string;
-  // Graphql query string
-  _query?: string;
+	// Task Status
+	status?: string;
+	// Task Location ID
+	location_id?: string;
+	// Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
+	created?: number;
+	// Filter tasks by their started date. Only return tasks that have a date greater than or equal to the date.
+	started?: number;
+	// Filter tasks by their completed date. Only return tasks that have a completed date less than or equal to the date.
+	completed?: number;
+	// Filter tasks by the action_time in pickup_details. Only return tasks that have a pickup_time date greater than or equal to the date.
+	pickup_time?: number;
+	// The type of task that will be searched on. The default is: 'bolter'
+	query_type?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetTaskLocationBrandResponse = Tasks;
 
 export interface GetTaskLocationBrandRequest
-  extends BaseRequest,
-    RequestQuery<GetTaskLocationBrandQuery>,
-    GetTaskLocationBrandPath {}
+	extends BaseRequest,
+		RequestQuery<GetTaskLocationBrandQuery>,
+		GetTaskLocationBrandPath {}
 
 // GET /task/location/group/{id} - Get location group tasks
 
 export interface GetTaskLocationGroupPath {
-  // Location group ID
-  id: string;
+	// Location group ID
+	id: string;
 }
 
 export interface GetTaskLocationGroupQuery {
-  // Task Status
-  status?: string;
-  // Task Location ID
-  location_id?: string;
-  // Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
-  created?: number;
-  // Filter tasks by their started date. Only return tasks that have a date greater than or equal to the date.
-  started?: number;
-  // Filter tasks by their completed date. Only return tasks that have a completed date less than or equal to the date.
-  completed?: number;
-  // Filter tasks by the action_time in pickup_details. Only return tasks that have a pickup_time date greater than or equal to the date.
-  pickup_time?: number;
-  // The type of task that will be searched on. The default is: 'bolter'
-  query_type?: string;
-  // Graphql query string
-  _query?: string;
+	// Task Status
+	status?: string;
+	// Task Location ID
+	location_id?: string;
+	// Filter tasks by their created date. Only return tasks that have a date greater than or equal to the date.
+	created?: number;
+	// Filter tasks by their started date. Only return tasks that have a date greater than or equal to the date.
+	started?: number;
+	// Filter tasks by their completed date. Only return tasks that have a completed date less than or equal to the date.
+	completed?: number;
+	// Filter tasks by the action_time in pickup_details. Only return tasks that have a pickup_time date greater than or equal to the date.
+	pickup_time?: number;
+	// The type of task that will be searched on. The default is: 'bolter'
+	query_type?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetTaskLocationGroupResponse = Tasks;
 
 export interface GetTaskLocationGroupRequest
-  extends BaseRequest,
-    RequestQuery<GetTaskLocationGroupQuery>,
-    GetTaskLocationGroupPath {}
+	extends BaseRequest,
+		RequestQuery<GetTaskLocationGroupQuery>,
+		GetTaskLocationGroupPath {}