@munchi_oy/core 2.12.0 → 2.14.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,36 @@ export interface CreateVenueGiftCardDto {
5196
5196
  * @memberof CreateVenueGiftCardDto
5197
5197
  */
5198
5198
  'note'?: string;
5199
+ /**
5200
+ * The message shown in the card\'s email, 1 to 300 characters: the buyer\'s or the store\'s own words. Absent: none.
5201
+ * @type {string}
5202
+ * @memberof CreateVenueGiftCardDto
5203
+ */
5204
+ 'message'?: string;
5205
+ /**
5206
+ * Whether the card is emailed to buyerEmail at once. Absent: true. Without buyerEmail nothing is sent.
5207
+ * @type {boolean}
5208
+ * @memberof CreateVenueGiftCardDto
5209
+ */
5210
+ 'sendEmail'?: boolean;
5211
+ /**
5212
+ * The buyer\'s email, at most 254 characters once the spaces around it are dropped. Absent or only spaces: none. Answered as buyerEmail.
5213
+ * @type {string}
5214
+ * @memberof CreateVenueGiftCardDto
5215
+ */
5216
+ 'buyerEmail'?: string;
5217
+ /**
5218
+ * 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.
5219
+ * @type {string}
5220
+ * @memberof CreateVenueGiftCardDto
5221
+ */
5222
+ 'phoneCountryCode'?: string;
5223
+ /**
5224
+ * 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.
5225
+ * @type {string}
5226
+ * @memberof CreateVenueGiftCardDto
5227
+ */
5228
+ 'phoneNumber'?: string;
5199
5229
  /**
5200
5230
  * 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
5231
  * @type {string}
@@ -8482,6 +8512,63 @@ export interface GetStationResponseDtoStation {
8482
8512
  */
8483
8513
  'paymentTerminal'?: StationDetailsDtoPaymentTerminal | null;
8484
8514
  }
8515
+ /**
8516
+ *
8517
+ * @export
8518
+ * @interface GiftCardAttentionDto
8519
+ */
8520
+ export interface GiftCardAttentionDto {
8521
+ /**
8522
+ *
8523
+ * @type {GiftCardAttentionDtoExpiringSoon}
8524
+ * @memberof GiftCardAttentionDto
8525
+ */
8526
+ 'expiringSoon': GiftCardAttentionDtoExpiringSoon;
8527
+ /**
8528
+ *
8529
+ * @type {GiftCardAttentionDtoStalePending}
8530
+ * @memberof GiftCardAttentionDto
8531
+ */
8532
+ 'stalePending': GiftCardAttentionDtoStalePending;
8533
+ /**
8534
+ * The days ahead expiringSoon looks
8535
+ * @type {number}
8536
+ * @memberof GiftCardAttentionDto
8537
+ */
8538
+ 'expiringWithinDays': number;
8539
+ }
8540
+ /**
8541
+ * ACTIVE cards that expire within the next expiringWithinDays days: what is on them and how many
8542
+ * @export
8543
+ * @interface GiftCardAttentionDtoExpiringSoon
8544
+ */
8545
+ export interface GiftCardAttentionDtoExpiringSoon {
8546
+ /**
8547
+ * The sum, in cents
8548
+ * @type {number}
8549
+ * @memberof GiftCardAttentionDtoExpiringSoon
8550
+ */
8551
+ 'amount': number;
8552
+ /**
8553
+ * How many cards
8554
+ * @type {number}
8555
+ * @memberof GiftCardAttentionDtoExpiringSoon
8556
+ */
8557
+ 'count': number;
8558
+ }
8559
+ /**
8560
+ * NOT_YET_VALID cards made more than 24 hours ago: their POS order may never have been paid
8561
+ * @export
8562
+ * @interface GiftCardAttentionDtoStalePending
8563
+ */
8564
+ export interface GiftCardAttentionDtoStalePending {
8565
+ /**
8566
+ * How many cards
8567
+ * @type {number}
8568
+ * @memberof GiftCardAttentionDtoStalePending
8569
+ */
8570
+ 'count': number;
8571
+ }
8485
8572
  /**
8486
8573
  *
8487
8574
  * @export
@@ -8490,6 +8577,8 @@ export interface GetStationResponseDtoStation {
8490
8577
  export declare const GiftCardChannel: {
8491
8578
  readonly Till: "TILL";
8492
8579
  readonly OnlineStore: "ONLINE_STORE";
8580
+ readonly Kiosk: "KIOSK";
8581
+ readonly MobileApp: "MOBILE_APP";
8493
8582
  };
8494
8583
  export type GiftCardChannel = typeof GiftCardChannel[keyof typeof GiftCardChannel];
8495
8584
  /**
@@ -8510,6 +8599,31 @@ export interface GiftCardChannelsDto {
8510
8599
  * @memberof GiftCardChannelsDto
8511
8600
  */
8512
8601
  'onlineStore': boolean;
8602
+ /**
8603
+ * Whether the store\'s kiosk takes gift cards. Always answered; absent in a change: unchanged, so a dashboard that sends only till and onlineStore keeps working.
8604
+ * @type {boolean}
8605
+ * @memberof GiftCardChannelsDto
8606
+ */
8607
+ 'kiosk'?: boolean;
8608
+ /**
8609
+ * Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
8610
+ * @type {boolean}
8611
+ * @memberof GiftCardChannelsDto
8612
+ */
8613
+ 'mobileApp'?: boolean;
8614
+ }
8615
+ /**
8616
+ *
8617
+ * @export
8618
+ * @interface GiftCardCountDto
8619
+ */
8620
+ export interface GiftCardCountDto {
8621
+ /**
8622
+ * How many cards
8623
+ * @type {number}
8624
+ * @memberof GiftCardCountDto
8625
+ */
8626
+ 'count': number;
8513
8627
  }
8514
8628
  /**
8515
8629
  *
@@ -8586,6 +8700,30 @@ export interface GiftCardCredentialsViewDto {
8586
8700
  */
8587
8701
  'uniquePosDeviceId': string | null;
8588
8702
  }
