@munchi_oy/core 2.11.1 → 2.13.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.
@@ -709,6 +709,19 @@ export declare const BasketNotPricedReason: {
709
709
  readonly Unavailable: "UNAVAILABLE";
710
710
  };
711
711
  export type BasketNotPricedReason = typeof BasketNotPricedReason[keyof typeof BasketNotPricedReason];
712
+ /**
713
+ *
714
+ * @export
715
+ * @interface BlockVenueGiftCardDto
716
+ */
717
+ export interface BlockVenueGiftCardDto {
718
+ /**
719
+ * Why the card is blocked, 1 to 200 characters. Absent: no reason.
720
+ * @type {string}
721
+ * @memberof BlockVenueGiftCardDto
722
+ */
723
+ 'reason'?: string;
724
+ }
712
725
  /**
713
726
  *
714
727
  * @export
@@ -1458,6 +1471,8 @@ export interface BusinessLoyaltyPlan {
1458
1471
  */
1459
1472
  export declare const BusinessPaymentIntegrationType: {
1460
1473
  readonly GiftCard: "GiftCard";
1474
+ readonly MunchiGiftCard: "MunchiGiftCard";
1475
+ readonly Epassi: "Epassi";
1461
1476
  };
1462
1477
  export type BusinessPaymentIntegrationType = typeof BusinessPaymentIntegrationType[keyof typeof BusinessPaymentIntegrationType];
1463
1478
  /**
@@ -4599,6 +4614,12 @@ export interface CreateMunchiGiftCardDto {
4599
4614
  * @memberof CreateMunchiGiftCardDto
4600
4615
  */
4601
4616
  'expiresAt'?: string;
4617
+ /**
4618
+ * The till order the card is sold on. With it the card is PENDING, so it cannot pay, until that order is paid; without it (older tills) the card can pay at once, as before
4619
+ * @type {string}
4620
+ * @memberof CreateMunchiGiftCardDto
4621
+ */
4622
+ 'orderId'?: string;
4602
4623
  }
4603
4624
  /**
4604
4625
  *
@@ -4690,6 +4711,12 @@ export interface CreateMunchiGiftCardResponseDto {
4690
4711
  * @memberof CreateMunchiGiftCardResponseDto
4691
4712
  */
4692
4713
  'createdAt': string;
4714
+ /**
4715
+ *
4716
+ * @type {GiftCardStatus}
4717
+ * @memberof CreateMunchiGiftCardResponseDto
4718
+ */
4719
+ 'status'?: GiftCardStatus;
4693
4720
  }
4694
4721
  /**
4695
4722
  *
@@ -5145,6 +5172,55 @@ export interface CreateTerminalPaymentDto {
5145
5172
  */
5146
5173
  'showTransactionResult'?: boolean;
5147
5174
  }
5175
+ /**
5176
+ *
5177
+ * @export
5178
+ * @interface CreateVenueGiftCardDto
5179
+ */
5180
+ export interface CreateVenueGiftCardDto {
5181
+ /**
5182
+ * The card\'s balance, in cents, 100 to 100000
5183
+ * @type {number}
5184
+ * @memberof CreateVenueGiftCardDto
5185
+ */
5186
+ 'amount': number;
5187
+ /**
5188
+ * Whom the card is for, 1 to 120 characters. Absent: nobody is named.
5189
+ * @type {string}
5190
+ * @memberof CreateVenueGiftCardDto
5191
+ */
5192
+ 'recipientName'?: string;
5193
+ /**
5194
+ * A note for the merchant, 1 to 500 characters. Absent: none.
5195
+ * @type {string}
5196
+ * @memberof CreateVenueGiftCardDto
5197
+ */
5198
+ 'note'?: string;
5199
+ /**
5200
+ * The buyer\'s email, at most 254 characters once the spaces around it are dropped. Absent or only spaces: none. Answered as buyerEmail.
5201
+ * @type {string}
5202
+ * @memberof CreateVenueGiftCardDto
5203
+ */
5204
+ 'buyerEmail'?: string;
5205
+ /**
5206
+ * The country code of the buyer\'s phone, 1 to 8 characters once the spaces around it are dropped; sent with phoneNumber or not at all. Absent: none.
5207
+ * @type {string}
5208
+ * @memberof CreateVenueGiftCardDto
5209
+ */
5210
+ 'phoneCountryCode'?: string;
5211
+ /**
5212
+ * The buyer\'s phone number without its country code, 3 to 32 characters once the spaces around it are dropped; sent with phoneCountryCode or not at all. Absent: none.
5213
+ * @type {string}
5214
+ * @memberof CreateVenueGiftCardDto
5215
+ */
5216
+ 'phoneNumber'?: string;
5217
+ /**
5218
+ * When the card stops working, ISO 8601 date-time, not in the past. Absent or null: the settings\' validityMonths from now, or never when that is null.
5219
+ * @type {string}
5220
+ * @memberof CreateVenueGiftCardDto
5221
+ */
5222
+ 'expiresAt'?: string | null;
5223
+ }
5148
5224
  /**
5149
5225
  *
5150
5226
  * @export
@@ -8424,6 +8500,105 @@ export interface GetStationResponseDtoStation {
8424
8500
  */
8425
8501
  'paymentTerminal'?: StationDetailsDtoPaymentTerminal | null;
8426
8502
  }
8503
+ /**
8504
+ *
8505
+ * @export
8506
+ * @interface GiftCardAttentionDto
8507
+ */
8508
+ export interface GiftCardAttentionDto {
8509
+ /**
8510
+ *
8511
+ * @type {GiftCardAttentionDtoExpiringSoon}
8512
+ * @memberof GiftCardAttentionDto
8513
+ */
8514
+ 'expiringSoon': GiftCardAttentionDtoExpiringSoon;
8515
+ /**
8516
+ *
8517
+ * @type {GiftCardAttentionDtoStalePending}
8518
+ * @memberof GiftCardAttentionDto
8519
+ */
8520
+ 'stalePending': GiftCardAttentionDtoStalePending;
8521
+ /**
8522
+ * The days ahead expiringSoon looks
8523
+ * @type {number}
8524
+ * @memberof GiftCardAttentionDto
8525
+ */
8526
+ 'expiringWithinDays': number;
8527
+ }
8528
+ /**
8529
+ * ACTIVE cards that expire within the next expiringWithinDays days: what is on them and how many
8530
+ * @export
8531
+ * @interface GiftCardAttentionDtoExpiringSoon
8532
+ */
8533
+ export interface GiftCardAttentionDtoExpiringSoon {
8534
+ /**
8535
+ * The sum, in cents
8536
+ * @type {number}
8537
+ * @memberof GiftCardAttentionDtoExpiringSoon
8538
+ */
8539
+ 'amount': number;
8540
+ /**
8541
+ * How many cards
8542
+ * @type {number}
8543
+ * @memberof GiftCardAttentionDtoExpiringSoon
8544
+ */
8545
+ 'count': number;
8546
+ }
8547
+ /**
8548
+ * NOT_YET_VALID cards made more than 24 hours ago: their POS order may never have been paid
8549
+ * @export
8550
+ * @interface GiftCardAttentionDtoStalePending
8551
+ */
8552
+ export interface GiftCardAttentionDtoStalePending {
8553
+ /**
8554
+ * How many cards
8555
+ * @type {number}
8556
+ * @memberof GiftCardAttentionDtoStalePending
8557
+ */
8558
+ 'count': number;
8559
+ }
8560
+ /**
8561
+ *
8562
+ * @export
8563
+ * @enum {string}
8564
+ */
8565
+ export declare const GiftCardChannel: {
8566
+ readonly Till: "TILL";
8567
+ readonly OnlineStore: "ONLINE_STORE";
8568
+ };
8569
+ export type GiftCardChannel = typeof GiftCardChannel[keyof typeof GiftCardChannel];
8570
+ /**
8571
+ *
8572
+ * @export
8573
+ * @interface GiftCardChannelsDto
8574
+ */
8575
+ export interface GiftCardChannelsDto {
8576
+ /**
8577
+ * Whether the store\'s till takes gift cards
8578
+ * @type {boolean}
8579
+ * @memberof GiftCardChannelsDto
8580
+ */
8581
+ 'till': boolean;
8582
+ /**
8583
+ * Whether the store\'s online store takes gift cards
8584
+ * @type {boolean}
8585
+ * @memberof GiftCardChannelsDto
8586
+ */
8587
+ 'onlineStore': boolean;
8588
+ }
8589
+ /**
8590
+ *
8591
+ * @export
8592
+ * @interface GiftCardCountDto
8593
+ */
8594
+ export interface GiftCardCountDto {
8595
+ /**
8596
+ * How many cards
8597
+ * @type {number}
8598
+ * @memberof GiftCardCountDto
8599
+ */
8600
+ 'count': number;
8601
+ }
8427
8602
  /**
8428
8603
  *
8429
8604
  * @export
@@ -8537,6 +8712,71 @@ export declare const GiftCardErrorCode: {
8537
8712
  readonly NUMBER_4001: 4001;
8538
8713
  };
8539
8714
  export type GiftCardErrorCode = typeof GiftCardErrorCode[keyof typeof GiftCardErrorCode];
8715
+ /**
8716
+ *
8717
+ * @export
8718
+ * @interface GiftCardHistoryEventDto
8719
+ */
8720
+ export interface GiftCardHistoryEventDto {
8721
+ /**
8722
+ *
8723
+ * @type {GiftCardHistoryKind}
8724
+ * @memberof GiftCardHistoryEventDto
8725
+ */
8726
+ 'kind': GiftCardHistoryKind;
8727
+ /**
8728
+ * How much moved, in cents: never negative, except CORRECTED, which is negative when the correction took money off the card; 0 for BLOCKED, UNBLOCKED and SWITCHED_ON
8729
+ * @type {number}
8730
+ * @memberof GiftCardHistoryEventDto
8731
+ */
8732
+ 'amount': number;
8733
+ /**
8734
+ * The card\'s balance after it, in cents; null for BLOCKED, UNBLOCKED and SWITCHED_ON
8735
+ * @type {number}
8736
+ * @memberof GiftCardHistoryEventDto
8737
+ */
8738
+ 'balanceAfter': number | null;
8739
+ /**
8740
+ * The store where it happened; null when the history did not record one
8741
+ * @type {number}
8742
+ * @memberof GiftCardHistoryEventDto
8743
+ */
8744
+ 'venueId': number | null;
8745
+ /**
8746
+ * That store\'s name; null with venueId, or when the store is gone
8747
+ * @type {string}
8748
+ * @memberof GiftCardHistoryEventDto
8749
+ */
8750
+ 'venueName': string | null;
8751
+ /**
8752
+ * The till order it belongs to; null when none
8753
+ * @type {string}
8754
+ * @memberof GiftCardHistoryEventDto
8755
+ */
8756
+ 'orderId': string | null;
8757
+ /**
8758
+ * When it happened, ISO 8601
8759
+ * @type {string}
8760
+ * @memberof GiftCardHistoryEventDto
8761
+ */
8762
+ 'at': string;
8763
+ }
8764
+ /**
8765
+ *
8766
+ * @export
8767
+ * @enum {string}
8768
+ */
8769
+ export declare const GiftCardHistoryKind: {
8770
+ readonly Sold: "SOLD";
8771
+ readonly CreatedByHand: "CREATED_BY_HAND";
8772
+ readonly Spent: "SPENT";
8773
+ readonly GivenBack: "GIVEN_BACK";
8774
+ readonly Corrected: "CORRECTED";
8775
+ readonly Blocked: "BLOCKED";
8776
+ readonly Unblocked: "UNBLOCKED";
8777
+ readonly SwitchedOn: "SWITCHED_ON";
8778
+ };
8779
+ export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
8540
8780
  /**
8541
8781
  *
8542
8782
  * @export
@@ -8580,6 +8820,17 @@ export interface GiftCardInfoDto {
8580
8820
  */
