@compassdigital/sdk.typescript 4.528.0 → 4.528.1-beta.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, GetReviewResponse, DeleteReviewResponse } from './interface/review';
 import { DeleteDiscountResponse, GetDiscountResponse, PutDiscountBody, PutDiscountResponse, GetDiscountsQuery, GetDiscountsResponse, PostDiscountBody, PostDiscountResponse, PostDiscountEventBody, PostDiscountEventResponse, PostRewardsQuery, PostRewardsBody, PostRewardsResponse, PutDiscountPublishBody, PutDiscountPublishResponse } from './interface/discount';
+import { BundleControllerFindAllQuery, BundleControllerFindAllResponse, BundleControllerCreateBody, BundleControllerCreateResponse, BundleControllerFindOneResponse, BundleControllerUpdateBody, BundleControllerUpdateResponse, BundleControllerRemoveResponse, CampaignControllerListQuery, CampaignControllerListResponse, CampaignControllerCreateBody, CampaignControllerCreateResponse, CampaignControllerFindOneResponse, CampaignControllerUpdateBody, CampaignControllerUpdateResponse, CampaignControllerRemoveResponse, CampaignControllerUpdateStatusBody, CampaignControllerUpdateStatusResponse, CampaignControllerCloneResponse, VoucherControllerFindAllQuery, VoucherControllerFindAllResponse, VoucherControllerCreateBody, VoucherControllerCreateResponse, VoucherControllerFindOneResponse, VoucherControllerUpdateBody, VoucherControllerUpdateResponse, VoucherControllerRemoveResponse, VoucherControllerRevokeBody, VoucherControllerRevokeResponse, VoucherControllerBatchGenerateBody, VoucherControllerBatchGenerateResponse, VoucherControllerFindRedemptionsQuery, VoucherControllerFindRedemptionsResponse, VoucherControllerValidateResponse, VoucherControllerRedeemResponse, SegmentControllerFindAllQuery, SegmentControllerFindAllResponse, SegmentControllerCreateBody, SegmentControllerCreateResponse, SegmentControllerGetAttributesResponse, SegmentControllerPreviewRuleCountResponse, SegmentControllerFindOneResponse, SegmentControllerUpdateBody, SegmentControllerUpdateResponse, SegmentControllerRemoveResponse, SegmentControllerFindMembersQuery, SegmentControllerFindMembersResponse, SegmentControllerAddMembersBody, SegmentControllerAddMembersResponse, SegmentControllerRemoveMembersBody, SegmentControllerRemoveMembersResponse, RedemptionControllerRollbackBody, RedemptionControllerRollbackResponse, LoyaltyControllerListProgramsQuery, LoyaltyControllerListProgramsResponse, LoyaltyControllerCreateProgramBody, LoyaltyControllerCreateProgramResponse, LoyaltyControllerFindOneProgramResponse, LoyaltyControllerUpdateProgramBody, LoyaltyControllerUpdateProgramResponse, LoyaltyControllerUpdateProgramStatusBody, LoyaltyControllerUpdateProgramStatusResponse, LoyaltyControllerListCardsQuery, LoyaltyControllerListCardsResponse, LoyaltyControllerFindCardResponse, LoyaltyControllerAdjustPointsBody, LoyaltyControllerAdjustPointsResponse } from './interface/loyalty';
 import { GetTimeslotsBrandQuery, GetTimeslotsBrandResponse, PostTimeslotsBrandsBody, PostTimeslotsBrandsResponse, PostTimeslotsBrandIncrementBody, PostTimeslotsBrandIncrementResponse } from './interface/timeslots';
 import { ProductionSheetControllerCreateSheetBody, ProductionSheetControllerCreateSheetResponse, ProductionSheetControllerGetScheduledMenuDataQuery, ProductionSheetControllerGetScheduledMenuDataResponse, ProductionSheetControllerSaveItemForecastDifferentialBody, ProductionSheetControllerSaveItemForecastDifferentialResponse, ProductionSheetControllerSendChatMessageBody, ProductionSheetControllerSendChatMessageResponse, ProductionSheetControllerSendChatFeedbackBody, ProductionSheetControllerSendChatFeedbackResponse, ProductionSheetControllerGetForecastMetaDataQuery, ProductionSheetControllerGetForecastMetaDataResponse, ProductionSheetControllerServiceStatusResponse, ProductionSheetControllerChatStreamBody, ProductionSheetControllerChatStreamResponse } from './interface/forecasting';
 import { BaseServiceClient, RequestOptions, ResponsePromise } from './base';