8703
+ /**
8704
+ *
8705
+ * @export
8706
+ * @enum {string}
8707
+ */
8708
+ export declare const GiftCardEmailKind: {
8709
+ readonly Card: "CARD";
8710
+ readonly CardAgain: "CARD_AGAIN";
8711
+ readonly Expiry30: "EXPIRY_30";
8712
+ readonly Expiry7: "EXPIRY_7";
8713
+ };
8714
+ export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
8715
+ /**
8716
+ *
8717
+ * @export
8718
+ * @enum {string}
8719
+ */
8720
+ export declare const GiftCardEmailStatus: {
8721
+ readonly Pending: "PENDING";
8722
+ readonly Sent: "SENT";
8723
+ readonly Failed: "FAILED";
8724
+ readonly Skipped: "SKIPPED";
8725
+ };
8726
+ export type GiftCardEmailStatus = typeof GiftCardEmailStatus[keyof typeof GiftCardEmailStatus];
8589
8727
  /**
8590
8728
  *
8591
8729
  * @export
@@ -8666,6 +8804,18 @@ export interface GiftCardHistoryEventDto {
8666
8804
  * @memberof GiftCardHistoryEventDto
8667
8805
  */
8668
8806
  'orderId': string | null;
8807
+ /**
8808
+ * The address of an EMAILED, EMAIL_FAILED or EMAIL_CHANGED line; null for the others
8809
+ * @type {string}
8810
+ * @memberof GiftCardHistoryEventDto
8811
+ */
8812
+ 'to': string | null;
8813
+ /**
8814
+ *
8815
+ * @type {GiftCardEmailKind}
8816
+ * @memberof GiftCardHistoryEventDto
8817
+ */
8818
+ 'emailKind': GiftCardEmailKind | null;
8669
8819
  /**
8670
8820
  * When it happened, ISO 8601
8671
8821
  * @type {string}
@@ -8687,6 +8837,9 @@ export declare const GiftCardHistoryKind: {
8687
8837
  readonly Blocked: "BLOCKED";
8688
8838
  readonly Unblocked: "UNBLOCKED";
8689
8839
  readonly SwitchedOn: "SWITCHED_ON";
8840
+ readonly Emailed: "EMAILED";
8841
+ readonly EmailFailed: "EMAIL_FAILED";
8842
+ readonly EmailChanged: "EMAIL_CHANGED";
8690
8843
  };
8691
8844
  export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
8692
8845
  /**
@@ -8743,6 +8896,37 @@ export declare const GiftCardIssue: {
8743
8896
  readonly ByHand: "BY_HAND";
8744
8897
  };
8745
8898
  export type GiftCardIssue = typeof GiftCardIssue[keyof typeof GiftCardIssue];
8899
+ /**
8900
+ *
8901
+ * @export
8902
+ * @interface GiftCardLastEmailDto
8903
+ */
8904
+ export interface GiftCardLastEmailDto {
8905
+ /**
8906
+ *
8907
+ * @type {GiftCardEmailKind}
8908
+ * @memberof GiftCardLastEmailDto
8909
+ */
8910
+ 'kind': GiftCardEmailKind;
8911
+ /**
8912
+ *
8913
+ * @type {GiftCardEmailStatus}
8914
+ * @memberof GiftCardLastEmailDto
8915
+ */
8916
+ 'status': GiftCardEmailStatus;
8917
+ /**
8918
+ * The address it goes to
8919
+ * @type {string}
8920
+ * @memberof GiftCardLastEmailDto
8921
+ */
8922
+ 'to': string;
8923
+ /**
8924
+ * When it was sent, else when it last changed, ISO 8601
8925
+ * @type {string}
8926
+ * @memberof GiftCardLastEmailDto
8927
+ */
8928
+ 'at': string;
8929
+ }
8746
8930
  /**
8747
8931
  *
8748
8932
  * @export
@@ -8781,6 +8965,211 @@ export interface GiftCardMoneyDto {
8781
8965
  */
8782
8966
  'count': number;
8783
8967
  }
