@compassdigital/sdk.typescript 4.107.0 → 4.109.0

package/src/index.ts

@@ -296,8 +296,12 @@ import {
 	GetPromoCompanyLocationGroupResponse,
 	PostPromoValidateVoucherBody,
 	PostPromoValidateVoucherResponse,
+	PostPromoValidateVouchersBody,
+	PostPromoValidateVouchersResponse,
 	PostPromoRedeemVoucherBody,
 	PostPromoRedeemVoucherResponse,
+	PostPromoRedeemVouchersBody,
+	PostPromoRedeemVouchersResponse,
 	PostPromoVoucherBody,
 	PostPromoVoucherResponse,
 	PutPromoVoucherBody,
@@ -1054,17 +1058,6 @@ import {
 	PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse,
 } from './interface/frictionless';
 
-import {
-	HealthCheckControllerExecuteQuery,
-	HealthCheckControllerExecuteResponse,
-	GetPaymentListByBrandQuery,
-	GetPaymentListByBrandResponse,
-	GetCustomerOrdersQuery,
-	GetCustomerOrdersResponse,
-	PostReviewOrderItemsBody,
-	PostReviewOrderItemsResponse,
-} from './interface/consumer';
-
 import {
 	PostAiLanguageGenerateBody,
 	PostAiLanguageGenerateResponse,
@@ -1094,14 +1087,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 {
@@ -3706,6 +3703,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
 	 *
@@ -3726,6 +3743,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
 	 *
@@ -11165,88 +11202,6 @@ 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 /ai/language/generate - Generate text from a given prompt
 	 *
@@ -11356,7 +11311,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(
@@ -11378,7 +11333,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
 	 */
@@ -11400,7 +11355,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(
@@ -11420,7 +11375,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(
@@ -11494,6 +11449,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
 	 *
@@ -11519,7 +11496,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(
@@ -11544,10 +11521,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',
@@ -11562,20 +11539,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,
 		);
 	}
@@ -11794,7 +11811,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/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;

package/src/interface/centricos.ts

@@ -50,6 +50,8 @@ export interface OrdersExportResponse {
 	fileName: string;
 }
 
+export type CompassLongID = Record<string, any>;
+
 export interface DayPart {
 	label: string;
 	start: string;
@@ -107,6 +109,28 @@ export interface GetSitesResponse {
 	results: Site[];
 }
 
+export interface PriceLevelStation {
+	id: string;
+	name: string;
+}
+
+export interface PriceLevelBusinessUnit {
+	id: string;
+	name: string;
+	unit_number: number;
+	stations: PriceLevelStation[];
+}
+
+export interface PriceLevelSite {
+	id: string;
+	name: string;
+	business_units: PriceLevelBusinessUnit[];
+}
+
+export interface GetPriceLevelSitesResponse {
+	sites: PriceLevelSite[];
+}
+
 export interface ReviewOrderItem {
 	// Order id
 	id: string;
@@ -190,76 +214,107 @@ export interface GetStationResponse {
 	closure_schedules: ClosureSchedule[];
 }
 
-export interface VoucherifyDiscountDTO {
+export interface DiscountRequestDTO {
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	// user is of discount creator
+	createdBy?: string;
+	// last user who updated the discount
+	updatedBy?: string;
+	// creation timestamp
+	createdAt?: string;
+	// last update timestamp
+	updatedAt?: string;
+	// Voucherify metadata
+	meta?: Record<string, any>;
 	id?: string;
-	type?: string;
-	amountOff?: number;
-	percentOff?: number;
-}
-
-export interface VoucherifyMetaDataDTO {
-	code?: string;
-	discount?: VoucherifyDiscountDTO;
+	is?: Record<string, any>;
 }
 
-export interface DiscountStatus {
-	live?: boolean;
-	scheduled?: boolean;
-	archived?: boolean;
-}
-
-export interface DiscountIs {
-	badgepayPromo?: boolean;
-	mealplanPromo?: boolean;
-	decliningBalancePromo?: boolean;
-	voucherPromo?: boolean;
-}
-
-export interface DiscountRequestDTO {
-	meta?: {
-		[index: string]: any;
-	} & VoucherifyMetaDataDTO;
-	id?: string;
-	createdBy?: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
+export interface SiteDTO {
+	// The ID of the site
+	id: string;
+	// The name of the site
+	name: string;
 }
 
 export interface PutDiscountVoucherifyRequestDTO {
 	discount: DiscountRequestDTO;
-	sites?: string[];
+	sites?: SiteDTO[];
 }
 
 export interface DiscountResponseDTO {
 	// user is of discount creator
 	createdBy: string;
-	meta?: {
-		[index: string]: any;
-	} & VoucherifyMetaDataDTO;
+	// last user who updated the discount
+	updatedBy: string;
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	// Voucherify metadata
+	meta?: Record<string, any>;
 	id: string;
 	createdAt: string;
 	updatedAt: string;
-	name?: string;
-	status?: DiscountStatus;
-	is?: DiscountIs;
-	app?: string;
+	is?: Record<string, any>;
 }
 
 export interface PutDiscountVoucherifyResponseDTO {
 	discount: DiscountResponseDTO;
-	sites?: string[];
+	sites?: SiteDTO[];
 }
 
-export interface PutDiscountVoucherifyPublishRequestDTO {
-	discount: DiscountRequestDTO;
-	sites?: string[];
-}
+export type DiscountValidationError = Record<string, any>;
+
+export type DiscountCreateError = Record<string, any>;
 
 export interface PutDiscountVoucherifyPublishResponseDTO {
-	discount: DiscountResponseDTO;
-	sites?: string[];
+	// user is of discount creator
+	createdBy: string;
+	// last user who updated the discount
+	updatedBy: string;
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	// Voucherify metadata
+	meta?: Record<string, any>;
+	// List of sites where discount is published
+	sites?: SiteDTO[];
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	is?: Record<string, any>;
+}
+
+export type DiscountPublishError = Record<string, any>;
+
+export interface DeleteDiscountsVoucherifyResponseDTO {
+	success: boolean;
+}
+
+export type DiscountDeleteError = Record<string, any>;
+
+export interface DiscountDTO {
+	// user is of discount creator
+	createdBy: string;
+	// last user who updated the discount
+	updatedBy: string;
+	// name of the discount
+	name: string;
+	// status of the discount
+	status?: Record<string, any>;
+	id: string;
+	createdAt: string;
+	updatedAt: string;
+	is?: Record<string, any>;
+}
+
+export interface GetDiscountResponseDTO {
+	discount: DiscountDTO;
 }
 
 // POST /centricos/ai/item/description - Generate item description
@@ -338,7 +393,7 @@ export interface PostCentricosOrdersExportRequest
 // GET /centricos/report/group/{location_group}/config - Get report configuration for a location group. Times are in site's local timezone.
 
 export interface GetCentricosReportGroupConfigPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -357,7 +412,7 @@ export interface GetCentricosReportGroupConfigRequest
 // PUT /centricos/report/group/{location_group}/config - Update report configuration for a location group. Times are in site's local timezone.
 
 export interface PutCentricosReportGroupConfigPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -374,7 +429,7 @@ export interface PutCentricosReportGroupConfigRequest
 // DELETE /centricos/report/group/{location_group}/config - Delete report configuration for a location group. Times are in site's local timezone.
 
 export interface DeleteCentricosReportGroupConfigPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -387,7 +442,7 @@ export interface DeleteCentricosReportGroupConfigRequest
 // GET /centricos/report/group/{location_group}/config/default - Get default report configuration. Times are in site's local timezone.
 
 export interface GetCentricosReportConfigDefaultPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	location_group: string;
 }
 
@@ -455,6 +510,26 @@ 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 {
+	// TODO: cannot use CompassLongID as path parameter
+	price_level: string;
+}
+
+export interface GetSitesFromPriceLevelQuery {
+	local_menu_group?: string;
+	// Graphql query string
+	_query?: string;
+}
+
+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 {
@@ -476,7 +551,7 @@ export interface GetReviewOrderItemsRequest
 // GET /centricos/station/{station_id} - Get station details
 
 export interface GetCentricosStationPath {
-	// TODO: add parameter to swagger.json
+	// TODO: cannot use CompassLongID as path parameter
 	station_id: string;
 }
 
@@ -494,27 +569,55 @@ export interface GetCentricosStationRequest
 
 // PUT /centricos/discount/voucherify - Add or Update a voucherify discount and assign it to multiple sites
 
-export type PutDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
+export type PutCentricosDiscountVoucherifyBody = PutDiscountVoucherifyRequestDTO;
 
-export type PutDiscountVoucherifyResponse = PutDiscountVoucherifyResponseDTO;
+export type PutCentricosDiscountVoucherifyResponse = PutDiscountVoucherifyResponseDTO;
 
-export interface PutDiscountVoucherifyRequest extends BaseRequest {
-	body: PutDiscountVoucherifyBody;
+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 PutDiscountVoucherifyPublishPath {
+export interface PutCentricosDiscountVoucherifyPublishPath {
 	// Discount ID
 	id: string;
 }
 
-export type PutDiscountVoucherifyPublishBody = PutDiscountVoucherifyPublishRequestDTO;
+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 {
+	// Discount ID
+	id: string;
+}
 
-export type PutDiscountVoucherifyPublishResponse = PutDiscountVoucherifyPublishResponseDTO;
+export type DeleteCentricosDiscountsVoucherifyResponse = DeleteDiscountsVoucherifyResponseDTO;
 
-export interface PutDiscountVoucherifyPublishRequest
+export interface DeleteCentricosDiscountsVoucherifyRequest
 	extends BaseRequest,
-		PutDiscountVoucherifyPublishPath {
-	body: PutDiscountVoucherifyPublishBody;
+		DeleteCentricosDiscountsVoucherifyPath {}
+
+// GET /centricos/discount/{id} - Get discount information by ID
+
+export interface GetCentricosDiscountPath {
+	// ID of the discount to retrieve
+	id: string;
+}
+
+export interface GetCentricosDiscountQuery {
+	// Graphql query string
+	_query?: string;
 }
+
+export type GetCentricosDiscountResponse = GetDiscountResponseDTO;
+
+export interface GetCentricosDiscountRequest
+	extends BaseRequest,
+		RequestQuery<GetCentricosDiscountQuery>,
+		GetCentricosDiscountPath {}