8581
8821
  'giftCardNumber': string;
8582
8822
  }
8823
+ /**
8824
+ *
8825
+ * @export
8826
+ * @enum {string}
8827
+ */
8828
+ export declare const GiftCardIssue: {
8829
+ readonly TillSale: "TILL_SALE";
8830
+ readonly OnlineSale: "ONLINE_SALE";
8831
+ readonly ByHand: "BY_HAND";
8832
+ };
8833
+ export type GiftCardIssue = typeof GiftCardIssue[keyof typeof GiftCardIssue];
8583
8834
  /**
8584
8835
  *
8585
8836
  * @export
@@ -8599,6 +8850,707 @@ export interface GiftCardLinksDto {
8599
8850
  */
8600
8851
  'validate'?: string;
8601
8852
  }
8853
+ /**
8854
+ *
8855
+ * @export
8856
+ * @interface GiftCardMoneyDto
8857
+ */
8858
+ export interface GiftCardMoneyDto {
8859
+ /**
8860
+ * The sum, in cents
8861
+ * @type {number}
8862
+ * @memberof GiftCardMoneyDto
8863
+ */
8864
+ 'amount': number;
8865
+ /**
8866
+ * How many cards
8867
+ * @type {number}
8868
+ * @memberof GiftCardMoneyDto
8869
+ */
8870
+ 'count': number;
8871
+ }
8872
+ /**
8873
+ *
8874
+ * @export
8875
+ * @interface GiftCardMoneyWentDto
8876
+ */
8877
+ export interface GiftCardMoneyWentDto {
8878
+ /**
8879
+ * What has left the cards, in cents: their first balances less what is on them now. A card\'s balance always equals its history added up, so this is every payment less every give-back, and any correction of the history (a correction that took money off counts here).
8880
+ * @type {number}
8881
+ * @memberof GiftCardMoneyWentDto
8882
+ */
8883
+ 'spent': number;
8884
+ /**
8885
+ * On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
8886
+ * @type {number}
8887
+ * @memberof GiftCardMoneyWentDto
8888
+ */
8889
+ 'onCards': number;
8890
+ /**
8891
+ * Left on EXPIRED cards, in cents
8892
+ * @type {number}
8893
+ * @memberof GiftCardMoneyWentDto
8894
+ */
8895
+ 'expiredUnused': number;
8896
+ /**
8897
+ * Left on BLOCKED cards, in cents
8898
+ * @type {number}
8899
+ * @memberof GiftCardMoneyWentDto
8900
+ */
8901
+ 'blocked': number;
8902
+ }
8903
+ /**
8904
+ *
8905
+ * @export
8906
+ * @interface GiftCardMovementDto
8907
+ */
8908
+ export interface GiftCardMovementDto {
8909
+ /**
8910
+ * The movement\'s id
8911
+ * @type {string}
8912
+ * @memberof GiftCardMovementDto
8913
+ */
8914
+ 'id': string;
8915
+ /**
8916
+ * When it happened, ISO 8601
8917
+ * @type {string}
8918
+ * @memberof GiftCardMovementDto
8919
+ */
8920
+ 'at': string;
8921
+ /**
8922
+ * The card\'s id
8923
+ * @type {string}
8924
+ * @memberof GiftCardMovementDto
8925
+ */
8926
+ 'cardId': string;
8927
+ /**
8928
+ * The card\'s 6-digit code
8929
+ * @type {string}
8930
+ * @memberof GiftCardMovementDto
8931
+ */
8932
+ 'code': string;
8933
+ /**
8934
+ *
8935
+ * @type {GiftCardHistoryKind}
8936
+ * @memberof GiftCardMovementDto
8937
+ */
8938
+ 'kind': GiftCardHistoryKind;
8939
+ /**
8940
+ * How the card\'s balance moved, in cents: positive for SOLD, CREATED_BY_HAND and GIVEN_BACK, negative for SPENT, either for CORRECTED
8941
+ * @type {number}
8942
+ * @memberof GiftCardMovementDto
8943
+ */
8944
+ 'amount': number;
8945
+ /**
8946
+ * The card\'s balance after it, in cents
8947
+ * @type {number}
8948
+ * @memberof GiftCardMovementDto
8949
+ */
8950
+ 'balanceAfter': number;
8951
+ /**
8952
+ * The store where it happened; null when the history did not record one
8953
+ * @type {number}
8954
+ * @memberof GiftCardMovementDto
8955
+ */
8956
+ 'venueId': number | null;
8957
+ /**
8958
+ * That store\'s name; null with venueId, or when the store is gone
8959
+ * @type {string}
8960
+ * @memberof GiftCardMovementDto
8961
+ */
8962
+ 'venueName': string | null;
8963
+ /**
8964
+ * The POS order it belongs to; null when none
8965
+ * @type {string}
8966
+ * @memberof GiftCardMovementDto
8967
+ */
8968
+ 'orderId': string | null;
8969
+ /**
8970
+ * True for a SOLD movement whose card is still NOT_YET_VALID: its POS order is not paid yet, and the report\'s sold leaves it out
8971
+ * @type {boolean}
8972
+ * @memberof GiftCardMovementDto
8973
+ */
8974
+ 'pending': boolean;
8975
+ }
8976
+ /**
8977
+ *
8978
+ * @export
8979
+ * @interface GiftCardMovementsDto
8980
+ */
8981
+ export interface GiftCardMovementsDto {
8982
+ /**
8983
+ * The page\'s movements, newest first
8984
+ * @type {Array<GiftCardMovementDto>}
8985
+ * @memberof GiftCardMovementsDto
8986
+ */
8987
+ 'movements': Array<GiftCardMovementDto>;
8988
+ /**
8989
+ * The cursor of the next page; null when this page is the last
8990
+ * @type {string}
8991
+ * @memberof GiftCardMovementsDto
8992
+ */
8993
+ 'nextCursor': string | null;
8994
+ }
8995
+ /**
8996
+ *
8997
+ * @export
8998
+ * @interface GiftCardPeriodTotalsDto
8999
+ */
9000
+ export interface GiftCardPeriodTotalsDto {
9001
+ /**
9002
+ *
9003
+ * @type {GiftCardPeriodTotalsDtoSold}
9004
+ * @memberof GiftCardPeriodTotalsDto
9005
+ */
9006
+ 'sold': GiftCardPeriodTotalsDtoSold;
9007
+ /**
9008
+ *
9009
+ * @type {GiftCardPeriodTotalsDtoGivenFree}
9010
+ * @memberof GiftCardPeriodTotalsDto
9011
+ */
9012
+ 'givenFree': GiftCardPeriodTotalsDtoGivenFree;
9013
+ /**
9014
+ *
9015
+ * @type {GiftCardPeriodTotalsDtoSpent}
9016
+ * @memberof GiftCardPeriodTotalsDto
9017
+ */
9018
+ 'spent': GiftCardPeriodTotalsDtoSpent;
9019
+ }
9020
+ /**
9021
+ * Cards made by hand
9022
+ * @export
9023
+ * @interface GiftCardPeriodTotalsDtoGivenFree
9024
+ */
9025
+ export interface GiftCardPeriodTotalsDtoGivenFree {
9026
+ /**
9027
+ * The sum, in cents
9028
+ * @type {number}
9029
+ * @memberof GiftCardPeriodTotalsDtoGivenFree
9030
+ */
9031
+ 'amount': number;
9032
+ /**
9033
+ * How many cards
9034
+ * @type {number}
9035
+ * @memberof GiftCardPeriodTotalsDtoGivenFree
9036
+ */
9037
+ 'count': number;
9038
+ }
9039
+ /**
9040
+ * Cards sold, at the till or online
9041
+ * @export
9042
+ * @interface GiftCardPeriodTotalsDtoSold
9043
+ */
9044
+ export interface GiftCardPeriodTotalsDtoSold {
9045
+ /**
9046
+ * The sum, in cents
9047
+ * @type {number}
9048
+ * @memberof GiftCardPeriodTotalsDtoSold
9049
+ */
9050
+ 'amount': number;
9051
+ /**
9052
+ * How many cards
9053
+ * @type {number}
9054
+ * @memberof GiftCardPeriodTotalsDtoSold
9055
+ */
9056
+ 'count': number;
9057
+ }
9058
+ /**
9059
+ * Cards spent
9060
+ * @export
9061
+ * @interface GiftCardPeriodTotalsDtoSpent
9062
+ */
9063
+ export interface GiftCardPeriodTotalsDtoSpent {
9064
+ /**
9065
+ * Taken off cards, less what went back on them, in cents
9066
+ * @type {number}
9067
+ * @memberof GiftCardPeriodTotalsDtoSpent
9068
+ */
9069
+ 'amount': number;
9070
+ /**
9071
+ * How many orders cards paid that kept the payment
9072
+ * @type {number}
9073
+ * @memberof GiftCardPeriodTotalsDtoSpent
9074
+ */
9075
+ 'orderCount': number;
9076
+ }
9077
+ /**
9078
+ *
9079
+ * @export
9080
+ * @interface GiftCardReportDto
9081
+ */
9082
+ export interface GiftCardReportDto {
9083
+ /**
9084
+ *
9085
+ * @type {CurrencyCode}
9086
+ * @memberof GiftCardReportDto
9087
+ */
9088
+ 'currency': CurrencyCode;
9089
+ /**
9090
+ *
9091
+ * @type {GiftCardReportDtoSold}
9092
+ * @memberof GiftCardReportDto
9093
+ */
9094
+ 'sold': GiftCardReportDtoSold;
9095
+ /**
9096
+ *
9097
+ * @type {GiftCardReportDtoGivenFree}
9098
+ * @memberof GiftCardReportDto
9099
+ */
9100
+ 'givenFree': GiftCardReportDtoGivenFree;
9101
+ /**
9102
+ *
9103
+ * @type {GiftCardReportDtoSpent}
9104
+ * @memberof GiftCardReportDto
9105
+ */
9106
+ 'spent': GiftCardReportDtoSpent;
9107
+ /**
9108
+ * Right now, what is left on the owner\'s cards that are ACTIVE, in cents
9109
+ * @type {number}
9110
+ * @memberof GiftCardReportDto
9111
+ */
9112
+ 'leftOnCards': number;
9113
+ /**
9114
+ * One row per store with any movement in the period
9115
+ * @type {Array<GiftCardStoreReportDto>}
9116
+ * @memberof GiftCardReportDto
9117
+ */
9118
+ 'stores': Array<GiftCardStoreReportDto>;
9119
+ /**
9120
+ *
9121
+ * @type {GiftCardReportDtoPrevious}
9122
+ * @memberof GiftCardReportDto
9123
+ */
9124
+ 'previous': GiftCardReportDtoPrevious;
9125
+ /**
9126
+ *
9127
+ * @type {GiftCardReportDtoMoneyWent}
9128
+ * @memberof GiftCardReportDto
9129
+ */
9130
+ 'moneyWent': GiftCardReportDtoMoneyWent;
9131
+ /**
9132
+ *
9133
+ * @type {GiftCardReportDtoAttention}
9134
+ * @memberof GiftCardReportDto
9135
+ */
9136
+ 'attention': GiftCardReportDtoAttention;
9137
+ }
9138
+ /**
9139
+ * Right now: what may need the store\'s attention
9140
+ * @export
9141
+ * @interface GiftCardReportDtoAttention
9142
+ */
9143
+ export interface GiftCardReportDtoAttention {
9144
+ /**
9145
+ *
9146
+ * @type {GiftCardAttentionDtoExpiringSoon}
9147
+ * @memberof GiftCardReportDtoAttention
9148
+ */
9149
+ 'expiringSoon': GiftCardAttentionDtoExpiringSoon;
9150
+ /**
9151
+ *
9152
+ * @type {GiftCardAttentionDtoStalePending}
9153
+ * @memberof GiftCardReportDtoAttention
9154
+ */
9155
+ 'stalePending': GiftCardAttentionDtoStalePending;
9156
+ /**
9157
+ * The days ahead expiringSoon looks
9158
+ * @type {number}
9159
+ * @memberof GiftCardReportDtoAttention
9160
+ */
9161
+ 'expiringWithinDays': number;
9162
+ }
9163
+ /**
9164
+ * Cards made by hand in the period
9165
+ * @export
9166
+ * @interface GiftCardReportDtoGivenFree
9167
+ */
9168
+ export interface GiftCardReportDtoGivenFree {
9169
+ /**
9170
+ * The sum, in cents
9171
+ * @type {number}
9172
+ * @memberof GiftCardReportDtoGivenFree
9173
+ */
9174
+ 'amount': number;
9175
+ /**
9176
+ * How many cards
9177
+ * @type {number}
9178
+ * @memberof GiftCardReportDtoGivenFree
9179
+ */
9180
+ 'count': number;
9181
+ }
9182
+ /**
9183
+ * Right now, over every card of the owner in the currency: where the money paid onto cards went
9184
+ * @export
9185
+ * @interface GiftCardReportDtoMoneyWent
9186
+ */
9187
+ export interface GiftCardReportDtoMoneyWent {
9188
+ /**
9189
+ * What has left the cards, in cents: their first balances less what is on them now. A card\'s balance always equals its history added up, so this is every payment less every give-back, and any correction of the history (a correction that took money off counts here).
9190
+ * @type {number}
9191
+ * @memberof GiftCardReportDtoMoneyWent
9192
+ */
9193
+ 'spent': number;
9194
+ /**
9195
+ * On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
9196
+ * @type {number}
9197
+ * @memberof GiftCardReportDtoMoneyWent
9198
+ */
9199
+ 'onCards': number;
9200
+ /**
9201
+ * Left on EXPIRED cards, in cents
9202
+ * @type {number}
9203
+ * @memberof GiftCardReportDtoMoneyWent
9204
+ */
9205
+ 'expiredUnused': number;
9206
+ /**
9207
+ * Left on BLOCKED cards, in cents
9208
+ * @type {number}
9209
+ * @memberof GiftCardReportDtoMoneyWent
9210
+ */
9211
+ 'blocked': number;
9212
+ }
9213
+ /**
9214
+ * The same sums over the period of the same number of days that ends the day before from
9215
+ * @export
9216
+ * @interface GiftCardReportDtoPrevious
9217
+ */
9218
+ export interface GiftCardReportDtoPrevious {
9219
+ /**
9220
+ *
9221
+ * @type {GiftCardPeriodTotalsDtoSold}
9222
+ * @memberof GiftCardReportDtoPrevious
9223
+ */
9224
+ 'sold': GiftCardPeriodTotalsDtoSold;
9225
+ /**
9226
+ *
9227
+ * @type {GiftCardPeriodTotalsDtoGivenFree}
9228
+ * @memberof GiftCardReportDtoPrevious
9229
+ */
9230
+ 'givenFree': GiftCardPeriodTotalsDtoGivenFree;
9231
+ /**
9232
+ *
9233
+ * @type {GiftCardPeriodTotalsDtoSpent}
9234
+ * @memberof GiftCardReportDtoPrevious
9235
+ */
9236
+ 'spent': GiftCardPeriodTotalsDtoSpent;
9237
+ }
9238
+ /**
9239
+ * Cards sold in the period, at the till or online
9240
+ * @export
9241
+ * @interface GiftCardReportDtoSold
9242
+ */
9243
+ export interface GiftCardReportDtoSold {
9244
+ /**
9245
+ * The sum, in cents
9246
+ * @type {number}
9247
+ * @memberof GiftCardReportDtoSold
9248
+ */
9249
+ 'amount': number;
9250
+ /**
9251
+ * How many cards
9252
+ * @type {number}
9253
+ * @memberof GiftCardReportDtoSold
9254
+ */
9255
+ 'count': number;
9256
+ }
9257
+ /**
9258
+ * Cards spent in the period
9259
+ * @export
9260
+ * @interface GiftCardReportDtoSpent
9261
+ */
9262
+ export interface GiftCardReportDtoSpent {
9263
+ /**
9264
+ * Taken off cards, less what went back on them, in cents
9265
+ * @type {number}
9266
+ * @memberof GiftCardReportDtoSpent
9267
+ */
9268
+ 'amount': number;
9269
+ /**
9270
+ * How many orders cards paid that kept the payment
9271
+ * @type {number}
9272
+ * @memberof GiftCardReportDtoSpent
9273
+ */
9274
+ 'orderCount': number;
9275
+ }
9276
+ /**
9277
+ *
9278
+ * @export
9279
+ * @interface GiftCardSettingsDto
9280
+ */
9281
+ export interface GiftCardSettingsDto {
9282
+ /**
9283
+ *
9284
+ * @type {GiftCardSettingsDtoChannels}
9285
+ * @memberof GiftCardSettingsDto
9286
+ */
9287
+ 'channels': GiftCardSettingsDtoChannels;
9288
+ /**
9289
+ * The store\'s own channels that are on and can take gift cards: TILL for its till, ONLINE_STORE for its online store. A kiosk is never listed.
9290
+ * @type {Array<GiftCardChannel>}
9291
+ * @memberof GiftCardSettingsDto
9292
+ */
9293
+ 'availableChannels': Array<GiftCardChannel>;
9294
+ /**
9295
+ * The amounts offered, in cents, ascending
9296
+ * @type {Array<number>}
9297
+ * @memberof GiftCardSettingsDto
9298
+ */
9299
+ 'amounts': Array<number>;
9300
+ /**
9301
+ * Whether a buyer may choose any amount
9302
+ * @type {boolean}
9303
+ * @memberof GiftCardSettingsDto
9304
+ */
9305
+ 'anyAmount': boolean;
9306
+ /**
9307
+ * The smallest amount a buyer may choose, in cents
9308
+ * @type {number}
9309
+ * @memberof GiftCardSettingsDto
9310
+ */
9311
+ 'minAmount': number;
9312
+ /**
9313
+ * The largest amount a buyer may choose, in cents
9314
+ * @type {number}
9315
+ * @memberof GiftCardSettingsDto
9316
+ */
9317
+ 'maxAmount': number;
9318
+ /**
9319
+ * How many months a new card stays valid; null when cards never expire
9320
+ * @type {number}
9321
+ * @memberof GiftCardSettingsDto
9322
+ */
9323
+ 'validityMonths': number | null;
9324
+ /**
9325
+ * The text printed on the card; null when none
9326
+ * @type {string}
9327
+ * @memberof GiftCardSettingsDto
9328
+ */
9329
+ 'cardText': string | null;
9330
+ /**
9331
+ * The card\'s picture, an https URL; null when none
9332
+ * @type {string}
9333
+ * @memberof GiftCardSettingsDto
9334
+ */
9335
+ 'imageUrl': string | null;
9336
+ }
9337
+ /**
9338
+ * Where the store\'s gift cards can be spent
9339
+ * @export
9340
+ * @interface GiftCardSettingsDtoChannels
9341
+ */
9342
+ export interface GiftCardSettingsDtoChannels {
9343
+ /**
9344
+ * Whether the store\'s till takes gift cards
9345
+ * @type {boolean}
9346
+ * @memberof GiftCardSettingsDtoChannels
9347
+ */
9348
+ 'till': boolean;
9349
+ /**
9350
+ * Whether the store\'s online store takes gift cards
9351
+ * @type {boolean}
9352
+ * @memberof GiftCardSettingsDtoChannels
9353
+ */
9354
+ 'onlineStore': boolean;
9355
+ }
9356
+ /**
9357
+ *
9358
+ * @export
9359
+ * @interface GiftCardSpentDto
9360
+ */
9361
+ export interface GiftCardSpentDto {
9362
+ /**
9363
+ * Taken off cards, less what went back on them, in cents
9364
+ * @type {number}
9365
+ * @memberof GiftCardSpentDto
9366
+ */
9367
+ 'amount': number;
9368
+ /**
9369
+ * How many orders cards paid that kept the payment
9370
+ * @type {number}
9371
+ * @memberof GiftCardSpentDto
9372
+ */
9373
+ 'orderCount': number;
9374
+ }
9375
+ /**
9376
+ *
9377
+ * @export
9378
+ * @enum {string}
9379
+ */
9380
+ export declare const GiftCardState: {
9381
+ readonly Blocked: "BLOCKED";
9382
+ readonly NotYetValid: "NOT_YET_VALID";
9383
+ readonly Expired: "EXPIRED";
9384
+ readonly UsedUp: "USED_UP";
9385
+ readonly Active: "ACTIVE";
9386
+ };
9387
+ export type GiftCardState = typeof GiftCardState[keyof typeof GiftCardState];
9388
+ /**
9389
+ *
9390
+ * @export
9391
+ * @enum {string}
9392
+ */
9393
+ export declare const GiftCardStatus: {
9394
+ readonly Pending: "PENDING";
9395
+ readonly Active: "ACTIVE";
9396
+ };
9397
+ export type GiftCardStatus = typeof GiftCardStatus[keyof typeof GiftCardStatus];
9398
+ /**
9399
+ *
9400
+ * @export
9401
+ * @interface GiftCardStoreReportDto
9402
+ */
9403
+ export interface GiftCardStoreReportDto {
9404
+ /**
9405
+ * The store; null for the history of a merchant\'s cards sold before it recorded the store
9406
+ * @type {number}
9407
+ * @memberof GiftCardStoreReportDto
9408
+ */
9409
+ 'venueId': number | null;
9410
+ /**
9411
+ * The store\'s name; null with venueId, or when the store is gone
9412
+ * @type {string}
9413
+ * @memberof GiftCardStoreReportDto
9414
+ */
9415
+ 'venueName': string | null;
9416
+ /**
9417
+ *
9418
+ * @type {GiftCardStoreReportDtoSold}
9419
+ * @memberof GiftCardStoreReportDto
9420
+ */
9421
+ 'sold': GiftCardStoreReportDtoSold;
9422
+ /**
9423
+ *
9424
+ * @type {GiftCardStoreReportDtoGivenFree}
9425
+ * @memberof GiftCardStoreReportDto
9426
+ */
9427
+ 'givenFree': GiftCardStoreReportDtoGivenFree;
9428
+ /**
9429
+ *
9430
+ * @type {GiftCardStoreReportDtoSpent}
9431
+ * @memberof GiftCardStoreReportDto
9432
+ */
9433
+ 'spent': GiftCardStoreReportDtoSpent;
9434
+ /**
9435
+ * Sold less spent, in cents: what the store took in for cards less what it gave out
9436
+ * @type {number}
9437
+ * @memberof GiftCardStoreReportDto
9438
+ */
9439
+ 'difference': number;
9440
+ }
9441
+ /**
9442
+ * Cards made by hand at the store
9443
+ * @export
9444
+ * @interface GiftCardStoreReportDtoGivenFree
9445
+ */
9446
+ export interface GiftCardStoreReportDtoGivenFree {
9447
+ /**
9448
+ * The sum, in cents
9449
+ * @type {number}
9450
+ * @memberof GiftCardStoreReportDtoGivenFree
9451
+ */
9452
+ 'amount': number;
9453
+ /**
9454
+ * How many cards
9455
+ * @type {number}
9456
+ * @memberof GiftCardStoreReportDtoGivenFree
9457
+ */
9458
+ 'count': number;
9459
+ }
9460
+ /**
9461
+ * Cards sold at the store
9462
+ * @export
9463
+ * @interface GiftCardStoreReportDtoSold
9464
+ */
9465
+ export interface GiftCardStoreReportDtoSold {
9466
+ /**
9467
+ * The sum, in cents
9468
+ * @type {number}
9469
+ * @memberof GiftCardStoreReportDtoSold
9470
+ */
9471
+ 'amount': number;
9472
+ /**
9473
+ * How many cards
9474
+ * @type {number}
9475
+ * @memberof GiftCardStoreReportDtoSold
9476
+ */
9477
+ 'count': number;
9478
+ }
9479
+ /**
9480
+ * Cards spent at the store
9481
+ * @export
9482
+ * @interface GiftCardStoreReportDtoSpent
9483
+ */
9484
+ export interface GiftCardStoreReportDtoSpent {
9485
+ /**
9486
+ * Taken off cards, less what went back on them, in cents
9487
+ * @type {number}
9488
+ * @memberof GiftCardStoreReportDtoSpent
9489
+ */
9490
+ 'amount': number;
9491
+ /**
9492
+ * How many orders cards paid that kept the payment
9493
+ * @type {number}
9494
+ * @memberof GiftCardStoreReportDtoSpent
9495
+ */
9496
+ 'orderCount': number;
9497
+ }
9498
+ /**
9499
+ *
9500
+ * @export
9501
+ * @interface GiveBackMunchiGiftCardDto
9502
+ */
9503
+ export interface GiveBackMunchiGiftCardDto {
9504
+ /**
9505
+ * The venue\'s orderingBusinessId: the venue whose till made the redemption
9506
+ * @type {number}
9507
+ * @memberof GiveBackMunchiGiftCardDto
9508
+ */
9509
+ 'orderingBusinessId': number;
9510
+ /**
9511
+ * The X-Idempotency-Key the till sent with the redemption to give back; 8 to 100 letters, digits, \'-\' or \'_\'
9512
+ * @type {string}
9513
+ * @memberof GiveBackMunchiGiftCardDto
9514
+ */
9515
+ 'idempotencyKey': string;
9516
+ }
9517
+ /**
9518
+ *
9519
+ * @export
9520
+ * @interface GiveBackMunchiGiftCardResponseDto
9521
+ */
9522
+ export interface GiveBackMunchiGiftCardResponseDto {
9523
+ /**
9524
+ * true when the redemption\'s amount is back on the card: given back now, or already before
9525
+ * @type {boolean}
9526
+ * @memberof GiveBackMunchiGiftCardResponseDto
9527
+ */
9528
+ 'success': boolean;
9529
+ /**
9530
+ *
9531
+ * @type {GiftCardErrorCode}
9532
+ * @memberof GiveBackMunchiGiftCardResponseDto
9533
+ */
9534
+ 'errorCode'?: GiftCardErrorCode | null;
9535
+ /**
9536
+ * On success: the amount put back on the card, in cents
9537
+ * @type {number}
9538
+ * @memberof GiveBackMunchiGiftCardResponseDto
9539
+ */
9540
+ 'givenBackAmount'?: number;
9541
+ /**
9542
+ * On success: what the card holds now, in units of its currency (euros for EUR, not cents)
9543
+ * @type {number}
9544
+ * @memberof GiveBackMunchiGiftCardResponseDto
9545
+ */
9546
+ 'remainingBalance'?: number;
9547
+ /**
9548
+ *
9549
+ * @type {CurrencyCode}
9550
+ * @memberof GiveBackMunchiGiftCardResponseDto
9551
+ */
9552
+ 'currency'?: CurrencyCode;
9553
+ }
8602
9554
  /**
8603
9555
  *
8604
9556
  * @export
@@ -13157,6 +14109,18 @@ export interface MunchiGiftCardDataItemDto {
13157
14109
  * @memberof MunchiGiftCardDataItemDto
13158
14110
  */
