@munchi_oy/core 2.12.0 → 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.
@@ -5196,6 +5196,24 @@ export interface CreateVenueGiftCardDto {
5196
5196
  * @memberof CreateVenueGiftCardDto
5197
5197
  */
5198
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;
5199
5217
  /**
5200
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.
5201
5219
  * @type {string}
@@ -8482,6 +8500,63 @@ export interface GetStationResponseDtoStation {
8482
8500
  */
8483
8501
  'paymentTerminal'?: StationDetailsDtoPaymentTerminal | null;
8484
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
+ }
8485
8560
  /**
8486
8561
  *
8487
8562
  * @export
@@ -8511,6 +8586,19 @@ export interface GiftCardChannelsDto {
8511
8586
  */
8512
8587
  'onlineStore': boolean;
8513
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
+ }
8514
8602
  /**
8515
8603
  *
8516
8604
  * @export
@@ -8781,6 +8869,211 @@ export interface GiftCardMoneyDto {
8781
8869
  */
8782
8870
  'count': number;
8783
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
+ }
8784
9077
  /**
8785
9078
  *
8786
9079
  * @export
@@ -8823,6 +9116,49 @@ export interface GiftCardReportDto {
8823
9116
  * @memberof GiftCardReportDto
8824
9117
  */
8825
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;
8826
9162
  }
8827
9163
  /**
8828
9164
  * Cards made by hand in the period
@@ -8843,6 +9179,62 @@ export interface GiftCardReportDtoGivenFree {
8843
9179
  */
8844
9180
  'count': number;
8845
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
+ }
8846
9238
  /**
8847
9239
  * Cards sold in the period, at the till or online
8848
9240
  * @export
@@ -25542,7 +25934,7 @@ export interface RecordWorldlineA2aResultDtoAnswer {
25542
25934
  */
25543
25935
  'remark'?: string;
25544
25936
  /**
25545
- * 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.
25546
25938
  * @type {string}
25547
25939
  * @memberof RecordWorldlineA2aResultDtoAnswer
25548
25940
  */
