@compassdigital/sdk.typescript 4.616.0 → 4.617.0

package/src/index.ts

@@ -1190,8 +1190,13 @@ import {
 	GetConsumerFrictionlessCheckinResponse,
 	PostFrictionlessQrcodeBody,
 	PostFrictionlessQrcodeResponse,
+	PostConsumerV2FrictionlessQrcodeBody,
+	PostConsumerV2FrictionlessQrcodeResponse,
 	PostConsumerForgotPasswordBody,
 	PostConsumerForgotPasswordResponse,
+	PostConsumerV2ForgotPasswordQuery,
+	PostConsumerV2ForgotPasswordBody,
+	PostConsumerV2ForgotPasswordResponse,
 	PostConsumerAddSecretBody,
 	PostConsumerAddSecretResponse,
 	GetConsumerLocationGroupQuery,
@@ -13679,6 +13684,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /consumer/v2/frictionless/qrCode - Create a QR code for a frictionless checkin
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_consumer_v2_frictionless_qrcode(
+		body: PostConsumerV2FrictionlessQrcodeBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostConsumerV2FrictionlessQrcodeResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/v2/frictionless/qrCode',
+			'POST',
+			`/consumer/v2/frictionless/qrCode`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /consumer/forgotpassword - Forgot password
 	 *
@@ -13699,6 +13724,28 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /consumer/v2/forgotpassword - Forgot password
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_consumer_v2_forgot_password(
+		body: PostConsumerV2ForgotPasswordBody,
+		options: {
+			query: PostConsumerV2ForgotPasswordQuery;
+		} & RequestOptions,
+	): ResponsePromise<PostConsumerV2ForgotPasswordResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/v2/forgotpassword',
+			'POST',
+			`/consumer/v2/forgotpassword`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /consumer/user/{id}/secret/{key} - Add user secret
 	 *

package/src/interface/consumer.ts

@@ -1512,13 +1512,28 @@ export interface HomePageResponse {
 }
 
 export interface FrictionlessCheckinResponse {
+	// Check-in session ID
 	id: string;
-	provider: Record<string, any>;
-	status: Record<string, any>;
+	// Frictionless provider
+	provider: 'AWS' | 'SC';
+	// Current status of the check-in session
+	status:
+		| 'CREATING'
+		| 'ACTIVE'
+		| 'ERROR'
+		| 'CANCELED'
+		| 'PROCESSING'
+		| 'UPDATE_PAYMENT_REQUIRED'
+		| 'COMPLETED';
+	// Reason the session failed
 	reasonOfFail?: string;
+	// Third-party correlated ID
 	thirdPartyCorrelatedID?: string;
+	// Shopping cart ID associated with the session
 	shoppingCartID?: string;
+	// Brand ID
 	brandID: string;
+	// User ID
 	userID: string;
 }
 
@@ -1535,14 +1550,44 @@ export interface FrictionlessQrCodeResponse {
 	id: string;
 }
 
-export interface ForgotPasswordRequest {
+export interface FrictionlessMealplanPaymentDto {
+	// Meal plan tender ID
+	tenderID: string;
+	// Meal plan name
+	name: string;
+}
+
+export interface FrictionlessCreditCardPaymentDto {
+	// Credit card type
+	cardType: string;
+	// Last 4 digits of the credit card
+	last4: string;
+}
+
+export interface FrictionlessPaymentMethodDto {
+	// Meal plan payment details
+	mealplan?: FrictionlessMealplanPaymentDto;
+	// Credit card payment details
+	creditCard?: FrictionlessCreditCardPaymentDto;
+	// Payment token
+	token?: string;
+}
+
+export interface FrictionlessQrCodeV2Request {
+	// brand id
+	brandId: string;
+	// payment method
+	paymentMethod: FrictionlessPaymentMethodDto;
+}
+
+export interface ForgotPasswordV1Request {
 	// email
 	email: string;
 	// captchaResponseKey
 	captchaResponseKey: string;
-	// realm
+	// The realm of the user
 	realm?: string;
-	// lang
+	// The language, e.g. en, fr
 	lang?: string;
 }
 
@@ -1551,10 +1596,15 @@ export interface ForgotPasswordResponse {
 	success?: boolean;
 }
 
-export interface PostConsumerUserAddSecretBody {
-	key?: string;
+export interface ForgotPasswordRequest {
+	// email
+	email: string;
+	// Type of password reset
+	type?: 'forgot_password' | 'new_user';
 }
 
+export type PostConsumerUserAddSecretBody = Record<string, any>;
+
 export interface PostUserAddSecret {
 	key?: string;
 }
@@ -2096,10 +2146,12 @@ export interface ConsumerCashlessLog {
 }
 
 export interface ConsumerUserMeta {
-	is_guest?: boolean;
+	// Whether the user has opted in to marketing
 	marketing_opt_in?: boolean;
+	// Date the user opted in to marketing
 	marketing_opt_in_date?: string;
-	marketing_opt_in_source?: Record<string, any>;
+	// Source where the user opted in to marketing
+	marketing_opt_in_source?: 'App' | 'Web';
 	order_status_notification?: {
 		send_emails?: boolean;
 		send_emails_date_updated?: string;
@@ -2143,6 +2195,17 @@ export interface ConsumerUserIs {
 	placeholder?: boolean;
 }
 
+export interface ConsumerScopes {
+	scopes?: string[];
+}
+
+export interface ConsumerTemporaryPermissions {
+	// Expiry date of the temporary permissions
+	expiry: string;
+	// Permission scopes
+	scopes: string[];
+}
+
 export interface PostConsumerUserChangePasswordResponse {
 	// The ID of the user
 	id: string;
@@ -2152,17 +2215,37 @@ export interface PostConsumerUserChangePasswordResponse {
 	name?: ConsumerUserName;
 	// The date the user was created
 	date?: ConsumerUserDate;
+	// The birthday of the user
+	birthday?: string;
+	// The password of the user
+	password?: string;
+	// The phone of the user
+	phone?: number;
+	// The phone country code of the user
+	phone_country_code?: string;
+	// The realm of the user
+	realm?: string;
+	// The location group of the user
+	location_group?: string;
+	// The ssoId of the user
+	ssoId?: string;
+	// The last accessed date of the user
+	last_accessed?: string;
 	// The gender of the user
-	gender?: Record<string, any>;
+	gender?: 'male' | 'female' | 'non-binary';
+	// The meta of the user
 	meta?: ConsumerUserMeta;
+	// Quick boolean details for the user
 	is?: ConsumerUserIs;
-}
-
-export interface ConsumerScopes {
-	scopes?: string[];
+	// The permissions of the user
+	permissions?: ConsumerScopes;
+	// Temporary permissions for the user
+	temporary_permissions?: ConsumerTemporaryPermissions;
 }
 
 export interface PutConsumerUserRequest {
+	// The id of the user
+	id?: string;
 	// The email of the user
 	email?: string;
 	// The name of the user
@@ -2180,7 +2263,7 @@ export interface PutConsumerUserRequest {
 	// The realm of the user
 	realm?: string;
 	// The gender of the user
-	gender?: Record<string, any>;
+	gender?: 'male' | 'female' | 'non-binary';
 	// The meta of the user
 	meta?: ConsumerUserMeta;
 	// The is of the user
@@ -2227,6 +2310,8 @@ export interface PutConsumerUserResponse {
 }
 
 export interface PatchConsumerUserRequest {
+	// The id of the user
+	id?: string;
 	// The email of the user
 	email?: string;
 	// The name of the user
@@ -2244,7 +2329,7 @@ export interface PatchConsumerUserRequest {
 	// The realm of the user
 	realm?: string;
 	// The gender of the user
-	gender?: Record<string, any>;
+	gender?: 'male' | 'female' | 'non-binary';
 	// The meta of the user
 	meta?: ConsumerUserMeta;
 	// The is of the user
@@ -2295,7 +2380,7 @@ export interface GetConsumerUserResponse {
 	// The realm of the user
 	realm?: string;
 	// The gender of the user
-	gender?: Record<string, any>;
+	gender?: 'male' | 'female' | 'non-binary';
 	// The meta of the user
 	meta?: ConsumerUserMeta;
 	// The is of the user
@@ -2306,6 +2391,8 @@ export interface GetConsumerUserResponse {
 	location_group?: string;
 	// The ssoId of the user
 	ssoId?: string;
+	// The last accessed date of the user
+	last_accessed?: string;
 }
 
 export interface ConsumerCashlessTender {
@@ -3445,20 +3532,57 @@ export interface PostConsumerUserGuestRequest {
 	name: ConsumerUserName;
 }
 
+export interface GuestUserAccess {
+	// Access token
+	token?: string;
+	// Token expiry date
+	expires?: string;
+}
+
+export interface GuestUserProfile {
+	// The ID of the user
+	id?: string;
+	// The email of the user
+	email?: string;
+	// The name of the user
+	name?: ConsumerUserName;
+	// The date of the user
+	date?: ConsumerUserDate;
+	// The birthday of the user
+	birthday?: string;
+	// The password of the user
+	password?: string;
+	// The phone of the user
+	phone?: number;
+	// The phone country code of the user
+	phone_country_code?: string;
+	// The realm of the user
+	realm?: string;
+	// The gender of the user
+	gender?: 'male' | 'female' | 'non-binary';
+	// The meta of the user
+	meta?: ConsumerUserMeta;
+	// Quick boolean details for the user
+	is?: ConsumerUserIs;
+	// The permissions of the user
+	permissions?: ConsumerScopes;
+	// The location group of the user
+	location_group?: string;
+	// The ssoId of the user
+	ssoId?: string;
+	// The last accessed date of the user
+	last_accessed?: string;
+}
+
 export interface PostConsumerUserGuestResponse {
-	// The token of the guest user
+	// @deprecated
 	token?: string;
-	access?: {
-		token?: string;
-		expires?: string;
-	};
+	// The access information of the guest user
+	access?: GuestUserAccess;
 	// The user ID of the guest user
 	user?: string;
-	profile?: {
-		id?: string;
-		email?: string;
-		realm?: string;
-	};
+	// The profile of the guest user
+	profile?: GuestUserProfile;
 }
 
 export interface OpenAiToolCallFunction {
@@ -3762,12 +3886,33 @@ export type PostFrictionlessQrcodeBody = FrictionlessQrCodeRequest;
 
 export type PostFrictionlessQrcodeResponse = FrictionlessQrCodeResponse;
 
+// POST /consumer/v2/frictionless/qrCode - Create a QR code for a frictionless checkin
+
+export type PostConsumerV2FrictionlessQrcodeBody = FrictionlessQrCodeV2Request;
+
+export type PostConsumerV2FrictionlessQrcodeResponse = FrictionlessQrCodeResponse;
+
 // POST /consumer/forgotpassword - Forgot password
 
-export type PostConsumerForgotPasswordBody = ForgotPasswordRequest;
+export type PostConsumerForgotPasswordBody = ForgotPasswordV1Request;
 
 export type PostConsumerForgotPasswordResponse = ForgotPasswordResponse;
 
+// POST /consumer/v2/forgotpassword - Forgot password
+
+export interface PostConsumerV2ForgotPasswordQuery {
+	// hCaptcha response key
+	captchaResponseKey: string;
+	// The realm of the user
+	realm?: string;
+	// The language, e.g. en, fr
+	lang?: string;
+}
+
+export type PostConsumerV2ForgotPasswordBody = ForgotPasswordRequest;
+
+export type PostConsumerV2ForgotPasswordResponse = ForgotPasswordResponse;
+
 // POST /consumer/user/{id}/secret/{key} - Add user secret
 
 export interface PostConsumerAddSecretPath {