8968
+ /**
8969
+ *
8970
+ * @export
8971
+ * @interface GiftCardMoneyWentDto
8972
+ */
8973
+ export interface GiftCardMoneyWentDto {
8974
+ /**
8975
+ * 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).
8976
+ * @type {number}
8977
+ * @memberof GiftCardMoneyWentDto
8978
+ */
8979
+ 'spent': number;
8980
+ /**
8981
+ * On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
8982
+ * @type {number}
8983
+ * @memberof GiftCardMoneyWentDto
8984
+ */
8985
+ 'onCards': number;
8986
+ /**
8987
+ * Left on EXPIRED cards, in cents
8988
+ * @type {number}
8989
+ * @memberof GiftCardMoneyWentDto
8990
+ */
8991
+ 'expiredUnused': number;
8992
+ /**
8993
+ * Left on BLOCKED cards, in cents
8994
+ * @type {number}
8995
+ * @memberof GiftCardMoneyWentDto
8996
+ */
8997
+ 'blocked': number;
8998
+ }
8999
+ /**
9000
+ *
9001
+ * @export
9002
+ * @interface GiftCardMovementDto
9003
+ */
9004
+ export interface GiftCardMovementDto {
9005
+ /**
9006
+ * The movement\'s id
9007
+ * @type {string}
9008
+ * @memberof GiftCardMovementDto
9009
+ */
9010
+ 'id': string;
9011
+ /**
9012
+ * When it happened, ISO 8601
9013
+ * @type {string}
9014
+ * @memberof GiftCardMovementDto
9015
+ */
9016
+ 'at': string;
9017
+ /**
9018
+ * The card\'s id
9019
+ * @type {string}
9020
+ * @memberof GiftCardMovementDto
9021
+ */
9022
+ 'cardId': string;
9023
+ /**
9024
+ * The card\'s 6-digit code
9025
+ * @type {string}
9026
+ * @memberof GiftCardMovementDto
9027
+ */
9028
+ 'code': string;
9029
+ /**
9030
+ *
9031
+ * @type {GiftCardHistoryKind}
9032
+ * @memberof GiftCardMovementDto
9033
+ */
9034
+ 'kind': GiftCardHistoryKind;
9035
+ /**
9036
+ * How the card\'s balance moved, in cents: positive for SOLD, CREATED_BY_HAND and GIVEN_BACK, negative for SPENT, either for CORRECTED
9037
+ * @type {number}
9038
+ * @memberof GiftCardMovementDto
9039
+ */
9040
+ 'amount': number;
9041
+ /**
9042
+ * The card\'s balance after it, in cents
9043
+ * @type {number}
9044
+ * @memberof GiftCardMovementDto
9045
+ */
9046
+ 'balanceAfter': number;
9047
+ /**
9048
+ * The store where it happened; null when the history did not record one
9049
+ * @type {number}
9050
+ * @memberof GiftCardMovementDto
9051
+ */
9052
+ 'venueId': number | null;
9053
+ /**
9054
+ * That store\'s name; null with venueId, or when the store is gone
9055
+ * @type {string}
9056
+ * @memberof GiftCardMovementDto
9057
+ */
9058
+ 'venueName': string | null;
9059
+ /**
9060
+ * The POS order it belongs to; null when none
9061
+ * @type {string}
9062
+ * @memberof GiftCardMovementDto
9063
+ */
9064
+ 'orderId': string | null;
9065
+ /**
9066
+ * 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
9067
+ * @type {boolean}
9068
+ * @memberof GiftCardMovementDto
9069
+ */
9070
+ 'pending': boolean;
9071
+ }
9072
+ /**
9073
+ *
9074
+ * @export
9075
+ * @interface GiftCardMovementsDto
9076
+ */
9077
+ export interface GiftCardMovementsDto {
9078
+ /**
9079
+ * The page\'s movements, newest first
9080
+ * @type {Array<GiftCardMovementDto>}
9081
+ * @memberof GiftCardMovementsDto
9082
+ */
9083
+ 'movements': Array<GiftCardMovementDto>;
9084
+ /**
9085
+ * The cursor of the next page; null when this page is the last
9086
+ * @type {string}
9087
+ * @memberof GiftCardMovementsDto
9088
+ */
9089
+ 'nextCursor': string | null;
9090
+ }
9091
+ /**
9092
+ *
9093
+ * @export
9094
+ * @interface GiftCardPeriodTotalsDto
9095
+ */
9096
+ export interface GiftCardPeriodTotalsDto {
9097
+ /**
9098
+ *
9099
+ * @type {GiftCardPeriodTotalsDtoSold}
9100
+ * @memberof GiftCardPeriodTotalsDto
9101
+ */
9102
+ 'sold': GiftCardPeriodTotalsDtoSold;
9103
+ /**
9104
+ *
9105
+ * @type {GiftCardPeriodTotalsDtoGivenFree}
9106
+ * @memberof GiftCardPeriodTotalsDto
9107
+ */
9108
+ 'givenFree': GiftCardPeriodTotalsDtoGivenFree;
9109
+ /**
9110
+ *
9111
+ * @type {GiftCardPeriodTotalsDtoSpent}
9112
+ * @memberof GiftCardPeriodTotalsDto
9113
+ */
9114
+ 'spent': GiftCardPeriodTotalsDtoSpent;
9115
+ }
9116
+ /**
9117
+ * Cards made by hand
9118
+ * @export
9119
+ * @interface GiftCardPeriodTotalsDtoGivenFree
9120
+ */
9121
+ export interface GiftCardPeriodTotalsDtoGivenFree {
9122
+ /**
9123
+ * The sum, in cents
9124
+ * @type {number}
9125
+ * @memberof GiftCardPeriodTotalsDtoGivenFree
9126
+ */
9127
+ 'amount': number;
9128
+ /**
9129
+ * How many cards
9130
+ * @type {number}
9131
+ * @memberof GiftCardPeriodTotalsDtoGivenFree
9132
+ */
9133
+ 'count': number;
9134
+ }
9135
+ /**
9136
+ * Cards sold, at the till or online
9137
+ * @export
9138
+ * @interface GiftCardPeriodTotalsDtoSold
9139
+ */
9140
+ export interface GiftCardPeriodTotalsDtoSold {
9141
+ /**
9142
+ * The sum, in cents
9143
+ * @type {number}
9144
+ * @memberof GiftCardPeriodTotalsDtoSold
9145
+ */
9146
+ 'amount': number;
9147
+ /**
9148
+ * How many cards
9149
+ * @type {number}
9150
+ * @memberof GiftCardPeriodTotalsDtoSold
9151
+ */
9152
+ 'count': number;
9153
+ }
9154
+ /**
9155
+ * Cards spent
9156
+ * @export
9157
+ * @interface GiftCardPeriodTotalsDtoSpent
9158
+ */
9159
+ export interface GiftCardPeriodTotalsDtoSpent {
9160
+ /**
9161
+ * Taken off cards, less what went back on them, in cents
9162
+ * @type {number}
9163
+ * @memberof GiftCardPeriodTotalsDtoSpent
9164
+ */
9165
+ 'amount': number;
9166
+ /**
9167
+ * How many orders cards paid that kept the payment
9168
+ * @type {number}
9169
+ * @memberof GiftCardPeriodTotalsDtoSpent
9170
+ */
9171
+ 'orderCount': number;
9172
+ }
8784
9173
  /**
8785
9174
  *
8786
9175
  * @export
@@ -8823,6 +9212,49 @@ export interface GiftCardReportDto {
8823
9212
  * @memberof GiftCardReportDto
8824
9213
  */
8825
9214
  'stores': Array<GiftCardStoreReportDto>;
9215
+ /**
9216
+ *
9217
+ * @type {GiftCardReportDtoPrevious}
9218
+ * @memberof GiftCardReportDto
9219
+ */
9220
+ 'previous': GiftCardReportDtoPrevious;
9221
+ /**
9222
+ *
9223
+ * @type {GiftCardReportDtoMoneyWent}
9224
+ * @memberof GiftCardReportDto
9225
+ */
9226
+ 'moneyWent': GiftCardReportDtoMoneyWent;
9227
+ /**
9228
+ *
9229
+ * @type {GiftCardReportDtoAttention}
9230
+ * @memberof GiftCardReportDto
9231
+ */
9232
+ 'attention': GiftCardReportDtoAttention;
9233
+ }
9234
+ /**
9235
+ * Right now: what may need the store\'s attention
9236
+ * @export
9237
+ * @interface GiftCardReportDtoAttention
9238
+ */
9239
+ export interface GiftCardReportDtoAttention {
9240
+ /**
9241
+ *
9242
+ * @type {GiftCardAttentionDtoExpiringSoon}
9243
+ * @memberof GiftCardReportDtoAttention
9244
+ */
9245
+ 'expiringSoon': GiftCardAttentionDtoExpiringSoon;
9246
+ /**
9247
+ *
9248
+ * @type {GiftCardAttentionDtoStalePending}
9249
+ * @memberof GiftCardReportDtoAttention
9250
+ */
9251
+ 'stalePending': GiftCardAttentionDtoStalePending;
9252
+ /**
9253
+ * The days ahead expiringSoon looks
9254
+ * @type {number}
9255
+ * @memberof GiftCardReportDtoAttention
9256
+ */
9257
+ 'expiringWithinDays': number;
8826
9258
  }
