@compassdigital/sdk.typescript 4.382.0 → 4.384.0

package/src/interface/consumer.ts

@@ -2002,21 +2002,14 @@ export interface PostConsumerUserChangePasswordResponse {
 	id: string;
 	// The email of the user
 	email: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	// The name of the user
+	name?: Record<string, any>;
+	// The date the user was created
+	date?: Record<string, any>;
 	// The gender of the user
 	gender?: Record<string, any>;
 	meta?: ConsumerUserMeta;
-	is?: {
-		locked_out?: boolean;
-		verified?: boolean;
-	};
+	is?: Record<string, any>;
 }
 
 export interface ConsumerScopes {
@@ -2024,33 +2017,33 @@ export interface ConsumerScopes {
 }
 
 export interface PutConsumerUserRequest {
-	id?: string;
+	// The email of the user
 	email?: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	// The name of the user
+	name?: Record<string, any>;
+	// The date of the user
+	date?: Record<string, any>;
+	// 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;
-	gender?: Record<string, any>;
+	// The gender of the user
+	gender?: 'male' | 'female' | 'non-binary';
+	// The meta of the user
 	meta?: ConsumerUserMeta;
-	is?: {
-		disabled?: boolean;
-		locked_out?: boolean;
-		verified?: boolean;
-		phone_verified?: boolean;
-		deleted?: boolean;
-		placeholder?: boolean;
-	};
+	// The is of the user
+	is?: Record<string, any>;
+	// The permissions of the user
 	permissions?: ConsumerScopes;
+	// The location group of the user
 	location_group?: string;
+	// The ssoId of the user
 	ssoId?: string;
 }
 
@@ -2059,14 +2052,10 @@ export interface PutConsumerUserResponse {
 	id: string;
 	// The email of the user
 	email: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	// The name of the user
+	name?: Record<string, any>;
+	// The date of the user
+	date?: Record<string, any>;
 	// The birthday of the user
 	birthday?: string;
 	// The password of the user
@@ -2081,14 +2070,8 @@ export interface PutConsumerUserResponse {
 	gender?: Record<string, any>;
 	// The meta of the user
 	meta?: ConsumerUserMeta;
-	is?: {
-		disabled?: boolean;
-		locked_out?: boolean;
-		verified?: boolean;
-		phone_verified?: boolean;
-		deleted?: boolean;
-		placeholder?: boolean;
-	};
+	// The is of the user
+	is?: Record<string, any>;
 	// The permissions of the user
 	permissions?: ConsumerScopes;
 	// The location group of the user
@@ -2098,47 +2081,41 @@ export interface PutConsumerUserResponse {
 }
 
 export interface PatchConsumerUserRequest {
-	id?: string;
+	// The email of the user
 	email?: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	// The name of the user
+	name?: Record<string, any>;
+	// The date of the user
+	date?: Record<string, any>;
+	// 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;
-	gender?: Record<string, any>;
+	// The gender of the user
+	gender?: 'male' | 'female' | 'non-binary';
+	// The meta of the user
 	meta?: ConsumerUserMeta;
-	is?: {
-		disabled?: boolean;
-		locked_out?: boolean;
-		verified?: boolean;
-		phone_verified?: boolean;
-		deleted?: boolean;
-		placeholder?: boolean;
-	};
+	// The is of the user
+	is?: Record<string, any>;
+	// The permissions of the user
 	permissions?: ConsumerScopes;
+	// The location group of the user
 	location_group?: string;
+	// The ssoId of the user
 	ssoId?: string;
 }
 
 export interface PatchConsumerUserResponse {
 	id?: string;
 	email?: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	name?: Record<string, any>;
+	date?: Record<string, any>;
 	birthday?: string;
 	password?: string;
 	phone?: number;
@@ -2146,14 +2123,7 @@ export interface PatchConsumerUserResponse {
 	realm?: string;
 	gender?: Record<string, any>;
 	meta?: ConsumerUserMeta;
-	is?: {
-		disabled?: boolean;
-		locked_out?: boolean;
-		verified?: boolean;
-		phone_verified?: boolean;
-		deleted?: boolean;
-		placeholder?: boolean;
-	};
+	is?: Record<string, any>;
 	permissions?: ConsumerScopes;
 	location_group?: string;
 	ssoId?: string;
@@ -2164,14 +2134,10 @@ export interface GetConsumerUserResponse {
 	id: string;
 	// The email of the user
 	email: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	// The name of the user
+	name?: Record<string, any>;
+	// The date of the user
+	date?: Record<string, any>;
 	// The birthday of the user
 	birthday?: string;
 	// The password of the user
@@ -2186,14 +2152,8 @@ export interface GetConsumerUserResponse {
 	gender?: Record<string, any>;
 	// The meta of the user
 	meta?: ConsumerUserMeta;
-	is?: {
-		disabled?: boolean;
-		locked_out?: boolean;
-		verified?: boolean;
-		phone_verified?: boolean;
-		deleted?: boolean;
-		placeholder?: boolean;
-	};
+	// The is of the user
+	is?: Record<string, any>;
 	// The permissions of the user
 	permissions?: ConsumerScopes;
 	// The location group of the user
@@ -2202,6 +2162,22 @@ export interface GetConsumerUserResponse {
 	ssoId?: string;
 }
 
+export interface ConsumerCashlessTender {
+	// Cashless tender balance
+	balance?: number;
+	// Cashless tender ID
+	id?: string;
+	// Cashless tender name
+	name?: string;
+	// Cashless tender type
+	type?: 'badge_pay' | 'stipend' | 'voucher' | 'coupon_voucher';
+}
+
+export interface ConsumerGetPaymentCashlessResponse {
+	// list of cashless tenders
+	tenders?: ConsumerCashlessTender[];
+}
+
 export interface ConsumerGetPaymentClienttokenResponse {
 	// Client token (BrainTree)
 	clienttoken?: string;
@@ -2790,14 +2766,6 @@ export interface ConsumerMealExchange {
 	type?: string;
 }
 
-export interface ConsumerCashlessTender {
-	id?: string;
-	total?: number;
-	tender?: string;
-	name?: string;
-	type?: string;
-}
-
 export interface PutConsumerShoppingCartPaymentRequestDto {
 	// The email to apply to the shopping cart
 	email?: string;
@@ -3071,34 +3039,34 @@ export interface PostConsumerUserVerificationResponse {
 }
 
 export interface PostConsumerUserCaptchaRequest {
-	id?: string;
+	// The email of the user
 	email?: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
-	birthday?: string;
+	// The name of the user
+	name?: Record<string, any>;
+	// The date of the user
+	date?: Record<string, any>;
+	// The birthday of the user
+	birthday: string;
+	// The password of the user
 	password?: string;
-	phone?: number;
-	phone_country_code?: string;
-	realm?: string;
-	gender?: Record<string, any>;
-	meta?: ConsumerUserMeta;
-	is?: {
-		disabled?: boolean;
-		locked_out?: boolean;
-		verified?: boolean;
-		phone_verified?: boolean;
-		deleted?: boolean;
-		placeholder?: boolean;
-	};
-	permissions?: ConsumerScopes;
-	location_group?: string;
-	ssoId?: 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;
+	// The is of the user
+	is?: Record<string, any>;
+	// The permissions of the user
+	permissions: ConsumerScopes;
+	// The location group of the user
+	location_group: string;
+	// The ssoId of the user
+	ssoId: string;
 }
 
 export interface PostConsumerUserCaptchaResponse {
@@ -3106,14 +3074,10 @@ export interface PostConsumerUserCaptchaResponse {
 	id: string;
 	// The email of the user
 	email: string;
-	name?: {
-		first?: string;
-		last?: string;
-	};
-	date?: {
-		created?: string;
-		modified?: string;
-	};
+	// The name of the user
+	name?: Record<string, any>;
+	// The date of the user
+	date?: Record<string, any>;
 	// The birthday of the user
 	birthday?: string;
 	// The phone of the user
@@ -3126,14 +3090,8 @@ export interface PostConsumerUserCaptchaResponse {
 	gender?: Record<string, any>;
 	// The meta of the user
 	meta?: ConsumerUserMeta;
-	is?: {
-		disabled?: boolean;
-		locked_out?: boolean;
-		verified?: boolean;
-		phone_verified?: boolean;
-		deleted?: boolean;
-		placeholder?: boolean;
-	};
+	// The is of the user
+	is?: Record<string, any>;
 	// The permissions of the user
 	permissions?: ConsumerScopes;
 	// The location group of the user
@@ -3161,10 +3119,8 @@ export interface PostConsumerUserGuestRequest {
 	realm: string;
 	// The email of the user
 	email: string;
-	name: {
-		first: string;
-		last: string;
-	};
+	// The name of the user
+	name: Record<string, any>;
 }
 
 export interface PostConsumerUserGuestResponse {
@@ -3533,6 +3489,20 @@ export type PostConsumerChangePasswordBody = PostConsumerUserChangePasswordReque
 
 export type PostConsumerChangePasswordResponse = PostConsumerUserChangePasswordResponse;
 
+// GET /consumer/payment/{id}/cashless - get payment cashless tenders
+
+export interface GetPaymentCashlessConsumerPath {
+	// Payment ID
+	id: string;
+}
+
+export interface GetPaymentCashlessConsumerQuery {
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetPaymentCashlessConsumerResponse = ConsumerGetPaymentCashlessResponse;
+
 // GET /consumer/payment/{id}/clienttoken - get payment client token
 
 export interface GetPaymentClienttokenConsumerPath {