@compassdigital/sdk.typescript 4.787.0 → 4.789.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/lib/index.d.ts CHANGED
@@ -9,7 +9,7 @@ import { GetKdsDevicesQuery, GetKdsDevicesResponse, GetKdsDeviceLocationsQuery,
9
9
  import { PostMealplanBody, PostMealplanResponse, PutMealplanBody, PutMealplanResponse, GetMealplanQuery, GetMealplanResponse, DeleteMealplanBody, DeleteMealplanResponse, PostMealplanCallbackQuery, PostMealplanCallbackBody, PostMealplanCallbackResponse, GetMealplanBarcodeResponse, GetMealplanTenderResponse, DeleteMealplanTenderBody, DeleteMealplanTenderResponse, PatchMealplanTenderBody, PatchMealplanTenderResponse, PostMealplanVerifyQuery, PostMealplanVerifyBody, PostMealplanVerifyResponse, PutMealplanVerifyBody, PutMealplanVerifyResponse, PostMealplanAuthorizeBody, PostMealplanAuthorizeResponse, PostMealplanInternalTendersBody, PostMealplanInternalTendersResponse, PostMealplanInternalDebitBody, PostMealplanInternalDebitResponse, GetMealplanInstitutionsResponse, PostMealplanInternalRefundBody, PostMealplanInternalRefundResponse } from './interface/mealplan';
10
10
  import { PostDatalakeSqlBody, PostDatalakeSqlResponse, GetDatalakeSwaggerResponse } from './interface/datalake';
11
11
  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, PostPromoVoucherReverseStackableBody, PostPromoVoucherReverseStackableResponse, PostPromoVoucherifyActivityExecuteBody, PostPromoVoucherifyActivityExecuteResponse, GetPromoVoucherifyActivityConfigResponse, GetPromoPingResponse$0, GetPromoHealthResponse$0 } from './interface/promo';
12
- import { GetConfigAppconfigResponse, GetConfigResponse, PostConfigBody, PostConfigResponse, PutConfigBody, PutConfigResponse, DeleteConfigResponse, GetConfigPublicResponse, PostConfigPublicBody, PostConfigPublicResponse, PutConfigPublicBody, PutConfigPublicResponse, DeleteConfigPublicResponse, GetConfigHealthResponse, GetConfigPingResponse } from './interface/config';
12
+ import { GetConfigAppconfigResponse, GetConfigResponse, PostConfigBody, PostConfigResponse, PutConfigBody, PutConfigResponse, DeleteConfigResponse, GetConfigPublicResponse, PostConfigPublicBody, PostConfigPublicResponse, PutConfigPublicBody, PutConfigPublicResponse, DeleteConfigPublicResponse, PutConfigStationPrivateBody, PutConfigStationPrivateResponse, GetConfigHealthResponse, GetConfigPingResponse } from './interface/config';
13
13
  import { GetAnnouncementPingResponse$0, GetAnnouncementHealthResponse$0, PostAnnouncementQuery, PostAnnouncementBody, PostAnnouncementResponse, GetAnnouncementsQuery, GetAnnouncementsResponse, GetAnnouncementResponse, PutAnnouncementQuery, PutAnnouncementBody, PutAnnouncementResponse, PatchAnnouncementBody, PatchAnnouncementResponse, DeleteAnnouncementResponse } from './interface/announcement';
14
14
  import { GetReportAnalyticsGroupQuery, GetReportAnalyticsGroupResponse, GetReportAnalyticsCombinedGroupQuery, GetReportAnalyticsCombinedGroupResponse, GetReportEodGroupQuery, GetReportEodGroupResponse, GetReportEodGroupSubscribersResponse, PostReportEodGroupSubscribersBody, PostReportEodGroupSubscribersResponse, DeleteReportEodGroupSubscribersResponse, PutReportEodGroupSubscribersBody, PutReportEodGroupSubscribersResponse, GetReportEodGroupItemsQuery, GetReportEodGroupItemsResponse, PutReportGroupConfigBody, PutReportGroupConfigResponse, GetReportGroupConfigResponse, DeleteReportGroupConfigResponse, GetReportGroupConfigDefaultResponse } from './interface/report';