8827
9259
  /**
8828
9260
  * Cards made by hand in the period
@@ -8843,6 +9275,62 @@ export interface GiftCardReportDtoGivenFree {
8843
9275
  */
8844
9276
  'count': number;
8845
9277
  }
9278
+ /**
9279
+ * Right now, over every card of the owner in the currency: where the money paid onto cards went
9280
+ * @export
9281
+ * @interface GiftCardReportDtoMoneyWent
9282
+ */
9283
+ export interface GiftCardReportDtoMoneyWent {
9284
+ /**
9285
+ * 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).
9286
+ * @type {number}
9287
+ * @memberof GiftCardReportDtoMoneyWent
9288
+ */
9289
+ 'spent': number;
9290
+ /**
9291
+ * On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
9292
+ * @type {number}
9293
+ * @memberof GiftCardReportDtoMoneyWent
9294
+ */
9295
+ 'onCards': number;
9296
+ /**
9297
+ * Left on EXPIRED cards, in cents
9298
+ * @type {number}
9299
+ * @memberof GiftCardReportDtoMoneyWent
9300
+ */
9301
+ 'expiredUnused': number;
9302
+ /**
9303
+ * Left on BLOCKED cards, in cents
9304
+ * @type {number}
9305
+ * @memberof GiftCardReportDtoMoneyWent
9306
+ */
9307
+ 'blocked': number;
9308
+ }
9309
+ /**
9310
+ * The same sums over the period of the same number of days that ends the day before from
9311
+ * @export
9312
+ * @interface GiftCardReportDtoPrevious
9313
+ */
9314
+ export interface GiftCardReportDtoPrevious {
9315
+ /**
9316
+ *
9317
+ * @type {GiftCardPeriodTotalsDtoSold}
9318
+ * @memberof GiftCardReportDtoPrevious
9319
+ */
9320
+ 'sold': GiftCardPeriodTotalsDtoSold;
9321
+ /**
9322
+ *
9323
+ * @type {GiftCardPeriodTotalsDtoGivenFree}
9324
+ * @memberof GiftCardReportDtoPrevious
9325
+ */
9326
+ 'givenFree': GiftCardPeriodTotalsDtoGivenFree;
9327
+ /**
9328
+ *
9329
+ * @type {GiftCardPeriodTotalsDtoSpent}
9330
+ * @memberof GiftCardReportDtoPrevious
9331
+ */
9332
+ 'spent': GiftCardPeriodTotalsDtoSpent;
9333
+ }
8846
9334
  /**
8847
9335
  * Cards sold in the period, at the till or online
8848
9336
  * @export
@@ -8894,7 +9382,7 @@ export interface GiftCardSettingsDto {
8894
9382
  */
8895
9383
  'channels': GiftCardSettingsDtoChannels;
8896
9384
  /**
8897
- * 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.
9385
+ * The store\'s own channels that are on and can take gift cards: TILL for its till (an active MunchiPos row), ONLINE_STORE for its online store and MOBILE_APP for its mobile app (both an active Storefront row: the app orders through the same storefront), KIOSK for its kiosk (an active MunchiKiosk, MunchiKioskV2 or Kiosk row).
8898
9386
  * @type {Array<GiftCardChannel>}
8899
9387
  * @memberof GiftCardSettingsDto
8900
9388
  */
@@ -8941,6 +9429,18 @@ export interface GiftCardSettingsDto {
8941
9429
  * @memberof GiftCardSettingsDto
8942
9430
  */
8943
9431
  'imageUrl': string | null;
9432
+ /**
9433
+ * Whether holders are reminded by email 30 and 7 days before their card expires
9434
+ * @type {boolean}
9435
+ * @memberof GiftCardSettingsDto
9436
+ */
9437
+ 'remindBeforeExpiry': boolean;
9438
+ /**
9439
+ * The store\'s own gift card terms, shown in every card email; null for Munchi\'s standard terms
9440
+ * @type {string}
9441
+ * @memberof GiftCardSettingsDto
9442
+ */
9443
+ 'terms': string | null;
8944
9444
  }
8945
9445
  /**
8946
9446
  * Where the store\'s gift cards can be spent
@@ -8960,6 +9460,18 @@ export interface GiftCardSettingsDtoChannels {
8960
9460
  * @memberof GiftCardSettingsDtoChannels
8961
9461
  */
8962
9462
  'onlineStore': boolean;
9463
+ /**
9464
+ * Whether the store\'s kiosk takes gift cards. Always answered; absent in a change: unchanged, so a dashboard that sends only till and onlineStore keeps working.
9465
+ * @type {boolean}
9466
+ * @memberof GiftCardSettingsDtoChannels
9467
+ */
9468
+ 'kiosk'?: boolean;
9469
+ /**
9470
+ * Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
9471
+ * @type {boolean}
9472
+ * @memberof GiftCardSettingsDtoChannels
9473
+ */
9474
+ 'mobileApp'?: boolean;
8963
9475
  }
8964
9476
  /**
8965
9477
  *
@@ -25542,7 +26054,7 @@ export interface RecordWorldlineA2aResultDtoAnswer {
25542
26054
  */
25543
26055
  'remark'?: string;
25544
26056
  /**
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.
26057
+ * 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
26058
  * @type {string}
25547
26059
  * @memberof RecordWorldlineA2aResultDtoAnswer
25548
26060
  */