13159
14111
  'id': string;
14112
+ /**
14113
+ *
14114
+ * @type {GiftCardStatus}
14115
+ * @memberof MunchiGiftCardDataItemDto
14116
+ */
14117
+ 'status'?: GiftCardStatus;
14118
+ /**
14119
+ * Whether the card is blocked: no till or store takes it, whatever its status says. Absent from servers before it.
14120
+ * @type {boolean}
14121
+ * @memberof MunchiGiftCardDataItemDto
14122
+ */
14123
+ 'blocked'?: boolean;
13160
14124
  /**
13161
14125
  * The card\'s 6-digit code
13162
14126
  * @type {string}
@@ -24970,7 +25934,7 @@ export interface RecordWorldlineA2aResultDtoAnswer {
24970
25934
  */
24971
25935
  'remark'?: string;
24972
25936
  /**
24973
- * The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s answer, which is refused when it is not the session\'s. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
25937
+ * The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it (WPI answers a cancel without a reference) and then only ends the wait. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
24974
25938
  * @type {string}
24975
25939
  * @memberof RecordWorldlineA2aResultDtoAnswer
24976
25940
  */
@@ -25072,6 +26036,12 @@ export interface RedeemGiftCardDto {
25072
26036
  * @memberof RedeemGiftCardDto
25073
26037
  */
25074
26038
  'orderingBusinessId': number;
26039
+ /**
26040
+ * The id of the till order the card pays for. Munchi\'s own cards keep it on the redemption, so the redemption can be traced to its order; Luckiefun cards do not read it. Absent from older tills
26041
+ * @type {string}
26042
+ * @memberof RedeemGiftCardDto
26043
+ */
26044
+ 'orderId'?: string;
25075
26045
  }
