@compassdigital/sdk.typescript 4.109.0 → 4.110.0

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
 	 *

package/src/interface/ai.ts

@@ -71,26 +71,14 @@ export type PostAiLanguageGenerateBody = GenerateTextRequest;
 
 export type PostAiLanguageGenerateResponse = GenerateTextResponse;
 
-export interface PostAiLanguageGenerateRequest extends BaseRequest {
-	body: PostAiLanguageGenerateBody;
-}
-
 // POST /ai/image/generate - Generate image from a given prompt
 
 export type PostAiImageGenerateBody = GenerateImageRequest;
 
 export type PostAiImageGenerateResponse = GenerateImageResponse;
 
-export interface PostAiImageGenerateRequest extends BaseRequest {
-	body: PostAiImageGenerateBody;
-}
-
 // POST /ai/translate - Translate strings
 
 export type PostAiTranslateBody = TranslateRequest;
 
 export type PostAiTranslateResponse = TranslateResponse;
-
-export interface PostAiTranslateRequest extends BaseRequest {
-	body: PostAiTranslateBody;
-}

package/src/interface/auth.ts

@@ -126,10 +126,6 @@ export type PostAuthFlowBody = SSOFlowRequestDTO;
 
 export type PostAuthFlowResponse = SSOFlowResponseDTO;
 
