@compassdigital/sdk.typescript 4.739.0 → 4.740.0

package/lib/index.d.ts

@@ -21,7 +21,7 @@ import { GetNotificationsQuery, GetNotificationsResponse, PostNotificationBody,
 import { GetCompassconnectOmsTokenQuery, GetCompassconnectOmsTokenResponse } from './interface/compassconnect';
 import { PostVendorApplicationBody, PostVendorApplicationResponse, GetVendorApplicationsQuery, GetVendorApplicationsResponse, GetVendorApplicationResponse, PatchVendorApplicationBody, PatchVendorApplicationResponse, DeleteVendorApplicationResponse, PostVendorQuery, PostVendorBody, PostVendorResponse, GetVendorsResponse, GetVendorResponse, PatchVendorBody, PatchVendorResponse, DeleteVendorResponse, GetVendorAuthResponse, GetVendorKeysQuery, GetVendorKeysResponse, PostVendorKeyBody, PostVendorKeyResponse, GetVendorKeyResponse, PatchVendorKeyBody, PatchVendorKeyResponse, DeleteVendorKeyResponse, PostVendorKeyRotateQuery, PostVendorKeyRotateResponse, PostVendorResetPasswordBody, PostVendorResetPasswordResponse } from './interface/vendor';
 import { GetFrictionlessBrandFrictionlessStatusResponse, PostFrictionlessQrCodeBody, PostFrictionlessQrCodeResponse, GetFrictionlessCheckinStatusResponse, GetFrictionlessCheckinResponse, GetFrictionlessUsersPaymentIssuesResponse, GetFrictionlessFailedCheckinsResponse, PostFrictionlessCheckinsReprocessResponse, PostFrictionlessCheckinReprocessPaymentBody, PostFrictionlessCheckinReprocessPaymentResponse, PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody, PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse, PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody, PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse } from './interface/frictionless';
-import { HealthCheckControllerExecuteResponse, GetPaymentListByBrandQuery, GetPaymentListByBrandResponse, GetCustomerOrdersQuery, GetCustomerOrdersResponse, GetCustomerOrdersV2Query, GetCustomerOrdersV2Response, PostConsumerOrderBody, PostConsumerOrderResponse, PatchConsumerOrderCancelBody, PatchConsumerOrderCancelResponse, PostReviewOrderItemsBody, PostReviewOrderItemsResponse, GetConsumerHomePageQuery, GetConsumerHomePageResponse, GetConsumerHomePageV2Query, GetConsumerHomePageV2Response, GetConsumerFrictionlessCheckinResponse, PostFrictionlessQrcodeBody, PostFrictionlessQrcodeResponse, PostConsumerV2FrictionlessQrcodeBody, PostConsumerV2FrictionlessQrcodeResponse, PostConsumerForgotPasswordBody, PostConsumerForgotPasswordResponse, PostConsumerV2ForgotPasswordQuery, PostConsumerV2ForgotPasswordBody, PostConsumerV2ForgotPasswordResponse, PostConsumerAddSecretBody, PostConsumerAddSecretResponse, GetConsumerLocationGroupQuery, GetConsumerLocationGroupResponse$0, GetConsumerLocationMultigroupQuery, GetConsumerLocationMultigroupResponse, GetConsumerClientGroupsQuery, GetConsumerClientGroupsResponse$0, GetConsumerActiveMenusQuery, GetConsumerActiveMenusResponse, GetConsumerMenuRecommendedItemsQuery, GetConsumerMenuRecommendedItemsResponse$0, GetConsumerAllergensListResponse, GetConsumerMenuResponse, GetConsumerMenuV2Response, GetConsumerMenuItemsQuery, GetConsumerMenuItemsResponse$0, PostConsumerLocationsMarketplaceTimeslotsQuery, PostConsumerLocationsMarketplaceTimeslotsResponse, PostConsumerLocationsMarketplaceTimeslotsDeliveryQuery, PostConsumerLocationsMarketplaceTimeslotsDeliveryResponse, DeleteConsumerUserQuery, DeleteConsumerUserResponse, PutConsumerUserBody, PutConsumerUserResponse$0, PatchConsumerUserBody, PatchConsumerUserResponse$0, GetConsumerUserResponse$0, DeleteConsumerLogoutResponse, PostConsumerChangePasswordBody, PostConsumerChangePasswordResponse, GetPaymentCashlessConsumerResponse, PostPaymentCashlessConsumerBody, PostPaymentCashlessConsumerResponse, GetPaymentClienttokenConsumerQuery, GetPaymentClienttokenConsumerResponse, GetPaymentHpcConsumerQuery, GetPaymentHpcConsumerResponse, GetPaymentTokenConsumerQuery, GetPaymentTokenConsumerResponse, PostConsumerPaymentTokenBody$0, PostConsumerPaymentTokenResponse$0, GetConsumerShoppingcartResponse, PutConsumerShoppingcartBody, PutConsumerShoppingcartResponse, DeleteConsumerShoppingcartBody, DeleteConsumerShoppingcartResponse, PatchConsumerShoppingcartBody, PatchConsumerShoppingcartResponse, PutConsumerShoppingcartPaymentBody, PutConsumerShoppingcartPaymentResponse, PostConsumerShoppingcartRecommendedItemsBody, PostConsumerShoppingcartRecommendedItemsResponse, PostConsumerShoppingcartBody, PostConsumerShoppingcartResponse, PostConsumerPromoValidateBody, PostConsumerPromoValidateResponse, PostConsumerPromoRedeemBody, PostConsumerPromoRedeemResponse, PutConsumerUserMealplanResponse, GetMealplanConsumerResponse, PostMealplanConsumerBody, PostMealplanConsumerResponse, PutConsumerMealplanBody, PutConsumerMealplanResponse, DeleteMealplanConsumerBody, DeleteMealplanConsumerResponse, GetMealplanBarcodeConsumerResponse, PostMealplanVerifyConsumerBody, PostMealplanVerifyConsumerResponse, GetConsumerConfigAppconfigResponse, PatchCheckinConsumerOrderResponse, GetConsumerAppThemeResponse, GetConsumerBrandMenuTimeslotsQuery, GetConsumerBrandMenuTimeslotsResponse, GetConsumerBrandMenuDeliveryTimeslotsQuery, GetConsumerBrandMenuDeliveryTimeslotsResponse, GetConsumerConfigPublicResponse$0, PutConsumerShoppingcartPromoBody, PutConsumerShoppingcartPromoResponse, DeleteConsumerShoppingcartPromoResponse, PutConsumerShoppingcartCheckoutResponse, GetConsumerStationDiscountsResponse, PostConsumerShoppingcartCloneBody, PostConsumerShoppingcartCloneResponse, GetConsumerLocationBrandQuery, GetConsumerLocationBrandResponse, PostConsumerCustomerRewardsQuery, PostConsumerCustomerRewardsBody, PostConsumerCustomerRewardsResponse, PostConsumerSendEmailVerificationResponse, PostConsumerUserCreateQuery, PostConsumerUserCreateBody, PostConsumerUserCreateResponse, PostConsumerUserGuestTokenBody, PostConsumerUserGuestTokenResponse$0, PostConsumerUserGuestBody, PostConsumerUserGuestResponse$0, PostConsumerOpenaiChatBody, PostConsumerOpenaiChatResponse, PostPaymentValidateMerchantBody$0, PostPaymentValidateMerchantResponse$0, GetConsumerReviewOrderItemsQuery, GetConsumerReviewOrderItemsResponse, PostConsumerShoppingcartBulkBody, PostConsumerShoppingcartBulkResponse, ConsumerPostExternalExchangeLoginCodeBody, ConsumerPostExternalExchangeLoginCodeResponse, GetConsumerUserMealplanBarcodeResponse, GetConsumerLocationQuery, GetConsumerLocationResponse$0, PostConsumerDeliveryOrderOpenLidResponse, PostConsumerDeliveryOrderCloseLidResponse } from './interface/consumer';
+import { HealthCheckControllerExecuteResponse, GetPaymentListByBrandQuery, GetPaymentListByBrandResponse, GetCustomerOrdersQuery, GetCustomerOrdersResponse, GetCustomerOrdersV2Query, GetCustomerOrdersV2Response, PostConsumerOrderBody, PostConsumerOrderResponse, PatchConsumerOrderCancelBody, PatchConsumerOrderCancelResponse, PostReviewOrderItemsBody, PostReviewOrderItemsResponse, GetConsumerHomePageQuery, GetConsumerHomePageResponse, GetConsumerHomePageV2Query, GetConsumerHomePageV2Response, GetConsumerHomePageV3Query, GetConsumerHomePageV3Response, GetConsumerFrictionlessCheckinResponse, PostFrictionlessQrcodeBody, PostFrictionlessQrcodeResponse, PostConsumerV2FrictionlessQrcodeBody, PostConsumerV2FrictionlessQrcodeResponse, PostConsumerForgotPasswordBody, PostConsumerForgotPasswordResponse, PostConsumerV2ForgotPasswordQuery, PostConsumerV2ForgotPasswordBody, PostConsumerV2ForgotPasswordResponse, PostConsumerAddSecretBody, PostConsumerAddSecretResponse, GetConsumerLocationGroupQuery, GetConsumerLocationGroupResponse$0, GetConsumerLocationMultigroupQuery, GetConsumerLocationMultigroupResponse, GetConsumerClientGroupsQuery, GetConsumerClientGroupsResponse$0, GetConsumerActiveMenusQuery, GetConsumerActiveMenusResponse, GetConsumerMenuRecommendedItemsQuery, GetConsumerMenuRecommendedItemsResponse$0, GetConsumerAllergensListResponse, GetConsumerMenuResponse, GetConsumerMenuV2Response, GetConsumerMenuItemsQuery, GetConsumerMenuItemsResponse$0, PostConsumerLocationsMarketplaceTimeslotsQuery, PostConsumerLocationsMarketplaceTimeslotsResponse, PostConsumerLocationsMarketplaceTimeslotsDeliveryQuery, PostConsumerLocationsMarketplaceTimeslotsDeliveryResponse, DeleteConsumerUserQuery, DeleteConsumerUserResponse, PutConsumerUserBody, PutConsumerUserResponse$0, PatchConsumerUserBody, PatchConsumerUserResponse$0, GetConsumerUserResponse$0, DeleteConsumerLogoutResponse, PostConsumerChangePasswordBody, PostConsumerChangePasswordResponse, GetPaymentCashlessConsumerResponse, PostPaymentCashlessConsumerBody, PostPaymentCashlessConsumerResponse, GetPaymentClienttokenConsumerQuery, GetPaymentClienttokenConsumerResponse, GetPaymentHpcConsumerQuery, GetPaymentHpcConsumerResponse, GetPaymentTokenConsumerQuery, GetPaymentTokenConsumerResponse, PostConsumerPaymentTokenBody$0, PostConsumerPaymentTokenResponse$0, GetConsumerShoppingcartResponse, PutConsumerShoppingcartBody, PutConsumerShoppingcartResponse, DeleteConsumerShoppingcartBody, DeleteConsumerShoppingcartResponse, PatchConsumerShoppingcartBody, PatchConsumerShoppingcartResponse, PutConsumerShoppingcartPaymentBody, PutConsumerShoppingcartPaymentResponse, PostConsumerShoppingcartRecommendedItemsBody, PostConsumerShoppingcartRecommendedItemsResponse, PostConsumerShoppingcartBody, PostConsumerShoppingcartResponse, PostConsumerPromoValidateBody, PostConsumerPromoValidateResponse, PostConsumerPromoRedeemBody, PostConsumerPromoRedeemResponse, PutConsumerUserMealplanResponse, GetMealplanConsumerResponse, PostMealplanConsumerBody, PostMealplanConsumerResponse, PutConsumerMealplanBody, PutConsumerMealplanResponse, DeleteMealplanConsumerBody, DeleteMealplanConsumerResponse, GetMealplanBarcodeConsumerResponse, PostMealplanVerifyConsumerBody, PostMealplanVerifyConsumerResponse, GetConsumerConfigAppconfigResponse, PatchCheckinConsumerOrderResponse, GetConsumerAppThemeResponse, GetConsumerBrandMenuTimeslotsQuery, GetConsumerBrandMenuTimeslotsResponse, GetConsumerBrandMenuDeliveryTimeslotsQuery, GetConsumerBrandMenuDeliveryTimeslotsResponse, GetConsumerConfigPublicResponse$0, PutConsumerShoppingcartPromoBody, PutConsumerShoppingcartPromoResponse, DeleteConsumerShoppingcartPromoResponse, PutConsumerShoppingcartCheckoutResponse, GetConsumerStationDiscountsResponse, PostConsumerShoppingcartCloneBody, PostConsumerShoppingcartCloneResponse, GetConsumerLocationBrandQuery, GetConsumerLocationBrandResponse, PostConsumerCustomerRewardsQuery, PostConsumerCustomerRewardsBody, PostConsumerCustomerRewardsResponse, PostConsumerSendEmailVerificationResponse, PostConsumerUserCreateQuery, PostConsumerUserCreateBody, PostConsumerUserCreateResponse, PostConsumerUserGuestTokenBody, PostConsumerUserGuestTokenResponse$0, PostConsumerUserGuestBody, PostConsumerUserGuestResponse$0, PostConsumerOpenaiChatBody, PostConsumerOpenaiChatResponse, PostPaymentValidateMerchantBody$0, PostPaymentValidateMerchantResponse$0, GetConsumerReviewOrderItemsQuery, GetConsumerReviewOrderItemsResponse, PostConsumerShoppingcartBulkBody, PostConsumerShoppingcartBulkResponse, ConsumerPostExternalExchangeLoginCodeBody, ConsumerPostExternalExchangeLoginCodeResponse, GetConsumerUserMealplanBarcodeResponse, GetConsumerLocationQuery, GetConsumerLocationResponse$0, PostConsumerDeliveryOrderOpenLidResponse, PostConsumerDeliveryOrderCloseLidResponse } from './interface/consumer';
 import { PostAiLanguageGenerateBody, PostAiLanguageGenerateResponse, PostAiImageGenerateBody, PostAiImageGenerateResponse, PostAiTranslateBody, PostAiTranslateResponse } from './interface/ai';
 import { PostCentricosAiItemDescriptionBody, PostCentricosAiItemDescriptionResponse, PostCentricosAiItemImageBody, PostCentricosAiItemImageResponse, PostCentricosAiLanguageGenerateOrderSearchParamsBody, PostCentricosAiLanguageGenerateOrderSearchParamsResponse, PostCentricosOrdersExportQuery, PostCentricosOrdersExportResponse, GetCentricosReportGroupConfigResponse, PutCentricosReportGroupConfigBody, PutCentricosReportGroupConfigResponse, DeleteCentricosReportGroupConfigResponse, GetCentricosReportConfigDefaultResponse, GetCentricosLookerEmbedurlQuery, GetCentricosLookerEmbedurlResponse, GetSiteDevicesResponse, GetCentricosSitesQuery, GetCentricosSitesResponse, GetSitesFromPriceLevelQuery, GetSitesFromPriceLevelResponse, PostCentricosSiteBody, PostCentricosSiteResponse, PostCentricosSitesBatchBody, PostCentricosSitesBatchResponse, GetCentricosSiteResponse, GetCentricosSiteMenuHoursDetailsResponse, GetReviewOrderItemsResponse, GetYesterdaysSnapshotResponse, GetCentricosStationResponse, DeleteCentricosStationResponse, PutCentricosStationIntegrationResponse, DeleteCentricosStationIntegrationResponse, PutCentricosDiscountVoucherifyBody, PutCentricosDiscountVoucherifyResponse, PutCentricosDiscountVoucherifyPublishResponse, DeleteCentricosDiscountsVoucherifyResponse, GetCentricosDiscountResponse, GetCentricosDiscountsQuery, GetCentricosDiscountsResponse, GetCentricosDiscountsSitesQuery, GetCentricosDiscountsSitesResponse, GetRecommendationsBySiteResponse, GetDescriptionRecommendationsQuery, GetDescriptionRecommendationsResponse, UpsertDescriptionRecommendationBody, UpsertDescriptionRecommendationResponse, PostCentricosBusinessUnitValidateVertexResponse, DeleteCentricosBusinessUnitResponse, GetCentricosMenuGlobalMenuGroupsQuery, GetCentricosMenuGlobalMenuGroupsResponse, PostCentricosMenuBrandItemsSearchBody, PostCentricosMenuBrandItemsSearchResponse, PostCentricosMenuStationItemsSearchBody, PostCentricosMenuStationItemsSearchResponse, PostCentricosMenuBrandsFetchBody, PostCentricosMenuBrandsFetchResponse, PostCentricosStationsMenusFetchBody, PostCentricosStationsMenusFetchResponse, ListSwapsBody, ListSwapsResponse, GetSwapDetailsResponse, GetCentricosGooglePlacesQuery, GetCentricosGooglePlacesResponse, GetCentricosRystEmbedConfigQuery, GetCentricosRystEmbedConfigResponse, GetCentricosTrendingCpgProductsResponse, GetCentricosUserLogsCsvResponse } from './interface/centricos';
 import { TaxHealthCheckResponse, PostQuoteTaxBody, PostQuoteTaxResponse } from './interface/tax';
@@ -5053,6 +5053,15 @@ export declare class ServiceClient extends BaseServiceClient {
     get_consumer_home_page_v2(siteId: string, options: {
         query: GetConsumerHomePageV2Query;
     } & RequestOptions): ResponsePromise<GetConsumerHomePageV2Response>;
+    /**
+     * GET /consumer/v3/home/{siteId} - Provide the front end all the data required to render the home page
+     *
+     * @param siteId - Site ID as Encoded CDL ID
+     * @param options - additional request options
+     */
+    get_consumer_home_page_v3(siteId: string, options: {
+        query: GetConsumerHomePageV3Query;
+    } & RequestOptions): ResponsePromise<GetConsumerHomePageV3Response>;
     /**
      * GET /consumer/frictionless/checkin/{id} - Allow a user to check in to a location using frictionless technology
      *