@compassdigital/sdk.typescript 4.109.0 → 4.111.0

package/src/events/LegacyUserCreated.ts

@@ -0,0 +1,92 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyUserCreatedEvent {
+	id: string;
+	email: string;
+	name: 'LegacyUserCreated';
+	phone?: number;
+	phone_country_code?: string;
+	date: {
+		created: string;
+		modified: string;
+		last_accessed: string;
+	};
+	birthday?: string;
+	password?: string;
+	tokens?: {
+		refresh?: string;
+	}[];
+	secrets?: {
+		blackboard?: string;
+		atrium?: string;
+		cbord?: string;
+		heartland?: string;
+		payment_methods?: string;
+		itc?: string;
+		preferred_payment_method?: string;
+		fcm_token?: string;
+		FCM_TOKEN?: string;
+		phone_verification?: Record<string, any>;
+		dh_userid?: string;
+		dh_customer_id?: string;
+		dh_password?: string;
+		_EMAIL_VERIFICATION_TOKEN?: string;
+		_PASSWORD_RESET_TOKEN?: string;
+		freedompay?: string;
+		oauthaccess?: Record<string, any>;
+	};
+	gender?: string;
+	meta?: {
+		marketing_opt_in?: boolean;
+		marketing_opt_in_source?: string;
+		marketing_opt_in_date?: string;
+		order_status_notification?: {
+			send_emails?: boolean;
+			send_emails_date_updated?: string;
+		};
+		scan_and_go_tutorial_is_complete?: boolean;
+		last_location?: string;
+		self_checkout_walk_me_complete?: boolean;
+		newUser?: boolean;
+		brand?: string;
+		title?: string;
+		password_verification?: {
+			attempts?: number;
+			first_attempted?: string;
+		};
+		login_limit?: {
+			login_attempts?: number;
+			last_attempt_date?: string;
+		};
+		phone_verification?: {
+			verification_code?: string;
+			date_generated?: number;
+			failed_attempts?: number;
+			consecutive_failed_attempts?: number;
+		};
+		cashless?: {
+			stipend?: Record<string, any>;
+			voucher?: Record<string, any>;
+			badge_pay?: Record<string, any>;
+			coupon_voucher?: Record<string, any>;
+		};
+		mealplan_added_date?: string;
+		is_guest?: boolean;
+		first_badgepay_added_date?: string;
+		looker_id?: string;
+	};
+	permissions?: {
+		scopes?: string[];
+	};
+	is?: {
+		verified?: boolean;
+		disabled?: boolean;
+		deleted?: boolean;
+		phone_verified?: boolean;
+		locked_out?: boolean;
+		placeholder?: boolean;
+	};
+	location_group?: string;
+	ssoId?: string;
+	version: '0.0.1';
+}

package/src/events/LegacyUserUpdated.ts

@@ -0,0 +1,113 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyUserUpdatedEvent {
+	id: string;
+	email: string;
+	name: 'LegacyUserUpdated';
+	phone?: number;
+	phone_country_code?: string;
+	date: {
+		created: string;
+		modified: string;
+		last_accessed: string;
+	};
+	birthday?: string;
+	password?: string;
+	tokens?: {
+		refresh?: string;
+	}[];
+	secrets?: {
+		blackboard?: string;
+		atrium?: string;
+		cbord?: string;
+		heartland?: string;
+		payment_methods?: string;
+		itc?: string;
+		preferred_payment_method?: string;
+		fcm_token?: string;
+		FCM_TOKEN?: string;
+		phone_verification?: Record<string, any>;
+		dh_userid?: string;
+		dh_customer_id?: string;
+		dh_password?: string;
+		_EMAIL_VERIFICATION_TOKEN?: string;
+		_PASSWORD_RESET_TOKEN?: string;
+		freedompay?: string;
+		oauthaccess?: Record<string, any>;
+	};
+	gender?: string;
+	meta?: {
+		marketing_opt_in?: boolean;
+		marketing_opt_in_source?: string;
+		marketing_opt_in_date?: string;
+		order_status_notification?: {
+			send_emails?: boolean;
+			send_emails_date_updated?: string;
+		};
+		scan_and_go_tutorial_is_complete?: boolean;
+		last_location?: string;
+		self_checkout_walk_me_complete?: boolean;
+		newUser?: boolean;
+		brand?: string;
+		title?: string;
+		password_verification?: {
+			attempts?: number;
+			first_attempted?: string;
+		};
+		login_limit?: {
+			login_attempts?: number;
+			last_attempt_date?: string;
+		};
+		phone_verification?: {
+			verification_code?: string;
+			date_generated?: number;
+			failed_attempts?: number;
+			consecutive_failed_attempts?: number;
+		};
+		cashless?: {
+			stipend?: Record<string, any>;
+			voucher?: Record<string, any>;
+			badge_pay?: Record<string, any>;
+			coupon_voucher?: Record<string, any>;
+		};
+		mealplan_added_date?: string;
+		is_guest?: boolean;
+		first_badgepay_added_date?: string;
+		looker_id?: string;
+	};
+	permissions?: {
+		scopes?: string[];
+	};
+	is?: {
+		verified?: boolean;
+		disabled?: boolean;
+		deleted?: boolean;
+		phone_verified?: boolean;
+		locked_out?: boolean;
+		placeholder?: boolean;
+	};
+	location_group?: string;
+	ssoId?: string;
+	// Previous state of the user record before update
+	_old: {
+		id: string;
+		email: string;
+		name: {
+			first: string;
+			last: string;
+		};
+		phone?: number;
+		phone_country_code?: string;
+		date: {
+			created: string;
+			modified: string;
+			last_accessed: string;
+		};
+		meta?: Record<string, any>;
+		permissions?: Record<string, any>;
+		is?: Record<string, any>;
+		location_group?: string;
+		ssoId?: string;
+	};
+	version: '0.0.1';
+}