@@ -37098,6 +37490,12 @@ export interface VenueGiftCardDetailDto {
37098
37490
  * @memberof VenueGiftCardDetailDto
37099
37491
  */
37100
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;
37101
37499
  /**
37102
37500
  * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37103
37501
  * @type {number}
@@ -37207,6 +37605,12 @@ export interface VenueGiftCardDto {
37207
37605
  * @memberof VenueGiftCardDto
37208
37606
  */
37209
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;
37210
37614
  /**
37211
37615
  * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37212
37616
  * @type {number}
@@ -39793,7 +40197,7 @@ export interface WorldlineAppAnswerDto {
39793
40197
  */
39794
40198
  'remark'?: string;
39795
40199
  /**
39796
- * 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.
39797
40201
  * @type {string}
39798
40202
  * @memberof WorldlineAppAnswerDto
39799
40203
  */
@@ -45455,7 +45859,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45455
45859
  * @summary Make a gift card by hand, given for free
45456
45860
  * @param {number} businessId The store\&#39;s orderingBusinessId
45457
45861
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45458
- * @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 when it sends one (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.
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.
45459
45863
  * @param {*} [options] Override http request option.
45460
45864
  * @throws {RequiredError}
45461
45865
  */
@@ -45470,7 +45874,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45470
45874
  */
45471
45875
  getVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45472
45876
  /**
45473
- * 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. Three statements; nothing is written.
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.
45474
45878
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45475
45879
  * @param {number} businessId The store\&#39;s orderingBusinessId
45476
45880
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45487,6 +45891,21 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45487
45891
  * @throws {RequiredError}
45488
45892
  */
45489
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>;
45490
45909
  /**
45491
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.
45492
45911
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45495,10 +45914,11 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45495
45914
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45496
45915
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45497
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.
45498
45918
  * @param {*} [options] Override http request option.
45499
45919
  * @throws {RequiredError}
45500
45920
  */
45501
- listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45921
+ listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45502
45922
  /**
45503
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.
45504
45924
  * @summary Unblock a gift card
@@ -45547,7 +45967,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45547
45967
  * @summary Make a gift card by hand, given for free
45548
45968
  * @param {number} businessId The store\&#39;s orderingBusinessId
45549
45969
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45550
- * @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 when it sends one (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.
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.
45551
45971
  * @param {*} [options] Override http request option.
45552
45972
  * @throws {RequiredError}
45553
45973
  */
@@ -45562,7 +45982,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45562
45982
  */
45563
45983
  getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45564
45984
  /**
45565
- * 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. Three statements; nothing is written.
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.
45566
45986
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45567
45987
  * @param {number} businessId The store\&#39;s orderingBusinessId
45568
45988
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45579,6 +45999,21 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45579
45999
  * @throws {RequiredError}
45580
46000
  */
45581
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>>;
45582
46017
  /**
45583
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.
45584
46019
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45587,10 +46022,11 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45587
46022
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45588
46023
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45589
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.
45590
46026
  * @param {*} [options] Override http request option.
45591
46027
  * @throws {RequiredError}
45592
46028
  */
45593
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
46029
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
45594
46030
  /**
45595
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.
45596
46032
  * @summary Unblock a gift card
@@ -45639,7 +46075,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45639
46075
  * @summary Make a gift card by hand, given for free
45640
46076
  * @param {number} businessId The store\&#39;s orderingBusinessId
45641
46077
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45642
- * @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 when it sends one (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.
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.
45643
46079
  * @param {*} [options] Override http request option.
45644
46080
  * @throws {RequiredError}
45645
46081
  */
@@ -45654,7 +46090,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45654
46090
  */
45655
46091
  getVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45656
46092
  /**
45657
- * 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. Three statements; nothing is written.
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.
45658
46094
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45659
46095
  * @param {number} businessId The store\&#39;s orderingBusinessId
45660
46096
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45671,6 +46107,21 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45671
46107
  * @throws {RequiredError}
45672
46108
  */
45673
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>;
45674
46125
  /**
45675
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.
45676
46127
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45679,10 +46130,11 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45679
46130
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45680
46131
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45681
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.
45682
46134
  * @param {*} [options] Override http request option.
45683
46135
  * @throws {RequiredError}
45684
46136
  */
45685
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: any): AxiosPromise<VenueGiftCardsDto>;
46137
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto>;
45686
46138
  /**
45687
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.
45688
46140
  * @summary Unblock a gift card
@@ -45734,7 +46186,7 @@ export interface GiftCardsApiInterface {
45734
46186
  * @summary Make a gift card by hand, given for free
45735
46187
  * @param {number} businessId The store\&#39;s orderingBusinessId
45736
46188
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45737
- * @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 when it sends one (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.
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.
45738
46190
  * @param {*} [options] Override http request option.
45739
46191
  * @throws {RequiredError}
45740
46192
  * @memberof GiftCardsApiInterface
@@ -45751,7 +46203,7 @@ export interface GiftCardsApiInterface {
45751
46203
  */
45752
46204
  getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45753
46205
  /**
45754
- * 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. Three statements; nothing is written.
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.
45755
46207
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45756
46208
  * @param {number} businessId The store\&#39;s orderingBusinessId
45757
46209
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45770,6 +46222,22 @@ export interface GiftCardsApiInterface {
45770
46222
  * @memberof GiftCardsApiInterface
45771
46223
  */
45772
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>;
45773
46241
  /**
45774
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.
45775
46243
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45778,11 +46246,12 @@ export interface GiftCardsApiInterface {
45778
46246
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45779
46247
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45780
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.
45781
46250
  * @param {*} [options] Override http request option.
45782
46251
  * @throws {RequiredError}
45783
46252
  * @memberof GiftCardsApiInterface
45784
46253
  */
45785
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
46254
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
45786
46255
  /**
45787
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.
45788
46257
  * @summary Unblock a gift card
@@ -45837,7 +46306,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45837
46306
  * @summary Make a gift card by hand, given for free
45838
46307
  * @param {number} businessId The store\&#39;s orderingBusinessId
45839
46308
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45840
- * @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 when it sends one (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.
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.
45841
46310
  * @param {*} [options] Override http request option.
45842
46311
  * @throws {RequiredError}
45843
46312
  * @memberof GiftCardsApi
@@ -45854,7 +46323,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45854
46323
  */
45855
46324
  getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45856
46325
  /**
45857
- * 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. Three statements; nothing is written.
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.
45858
46327
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45859
46328
  * @param {number} businessId The store\&#39;s orderingBusinessId
45860
46329
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45873,6 +46342,22 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45873
46342
  * @memberof GiftCardsApi
45874
46343
  */
45875
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, {}>>;
45876
46361
  /**
45877
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.
45878
46363
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45881,11 +46366,12 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45881
46366
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45882
46367
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45883
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.
45884
46370
  * @param {*} [options] Override http request option.
45885
46371
  * @throws {RequiredError}
45886
46372
  * @memberof GiftCardsApi
45887
46373
  */
45888
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
46374
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
45889
46375
  /**
45890
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.
45891
46377
  * @summary Unblock a gift card
@@ -51589,7 +52075,7 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
51589
52075
  */
51590
52076
  recordManualPayment: (createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51591
52077
  /**
51592
- * 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.
51593
52079
  * @summary Record the Worldline payment app\'s answer for a handheld session
51594
52080
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
51595
52081
  * @param {*} [options] Override http request option.
@@ -51839,7 +52325,7 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
51839
52325
  */
51840
52326
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
51841
52327
  /**
51842
- * 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.
51843
52329
  * @summary Record the Worldline payment app\'s answer for a handheld session
51844
52330
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
51845
52331
  * @param {*} [options] Override http request option.
@@ -52089,7 +52575,7 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
52089
52575
  */
52090
52576
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
52091
52577
  /**
52092
- * 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.
52093
52579
  * @summary Record the Worldline payment app\'s answer for a handheld session
52094
52580
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
52095
52581
  * @param {*} [options] Override http request option.
@@ -52357,7 +52843,7 @@ export interface PaymentSessionApiInterface {
52357
52843
  */
52358
52844
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
52359
52845
  /**
52360
- * 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.
52361
52847
  * @summary Record the Worldline payment app\'s answer for a handheld session
52362
52848
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
52363
52849
  * @param {*} [options] Override http request option.
@@ -52638,7 +53124,7 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
52638
53124
  */
52639
53125
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
52640
53126
  /**
52641
- * 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.
52642
53128
  * @summary Record the Worldline payment app\'s answer for a handheld session
52643
53129
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
52644
53130
  * @param {*} [options] Override http request option.