15
15
  import { GetUserAuthQuery, GetUserAuthResponse, PostUserAuthQuery, PostUserAuthBody, PostUserAuthResponse, PostUserOauthBody, PostUserOauthResponse, PostUserZendeskBody, PostUserZendeskResponse, PostUserQuery, PostUserBody, PostUserResponse, GetUserResponse, PutUserQuery, PutUserBody, PutUserResponse, PatchUserQuery, PatchUserBody, PatchUserResponse, DeleteUserResponse, PostUserKdsTokenBody, PostUserKdsTokenResponse, GetUserKdsTokenQuery, GetUserKdsTokenResponse, DeleteUserDeviceAuthResponse, PatchUserAuthKdsBody, PatchUserAuthKdsResponse, PostUserChangePasswordBody, PostUserChangePasswordResponse, GetUserLogsQuery, GetUserLogsResponse$0, DeleteUserLogoutResponse, PostUserAddSecretBody, PostUserAddSecretResponse, GetUserSecretQuery, GetUserSecretResponse, PostUserResetPasswordQuery, PostUserResetPasswordBody, PostUserResetPasswordResponse, PostUserResetPasswordTokenQuery, PostUserResetPasswordTokenBody, PostUserResetPasswordTokenResponse, GetUserRealmUsersQuery, GetUserRealmUsersResponse, GetUserPermissionsResponse, PutUserPermissionsBody, PutUserPermissionsResponse, GetUserScopesQuery, GetUserScopesResponse, PostUserCheckInBody, PostUserCheckInResponse, GetUserSearchCheckInQuery, GetUserSearchCheckInResponse, PostUserSendEmailVerificationResponse, PutUserVerifyUserEmailBody, PutUserVerifyUserEmailResponse, PostUserGuestUserBody, PostUserGuestUserResponse, PostUserGuestTokenBody, PostUserGuestTokenResponse, PostUserEmbedurlBody, PostUserEmbedurlResponse, GetUserProfileQuery, GetUserProfileResponse, GetUserPingResponse, GetUserHealthResponse } from './interface/user';
@@ -23,7 +23,7 @@ import { PostVendorApplicationBody, PostVendorApplicationResponse, GetVendorAppl
23
23
  import { GetFrictionlessBrandFrictionlessStatusResponse, PostFrictionlessQrCodeBody, PostFrictionlessQrCodeResponse, GetFrictionlessCheckinStatusResponse, GetFrictionlessCheckinResponse, GetFrictionlessUsersPaymentIssuesResponse, GetFrictionlessFailedCheckinsResponse, PostFrictionlessCheckinsReprocessResponse, PostFrictionlessCheckinReprocessPaymentBody, PostFrictionlessCheckinReprocessPaymentResponse, PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysBody, PostFrictionlessAmazonJwoConnectorV1IdentityIdentityKeysResponse, PostFrictionlessAmazonJwoConnectorV1OrderPurchasesBody, PostFrictionlessAmazonJwoConnectorV1OrderPurchasesResponse } from './interface/frictionless';
24
24
  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, GetConsumerDeliveryResponse, PostConsumerDeliveryOrderOpenLidResponse, PostConsumerDeliveryOrderCloseLidResponse } from './interface/consumer';
25
25
  import { PostAiLanguageGenerateBody, PostAiLanguageGenerateResponse, PostAiImageGenerateBody, PostAiImageGenerateResponse, PostAiTranslateBody, PostAiTranslateResponse } from './interface/ai';
26
- 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, PutCentricosStationIntegrationBody, 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';
26
+ 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, PutCentricosStationIntegrationBody, PutCentricosStationIntegrationResponse, DeleteCentricosStationIntegrationResponse, PutCentricosDiscountVoucherifyBody, PutCentricosDiscountVoucherifyResponse, PutCentricosDiscountVoucherifyPublishResponse, DeleteCentricosDiscountsVoucherifyResponse, GetCentricosDiscountResponse, GetCentricosDiscountsQuery, GetCentricosDiscountsResponse, GetCentricosDiscountsSitesQuery, GetCentricosDiscountsSitesResponse, GetRecommendationsBySiteResponse, GetDescriptionRecommendationsQuery, GetDescriptionRecommendationsResponse, UpsertDescriptionRecommendationBody, UpsertDescriptionRecommendationResponse, PostCentricosBusinessUnitValidateVertexResponse, DeleteCentricosBusinessUnitResponse, PutCentricosBusinessUnitDropOffBody, PutCentricosBusinessUnitDropOffResponse, GetCentricosMenuGlobalMenuGroupsQuery, GetCentricosMenuGlobalMenuGroupsResponse, PostCentricosMenuBrandItemsSearchBody, PostCentricosMenuBrandItemsSearchResponse, PostCentricosMenuStationItemsSearchBody, PostCentricosMenuStationItemsSearchResponse, PostCentricosMenuBrandsFetchBody, PostCentricosMenuBrandsFetchResponse, PostCentricosStationsMenusFetchBody, PostCentricosStationsMenusFetchResponse, ListSwapsBody, ListSwapsResponse, GetSwapDetailsResponse, GetCentricosGooglePlacesQuery, GetCentricosGooglePlacesResponse, GetCentricosRystEmbedConfigQuery, GetCentricosRystEmbedConfigResponse, GetCentricosTrendingCpgProductsResponse, GetCentricosUserLogsCsvResponse } from './interface/centricos';
27
27
  import { TaxHealthCheckResponse, PostQuoteTaxBody, PostQuoteTaxResponse } from './interface/tax';
