@compassdigital/sdk.typescript 4.108.0 → 4.110.0

package/src/index.ts

@@ -296,8 +296,12 @@ import {
 	GetPromoCompanyLocationGroupResponse,
 	PostPromoValidateVoucherBody,
 	PostPromoValidateVoucherResponse,
+	PostPromoValidateVouchersBody,
+	PostPromoValidateVouchersResponse,
 	PostPromoRedeemVoucherBody,
 	PostPromoRedeemVoucherResponse,
+	PostPromoRedeemVouchersBody,
+	PostPromoRedeemVouchersResponse,
 	PostPromoVoucherBody,
 	PostPromoVoucherResponse,
 	PutPromoVoucherBody,
@@ -1065,6 +1069,21 @@ import {
 	PostReviewOrderItemsResponse,
 	PostHomePageBody,
 	PostHomePageResponse,
+	GetConsumerFrictionlessCheckinQuery,
+	GetConsumerFrictionlessCheckinResponse,
+	PostFrictionlessQrcodeBody,
+	PostFrictionlessQrcodeResponse,
+	PostConsumerForgotPasswordBody,
+	PostConsumerForgotPasswordResponse,
+	PostConsumerAddSecretResponse,
+	GetConsumerLocationGroupQuery,
+	GetConsumerLocationGroupResponse$0,
+	GetConsumerLocationMultigroupQuery,
+	GetConsumerLocationMultigroupResponse,
+	GetConsumerActiveMenusQuery,
+	GetConsumerActiveMenusResponse,
+	GetConsumerMenuQuery,
+	GetConsumerMenuResponse$0,
 } from './interface/consumer';
 
 import {
@@ -1096,14 +1115,18 @@ import {
 	GetSiteDevicesResponse,
 	GetCentricosSitesQuery,
 	GetCentricosSitesResponse,
+	GetSitesFromPriceLevelQuery,
+	GetSitesFromPriceLevelResponse,
 	GetReviewOrderItemsQuery,
 	GetReviewOrderItemsResponse,
 	GetCentricosStationQuery,
 	GetCentricosStationResponse,
-	PutDiscountVoucherifyBody,
-	PutDiscountVoucherifyResponse,
-	PutDiscountVoucherifyPublishBody,
-	PutDiscountVoucherifyPublishResponse,
+	PutCentricosDiscountVoucherifyBody,
+	PutCentricosDiscountVoucherifyResponse,
+	PutCentricosDiscountVoucherifyPublishResponse,
+	DeleteCentricosDiscountsVoucherifyResponse,
+	GetCentricosDiscountQuery,
+	GetCentricosDiscountResponse,
 } from './interface/centricos';
 
 import {
@@ -3708,6 +3731,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /promo/validate/vouchers - Validate multiple promo vouchers
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_promo_validate_vouchers(
+		body: PostPromoValidateVouchersBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostPromoValidateVouchersResponse> {
+		return this.request(
+			'promo',
+			'/promo/validate/vouchers',
+			'post',
+			`/promo/validate/vouchers`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /promo/redeem/voucher - Redeem a promo voucher
 	 *
@@ -3728,6 +3771,26 @@ export class ServiceClient extends BaseServiceClient {
 		);
 	}
 
+	/**
+	 * POST /promo/redeem/vouchers - Redeem multiple promo vouchers
+	 *
+	 * @param body
+	 * @param options - additional request options
+	 */
+	post_promo_redeem_vouchers(
+		body: PostPromoRedeemVouchersBody,
+		options?: RequestOptions,
+	): ResponsePromise<PostPromoRedeemVouchersResponse> {
+		return this.request(
+			'promo',
+			'/promo/redeem/vouchers',
+			'post',
+			`/promo/redeem/vouchers`,
+			body,
+			options,
+		);
+	}
+
 	/**
 	 * POST /promo/voucher - Create new voucher
 	 *
@@ -11262,6 +11325,167 @@ export class ServiceClient extends BaseServiceClient {
 		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
 	 *
@@ -11371,7 +11595,7 @@ export class ServiceClient extends BaseServiceClient {
 	/**
 	 * GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in site's local timezone.
 	 *
-	 * @param location_group - TODO: add parameter to swagger.json
+	 * @param location_group - TODO: cannot use CompassLongID as path parameter
 	 * @param options - additional request options
 	 */
 	get_centricos_report_group_config(
@@ -11393,7 +11617,7 @@ export class ServiceClient extends BaseServiceClient {
 	/**
 	 * PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in site's local timezone.
 	 *
-	 * @param location_group - TODO: add parameter to swagger.json
+	 * @param location_group - TODO: cannot use CompassLongID as path parameter
 	 * @param body
 	 * @param options - additional request options
 	 */
@@ -11415,7 +11639,7 @@ export class ServiceClient extends BaseServiceClient {
 	/**
 	 * DELETE /centricos/report/group/{location_group}/config - Delete report configuration for a location group. Times are in site's local timezone.
 	 *
-	 * @param location_group - TODO: add parameter to swagger.json
+	 * @param location_group - TODO: cannot use CompassLongID as path parameter
 	 * @param options - additional request options
 	 */
 	delete_centricos_report_group_config(
@@ -11435,7 +11659,7 @@ export class ServiceClient extends BaseServiceClient {
 	/**
 	 * GET /centricos/report/group/{location_group}/config/default - Get default report configuration. Times are in site's local timezone.
 	 *
-	 * @param location_group - TODO: add parameter to swagger.json
+	 * @param location_group - TODO: cannot use CompassLongID as path parameter
 	 * @param options - additional request options
 	 */
 	get_centricos_report_config_default(
@@ -11509,6 +11733,28 @@ export class ServiceClient extends BaseServiceClient {
 		return this.request('centricos', '/centricos/sites', 'get', `/centricos/sites`, null, options);
 	}
 
+	/**
+	 * 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.
+	 *
+	 * @param price_level - TODO: cannot use CompassLongID as path parameter
+	 * @param options - additional request options
+	 */
+	get_sites_from_price_level(
+		price_level: string,
+		options?: {
+			query?: GetSitesFromPriceLevelQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetSitesFromPriceLevelResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/sites/price-level/{price_level}',
+			'get',
+			`/centricos/sites/price-level/${price_level}`,
+			null,
+			options,
+		);
+	}
+
 	/**
 	 * GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
 	 *
@@ -11534,7 +11780,7 @@ export class ServiceClient extends BaseServiceClient {
 	/**
 	 * GET /centricos/station/{station_id} - Get station details
 	 *
-	 * @param station_id - TODO: add parameter to swagger.json
+	 * @param station_id - TODO: cannot use CompassLongID as path parameter
 	 * @param options - additional request options
 	 */
 	get_centricos_station(
@@ -11559,10 +11805,10 @@ export class ServiceClient extends BaseServiceClient {
 	 * @param body
 	 * @param options - additional request options
 	 */
-	put_discount_voucherify(
-		body: PutDiscountVoucherifyBody,
+	put_centricos_discount_voucherify(
+		body: PutCentricosDiscountVoucherifyBody,
 		options?: RequestOptions,
-	): ResponsePromise<PutDiscountVoucherifyResponse> {
+	): ResponsePromise<PutCentricosDiscountVoucherifyResponse> {
 		return this.request(
 			'centricos',
 			'/centricos/discount/voucherify',
@@ -11577,20 +11823,60 @@ export class ServiceClient extends BaseServiceClient {
 	 * PUT /centricos/discount/{id}/voucherify/publish - Update and publish a voucherify discount and assign it to multiple sites
 	 *
 	 * @param id - Discount ID
-	 * @param body
 	 * @param options - additional request options
 	 */
-	put_discount_voucherify_publish(
+	put_centricos_discount_voucherify_publish(
 		id: string,
-		body: PutDiscountVoucherifyPublishBody,
 		options?: RequestOptions,
-	): ResponsePromise<PutDiscountVoucherifyPublishResponse> {
+	): ResponsePromise<PutCentricosDiscountVoucherifyPublishResponse> {
 		return this.request(
 			'centricos',
 			'/centricos/discount/{id}/voucherify/publish',
 			'put',
 			`/centricos/discount/${id}/voucherify/publish`,
-			body,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * DELETE /centricos/discount/{id}/voucherify - Delete a discount from voucherify and all of its entity associations
+	 *
+	 * @param id - Discount ID
+	 * @param options - additional request options
+	 */
+	delete_centricos_discounts_voucherify(
+		id: string,
+		options?: RequestOptions,
+	): ResponsePromise<DeleteCentricosDiscountsVoucherifyResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/discount/{id}/voucherify',
+			'delete',
+			`/centricos/discount/${id}/voucherify`,
+			null,
+			options,
+		);
+	}
+
+	/**
+	 * GET /centricos/discount/{id} - Get discount information by ID
+	 *
+	 * @param id - ID of the discount to retrieve
+	 * @param options - additional request options
+	 */
+	get_centricos_discount(
+		id: string,
+		options?: {
+			query?: GetCentricosDiscountQuery;
+		} & RequestOptions,
+	): ResponsePromise<GetCentricosDiscountResponse> {
+		return this.request(
+			'centricos',
+			'/centricos/discount/{id}',
+			'get',
+			`/centricos/discount/${id}`,
+			null,
 			options,
 		);
 	}
@@ -11809,7 +12095,7 @@ export class ServiceClient extends BaseServiceClient {
 	/**
 	 * GET /discount/{id} - Get a discount
 	 *
-	 * @param id
+	 * @param id - a discount id
 	 * @param options - additional request options
 	 */
 	get_discount(

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

@@ -19,6 +19,12 @@ export interface SSOFlowResponseDTO {
 	oidc?: OIDC;
 }
 
+export interface UnauthorizedErrorDTO {
+	message: string;
+	code: number;
+	data: Record<string, any>;
+}
+
 export interface SSOMapping {
 	id: string;
 	given_name: string;
@@ -120,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 {
@@ -133,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 {
@@ -166,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)
 
@@ -185,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 {
@@ -198,7 +178,3 @@ export interface GetAuthSsoExchangeQuery {
 }
 
 export type GetAuthSsoExchangeResponse = SSOAuthResponseDTO;
-
-export interface GetAuthSsoExchangeRequest
-	extends BaseRequest,
-		RequestQuery<GetAuthSsoExchangeQuery> {}