@@ -35442,6 +35954,18 @@ export interface UpdateGiftCardSettingsDto {
35442
35954
  * @memberof UpdateGiftCardSettingsDto
35443
35955
  */
35444
35956
  'imageUrl'?: string | null;
35957
+ /**
35958
+ * Whether holders are reminded by email 30 and 7 days before their card expires. Absent: unchanged.
35959
+ * @type {boolean}
35960
+ * @memberof UpdateGiftCardSettingsDto
35961
+ */
35962
+ 'remindBeforeExpiry'?: boolean;
35963
+ /**
35964
+ * The store\'s own gift card terms, 1 to 5000 characters, shown in every card email, or null for Munchi\'s standard terms. Absent: unchanged.
35965
+ * @type {string}
35966
+ * @memberof UpdateGiftCardSettingsDto
35967
+ */
35968
+ 'terms'?: string | null;
35445
35969
  }
35446
35970
  /**
35447
35971
  * Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
@@ -35461,6 +35985,18 @@ export interface UpdateGiftCardSettingsDtoChannels {
35461
35985
  * @memberof UpdateGiftCardSettingsDtoChannels
35462
35986
  */
35463
35987
  'onlineStore': boolean;
35988
+ /**
35989
+ * Whether the store\'s kiosk takes gift cards. Always answered; absent in a change: unchanged, so a dashboard that sends only till and onlineStore keeps working.
35990
+ * @type {boolean}
35991
+ * @memberof UpdateGiftCardSettingsDtoChannels
35992
+ */
35993
+ 'kiosk'?: boolean;
35994
+ /**
35995
+ * Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
35996
+ * @type {boolean}
35997
+ * @memberof UpdateGiftCardSettingsDtoChannels
35998
+ */
35999
+ 'mobileApp'?: boolean;
35464
36000
  }
35465
36001
  /**
35466
36002
  *
@@ -35922,6 +36458,19 @@ export interface UpdateTableStatusDto {
35922
36458
  */
35923
36459
  'status': TableStatus;
35924
36460
  }
36461
+ /**
36462
+ *
36463
+ * @export
36464
+ * @interface UpdateVenueGiftCardDto
36465
+ */
36466
+ export interface UpdateVenueGiftCardDto {
36467
+ /**
36468
+ * The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
36469
+ * @type {string}
36470
+ * @memberof UpdateVenueGiftCardDto
36471
+ */
36472
+ 'buyerEmail': string | null;
36473
+ }
35925
36474
  /**
35926
36475
  *
35927
36476
  * @export
@@ -37098,6 +37647,12 @@ export interface VenueGiftCardDetailDto {
37098
37647
  * @memberof VenueGiftCardDetailDto
37099
37648
  */
37100
37649
  'buyerEmail': string | null;
37650
+ /**
37651
+ * The buyer\'s phone: its country code and number, a space between; null when no number was given
37652
+ * @type {string}
37653
+ * @memberof VenueGiftCardDetailDto
37654
+ */
37655
+ 'buyerPhone': string | null;
37101
37656
  /**
37102
37657
  * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37103
37658
  * @type {number}
@@ -37146,6 +37701,49 @@ export interface VenueGiftCardDetailDto {
37146
37701
  * @memberof VenueGiftCardDetailDto
37147
37702
  */
37148
37703
  'history': Array<GiftCardHistoryEventDto>;
37704
+ /**
37705
+ * The message shown in the card\'s email; null when none
37706
+ * @type {string}
37707
+ * @memberof VenueGiftCardDetailDto
37708
+ */
37709
+ 'message': string | null;
37710
+ /**
37711
+ *
37712
+ * @type {VenueGiftCardDetailDtoLastEmail}
37713
+ * @memberof VenueGiftCardDetailDto
37714
+ */
37715
+ 'lastEmail': VenueGiftCardDetailDtoLastEmail | null;
37716
+ }
37717
+ /**
37718
+ * The card\'s newest email; null when it has none
37719
+ * @export
37720
+ * @interface VenueGiftCardDetailDtoLastEmail
37721
+ */
37722
+ export interface VenueGiftCardDetailDtoLastEmail {
37723
+ /**
37724
+ *
37725
+ * @type {GiftCardEmailKind}
37726
+ * @memberof VenueGiftCardDetailDtoLastEmail
37727
+ */
37728
+ 'kind': GiftCardEmailKind;
37729
+ /**
37730
+ *
37731
+ * @type {GiftCardEmailStatus}
37732
+ * @memberof VenueGiftCardDetailDtoLastEmail
37733
+ */
37734
+ 'status': GiftCardEmailStatus;
37735
+ /**
37736
+ * The address it goes to
37737
+ * @type {string}
37738
+ * @memberof VenueGiftCardDetailDtoLastEmail
37739
+ */
37740
+ 'to': string;
37741
+ /**
37742
+ * When it was sent, else when it last changed, ISO 8601
37743
+ * @type {string}
37744
+ * @memberof VenueGiftCardDetailDtoLastEmail
37745
+ */
37746
+ 'at': string;
37149
37747
  }
37150
37748
  /**
37151
37749
  *
@@ -37207,6 +37805,12 @@ export interface VenueGiftCardDto {
37207
37805
  * @memberof VenueGiftCardDto
37208
37806
  */
37209
37807
  'buyerEmail': string | null;
37808
+ /**
37809
+ * The buyer\'s phone: its country code and number, a space between; null when no number was given
37810
+ * @type {string}
37811
+ * @memberof VenueGiftCardDto
37812
+ */
37813
+ 'buyerPhone': string | null;
37210
37814
  /**
37211
37815
  * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37212
37816
  * @type {number}
@@ -39793,7 +40397,7 @@ export interface WorldlineAppAnswerDto {
39793
40397
  */
39794
40398
  'remark'?: string;
39795
40399
  /**
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.
40400
+ * 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
40401
  * @type {string}
39798
40402
  * @memberof WorldlineAppAnswerDto
39799
40403
  */
@@ -42968,7 +43572,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
42968
43572
  */
42969
43573
  configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42970
43574
  /**
42971
- * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
43575
+ * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
42972
43576
  * @summary Create or update a venue
42973
43577
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
42974
43578
  * @param {UpsertBusinessDto} upsertBusinessDto
@@ -43026,7 +43630,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
43026
43630
  */
43027
43631
  configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43028
43632
  /**
43029
- * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
43633
+ * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
43030
43634
  * @summary Set active provider and upsert its credentials
43031
43635
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43032
43636
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43046,7 +43650,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
43046
43650
  */
43047
43651
  configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