package/src/events/LegacyV2MenuCreated.ts

@@ -0,0 +1,13 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyV2MenuCreatedEvent {
+	// Metadata related to the request, can be empty or contain additional information.
+	meta: Record<string, any>;
+	// The main request body containing the required ID.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+	};
+	name: 'LegacyV2MenuCreated';
+	version: '0.0.1';
+}

package/src/events/LegacyV2MenuDeleted.ts

@@ -0,0 +1,13 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyV2MenuDeletedEvent {
+	// Metadata related to the request, can be empty or contain additional information.
+	meta: Record<string, any>;
+	// The main request body containing the required ID.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+	};
+	name: 'LegacyV2MenuDeleted';
+	version: '0.0.1';
+}

package/src/events/LegacyV2MenuUpdated.ts

@@ -0,0 +1,13 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyV2MenuUpdatedEvent {
+	// Metadata related to the request, can be empty or contain additional information.
+	meta: Record<string, any>;
+	// The main request body containing the required ID.
+	body: {
+		// Unique identifier for the request.
+		id: string;
+	};
+	name: 'LegacyV2MenuUpdated';
+	version: '0.0.1';
+}

package/src/events/LegacyWebhookEventCreated.ts

@@ -0,0 +1,12 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface LegacyWebhookEventCreatedEvent {
+	process_id: string;
+	data: Record<string, any>;
+	partner: string;
+	expiry_date: number;
+	sort_key: string;
+	type: string;
+	name: 'LegacyWebhookEventCreated';
+	version: '0.0.1';
+}

package/src/events/ReprocessCheckinCommandArrived.ts

@@ -0,0 +1,8 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface ReprocessCheckinCommandArrivedEvent {
+	name: 'ReprocessCheckinCommandArrived';
+	checkinID: string;
+	correlationID: string;
+	version: '0.0.1';
+}

package/src/events/ScanAndGoLocationBrandCreated.ts

@@ -0,0 +1,22 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface ScanAndGoLocationBrandCreatedEvent {
+	id: string;
+	is: {
+		hidden: boolean;
+		delivery_supported: boolean;
+		pickup_supported: boolean;
+		frictionless_supported: boolean;
+		web_order_enabled: boolean;
+		scan_and_go_supported: boolean;
+		special_instructions_enabled: boolean;
+		item_label_edit_enabled: boolean;
+		local_images_enabled: boolean;
+		plu_enabled: boolean;
+	};
+	company: string;
+	sector: string;
+	location: string;
+	name: 'ScanAndGoLocationBrandCreated';
+	version: '0.0.1';
+}

package/src/events/UpdateCheckInPaymentRequired.ts

@@ -0,0 +1,23 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export interface UpdateCheckInPaymentRequiredEvent {
+	name: 'UpdateCheckInPaymentRequired';
+	correlationID: string;
+	checkin: {
+		id: string;
+		createdAt: string;
+		updatedAt: string;
+		userID: string;
+		brandID: string;
+		provider: string;
+		i18n: string;
+		payment: {
+			method: string;
+			lastFour: string;
+		};
+		shoppingCartID: string;
+		shoppingCartAmount: number;
+		metadata?: Record<string, any>;
+	};
+	version: '0.0.1';
+}

package/src/events/index.ts