25076
26046
  /**
25077
26047
  *
@@ -34810,6 +35780,80 @@ export interface UpdateFloorSectionDto {
34810
35780
  */
34811
35781
  'sortOrder'?: number;
34812
35782
  }
35783
+ /**
35784
+ *
35785
+ * @export
35786
+ * @interface UpdateGiftCardSettingsDto
35787
+ */
35788
+ export interface UpdateGiftCardSettingsDto {
35789
+ /**
35790
+ *
35791
+ * @type {UpdateGiftCardSettingsDtoChannels}
35792
+ * @memberof UpdateGiftCardSettingsDto
35793
+ */
35794
+ 'channels'?: UpdateGiftCardSettingsDtoChannels;
35795
+ /**
35796
+ * The amounts offered, in cents: 1 to 6 different amounts, each 100 to 100000. Stored ascending. Absent: unchanged.
35797
+ * @type {Array<number>}
35798
+ * @memberof UpdateGiftCardSettingsDto
35799
+ */
35800
+ 'amounts'?: Array<number>;
35801
+ /**
35802
+ * Whether a buyer may choose any amount. Absent: unchanged.
35803
+ * @type {boolean}
35804
+ * @memberof UpdateGiftCardSettingsDto
35805
+ */
35806
+ 'anyAmount'?: boolean;
35807
+ /**
35808
+ * The smallest amount a buyer may choose, in cents, 100 to 100000; not above maxAmount once merged with what is stored. Absent: unchanged.
35809
+ * @type {number}
35810
+ * @memberof UpdateGiftCardSettingsDto
35811
+ */
35812
+ 'minAmount'?: number;
35813
+ /**
35814
+ * The largest amount a buyer may choose, in cents, 100 to 100000; not below minAmount once merged with what is stored. Absent: unchanged.
35815
+ * @type {number}
35816
+ * @memberof UpdateGiftCardSettingsDto
35817
+ */
35818
+ 'maxAmount'?: number;
35819
+ /**
35820
+ * How many months a new card stays valid, 1 to 60, or null for never. Absent: unchanged.
35821
+ * @type {number}
35822
+ * @memberof UpdateGiftCardSettingsDto
35823
+ */
35824
+ 'validityMonths'?: number | null;
35825
+ /**
35826
+ * The text printed on the card, 1 to 120 characters, or null for none. Absent: unchanged.
35827
+ * @type {string}
35828
+ * @memberof UpdateGiftCardSettingsDto
35829
+ */
35830
+ 'cardText'?: string | null;
35831
+ /**
35832
+ * The card\'s picture, an https URL of at most 2048 characters, or null for none. Absent: unchanged.
35833
+ * @type {string}
35834
+ * @memberof UpdateGiftCardSettingsDto
35835
+ */
35836
+ 'imageUrl'?: string | null;
35837
+ }
35838
+ /**
35839
+ * Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
35840
+ * @export
35841
+ * @interface UpdateGiftCardSettingsDtoChannels
35842
+ */
35843
+ export interface UpdateGiftCardSettingsDtoChannels {
35844
+ /**
35845
+ * Whether the store\'s till takes gift cards
35846
+ * @type {boolean}
35847
+ * @memberof UpdateGiftCardSettingsDtoChannels
35848
+ */
35849
+ 'till': boolean;
35850
+ /**
35851
+ * Whether the store\'s online store takes gift cards
35852
+ * @type {boolean}
35853
+ * @memberof UpdateGiftCardSettingsDtoChannels
35854
+ */
35855
+ 'onlineStore': boolean;
35856
+ }
34813
35857
  /**
34814
35858
  *
34815
35859
  * @export
@@ -36386,6 +37430,231 @@ export interface VenueFoundDto {
36386
37430
  */