-export interface PostAuthFlowRequest extends BaseRequest {
-	body: PostAuthFlowBody;
-}
-
 // GET /auth/sso-configs - Returns all available SSO configurations
 
 export interface GetAuthSsoConfigsQuery {
@@ -139,30 +135,18 @@ export interface GetAuthSsoConfigsQuery {
 
 export type GetAuthSsoConfigsResponse = SSOConfigsResponseDTO[];
 
-export interface GetAuthSsoConfigsRequest
-	extends BaseRequest,
-		RequestQuery<GetAuthSsoConfigsQuery> {}
-
 // POST /auth/sso-config - Create a new SSO configuration
 
 export type PostAuthSsoConfigBody = SSOConfigRequestDTO;
 
 export type PostAuthSsoConfigResponse = SSOConfigResponseDTO;
 
-export interface PostAuthSsoConfigRequest extends BaseRequest {
-	body: PostAuthSsoConfigBody;
-}
-
 // PUT /auth/sso-config - Update an SSO configuration
 
 export type PutAuthSsoConfigBody = SSOConfigUpdateRequestDTO;
 
 export type PutAuthSsoConfigResponse = SSOConfigResponseDTO;
 
-export interface PutAuthSsoConfigRequest extends BaseRequest {
-	body: PutAuthSsoConfigBody;
-}
-
 // DELETE /auth/sso-config/{name}/{clientId} - Delete a SSO configuration
 
 export interface DeleteAuthSsoConfigPath {
@@ -172,18 +156,12 @@ export interface DeleteAuthSsoConfigPath {
 
 export type DeleteAuthSsoConfigResponse = SSOConfigResponseDTO;
 
-export interface DeleteAuthSsoConfigRequest extends BaseRequest, DeleteAuthSsoConfigPath {}
-
 // POST /auth/sso - Authenticates a user using a SSO provider.
 
 export type PostAuthSsoBody = SSOAuthRequestDTO;
 
 export type PostAuthSsoResponse = SSOAuthResponseDTO;
 
-export interface PostAuthSsoRequest extends BaseRequest {
-	body: PostAuthSsoBody;
-}
-
 // POST /auth/sso/exchange - exchange idP information for short lived exchange token
 // 					(only required for web clients)
 
@@ -191,10 +169,6 @@ export type PostAuthSsoExchangeBody = SSOAuthRequestDTO;
 
 export type PostAuthSsoExchangeResponse = SSOExchangeDTO;
 
-export interface PostAuthSsoExchangeRequest extends BaseRequest {
-	body: PostAuthSsoExchangeBody;
-}
-
 // GET /auth/sso/exchange - Exchange short lived JWT for access & refresh
 
 export interface GetAuthSsoExchangeQuery {
@@ -204,7 +178,3 @@ export interface GetAuthSsoExchangeQuery {
 }
 
 export type GetAuthSsoExchangeResponse = SSOAuthResponseDTO;
-
-export interface GetAuthSsoExchangeRequest
-	extends BaseRequest,
-		RequestQuery<GetAuthSsoExchangeQuery> {}

package/src/interface/centricos.ts

@@ -214,6 +214,15 @@ export interface GetStationResponse {
 	closure_schedules: ClosureSchedule[];
 }
 
+export interface CentricVoucherifyMetaData {
+	// The type of the voucherify discount
+	type: string;
+	// The numeric value of discount for amount off
+	amountOff?: number;
+	// The percentage value of discount for percent off
+	percentOff?: number;
+}
+
 export interface DiscountRequestDTO {
 	// name of the discount
 	name: string;
@@ -227,22 +236,16 @@ export interface DiscountRequestDTO {
 	createdAt?: string;
 	// last update timestamp
 	updatedAt?: string;
-	// Voucherify metadata
-	meta?: Record<string, any>;
+	meta?: {
+		[index: string]: any;
+	} & CentricVoucherifyMetaData;
 	id?: string;
 	is?: Record<string, any>;
 }
 
-export interface SiteDTO {
-	// The ID of the site
-	id: string;
-	// The name of the site
-	name: string;
-}
-
 export interface PutDiscountVoucherifyRequestDTO {
 	discount: DiscountRequestDTO;
-	sites?: SiteDTO[];
+	sites?: string[];
 }
 
 export interface DiscountResponseDTO {
@@ -254,8 +257,9 @@ export interface DiscountResponseDTO {
 	name: string;
 	// status of the discount
 	status?: Record<string, any>;
-	// Voucherify metadata
-	meta?: Record<string, any>;
+	meta?: {
+		[index: string]: any;
+	} & CentricVoucherifyMetaData;
 	id: string;
 	createdAt: string;
 	updatedAt: string;
@@ -264,13 +268,20 @@ export interface DiscountResponseDTO {
 
 export interface PutDiscountVoucherifyResponseDTO {
 	discount: DiscountResponseDTO;
-	sites?: SiteDTO[];
+	sites?: string[];
 }
 
 export type DiscountValidationError = Record<string, any>;
 
 export type DiscountCreateError = Record<string, any>;
 
+export interface SiteDTO {
+	// The ID of the site
+	id: string;
+	// The name of the site
+	name: string;
+}
+
 export interface PutDiscountVoucherifyPublishResponseDTO {
 	// user is of discount creator
 	createdBy: string;
@@ -280,8 +291,9 @@ export interface PutDiscountVoucherifyPublishResponseDTO {
 	name: string;
 	// status of the discount
 	status?: Record<string, any>;
-	// Voucherify metadata
-	meta?: Record<string, any>;
+	meta?: {
+		[index: string]: any;
+	} & CentricVoucherifyMetaData;
 	// List of sites where discount is published
 	sites?: SiteDTO[];
 	id: string;
@@ -323,20 +335,12 @@ export type PostCentricosAiItemDescriptionBody = AIItemDescriptionRequest;
 
 export type PostCentricosAiItemDescriptionResponse = AIItemDescriptionResponse;
 
-export interface PostCentricosAiItemDescriptionRequest extends BaseRequest {
-	body: PostCentricosAiItemDescriptionBody;
-}
-
 // POST /centricos/ai/item/image - Generate item image
 
 export type PostCentricosAiItemImageBody = AIItemImageRequest;
 
 export type PostCentricosAiItemImageResponse = AIItemImageResponse;
 
-export interface PostCentricosAiItemImageRequest extends BaseRequest {
-	body: PostCentricosAiItemImageBody;
-}
-
 // GET /centricos/orders/export - Get orders in csv format
 
 export interface PostCentricosOrdersExportQuery {
@@ -386,10 +390,6 @@ export interface PostCentricosOrdersExportQuery {
 
 export type PostCentricosOrdersExportResponse = OrdersExportResponse;
 
-export interface PostCentricosOrdersExportRequest
-	extends BaseRequest,
-		RequestQuery<PostCentricosOrdersExportQuery> {}
-
 // GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in site's local timezone.
 
 export interface GetCentricosReportGroupConfigPath {
@@ -404,11 +404,6 @@ export interface GetCentricosReportGroupConfigQuery {
 
 export type GetCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
 
-export interface GetCentricosReportGroupConfigRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosReportGroupConfigQuery>,
-		GetCentricosReportGroupConfigPath {}
-
 // PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in site's local timezone.
 
 export interface PutCentricosReportGroupConfigPath {
@@ -420,12 +415,6 @@ export type PutCentricosReportGroupConfigBody = ReportGroupConfigRequest;
 
 export type PutCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
 
-export interface PutCentricosReportGroupConfigRequest
-	extends BaseRequest,
-		PutCentricosReportGroupConfigPath {
-	body: PutCentricosReportGroupConfigBody;
-}
-
 // DELETE /centricos/report/group/{location_group}/config - Delete report configuration for a location group. Times are in site's local timezone.
 
 export interface DeleteCentricosReportGroupConfigPath {
@@ -435,10 +424,6 @@ export interface DeleteCentricosReportGroupConfigPath {
 
 export type DeleteCentricosReportGroupConfigResponse = ReportGroupConfigResponse;
 
-export interface DeleteCentricosReportGroupConfigRequest
-	extends BaseRequest,
-		DeleteCentricosReportGroupConfigPath {}
-
 // GET /centricos/report/group/{location_group}/config/default - Get default report configuration. Times are in site's local timezone.
 
 export interface GetCentricosReportConfigDefaultPath {
@@ -453,11 +438,6 @@ export interface GetCentricosReportConfigDefaultQuery {
 
 export type GetCentricosReportConfigDefaultResponse = ReportGroupConfigResponse;
 
-export interface GetCentricosReportConfigDefaultRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosReportConfigDefaultQuery>,
-		GetCentricosReportConfigDefaultPath {}
-
 // GET /centricos/looker/embedurl - Get a signed URL for looker embeding
 
 export interface GetCentricosLookerEmbedurlQuery {
@@ -468,10 +448,6 @@ export interface GetCentricosLookerEmbedurlQuery {
 
 export type GetCentricosLookerEmbedurlResponse = LookerEmbedURLResponse;
 
-export interface GetCentricosLookerEmbedurlRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosLookerEmbedurlQuery> {}
-
 // GET /centricos/devices/{site_id} - Get site devices
 
 export interface GetSiteDevicesPath {
@@ -486,11 +462,6 @@ export interface GetSiteDevicesQuery {
 
 export type GetSiteDevicesResponse = SiteDevicesResponse;
 
-export interface GetSiteDevicesRequest
-	extends BaseRequest,
-		RequestQuery<GetSiteDevicesQuery>,
-		GetSiteDevicesPath {}
-
 // GET /centricos/sites - Get a list of sites. This endpoint is paginated and supports filtering, sorting, and searching.
 
 export interface GetCentricosSitesQuery {
@@ -506,10 +477,6 @@ export interface GetCentricosSitesQuery {
 
 export type GetCentricosSitesResponse = GetSitesResponse;
 
-export interface GetCentricosSitesRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosSitesQuery> {}
-
 // GET /centricos/sites/price-level/{price_level} - This returns specific properties from sites, locations, and stations connected to a menu price level. This does not support pagination, filtering, sorting, or searching.
 
 export interface GetSitesFromPriceLevelPath {
@@ -525,11 +492,6 @@ export interface GetSitesFromPriceLevelQuery {
 
 export type GetSitesFromPriceLevelResponse = GetPriceLevelSitesResponse;
 
-export interface GetSitesFromPriceLevelRequest
-	extends BaseRequest,
-		RequestQuery<GetSitesFromPriceLevelQuery>,
-		GetSitesFromPriceLevelPath {}
-
 // GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
 
 export interface GetReviewOrderItemsPath {
@@ -543,11 +505,6 @@ export interface GetReviewOrderItemsQuery {
 
 export type GetReviewOrderItemsResponse = ReviewOrderItemsResponseDTO;
 
-export interface GetReviewOrderItemsRequest
-	extends BaseRequest,
-		RequestQuery<GetReviewOrderItemsQuery>,
-		GetReviewOrderItemsPath {}
-
 // GET /centricos/station/{station_id} - Get station details
 
 export interface GetCentricosStationPath {
@@ -562,21 +519,12 @@ export interface GetCentricosStationQuery {
 
 export type GetCentricosStationResponse = GetStationResponse;
 
-export interface GetCentricosStationRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosStationQuery>,
-		GetCentricosStationPath {}
-
 // PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
 
 export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
 
 export type PutCentricosDiscountVoucherifyResponse = PutDiscountVoucherifyResponseDTO;
 
-export interface PutCentricosDiscountVoucherifyRequest extends BaseRequest {
-	body: PutCentricosDiscountVoucherifyBody;
-}
-
 // PUT /centricos/discount/{id}/voucherify/publish - Update and publish a voucherify discount and assign it to multiple sites
 
 export interface PutCentricosDiscountVoucherifyPublishPath {
@@ -586,10 +534,6 @@ export interface PutCentricosDiscountVoucherifyPublishPath {
 
 export type PutCentricosDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
 
-export interface PutCentricosDiscountVoucherifyPublishRequest
-	extends BaseRequest,
-		PutCentricosDiscountVoucherifyPublishPath {}
-
 // DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
 
 export interface DeleteCentricosDiscountsVoucherifyPath {
@@ -599,10 +543,6 @@ export interface DeleteCentricosDiscountsVoucherifyPath {
 
 export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
 
-export interface DeleteCentricosDiscountsVoucherifyRequest
-	extends BaseRequest,
-		DeleteCentricosDiscountsVoucherifyPath {}
-
 // GET /centricos/discount/{id} - Get discount information by ID
 
 export interface GetCentricosDiscountPath {
@@ -616,8 +556,3 @@ export interface GetCentricosDiscountQuery {
 }
 
 export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
-
-export interface GetCentricosDiscountRequest
-	extends BaseRequest,
-		RequestQuery<GetCentricosDiscountQuery>,
-		GetCentricosDiscountPath {}