@compassdigital/sdk.typescript 4.67.0 → 4.68.0

package/src/interface/mealplan.ts

@@ -1,275 +1,276 @@
 /* eslint-disable */
 // THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
 
-import { RequestQuery, BaseRequest } from "./util";
+import { RequestQuery, BaseRequest } from './util';
 
 export interface Error {
-  code?: number;
-  message?: string;
-  data?: Record<string, any>;
-  headers?: {
-    Location?: string;
-  };
+	code?: number;
+	message?: string;
+	data?: Record<string, any>;
+	headers?: {
+		Location?: string;
+	};
 }
 
 export interface Tender {
-  // tender
-  id?: string;
-  name?: string;
-  balance?: number;
-  amount?: number;
-  type?: string;
-  is?: TenderIs;
-  currency?: string;
+	// tender
+	id?: string;
+	name?: string;
+	balance?: number;
+	amount?: number;
+	type?: string;
+	is?: TenderIs;
+	currency?: string;
 }
 
 export interface TenderIs {
-  validated?: boolean;
+	validated?: boolean;
 }
 
 export interface TendersAndAuth {
-  tenders?: Tender[];
-  auth?: AuthPayload;
+	tenders?: Tender[];
+	auth?: AuthPayload;
 }
 
 export interface VerifyEmail {
-  email?: string;
+	email?: string;
 }
 
 export interface success {
-  success?: boolean;
+	success?: boolean;
 }
 
 export interface AuthPayload {
-  webview?: {
-    url?: string;
-    method?: string;
-    encoding?: string;
-    body?: {
-      [index: string]: any;
-    };
-  };
-  direct?: {
-    name?: {
-      en?: string;
-    };
-    description?: {
-      en?: string;
-    };
-    username_field?: {
-      en?: string;
-    };
-    password_field?: {
-      en?: string;
-    };
-    username_value?: string;
-    email_value?: string;
-  };
+	webview?: {
+		url?: string;
+		method?: string;
+		encoding?: string;
+		body?: {
+			[index: string]: any;
+		};
+	};
+	direct?: {
+		name?: {
+			en?: string;
+		};
+		description?: {
+			en?: string;
+		};
+		username_field?: {
+			en?: string;
+		};
+		password_field?: {
+			en?: string;
+		};
+		username_value?: string;
+		email_value?: string;
+	};
 }
 
 // POST /mealplan/{id} - Authenticate against the meal plan provider
 
 export interface PostMealplanPath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface PostMealplanBody {
-  username?: string;
-  password?: string;
-  // Used for email domain validation, if enabled for current mealplan.
-  email?: string;
-  lang?: string;
+	username?: string;
+	password?: string;
+	// Used for email domain validation, if enabled for current mealplan.
+	email?: string;
+	lang?: string;
+	skey?: string;
 }
 
 export interface PostMealplanResponse {
-  tenders?: Tender[];
+	tenders?: Tender[];
 }
 
 export interface PostMealplanRequest extends BaseRequest, PostMealplanPath {
-  body: PostMealplanBody;
+	body: PostMealplanBody;
 }
 
 // PUT /mealplan/{id} - Save a token for access to the meal plan
 
 export interface PutMealplanPath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface PutMealplanBody {
-  token?: string;
+	token?: string;
 }
 
 export interface PutMealplanResponse {
-  tenders?: Tender[];
+	tenders?: Tender[];
 }
 
 export interface PutMealplanRequest extends BaseRequest, PutMealplanPath {
-  body: PutMealplanBody;
+	body: PutMealplanBody;
 }
 
 // GET /mealplan/{id} - Check the user's meal plan tenders and get the authentication configuration
 
 export interface GetMealplanPath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface GetMealplanQuery {
-  // Retrieve all tenders from the get_mealplan call. Defaults to false
-  all_tenders?: boolean;
-  // Graphql query string
-  _query?: string;
+	// Retrieve all tenders from the get_mealplan call. Defaults to false
+	all_tenders?: boolean;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetMealplanResponse = TendersAndAuth;
 
 export interface GetMealplanRequest
-  extends BaseRequest,
-    RequestQuery<GetMealplanQuery>,
-    GetMealplanPath {}
+	extends BaseRequest,
+		RequestQuery<GetMealplanQuery>,
+		GetMealplanPath {}
 
 // DELETE /mealplan/{id} - Delete a mealplan or a tender from the user's account
 
 export interface DeleteMealplanPath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface DeleteMealplanBody {
-  tenders?: string[];
+	tenders?: string[];
 }
 
 export type DeleteMealplanResponse = TendersAndAuth;
 
 export interface DeleteMealplanRequest extends BaseRequest, DeleteMealplanPath {
-  body: DeleteMealplanBody;
+	body: DeleteMealplanBody;
 }
 
 // POST /mealplan/{id}/callback - Callback endpoint for meal plans that make a call back from a webview workflow
 
 export interface PostMealplanCallbackPath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface PostMealplanCallbackQuery {
-  // Determines whether the request originates from a web client or not
-  web?: boolean;
+	// Determines whether the request originates from a web client or not
+	web?: boolean;
 }
 
 export interface PostMealplanCallbackBody {
-  // Used for ITC SSO
-  Credential?: string;
-  // Used for ITC SSO
-  token?: string;
+	// Used for ITC SSO
+	Credential?: string;
+	// Used for ITC SSO
+	token?: string;
 }
 
 export interface PostMealplanCallbackResponse {
-  token?: string;
-  //@deprecated
-  cardNumber?: string;
+	token?: string;
+	//@deprecated
+	cardNumber?: string;
 }
 
 export interface PostMealplanCallbackRequest
-  extends BaseRequest,
-    RequestQuery<PostMealplanCallbackQuery>,
-    PostMealplanCallbackPath {
-  body: PostMealplanCallbackBody;
+	extends BaseRequest,
+		RequestQuery<PostMealplanCallbackQuery>,
+		PostMealplanCallbackPath {
+	body: PostMealplanCallbackBody;
 }
 
 // GET /mealplan/{id}/tender/{tender} - Check the user's tender balance
 
 export interface GetMealplanTenderPath {
-  // Meal plan ID
-  id: string;
-  // Tender ID
-  tender: string;
+	// Meal plan ID
+	id: string;
+	// Tender ID
+	tender: string;
 }
 
 export interface GetMealplanTenderQuery {
-  // Graphql query string
-  _query?: string;
+	// Graphql query string
+	_query?: string;
 }
 
 export type GetMealplanTenderResponse = Tender;
 
 export interface GetMealplanTenderRequest
-  extends BaseRequest,
-    RequestQuery<GetMealplanTenderQuery>,
-    GetMealplanTenderPath {}
+	extends BaseRequest,
+		RequestQuery<GetMealplanTenderQuery>,
+		GetMealplanTenderPath {}
 
 // DELETE /mealplan/{id}/tender/{tender} - Debit an amount from the tender balance
 
 export interface DeleteMealplanTenderPath {
-  // Meal plan ID
-  id: string;
-  // Tender ID
-  tender: string;
+	// Meal plan ID
+	id: string;
+	// Tender ID
+	tender: string;
 }
 
 export interface DeleteMealplanTenderBody {
-  amount: number;
-  type?: string;
-  conversion_amount?: number;
-  terminal_id?: string;
-  drain_order_type?: {
-    taxable?: boolean;
-    tax_exempt?: boolean;
-  };
+	amount: number;
+	type?: string;
+	conversion_amount?: number;
+	terminal_id?: string;
+	drain_order_type?: {
+		taxable?: boolean;
+		tax_exempt?: boolean;
+	};
 }
 
 export interface DeleteMealplanTenderResponse {
-  // tender
-  id?: string;
-  name?: string;
-  balance?: number;
-  is?: TenderIs;
-  transaction_id?: string;
-  type?: number;
-  tender_id?: number;
-  currency?: string;
-  transaction_amount?: number;
+	// tender
+	id?: string;
+	name?: string;
+	balance?: number;
+	is?: TenderIs;
+	transaction_id?: string;
+	type?: number;
+	tender_id?: number;
+	currency?: string;
+	transaction_amount?: number;
 }
 
 export interface DeleteMealplanTenderRequest extends BaseRequest, DeleteMealplanTenderPath {
-  body: DeleteMealplanTenderBody;
+	body: DeleteMealplanTenderBody;
 }
 
 // PATCH /mealplan/{id}/tender/{tender} - Refund an amount to the tender balance
 
 export interface PatchMealplanTenderPath {
-  // Meal plan ID
-  id: string;
-  // Tender ID
-  tender: string;
+	// Meal plan ID
+	id: string;
+	// Tender ID
+	tender: string;
 }
 
 export interface PatchMealplanTenderBody {
-  amount: number;
-  transaction_id?: string;
-  // Amount for order paid by user
-  transaction_amount?: number;
-  terminal_id?: string;
+	amount: number;
+	transaction_id?: string;
+	// Amount for order paid by user
+	transaction_amount?: number;
+	terminal_id?: string;
 }
 
 export type PatchMealplanTenderResponse = Tender;
 
 export interface PatchMealplanTenderRequest extends BaseRequest, PatchMealplanTenderPath {
-  body: PatchMealplanTenderBody;
+	body: PatchMealplanTenderBody;
 }
 
 // POST /mealplan/{id}/verify - Send verification email to user linking a mealplan
 
 export interface PostMealplanVerifyPath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface PostMealplanVerifyQuery {
-  // The language of the user ex: en, fr
-  lang?: string;
+	// The language of the user ex: en, fr
+	lang?: string;
 }
 
 export type PostMealplanVerifyBody = VerifyEmail;
@@ -277,53 +278,53 @@ export type PostMealplanVerifyBody = VerifyEmail;
 export type PostMealplanVerifyResponse = success;
 
 export interface PostMealplanVerifyRequest
-  extends BaseRequest,
-    RequestQuery<PostMealplanVerifyQuery>,
-    PostMealplanVerifyPath {
-  body: PostMealplanVerifyBody;
+	extends BaseRequest,
+		RequestQuery<PostMealplanVerifyQuery>,
+		PostMealplanVerifyPath {
+	body: PostMealplanVerifyBody;
 }
 
 // PUT /mealplan/{id}/verify - Verify email address using provided payload
 
 export interface PutMealplanVerifyPath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface PutMealplanVerifyBody {
-  token?: string;
+	token?: string;
 }
 
 export type PutMealplanVerifyResponse = success;
 
 export interface PutMealplanVerifyRequest extends BaseRequest, PutMealplanVerifyPath {
-  body: PutMealplanVerifyBody;
+	body: PutMealplanVerifyBody;
 }
 
 // POST /mealplan/{id}/authorize - Authorize Transaction
 
 export interface PostMealplanAuthorizePath {
-  // Meal plan ID
-  id: string;
+	// Meal plan ID
+	id: string;
 }
 
 export interface PostMealplanAuthorizeBody {
-  // Encoded ID of the tender - should be renamed to `tender_number` for consistency
-  tender_id: string;
-  // Amount for the transaction should be authorized
-  amount: number;
+	// Encoded ID of the tender - should be renamed to `tender_number` for consistency
+	tender_id: string;
+	// Amount for the transaction should be authorized
+	amount: number;
 }
 
 export interface PostMealplanAuthorizeResponse {
-  // tender
-  id?: string;
-  name?: string;
-  balance?: number;
-  is?: TenderIs;
-  transaction_id?: string;
-  currency?: string;
+	// tender
+	id?: string;
+	name?: string;
+	balance?: number;
+	is?: TenderIs;
+	transaction_id?: string;
+	currency?: string;
 }
 
 export interface PostMealplanAuthorizeRequest extends BaseRequest, PostMealplanAuthorizePath {
-  body: PostMealplanAuthorizeBody;
+	body: PostMealplanAuthorizeBody;
 }