36387
37431
  'chainId': string | null;
36388
37432
  }
37433
+ /**
37434
+ *
37435
+ * @export
37436
+ * @interface VenueGiftCardDetailDto
37437
+ */
37438
+ export interface VenueGiftCardDetailDto {
37439
+ /**
37440
+ * The card\'s id
37441
+ * @type {string}
37442
+ * @memberof VenueGiftCardDetailDto
37443
+ */
37444
+ 'id': string;
37445
+ /**
37446
+ * The 6-digit code the customer gives
37447
+ * @type {string}
37448
+ * @memberof VenueGiftCardDetailDto
37449
+ */
37450
+ 'code': string;
37451
+ /**
37452
+ *
37453
+ * @type {GiftCardState}
37454
+ * @memberof VenueGiftCardDetailDto
37455
+ */
37456
+ 'state': GiftCardState;
37457
+ /**
37458
+ *
37459
+ * @type {GiftCardIssue}
37460
+ * @memberof VenueGiftCardDetailDto
37461
+ */
37462
+ 'issuedAs': GiftCardIssue;
37463
+ /**
37464
+ *
37465
+ * @type {CurrencyCode}
37466
+ * @memberof VenueGiftCardDetailDto
37467
+ */
37468
+ 'currency': CurrencyCode;
37469
+ /**
37470
+ * The card\'s first balance, in cents
37471
+ * @type {number}
37472
+ * @memberof VenueGiftCardDetailDto
37473
+ */
37474
+ 'initialBalance': number;
37475
+ /**
37476
+ * What is left on the card, in cents
37477
+ * @type {number}
37478
+ * @memberof VenueGiftCardDetailDto
37479
+ */
37480
+ 'remainingBalance': number;
37481
+ /**
37482
+ * Who bought the card, or whom a card made by hand is for; null when nobody was named
37483
+ * @type {string}
37484
+ * @memberof VenueGiftCardDetailDto
37485
+ */
37486
+ 'buyerName': string | null;
37487
+ /**
37488
+ * The buyer\'s email; null when none was given
37489
+ * @type {string}
37490
+ * @memberof VenueGiftCardDetailDto
37491
+ */
37492
+ 'buyerEmail': string | null;
37493
+ /**
37494
+ * The buyer\'s phone: its country code and number, a space between; null when no number was given
37495
+ * @type {string}
37496
+ * @memberof VenueGiftCardDetailDto
37497
+ */
37498
+ 'buyerPhone': string | null;
37499
+ /**
37500
+ * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37501
+ * @type {number}
37502
+ * @memberof VenueGiftCardDetailDto
37503
+ */
37504
+ 'soldAtVenueId': number | null;
37505
+ /**
37506
+ * That store\'s name; null with soldAtVenueId, or when the store is gone
37507
+ * @type {string}
37508
+ * @memberof VenueGiftCardDetailDto
37509
+ */
37510
+ 'soldAtVenueName': string | null;
37511
+ /**
37512
+ * When the card stops working, ISO 8601; null when it never expires
37513
+ * @type {string}
37514
+ * @memberof VenueGiftCardDetailDto
37515
+ */
37516
+ 'expiresAt': string | null;
37517
+ /**
37518
+ * When the card was made, ISO 8601
37519
+ * @type {string}
37520
+ * @memberof VenueGiftCardDetailDto
37521
+ */
37522
+ 'createdAt': string;
37523
+ /**
37524
+ * The note written on a card made by hand; null when none
37525
+ * @type {string}
37526
+ * @memberof VenueGiftCardDetailDto
37527
+ */
37528
+ 'note': string | null;
37529
+ /**
37530
+ * When the card was blocked, ISO 8601; null while it is not blocked
37531
+ * @type {string}
37532
+ * @memberof VenueGiftCardDetailDto
37533
+ */
37534
+ 'blockedAt': string | null;
37535
+ /**
37536
+ * Why it was blocked; null while it is not blocked or no reason was given
37537
+ * @type {string}
37538
+ * @memberof VenueGiftCardDetailDto
37539
+ */
37540
+ 'blockReason': string | null;
37541
+ /**
37542
+ * What happened to the card, oldest first
37543
+ * @type {Array<GiftCardHistoryEventDto>}
37544
+ * @memberof VenueGiftCardDetailDto
37545
+ */
37546
+ 'history': Array<GiftCardHistoryEventDto>;
37547
+ }
37548
+ /**
37549
+ *
37550
+ * @export
37551
+ * @interface VenueGiftCardDto
37552
+ */
37553
+ export interface VenueGiftCardDto {
37554
+ /**
37555
+ * The card\'s id
37556
+ * @type {string}
37557
+ * @memberof VenueGiftCardDto
37558
+ */
37559
+ 'id': string;
37560
+ /**
37561
+ * The 6-digit code the customer gives
37562
+ * @type {string}
37563
+ * @memberof VenueGiftCardDto
37564
+ */
37565
+ 'code': string;
37566
+ /**
37567
+ *
37568
+ * @type {GiftCardState}
37569
+ * @memberof VenueGiftCardDto
37570
+ */
37571
+ 'state': GiftCardState;
37572
+ /**
37573
+ *
37574
+ * @type {GiftCardIssue}
37575
+ * @memberof VenueGiftCardDto
37576
+ */
37577
+ 'issuedAs': GiftCardIssue;
37578
+ /**
37579
+ *
37580
+ * @type {CurrencyCode}
37581
+ * @memberof VenueGiftCardDto
37582
+ */
37583
+ 'currency': CurrencyCode;
37584
+ /**
37585
+ * The card\'s first balance, in cents
37586
+ * @type {number}
37587
+ * @memberof VenueGiftCardDto
37588
+ */
37589
+ 'initialBalance': number;
37590
+ /**
37591
+ * What is left on the card, in cents
37592
+ * @type {number}
37593
+ * @memberof VenueGiftCardDto
37594
+ */
37595
+ 'remainingBalance': number;
37596
+ /**
37597
+ * Who bought the card, or whom a card made by hand is for; null when nobody was named
37598
+ * @type {string}
37599
+ * @memberof VenueGiftCardDto
37600
+ */
37601
+ 'buyerName': string | null;
37602
+ /**
37603
+ * The buyer\'s email; null when none was given
37604
+ * @type {string}
37605
+ * @memberof VenueGiftCardDto
37606
+ */
37607
+ 'buyerEmail': string | null;
37608
+ /**
37609
+ * The buyer\'s phone: its country code and number, a space between; null when no number was given
37610
+ * @type {string}
37611
+ * @memberof VenueGiftCardDto
37612
+ */
37613
+ 'buyerPhone': string | null;
37614
+ /**
37615
+ * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37616
+ * @type {number}
37617
+ * @memberof VenueGiftCardDto
37618
+ */
37619
+ 'soldAtVenueId': number | null;
37620
+ /**
37621
+ * That store\'s name; null with soldAtVenueId, or when the store is gone
37622
+ * @type {string}
37623
+ * @memberof VenueGiftCardDto
37624
+ */
37625
+ 'soldAtVenueName': string | null;
37626
+ /**
37627
+ * When the card stops working, ISO 8601; null when it never expires
37628
+ * @type {string}
37629
+ * @memberof VenueGiftCardDto
37630
+ */
37631
+ 'expiresAt': string | null;
37632
+ /**
37633
+ * When the card was made, ISO 8601
37634
+ * @type {string}
37635
+ * @memberof VenueGiftCardDto
37636
+ */
37637
+ 'createdAt': string;
37638
+ }
37639
+ /**
37640
+ *
37641
+ * @export
37642
+ * @interface VenueGiftCardsDto
37643
+ */
37644
+ export interface VenueGiftCardsDto {
37645
+ /**
37646
+ * The page\'s cards, newest first
37647
+ * @type {Array<VenueGiftCardDto>}
37648
+ * @memberof VenueGiftCardsDto
37649
+ */
37650
+ 'cards': Array<VenueGiftCardDto>;
37651
+ /**
37652
+ * The cursor of the next page; null when this page is the last
37653
+ * @type {string}
37654
+ * @memberof VenueGiftCardsDto
37655
+ */
37656
+ 'nextCursor': string | null;
37657
+ }
36389
37658
  /**
36390
37659
  *
36391
37660
  * @export
@@ -38928,7 +40197,7 @@ export interface WorldlineAppAnswerDto {
38928
40197
  */
38929
40198
  'remark'?: string;
38930
40199
  /**
38931
- * The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s answer, which is refused when it is not the session\'s. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
40200
+ * The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it (WPI answers a cancel without a reference) and then only ends the wait. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
38932
40201
  * @type {string}
38933
40202
  * @memberof WorldlineAppAnswerDto
38934
40203
  */
@@ -44561,6 +45830,569 @@ export declare class FloorPlanApi extends BaseAPI implements FloorPlanApiInterfa
44561
45830
  */