43048
43652
  /**
43049
- * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
43653
+ * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
43050
43654
  * @summary Create or update a channel\'s Viva config
43051
43655
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43052
43656
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43111,7 +43715,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
43111
43715
  */
43112
43716
  configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>>;
43113
43717
  /**
43114
- * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
43718
+ * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
43115
43719
  * @summary Create or update a venue
43116
43720
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43117
43721
  * @param {UpsertBusinessDto} upsertBusinessDto
@@ -43169,7 +43773,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
43169
43773
  */
43170
43774
  configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
43171
43775
  /**
43172
- * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
43776
+ * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
43173
43777
  * @summary Set active provider and upsert its credentials
43174
43778
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43175
43779
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43189,7 +43793,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
43189
43793
  */
43190
43794
  configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
43191
43795
  /**
43192
- * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
43796
+ * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
43193
43797
  * @summary Create or update a channel\'s Viva config
43194
43798
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43195
43799
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43254,7 +43858,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
43254
43858
  */
43255
43859
  configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto>;
43256
43860
  /**
43257
- * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
43861
+ * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
43258
43862
  * @summary Create or update a venue
43259
43863
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43260
43864
  * @param {UpsertBusinessDto} upsertBusinessDto
@@ -43312,7 +43916,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
43312
43916
  */
43313
43917
  configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
43314
43918
  /**
43315
- * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
43919
+ * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
43316
43920
  * @summary Set active provider and upsert its credentials
43317
43921
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43318
43922
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43332,7 +43936,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
43332
43936
  */
43333
43937
  configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
43334
43938
  /**
43335
- * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
43939
+ * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
43336
43940
  * @summary Create or update a channel\'s Viva config
43337
43941
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43338
43942
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43403,7 +44007,7 @@ export interface ConfigManagementApiInterface {
43403
44007
  */
43404
44008
  configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
43405
44009
  /**
43406
- * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
44010
+ * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
43407
44011
  * @summary Create or update a venue
43408
44012
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43409
44013
  * @param {UpsertBusinessDto} upsertBusinessDto
@@ -43467,7 +44071,7 @@ export interface ConfigManagementApiInterface {
43467
44071
  */
43468
44072
  configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
43469
44073
  /**
43470
- * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
44074
+ * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
43471
44075
  * @summary Set active provider and upsert its credentials
43472
44076
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43473
44077
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43489,7 +44093,7 @@ export interface ConfigManagementApiInterface {
43489
44093
  */
43490
44094
  configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
43491
44095
  /**
43492
- * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
44096
+ * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
43493
44097
  * @summary Create or update a channel\'s Viva config
43494
44098
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43495
44099
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43562,7 +44166,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
43562
44166
  */
43563
44167
  configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
43564
44168
  /**
43565
- * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
44169
+ * A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
43566
44170
  * @summary Create or update a venue
43567
44171
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43568
44172
  * @param {UpsertBusinessDto} upsertBusinessDto
@@ -43626,7 +44230,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
43626
44230
  */
43627
44231
  configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
43628
44232
  /**
43629
- * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The two saves are not one transaction.
44233
+ * Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
43630
44234
  * @summary Set active provider and upsert its credentials
43631
44235
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43632
44236
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -43648,7 +44252,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
43648
44252
  */
43649
44253
  configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
43650
44254
  /**
43651
- * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
44255
+ * Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
43652
44256
  * @summary Create or update a channel\'s Viva config
43653
44257
  * @param {number} businessId The venue\&#39;s orderingBusinessId, not its cuid
43654
44258
  * @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
@@ -45455,11 +46059,21 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45455
46059
  * @summary Make a gift card by hand, given for free
45456
46060
  * @param {number} businessId The store\&#39;s orderingBusinessId
45457
46061
  * @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.
46062
+ * @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
46063
  * @param {*} [options] Override http request option.
45460
46064
  * @throws {RequiredError}
45461
46065
  */