@@ -0,0 +1,69 @@
+// THIS FILE IS AUTOMATICALLY GENERATED, DO NOT MODIFY
+
+export { CheckinProcessingFailedEvent } from './CheckinProcessingFailed';
+
+export { FrictionlessCheckinExecutedEvent } from './FrictionlessCheckinExecuted';
+
+export { FrictionlessShopperCheckedOutEvent } from './FrictionlessShopperCheckedOut';
+
+export { FrictionlessThirdPartyWebhookReceivedEvent } from './FrictionlessThirdPartyWebhookReceived';
+
+export { LegacyBrandCleanupRequestedEvent } from './LegacyBrandCleanupRequested';
+
+export { LegacyBrandExcelImportRequestedEvent } from './LegacyBrandExcelImportRequested';
+
+export { LegacyDraftBrandDiffGenerateRequestedEvent } from './LegacyDraftBrandDiffGenerateRequested';
+
+export { LegacyDraftBrandGlobalDiffsApplyRequestedEvent } from './LegacyDraftBrandGlobalDiffsApplyRequested';
+
+export { LegacyDraftBrandPublishRequestedEvent } from './LegacyDraftBrandPublishRequested';
+
+export { LegacyDraftBrandPublishedEvent } from './LegacyDraftBrandPublished';
+
+export { LegacyDraftMenuPublishedToV2MenuEvent } from './LegacyDraftMenuPublishedToV2Menu';
+
+export { LegacyGlobalMenuGroupDeletedEvent } from './LegacyGlobalMenuGroupDeleted';
+
+export { LegacyItemExcelImportRequestedEvent } from './LegacyItemExcelImportRequested';
+
+export { LegacyItemExcelValidationRequestedEvent } from './LegacyItemExcelValidationRequested';
+
+export { LegacyLocalMenuGroupDeletedEvent } from './LegacyLocalMenuGroupDeleted';
+
+export { LegacyLocationCreatedEvent } from './LegacyLocationCreated';
+
+export { LegacyLocationUpdatedEvent } from './LegacyLocationUpdated';
+
+export { LegacyMenuPublishToV2MenuRequestedEvent } from './LegacyMenuPublishToV2MenuRequested';
+
+export { LegacyMenuUpdatedEvent } from './LegacyMenuUpdated';
+
+export { LegacyOrderCreatedEvent } from './LegacyOrderCreated';
+
+export { LegacyOrderReadyStatusUpdateEvent } from './LegacyOrderReadyStatusUpdate';
+
+export { LegacyOrderUpdatedEvent } from './LegacyOrderUpdated';
+
+export { LegacyPopulateLocalBrandsRequestedEvent } from './LegacyPopulateLocalBrandsRequested';
+
+export { LegacyShoppingCartCreatedEvent } from './LegacyShoppingCartCreated';
+
+export { LegacyShoppingCartUpdatedEvent } from './LegacyShoppingCartUpdated';
+
+export { LegacyUserCreatedEvent } from './LegacyUserCreated';
+
+export { LegacyUserUpdatedEvent } from './LegacyUserUpdated';
+
+export { LegacyV2MenuCreatedEvent } from './LegacyV2MenuCreated';
+
+export { LegacyV2MenuDeletedEvent } from './LegacyV2MenuDeleted';
+
+export { LegacyV2MenuUpdatedEvent } from './LegacyV2MenuUpdated';
+
+export { LegacyWebhookEventCreatedEvent } from './LegacyWebhookEventCreated';
+
+export { ReprocessCheckinCommandArrivedEvent } from './ReprocessCheckinCommandArrived';
+
+export { ScanAndGoLocationBrandCreatedEvent } from './ScanAndGoLocationBrandCreated';
+
+export { UpdateCheckInPaymentRequiredEvent } from './UpdateCheckInPaymentRequired';

package/src/index.ts

@@ -1058,6 +1058,34 @@ import {
 	PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse,
 } from './interface/frictionless';
 