44562
45831
  updateTableStatus(id: string, businessId: number, updateTableStatusDto: UpdateTableStatusDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DiningTableResponseDto, any, {}>>;
44563
45832
  }
45833
+ /**
45834
+ * GiftCardsApi - axios parameter creator
45835
+ * @export
45836
+ */
45837
+ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configuration) => {
45838
+ /**
45839
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
45840
+ * @summary Switch on a gift card whose till order is not paid yet
45841
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45842
+ * @param {string} cardId The card\&#39;s id
45843
+ * @param {*} [options] Override http request option.
45844
+ * @throws {RequiredError}
45845
+ */
45846
+ activateVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45847
+ /**
45848
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
45849
+ * @summary Block a gift card
45850
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45851
+ * @param {string} cardId The card\&#39;s id
45852
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
45853
+ * @param {*} [options] Override http request option.
45854
+ * @throws {RequiredError}
45855
+ */
45856
+ blockVenueGiftCard: (businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45857
+ /**
45858
+ * A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
45859
+ * @summary Make a gift card by hand, given for free
45860
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45861
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45862
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\&#39;s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
45863
+ * @param {*} [options] Override http request option.
45864
+ * @throws {RequiredError}
45865
+ */
45866
+ createVenueGiftCard: (businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45867
+ /**
45868
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45869
+ * @summary Read one of a store\'s gift cards with its history
45870
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45871
+ * @param {string} cardId The card\&#39;s id
45872
+ * @param {*} [options] Override http request option.
45873
+ * @throws {RequiredError}
45874
+ */
45875
+ getVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45876
+ /**
45877
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
45878
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45879
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45880
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45881
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45882
+ * @param {*} [options] Override http request option.
45883
+ * @throws {RequiredError}
45884
+ */
45885
+ getVenueGiftCardReport: (businessId: number, from: string, to: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45886
+ /**
45887
+ * Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
45888
+ * @summary Read a store\'s gift card settings
45889
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45890
+ * @param {*} [options] Override http request option.
45891
+ * @throws {RequiredError}
45892
+ */
45893
+ getVenueGiftCardSettings: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45894
+ /**
45895
+ * Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
45896
+ * @summary List every movement of a store\'s gift cards in a period, newest first
45897
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45898
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45899
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45900
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
45901
+ * @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
45902
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
45903
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
45904
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
45905
+ * @param {*} [options] Override http request option.
45906
+ * @throws {RequiredError}
45907
+ */
45908
+ listVenueGiftCardMovements: (businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45909
+ /**
45910
+ * The cards of the store\'s owner, newest first (createdAt, then id). search finds a code that starts with it, or a buyer\'s name or email that contains it; state keeps the cards in that state now. Send nextCursor as cursor for the next page. Three statements; nothing is written.
45911
+ * @summary List a store\'s gift cards, newest first, a page at a time
45912
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45913
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
45914
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45915
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45916
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
45917
+ * @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\&#39;s time zone. Absent: any expiry.
45918
+ * @param {*} [options] Override http request option.
45919
+ * @throws {RequiredError}
45920
+ */
45921
+ listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45922
+ /**
45923
+ * The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
45924
+ * @summary Unblock a gift card
45925
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45926
+ * @param {string} cardId The card\&#39;s id
45927
+ * @param {*} [options] Override http request option.
45928
+ * @throws {RequiredError}
45929
+ */
45930
+ unblockVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45931
+ /**
45932
+ * Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
45933
+ * @summary Change a store\'s gift card settings
45934
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45935
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
45936
+ * @param {*} [options] Override http request option.
45937
+ * @throws {RequiredError}
45938
+ */
45939
+ updateVenueGiftCardSettings: (businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45940
+ };
45941
+ /**
45942
+ * GiftCardsApi - functional programming interface
45943
+ * @export
45944
+ */
45945
+ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45946
+ /**
45947
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
45948
+ * @summary Switch on a gift card whose till order is not paid yet
45949
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45950
+ * @param {string} cardId The card\&#39;s id
45951
+ * @param {*} [options] Override http request option.
45952
+ * @throws {RequiredError}
45953
+ */
45954
+ activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45955
+ /**
45956
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
45957
+ * @summary Block a gift card
45958
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45959
+ * @param {string} cardId The card\&#39;s id
45960
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
45961
+ * @param {*} [options] Override http request option.
45962
+ * @throws {RequiredError}
45963
+ */
45964
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45965
+ /**
45966
+ * A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
45967
+ * @summary Make a gift card by hand, given for free
45968
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45969
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45970
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\&#39;s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
45971
+ * @param {*} [options] Override http request option.
45972
+ * @throws {RequiredError}
45973
+ */
45974
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45975
+ /**
45976
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45977
+ * @summary Read one of a store\'s gift cards with its history
45978
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45979
+ * @param {string} cardId The card\&#39;s id
45980
+ * @param {*} [options] Override http request option.
45981
+ * @throws {RequiredError}
45982
+ */
45983
+ getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45984
+ /**
45985
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
45986
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45987
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45988
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45989
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45990
+ * @param {*} [options] Override http request option.
45991
+ * @throws {RequiredError}
45992
+ */
45993
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardReportDto>>;
45994
+ /**
45995
+ * Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
45996
+ * @summary Read a store\'s gift card settings
45997
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45998
+ * @param {*} [options] Override http request option.
45999
+ * @throws {RequiredError}
46000
+ */
46001
+ getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSettingsDto>>;
46002
+ /**
46003
+ * Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46004
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46005
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46006
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46007
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
46008
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46009
+ * @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
46010
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46011
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46012
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46013
+ * @param {*} [options] Override http request option.
46014
+ * @throws {RequiredError}
46015
+ */
46016
+ listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardMovementsDto>>;
46017
+ /**
46018
+ * The cards of the store\'s owner, newest first (createdAt, then id). search finds a code that starts with it, or a buyer\'s name or email that contains it; state keeps the cards in that state now. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46019
+ * @summary List a store\'s gift cards, newest first, a page at a time
46020
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46021
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
46022
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
46023
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
46024
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46025
+ * @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\&#39;s time zone. Absent: any expiry.
46026
+ * @param {*} [options] Override http request option.
46027
+ * @throws {RequiredError}
46028
+ */
46029
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
46030
+ /**
46031
+ * The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
46032
+ * @summary Unblock a gift card
46033
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46034
+ * @param {string} cardId The card\&#39;s id
46035
+ * @param {*} [options] Override http request option.
46036
+ * @throws {RequiredError}
46037
+ */
46038
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
46039
+ /**
46040
+ * Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
46041
+ * @summary Change a store\'s gift card settings
46042
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46043
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
46044
+ * @param {*} [options] Override http request option.
46045
+ * @throws {RequiredError}
46046
+ */
46047
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSettingsDto>>;
46048
+ };
46049
+ /**
46050
+ * GiftCardsApi - factory interface
46051
+ * @export
46052
+ */
46053
+ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
46054
+ /**
46055
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
46056
+ * @summary Switch on a gift card whose till order is not paid yet
46057
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46058
+ * @param {string} cardId The card\&#39;s id
46059
+ * @param {*} [options] Override http request option.
46060
+ * @throws {RequiredError}
46061
+ */
46062
+ activateVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
46063
+ /**
46064
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
46065
+ * @summary Block a gift card
46066
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46067
+ * @param {string} cardId The card\&#39;s id
46068
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
46069
+ * @param {*} [options] Override http request option.
46070
+ * @throws {RequiredError}
46071
+ */
46072
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
46073
+ /**
46074
+ * A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
46075
+ * @summary Make a gift card by hand, given for free
46076
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46077
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
46078
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\&#39;s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
46079
+ * @param {*} [options] Override http request option.
46080
+ * @throws {RequiredError}
46081
+ */
46082
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
46083
+ /**
46084
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
46085
+ * @summary Read one of a store\'s gift cards with its history
46086
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46087
+ * @param {string} cardId The card\&#39;s id
46088
+ * @param {*} [options] Override http request option.
46089
+ * @throws {RequiredError}
46090
+ */
46091
+ getVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
46092
+ /**
46093
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
46094
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
46095
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46096
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46097
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
46098
+ * @param {*} [options] Override http request option.
46099
+ * @throws {RequiredError}
46100
+ */
46101
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: any): AxiosPromise<GiftCardReportDto>;
46102
+ /**
46103
+ * Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
46104
+ * @summary Read a store\'s gift card settings
46105
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46106
+ * @param {*} [options] Override http request option.
46107
+ * @throws {RequiredError}
46108
+ */
46109
+ getVenueGiftCardSettings(businessId: number, options?: any): AxiosPromise<GiftCardSettingsDto>;
46110
+ /**
46111
+ * Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46112
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46113
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46114
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46115
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
46116
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46117
+ * @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
46118
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46119
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46120
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46121
+ * @param {*} [options] Override http request option.
46122
+ * @throws {RequiredError}
46123
+ */
46124
+ listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: any): AxiosPromise<GiftCardMovementsDto>;
46125
+ /**
46126
+ * The cards of the store\'s owner, newest first (createdAt, then id). search finds a code that starts with it, or a buyer\'s name or email that contains it; state keeps the cards in that state now. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46127
+ * @summary List a store\'s gift cards, newest first, a page at a time
46128
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46129
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
46130
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
46131
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
46132
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46133
+ * @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\&#39;s time zone. Absent: any expiry.
46134
+ * @param {*} [options] Override http request option.
46135
+ * @throws {RequiredError}
46136
+ */
46137
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto>;
46138
+ /**
46139
+ * The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
46140
+ * @summary Unblock a gift card
46141
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46142
+ * @param {string} cardId The card\&#39;s id
46143
+ * @param {*} [options] Override http request option.
46144
+ * @throws {RequiredError}
46145
+ */
46146
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
46147
+ /**
46148
+ * Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
46149
+ * @summary Change a store\'s gift card settings
46150
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46151
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
46152
+ * @param {*} [options] Override http request option.
46153
+ * @throws {RequiredError}
46154
+ */
46155
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: any): AxiosPromise<GiftCardSettingsDto>;
46156
+ };
46157
+ /**
46158
+ * GiftCardsApi - interface
46159
+ * @export
46160
+ * @interface GiftCardsApi
46161
+ */
46162
+ export interface GiftCardsApiInterface {
46163
+ /**
46164
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
46165
+ * @summary Switch on a gift card whose till order is not paid yet
46166
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46167
+ * @param {string} cardId The card\&#39;s id
46168
+ * @param {*} [options] Override http request option.
46169
+ * @throws {RequiredError}
46170
+ * @memberof GiftCardsApiInterface
46171
+ */
46172
+ activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
46173
+ /**
46174
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
46175
+ * @summary Block a gift card
46176
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46177
+ * @param {string} cardId The card\&#39;s id
46178
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
46179
+ * @param {*} [options] Override http request option.
46180
+ * @throws {RequiredError}
46181
+ * @memberof GiftCardsApiInterface
46182
+ */
46183
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
46184
+ /**
46185
+ * A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
46186
+ * @summary Make a gift card by hand, given for free
46187
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46188
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
46189
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\&#39;s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
46190
+ * @param {*} [options] Override http request option.
46191
+ * @throws {RequiredError}
46192
+ * @memberof GiftCardsApiInterface
46193
+ */
46194
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
46195
+ /**
46196
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
46197
+ * @summary Read one of a store\'s gift cards with its history
46198
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46199
+ * @param {string} cardId The card\&#39;s id
46200
+ * @param {*} [options] Override http request option.
46201
+ * @throws {RequiredError}
46202
+ * @memberof GiftCardsApiInterface
46203
+ */
46204
+ getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
46205
+ /**
46206
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
46207
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
46208
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46209
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46210
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
46211
+ * @param {*} [options] Override http request option.
46212
+ * @throws {RequiredError}
46213
+ * @memberof GiftCardsApiInterface
46214
+ */
46215
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<GiftCardReportDto>;
46216
+ /**
46217
+ * Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
46218
+ * @summary Read a store\'s gift card settings
46219
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46220
+ * @param {*} [options] Override http request option.
46221
+ * @throws {RequiredError}
46222
+ * @memberof GiftCardsApiInterface
46223
+ */
46224
+ getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
46225
+ /**
46226
+ * Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46227
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46228
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46229
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46230
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
46231
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46232
+ * @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
46233
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46234
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46235
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46236
+ * @param {*} [options] Override http request option.
46237
+ * @throws {RequiredError}
46238
+ * @memberof GiftCardsApiInterface
46239
+ */
46240
+ listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardMovementsDto>;
46241
+ /**
46242
+ * The cards of the store\'s owner, newest first (createdAt, then id). search finds a code that starts with it, or a buyer\'s name or email that contains it; state keeps the cards in that state now. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46243
+ * @summary List a store\'s gift cards, newest first, a page at a time
46244
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46245
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
46246
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
46247
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
46248
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46249
+ * @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\&#39;s time zone. Absent: any expiry.
46250
+ * @param {*} [options] Override http request option.
46251
+ * @throws {RequiredError}
46252
+ * @memberof GiftCardsApiInterface
46253
+ */
46254
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
46255
+ /**
46256
+ * The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
46257
+ * @summary Unblock a gift card
46258
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46259
+ * @param {string} cardId The card\&#39;s id
46260
+ * @param {*} [options] Override http request option.
46261
+ * @throws {RequiredError}
46262
+ * @memberof GiftCardsApiInterface
46263
+ */
46264
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
46265
+ /**
46266
+ * Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
46267
+ * @summary Change a store\'s gift card settings
46268
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46269
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
46270
+ * @param {*} [options] Override http request option.
46271
+ * @throws {RequiredError}
46272
+ * @memberof GiftCardsApiInterface
46273
+ */
46274
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
46275
+ }
46276
+ /**
46277
+ * GiftCardsApi - object-oriented interface
46278
+ * @export
46279
+ * @class GiftCardsApi
46280
+ * @extends {BaseAPI}
46281
+ */
46282
+ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
46283
+ /**
46284
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
46285
+ * @summary Switch on a gift card whose till order is not paid yet
46286
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46287
+ * @param {string} cardId The card\&#39;s id
46288
+ * @param {*} [options] Override http request option.
46289
+ * @throws {RequiredError}
46290
+ * @memberof GiftCardsApi
46291
+ */
46292
+ activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
46293
+ /**
46294
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
46295
+ * @summary Block a gift card
46296
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46297
+ * @param {string} cardId The card\&#39;s id
46298
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
46299
+ * @param {*} [options] Override http request option.
46300
+ * @throws {RequiredError}
46301
+ * @memberof GiftCardsApi
46302
+ */
46303
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
46304
+ /**
46305
+ * A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
46306
+ * @summary Make a gift card by hand, given for free
46307
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46308
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
46309
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\&#39;s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
46310
+ * @param {*} [options] Override http request option.
46311
+ * @throws {RequiredError}
46312
+ * @memberof GiftCardsApi
46313
+ */
46314
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
46315
+ /**
46316
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
46317
+ * @summary Read one of a store\'s gift cards with its history
46318
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46319
+ * @param {string} cardId The card\&#39;s id
46320
+ * @param {*} [options] Override http request option.
46321
+ * @throws {RequiredError}
46322
+ * @memberof GiftCardsApi
46323
+ */
46324
+ getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
46325
+ /**
46326
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
46327
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
46328
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46329
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46330
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
46331
+ * @param {*} [options] Override http request option.
46332
+ * @throws {RequiredError}
46333
+ * @memberof GiftCardsApi
46334
+ */
46335
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardReportDto, any, {}>>;
46336
+ /**
46337
+ * Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
46338
+ * @summary Read a store\'s gift card settings
46339
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46340
+ * @param {*} [options] Override http request option.
46341
+ * @throws {RequiredError}
46342
+ * @memberof GiftCardsApi
46343
+ */
46344
+ getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardSettingsDto, any, {}>>;
46345
+ /**
46346
+ * Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46347
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46348
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46349
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46350
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
46351
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46352
+ * @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
46353
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46354
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46355
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46356
+ * @param {*} [options] Override http request option.
46357
+ * @throws {RequiredError}
46358
+ * @memberof GiftCardsApi
46359
+ */
46360
+ listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardMovementsDto, any, {}>>;
46361
+ /**
46362
+ * The cards of the store\'s owner, newest first (createdAt, then id). search finds a code that starts with it, or a buyer\'s name or email that contains it; state keeps the cards in that state now. Send nextCursor as cursor for the next page. Three statements; nothing is written.
46363
+ * @summary List a store\'s gift cards, newest first, a page at a time
46364
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46365
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
46366
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
46367
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
46368
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46369
+ * @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\&#39;s time zone. Absent: any expiry.
46370
+ * @param {*} [options] Override http request option.
46371
+ * @throws {RequiredError}
46372
+ * @memberof GiftCardsApi
46373
+ */
46374
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
46375
+ /**
46376
+ * The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
46377
+ * @summary Unblock a gift card
46378
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46379
+ * @param {string} cardId The card\&#39;s id
46380
+ * @param {*} [options] Override http request option.
46381
+ * @throws {RequiredError}
46382
+ * @memberof GiftCardsApi
46383
+ */
46384
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
46385
+ /**
46386
+ * Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
46387
+ * @summary Change a store\'s gift card settings
46388
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46389
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
46390
+ * @param {*} [options] Override http request option.
46391
+ * @throws {RequiredError}
46392
+ * @memberof GiftCardsApi
46393
+ */
46394
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardSettingsDto, any, {}>>;
46395
+ }
44564
46396
  /**
44565
46397
  * GiftcardApi - axios parameter creator
44566
46398
  * @export
@@ -47136,13 +48968,14 @@ export declare class MenuApi extends BaseAPI implements MenuApiInterface {
47136
48968
  */
