@compassdigital/sdk.typescript 4.598.0 → 4.600.0

package/lib/index.d.ts

@@ -29,6 +29,7 @@ import { GetSearchOrderQuery, GetSearchOrderResponse, GetSearchLocationQuery, Ge
 import { PostAuthFlowBody, PostAuthFlowResponse, GetAuthSsoConfigQuery, GetAuthSsoConfigResponse, GetAuthSsoConfigsResponse, PostAuthSsoConfigBody, PostAuthSsoConfigResponse, PutAuthSsoConfigBody, PutAuthSsoConfigResponse, DeleteAuthSsoConfigResponse, PostAuthSsoBody, PostAuthSsoResponse, PostAuthSsoExchangeBody, PostAuthSsoExchangeResponse, GetAuthSsoExchangeQuery, GetAuthSsoExchangeResponse, PostAuthJwtAssertionBody, PostAuthJwtAssertionResponse, GetAuthJwtAssertionJwkResponse } from './interface/auth';
 import { GetReviewsQuery, GetReviewsResponse, PostReviewBody, PostReviewResponse, GetReviewPingResponse, GetReviewHealthResponse, GetReviewResponse, DeleteReviewResponse } from './interface/review';
 import { DeleteDiscountResponse, GetDiscountResponse, PutDiscountBody, PutDiscountResponse, GetDiscountsQuery, GetDiscountsResponse, PostDiscountBody, PostDiscountResponse, GetDiscountHealthResponse, GetDiscountPingResponse, PostDiscountEventBody, PostDiscountEventResponse, PostRewardsQuery, PostRewardsBody, PostRewardsResponse, PostDiscountValidateDiscountsBody, PostDiscountValidateDiscountsResponse, PutDiscountPublishBody, PutDiscountPublishResponse } from './interface/discount';
+import { GetLoyaltyBundlesQuery, GetLoyaltyBundlesResponse, PostLoyaltyBundleBody, PostLoyaltyBundleResponse, GetLoyaltyBundleResponse, PatchLoyaltyBundleBody, PatchLoyaltyBundleResponse, DeleteLoyaltyBundleResponse, GetLoyaltyCampaignsQuery, GetLoyaltyCampaignsResponse, PostLoyaltyCampaignBody, PostLoyaltyCampaignResponse, GetLoyaltyCampaignResponse, PutLoyaltyCampaignBody, PutLoyaltyCampaignResponse, DeleteLoyaltyCampaignResponse, PatchLoyaltyCampaignStatusBody, PatchLoyaltyCampaignStatusResponse, PostLoyaltyCampaignCloneResponse, GetLoyaltyVouchersQuery, GetLoyaltyVouchersResponse, PostLoyaltyVoucherBody, PostLoyaltyVoucherResponse, GetLoyaltyVoucherResponse, PutLoyaltyVoucherBody, PutLoyaltyVoucherResponse, DeleteLoyaltyVoucherResponse, PostLoyaltyVoucherRevokeBody, PostLoyaltyVoucherRevokeResponse, PostLoyaltyVouchersBatchBody, PostLoyaltyVouchersBatchResponse, GetLoyaltyVoucherRedemptionsQuery, GetLoyaltyVoucherRedemptionsResponse, PostLoyaltyVouchersValidateBody, PostLoyaltyVouchersValidateResponse, PostLoyaltyVouchersRedeemBody, PostLoyaltyVouchersRedeemResponse, GetLoyaltySegmentsQuery, GetLoyaltySegmentsResponse, PostLoyaltySegmentBody, PostLoyaltySegmentResponse, GetLoyaltySegmentAttributesResponse, PostLoyaltySegmentPreviewCountBody, PostLoyaltySegmentPreviewCountResponse, GetLoyaltySegmentResponse, PatchLoyaltySegmentBody, PatchLoyaltySegmentResponse, DeleteLoyaltySegmentResponse, GetLoyaltySegmentMembersQuery, GetLoyaltySegmentMembersResponse, PostLoyaltySegmentMembersBody, PostLoyaltySegmentMembersResponse, DeleteLoyaltySegmentMembersBody, DeleteLoyaltySegmentMembersResponse, PostLoyaltyRedemptionRollbackBody, PostLoyaltyRedemptionRollbackResponse, GetLoyaltyRewardsQuery, GetLoyaltyRewardsResponse, PostLoyaltyRewardBody, PostLoyaltyRewardResponse, GetLoyaltyRewardResponse, PutLoyaltyRewardBody, PutLoyaltyRewardResponse, PatchLoyaltyRewardStatusBody, PatchLoyaltyRewardStatusResponse, GetLoyaltyRewardCardsQuery, GetLoyaltyRewardCardsResponse, GetLoyaltyRewardCardResponse, PostLoyaltyRewardCardAdjustBody, PostLoyaltyRewardCardAdjustResponse, PostLoyaltyRewardOrderEarnBody, PostLoyaltyRewardOrderEarnResponse } from './interface/loyalty';
 import { GetTimeslotsBrandQuery, GetTimeslotsBrandResponse, PostTimeslotsBrandsBody, PostTimeslotsBrandsResponse, PostTimeslotsBrandIncrementBody, PostTimeslotsBrandIncrementResponse } from './interface/timeslots';
 import { ProductionSheetControllerCreateSheetBody, ProductionSheetControllerCreateSheetResponse, ProductionSheetControllerGetProductionSheetPaginatedQuery, ProductionSheetControllerGetProductionSheetPaginatedResponse, ProductionSheetControllerGetScheduledMenuDataQuery, ProductionSheetControllerGetScheduledMenuDataResponse, ProductionSheetControllerSaveItemForecastDifferentialBody, ProductionSheetControllerSaveItemForecastDifferentialResponse, ProductionSheetControllerSendChatMessageBody, ProductionSheetControllerSendChatMessageResponse, ProductionSheetControllerSendChatFeedbackBody, ProductionSheetControllerSendChatFeedbackResponse, ProductionSheetControllerGetForecastMetaDataQuery, ProductionSheetControllerGetForecastMetaDataResponse, ProductionSheetControllerPingResponse, ProductionSheetControllerChatStreamBody, ProductionSheetControllerChatStreamResponse, GetForecastingHealthResponse } from './interface/forecasting';
 import { BaseServiceClient, RequestOptions, ResponsePromise } from './base';
@@ -5942,6 +5943,323 @@ export declare class ServiceClient extends BaseServiceClient {
      * @param options - additional request options
      */
     put_discount_publish(id: string, body: PutDiscountPublishBody, options?: RequestOptions): ResponsePromise<PutDiscountPublishResponse>;
+    /**
+     * GET /loyalty/bundles - List bundles with optional filters
+     *
+     * @param options - additional request options
+     */
+    get_loyalty_bundles(options?: {
+        query?: GetLoyaltyBundlesQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltyBundlesResponse>;
+    /**
+     * POST /loyalty/bundles - Create a new bundle
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_bundle(body: PostLoyaltyBundleBody, options?: RequestOptions): ResponsePromise<PostLoyaltyBundleResponse>;
+    /**
+     * GET /loyalty/bundles/{id} - Get bundle by ID with groups
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_bundle(id: string, options?: RequestOptions): ResponsePromise<GetLoyaltyBundleResponse>;
+    /**
+     * PATCH /loyalty/bundles/{id} - Update a bundle
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    patch_loyalty_bundle(id: string, body: PatchLoyaltyBundleBody, options?: RequestOptions): ResponsePromise<PatchLoyaltyBundleResponse>;
+    /**
+     * DELETE /loyalty/bundles/{id} - Soft-delete a bundle
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    delete_loyalty_bundle(id: string, options?: RequestOptions): ResponsePromise<DeleteLoyaltyBundleResponse>;
+    /**
+     * GET /loyalty/campaigns - List campaigns with filters and pagination
+     *
+     * @param options - additional request options
+     */
+    get_loyalty_campaigns(options?: {
+        query?: GetLoyaltyCampaignsQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltyCampaignsResponse>;
+    /**
+     * POST /loyalty/campaigns - Create a campaign with nested child entities
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_campaign(body: PostLoyaltyCampaignBody, options?: RequestOptions): ResponsePromise<PostLoyaltyCampaignResponse>;
+    /**
+     * GET /loyalty/campaigns/{id} - Get campaign detail with all child entities
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_campaign(id: string, options?: RequestOptions): ResponsePromise<GetLoyaltyCampaignResponse>;
+    /**
+     * PUT /loyalty/campaigns/{id} - Update a campaign and its child entities
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    put_loyalty_campaign(id: string, body: PutLoyaltyCampaignBody, options?: RequestOptions): ResponsePromise<PutLoyaltyCampaignResponse>;
+    /**
+     * DELETE /loyalty/campaigns/{id} - Soft-delete a campaign
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    delete_loyalty_campaign(id: string, options?: RequestOptions): ResponsePromise<DeleteLoyaltyCampaignResponse>;
+    /**
+     * PATCH /loyalty/campaigns/{id}/status - Transition campaign status
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    patch_loyalty_campaign_status(id: string, body: PatchLoyaltyCampaignStatusBody, options?: RequestOptions): ResponsePromise<PatchLoyaltyCampaignStatusResponse>;
+    /**
+     * POST /loyalty/campaigns/{id}/clone - Deep clone a campaign and all child entities
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    post_loyalty_campaign_clone(id: string, options?: RequestOptions): ResponsePromise<PostLoyaltyCampaignCloneResponse>;
+    /**
+     * GET /loyalty/vouchers - List vouchers with optional filters
+     *
+     * @param options - additional request options
+     */
+    get_loyalty_vouchers(options?: {
+        query?: GetLoyaltyVouchersQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltyVouchersResponse>;
+    /**
+     * POST /loyalty/vouchers - Create a single voucher
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_voucher(body: PostLoyaltyVoucherBody, options?: RequestOptions): ResponsePromise<PostLoyaltyVoucherResponse>;
+    /**
+     * GET /loyalty/vouchers/{id} - Get voucher by ID with campaign info and redemption count
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_voucher(id: string, options?: RequestOptions): ResponsePromise<GetLoyaltyVoucherResponse>;
+    /**
+     * PUT /loyalty/vouchers/{id} - Update a voucher
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    put_loyalty_voucher(id: string, body: PutLoyaltyVoucherBody, options?: RequestOptions): ResponsePromise<PutLoyaltyVoucherResponse>;
+    /**
+     * DELETE /loyalty/vouchers/{id} - Soft-delete a voucher
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    delete_loyalty_voucher(id: string, options?: RequestOptions): ResponsePromise<DeleteLoyaltyVoucherResponse>;
+    /**
+     * POST /loyalty/vouchers/{id}/revoke - Revoke a voucher with a required reason
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_voucher_revoke(id: string, body: PostLoyaltyVoucherRevokeBody, options?: RequestOptions): ResponsePromise<PostLoyaltyVoucherRevokeResponse>;
+    /**
+     * POST /loyalty/vouchers/batch - Batch generate voucher codes for a campaign
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_vouchers_batch(body: PostLoyaltyVouchersBatchBody, options?: RequestOptions): ResponsePromise<PostLoyaltyVouchersBatchResponse>;
+    /**
+     * GET /loyalty/vouchers/{id}/redemptions - Get redemption history for a voucher
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_voucher_redemptions(id: string, options?: {
+        query?: GetLoyaltyVoucherRedemptionsQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltyVoucherRedemptionsResponse>;
+    /**
+     * POST /loyalty/vouchers/validate - Validate one or more voucher codes
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_vouchers_validate(body: PostLoyaltyVouchersValidateBody, options?: RequestOptions): ResponsePromise<PostLoyaltyVouchersValidateResponse>;
+    /**
+     * POST /loyalty/vouchers/redeem - Redeem one or more voucher codes
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_vouchers_redeem(body: PostLoyaltyVouchersRedeemBody, options?: RequestOptions): ResponsePromise<PostLoyaltyVouchersRedeemResponse>;
+    /**
+     * GET /loyalty/segments - List segments with optional filters
+     *
+     * @param options - additional request options
+     */
+    get_loyalty_segments(options?: {
+        query?: GetLoyaltySegmentsQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltySegmentsResponse>;
+    /**
+     * POST /loyalty/segments - Create a new segment
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_segment(body: PostLoyaltySegmentBody, options?: RequestOptions): ResponsePromise<PostLoyaltySegmentResponse>;
+    /**
+     * GET /loyalty/segments/attributes - List available attributes for rule-based segments
+     *
+     * @param options - additional request options
+     */
+    get_loyalty_segment_attributes(options?: RequestOptions): ResponsePromise<GetLoyaltySegmentAttributesResponse>;
+    /**
+     * POST /loyalty/segments/preview-count - Preview how many customers match a segment rule
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_segment_preview_count(body: PostLoyaltySegmentPreviewCountBody, options?: RequestOptions): ResponsePromise<PostLoyaltySegmentPreviewCountResponse>;
+    /**
+     * GET /loyalty/segments/{id} - Get segment by ID
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_segment(id: string, options?: RequestOptions): ResponsePromise<GetLoyaltySegmentResponse>;
+    /**
+     * PATCH /loyalty/segments/{id} - Update a segment
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    patch_loyalty_segment(id: string, body: PatchLoyaltySegmentBody, options?: RequestOptions): ResponsePromise<PatchLoyaltySegmentResponse>;
+    /**
+     * DELETE /loyalty/segments/{id} - Soft-delete a segment
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    delete_loyalty_segment(id: string, options?: RequestOptions): ResponsePromise<DeleteLoyaltySegmentResponse>;
+    /**
+     * GET /loyalty/segments/{id}/members - List members of a static_list segment
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_segment_members(id: string, options?: {
+        query?: GetLoyaltySegmentMembersQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltySegmentMembersResponse>;
+    /**
+     * POST /loyalty/segments/{id}/members - Add members to a segment
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_segment_members(id: string, body: PostLoyaltySegmentMembersBody, options?: RequestOptions): ResponsePromise<PostLoyaltySegmentMembersResponse>;
+    /**
+     * DELETE /loyalty/segments/{id}/members - Remove members from a segment
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    delete_loyalty_segment_members(id: string, body: DeleteLoyaltySegmentMembersBody, options?: RequestOptions): ResponsePromise<DeleteLoyaltySegmentMembersResponse>;
+    /**
+     * POST /loyalty/redemptions/{id}/rollback - Roll back a redemption and restore the voucher
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_redemption_rollback(id: string, body: PostLoyaltyRedemptionRollbackBody, options?: RequestOptions): ResponsePromise<PostLoyaltyRedemptionRollbackResponse>;
+    /**
+     * GET /loyalty/rewards - List rewards with filters and pagination
+     *
+     * @param options - additional request options
+     */
+    get_loyalty_rewards(options?: {
+        query?: GetLoyaltyRewardsQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltyRewardsResponse>;
+    /**
+     * POST /loyalty/rewards - Create a reward with earning rules and milestones
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_reward(body: PostLoyaltyRewardBody, options?: RequestOptions): ResponsePromise<PostLoyaltyRewardResponse>;
+    /**
+     * GET /loyalty/rewards/{id} - Get reward detail with earning rules and milestones
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_reward(id: string, options?: RequestOptions): ResponsePromise<GetLoyaltyRewardResponse>;
+    /**
+     * PUT /loyalty/rewards/{id} - Update a reward and replace its earning rules and milestones
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    put_loyalty_reward(id: string, body: PutLoyaltyRewardBody, options?: RequestOptions): ResponsePromise<PutLoyaltyRewardResponse>;
+    /**
+     * PATCH /loyalty/rewards/{id}/status - Transition reward status
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    patch_loyalty_reward_status(id: string, body: PatchLoyaltyRewardStatusBody, options?: RequestOptions): ResponsePromise<PatchLoyaltyRewardStatusResponse>;
+    /**
+     * GET /loyalty/rewards/{id}/cards - List enrolled customer cards for a reward
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    get_loyalty_reward_cards(id: string, options?: {
+        query?: GetLoyaltyRewardCardsQuery;
+    } & RequestOptions): ResponsePromise<GetLoyaltyRewardCardsResponse>;
+    /**
+     * GET /loyalty/rewards/{id}/cards/{customerId} - Get card detail with transaction event history
+     *
+     * @param id
+     * @param customerId
+     * @param options - additional request options
+     */
+    get_loyalty_reward_card(id: string, customerId: string, options?: RequestOptions): ResponsePromise<GetLoyaltyRewardCardResponse>;
+    /**
+     * POST /loyalty/rewards/cards/{cardId}/adjust - Manual point adjustment on a reward card
+     *
+     * @param cardId
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_reward_card_adjust(cardId: string, body: PostLoyaltyRewardCardAdjustBody, options?: RequestOptions): ResponsePromise<PostLoyaltyRewardCardAdjustResponse>;
+    /**
+     * POST /loyalty/rewards/orders/earn - Evaluate an order against active reward rules and award points idempotently
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    post_loyalty_reward_order_earn(body: PostLoyaltyRewardOrderEarnBody, options?: RequestOptions): ResponsePromise<PostLoyaltyRewardOrderEarnResponse>;
     /**
      * GET /timeslots/brand/{brandId} - Get timeslots for brand
      *