45462
46066
  createVenueGiftCard: (businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46067
+ /**
46068
+ * Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
46069
+ * @summary Send a gift card again to its saved email address
46070
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46071
+ * @param {string} cardId The card\&#39;s id
46072
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
46073
+ * @param {*} [options] Override http request option.
46074
+ * @throws {RequiredError}
46075
+ */
46076
+ emailVenueGiftCard: (businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45463
46077
  /**
45464
46078
  * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45465
46079
  * @summary Read one of a store\'s gift cards with its history
@@ -45470,7 +46084,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45470
46084
  */
45471
46085
  getVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45472
46086
  /**
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.
46087
+ * 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
46088
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45475
46089
  * @param {number} businessId The store\&#39;s orderingBusinessId
45476
46090
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45487,6 +46101,21 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45487
46101
  * @throws {RequiredError}
45488
46102
  */
45489
46103
  getVenueGiftCardSettings: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46104
+ /**
46105
+ * 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.
46106
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46107
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46108
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46109
+ * @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
46110
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46111
+ * @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.
46112
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46113
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46114
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46115
+ * @param {*} [options] Override http request option.
46116
+ * @throws {RequiredError}
46117
+ */
46118
+ listVenueGiftCardMovements: (businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45490
46119
  /**
45491
46120
  * 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
46121
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45495,10 +46124,11 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45495
46124
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45496
46125
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45497
46126
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46127
+ * @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
46128
  * @param {*} [options] Override http request option.
45499
46129
  * @throws {RequiredError}
45500
46130
  */
45501
- listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46131
+ listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45502
46132
  /**
45503
46133
  * 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
46134
  * @summary Unblock a gift card
@@ -45508,6 +46138,16 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
45508
46138
  * @throws {RequiredError}
45509
46139
  */
45510
46140
  unblockVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46141
+ /**
46142
+ * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
46143
+ * @summary Correct a gift card\'s email address
46144
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46145
+ * @param {string} cardId The card\&#39;s id
46146
+ * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
46147
+ * @param {*} [options] Override http request option.
46148
+ * @throws {RequiredError}
46149
+ */
46150
+ updateVenueGiftCard: (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45511
46151
  /**
45512
46152
  * 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.
45513
46153
  * @summary Change a store\'s gift card settings
@@ -45547,11 +46187,21 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45547
46187
  * @summary Make a gift card by hand, given for free
45548
46188
  * @param {number} businessId The store\&#39;s orderingBusinessId
45549
46189
  * @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.
46190
+ * @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
46191
  * @param {*} [options] Override http request option.
45552
46192
  * @throws {RequiredError}
45553
46193
  */
45554
46194
  createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
46195
+ /**
46196
+ * Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
46197
+ * @summary Send a gift card again to its saved email address
46198
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46199
+ * @param {string} cardId The card\&#39;s id
46200
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
46201
+ * @param {*} [options] Override http request option.
46202
+ * @throws {RequiredError}
46203
+ */
46204
+ emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45555
46205
  /**
45556
46206
  * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45557
46207
  * @summary Read one of a store\'s gift cards with its history
@@ -45562,7 +46212,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45562
46212
  */
45563
46213
  getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45564
46214
  /**
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.
46215
+ * 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
46216
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45567
46217
  * @param {number} businessId The store\&#39;s orderingBusinessId
45568
46218
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45579,6 +46229,21 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45579
46229
  * @throws {RequiredError}
45580
46230
  */
45581
46231
  getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSettingsDto>>;
46232
+ /**
46233
+ * 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.
46234
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46235
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46236
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46237
+ * @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
46238
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46239
+ * @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.
46240
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46241
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46242
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46243
+ * @param {*} [options] Override http request option.
46244
+ * @throws {RequiredError}
46245
+ */
46246
+ 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
46247
  /**
45583
46248
  * 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
46249
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45587,10 +46252,11 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45587
46252
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45588
46253
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45589
46254
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46255
+ * @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
46256
  * @param {*} [options] Override http request option.
45591
46257
  * @throws {RequiredError}
45592
46258
  */
45593
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
46259
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
45594
46260
  /**
45595
46261
  * 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
46262
  * @summary Unblock a gift card
@@ -45600,6 +46266,16 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45600
46266
  * @throws {RequiredError}
45601
46267
  */
45602
46268
  unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
46269
+ /**
46270
+ * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
46271
+ * @summary Correct a gift card\'s email address
46272
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46273
+ * @param {string} cardId The card\&#39;s id
46274
+ * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
46275
+ * @param {*} [options] Override http request option.
46276
+ * @throws {RequiredError}
46277
+ */
46278
+ updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45603
46279
  /**
45604
46280
  * 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.
45605
46281
  * @summary Change a store\'s gift card settings
@@ -45639,11 +46315,21 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45639
46315
  * @summary Make a gift card by hand, given for free
45640
46316
  * @param {number} businessId The store\&#39;s orderingBusinessId
45641
46317
  * @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.
46318
+ * @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
46319
  * @param {*} [options] Override http request option.
45644
46320
  * @throws {RequiredError}
45645
46321
  */
45646
46322
  createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
46323
+ /**
46324
+ * Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
46325
+ * @summary Send a gift card again to its saved email address
46326
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46327
+ * @param {string} cardId The card\&#39;s id
46328
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
46329
+ * @param {*} [options] Override http request option.
46330
+ * @throws {RequiredError}
46331
+ */
46332
+ emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45647
46333
  /**
45648
46334
  * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45649
46335
  * @summary Read one of a store\'s gift cards with its history
@@ -45654,7 +46340,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45654
46340
  */
45655
46341
  getVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45656
46342
  /**
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.
46343
+ * 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
46344
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45659
46345
  * @param {number} businessId The store\&#39;s orderingBusinessId
45660
46346
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45671,6 +46357,21 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45671
46357
  * @throws {RequiredError}
45672
46358
  */
45673
46359
  getVenueGiftCardSettings(businessId: number, options?: any): AxiosPromise<GiftCardSettingsDto>;
46360
+ /**
46361
+ * 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.
46362
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46363
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46364
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46365
+ * @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
46366
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46367
+ * @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.
46368
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46369
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46370
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46371
+ * @param {*} [options] Override http request option.
46372
+ * @throws {RequiredError}
46373
+ */
46374
+ listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: any): AxiosPromise<GiftCardMovementsDto>;
45674
46375
  /**
45675
46376
  * 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
46377
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45679,10 +46380,11 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45679
46380
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45680
46381
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45681
46382
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46383
+ * @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
46384
  * @param {*} [options] Override http request option.
45683
46385
  * @throws {RequiredError}
45684
46386
  */
45685
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: any): AxiosPromise<VenueGiftCardsDto>;
46387
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto>;
45686
46388
  /**
45687
46389
  * 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
46390
  * @summary Unblock a gift card
@@ -45692,6 +46394,16 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
45692
46394
  * @throws {RequiredError}
45693
46395
  */
45694
46396
  unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
46397
+ /**
46398
+ * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
46399
+ * @summary Correct a gift card\'s email address
46400
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46401
+ * @param {string} cardId The card\&#39;s id
46402
+ * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
46403
+ * @param {*} [options] Override http request option.
46404
+ * @throws {RequiredError}
46405
+ */
46406
+ updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45695
46407
  /**
45696
46408
  * 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.
45697
46409
  * @summary Change a store\'s gift card settings
@@ -45734,12 +46446,23 @@ export interface GiftCardsApiInterface {
45734
46446
  * @summary Make a gift card by hand, given for free
45735
46447
  * @param {number} businessId The store\&#39;s orderingBusinessId
45736
46448
  * @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.
46449
+ * @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
46450
  * @param {*} [options] Override http request option.
45739
46451
  * @throws {RequiredError}
45740
46452
  * @memberof GiftCardsApiInterface
45741
46453
  */
45742
46454
  createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
46455
+ /**
46456
+ * Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
46457
+ * @summary Send a gift card again to its saved email address
46458
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46459
+ * @param {string} cardId The card\&#39;s id
46460
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
46461
+ * @param {*} [options] Override http request option.
46462
+ * @throws {RequiredError}
46463
+ * @memberof GiftCardsApiInterface
46464
+ */
46465
+ emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45743
46466
  /**
45744
46467
  * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45745
46468
  * @summary Read one of a store\'s gift cards with its history
@@ -45751,7 +46474,7 @@ export interface GiftCardsApiInterface {
45751
46474
  */
45752
46475
  getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45753
46476
  /**
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.
46477
+ * 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
46478
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45756
46479
  * @param {number} businessId The store\&#39;s orderingBusinessId
45757
46480
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45770,6 +46493,22 @@ export interface GiftCardsApiInterface {
45770
46493
  * @memberof GiftCardsApiInterface
45771
46494
  */
45772
46495
  getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
46496
+ /**
46497
+ * 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.
46498
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46499
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46500
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46501
+ * @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
46502
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46503
+ * @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.
46504
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46505
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46506
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46507
+ * @param {*} [options] Override http request option.
46508
+ * @throws {RequiredError}
46509
+ * @memberof GiftCardsApiInterface
46510
+ */
46511
+ listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardMovementsDto>;
45773
46512
  /**
45774
46513
  * 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
46514
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45778,11 +46517,12 @@ export interface GiftCardsApiInterface {
45778
46517
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45779
46518
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45780
46519
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46520
+ * @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
46521
  * @param {*} [options] Override http request option.
45782
46522
  * @throws {RequiredError}
45783
46523
  * @memberof GiftCardsApiInterface
45784
46524
  */
45785
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
46525
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
45786
46526
  /**
45787
46527
  * 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
46528
  * @summary Unblock a gift card
@@ -45793,6 +46533,17 @@ export interface GiftCardsApiInterface {
45793
46533
  * @memberof GiftCardsApiInterface
45794
46534
  */
45795
46535
  unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
46536
+ /**
46537
+ * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
46538
+ * @summary Correct a gift card\'s email address
46539
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46540
+ * @param {string} cardId The card\&#39;s id
46541
+ * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
46542
+ * @param {*} [options] Override http request option.
46543
+ * @throws {RequiredError}
46544
+ * @memberof GiftCardsApiInterface
46545
+ */
46546
+ updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45796
46547
  /**
45797
46548
  * 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.
45798
46549
  * @summary Change a store\'s gift card settings
@@ -45837,12 +46588,23 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45837
46588
  * @summary Make a gift card by hand, given for free
45838
46589
  * @param {number} businessId The store\&#39;s orderingBusinessId
45839
46590
  * @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.
46591
+ * @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
46592
  * @param {*} [options] Override http request option.
45842
46593
  * @throws {RequiredError}
45843
46594
  * @memberof GiftCardsApi
45844
46595
  */
45845
46596
  createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
46597
+ /**
46598
+ * Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
46599
+ * @summary Send a gift card again to its saved email address
46600
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46601
+ * @param {string} cardId The card\&#39;s id
46602
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
46603
+ * @param {*} [options] Override http request option.
46604
+ * @throws {RequiredError}
46605
+ * @memberof GiftCardsApi
46606
+ */
46607
+ emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45846
46608
  /**
45847
46609
  * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45848
46610
  * @summary Read one of a store\'s gift cards with its history
@@ -45854,7 +46616,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45854
46616
  */
45855
46617
  getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45856
46618
  /**
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.
46619
+ * 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
46620
  * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45859
46621
  * @param {number} businessId The store\&#39;s orderingBusinessId
45860
46622
  * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
@@ -45873,6 +46635,22 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45873
46635
  * @memberof GiftCardsApi
45874
46636
  */
45875
46637
  getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardSettingsDto, any, {}>>;
46638
+ /**
46639
+ * 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.
46640
+ * @summary List every movement of a store\'s gift cards in a period, newest first
46641
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46642
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
46643
+ * @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
46644
+ * @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
46645
+ * @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.
46646
+ * @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
46647
+ * @param {string} [cursor] The nextCursor of the page before: a movement\&#39;s id. Absent for the first page.
46648
+ * @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
46649
+ * @param {*} [options] Override http request option.
46650
+ * @throws {RequiredError}
46651
+ * @memberof GiftCardsApi
46652
+ */
46653
+ 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
46654
  /**
45877
46655
  * 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
46656
  * @summary List a store\'s gift cards, newest first, a page at a time
@@ -45881,11 +46659,12 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45881
46659
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45882
46660
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45883
46661
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
46662
+ * @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
46663
  * @param {*} [options] Override http request option.
45885
46664
  * @throws {RequiredError}
45886
46665
  * @memberof GiftCardsApi
45887
46666
  */
45888
- listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
46667
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
45889
46668
  /**
45890
46669
  * 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
46670
  * @summary Unblock a gift card
@@ -45896,6 +46675,17 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
45896
46675
  * @memberof GiftCardsApi
45897
46676
  */
45898
46677
  unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
46678
+ /**
46679
+ * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
46680
+ * @summary Correct a gift card\'s email address
46681
+ * @param {number} businessId The store\&#39;s orderingBusinessId
46682
+ * @param {string} cardId The card\&#39;s id
46683
+ * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
46684
+ * @param {*} [options] Override http request option.
46685
+ * @throws {RequiredError}
46686
+ * @memberof GiftCardsApi
46687
+ */
46688
+ updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45899
46689
  /**
45900
46690
  * 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.
45901
46691
  * @summary Change a store\'s gift card settings
@@ -51589,7 +52379,7 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
51589
52379
  */
51590
52380
  recordManualPayment: (createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
51591
52381
  /**
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.
52382
+ * 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
52383
  * @summary Record the Worldline payment app\'s answer for a handheld session
51594
52384
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
51595
52385
  * @param {*} [options] Override http request option.
@@ -51839,7 +52629,7 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
51839
52629
  */
51840
52630
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
51841
52631
  /**
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.
52632
+ * 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
52633
  * @summary Record the Worldline payment app\'s answer for a handheld session
51844
52634
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
51845
52635
  * @param {*} [options] Override http request option.
@@ -52089,7 +52879,7 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
52089
52879
  */
52090
52880
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
52091
52881
  /**
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.
52882
+ * 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
52883
  * @summary Record the Worldline payment app\'s answer for a handheld session
52094
52884
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
52095
52885
  * @param {*} [options] Override http request option.
@@ -52357,7 +53147,7 @@ export interface PaymentSessionApiInterface {
52357
53147
  */
52358
53148
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
52359
53149
  /**
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.
53150
+ * 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
53151
  * @summary Record the Worldline payment app\'s answer for a handheld session
52362
53152
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
52363
53153
  * @param {*} [options] Override http request option.
@@ -52638,7 +53428,7 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
52638
53428
  */
52639
53429
  recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
52640
53430
  /**
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.
53431
+ * 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
53432
  * @summary Record the Worldline payment app\'s answer for a handheld session
52643
53433
  * @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
52644
53434
  * @param {*} [options] Override http request option.