@@ -5744,6 +5745,313 @@ 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
+     */
+    BundleController_findAll(options?: {
+        query?: BundleControllerFindAllQuery;
+    } & RequestOptions): ResponsePromise<BundleControllerFindAllResponse>;
+    /**
+     * POST /loyalty/bundles - Create a new bundle
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    BundleController_create(body: BundleControllerCreateBody, options?: RequestOptions): ResponsePromise<BundleControllerCreateResponse>;
+    /**
+     * GET /loyalty/bundles/{id} - Get bundle by ID with groups
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    BundleController_findOne(id: string, options?: RequestOptions): ResponsePromise<BundleControllerFindOneResponse>;
+    /**
+     * PATCH /loyalty/bundles/{id} - Update a bundle
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    BundleController_update(id: string, body: BundleControllerUpdateBody, options?: RequestOptions): ResponsePromise<BundleControllerUpdateResponse>;
+    /**
+     * DELETE /loyalty/bundles/{id} - Soft-delete a bundle
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    BundleController_remove(id: string, options?: RequestOptions): ResponsePromise<BundleControllerRemoveResponse>;
+    /**
+     * GET /loyalty/campaigns - List campaigns with filters and pagination
+     *
+     * @param options - additional request options
+     */
+    CampaignController_list(options?: {
+        query?: CampaignControllerListQuery;
+    } & RequestOptions): ResponsePromise<CampaignControllerListResponse>;
+    /**
+     * POST /loyalty/campaigns - Create a campaign with nested child entities
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    CampaignController_create(body: CampaignControllerCreateBody, options?: RequestOptions): ResponsePromise<CampaignControllerCreateResponse>;
+    /**
+     * GET /loyalty/campaigns/{id} - Get campaign detail with all child entities
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    CampaignController_findOne(id: string, options?: RequestOptions): ResponsePromise<CampaignControllerFindOneResponse>;
+    /**
+     * PUT /loyalty/campaigns/{id} - Update a campaign and its child entities
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    CampaignController_update(id: string, body: CampaignControllerUpdateBody, options?: RequestOptions): ResponsePromise<CampaignControllerUpdateResponse>;
+    /**
+     * DELETE /loyalty/campaigns/{id} - Soft-delete a campaign
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    CampaignController_remove(id: string, options?: RequestOptions): ResponsePromise<CampaignControllerRemoveResponse>;
+    /**
+     * PATCH /loyalty/campaigns/{id}/status - Transition campaign status
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    CampaignController_updateStatus(id: string, body: CampaignControllerUpdateStatusBody, options?: RequestOptions): ResponsePromise<CampaignControllerUpdateStatusResponse>;
+    /**
+     * POST /loyalty/campaigns/{id}/clone - Deep clone a campaign and all child entities
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    CampaignController_clone(id: string, options?: RequestOptions): ResponsePromise<CampaignControllerCloneResponse>;
+    /**
+     * GET /loyalty/vouchers - List vouchers with optional filters
+     *
+     * @param options - additional request options
+     */
+    VoucherController_findAll(options?: {
+        query?: VoucherControllerFindAllQuery;
+    } & RequestOptions): ResponsePromise<VoucherControllerFindAllResponse>;
+    /**
+     * POST /loyalty/vouchers - Create a single voucher
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    VoucherController_create(body: VoucherControllerCreateBody, options?: RequestOptions): ResponsePromise<VoucherControllerCreateResponse>;
+    /**
+     * GET /loyalty/vouchers/{id} - Get voucher by ID with campaign info and redemption count
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    VoucherController_findOne(id: string, options?: RequestOptions): ResponsePromise<VoucherControllerFindOneResponse>;
+    /**
+     * PUT /loyalty/vouchers/{id} - Update a voucher
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    VoucherController_update(id: string, body: VoucherControllerUpdateBody, options?: RequestOptions): ResponsePromise<VoucherControllerUpdateResponse>;
+    /**
+     * DELETE /loyalty/vouchers/{id} - Soft-delete a voucher
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    VoucherController_remove(id: string, options?: RequestOptions): ResponsePromise<VoucherControllerRemoveResponse>;
+    /**
+     * POST /loyalty/vouchers/{id}/revoke - Revoke a voucher with a required reason
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    VoucherController_revoke(id: string, body: VoucherControllerRevokeBody, options?: RequestOptions): ResponsePromise<VoucherControllerRevokeResponse>;
+    /**
+     * POST /loyalty/vouchers/batch - Batch generate voucher codes for a campaign
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    VoucherController_batchGenerate(body: VoucherControllerBatchGenerateBody, options?: RequestOptions): ResponsePromise<VoucherControllerBatchGenerateResponse>;
+    /**
+     * GET /loyalty/vouchers/{id}/redemptions - Get redemption history for a voucher
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    VoucherController_findRedemptions(id: string, options?: {
+        query?: VoucherControllerFindRedemptionsQuery;
+    } & RequestOptions): ResponsePromise<VoucherControllerFindRedemptionsResponse>;
+    /**
+     * POST /loyalty/vouchers/validate - Validate a voucher code (stub)
+     *
+     * @param options - additional request options
+     */
+    VoucherController_validate(options?: RequestOptions): ResponsePromise<VoucherControllerValidateResponse>;
+    /**
+     * POST /loyalty/vouchers/redeem - Redeem a voucher code (stub)
+     *
+     * @param options - additional request options
+     */
+    VoucherController_redeem(options?: RequestOptions): ResponsePromise<VoucherControllerRedeemResponse>;
+    /**
+     * GET /loyalty/segments - List segments with optional filters
+     *
+     * @param options - additional request options
+     */
+    SegmentController_findAll(options?: {
+        query?: SegmentControllerFindAllQuery;
+    } & RequestOptions): ResponsePromise<SegmentControllerFindAllResponse>;
+    /**
+     * POST /loyalty/segments - Create a new segment
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    SegmentController_create(body: SegmentControllerCreateBody, options?: RequestOptions): ResponsePromise<SegmentControllerCreateResponse>;
+    /**
+     * GET /loyalty/segments/attributes - List available attributes for rule-based segments
+     *
+     * @param options - additional request options
+     */
+    SegmentController_getAttributes(options?: RequestOptions): ResponsePromise<SegmentControllerGetAttributesResponse>;
+    /**
+     * POST /loyalty/segments/preview-count - Preview how many customers match a segment rule
+     *
+     * @param options - additional request options
+     */
+    SegmentController_previewRuleCount(options?: RequestOptions): ResponsePromise<SegmentControllerPreviewRuleCountResponse>;
+    /**
+     * GET /loyalty/segments/{id} - Get segment by ID
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    SegmentController_findOne(id: string, options?: RequestOptions): ResponsePromise<SegmentControllerFindOneResponse>;
+    /**
+     * PATCH /loyalty/segments/{id} - Update a segment
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    SegmentController_update(id: string, body: SegmentControllerUpdateBody, options?: RequestOptions): ResponsePromise<SegmentControllerUpdateResponse>;
+    /**
+     * DELETE /loyalty/segments/{id} - Soft-delete a segment
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    SegmentController_remove(id: string, options?: RequestOptions): ResponsePromise<SegmentControllerRemoveResponse>;
+    /**
+     * GET /loyalty/segments/{id}/members - List members of a static_list segment
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    SegmentController_findMembers(id: string, options?: {
+        query?: SegmentControllerFindMembersQuery;
+    } & RequestOptions): ResponsePromise<SegmentControllerFindMembersResponse>;
+    /**
+     * POST /loyalty/segments/{id}/members - Add members to a segment
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    SegmentController_addMembers(id: string, body: SegmentControllerAddMembersBody, options?: RequestOptions): ResponsePromise<SegmentControllerAddMembersResponse>;
+    /**
+     * DELETE /loyalty/segments/{id}/members - Remove members from a segment
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    SegmentController_removeMembers(id: string, body: SegmentControllerRemoveMembersBody, options?: RequestOptions): ResponsePromise<SegmentControllerRemoveMembersResponse>;
+    /**
+     * POST /loyalty/redemptions/{id}/rollback - Roll back a redemption and restore the voucher
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    RedemptionController_rollback(id: string, body: RedemptionControllerRollbackBody, options?: RequestOptions): ResponsePromise<RedemptionControllerRollbackResponse>;
+    /**
+     * GET /loyalty/loyalty/programs - List loyalty programs with filters and pagination
+     *
+     * @param options - additional request options
+     */
+    LoyaltyController_listPrograms(options?: {
+        query?: LoyaltyControllerListProgramsQuery;
+    } & RequestOptions): ResponsePromise<LoyaltyControllerListProgramsResponse>;
+    /**
+     * POST /loyalty/loyalty/programs - Create a loyalty program with earning rules and milestones
+     *
+     * @param body
+     * @param options - additional request options
+     */
+    LoyaltyController_createProgram(body: LoyaltyControllerCreateProgramBody, options?: RequestOptions): ResponsePromise<LoyaltyControllerCreateProgramResponse>;
+    /**
+     * GET /loyalty/loyalty/programs/{id} - Get loyalty program detail with earning rules and milestones
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    LoyaltyController_findOneProgram(id: string, options?: RequestOptions): ResponsePromise<LoyaltyControllerFindOneProgramResponse>;
+    /**
+     * PUT /loyalty/loyalty/programs/{id} - Update a loyalty program and replace its earning rules and milestones
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    LoyaltyController_updateProgram(id: string, body: LoyaltyControllerUpdateProgramBody, options?: RequestOptions): ResponsePromise<LoyaltyControllerUpdateProgramResponse>;
+    /**
+     * PATCH /loyalty/loyalty/programs/{id}/status - Transition loyalty program status
+     *
+     * @param id
+     * @param body
+     * @param options - additional request options
+     */
+    LoyaltyController_updateProgramStatus(id: string, body: LoyaltyControllerUpdateProgramStatusBody, options?: RequestOptions): ResponsePromise<LoyaltyControllerUpdateProgramStatusResponse>;
+    /**
+     * GET /loyalty/loyalty/programs/{id}/cards - List enrolled customer cards for a program
+     *
+     * @param id
+     * @param options - additional request options
+     */
+    LoyaltyController_listCards(id: string, options?: {
+        query?: LoyaltyControllerListCardsQuery;
+    } & RequestOptions): ResponsePromise<LoyaltyControllerListCardsResponse>;
+    /**
+     * GET /loyalty/loyalty/programs/{id}/cards/{customerId} - Get card detail with transaction event history
+     *
+     * @param id
+     * @param customerId
+     * @param options - additional request options
+     */
+    LoyaltyController_findCard(id: string, customerId: string, options?: RequestOptions): ResponsePromise<LoyaltyControllerFindCardResponse>;
+    /**
+     * POST /loyalty/loyalty/cards/{cardId}/adjust - Manual point adjustment on a loyalty card
+     *
+     * @param cardId
+     * @param body
+     * @param options - additional request options
+     */
+    LoyaltyController_adjustPoints(cardId: string, body: LoyaltyControllerAdjustPointsBody, options?: RequestOptions): ResponsePromise<LoyaltyControllerAdjustPointsResponse>;
     /**
      * GET /timeslots/brand/{brandId} - Get timeslots for brand
      *