+import {
+	HealthCheckControllerExecuteQuery,
+	HealthCheckControllerExecuteResponse,
+	GetPaymentListByBrandQuery,
+	GetPaymentListByBrandResponse,
+	GetCustomerOrdersQuery,
+	GetCustomerOrdersResponse,
+	PostReviewOrderItemsBody,
+	PostReviewOrderItemsResponse,
+	PostHomePageBody,
+	PostHomePageResponse,
+	GetConsumerFrictionlessCheckinQuery,
+	GetConsumerFrictionlessCheckinResponse,
+	PostFrictionlessQrcodeBody,
+	PostFrictionlessQrcodeResponse,
+	PostConsumerForgotPasswordBody,
+	PostConsumerForgotPasswordResponse,
+	PostConsumerAddSecretResponse,
+	GetConsumerLocationGroupQuery,
+	GetConsumerLocationGroupResponse$0,
+	GetConsumerLocationMultigroupQuery,
+	GetConsumerLocationMultigroupResponse,
+	GetConsumerActiveMenusQuery,
+	GetConsumerActiveMenusResponse,
+	GetConsumerMenuQuery,
+	GetConsumerMenuResponse$0,
+} from './interface/consumer';
+
 import {
 	PostAiLanguageGenerateBody,
 	PostAiLanguageGenerateResponse,
@@ -11202,6 +11230,262 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /consumer/v1/health-check
+	 *
+	 * @param options - additional request options
+	 */
+	HealthCheckController_execute(
+		options?: {
+			query?: HealthCheckControllerExecuteQuery;
+		} & RequestOptions,
+	): ResponsePromise<HealthCheckControllerExecuteResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/v1/health-check',
+			'get',
+			`/consumer/v1/health-check`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /consumer/v1/payment-methods - List payment methods available in a given brand
+	 *
+	 * @param options - additional request options
+	 */
+	get_payment_list_by_brand(
+		options?: {
+			query?: GetPaymentListByBrandQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetPaymentListByBrandResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/v1/payment-methods',
+			'get',
+			`/consumer/v1/payment-methods`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /consumer/customer-orders/{userId} - Get customer orders
+	 *
+	 * @param userId - a valid CDL user id
+	 * @param options - additional request options
+	 */
+	get_customer_orders(
+		userId: string,
+		options?: {
+			query?: GetCustomerOrdersQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetCustomerOrdersResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/customer-orders/{userId}',
+			'get',
+			`/consumer/customer-orders/${userId}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /consumer/review/order-items - Submit reviews for order items
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_review_order_items(
+		body: PostReviewOrderItemsBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostReviewOrderItemsResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/review/order-items',
+			'post',
+			`/consumer/review/order-items`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /consumer/home - Provide the front end all the data required to render the home page
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_home_page(
+		body: PostHomePageBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostHomePageResponse> {
+		return this.request('consumer', '/consumer/home', 'post', `/consumer/home`, body, options);
+	}
+
+	/**
+	 * GET /consumer/frictionless/checkin/{id} - Allow a user to check in to a location using frictionless technology
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_consumer_frictionless_checkin(
+		id: string,
+		options?: {
+			query?: GetConsumerFrictionlessCheckinQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetConsumerFrictionlessCheckinResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/frictionless/checkin/{id}',
+			'get',
+			`/consumer/frictionless/checkin/${id}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * POST /consumer/frictionless/qrCode - Create a QR code for a frictionless checkin
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_frictionless_qrcode(
+		body: PostFrictionlessQrcodeBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostFrictionlessQrcodeResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/frictionless/qrCode',
+			'post',
+			`/consumer/frictionless/qrCode`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /consumer/forgotpassword - Forgot password
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_consumer_forgot_password(
+		body: PostConsumerForgotPasswordBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostConsumerForgotPasswordResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/forgotpassword',
+			'post',
+			`/consumer/forgotpassword`,
+			body,
+			options,
+		);
+	}
+
+	/**
+	 * POST /consumer/secret - Add user secret
+	 *
+	 * @param options - additional request options
+	 */
+	post_consumer_add_secret(
+		options?: RequestOptions,
+	): ResponsePromise<PostConsumerAddSecretResponse> {
+		return this.request('consumer', '/consumer/secret', 'post', `/consumer/secret`, null, options);
+	}
+
+	/**
+	 * GET /consumer/location-group/{id} - Get location group
+	 *
+	 * @param id - TODO: add parameter to swagger.json
+	 * @param options - additional request options
+	 */
+	get_consumer_location_group(
+		id: string,
+		options?: {
+			query?: GetConsumerLocationGroupQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetConsumerLocationGroupResponse$0> {
+		return this.request(
+			'consumer',
+			'/consumer/location-group/{id}',
+			'get',
+			`/consumer/location-group/${id}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /consumer/location-multigroup/{id} - Get location multi group
+	 *
+	 * @param id - TODO: add parameter to swagger.json
+	 * @param options - additional request options
+	 */
+	get_consumer_location_multigroup(
+		id: string,
+		options?: {
+			query?: GetConsumerLocationMultigroupQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetConsumerLocationMultigroupResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/location-multigroup/{id}',
+			'get',
+			`/consumer/location-multigroup/${id}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /consumer/active-menus/{stationId} - Get current menu
+	 *
+	 * @param stationId - TODO: add parameter to swagger.json
+	 * @param options - additional request options
+	 */
+	get_consumer_active_menus(
+		stationId: string,
+		options: {
+			query: GetConsumerActiveMenusQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetConsumerActiveMenusResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/active-menus/{stationId}',
+			'get',
+			`/consumer/active-menus/${stationId}`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /consumer/menu/{id} - Provide the front end all the data required to render the home page
+	 *
+	 * @param id
+	 * @param options - additional request options
+	 */
+	get_consumer_menu(
+		id: string,
+		options?: {
+			query?: GetConsumerMenuQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetConsumerMenuResponse$0> {
+		return this.request(
+			'consumer',
+			'/consumer/menu/{id}',
+			'get',
+			`/consumer/menu/${id}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * POST /ai/language/generate - Generate text from a given prompt
 	 *