@compassdigital/sdk.typescript 4.420.0 → 4.422.0

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "@compassdigital/sdk.typescript",
-	"version": "4.420.0",
+	"version": "4.422.0",
 	"description": "Compass Digital Labs TypeScript SDK",
 	"type": "commonjs",
 	"main": "./lib/index.js",

package/src/index.ts

@@ -623,7 +623,6 @@ import {
 	GetMenuV3DraftBrandVerifyPublishResponse,
 	PostMenuV3DraftBrandArchiveResponse,
 	PostMenuV3DraftBrandUnarchiveResponse,
-	PostMenuV3DraftBrandSyncMenuworksQuery,
 	PostMenuV3DraftBrandSyncMenuworksResponse,
 	PostMenuV3BrandQuery,
 	PostMenuV3BrandBody,
@@ -1179,6 +1178,10 @@ import {
 	GetPaymentCashlessConsumerResponse,
 	GetPaymentClienttokenConsumerQuery,
 	GetPaymentClienttokenConsumerResponse,
+	GetPaymentHpcConsumerQuery,
+	GetPaymentHpcConsumerResponse,
+	GetPaymentTokenConsumerQuery,
+	GetPaymentTokenConsumerResponse,
 	GetConsumerShoppingcartResponse,
 	PutConsumerShoppingcartBody,
 	PutConsumerShoppingcartResponse,
@@ -7407,22 +7410,20 @@ export class ServiceClient extends BaseServiceClient {
 	}
 
 	/**
-	 * POST /menu/v3/draft/brand/{id}/sync-menuworks
+	 * POST /menu/v3/draft/brand/{brand_id}/sync-menuworks
 	 *
-	 * @param id - TODO: add parameter to swagger.json
+	 * @param brand_id
 	 * @param options - additional request options
 	 */
 	post_menu_v3_draft_brand_sync_menuworks(
-		id: string,
-		options?: {
-			query?: PostMenuV3DraftBrandSyncMenuworksQuery;
-		} & RequestOptions,
+		brand_id: string,
+		options?: RequestOptions,
 	): ResponsePromise<PostMenuV3DraftBrandSyncMenuworksResponse> {
 		return this.request(
 			'menu',
-			'/menu/v3/draft/brand/{id}/sync-menuworks',
+			'/menu/v3/draft/brand/{brand_id}/sync-menuworks',
 			'POST',
-			`/menu/v3/draft/brand/${id}/sync-menuworks`,
+			`/menu/v3/draft/brand/${brand_id}/sync-menuworks`,
 			null,
 			options,
 		);
@@ -13380,6 +13381,46 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * GET /consumer/payment/hpc - Get FreedomPay HPC iframe for payment card entry
+	 *
+	 * @param options - additional request options
+	 */
+	get_payment_hpc_consumer(
+		options: {
+			query: GetPaymentHpcConsumerQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetPaymentHpcConsumerResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/payment/hpc',
+			'GET',
+			`/consumer/payment/hpc`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /consumer/payment/token - Get FreedomPay payment token from HPC session
+	 *
+	 * @param options - additional request options
+	 */
+	get_payment_token_consumer(
+		options: {
+			query: GetPaymentTokenConsumerQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetPaymentTokenConsumerResponse> {
+		return this.request(
+			'consumer',
+			'/consumer/payment/token',
+			'GET',
+			`/consumer/payment/token`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /consumer/shoppingcart/{id} - Get a shopping cart by ID
 	 *

package/src/interface/consumer.ts

@@ -2228,6 +2228,38 @@ export interface ConsumerGetPaymentClienttokenResponse {
 	expires_in?: number;
 }
 
+export interface ConsumerGetPaymentHpcResponse {
+	// FreedomPay HPC iframe HTML
+	iframe?: string;
+	// Session key for subsequent HPC operations
+	sessionKey?: string;
+}
+
+export interface ConsumerGetPaymentTokenResponse {
+	// Payment token
+	token?: string;
+	// Masked account number
+	accountNumberMasked?: string;
+	// Card expiration month
+	cardExpirationMonth?: string;
+	// Card expiration year
+	cardExpirationYear?: string;
+	// Card brand
+	brand?: string;
+	// POS card type
+	posCardType?: string;
+	// Card type
+	cardType?: string;
+	// Token expiration
+	tokenExpiration?: string;
+	// POS data
+	posData?: string;
+	// New token
+	newToken?: string;
+	// Session key
+	sessionKey?: string;
+}
+
 export interface PromoDetails {
 	code?: string;
 	provider?: Record<string, any>;
@@ -2789,7 +2821,7 @@ export interface ConsumerPublicMealplanConfig {
 	// The mealplan valid email domains
 	valid_email_domains?: string[];
 	// The mealplan note
-	note?: string;
+	note?: Record<string, any>;
 }
 
 export interface GetConsumerConfigPublicResponse {
@@ -3270,7 +3302,7 @@ export interface OpenAiChatBody {
 	// The messages to send to the chat completion
 	messages: OpenAiChatMessage[];
 	// The tools to use for the chat completion
-	tools: string[];
+	tools: Record<string, any>[];
 	// The tool choices to use for the chat completion
 	tool_choice: Record<string, any>;
 	// The temperature to use for the chat completion
@@ -3648,6 +3680,36 @@ export interface GetPaymentClienttokenConsumerQuery {
 
 export type GetPaymentClienttokenConsumerResponse = ConsumerGetPaymentClienttokenResponse;
 
+// GET /consumer/payment/hpc - Get FreedomPay HPC iframe for payment card entry
+
+export interface GetPaymentHpcConsumerQuery {
+	// CDL Site ID
+	siteId: string;
+	// hCaptcha response key
+	captchaResponseKey: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetPaymentHpcConsumerResponse = ConsumerGetPaymentHpcResponse;
+
+// GET /consumer/payment/token - Get FreedomPay payment token from HPC session
+
+export interface GetPaymentTokenConsumerQuery {
+	// Payment Key
+	paymentKey: string;
+	// Session key
+	sessionKey: string;
+	// CDL Site ID
+	siteId: string;
+	// Name on card
+	nameOnCard: string;
+	// Graphql query string
+	_query?: string;
+}
+
+export type GetPaymentTokenConsumerResponse = ConsumerGetPaymentTokenResponse;
+
 // GET /consumer/shoppingcart/{id} - Get a shopping cart by ID
 
 export interface GetConsumerShoppingcartPath {

package/src/interface/menu.ts

@@ -4086,15 +4086,10 @@ export interface PostMenuV3DraftBrandUnarchiveRequest
 	extends BaseRequest,
 		PostMenuV3DraftBrandUnarchivePath {}
 
-// POST /menu/v3/draft/brand/{id}/sync-menuworks
+// POST /menu/v3/draft/brand/{brand_id}/sync-menuworks
 
 export interface PostMenuV3DraftBrandSyncMenuworksPath {
-	// TODO: add parameter to swagger.json
-	id: string;
-}
-
-export interface PostMenuV3DraftBrandSyncMenuworksQuery {
-	brand_id?: string;
+	brand_id: string;
 }
 
 export interface PostMenuV3DraftBrandSyncMenuworksResponse {
@@ -4105,7 +4100,6 @@ export interface PostMenuV3DraftBrandSyncMenuworksResponse {
 
 export interface PostMenuV3DraftBrandSyncMenuworksRequest
 	extends BaseRequest,
-		RequestQuery<PostMenuV3DraftBrandSyncMenuworksQuery>,
 		PostMenuV3DraftBrandSyncMenuworksPath {}
 
 // POST /menu/v3/brand