47137
48969
  export declare const MunchiGiftCardApiAxiosParamCreator: (configuration?: Configuration) => {
47138
48970
  /**
47139
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
48971
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47140
48972
  * @summary Create a first-party Munchi gift card
47141
48973
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
48974
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47142
48975
  * @param {*} [options] Override http request option.
47143
48976
  * @throws {RequiredError}
47144
48977
  */
47145
- createMunchiGiftCard: (createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48978
+ createMunchiGiftCard: (createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47146
48979
  /**
47147
48980
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47148
48981
  * @summary Get Munchi gift card data
@@ -47152,13 +48985,22 @@ export declare const MunchiGiftCardApiAxiosParamCreator: (configuration?: Config
47152
48985
  */
47153
48986
  getMunchiGiftCardData: (getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47154
48987
  /**
47155
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
48988
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
48989
+ * @summary Give back a Munchi gift card redemption the till order did not keep
48990
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
48991
+ * @param {*} [options] Override http request option.
48992
+ * @throws {RequiredError}
48993
+ */
48994
+ giveBackMunchiGiftCardRedemption: (giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48995
+ /**
48996
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47156
48997
  * @summary Redeem a first-party Munchi gift card
47157
48998
  * @param {RedeemGiftCardDto} redeemGiftCardDto
48999
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47158
49000
  * @param {*} [options] Override http request option.
47159
49001
  * @throws {RequiredError}
47160
49002
  */
47161
- redeemMunchiGiftCard: (redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
49003
+ redeemMunchiGiftCard: (redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47162
49004
  /**
47163
49005
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47164
49006
  * @summary Validate a first-party Munchi gift card
@@ -47174,13 +49016,14 @@ export declare const MunchiGiftCardApiAxiosParamCreator: (configuration?: Config
47174
49016
  */
47175
49017
  export declare const MunchiGiftCardApiFp: (configuration?: Configuration) => {
47176
49018
  /**
47177
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
49019
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47178
49020
  * @summary Create a first-party Munchi gift card
47179
49021
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
49022
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47180
49023
  * @param {*} [options] Override http request option.
47181
49024
  * @throws {RequiredError}
47182
49025
  */
47183
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMunchiGiftCardResponseDto>>;
49026
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMunchiGiftCardResponseDto>>;
47184
49027
  /**
47185
49028
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47186
49029
  * @summary Get Munchi gift card data
@@ -47190,13 +49033,22 @@ export declare const MunchiGiftCardApiFp: (configuration?: Configuration) => {
47190
49033
  */
47191
49034
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMunchiGiftCardDataResponseDto>>;
47192
49035
  /**
47193
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
49036
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
49037
+ * @summary Give back a Munchi gift card redemption the till order did not keep
49038
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
49039
+ * @param {*} [options] Override http request option.
49040
+ * @throws {RequiredError}
49041
+ */
49042
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiveBackMunchiGiftCardResponseDto>>;
49043
+ /**
49044
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47194
49045
  * @summary Redeem a first-party Munchi gift card
47195
49046
  * @param {RedeemGiftCardDto} redeemGiftCardDto
49047
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47196
49048
  * @param {*} [options] Override http request option.
47197
49049
  * @throws {RequiredError}
47198
49050
  */
47199
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedeemGiftCardResponseDto>>;
49051
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedeemGiftCardResponseDto>>;
47200
49052
  /**
47201
49053
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47202
49054
  * @summary Validate a first-party Munchi gift card
@@ -47212,13 +49064,14 @@ export declare const MunchiGiftCardApiFp: (configuration?: Configuration) => {
47212
49064
  */
47213
49065
  export declare const MunchiGiftCardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
47214
49066
  /**
47215
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
49067
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47216
49068
  * @summary Create a first-party Munchi gift card
47217
49069
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
49070
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47218
49071
  * @param {*} [options] Override http request option.
47219
49072
  * @throws {RequiredError}
47220
49073
  */
47221
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: any): AxiosPromise<CreateMunchiGiftCardResponseDto>;
49074
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<CreateMunchiGiftCardResponseDto>;
47222
49075
  /**
47223
49076
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47224
49077
  * @summary Get Munchi gift card data
@@ -47228,13 +49081,22 @@ export declare const MunchiGiftCardApiFactory: (configuration?: Configuration, b
47228
49081
  */
47229
49082
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: any): AxiosPromise<GetMunchiGiftCardDataResponseDto>;
47230
49083
  /**
47231
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
49084
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
49085
+ * @summary Give back a Munchi gift card redemption the till order did not keep
49086
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
49087
+ * @param {*} [options] Override http request option.
49088
+ * @throws {RequiredError}
49089
+ */
49090
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: any): AxiosPromise<GiveBackMunchiGiftCardResponseDto>;
49091
+ /**
49092
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47232
49093
  * @summary Redeem a first-party Munchi gift card
47233
49094
  * @param {RedeemGiftCardDto} redeemGiftCardDto
49095
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47234
49096
  * @param {*} [options] Override http request option.
47235
49097
  * @throws {RequiredError}
47236
49098
  */
47237
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: any): AxiosPromise<RedeemGiftCardResponseDto>;
49099
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RedeemGiftCardResponseDto>;
47238
49100
  /**
47239
49101
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47240
49102
  * @summary Validate a first-party Munchi gift card
@@ -47251,14 +49113,15 @@ export declare const MunchiGiftCardApiFactory: (configuration?: Configuration, b
47251
49113
  */
47252
49114
  export interface MunchiGiftCardApiInterface {
47253
49115
  /**
47254
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
49116
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47255
49117
  * @summary Create a first-party Munchi gift card
47256
49118
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
49119
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47257
49120
  * @param {*} [options] Override http request option.
47258
49121
  * @throws {RequiredError}
47259
49122
  * @memberof MunchiGiftCardApiInterface
47260
49123
  */
47261
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<CreateMunchiGiftCardResponseDto>;
49124
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<CreateMunchiGiftCardResponseDto>;
47262
49125
  /**
47263
49126
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47264
49127
  * @summary Get Munchi gift card data
@@ -47269,14 +49132,24 @@ export interface MunchiGiftCardApiInterface {
47269
49132
  */
47270
49133
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig): AxiosPromise<GetMunchiGiftCardDataResponseDto>;
47271
49134
  /**
47272
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
49135
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
49136
+ * @summary Give back a Munchi gift card redemption the till order did not keep
49137
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
49138
+ * @param {*} [options] Override http request option.
49139
+ * @throws {RequiredError}
49140
+ * @memberof MunchiGiftCardApiInterface
49141
+ */
49142
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<GiveBackMunchiGiftCardResponseDto>;
49143
+ /**
49144
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47273
49145
  * @summary Redeem a first-party Munchi gift card
47274
49146
  * @param {RedeemGiftCardDto} redeemGiftCardDto
49147
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47275
49148
  * @param {*} [options] Override http request option.
47276
49149
  * @throws {RequiredError}
47277
49150
  * @memberof MunchiGiftCardApiInterface
47278
49151
  */
47279
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<RedeemGiftCardResponseDto>;
49152
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RedeemGiftCardResponseDto>;
47280
49153
  /**
47281
49154
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47282
49155
  * @summary Validate a first-party Munchi gift card
@@ -47295,14 +49168,15 @@ export interface MunchiGiftCardApiInterface {
47295
49168
  */
47296
49169
  export declare class MunchiGiftCardApi extends BaseAPI implements MunchiGiftCardApiInterface {
47297
49170
  /**
47298
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
49171
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47299
49172
  * @summary Create a first-party Munchi gift card
47300
49173
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
49174
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47301
49175
  * @param {*} [options] Override http request option.
47302
49176
  * @throws {RequiredError}
47303
49177
  * @memberof MunchiGiftCardApi
47304
49178
  */
47305
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMunchiGiftCardResponseDto, any, {}>>;
49179
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMunchiGiftCardResponseDto, any, {}>>;
47306
49180
  /**
47307
49181
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47308
49182
  * @summary Get Munchi gift card data
@@ -47313,14 +49187,24 @@ export declare class MunchiGiftCardApi extends BaseAPI implements MunchiGiftCard
47313
49187
  */
47314
49188
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMunchiGiftCardDataResponseDto, any, {}>>;
47315
49189
  /**
47316
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
49190
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
49191
+ * @summary Give back a Munchi gift card redemption the till order did not keep
49192
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
49193
+ * @param {*} [options] Override http request option.
49194
+ * @throws {RequiredError}
49195
+ * @memberof MunchiGiftCardApi
49196
+ */
49197
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiveBackMunchiGiftCardResponseDto, any, {}>>;
49198
+ /**
49199
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47317
49200
  * @summary Redeem a first-party Munchi gift card
47318
49201
  * @param {RedeemGiftCardDto} redeemGiftCardDto
49202
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47319
49203
  * @param {*} [options] Override http request option.
47320
49204
  * @throws {RequiredError}
47321
49205
  * @memberof MunchiGiftCardApi
47322
49206
  */
47323
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RedeemGiftCardResponseDto, any, {}>>;
49207
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RedeemGiftCardResponseDto, any, {}>>;
47324
49208
  /**
47325
49209
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47326
49210
  * @summary Validate a first-party Munchi gift card
@@ -50191,7 +52075,7 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
50191
52075
  */
50192
52076
  recordManualPayment: (createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
50193
52077
  /**
50194
- * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
52078
+ * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
50195
52079
  * @summary Record the Worldline payment app\'s answer for a handheld session
50196
52080
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
50197
52081
  * @param {*} [options] Override http request option.
@@ -50441,7 +52325,7 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
50441
52325
  */
50442
52326
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
50443
52327
  /**
50444
- * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
52328
+ * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
50445
52329
  * @summary Record the Worldline payment app\'s answer for a handheld session
50446
52330
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
50447
52331
  * @param {*} [options] Override http request option.
@@ -50691,7 +52575,7 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
50691
52575
  */
50692
52576
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
50693
52577
  /**
50694
- * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
52578
+ * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
50695
52579
  * @summary Record the Worldline payment app\'s answer for a handheld session
50696
52580
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
50697
52581
  * @param {*} [options] Override http request option.
@@ -50959,7 +52843,7 @@ export interface PaymentSessionApiInterface {
50959
52843
  */
50960
52844
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
50961
52845
  /**
50962
- * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
52846
+ * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
50963
52847
  * @summary Record the Worldline payment app\'s answer for a handheld session
50964
52848
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
50965
52849
  * @param {*} [options] Override http request option.
@@ -51240,7 +53124,7 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
51240
53124
  */
51241
53125
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
51242
53126
  /**
51243
- * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s answer carries the session\'s sessionId as its reference; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
53127
+ * Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
51244
53128
  * @summary Record the Worldline payment app\'s answer for a handheld session
51245
53129
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
51246
53130
  * @param {*} [options] Override http request option.
@@ -54928,13 +56812,13 @@ export declare const ReservationsApiAxiosParamCreator: (configuration?: Configur
54928
56812
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
54929
56813
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
54930
56814
  * @param {number} partySize How many guests the booking is for
56815
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
54931
56816
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
54932
56817
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
54933
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
54934
56818
  * @param {*} [options] Override http request option.
54935
56819
  * @throws {RequiredError}
54936
56820
  */
54937
- getReservationAvailability: (businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56821
+ getReservationAvailability: (businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54938
56822
  /**
54939
56823
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
54940
56824
  * @summary Get the reservation policy
@@ -55025,13 +56909,13 @@ export declare const ReservationsApiFp: (configuration?: Configuration) => {
55025
56909
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55026
56910
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55027
56911
  * @param {number} partySize How many guests the booking is for
56912
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55028
56913
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55029
56914
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55030
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55031
56915
  * @param {*} [options] Override http request option.
55032
56916
  * @throws {RequiredError}
55033
56917
  */
55034
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReservationAvailabilityResponseDto>>;
56918
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReservationAvailabilityResponseDto>>;
55035
56919
  /**
55036
56920
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55037
56921
  * @summary Get the reservation policy
@@ -55122,13 +57006,13 @@ export declare const ReservationsApiFactory: (configuration?: Configuration, bas
55122
57006
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55123
57007
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55124
57008
  * @param {number} partySize How many guests the booking is for
57009
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55125
57010
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55126
57011
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55127
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55128
57012
  * @param {*} [options] Override http request option.
55129
57013
  * @throws {RequiredError}
55130
57014
  */
55131
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: any): AxiosPromise<ReservationAvailabilityResponseDto>;
57015
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: any): AxiosPromise<ReservationAvailabilityResponseDto>;
55132
57016
  /**
55133
57017
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55134
57018
  * @summary Get the reservation policy
@@ -55221,14 +57105,14 @@ export interface ReservationsApiInterface {
55221
57105
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55222
57106
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55223
57107
  * @param {number} partySize How many guests the booking is for
57108
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55224
57109
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55225
57110
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55226
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55227
57111
  * @param {*} [options] Override http request option.
55228
57112
  * @throws {RequiredError}
55229
57113
  * @memberof ReservationsApiInterface
55230
57114
  */
55231
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig): AxiosPromise<ReservationAvailabilityResponseDto>;
57115
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): AxiosPromise<ReservationAvailabilityResponseDto>;
55232
57116
  /**
55233
57117
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55234
57118
  * @summary Get the reservation policy
@@ -55330,14 +57214,14 @@ export declare class ReservationsApi extends BaseAPI implements ReservationsApiI
55330
57214
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55331
57215
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55332
57216
  * @param {number} partySize How many guests the booking is for
57217
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55333
57218
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55334
57219
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55335
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55336
57220
  * @param {*} [options] Override http request option.
55337
57221
  * @throws {RequiredError}
55338
57222
  * @memberof ReservationsApi
55339
57223
  */
55340
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReservationAvailabilityResponseDto, any, {}>>;
57224
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReservationAvailabilityResponseDto, any, {}>>;
55341
57225
  /**
55342
57226
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55343
57227
  * @summary Get the reservation policy