@munchi_oy/core 1.9.128 → 1.9.129
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/dist/generated/api.d.ts +1053 -20
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +1249 -0
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2799,6 +2799,48 @@ export interface ClockOutRequestDto {
|
|
|
2799
2799
|
*/
|
|
2800
2800
|
'employeeId': string;
|
|
2801
2801
|
}
|
|
2802
|
+
/**
|
|
2803
|
+
*
|
|
2804
|
+
* @export
|
|
2805
|
+
* @interface CompleteOrderDto
|
|
2806
|
+
*/
|
|
2807
|
+
export interface CompleteOrderDto {
|
|
2808
|
+
/**
|
|
2809
|
+
* Collection the order is stored in
|
|
2810
|
+
* @type {string}
|
|
2811
|
+
* @memberof CompleteOrderDto
|
|
2812
|
+
*/
|
|
2813
|
+
'orderCollection': OrderCollectionEnum;
|
|
2814
|
+
}
|
|
2815
|
+
export declare const OrderCollectionEnum: {
|
|
2816
|
+
readonly Kiosk: "kiosk";
|
|
2817
|
+
};
|
|
2818
|
+
export type OrderCollectionEnum = typeof OrderCollectionEnum[keyof typeof OrderCollectionEnum];
|
|
2819
|
+
/**
|
|
2820
|
+
*
|
|
2821
|
+
* @export
|
|
2822
|
+
* @interface CompleteOrderResponseDto
|
|
2823
|
+
*/
|
|
2824
|
+
export interface CompleteOrderResponseDto {
|
|
2825
|
+
/**
|
|
2826
|
+
* Id of the completed order
|
|
2827
|
+
* @type {string}
|
|
2828
|
+
* @memberof CompleteOrderResponseDto
|
|
2829
|
+
*/
|
|
2830
|
+
'orderId': string;
|
|
2831
|
+
/**
|
|
2832
|
+
* The order is completed whenever this answers 200
|
|
2833
|
+
* @type {boolean}
|
|
2834
|
+
* @memberof CompleteOrderResponseDto
|
|
2835
|
+
*/
|
|
2836
|
+
'completed': boolean;
|
|
2837
|
+
/**
|
|
2838
|
+
* True when an earlier call already completed the order, so this call only announced its completion again
|
|
2839
|
+
* @type {boolean}
|
|
2840
|
+
* @memberof CompleteOrderResponseDto
|
|
2841
|
+
*/
|
|
2842
|
+
'alreadyCompleted': boolean;
|
|
2843
|
+
}
|
|
2802
2844
|
/**
|
|
2803
2845
|
*
|
|
2804
2846
|
* @export
|
|
@@ -3834,6 +3876,12 @@ export interface CreateManualSessionDtoOrder {
|
|
|
3834
3876
|
* @memberof CreateManualSessionDtoOrder
|
|
3835
3877
|
*/
|
|
3836
3878
|
'tableGroupId'?: string | null;
|
|
3879
|
+
/**
|
|
3880
|
+
*
|
|
3881
|
+
* @type {PosOrderDtoLoyalty}
|
|
3882
|
+
* @memberof CreateManualSessionDtoOrder
|
|
3883
|
+
*/
|
|
3884
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
3837
3885
|
}
|
|
3838
3886
|
/**
|
|
3839
3887
|
* Split context. Omit for a full-cart payment, or send { mode, partId|seatId } for a split. Must match the order\'s checkoutModel.
|
|
@@ -9194,6 +9242,152 @@ export declare const LoyaltyActionKey: {
|
|
|
9194
9242
|
readonly GetAdminHistory: "getAdminHistory";
|
|
9195
9243
|
};
|
|
9196
9244
|
export type LoyaltyActionKey = typeof LoyaltyActionKey[keyof typeof LoyaltyActionKey];
|
|
9245
|
+
/**
|
|
9246
|
+
*
|
|
9247
|
+
* @export
|
|
9248
|
+
* @interface LoyaltyActionOverrideDto
|
|
9249
|
+
*/
|
|
9250
|
+
export interface LoyaltyActionOverrideDto {
|
|
9251
|
+
/**
|
|
9252
|
+
*
|
|
9253
|
+
* @type {number}
|
|
9254
|
+
* @memberof LoyaltyActionOverrideDto
|
|
9255
|
+
*/
|
|
9256
|
+
'value'?: number;
|
|
9257
|
+
/**
|
|
9258
|
+
*
|
|
9259
|
+
* @type {string}
|
|
9260
|
+
* @memberof LoyaltyActionOverrideDto
|
|
9261
|
+
*/
|
|
9262
|
+
'currency'?: string | null;
|
|
9263
|
+
/**
|
|
9264
|
+
*
|
|
9265
|
+
* @type {number}
|
|
9266
|
+
* @memberof LoyaltyActionOverrideDto
|
|
9267
|
+
*/
|
|
9268
|
+
'max_units'?: number | null;
|
|
9269
|
+
/**
|
|
9270
|
+
*
|
|
9271
|
+
* @type {number}
|
|
9272
|
+
* @memberof LoyaltyActionOverrideDto
|
|
9273
|
+
*/
|
|
9274
|
+
'max_applications'?: number | null;
|
|
9275
|
+
}
|
|
9276
|
+
/**
|
|
9277
|
+
*
|
|
9278
|
+
* @export
|
|
9279
|
+
* @interface LoyaltyActionTargetDto
|
|
9280
|
+
*/
|
|
9281
|
+
export interface LoyaltyActionTargetDto {
|
|
9282
|
+
/**
|
|
9283
|
+
*
|
|
9284
|
+
* @type {Array<number>}
|
|
9285
|
+
* @memberof LoyaltyActionTargetDto
|
|
9286
|
+
*/
|
|
9287
|
+
'product_ids': Array<number>;
|
|
9288
|
+
/**
|
|
9289
|
+
*
|
|
9290
|
+
* @type {Array<number>}
|
|
9291
|
+
* @memberof LoyaltyActionTargetDto
|
|
9292
|
+
*/
|
|
9293
|
+
'category_ids': Array<number>;
|
|
9294
|
+
/**
|
|
9295
|
+
*
|
|
9296
|
+
* @type {Array<number>}
|
|
9297
|
+
* @memberof LoyaltyActionTargetDto
|
|
9298
|
+
*/
|
|
9299
|
+
'exclude_product_ids': Array<number>;
|
|
9300
|
+
/**
|
|
9301
|
+
*
|
|
9302
|
+
* @type {Array<number>}
|
|
9303
|
+
* @memberof LoyaltyActionTargetDto
|
|
9304
|
+
*/
|
|
9305
|
+
'exclude_category_ids': Array<number>;
|
|
9306
|
+
/**
|
|
9307
|
+
*
|
|
9308
|
+
* @type {boolean}
|
|
9309
|
+
* @memberof LoyaltyActionTargetDto
|
|
9310
|
+
*/
|
|
9311
|
+
'exclude_alcohol': boolean;
|
|
9312
|
+
}
|
|
9313
|
+
/**
|
|
9314
|
+
*
|
|
9315
|
+
* @export
|
|
9316
|
+
* @interface LoyaltyBusinessScopeDto
|
|
9317
|
+
*/
|
|
9318
|
+
export interface LoyaltyBusinessScopeDto {
|
|
9319
|
+
/**
|
|
9320
|
+
*
|
|
9321
|
+
* @type {number}
|
|
9322
|
+
* @memberof LoyaltyBusinessScopeDto
|
|
9323
|
+
*/
|
|
9324
|
+
'business_id': number;
|
|
9325
|
+
/**
|
|
9326
|
+
*
|
|
9327
|
+
* @type {Array<LoyaltyConditionBindingDto>}
|
|
9328
|
+
* @memberof LoyaltyBusinessScopeDto
|
|
9329
|
+
*/
|
|
9330
|
+
'condition_bindings': Array<LoyaltyConditionBindingDto>;
|
|
9331
|
+
/**
|
|
9332
|
+
*
|
|
9333
|
+
* @type {LoyaltyActionTargetDto}
|
|
9334
|
+
* @memberof LoyaltyBusinessScopeDto
|
|
9335
|
+
*/
|
|
9336
|
+
'action_target': LoyaltyActionTargetDto;
|
|
9337
|
+
/**
|
|
9338
|
+
*
|
|
9339
|
+
* @type {LoyaltyActionOverrideDto}
|
|
9340
|
+
* @memberof LoyaltyBusinessScopeDto
|
|
9341
|
+
*/
|
|
9342
|
+
'action_override'?: LoyaltyActionOverrideDto | null;
|
|
9343
|
+
}
|
|
9344
|
+
/**
|
|
9345
|
+
*
|
|
9346
|
+
* @export
|
|
9347
|
+
* @enum {string}
|
|
9348
|
+
*/
|
|
9349
|
+
export declare const LoyaltyCatalogType: {
|
|
9350
|
+
readonly Product: "product";
|
|
9351
|
+
readonly Coupon: "coupon";
|
|
9352
|
+
};
|
|
9353
|
+
export type LoyaltyCatalogType = typeof LoyaltyCatalogType[keyof typeof LoyaltyCatalogType];
|
|
9354
|
+
/**
|
|
9355
|
+
*
|
|
9356
|
+
* @export
|
|
9357
|
+
* @enum {string}
|
|
9358
|
+
*/
|
|
9359
|
+
export declare const LoyaltyChannel: {
|
|
9360
|
+
readonly Kiosk: "kiosk";
|
|
9361
|
+
readonly Pos: "pos";
|
|
9362
|
+
readonly Online: "online";
|
|
9363
|
+
readonly Mobile: "mobile";
|
|
9364
|
+
};
|
|
9365
|
+
export type LoyaltyChannel = typeof LoyaltyChannel[keyof typeof LoyaltyChannel];
|
|
9366
|
+
/**
|
|
9367
|
+
*
|
|
9368
|
+
* @export
|
|
9369
|
+
* @interface LoyaltyConditionBindingDto
|
|
9370
|
+
*/
|
|
9371
|
+
export interface LoyaltyConditionBindingDto {
|
|
9372
|
+
/**
|
|
9373
|
+
*
|
|
9374
|
+
* @type {string}
|
|
9375
|
+
* @memberof LoyaltyConditionBindingDto
|
|
9376
|
+
*/
|
|
9377
|
+
'condition_id': string;
|
|
9378
|
+
/**
|
|
9379
|
+
*
|
|
9380
|
+
* @type {Array<number>}
|
|
9381
|
+
* @memberof LoyaltyConditionBindingDto
|
|
9382
|
+
*/
|
|
9383
|
+
'product_ids': Array<number>;
|
|
9384
|
+
/**
|
|
9385
|
+
*
|
|
9386
|
+
* @type {Array<number>}
|
|
9387
|
+
* @memberof LoyaltyConditionBindingDto
|
|
9388
|
+
*/
|
|
9389
|
+
'category_ids': Array<number>;
|
|
9390
|
+
}
|
|
9197
9391
|
/**
|
|
9198
9392
|
*
|
|
9199
9393
|
* @export
|
|
@@ -9345,6 +9539,183 @@ export interface LoyaltyLinkMetadataDto {
|
|
|
9345
9539
|
*/
|
|
9346
9540
|
'venueId': number;
|
|
9347
9541
|
}
|
|
9542
|
+
/**
|
|
9543
|
+
*
|
|
9544
|
+
* @export
|
|
9545
|
+
* @interface LoyaltyMemberContextDto
|
|
9546
|
+
*/
|
|
9547
|
+
export interface LoyaltyMemberContextDto {
|
|
9548
|
+
/**
|
|
9549
|
+
* Loyalty user id the member context was resolved for
|
|
9550
|
+
* @type {number}
|
|
9551
|
+
* @memberof LoyaltyMemberContextDto
|
|
9552
|
+
*/
|
|
9553
|
+
'user_id': number;
|
|
9554
|
+
/**
|
|
9555
|
+
* Business the member context was resolved for
|
|
9556
|
+
* @type {number}
|
|
9557
|
+
* @memberof LoyaltyMemberContextDto
|
|
9558
|
+
*/
|
|
9559
|
+
'business_id': number;
|
|
9560
|
+
/**
|
|
9561
|
+
*
|
|
9562
|
+
* @type {LoyaltyChannel}
|
|
9563
|
+
* @memberof LoyaltyMemberContextDto
|
|
9564
|
+
*/
|
|
9565
|
+
'channel': LoyaltyChannel;
|
|
9566
|
+
/**
|
|
9567
|
+
* Points the member can still spend, excluding expired batches
|
|
9568
|
+
* @type {number}
|
|
9569
|
+
* @memberof LoyaltyMemberContextDto
|
|
9570
|
+
*/
|
|
9571
|
+
'points_balance': number;
|
|
9572
|
+
/**
|
|
9573
|
+
* Rewards available to this member on this channel
|
|
9574
|
+
* @type {Array<LoyaltyMemberContextRewardDto>}
|
|
9575
|
+
* @memberof LoyaltyMemberContextDto
|
|
9576
|
+
*/
|
|
9577
|
+
'rewards': Array<LoyaltyMemberContextRewardDto>;
|
|
9578
|
+
}
|
|
9579
|
+
/**
|
|
9580
|
+
*
|
|
9581
|
+
* @export
|
|
9582
|
+
* @interface LoyaltyMemberContextRequestDto
|
|
9583
|
+
*/
|
|
9584
|
+
export interface LoyaltyMemberContextRequestDto {
|
|
9585
|
+
/**
|
|
9586
|
+
* Loyalty user id the context is resolved for
|
|
9587
|
+
* @type {number}
|
|
9588
|
+
* @memberof LoyaltyMemberContextRequestDto
|
|
9589
|
+
*/
|
|
9590
|
+
'user_id': number;
|
|
9591
|
+
/**
|
|
9592
|
+
* Business the caller is asking about
|
|
9593
|
+
* @type {number}
|
|
9594
|
+
* @memberof LoyaltyMemberContextRequestDto
|
|
9595
|
+
*/
|
|
9596
|
+
'business_id': number;
|
|
9597
|
+
/**
|
|
9598
|
+
*
|
|
9599
|
+
* @type {LoyaltyChannel}
|
|
9600
|
+
* @memberof LoyaltyMemberContextRequestDto
|
|
9601
|
+
*/
|
|
9602
|
+
'channel': LoyaltyChannel;
|
|
9603
|
+
}
|
|
9604
|
+
/**
|
|
9605
|
+
*
|
|
9606
|
+
* @export
|
|
9607
|
+
* @interface LoyaltyMemberContextRewardDto
|
|
9608
|
+
*/
|
|
9609
|
+
export interface LoyaltyMemberContextRewardDto {
|
|
9610
|
+
/**
|
|
9611
|
+
*
|
|
9612
|
+
* @type {number}
|
|
9613
|
+
* @memberof LoyaltyMemberContextRewardDto
|
|
9614
|
+
*/
|
|
9615
|
+
'catalog_id': number;
|
|
9616
|
+
/**
|
|
9617
|
+
*
|
|
9618
|
+
* @type {LoyaltyRewardType}
|
|
9619
|
+
* @memberof LoyaltyMemberContextRewardDto
|
|
9620
|
+
*/
|
|
9621
|
+
'type': LoyaltyRewardType;
|
|
9622
|
+
/**
|
|
9623
|
+
*
|
|
9624
|
+
* @type {string}
|
|
9625
|
+
* @memberof LoyaltyMemberContextRewardDto
|
|
9626
|
+
*/
|
|
9627
|
+
'name': string;
|
|
9628
|
+
/**
|
|
9629
|
+
*
|
|
9630
|
+
* @type {string}
|
|
9631
|
+
* @memberof LoyaltyMemberContextRewardDto
|
|
9632
|
+
*/
|
|
9633
|
+
'description'?: string | null;
|
|
9634
|
+
/**
|
|
9635
|
+
* Points a member spends; always null for a coupon
|
|
9636
|
+
* @type {number}
|
|
9637
|
+
* @memberof LoyaltyMemberContextRewardDto
|
|
9638
|
+
*/
|
|
9639
|
+
'points_cost': number | null;
|
|
9640
|
+
/**
|
|
9641
|
+
*
|
|
9642
|
+
* @type {Array<LoyaltyMemberContextRuleDto>}
|
|
9643
|
+
* @memberof LoyaltyMemberContextRewardDto
|
|
9644
|
+
*/
|
|
9645
|
+
'rules': Array<LoyaltyMemberContextRuleDto>;
|
|
9646
|
+
}
|
|
9647
|
+
/**
|
|
9648
|
+
*
|
|
9649
|
+
* @export
|
|
9650
|
+
* @interface LoyaltyMemberContextRuleDto
|
|
9651
|
+
*/
|
|
9652
|
+
export interface LoyaltyMemberContextRuleDto {
|
|
9653
|
+
/**
|
|
9654
|
+
*
|
|
9655
|
+
* @type {number}
|
|
9656
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9657
|
+
*/
|
|
9658
|
+
'rule_id': number;
|
|
9659
|
+
/**
|
|
9660
|
+
*
|
|
9661
|
+
* @type {number}
|
|
9662
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9663
|
+
*/
|
|
9664
|
+
'revision': number;
|
|
9665
|
+
/**
|
|
9666
|
+
*
|
|
9667
|
+
* @type {LoyaltyRuleApplicationMode}
|
|
9668
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9669
|
+
*/
|
|
9670
|
+
'application_mode': LoyaltyRuleApplicationMode;
|
|
9671
|
+
/**
|
|
9672
|
+
*
|
|
9673
|
+
* @type {LoyaltyRuleStackingMode}
|
|
9674
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9675
|
+
*/
|
|
9676
|
+
'stacking_mode': LoyaltyRuleStackingMode;
|
|
9677
|
+
/**
|
|
9678
|
+
*
|
|
9679
|
+
* @type {Array<LoyaltyRuleConditionDto>}
|
|
9680
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9681
|
+
*/
|
|
9682
|
+
'conditions': Array<LoyaltyRuleConditionDto>;
|
|
9683
|
+
/**
|
|
9684
|
+
*
|
|
9685
|
+
* @type {boolean}
|
|
9686
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9687
|
+
*/
|
|
9688
|
+
'repeatable': boolean;
|
|
9689
|
+
/**
|
|
9690
|
+
*
|
|
9691
|
+
* @type {number}
|
|
9692
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9693
|
+
*/
|
|
9694
|
+
'max_applications': number | null;
|
|
9695
|
+
/**
|
|
9696
|
+
*
|
|
9697
|
+
* @type {LoyaltyRuleActionDto}
|
|
9698
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9699
|
+
*/
|
|
9700
|
+
'action': LoyaltyRuleActionDto;
|
|
9701
|
+
/**
|
|
9702
|
+
*
|
|
9703
|
+
* @type {LoyaltyBusinessScopeDto}
|
|
9704
|
+
* @memberof LoyaltyMemberContextRuleDto
|
|
9705
|
+
*/
|
|
9706
|
+
'business_scope': LoyaltyBusinessScopeDto;
|
|
9707
|
+
}
|
|
9708
|
+
/**
|
|
9709
|
+
*
|
|
9710
|
+
* @export
|
|
9711
|
+
* @enum {string}
|
|
9712
|
+
*/
|
|
9713
|
+
export declare const LoyaltyRedemptionStatus: {
|
|
9714
|
+
readonly Pending: "pending";
|
|
9715
|
+
readonly Redeemed: "redeemed";
|
|
9716
|
+
readonly Reversed: "reversed";
|
|
9717
|
+
};
|
|
9718
|
+
export type LoyaltyRedemptionStatus = typeof LoyaltyRedemptionStatus[keyof typeof LoyaltyRedemptionStatus];
|
|
9348
9719
|
/**
|
|
9349
9720
|
*
|
|
9350
9721
|
* @export
|
|
@@ -9389,6 +9760,190 @@ export interface LoyaltyResolveResponseDto {
|
|
|
9389
9760
|
*/
|
|
9390
9761
|
'perks': Array<ResolvedPerkDto>;
|
|
9391
9762
|
}
|
|
9763
|
+
/**
|
|
9764
|
+
*
|
|
9765
|
+
* @export
|
|
9766
|
+
* @enum {string}
|
|
9767
|
+
*/
|
|
9768
|
+
export declare const LoyaltyRestoreRequestStatus: {
|
|
9769
|
+
readonly Requested: "REQUESTED";
|
|
9770
|
+
readonly AlreadyReversed: "ALREADY_REVERSED";
|
|
9771
|
+
};
|
|
9772
|
+
export type LoyaltyRestoreRequestStatus = typeof LoyaltyRestoreRequestStatus[keyof typeof LoyaltyRestoreRequestStatus];
|
|
9773
|
+
/**
|
|
9774
|
+
*
|
|
9775
|
+
* @export
|
|
9776
|
+
* @enum {string}
|
|
9777
|
+
*/
|
|
9778
|
+
export declare const LoyaltyRewardType: {
|
|
9779
|
+
readonly Product: "product";
|
|
9780
|
+
readonly Coupon: "coupon";
|
|
9781
|
+
};
|
|
9782
|
+
export type LoyaltyRewardType = typeof LoyaltyRewardType[keyof typeof LoyaltyRewardType];
|
|
9783
|
+
/**
|
|
9784
|
+
*
|
|
9785
|
+
* @export
|
|
9786
|
+
* @interface LoyaltyRuleActionDto
|
|
9787
|
+
*/
|
|
9788
|
+
export interface LoyaltyRuleActionDto {
|
|
9789
|
+
/**
|
|
9790
|
+
*
|
|
9791
|
+
* @type {LoyaltyRuleActionType}
|
|
9792
|
+
* @memberof LoyaltyRuleActionDto
|
|
9793
|
+
*/
|
|
9794
|
+
'type': LoyaltyRuleActionType;
|
|
9795
|
+
/**
|
|
9796
|
+
* Plain percentage for a percentage action — 10 is 10% and 100 is a free item — or minor units for a fixed one. Never basis points.
|
|
9797
|
+
* @type {number}
|
|
9798
|
+
* @memberof LoyaltyRuleActionDto
|
|
9799
|
+
*/
|
|
9800
|
+
'value': number;
|
|
9801
|
+
/**
|
|
9802
|
+
*
|
|
9803
|
+
* @type {string}
|
|
9804
|
+
* @memberof LoyaltyRuleActionDto
|
|
9805
|
+
*/
|
|
9806
|
+
'currency'?: string | null;
|
|
9807
|
+
/**
|
|
9808
|
+
*
|
|
9809
|
+
* @type {LoyaltyRuleTargetType}
|
|
9810
|
+
* @memberof LoyaltyRuleActionDto
|
|
9811
|
+
*/
|
|
9812
|
+
'target_type': LoyaltyRuleTargetType;
|
|
9813
|
+
/**
|
|
9814
|
+
*
|
|
9815
|
+
* @type {LoyaltyRuleSelection}
|
|
9816
|
+
* @memberof LoyaltyRuleActionDto
|
|
9817
|
+
*/
|
|
9818
|
+
'selection': LoyaltyRuleSelection;
|
|
9819
|
+
/**
|
|
9820
|
+
*
|
|
9821
|
+
* @type {number}
|
|
9822
|
+
* @memberof LoyaltyRuleActionDto
|
|
9823
|
+
*/
|
|
9824
|
+
'units_per_application': number;
|
|
9825
|
+
/**
|
|
9826
|
+
*
|
|
9827
|
+
* @type {number}
|
|
9828
|
+
* @memberof LoyaltyRuleActionDto
|
|
9829
|
+
*/
|
|
9830
|
+
'max_units'?: number | null;
|
|
9831
|
+
/**
|
|
9832
|
+
*
|
|
9833
|
+
* @type {LoyaltyRuleFulfillmentMode}
|
|
9834
|
+
* @memberof LoyaltyRuleActionDto
|
|
9835
|
+
*/
|
|
9836
|
+
'fulfillment_mode': LoyaltyRuleFulfillmentMode;
|
|
9837
|
+
}
|
|
9838
|
+
/**
|
|
9839
|
+
*
|
|
9840
|
+
* @export
|
|
9841
|
+
* @enum {string}
|
|
9842
|
+
*/
|
|
9843
|
+
export declare const LoyaltyRuleActionType: {
|
|
9844
|
+
readonly Percentage: "percentage";
|
|
9845
|
+
readonly Fixed: "fixed";
|
|
9846
|
+
};
|
|
9847
|
+
export type LoyaltyRuleActionType = typeof LoyaltyRuleActionType[keyof typeof LoyaltyRuleActionType];
|
|
9848
|
+
/**
|
|
9849
|
+
*
|
|
9850
|
+
* @export
|
|
9851
|
+
* @enum {string}
|
|
9852
|
+
*/
|
|
9853
|
+
export declare const LoyaltyRuleApplicationMode: {
|
|
9854
|
+
readonly Manual: "manual";
|
|
9855
|
+
readonly Automatic: "automatic";
|
|
9856
|
+
};
|
|
9857
|
+
export type LoyaltyRuleApplicationMode = typeof LoyaltyRuleApplicationMode[keyof typeof LoyaltyRuleApplicationMode];
|
|
9858
|
+
/**
|
|
9859
|
+
*
|
|
9860
|
+
* @export
|
|
9861
|
+
* @interface LoyaltyRuleConditionDto
|
|
9862
|
+
*/
|
|
9863
|
+
export interface LoyaltyRuleConditionDto {
|
|
9864
|
+
/**
|
|
9865
|
+
*
|
|
9866
|
+
* @type {string}
|
|
9867
|
+
* @memberof LoyaltyRuleConditionDto
|
|
9868
|
+
*/
|
|
9869
|
+
'condition_id': string;
|
|
9870
|
+
/**
|
|
9871
|
+
*
|
|
9872
|
+
* @type {LoyaltyRuleConditionType}
|
|
9873
|
+
* @memberof LoyaltyRuleConditionDto
|
|
9874
|
+
*/
|
|
9875
|
+
'type': LoyaltyRuleConditionType;
|
|
9876
|
+
/**
|
|
9877
|
+
*
|
|
9878
|
+
* @type {number}
|
|
9879
|
+
* @memberof LoyaltyRuleConditionDto
|
|
9880
|
+
*/
|
|
9881
|
+
'required_quantity'?: number | null;
|
|
9882
|
+
/**
|
|
9883
|
+
*
|
|
9884
|
+
* @type {number}
|
|
9885
|
+
* @memberof LoyaltyRuleConditionDto
|
|
9886
|
+
*/
|
|
9887
|
+
'value'?: number | null;
|
|
9888
|
+
}
|
|
9889
|
+
/**
|
|
9890
|
+
*
|
|
9891
|
+
* @export
|
|
9892
|
+
* @enum {string}
|
|
9893
|
+
*/
|
|
9894
|
+
export declare const LoyaltyRuleConditionType: {
|
|
9895
|
+
readonly Always: "always";
|
|
9896
|
+
readonly ProductInCart: "product_in_cart";
|
|
9897
|
+
readonly CategoryInCart: "category_in_cart";
|
|
9898
|
+
readonly ProductQuantityInCart: "product_quantity_in_cart";
|
|
9899
|
+
readonly CategoryQuantityInCart: "category_quantity_in_cart";
|
|
9900
|
+
readonly CartMinValue: "cart_min_value";
|
|
9901
|
+
readonly CartMaxValue: "cart_max_value";
|
|
9902
|
+
};
|
|
9903
|
+
export type LoyaltyRuleConditionType = typeof LoyaltyRuleConditionType[keyof typeof LoyaltyRuleConditionType];
|
|
9904
|
+
/**
|
|
9905
|
+
*
|
|
9906
|
+
* @export
|
|
9907
|
+
* @enum {string}
|
|
9908
|
+
*/
|
|
9909
|
+
export declare const LoyaltyRuleFulfillmentMode: {
|
|
9910
|
+
readonly RequireInCart: "require_in_cart";
|
|
9911
|
+
readonly ConfigureTarget: "configure_target";
|
|
9912
|
+
};
|
|
9913
|
+
export type LoyaltyRuleFulfillmentMode = typeof LoyaltyRuleFulfillmentMode[keyof typeof LoyaltyRuleFulfillmentMode];
|
|
9914
|
+
/**
|
|
9915
|
+
*
|
|
9916
|
+
* @export
|
|
9917
|
+
* @enum {string}
|
|
9918
|
+
*/
|
|
9919
|
+
export declare const LoyaltyRuleSelection: {
|
|
9920
|
+
readonly All: "all";
|
|
9921
|
+
readonly Cheapest: "cheapest";
|
|
9922
|
+
readonly MostExpensive: "most_expensive";
|
|
9923
|
+
};
|
|
9924
|
+
export type LoyaltyRuleSelection = typeof LoyaltyRuleSelection[keyof typeof LoyaltyRuleSelection];
|
|
9925
|
+
/**
|
|
9926
|
+
*
|
|
9927
|
+
* @export
|
|
9928
|
+
* @enum {string}
|
|
9929
|
+
*/
|
|
9930
|
+
export declare const LoyaltyRuleStackingMode: {
|
|
9931
|
+
readonly ExclusiveBestForCustomer: "exclusive_best_for_customer";
|
|
9932
|
+
readonly Stackable: "stackable";
|
|
9933
|
+
};
|
|
9934
|
+
export type LoyaltyRuleStackingMode = typeof LoyaltyRuleStackingMode[keyof typeof LoyaltyRuleStackingMode];
|
|
9935
|
+
/**
|
|
9936
|
+
*
|
|
9937
|
+
* @export
|
|
9938
|
+
* @enum {string}
|
|
9939
|
+
*/
|
|
9940
|
+
export declare const LoyaltyRuleTargetType: {
|
|
9941
|
+
readonly ConditionMatch: "condition_match";
|
|
9942
|
+
readonly Product: "product";
|
|
9943
|
+
readonly Category: "category";
|
|
9944
|
+
readonly Order: "order";
|
|
9945
|
+
};
|
|
9946
|
+
export type LoyaltyRuleTargetType = typeof LoyaltyRuleTargetType[keyof typeof LoyaltyRuleTargetType];
|
|
9392
9947
|
/**
|
|
9393
9948
|
*
|
|
9394
9949
|
* @export
|
|
@@ -11317,35 +11872,147 @@ export interface OrderHistoryResponseDtoPagination {
|
|
|
11317
11872
|
*/
|
|
11318
11873
|
export interface OrderHistoryResponseDtoSummary {
|
|
11319
11874
|
/**
|
|
11320
|
-
* Total orders
|
|
11321
|
-
* @type {number}
|
|
11322
|
-
* @memberof OrderHistoryResponseDtoSummary
|
|
11875
|
+
* Total orders
|
|
11876
|
+
* @type {number}
|
|
11877
|
+
* @memberof OrderHistoryResponseDtoSummary
|
|
11878
|
+
*/
|
|
11879
|
+
'totalOrders': number;
|
|
11880
|
+
/**
|
|
11881
|
+
* Rejected orders
|
|
11882
|
+
* @type {number}
|
|
11883
|
+
* @memberof OrderHistoryResponseDtoSummary
|
|
11884
|
+
*/
|
|
11885
|
+
'rejectedOrders': number;
|
|
11886
|
+
/**
|
|
11887
|
+
* Total sales
|
|
11888
|
+
* @type {number}
|
|
11889
|
+
* @memberof OrderHistoryResponseDtoSummary
|
|
11890
|
+
*/
|
|
11891
|
+
'totalSales': number;
|
|
11892
|
+
/**
|
|
11893
|
+
* Rejected sales
|
|
11894
|
+
* @type {number}
|
|
11895
|
+
* @memberof OrderHistoryResponseDtoSummary
|
|
11896
|
+
*/
|
|
11897
|
+
'rejectedSales': number;
|
|
11898
|
+
/**
|
|
11899
|
+
* Total tip amount in cents
|
|
11900
|
+
* @type {number}
|
|
11901
|
+
* @memberof OrderHistoryResponseDtoSummary
|
|
11902
|
+
*/
|
|
11903
|
+
'totalTipAmount'?: number;
|
|
11904
|
+
}
|
|
11905
|
+
/**
|
|
11906
|
+
*
|
|
11907
|
+
* @export
|
|
11908
|
+
* @interface OrderLoyaltyDto
|
|
11909
|
+
*/
|
|
11910
|
+
export interface OrderLoyaltyDto {
|
|
11911
|
+
/**
|
|
11912
|
+
* Redemptions on this order, keyed by loyalty entry id.
|
|
11913
|
+
* @type {{ [key: string]: OrderLoyaltyRedemptionDto; }}
|
|
11914
|
+
* @memberof OrderLoyaltyDto
|
|
11915
|
+
*/
|
|
11916
|
+
'redemptions': {
|
|
11917
|
+
[key: string]: OrderLoyaltyRedemptionDto;
|
|
11918
|
+
};
|
|
11919
|
+
}
|
|
11920
|
+
/**
|
|
11921
|
+
*
|
|
11922
|
+
* @export
|
|
11923
|
+
* @interface OrderLoyaltyRedemptionDto
|
|
11924
|
+
*/
|
|
11925
|
+
export interface OrderLoyaltyRedemptionDto {
|
|
11926
|
+
/**
|
|
11927
|
+
* Loyalty entry id, and the key this entry is stored under
|
|
11928
|
+
* @type {string}
|
|
11929
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11930
|
+
*/
|
|
11931
|
+
'id': string;
|
|
11932
|
+
/**
|
|
11933
|
+
*
|
|
11934
|
+
* @type {Array<string>}
|
|
11935
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11936
|
+
*/
|
|
11937
|
+
'discountApplicationIds': Array<string>;
|
|
11938
|
+
/**
|
|
11939
|
+
*
|
|
11940
|
+
* @type {number}
|
|
11941
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11942
|
+
*/
|
|
11943
|
+
'catalogId': number;
|
|
11944
|
+
/**
|
|
11945
|
+
*
|
|
11946
|
+
* @type {LoyaltyCatalogType}
|
|
11947
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11948
|
+
*/
|
|
11949
|
+
'catalogType': LoyaltyCatalogType;
|
|
11950
|
+
/**
|
|
11951
|
+
*
|
|
11952
|
+
* @type {string}
|
|
11953
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11954
|
+
*/
|
|
11955
|
+
'rewardName': string;
|
|
11956
|
+
/**
|
|
11957
|
+
*
|
|
11958
|
+
* @type {number}
|
|
11959
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11960
|
+
*/
|
|
11961
|
+
'ruleId': number;
|
|
11962
|
+
/**
|
|
11963
|
+
*
|
|
11964
|
+
* @type {number}
|
|
11965
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11966
|
+
*/
|
|
11967
|
+
'ruleRevision': number;
|
|
11968
|
+
/**
|
|
11969
|
+
*
|
|
11970
|
+
* @type {number}
|
|
11971
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11972
|
+
*/
|
|
11973
|
+
'quantity': number;
|
|
11974
|
+
/**
|
|
11975
|
+
* Points spent, in points.
|
|
11976
|
+
* @type {number}
|
|
11977
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11978
|
+
*/
|
|
11979
|
+
'pointsCost': number | null;
|
|
11980
|
+
/**
|
|
11981
|
+
*
|
|
11982
|
+
* @type {LoyaltyRedemptionStatus}
|
|
11983
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11984
|
+
*/
|
|
11985
|
+
'status': LoyaltyRedemptionStatus;
|
|
11986
|
+
/**
|
|
11987
|
+
*
|
|
11988
|
+
* @type {string}
|
|
11989
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11323
11990
|
*/
|
|
11324
|
-
'
|
|
11991
|
+
'transactionId': string | null;
|
|
11325
11992
|
/**
|
|
11326
|
-
*
|
|
11327
|
-
* @type {
|
|
11328
|
-
* @memberof
|
|
11993
|
+
*
|
|
11994
|
+
* @type {string}
|
|
11995
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11329
11996
|
*/
|
|
11330
|
-
'
|
|
11997
|
+
'walletId': string | null;
|
|
11331
11998
|
/**
|
|
11332
|
-
*
|
|
11333
|
-
* @type {
|
|
11334
|
-
* @memberof
|
|
11999
|
+
*
|
|
12000
|
+
* @type {string}
|
|
12001
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11335
12002
|
*/
|
|
11336
|
-
'
|
|
12003
|
+
'settledAt': string | null;
|
|
11337
12004
|
/**
|
|
11338
|
-
*
|
|
11339
|
-
* @type {
|
|
11340
|
-
* @memberof
|
|
12005
|
+
*
|
|
12006
|
+
* @type {string}
|
|
12007
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11341
12008
|
*/
|
|
11342
|
-
'
|
|
12009
|
+
'reversalTransactionId': string | null;
|
|
11343
12010
|
/**
|
|
11344
|
-
*
|
|
11345
|
-
* @type {
|
|
11346
|
-
* @memberof
|
|
12011
|
+
*
|
|
12012
|
+
* @type {string}
|
|
12013
|
+
* @memberof OrderLoyaltyRedemptionDto
|
|
11347
12014
|
*/
|
|
11348
|
-
'
|
|
12015
|
+
'reversedAt': string | null;
|
|
11349
12016
|
}
|
|
11350
12017
|
/**
|
|
11351
12018
|
*
|
|
@@ -13119,6 +13786,12 @@ export interface ParkPosOrderDtoOrder {
|
|
|
13119
13786
|
* @memberof ParkPosOrderDtoOrder
|
|
13120
13787
|
*/
|
|
13121
13788
|
'tableGroupId'?: string | null;
|
|
13789
|
+
/**
|
|
13790
|
+
*
|
|
13791
|
+
* @type {PosOrderDtoLoyalty}
|
|
13792
|
+
* @memberof ParkPosOrderDtoOrder
|
|
13793
|
+
*/
|
|
13794
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
13122
13795
|
}
|
|
13123
13796
|
/**
|
|
13124
13797
|
*
|
|
@@ -15480,6 +16153,36 @@ export interface PosDiscountDto {
|
|
|
15480
16153
|
* @memberof PosDiscountDto
|
|
15481
16154
|
*/
|
|
15482
16155
|
'isAutomatic': boolean;
|
|
16156
|
+
/**
|
|
16157
|
+
* Position of this application in the cascade that produced it. Merchant applications run first, then loyalty; the sequence records the order actually used so a reader never has to re-derive it.
|
|
16158
|
+
* @type {number}
|
|
16159
|
+
* @memberof PosDiscountDto
|
|
16160
|
+
*/
|
|
16161
|
+
'sequence'?: number;
|
|
16162
|
+
/**
|
|
16163
|
+
* Payable amount this application was measured against, in minor units.
|
|
16164
|
+
* @type {number}
|
|
16165
|
+
* @memberof PosDiscountDto
|
|
16166
|
+
*/
|
|
16167
|
+
'baseAmount'?: number;
|
|
16168
|
+
/**
|
|
16169
|
+
* Amount the configured discount asked for, in minor units, before it was clamped to what was still payable.
|
|
16170
|
+
* @type {number}
|
|
16171
|
+
* @memberof PosDiscountDto
|
|
16172
|
+
*/
|
|
16173
|
+
'requestedAmount'?: number;
|
|
16174
|
+
/**
|
|
16175
|
+
* Part of requestedAmount that could not be taken because nothing payable was left, in minor units. Never cashback.
|
|
16176
|
+
* @type {number}
|
|
16177
|
+
* @memberof PosDiscountDto
|
|
16178
|
+
*/
|
|
16179
|
+
'forfeitedAmount'?: number;
|
|
16180
|
+
/**
|
|
16181
|
+
* Number of line units this application covers. Absent means it covers the whole line.
|
|
16182
|
+
* @type {number}
|
|
16183
|
+
* @memberof PosDiscountDto
|
|
16184
|
+
*/
|
|
16185
|
+
'units'?: number;
|
|
15483
16186
|
}
|
|
15484
16187
|
/**
|
|
15485
16188
|
*
|
|
@@ -16682,6 +17385,12 @@ export interface PosOrderDto {
|
|
|
16682
17385
|
* @memberof PosOrderDto
|
|
16683
17386
|
*/
|
|
16684
17387
|
'tableGroupId'?: string | null;
|
|
17388
|
+
/**
|
|
17389
|
+
*
|
|
17390
|
+
* @type {PosOrderDtoLoyalty}
|
|
17391
|
+
* @memberof PosOrderDto
|
|
17392
|
+
*/
|
|
17393
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
16685
17394
|
}
|
|
16686
17395
|
/**
|
|
16687
17396
|
* Equal split state persisted for the order
|
|
@@ -16769,6 +17478,21 @@ export interface PosOrderDtoInvoiceCompany {
|
|
|
16769
17478
|
*/
|
|
16770
17479
|
'updatedAt': string;
|
|
16771
17480
|
}
|
|
17481
|
+
/**
|
|
17482
|
+
* Loyalty rewards committed to this order. Absent on orders that used none.
|
|
17483
|
+
* @export
|
|
17484
|
+
* @interface PosOrderDtoLoyalty
|
|
17485
|
+
*/
|
|
17486
|
+
export interface PosOrderDtoLoyalty {
|
|
17487
|
+
/**
|
|
17488
|
+
* Redemptions on this order, keyed by loyalty entry id.
|
|
17489
|
+
* @type {{ [key: string]: OrderLoyaltyRedemptionDto; }}
|
|
17490
|
+
* @memberof PosOrderDtoLoyalty
|
|
17491
|
+
*/
|
|
17492
|
+
'redemptions': {
|
|
17493
|
+
[key: string]: OrderLoyaltyRedemptionDto;
|
|
17494
|
+
};
|
|
17495
|
+
}
|
|
16772
17496
|
/**
|
|
16773
17497
|
* Fine dining table service metadata
|
|
16774
17498
|
* @export
|
|
@@ -16984,6 +17708,12 @@ export interface PosOrderItemDto {
|
|
|
16984
17708
|
* @memberof PosOrderItemDto
|
|
16985
17709
|
*/
|
|
16986
17710
|
'discount': PosDiscountDto | null;
|
|
17711
|
+
/**
|
|
17712
|
+
* Every item-scope discount application on this line, in cascade order — including when there is only one.
|
|
17713
|
+
* @type {Array<PosDiscountDto>}
|
|
17714
|
+
* @memberof PosOrderItemDto
|
|
17715
|
+
*/
|
|
17716
|
+
'discountApplications'?: Array<PosDiscountDto>;
|
|
16987
17717
|
/**
|
|
16988
17718
|
*
|
|
16989
17719
|
* @type {boolean}
|
|
@@ -17500,6 +18230,12 @@ export interface PosOrderPayloadDtoOrder {
|
|
|
17500
18230
|
* @memberof PosOrderPayloadDtoOrder
|
|
17501
18231
|
*/
|
|
17502
18232
|
'tableGroupId'?: string | null;
|
|
18233
|
+
/**
|
|
18234
|
+
*
|
|
18235
|
+
* @type {PosOrderDtoLoyalty}
|
|
18236
|
+
* @memberof PosOrderPayloadDtoOrder
|
|
18237
|
+
*/
|
|
18238
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
17503
18239
|
}
|
|
17504
18240
|
/**
|
|
17505
18241
|
*
|
|
@@ -18415,6 +19151,12 @@ export interface ProcessOrderActionsResponseDtoOrder {
|
|
|
18415
19151
|
* @memberof ProcessOrderActionsResponseDtoOrder
|
|
18416
19152
|
*/
|
|
18417
19153
|
'tableGroupId'?: string | null;
|
|
19154
|
+
/**
|
|
19155
|
+
*
|
|
19156
|
+
* @type {PosOrderDtoLoyalty}
|
|
19157
|
+
* @memberof ProcessOrderActionsResponseDtoOrder
|
|
19158
|
+
*/
|
|
19159
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
18418
19160
|
}
|
|
18419
19161
|
/**
|
|
18420
19162
|
*
|
|
@@ -19727,6 +20469,12 @@ export interface RecordManualPaymentResultDtoOrder {
|
|
|
19727
20469
|
* @memberof RecordManualPaymentResultDtoOrder
|
|
19728
20470
|
*/
|
|
19729
20471
|
'tableGroupId'?: string | null;
|
|
20472
|
+
/**
|
|
20473
|
+
*
|
|
20474
|
+
* @type {PosOrderDtoLoyalty}
|
|
20475
|
+
* @memberof RecordManualPaymentResultDtoOrder
|
|
20476
|
+
*/
|
|
20477
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
19730
20478
|
}
|
|
19731
20479
|
/**
|
|
19732
20480
|
*
|
|
@@ -20700,6 +21448,56 @@ export declare const ScopeEnum: {
|
|
|
20700
21448
|
readonly Cart: "CART";
|
|
20701
21449
|
};
|
|
20702
21450
|
export type ScopeEnum = typeof ScopeEnum[keyof typeof ScopeEnum];
|
|
21451
|
+
/**
|
|
21452
|
+
*
|
|
21453
|
+
* @export
|
|
21454
|
+
* @interface RestoreLoyaltyRedemptionDto
|
|
21455
|
+
*/
|
|
21456
|
+
export interface RestoreLoyaltyRedemptionDto {
|
|
21457
|
+
/**
|
|
21458
|
+
* Business the order belongs to
|
|
21459
|
+
* @type {number}
|
|
21460
|
+
* @memberof RestoreLoyaltyRedemptionDto
|
|
21461
|
+
*/
|
|
21462
|
+
'businessId': number;
|
|
21463
|
+
/**
|
|
21464
|
+
* POS or kiosk order carrying the redemption
|
|
21465
|
+
* @type {string}
|
|
21466
|
+
* @memberof RestoreLoyaltyRedemptionDto
|
|
21467
|
+
*/
|
|
21468
|
+
'orderId': string;
|
|
21469
|
+
/**
|
|
21470
|
+
* Loyalty entry to restore
|
|
21471
|
+
* @type {string}
|
|
21472
|
+
* @memberof RestoreLoyaltyRedemptionDto
|
|
21473
|
+
*/
|
|
21474
|
+
'loyaltyEntryId': string;
|
|
21475
|
+
}
|
|
21476
|
+
/**
|
|
21477
|
+
*
|
|
21478
|
+
* @export
|
|
21479
|
+
* @interface RestoreLoyaltyRedemptionResponseDto
|
|
21480
|
+
*/
|
|
21481
|
+
export interface RestoreLoyaltyRedemptionResponseDto {
|
|
21482
|
+
/**
|
|
21483
|
+
*
|
|
21484
|
+
* @type {LoyaltyRestoreRequestStatus}
|
|
21485
|
+
* @memberof RestoreLoyaltyRedemptionResponseDto
|
|
21486
|
+
*/
|
|
21487
|
+
'status': LoyaltyRestoreRequestStatus;
|
|
21488
|
+
/**
|
|
21489
|
+
* Loyalty transaction the restore was asked against
|
|
21490
|
+
* @type {string}
|
|
21491
|
+
* @memberof RestoreLoyaltyRedemptionResponseDto
|
|
21492
|
+
*/
|
|
21493
|
+
'transactionId': string | null;
|
|
21494
|
+
/**
|
|
21495
|
+
* Reversal already recorded against the entry, when there is one
|
|
21496
|
+
* @type {string}
|
|
21497
|
+
* @memberof RestoreLoyaltyRedemptionResponseDto
|
|
21498
|
+
*/
|
|
21499
|
+
'reversalTransactionId': string | null;
|
|
21500
|
+
}
|
|
20703
21501
|
/**
|
|
20704
21502
|
*
|
|
20705
21503
|
* @export
|
|
@@ -21994,6 +22792,12 @@ export interface SyncKioskOrderDtoOrder {
|
|
|
21994
22792
|
* @memberof SyncKioskOrderDtoOrder
|
|
21995
22793
|
*/
|
|
21996
22794
|
'tableGroupId'?: string | null;
|
|
22795
|
+
/**
|
|
22796
|
+
*
|
|
22797
|
+
* @type {PosOrderDtoLoyalty}
|
|
22798
|
+
* @memberof SyncKioskOrderDtoOrder
|
|
22799
|
+
*/
|
|
22800
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
21997
22801
|
}
|
|
21998
22802
|
/**
|
|
21999
22803
|
*
|
|
@@ -22323,6 +23127,12 @@ export interface SyncPosOrderDtoOrder {
|
|
|
22323
23127
|
* @memberof SyncPosOrderDtoOrder
|
|
22324
23128
|
*/
|
|
22325
23129
|
'tableGroupId'?: string | null;
|
|
23130
|
+
/**
|
|
23131
|
+
*
|
|
23132
|
+
* @type {PosOrderDtoLoyalty}
|
|
23133
|
+
* @memberof SyncPosOrderDtoOrder
|
|
23134
|
+
*/
|
|
23135
|
+
'loyalty'?: PosOrderDtoLoyalty | null;
|
|
22326
23136
|
}
|
|
22327
23137
|
/**
|
|
22328
23138
|
* POS order actions to run in the background after persist (same shape as /pos/actions). Omit to only sync the order.
|
|
@@ -23703,6 +24513,12 @@ export interface UnifiedOrderResponseDto {
|
|
|
23703
24513
|
* @memberof UnifiedOrderResponseDto
|
|
23704
24514
|
*/
|
|
23705
24515
|
'posDiscounts'?: Array<PosDiscountDto>;
|
|
24516
|
+
/**
|
|
24517
|
+
*
|
|
24518
|
+
* @type {UnifiedOrderResponseDtoLoyalty}
|
|
24519
|
+
* @memberof UnifiedOrderResponseDto
|
|
24520
|
+
*/
|
|
24521
|
+
'loyalty'?: UnifiedOrderResponseDtoLoyalty | null;
|
|
23706
24522
|
/**
|
|
23707
24523
|
* Payment transactions recorded for the POS order. POS only
|
|
23708
24524
|
* @type {Array<TransactionDto>}
|
|
@@ -24035,6 +24851,21 @@ export interface UnifiedOrderResponseDtoLastPaymentError {
|
|
|
24035
24851
|
*/
|
|
24036
24852
|
'retryable': boolean;
|
|
24037
24853
|
}
|
|
24854
|
+
/**
|
|
24855
|
+
* Loyalty rewards committed to the POS order, keyed by loyalty entry id. POS only
|
|
24856
|
+
* @export
|
|
24857
|
+
* @interface UnifiedOrderResponseDtoLoyalty
|
|
24858
|
+
*/
|
|
24859
|
+
export interface UnifiedOrderResponseDtoLoyalty {
|
|
24860
|
+
/**
|
|
24861
|
+
* Redemptions on this order, keyed by loyalty entry id.
|
|
24862
|
+
* @type {{ [key: string]: OrderLoyaltyRedemptionDto; }}
|
|
24863
|
+
* @memberof UnifiedOrderResponseDtoLoyalty
|
|
24864
|
+
*/
|
|
24865
|
+
'redemptions': {
|
|
24866
|
+
[key: string]: OrderLoyaltyRedemptionDto;
|
|
24867
|
+
};
|
|
24868
|
+
}
|
|
24038
24869
|
/**
|
|
24039
24870
|
* Preorder scheduling details. Platform only
|
|
24040
24871
|
* @export
|
|
@@ -33534,6 +34365,81 @@ export declare class KiosksApi extends BaseAPI implements KiosksApiInterface {
|
|
|
33534
34365
|
*/
|
|
33535
34366
|
validate(terminalId: string, provider: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TerminalValidationResponseDto, any, {}>>;
|
|
33536
34367
|
}
|
|
34368
|
+
/**
|
|
34369
|
+
* LoyaltyCommerceApi - axios parameter creator
|
|
34370
|
+
* @export
|
|
34371
|
+
*/
|
|
34372
|
+
export declare const LoyaltyCommerceApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
34373
|
+
/**
|
|
34374
|
+
*
|
|
34375
|
+
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
34376
|
+
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
34377
|
+
* @param {*} [options] Override http request option.
|
|
34378
|
+
* @throws {RequiredError}
|
|
34379
|
+
*/
|
|
34380
|
+
restoreRedemption: (restoreLoyaltyRedemptionDto: RestoreLoyaltyRedemptionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34381
|
+
};
|
|
34382
|
+
/**
|
|
34383
|
+
* LoyaltyCommerceApi - functional programming interface
|
|
34384
|
+
* @export
|
|
34385
|
+
*/
|
|
34386
|
+
export declare const LoyaltyCommerceApiFp: (configuration?: Configuration) => {
|
|
34387
|
+
/**
|
|
34388
|
+
*
|
|
34389
|
+
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
34390
|
+
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
34391
|
+
* @param {*} [options] Override http request option.
|
|
34392
|
+
* @throws {RequiredError}
|
|
34393
|
+
*/
|
|
34394
|
+
restoreRedemption(restoreLoyaltyRedemptionDto: RestoreLoyaltyRedemptionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RestoreLoyaltyRedemptionResponseDto>>;
|
|
34395
|
+
};
|
|
34396
|
+
/**
|
|
34397
|
+
* LoyaltyCommerceApi - factory interface
|
|
34398
|
+
* @export
|
|
34399
|
+
*/
|
|
34400
|
+
export declare const LoyaltyCommerceApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
34401
|
+
/**
|
|
34402
|
+
*
|
|
34403
|
+
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
34404
|
+
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
34405
|
+
* @param {*} [options] Override http request option.
|
|
34406
|
+
* @throws {RequiredError}
|
|
34407
|
+
*/
|
|
34408
|
+
restoreRedemption(restoreLoyaltyRedemptionDto: RestoreLoyaltyRedemptionDto, options?: any): AxiosPromise<RestoreLoyaltyRedemptionResponseDto>;
|
|
34409
|
+
};
|
|
34410
|
+
/**
|
|
34411
|
+
* LoyaltyCommerceApi - interface
|
|
34412
|
+
* @export
|
|
34413
|
+
* @interface LoyaltyCommerceApi
|
|
34414
|
+
*/
|
|
34415
|
+
export interface LoyaltyCommerceApiInterface {
|
|
34416
|
+
/**
|
|
34417
|
+
*
|
|
34418
|
+
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
34419
|
+
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
34420
|
+
* @param {*} [options] Override http request option.
|
|
34421
|
+
* @throws {RequiredError}
|
|
34422
|
+
* @memberof LoyaltyCommerceApiInterface
|
|
34423
|
+
*/
|
|
34424
|
+
restoreRedemption(restoreLoyaltyRedemptionDto: RestoreLoyaltyRedemptionDto, options?: AxiosRequestConfig): AxiosPromise<RestoreLoyaltyRedemptionResponseDto>;
|
|
34425
|
+
}
|
|
34426
|
+
/**
|
|
34427
|
+
* LoyaltyCommerceApi - object-oriented interface
|
|
34428
|
+
* @export
|
|
34429
|
+
* @class LoyaltyCommerceApi
|
|
34430
|
+
* @extends {BaseAPI}
|
|
34431
|
+
*/
|
|
34432
|
+
export declare class LoyaltyCommerceApi extends BaseAPI implements LoyaltyCommerceApiInterface {
|
|
34433
|
+
/**
|
|
34434
|
+
*
|
|
34435
|
+
* @summary Ask the loyalty ledger to restore a settled redemption
|
|
34436
|
+
* @param {RestoreLoyaltyRedemptionDto} restoreLoyaltyRedemptionDto
|
|
34437
|
+
* @param {*} [options] Override http request option.
|
|
34438
|
+
* @throws {RequiredError}
|
|
34439
|
+
* @memberof LoyaltyCommerceApi
|
|
34440
|
+
*/
|
|
34441
|
+
restoreRedemption(restoreLoyaltyRedemptionDto: RestoreLoyaltyRedemptionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RestoreLoyaltyRedemptionResponseDto, any, {}>>;
|
|
34442
|
+
}
|
|
33537
34443
|
/**
|
|
33538
34444
|
* LoyaltyIntegerationsApi - axios parameter creator
|
|
33539
34445
|
* @export
|
|
@@ -33609,6 +34515,14 @@ export declare const LoyaltyIntegerationsApiAxiosParamCreator: (configuration?:
|
|
|
33609
34515
|
* @throws {RequiredError}
|
|
33610
34516
|
*/
|
|
33611
34517
|
getUserWallet: (businessId: number, userId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
34518
|
+
/**
|
|
34519
|
+
*
|
|
34520
|
+
* @summary Resolve the loyalty member context for a member on a till surface
|
|
34521
|
+
* @param {LoyaltyMemberContextRequestDto} loyaltyMemberContextRequestDto
|
|
34522
|
+
* @param {*} [options] Override http request option.
|
|
34523
|
+
* @throws {RequiredError}
|
|
34524
|
+
*/
|
|
34525
|
+
memberContext: (loyaltyMemberContextRequestDto: LoyaltyMemberContextRequestDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
33612
34526
|
/**
|
|
33613
34527
|
*
|
|
33614
34528
|
* @summary Resolve applicable loyalty perks for the current cart (AI)
|
|
@@ -33723,6 +34637,14 @@ export declare const LoyaltyIntegerationsApiFp: (configuration?: Configuration)
|
|
|
33723
34637
|
* @throws {RequiredError}
|
|
33724
34638
|
*/
|
|
33725
34639
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWalletResponseDto>>;
|
|
34640
|
+
/**
|
|
34641
|
+
*
|
|
34642
|
+
* @summary Resolve the loyalty member context for a member on a till surface
|
|
34643
|
+
* @param {LoyaltyMemberContextRequestDto} loyaltyMemberContextRequestDto
|
|
34644
|
+
* @param {*} [options] Override http request option.
|
|
34645
|
+
* @throws {RequiredError}
|
|
34646
|
+
*/
|
|
34647
|
+
memberContext(loyaltyMemberContextRequestDto: LoyaltyMemberContextRequestDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoyaltyMemberContextDto>>;
|
|
33726
34648
|
/**
|
|
33727
34649
|
*
|
|
33728
34650
|
* @summary Resolve applicable loyalty perks for the current cart (AI)
|
|
@@ -33837,6 +34759,14 @@ export declare const LoyaltyIntegerationsApiFactory: (configuration?: Configurat
|
|
|
33837
34759
|
* @throws {RequiredError}
|
|
33838
34760
|
*/
|
|
33839
34761
|
getUserWallet(businessId: number, userId: number, options?: any): AxiosPromise<UserWalletResponseDto>;
|
|
34762
|
+
/**
|
|
34763
|
+
*
|
|
34764
|
+
* @summary Resolve the loyalty member context for a member on a till surface
|
|
34765
|
+
* @param {LoyaltyMemberContextRequestDto} loyaltyMemberContextRequestDto
|
|
34766
|
+
* @param {*} [options] Override http request option.
|
|
34767
|
+
* @throws {RequiredError}
|
|
34768
|
+
*/
|
|
34769
|
+
memberContext(loyaltyMemberContextRequestDto: LoyaltyMemberContextRequestDto, options?: any): AxiosPromise<LoyaltyMemberContextDto>;
|
|
33840
34770
|
/**
|
|
33841
34771
|
*
|
|
33842
34772
|
* @summary Resolve applicable loyalty perks for the current cart (AI)
|
|
@@ -33960,6 +34890,15 @@ export interface LoyaltyIntegerationsApiInterface {
|
|
|
33960
34890
|
* @memberof LoyaltyIntegerationsApiInterface
|
|
33961
34891
|
*/
|
|
33962
34892
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<UserWalletResponseDto>;
|
|
34893
|
+
/**
|
|
34894
|
+
*
|
|
34895
|
+
* @summary Resolve the loyalty member context for a member on a till surface
|
|
34896
|
+
* @param {LoyaltyMemberContextRequestDto} loyaltyMemberContextRequestDto
|
|
34897
|
+
* @param {*} [options] Override http request option.
|
|
34898
|
+
* @throws {RequiredError}
|
|
34899
|
+
* @memberof LoyaltyIntegerationsApiInterface
|
|
34900
|
+
*/
|
|
34901
|
+
memberContext(loyaltyMemberContextRequestDto: LoyaltyMemberContextRequestDto, options?: AxiosRequestConfig): AxiosPromise<LoyaltyMemberContextDto>;
|
|
33963
34902
|
/**
|
|
33964
34903
|
*
|
|
33965
34904
|
* @summary Resolve applicable loyalty perks for the current cart (AI)
|
|
@@ -34088,6 +35027,15 @@ export declare class LoyaltyIntegerationsApi extends BaseAPI implements LoyaltyI
|
|
|
34088
35027
|
* @memberof LoyaltyIntegerationsApi
|
|
34089
35028
|
*/
|
|
34090
35029
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserWalletResponseDto, any, {}>>;
|
|
35030
|
+
/**
|
|
35031
|
+
*
|
|
35032
|
+
* @summary Resolve the loyalty member context for a member on a till surface
|
|
35033
|
+
* @param {LoyaltyMemberContextRequestDto} loyaltyMemberContextRequestDto
|
|
35034
|
+
* @param {*} [options] Override http request option.
|
|
35035
|
+
* @throws {RequiredError}
|
|
35036
|
+
* @memberof LoyaltyIntegerationsApi
|
|
35037
|
+
*/
|
|
35038
|
+
memberContext(loyaltyMemberContextRequestDto: LoyaltyMemberContextRequestDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LoyaltyMemberContextDto, any, {}>>;
|
|
34091
35039
|
/**
|
|
34092
35040
|
*
|
|
34093
35041
|
* @summary Resolve applicable loyalty perks for the current cart (AI)
|
|
@@ -34918,6 +35866,91 @@ export declare class NotificationApi extends BaseAPI implements NotificationApiI
|
|
|
34918
35866
|
*/
|
|
34919
35867
|
removeVenueSubscriptionsV2(deviceSubscriptionDto: DeviceSubscriptionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
34920
35868
|
}
|
|
35869
|
+
/**
|
|
35870
|
+
* OrderCompletionApi - axios parameter creator
|
|
35871
|
+
* @export
|
|
35872
|
+
*/
|
|
35873
|
+
export declare const OrderCompletionApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
35874
|
+
/**
|
|
35875
|
+
*
|
|
35876
|
+
* @summary Complete an order that has nothing left to pay
|
|
35877
|
+
* @param {string} businessId The unique ID of the business the order belongs to.
|
|
35878
|
+
* @param {string} orderId The unique ID of the order.
|
|
35879
|
+
* @param {CompleteOrderDto} completeOrderDto
|
|
35880
|
+
* @param {*} [options] Override http request option.
|
|
35881
|
+
* @throws {RequiredError}
|
|
35882
|
+
*/
|
|
35883
|
+
completeOrder: (businessId: string, orderId: string, completeOrderDto: CompleteOrderDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
35884
|
+
};
|
|
35885
|
+
/**
|
|
35886
|
+
* OrderCompletionApi - functional programming interface
|
|
35887
|
+
* @export
|
|
35888
|
+
*/
|
|
35889
|
+
export declare const OrderCompletionApiFp: (configuration?: Configuration) => {
|
|
35890
|
+
/**
|
|
35891
|
+
*
|
|
35892
|
+
* @summary Complete an order that has nothing left to pay
|
|
35893
|
+
* @param {string} businessId The unique ID of the business the order belongs to.
|
|
35894
|
+
* @param {string} orderId The unique ID of the order.
|
|
35895
|
+
* @param {CompleteOrderDto} completeOrderDto
|
|
35896
|
+
* @param {*} [options] Override http request option.
|
|
35897
|
+
* @throws {RequiredError}
|
|
35898
|
+
*/
|
|
35899
|
+
completeOrder(businessId: string, orderId: string, completeOrderDto: CompleteOrderDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CompleteOrderResponseDto>>;
|
|
35900
|
+
};
|
|
35901
|
+
/**
|
|
35902
|
+
* OrderCompletionApi - factory interface
|
|
35903
|
+
* @export
|
|
35904
|
+
*/
|
|
35905
|
+
export declare const OrderCompletionApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
35906
|
+
/**
|
|
35907
|
+
*
|
|
35908
|
+
* @summary Complete an order that has nothing left to pay
|
|
35909
|
+
* @param {string} businessId The unique ID of the business the order belongs to.
|
|
35910
|
+
* @param {string} orderId The unique ID of the order.
|
|
35911
|
+
* @param {CompleteOrderDto} completeOrderDto
|
|
35912
|
+
* @param {*} [options] Override http request option.
|
|
35913
|
+
* @throws {RequiredError}
|
|
35914
|
+
*/
|
|
35915
|
+
completeOrder(businessId: string, orderId: string, completeOrderDto: CompleteOrderDto, options?: any): AxiosPromise<CompleteOrderResponseDto>;
|
|
35916
|
+
};
|
|
35917
|
+
/**
|
|
35918
|
+
* OrderCompletionApi - interface
|
|
35919
|
+
* @export
|
|
35920
|
+
* @interface OrderCompletionApi
|
|
35921
|
+
*/
|
|
35922
|
+
export interface OrderCompletionApiInterface {
|
|
35923
|
+
/**
|
|
35924
|
+
*
|
|
35925
|
+
* @summary Complete an order that has nothing left to pay
|
|
35926
|
+
* @param {string} businessId The unique ID of the business the order belongs to.
|
|
35927
|
+
* @param {string} orderId The unique ID of the order.
|
|
35928
|
+
* @param {CompleteOrderDto} completeOrderDto
|
|
35929
|
+
* @param {*} [options] Override http request option.
|
|
35930
|
+
* @throws {RequiredError}
|
|
35931
|
+
* @memberof OrderCompletionApiInterface
|
|
35932
|
+
*/
|
|
35933
|
+
completeOrder(businessId: string, orderId: string, completeOrderDto: CompleteOrderDto, options?: AxiosRequestConfig): AxiosPromise<CompleteOrderResponseDto>;
|
|
35934
|
+
}
|
|
35935
|
+
/**
|
|
35936
|
+
* OrderCompletionApi - object-oriented interface
|
|
35937
|
+
* @export
|
|
35938
|
+
* @class OrderCompletionApi
|
|
35939
|
+
* @extends {BaseAPI}
|
|
35940
|
+
*/
|
|
35941
|
+
export declare class OrderCompletionApi extends BaseAPI implements OrderCompletionApiInterface {
|
|
35942
|
+
/**
|
|
35943
|
+
*
|
|
35944
|
+
* @summary Complete an order that has nothing left to pay
|
|
35945
|
+
* @param {string} businessId The unique ID of the business the order belongs to.
|
|
35946
|
+
* @param {string} orderId The unique ID of the order.
|
|
35947
|
+
* @param {CompleteOrderDto} completeOrderDto
|
|
35948
|
+
* @param {*} [options] Override http request option.
|
|
35949
|
+
* @throws {RequiredError}
|
|
35950
|
+
* @memberof OrderCompletionApi
|
|
35951
|
+
*/
|
|
35952
|
+
completeOrder(businessId: string, orderId: string, completeOrderDto: CompleteOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CompleteOrderResponseDto, any, {}>>;
|
|
35953
|
+
}
|
|
34921
35954
|
/**
|
|
34922
35955
|
* OrderInternalApi - axios parameter creator
|
|
34923
35956
|
* @export
|