28
28
  import { GetSearchOrderQuery, GetSearchOrderResponse, GetSearchLocationQuery, GetSearchLocationResponse, GetSearchUserQuery, GetSearchUserResponse, GetSearchDiscountsQuery, GetSearchDiscountsResponse } from './interface/search';
29
29
  import { PostAuthFlowBody, PostAuthFlowResponse, GetAuthSsoConfigQuery, GetAuthSsoConfigResponse, GetAuthSsoConfigsResponse, PostAuthSsoConfigBody, PostAuthSsoConfigResponse, PutAuthSsoConfigBody, PutAuthSsoConfigResponse, DeleteAuthSsoConfigResponse, PostAuthSsoBody, PostAuthSsoResponse, PostAuthSsoExchangeBody, PostAuthSsoExchangeResponse, GetAuthSsoExchangeQuery, GetAuthSsoExchangeResponse, PostAuthJwtAssertionBody, PostAuthJwtAssertionResponse, GetAuthJwtAssertionJwkResponse, GetAuthConnectProviderAuthorizeQuery, GetAuthConnectProviderAuthorizeResponse, PostAuthConnectProviderConfigBody, PostAuthConnectProviderConfigResponse, PutAuthConnectProviderConfigBody, PutAuthConnectProviderConfigResponse, GetAuthConnectProviderConfigQuery, GetAuthConnectProviderConfigResponse, DeleteAuthConnectProviderConfigQuery, DeleteAuthConnectProviderConfigResponse, GetAuthConnectProvidersResponse, PostAuthTokenBody, PostAuthTokenResponse, PostAuthOauthClientsBody, PostAuthOauthClientsResponse, GetAuthOauthClientsResponse, PutAuthOauthClientBody, PutAuthOauthClientResponse, GetAuthOauthClientResponse, DeleteAuthOauthClientResponse, GetAuthOpenidConfigurationResponse, PostAuthOidcRegisterBody, PostAuthOidcRegisterResponse, GetAuthAuthorizeQuery, GetAuthAuthorizeResponse, GetAuthAuthorizeRequestResponse, PostAuthAuthorizeLoginBody, PostAuthAuthorizeLoginResponse, PostAuthAuthorizeSsoBody, PostAuthAuthorizeSsoResponse } from './interface/auth';
@@ -1531,6 +1531,14 @@ export declare class ServiceClient extends BaseServiceClient {
1531
1531
  * @param options - additional request options
1532
1532
  */
1533
1533
  delete_config_public(key: string, options?: RequestOptions): ResponsePromise<DeleteConfigPublicResponse>;
1534
+ /**
1535
+ * PUT /config/station/{id}/private - Update a station's private configuration
1536
+ *
1537
+ * @param id - station id (a location/brand id)
1538
+ * @param body
1539
+ * @param options - additional request options
1540
+ */
1541
+ put_config_station_private(id: string, body: PutConfigStationPrivateBody, options?: RequestOptions): ResponsePromise<PutConfigStationPrivateResponse>;
1534
1542
  /**
1535
1543
  * GET /config/health - Config Service readiness and dependency health check
1536
1544
  *
@@ -5913,6 +5921,14 @@ export declare class ServiceClient extends BaseServiceClient {
5913
5921
  * @param options - additional request options
5914
5922
  */
5915
5923
  delete_centricos_business_unit(bu_id: string, options?: RequestOptions): ResponsePromise<DeleteCentricosBusinessUnitResponse>;
5924
+ /**
5925
+ * PUT /centricos/business-unit/{bu_id}/drop-off - Update shared drop-off settings for a business unit
5926
+ *
5927
+ * @param bu_id - TODO: cannot use CompassLongID as path parameter
5928
+ * @param body
5929
+ * @param options - additional request options
5930
+ */
5931
+ put_centricos_business_unit_drop_off(bu_id: string, body: PutCentricosBusinessUnitDropOffBody, options?: RequestOptions): ResponsePromise<PutCentricosBusinessUnitDropOffResponse>;
5916
5932
  /**
5917
5933
  * GET /centricos/menu/global-menu-groups - Get a paginated list of global menu groups with filtering, sorting, and relationships
5918
5934
  *