@compassdigital/sdk.typescript 4.108.0 → 4.110.0

package/lib/index.d.ts

@@ -8,7 +8,7 @@ import { PostTaskBody, PostTaskResponse, GetTaskQuery, GetTaskResponse, PatchTas
 import { GetKdsDevicesQuery, GetKdsDevicesResponse, PostKdsDeviceAuthBody, PostKdsDeviceAuthResponse, DeleteKdsDeviceAuthResponse, PatchKdsDeviceInfoBody, PatchKdsDeviceInfoResponse, DeleteKdsDeviceInfoResponse, GetKdsSwaggerQuery, GetKdsSwaggerResponse } from './interface/kds';
 import { PostMealplanBody, PostMealplanResponse, PutMealplanBody, PutMealplanResponse, GetMealplanQuery, GetMealplanResponse, DeleteMealplanBody, DeleteMealplanResponse, PostMealplanCallbackQuery, PostMealplanCallbackBody, PostMealplanCallbackResponse, GetMealplanTenderQuery, GetMealplanTenderResponse, DeleteMealplanTenderBody, DeleteMealplanTenderResponse, PatchMealplanTenderBody, PatchMealplanTenderResponse, PostMealplanVerifyQuery, PostMealplanVerifyBody, PostMealplanVerifyResponse, PutMealplanVerifyBody, PutMealplanVerifyResponse, PostMealplanAuthorizeBody, PostMealplanAuthorizeResponse } from './interface/mealplan';
 import { PostDatalakeSqlBody, PostDatalakeSqlResponse, GetDatalakeSwaggerQuery, GetDatalakeSwaggerResponse } from './interface/datalake';
-import { PostPromoBody, PostPromoResponse, GetPromosQuery, GetPromosResponse, GetPromoQuery, GetPromoResponse, PutPromoBody, PutPromoResponse, DeletePromoResponse, GetPromoCompanyLocationGroupQuery, GetPromoCompanyLocationGroupResponse, PostPromoValidateVoucherBody, PostPromoValidateVoucherResponse, PostPromoRedeemVoucherBody, PostPromoRedeemVoucherResponse, PostPromoVoucherBody, PostPromoVoucherResponse, PutPromoVoucherBody, PutPromoVoucherResponse, DeletePromoVoucherQuery, DeletePromoVoucherResponse, PostPromoCustomerBody, PostPromoCustomerResponse, DeletePromoCustomerBody, DeletePromoCustomerResponse, PostPromoVoucherReverseBody, PostPromoVoucherReverseResponse, PostPromoVoucherifyActivityExecuteBody, PostPromoVoucherifyActivityExecuteResponse, GetPromoVoucherifyActivityConfigQuery, GetPromoVoucherifyActivityConfigResponse } from './interface/promo';
+import { PostPromoBody, PostPromoResponse, GetPromosQuery, GetPromosResponse, GetPromoQuery, GetPromoResponse, PutPromoBody, PutPromoResponse, DeletePromoResponse, GetPromoCompanyLocationGroupQuery, GetPromoCompanyLocationGroupResponse, PostPromoValidateVoucherBody, PostPromoValidateVoucherResponse, PostPromoValidateVouchersBody, PostPromoValidateVouchersResponse, PostPromoRedeemVoucherBody, PostPromoRedeemVoucherResponse, PostPromoRedeemVouchersBody, PostPromoRedeemVouchersResponse, PostPromoVoucherBody, PostPromoVoucherResponse, PutPromoVoucherBody, PutPromoVoucherResponse, DeletePromoVoucherQuery, DeletePromoVoucherResponse, PostPromoCustomerBody, PostPromoCustomerResponse, DeletePromoCustomerBody, DeletePromoCustomerResponse, PostPromoVoucherReverseBody, PostPromoVoucherReverseResponse, PostPromoVoucherifyActivityExecuteBody, PostPromoVoucherifyActivityExecuteResponse, GetPromoVoucherifyActivityConfigQuery, GetPromoVoucherifyActivityConfigResponse } from './interface/promo';
 import { GetConfigAppconfigQuery, GetConfigAppconfigResponse, GetConfigQuery, GetConfigResponse, PostConfigBody, PostConfigResponse, PutConfigBody, PutConfigResponse, DeleteConfigResponse, GetConfigPublicQuery, GetConfigPublicResponse, PostConfigPublicBody, PostConfigPublicResponse, PutConfigPublicBody, PutConfigPublicResponse, DeleteConfigPublicResponse } from './interface/config';
 import { PostAnnouncementQuery, PostAnnouncementBody, PostAnnouncementResponse, GetAnnouncementsQuery, GetAnnouncementsResponse, GetAnnouncementQuery, GetAnnouncementResponse, PutAnnouncementQuery, PutAnnouncementBody, PutAnnouncementResponse, PatchAnnouncementBody, PatchAnnouncementResponse, DeleteAnnouncementResponse } from './interface/announcement';
 import { GetReportAnalyticsGroupQuery, GetReportAnalyticsGroupResponse, GetReportAnalyticsCombinedGroupQuery, GetReportAnalyticsCombinedGroupResponse, GetReportEodGroupQuery, GetReportEodGroupResponse, GetReportEodGroupSubscribersQuery, GetReportEodGroupSubscribersResponse, PostReportEodGroupSubscribersBody, PostReportEodGroupSubscribersResponse, DeleteReportEodGroupSubscribersResponse, PutReportEodGroupSubscribersBody, PutReportEodGroupSubscribersResponse, GetReportEodGroupItemsQuery, GetReportEodGroupItemsResponse, PutReportGroupConfigBody, PutReportGroupConfigResponse, GetReportGroupConfigQuery, GetReportGroupConfigResponse, DeleteReportGroupConfigResponse, GetReportGroupConfigDefaultQuery, GetReportGroupConfigDefaultResponse } from './interface/report';
@@ -20,9 +20,9 @@ import { GetNotificationsQuery, GetNotificationsResponse, PostNotificationBody,
 import { GetCompassconnectOmsTokenQuery, GetCompassconnectOmsTokenResponse } from './interface/compassconnect';
 import { PostVendorApplicationBody, PostVendorApplicationResponse, GetVendorApplicationQuery, GetVendorApplicationResponse, PatchVendorApplicationBody, PatchVendorApplicationResponse, PostVendorBody, PostVendorResponse, GetVendorsQuery, GetVendorsResponse, GetVendorQuery, GetVendorResponse, PatchVendorBody, PatchVendorResponse, GetVendorAuthQuery, GetVendorAuthResponse, PostVendorAuthBody, PostVendorAuthResponse, GetVendorKeysQuery, GetVendorKeysResponse, PostVendorKeyBody, PostVendorKeyResponse, GetVendorKeyQuery, GetVendorKeyResponse, PatchVendorKeyBody, PatchVendorKeyResponse, DeleteVendorKeyResponse, PostVendorKeyRotateQuery, PostVendorKeyRotateResponse, PostVendorResetPasswordBody, PostVendorResetPasswordResponse } from './interface/vendor';
 import { GetFrictionlessBrandFrictionlessStatusQuery, GetFrictionlessBrandFrictionlessStatusResponse, PostFrictionlessQrCodeBody, PostFrictionlessQrCodeResponse, GetFrictionlessCheckinStatusQuery, GetFrictionlessCheckinStatusResponse, GetFrictionlessCheckinQuery, GetFrictionlessCheckinResponse, GetFrictionlessUsersPaymentIssuesQuery, GetFrictionlessUsersPaymentIssuesResponse, GetFrictionlessFailedCheckinsQuery, GetFrictionlessFailedCheckinsResponse, PostFrictionlessCheckinsReprocessResponse, PostFrictionlessCheckinReprocessPaymentBody, PostFrictionlessCheckinReprocessPaymentResponse, PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody, PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse, PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody, PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse } from './interface/frictionless';
-import { HealthCheckControllerExecuteQuery, HealthCheckControllerExecuteResponse, GetPaymentListByBrandQuery, GetPaymentListByBrandResponse, GetCustomerOrdersQuery, GetCustomerOrdersResponse, PostReviewOrderItemsBody, PostReviewOrderItemsResponse, PostHomePageBody, PostHomePageResponse } from './interface/consumer';
+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, PostAiImageGenerateBody, PostAiImageGenerateResponse, PostAiTranslateBody, PostAiTranslateResponse } from './interface/ai';
-import { PostCentricosAiItemDescriptionBody, PostCentricosAiItemDescriptionResponse, PostCentricosAiItemImageBody, PostCentricosAiItemImageResponse, PostCentricosOrdersExportQuery, PostCentricosOrdersExportResponse, GetCentricosReportGroupConfigQuery, GetCentricosReportGroupConfigResponse, PutCentricosReportGroupConfigBody, PutCentricosReportGroupConfigResponse, DeleteCentricosReportGroupConfigResponse, GetCentricosReportConfigDefaultQuery, GetCentricosReportConfigDefaultResponse, GetCentricosLookerEmbedurlQuery, GetCentricosLookerEmbedurlResponse, GetSiteDevicesQuery, GetSiteDevicesResponse, GetCentricosSitesQuery, GetCentricosSitesResponse, GetReviewOrderItemsQuery, GetReviewOrderItemsResponse, GetCentricosStationQuery, GetCentricosStationResponse, PutDiscountVoucherifyBody, PutDiscountVoucherifyResponse, PutDiscountVoucherifyPublishBody, PutDiscountVoucherifyPublishResponse } from './interface/centricos';
+import { PostCentricosAiItemDescriptionBody, PostCentricosAiItemDescriptionResponse, PostCentricosAiItemImageBody, PostCentricosAiItemImageResponse, PostCentricosOrdersExportQuery, PostCentricosOrdersExportResponse, GetCentricosReportGroupConfigQuery, GetCentricosReportGroupConfigResponse, PutCentricosReportGroupConfigBody, PutCentricosReportGroupConfigResponse, DeleteCentricosReportGroupConfigResponse, GetCentricosReportConfigDefaultQuery, GetCentricosReportConfigDefaultResponse, GetCentricosLookerEmbedurlQuery, GetCentricosLookerEmbedurlResponse, GetSiteDevicesQuery, GetSiteDevicesResponse, GetCentricosSitesQuery, GetCentricosSitesResponse, GetSitesFromPriceLevelQuery, GetSitesFromPriceLevelResponse, GetReviewOrderItemsQuery, GetReviewOrderItemsResponse, GetCentricosStationQuery, GetCentricosStationResponse, PutCentricosDiscountVoucherifyBody, PutCentricosDiscountVoucherifyResponse, PutCentricosDiscountVoucherifyPublishResponse, DeleteCentricosDiscountsVoucherifyResponse, GetCentricosDiscountQuery, GetCentricosDiscountResponse } from './interface/centricos';
 import { TaxHealthCheckQuery, TaxHealthCheckResponse, PostQuoteTaxBody, PostQuoteTaxResponse } from './interface/tax';
 import { GetSearchOrderQuery, GetSearchOrderResponse, GetSearchLocationQuery, GetSearchLocationResponse } from './interface/search';
 import { PostAuthFlowBody, PostAuthFlowResponse, GetAuthSsoConfigsQuery, GetAuthSsoConfigsResponse, PostAuthSsoConfigBody, PostAuthSsoConfigResponse, PutAuthSsoConfigBody, PutAuthSsoConfigResponse, DeleteAuthSsoConfigResponse, PostAuthSsoBody, PostAuthSsoResponse, PostAuthSsoExchangeBody, PostAuthSsoExchangeResponse, GetAuthSsoExchangeQuery, GetAuthSsoExchangeResponse } from './interface/auth';
@@ -1135,6 +1135,13 @@ export declare class ServiceClient extends BaseServiceClient {
      * @param options - additional request options
      */
     post_promo_validate_voucher(body: PostPromoValidateVoucherBody, options?: RequestOptions): ResponsePromise<PostPromoValidateVoucherResponse>;
+    /**
+     * 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>;
     /**
      * POST /promo/redeem/voucher - Redeem a promo voucher
      *
@@ -1142,6 +1149,13 @@ export declare class ServiceClient extends BaseServiceClient {
      * @param options - additional request options
      */
     post_promo_redeem_voucher(body: PostPromoRedeemVoucherBody, options?: RequestOptions): ResponsePromise<PostPromoRedeemVoucherResponse>;
+    /**
+     * 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>;
     /**
      * POST /promo/voucher - Create new voucher
      *
@@ -4228,6 +4242,71 @@ export declare class ServiceClient extends BaseServiceClient {
      * @param options - additional request options
      */
     post_home_page(body: PostHomePageBody, options?: RequestOptions): ResponsePromise<PostHomePageResponse>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * POST /consumer/forgotpassword - Forgot password
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_consumer_forgot_password(body: PostConsumerForgotPasswordBody, options?: RequestOptions): ResponsePromise<PostConsumerForgotPasswordResponse>;
+    /**
+     * POST /consumer/secret - Add user secret
+     *
+     * @param options - additional request options
+     */
+    post_consumer_add_secret(options?: RequestOptions): ResponsePromise<PostConsumerAddSecretResponse>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
+    /**
+     * 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>;
     /**
      * POST /ai/language/generate - Generate text from a given prompt
      *
@@ -4274,7 +4353,7 @@ export declare 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(location_group: string, options?: {
@@ -4283,7 +4362,7 @@ export declare 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
      */
@@ -4291,14 +4370,14 @@ export declare 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(location_group: string, options?: RequestOptions): ResponsePromise<DeleteCentricosReportGroupConfigResponse>;
     /**
      * 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(location_group: string, options?: {
@@ -4329,6 +4408,15 @@ export declare class ServiceClient extends BaseServiceClient {
     get_centricos_sites(options: {
         query: GetCentricosSitesQuery;
     } & RequestOptions): ResponsePromise<GetCentricosSitesResponse>;
+    /**
+     * 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>;
     /**
      * GET /centricos/review/{orderId}/order-items - Get reviews for items in a given order in an array format
      *
@@ -4341,7 +4429,7 @@ export declare 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(station_id: string, options?: {
@@ -4353,15 +4441,30 @@ export declare class ServiceClient extends BaseServiceClient {
      * @param body
      * @param options - additional request options
      */
-    put_discount_voucherify(body: PutDiscountVoucherifyBody, options?: RequestOptions): ResponsePromise<PutDiscountVoucherifyResponse>;
+    put_centricos_discount_voucherify(body: PutCentricosDiscountVoucherifyBody, options?: RequestOptions): ResponsePromise<PutCentricosDiscountVoucherifyResponse>;
     /**
      * 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(id: string, body: PutDiscountVoucherifyPublishBody, options?: RequestOptions): ResponsePromise<PutDiscountVoucherifyPublishResponse>;
+    put_centricos_discount_voucherify_publish(id: string, options?: RequestOptions): ResponsePromise<PutCentricosDiscountVoucherifyPublishResponse>;
+    /**
+     * 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>;
+    /**
+     * 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>;
     /**
      * GET /tax/v1/health-check - Health Check
      *
@@ -4480,7 +4583,7 @@ export declare class ServiceClient extends BaseServiceClient {
     /**
      * GET /discount/{id} - Get a discount
      *
-     * @param id
+     * @param id - a discount id
      * @param options - additional request options
      */
     get_discount(id: string, options?: {