@munchi_oy/core 2.12.0 → 2.13.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/api.d.ts +508 -22
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +588 -25
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -5373,6 +5373,24 @@ export interface CreateVenueGiftCardDto {
|
|
|
5373
5373
|
* @memberof CreateVenueGiftCardDto
|
|
5374
5374
|
*/
|
|
5375
5375
|
'note'?: string;
|
|
5376
|
+
/**
|
|
5377
|
+
* The buyer\'s email, at most 254 characters once the spaces around it are dropped. Absent or only spaces: none. Answered as buyerEmail.
|
|
5378
|
+
* @type {string}
|
|
5379
|
+
* @memberof CreateVenueGiftCardDto
|
|
5380
|
+
*/
|
|
5381
|
+
'buyerEmail'?: string;
|
|
5382
|
+
/**
|
|
5383
|
+
* 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.
|
|
5384
|
+
* @type {string}
|
|
5385
|
+
* @memberof CreateVenueGiftCardDto
|
|
5386
|
+
*/
|
|
5387
|
+
'phoneCountryCode'?: string;
|
|
5388
|
+
/**
|
|
5389
|
+
* 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.
|
|
5390
|
+
* @type {string}
|
|
5391
|
+
* @memberof CreateVenueGiftCardDto
|
|
5392
|
+
*/
|
|
5393
|
+
'phoneNumber'?: string;
|
|
5376
5394
|
/**
|
|
5377
5395
|
* 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.
|
|
5378
5396
|
* @type {string}
|
|
@@ -8791,6 +8809,63 @@ export interface GetStationResponseDtoStation {
|
|
|
8791
8809
|
}
|
|
8792
8810
|
|
|
8793
8811
|
|
|
8812
|
+
/**
|
|
8813
|
+
*
|
|
8814
|
+
* @export
|
|
8815
|
+
* @interface GiftCardAttentionDto
|
|
8816
|
+
*/
|
|
8817
|
+
export interface GiftCardAttentionDto {
|
|
8818
|
+
/**
|
|
8819
|
+
*
|
|
8820
|
+
* @type {GiftCardAttentionDtoExpiringSoon}
|
|
8821
|
+
* @memberof GiftCardAttentionDto
|
|
8822
|
+
*/
|
|
8823
|
+
'expiringSoon': GiftCardAttentionDtoExpiringSoon;
|
|
8824
|
+
/**
|
|
8825
|
+
*
|
|
8826
|
+
* @type {GiftCardAttentionDtoStalePending}
|
|
8827
|
+
* @memberof GiftCardAttentionDto
|
|
8828
|
+
*/
|
|
8829
|
+
'stalePending': GiftCardAttentionDtoStalePending;
|
|
8830
|
+
/**
|
|
8831
|
+
* The days ahead expiringSoon looks
|
|
8832
|
+
* @type {number}
|
|
8833
|
+
* @memberof GiftCardAttentionDto
|
|
8834
|
+
*/
|
|
8835
|
+
'expiringWithinDays': number;
|
|
8836
|
+
}
|
|
8837
|
+
/**
|
|
8838
|
+
* ACTIVE cards that expire within the next expiringWithinDays days: what is on them and how many
|
|
8839
|
+
* @export
|
|
8840
|
+
* @interface GiftCardAttentionDtoExpiringSoon
|
|
8841
|
+
*/
|
|
8842
|
+
export interface GiftCardAttentionDtoExpiringSoon {
|
|
8843
|
+
/**
|
|
8844
|
+
* The sum, in cents
|
|
8845
|
+
* @type {number}
|
|
8846
|
+
* @memberof GiftCardAttentionDtoExpiringSoon
|
|
8847
|
+
*/
|
|
8848
|
+
'amount': number;
|
|
8849
|
+
/**
|
|
8850
|
+
* How many cards
|
|
8851
|
+
* @type {number}
|
|
8852
|
+
* @memberof GiftCardAttentionDtoExpiringSoon
|
|
8853
|
+
*/
|
|
8854
|
+
'count': number;
|
|
8855
|
+
}
|
|
8856
|
+
/**
|
|
8857
|
+
* NOT_YET_VALID cards made more than 24 hours ago: their POS order may never have been paid
|
|
8858
|
+
* @export
|
|
8859
|
+
* @interface GiftCardAttentionDtoStalePending
|
|
8860
|
+
*/
|
|
8861
|
+
export interface GiftCardAttentionDtoStalePending {
|
|
8862
|
+
/**
|
|
8863
|
+
* How many cards
|
|
8864
|
+
* @type {number}
|
|
8865
|
+
* @memberof GiftCardAttentionDtoStalePending
|
|
8866
|
+
*/
|
|
8867
|
+
'count': number;
|
|
8868
|
+
}
|
|
8794
8869
|
/**
|
|
8795
8870
|
*
|
|
8796
8871
|
* @export
|
|
@@ -8824,6 +8899,19 @@ export interface GiftCardChannelsDto {
|
|
|
8824
8899
|
*/
|
|
8825
8900
|
'onlineStore': boolean;
|
|
8826
8901
|
}
|
|
8902
|
+
/**
|
|
8903
|
+
*
|
|
8904
|
+
* @export
|
|
8905
|
+
* @interface GiftCardCountDto
|
|
8906
|
+
*/
|
|
8907
|
+
export interface GiftCardCountDto {
|
|
8908
|
+
/**
|
|
8909
|
+
* How many cards
|
|
8910
|
+
* @type {number}
|
|
8911
|
+
* @memberof GiftCardCountDto
|
|
8912
|
+
*/
|
|
8913
|
+
'count': number;
|
|
8914
|
+
}
|
|
8827
8915
|
/**
|
|
8828
8916
|
*
|
|
8829
8917
|
* @export
|
|
@@ -9108,6 +9196,213 @@ export interface GiftCardMoneyDto {
|
|
|
9108
9196
|
*/
|
|
9109
9197
|
'count': number;
|
|
9110
9198
|
}
|
|
9199
|
+
/**
|
|
9200
|
+
*
|
|
9201
|
+
* @export
|
|
9202
|
+
* @interface GiftCardMoneyWentDto
|
|
9203
|
+
*/
|
|
9204
|
+
export interface GiftCardMoneyWentDto {
|
|
9205
|
+
/**
|
|
9206
|
+
* 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).
|
|
9207
|
+
* @type {number}
|
|
9208
|
+
* @memberof GiftCardMoneyWentDto
|
|
9209
|
+
*/
|
|
9210
|
+
'spent': number;
|
|
9211
|
+
/**
|
|
9212
|
+
* On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
|
|
9213
|
+
* @type {number}
|
|
9214
|
+
* @memberof GiftCardMoneyWentDto
|
|
9215
|
+
*/
|
|
9216
|
+
'onCards': number;
|
|
9217
|
+
/**
|
|
9218
|
+
* Left on EXPIRED cards, in cents
|
|
9219
|
+
* @type {number}
|
|
9220
|
+
* @memberof GiftCardMoneyWentDto
|
|
9221
|
+
*/
|
|
9222
|
+
'expiredUnused': number;
|
|
9223
|
+
/**
|
|
9224
|
+
* Left on BLOCKED cards, in cents
|
|
9225
|
+
* @type {number}
|
|
9226
|
+
* @memberof GiftCardMoneyWentDto
|
|
9227
|
+
*/
|
|
9228
|
+
'blocked': number;
|
|
9229
|
+
}
|
|
9230
|
+
/**
|
|
9231
|
+
*
|
|
9232
|
+
* @export
|
|
9233
|
+
* @interface GiftCardMovementDto
|
|
9234
|
+
*/
|
|
9235
|
+
export interface GiftCardMovementDto {
|
|
9236
|
+
/**
|
|
9237
|
+
* The movement\'s id
|
|
9238
|
+
* @type {string}
|
|
9239
|
+
* @memberof GiftCardMovementDto
|
|
9240
|
+
*/
|
|
9241
|
+
'id': string;
|
|
9242
|
+
/**
|
|
9243
|
+
* When it happened, ISO 8601
|
|
9244
|
+
* @type {string}
|
|
9245
|
+
* @memberof GiftCardMovementDto
|
|
9246
|
+
*/
|
|
9247
|
+
'at': string;
|
|
9248
|
+
/**
|
|
9249
|
+
* The card\'s id
|
|
9250
|
+
* @type {string}
|
|
9251
|
+
* @memberof GiftCardMovementDto
|
|
9252
|
+
*/
|
|
9253
|
+
'cardId': string;
|
|
9254
|
+
/**
|
|
9255
|
+
* The card\'s 6-digit code
|
|
9256
|
+
* @type {string}
|
|
9257
|
+
* @memberof GiftCardMovementDto
|
|
9258
|
+
*/
|
|
9259
|
+
'code': string;
|
|
9260
|
+
/**
|
|
9261
|
+
*
|
|
9262
|
+
* @type {GiftCardHistoryKind}
|
|
9263
|
+
* @memberof GiftCardMovementDto
|
|
9264
|
+
*/
|
|
9265
|
+
'kind': GiftCardHistoryKind;
|
|
9266
|
+
/**
|
|
9267
|
+
* How the card\'s balance moved, in cents: positive for SOLD, CREATED_BY_HAND and GIVEN_BACK, negative for SPENT, either for CORRECTED
|
|
9268
|
+
* @type {number}
|
|
9269
|
+
* @memberof GiftCardMovementDto
|
|
9270
|
+
*/
|
|
9271
|
+
'amount': number;
|
|
9272
|
+
/**
|
|
9273
|
+
* The card\'s balance after it, in cents
|
|
9274
|
+
* @type {number}
|
|
9275
|
+
* @memberof GiftCardMovementDto
|
|
9276
|
+
*/
|
|
9277
|
+
'balanceAfter': number;
|
|
9278
|
+
/**
|
|
9279
|
+
* The store where it happened; null when the history did not record one
|
|
9280
|
+
* @type {number}
|
|
9281
|
+
* @memberof GiftCardMovementDto
|
|
9282
|
+
*/
|
|
9283
|
+
'venueId': number | null;
|
|
9284
|
+
/**
|
|
9285
|
+
* That store\'s name; null with venueId, or when the store is gone
|
|
9286
|
+
* @type {string}
|
|
9287
|
+
* @memberof GiftCardMovementDto
|
|
9288
|
+
*/
|
|
9289
|
+
'venueName': string | null;
|
|
9290
|
+
/**
|
|
9291
|
+
* The POS order it belongs to; null when none
|
|
9292
|
+
* @type {string}
|
|
9293
|
+
* @memberof GiftCardMovementDto
|
|
9294
|
+
*/
|
|
9295
|
+
'orderId': string | null;
|
|
9296
|
+
/**
|
|
9297
|
+
* 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
|
|
9298
|
+
* @type {boolean}
|
|
9299
|
+
* @memberof GiftCardMovementDto
|
|
9300
|
+
*/
|
|
9301
|
+
'pending': boolean;
|
|
9302
|
+
}
|
|
9303
|
+
|
|
9304
|
+
|
|
9305
|
+
/**
|
|
9306
|
+
*
|
|
9307
|
+
* @export
|
|
9308
|
+
* @interface GiftCardMovementsDto
|
|
9309
|
+
*/
|
|
9310
|
+
export interface GiftCardMovementsDto {
|
|
9311
|
+
/**
|
|
9312
|
+
* The page\'s movements, newest first
|
|
9313
|
+
* @type {Array<GiftCardMovementDto>}
|
|
9314
|
+
* @memberof GiftCardMovementsDto
|
|
9315
|
+
*/
|
|
9316
|
+
'movements': Array<GiftCardMovementDto>;
|
|
9317
|
+
/**
|
|
9318
|
+
* The cursor of the next page; null when this page is the last
|
|
9319
|
+
* @type {string}
|
|
9320
|
+
* @memberof GiftCardMovementsDto
|
|
9321
|
+
*/
|
|
9322
|
+
'nextCursor': string | null;
|
|
9323
|
+
}
|
|
9324
|
+
/**
|
|
9325
|
+
*
|
|
9326
|
+
* @export
|
|
9327
|
+
* @interface GiftCardPeriodTotalsDto
|
|
9328
|
+
*/
|
|
9329
|
+
export interface GiftCardPeriodTotalsDto {
|
|
9330
|
+
/**
|
|
9331
|
+
*
|
|
9332
|
+
* @type {GiftCardPeriodTotalsDtoSold}
|
|
9333
|
+
* @memberof GiftCardPeriodTotalsDto
|
|
9334
|
+
*/
|
|
9335
|
+
'sold': GiftCardPeriodTotalsDtoSold;
|
|
9336
|
+
/**
|
|
9337
|
+
*
|
|
9338
|
+
* @type {GiftCardPeriodTotalsDtoGivenFree}
|
|
9339
|
+
* @memberof GiftCardPeriodTotalsDto
|
|
9340
|
+
*/
|
|
9341
|
+
'givenFree': GiftCardPeriodTotalsDtoGivenFree;
|
|
9342
|
+
/**
|
|
9343
|
+
*
|
|
9344
|
+
* @type {GiftCardPeriodTotalsDtoSpent}
|
|
9345
|
+
* @memberof GiftCardPeriodTotalsDto
|
|
9346
|
+
*/
|
|
9347
|
+
'spent': GiftCardPeriodTotalsDtoSpent;
|
|
9348
|
+
}
|
|
9349
|
+
/**
|
|
9350
|
+
* Cards made by hand
|
|
9351
|
+
* @export
|
|
9352
|
+
* @interface GiftCardPeriodTotalsDtoGivenFree
|
|
9353
|
+
*/
|
|
9354
|
+
export interface GiftCardPeriodTotalsDtoGivenFree {
|
|
9355
|
+
/**
|
|
9356
|
+
* The sum, in cents
|
|
9357
|
+
* @type {number}
|
|
9358
|
+
* @memberof GiftCardPeriodTotalsDtoGivenFree
|
|
9359
|
+
*/
|
|
9360
|
+
'amount': number;
|
|
9361
|
+
/**
|
|
9362
|
+
* How many cards
|
|
9363
|
+
* @type {number}
|
|
9364
|
+
* @memberof GiftCardPeriodTotalsDtoGivenFree
|
|
9365
|
+
*/
|
|
9366
|
+
'count': number;
|
|
9367
|
+
}
|
|
9368
|
+
/**
|
|
9369
|
+
* Cards sold, at the till or online
|
|
9370
|
+
* @export
|
|
9371
|
+
* @interface GiftCardPeriodTotalsDtoSold
|
|
9372
|
+
*/
|
|
9373
|
+
export interface GiftCardPeriodTotalsDtoSold {
|
|
9374
|
+
/**
|
|
9375
|
+
* The sum, in cents
|
|
9376
|
+
* @type {number}
|
|
9377
|
+
* @memberof GiftCardPeriodTotalsDtoSold
|
|
9378
|
+
*/
|
|
9379
|
+
'amount': number;
|
|
9380
|
+
/**
|
|
9381
|
+
* How many cards
|
|
9382
|
+
* @type {number}
|
|
9383
|
+
* @memberof GiftCardPeriodTotalsDtoSold
|
|
9384
|
+
*/
|
|
9385
|
+
'count': number;
|
|
9386
|
+
}
|
|
9387
|
+
/**
|
|
9388
|
+
* Cards spent
|
|
9389
|
+
* @export
|
|
9390
|
+
* @interface GiftCardPeriodTotalsDtoSpent
|
|
9391
|
+
*/
|
|
9392
|
+
export interface GiftCardPeriodTotalsDtoSpent {
|
|
9393
|
+
/**
|
|
9394
|
+
* Taken off cards, less what went back on them, in cents
|
|
9395
|
+
* @type {number}
|
|
9396
|
+
* @memberof GiftCardPeriodTotalsDtoSpent
|
|
9397
|
+
*/
|
|
9398
|
+
'amount': number;
|
|
9399
|
+
/**
|
|
9400
|
+
* How many orders cards paid that kept the payment
|
|
9401
|
+
* @type {number}
|
|
9402
|
+
* @memberof GiftCardPeriodTotalsDtoSpent
|
|
9403
|
+
*/
|
|
9404
|
+
'orderCount': number;
|
|
9405
|
+
}
|
|
9111
9406
|
/**
|
|
9112
9407
|
*
|
|
9113
9408
|
* @export
|
|
@@ -9150,9 +9445,52 @@ export interface GiftCardReportDto {
|
|
|
9150
9445
|
* @memberof GiftCardReportDto
|
|
9151
9446
|
*/
|
|
9152
9447
|
'stores': Array<GiftCardStoreReportDto>;
|
|
9448
|
+
/**
|
|
9449
|
+
*
|
|
9450
|
+
* @type {GiftCardReportDtoPrevious}
|
|
9451
|
+
* @memberof GiftCardReportDto
|
|
9452
|
+
*/
|
|
9453
|
+
'previous': GiftCardReportDtoPrevious;
|
|
9454
|
+
/**
|
|
9455
|
+
*
|
|
9456
|
+
* @type {GiftCardReportDtoMoneyWent}
|
|
9457
|
+
* @memberof GiftCardReportDto
|
|
9458
|
+
*/
|
|
9459
|
+
'moneyWent': GiftCardReportDtoMoneyWent;
|
|
9460
|
+
/**
|
|
9461
|
+
*
|
|
9462
|
+
* @type {GiftCardReportDtoAttention}
|
|
9463
|
+
* @memberof GiftCardReportDto
|
|
9464
|
+
*/
|
|
9465
|
+
'attention': GiftCardReportDtoAttention;
|
|
9153
9466
|
}
|
|
9154
9467
|
|
|
9155
9468
|
|
|
9469
|
+
/**
|
|
9470
|
+
* Right now: what may need the store\'s attention
|
|
9471
|
+
* @export
|
|
9472
|
+
* @interface GiftCardReportDtoAttention
|
|
9473
|
+
*/
|
|
9474
|
+
export interface GiftCardReportDtoAttention {
|
|
9475
|
+
/**
|
|
9476
|
+
*
|
|
9477
|
+
* @type {GiftCardAttentionDtoExpiringSoon}
|
|
9478
|
+
* @memberof GiftCardReportDtoAttention
|
|
9479
|
+
*/
|
|
9480
|
+
'expiringSoon': GiftCardAttentionDtoExpiringSoon;
|
|
9481
|
+
/**
|
|
9482
|
+
*
|
|
9483
|
+
* @type {GiftCardAttentionDtoStalePending}
|
|
9484
|
+
* @memberof GiftCardReportDtoAttention
|
|
9485
|
+
*/
|
|
9486
|
+
'stalePending': GiftCardAttentionDtoStalePending;
|
|
9487
|
+
/**
|
|
9488
|
+
* The days ahead expiringSoon looks
|
|
9489
|
+
* @type {number}
|
|
9490
|
+
* @memberof GiftCardReportDtoAttention
|
|
9491
|
+
*/
|
|
9492
|
+
'expiringWithinDays': number;
|
|
9493
|
+
}
|
|
9156
9494
|
/**
|
|
9157
9495
|
* Cards made by hand in the period
|
|
9158
9496
|
* @export
|
|
@@ -9172,6 +9510,62 @@ export interface GiftCardReportDtoGivenFree {
|
|
|
9172
9510
|
*/
|
|
9173
9511
|
'count': number;
|
|
9174
9512
|
}
|
|
9513
|
+
/**
|
|
9514
|
+
* Right now, over every card of the owner in the currency: where the money paid onto cards went
|
|
9515
|
+
* @export
|
|
9516
|
+
* @interface GiftCardReportDtoMoneyWent
|
|
9517
|
+
*/
|
|
9518
|
+
export interface GiftCardReportDtoMoneyWent {
|
|
9519
|
+
/**
|
|
9520
|
+
* 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).
|
|
9521
|
+
* @type {number}
|
|
9522
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9523
|
+
*/
|
|
9524
|
+
'spent': number;
|
|
9525
|
+
/**
|
|
9526
|
+
* On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
|
|
9527
|
+
* @type {number}
|
|
9528
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9529
|
+
*/
|
|
9530
|
+
'onCards': number;
|
|
9531
|
+
/**
|
|
9532
|
+
* Left on EXPIRED cards, in cents
|
|
9533
|
+
* @type {number}
|
|
9534
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9535
|
+
*/
|
|
9536
|
+
'expiredUnused': number;
|
|
9537
|
+
/**
|
|
9538
|
+
* Left on BLOCKED cards, in cents
|
|
9539
|
+
* @type {number}
|
|
9540
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9541
|
+
*/
|
|
9542
|
+
'blocked': number;
|
|
9543
|
+
}
|
|
9544
|
+
/**
|
|
9545
|
+
* The same sums over the period of the same number of days that ends the day before from
|
|
9546
|
+
* @export
|
|
9547
|
+
* @interface GiftCardReportDtoPrevious
|
|
9548
|
+
*/
|
|
9549
|
+
export interface GiftCardReportDtoPrevious {
|
|
9550
|
+
/**
|
|
9551
|
+
*
|
|
9552
|
+
* @type {GiftCardPeriodTotalsDtoSold}
|
|
9553
|
+
* @memberof GiftCardReportDtoPrevious
|
|
9554
|
+
*/
|
|
9555
|
+
'sold': GiftCardPeriodTotalsDtoSold;
|
|
9556
|
+
/**
|
|
9557
|
+
*
|
|
9558
|
+
* @type {GiftCardPeriodTotalsDtoGivenFree}
|
|
9559
|
+
* @memberof GiftCardReportDtoPrevious
|
|
9560
|
+
*/
|
|
9561
|
+
'givenFree': GiftCardPeriodTotalsDtoGivenFree;
|
|
9562
|
+
/**
|
|
9563
|
+
*
|
|
9564
|
+
* @type {GiftCardPeriodTotalsDtoSpent}
|
|
9565
|
+
* @memberof GiftCardReportDtoPrevious
|
|
9566
|
+
*/
|
|
9567
|
+
'spent': GiftCardPeriodTotalsDtoSpent;
|
|
9568
|
+
}
|
|
9175
9569
|
/**
|
|
9176
9570
|
* Cards sold in the period, at the till or online
|
|
9177
9571
|
* @export
|
|
@@ -26335,7 +26729,7 @@ export interface RecordWorldlineA2aResultDtoAnswer {
|
|
|
26335
26729
|
*/
|
|
26336
26730
|
'remark'?: string;
|
|
26337
26731
|
/**
|
|
26338
|
-
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s
|
|
26732
|
+
* 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.
|
|
26339
26733
|
* @type {string}
|
|
26340
26734
|
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
26341
26735
|
*/
|
|
@@ -38202,6 +38596,12 @@ export interface VenueGiftCardDetailDto {
|
|
|
38202
38596
|
* @memberof VenueGiftCardDetailDto
|
|
38203
38597
|
*/
|
|
38204
38598
|
'buyerEmail': string | null;
|
|
38599
|
+
/**
|
|
38600
|
+
* The buyer\'s phone: its country code and number, a space between; null when no number was given
|
|
38601
|
+
* @type {string}
|
|
38602
|
+
* @memberof VenueGiftCardDetailDto
|
|
38603
|
+
*/
|
|
38604
|
+
'buyerPhone': string | null;
|
|
38205
38605
|
/**
|
|
38206
38606
|
* The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
|
|
38207
38607
|
* @type {number}
|
|
@@ -38313,6 +38713,12 @@ export interface VenueGiftCardDto {
|
|
|
38313
38713
|
* @memberof VenueGiftCardDto
|
|
38314
38714
|
*/
|
|
38315
38715
|
'buyerEmail': string | null;
|
|
38716
|
+
/**
|
|
38717
|
+
* The buyer\'s phone: its country code and number, a space between; null when no number was given
|
|
38718
|
+
* @type {string}
|
|
38719
|
+
* @memberof VenueGiftCardDto
|
|
38720
|
+
*/
|
|
38721
|
+
'buyerPhone': string | null;
|
|
38316
38722
|
/**
|
|
38317
38723
|
* The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
|
|
38318
38724
|
* @type {number}
|
|
@@ -40961,7 +41367,7 @@ export interface WorldlineAppAnswerDto {
|
|
|
40961
41367
|
*/
|
|
40962
41368
|
'remark'?: string;
|
|
40963
41369
|
/**
|
|
40964
|
-
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s
|
|
41370
|
+
* 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.
|
|
40965
41371
|
* @type {string}
|
|
40966
41372
|
* @memberof WorldlineAppAnswerDto
|
|
40967
41373
|
*/
|
|
@@ -50691,7 +51097,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50691
51097
|
* @summary Make a gift card by hand, given for free
|
|
50692
51098
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
50693
51099
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
50694
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'s owner, amount, recipientName and note, and expiresAt when it sends
|
|
51100
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'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\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
50695
51101
|
* @param {*} [options] Override http request option.
|
|
50696
51102
|
* @throws {RequiredError}
|
|
50697
51103
|
*/
|
|
@@ -50778,7 +51184,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50778
51184
|
};
|
|
50779
51185
|
},
|
|
50780
51186
|
/**
|
|
50781
|
-
* 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.
|
|
51187
|
+
* 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.
|
|
50782
51188
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
50783
51189
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
50784
51190
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -50858,6 +51264,83 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50858
51264
|
|
|
50859
51265
|
|
|
50860
51266
|
|
|
51267
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51268
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51269
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51270
|
+
|
|
51271
|
+
return {
|
|
51272
|
+
url: toPathString(localVarUrlObj),
|
|
51273
|
+
options: localVarRequestOptions,
|
|
51274
|
+
};
|
|
51275
|
+
},
|
|
51276
|
+
/**
|
|
51277
|
+
* 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.
|
|
51278
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
51279
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51280
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51281
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51282
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
51283
|
+
* @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.
|
|
51284
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
51285
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
51286
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
51287
|
+
* @param {*} [options] Override http request option.
|
|
51288
|
+
* @throws {RequiredError}
|
|
51289
|
+
*/
|
|
51290
|
+
listVenueGiftCardMovements: async (businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51291
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51292
|
+
assertParamExists('listVenueGiftCardMovements', 'businessId', businessId)
|
|
51293
|
+
// verify required parameter 'from' is not null or undefined
|
|
51294
|
+
assertParamExists('listVenueGiftCardMovements', 'from', from)
|
|
51295
|
+
// verify required parameter 'to' is not null or undefined
|
|
51296
|
+
assertParamExists('listVenueGiftCardMovements', 'to', to)
|
|
51297
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-card-movements`
|
|
51298
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
51299
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51300
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51301
|
+
let baseOptions;
|
|
51302
|
+
if (configuration) {
|
|
51303
|
+
baseOptions = configuration.baseOptions;
|
|
51304
|
+
}
|
|
51305
|
+
|
|
51306
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
51307
|
+
const localVarHeaderParameter = {} as any;
|
|
51308
|
+
const localVarQueryParameter = {} as any;
|
|
51309
|
+
|
|
51310
|
+
// authentication JWT-auth required
|
|
51311
|
+
// http bearer authentication required
|
|
51312
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51313
|
+
|
|
51314
|
+
if (from !== undefined) {
|
|
51315
|
+
localVarQueryParameter['from'] = from;
|
|
51316
|
+
}
|
|
51317
|
+
|
|
51318
|
+
if (to !== undefined) {
|
|
51319
|
+
localVarQueryParameter['to'] = to;
|
|
51320
|
+
}
|
|
51321
|
+
|
|
51322
|
+
if (search !== undefined) {
|
|
51323
|
+
localVarQueryParameter['search'] = search;
|
|
51324
|
+
}
|
|
51325
|
+
|
|
51326
|
+
if (kinds) {
|
|
51327
|
+
localVarQueryParameter['kinds'] = kinds;
|
|
51328
|
+
}
|
|
51329
|
+
|
|
51330
|
+
if (venueIds) {
|
|
51331
|
+
localVarQueryParameter['venueIds'] = venueIds;
|
|
51332
|
+
}
|
|
51333
|
+
|
|
51334
|
+
if (cursor !== undefined) {
|
|
51335
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
51336
|
+
}
|
|
51337
|
+
|
|
51338
|
+
if (limit !== undefined) {
|
|
51339
|
+
localVarQueryParameter['limit'] = limit;
|
|
51340
|
+
}
|
|
51341
|
+
|
|
51342
|
+
|
|
51343
|
+
|
|
50861
51344
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50862
51345
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50863
51346
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -50875,10 +51358,11 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50875
51358
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
50876
51359
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
50877
51360
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51361
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
50878
51362
|
* @param {*} [options] Override http request option.
|
|
50879
51363
|
* @throws {RequiredError}
|
|
50880
51364
|
*/
|
|
50881
|
-
listVenueGiftCards: async (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51365
|
+
listVenueGiftCards: async (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50882
51366
|
// verify required parameter 'businessId' is not null or undefined
|
|
50883
51367
|
assertParamExists('listVenueGiftCards', 'businessId', businessId)
|
|
50884
51368
|
const localVarPath = `/api/v2/venues/{businessId}/gift-cards`
|
|
@@ -50914,6 +51398,10 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50914
51398
|
localVarQueryParameter['limit'] = limit;
|
|
50915
51399
|
}
|
|
50916
51400
|
|
|
51401
|
+
if (expiresBefore !== undefined) {
|
|
51402
|
+
localVarQueryParameter['expiresBefore'] = expiresBefore;
|
|
51403
|
+
}
|
|
51404
|
+
|
|
50917
51405
|
|
|
50918
51406
|
|
|
50919
51407
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -51051,7 +51539,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51051
51539
|
* @summary Make a gift card by hand, given for free
|
|
51052
51540
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51053
51541
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51054
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'s owner, amount, recipientName and note, and expiresAt when it sends
|
|
51542
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'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\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51055
51543
|
* @param {*} [options] Override http request option.
|
|
51056
51544
|
* @throws {RequiredError}
|
|
51057
51545
|
*/
|
|
@@ -51072,7 +51560,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51072
51560
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51073
51561
|
},
|
|
51074
51562
|
/**
|
|
51075
|
-
* 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.
|
|
51563
|
+
* 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.
|
|
51076
51564
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51077
51565
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51078
51566
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51095,6 +51583,24 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51095
51583
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardSettings(businessId, options);
|
|
51096
51584
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51097
51585
|
},
|
|
51586
|
+
/**
|
|
51587
|
+
* 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.
|
|
51588
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
51589
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51590
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51591
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51592
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
51593
|
+
* @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.
|
|
51594
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
51595
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
51596
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
51597
|
+
* @param {*} [options] Override http request option.
|
|
51598
|
+
* @throws {RequiredError}
|
|
51599
|
+
*/
|
|
51600
|
+
async 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>> {
|
|
51601
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueGiftCardMovements(businessId, from, to, search, kinds, venueIds, cursor, limit, options);
|
|
51602
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51603
|
+
},
|
|
51098
51604
|
/**
|
|
51099
51605
|
* 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.
|
|
51100
51606
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51103,11 +51609,12 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51103
51609
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51104
51610
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51105
51611
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51612
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51106
51613
|
* @param {*} [options] Override http request option.
|
|
51107
51614
|
* @throws {RequiredError}
|
|
51108
51615
|
*/
|
|
51109
|
-
async listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>> {
|
|
51110
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueGiftCards(businessId, search, state, cursor, limit, options);
|
|
51616
|
+
async listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>> {
|
|
51617
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options);
|
|
51111
51618
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51112
51619
|
},
|
|
51113
51620
|
/**
|
|
@@ -51172,7 +51679,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51172
51679
|
* @summary Make a gift card by hand, given for free
|
|
51173
51680
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51174
51681
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51175
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'s owner, amount, recipientName and note, and expiresAt when it sends
|
|
51682
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'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\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51176
51683
|
* @param {*} [options] Override http request option.
|
|
51177
51684
|
* @throws {RequiredError}
|
|
51178
51685
|
*/
|
|
@@ -51191,7 +51698,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51191
51698
|
return localVarFp.getVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51192
51699
|
},
|
|
51193
51700
|
/**
|
|
51194
|
-
* 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.
|
|
51701
|
+
* 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.
|
|
51195
51702
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51196
51703
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51197
51704
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51212,6 +51719,23 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51212
51719
|
getVenueGiftCardSettings(businessId: number, options?: any): AxiosPromise<GiftCardSettingsDto> {
|
|
51213
51720
|
return localVarFp.getVenueGiftCardSettings(businessId, options).then((request) => request(axios, basePath));
|
|
51214
51721
|
},
|
|
51722
|
+
/**
|
|
51723
|
+
* 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.
|
|
51724
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
51725
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51726
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51727
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51728
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
51729
|
+
* @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.
|
|
51730
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
51731
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
51732
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
51733
|
+
* @param {*} [options] Override http request option.
|
|
51734
|
+
* @throws {RequiredError}
|
|
51735
|
+
*/
|
|
51736
|
+
listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: any): AxiosPromise<GiftCardMovementsDto> {
|
|
51737
|
+
return localVarFp.listVenueGiftCardMovements(businessId, from, to, search, kinds, venueIds, cursor, limit, options).then((request) => request(axios, basePath));
|
|
51738
|
+
},
|
|
51215
51739
|
/**
|
|
51216
51740
|
* 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.
|
|
51217
51741
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51220,11 +51744,12 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51220
51744
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51221
51745
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51222
51746
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51747
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51223
51748
|
* @param {*} [options] Override http request option.
|
|
51224
51749
|
* @throws {RequiredError}
|
|
51225
51750
|
*/
|
|
51226
|
-
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: any): AxiosPromise<VenueGiftCardsDto> {
|
|
51227
|
-
return localVarFp.listVenueGiftCards(businessId, search, state, cursor, limit, options).then((request) => request(axios, basePath));
|
|
51751
|
+
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto> {
|
|
51752
|
+
return localVarFp.listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options).then((request) => request(axios, basePath));
|
|
51228
51753
|
},
|
|
51229
51754
|
/**
|
|
51230
51755
|
* 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.
|
|
@@ -51285,7 +51810,7 @@ export interface GiftCardsApiInterface {
|
|
|
51285
51810
|
* @summary Make a gift card by hand, given for free
|
|
51286
51811
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51287
51812
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51288
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'s owner, amount, recipientName and note, and expiresAt when it sends
|
|
51813
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'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\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51289
51814
|
* @param {*} [options] Override http request option.
|
|
51290
51815
|
* @throws {RequiredError}
|
|
51291
51816
|
* @memberof GiftCardsApiInterface
|
|
@@ -51304,7 +51829,7 @@ export interface GiftCardsApiInterface {
|
|
|
51304
51829
|
getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51305
51830
|
|
|
51306
51831
|
/**
|
|
51307
|
-
* 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.
|
|
51832
|
+
* 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.
|
|
51308
51833
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51309
51834
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51310
51835
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51325,6 +51850,23 @@ export interface GiftCardsApiInterface {
|
|
|
51325
51850
|
*/
|
|
51326
51851
|
getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
|
|
51327
51852
|
|
|
51853
|
+
/**
|
|
51854
|
+
* 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.
|
|
51855
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
51856
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51857
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51858
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51859
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
51860
|
+
* @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.
|
|
51861
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
51862
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
51863
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
51864
|
+
* @param {*} [options] Override http request option.
|
|
51865
|
+
* @throws {RequiredError}
|
|
51866
|
+
* @memberof GiftCardsApiInterface
|
|
51867
|
+
*/
|
|
51868
|
+
listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardMovementsDto>;
|
|
51869
|
+
|
|
51328
51870
|
/**
|
|
51329
51871
|
* 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.
|
|
51330
51872
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51333,11 +51875,12 @@ export interface GiftCardsApiInterface {
|
|
|
51333
51875
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51334
51876
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51335
51877
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51878
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51336
51879
|
* @param {*} [options] Override http request option.
|
|
51337
51880
|
* @throws {RequiredError}
|
|
51338
51881
|
* @memberof GiftCardsApiInterface
|
|
51339
51882
|
*/
|
|
51340
|
-
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
51883
|
+
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
51341
51884
|
|
|
51342
51885
|
/**
|
|
51343
51886
|
* 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.
|
|
@@ -51402,7 +51945,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51402
51945
|
* @summary Make a gift card by hand, given for free
|
|
51403
51946
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51404
51947
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51405
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'s owner, amount, recipientName and note, and expiresAt when it sends
|
|
51948
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. 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\'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\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51406
51949
|
* @param {*} [options] Override http request option.
|
|
51407
51950
|
* @throws {RequiredError}
|
|
51408
51951
|
* @memberof GiftCardsApi
|
|
@@ -51425,7 +51968,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51425
51968
|
}
|
|
51426
51969
|
|
|
51427
51970
|
/**
|
|
51428
|
-
* 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.
|
|
51971
|
+
* 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.
|
|
51429
51972
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51430
51973
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51431
51974
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51450,6 +51993,25 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51450
51993
|
return GiftCardsApiFp(this.configuration).getVenueGiftCardSettings(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
51451
51994
|
}
|
|
51452
51995
|
|
|
51996
|
+
/**
|
|
51997
|
+
* 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.
|
|
51998
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
51999
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52000
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
52001
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
52002
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
52003
|
+
* @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.
|
|
52004
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
52005
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
52006
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
52007
|
+
* @param {*} [options] Override http request option.
|
|
52008
|
+
* @throws {RequiredError}
|
|
52009
|
+
* @memberof GiftCardsApi
|
|
52010
|
+
*/
|
|
52011
|
+
public listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig) {
|
|
52012
|
+
return GiftCardsApiFp(this.configuration).listVenueGiftCardMovements(businessId, from, to, search, kinds, venueIds, cursor, limit, options).then((request) => request(this.axios, this.basePath));
|
|
52013
|
+
}
|
|
52014
|
+
|
|
51453
52015
|
/**
|
|
51454
52016
|
* 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.
|
|
51455
52017
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51458,12 +52020,13 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51458
52020
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51459
52021
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51460
52022
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
52023
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51461
52024
|
* @param {*} [options] Override http request option.
|
|
51462
52025
|
* @throws {RequiredError}
|
|
51463
52026
|
* @memberof GiftCardsApi
|
|
51464
52027
|
*/
|
|
51465
|
-
public listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig) {
|
|
51466
|
-
return GiftCardsApiFp(this.configuration).listVenueGiftCards(businessId, search, state, cursor, limit, options).then((request) => request(this.axios, this.basePath));
|
|
52028
|
+
public listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) {
|
|
52029
|
+
return GiftCardsApiFp(this.configuration).listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options).then((request) => request(this.axios, this.basePath));
|
|
51467
52030
|
}
|
|
51468
52031
|
|
|
51469
52032
|
/**
|
|
@@ -62356,7 +62919,7 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62356
62919
|
};
|
|
62357
62920
|
},
|
|
62358
62921
|
/**
|
|
62359
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
62922
|
+
* 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.
|
|
62360
62923
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
62361
62924
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
62362
62925
|
* @param {*} [options] Override http request option.
|
|
@@ -62997,7 +63560,7 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
62997
63560
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
62998
63561
|
},
|
|
62999
63562
|
/**
|
|
63000
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
63563
|
+
* 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.
|
|
63001
63564
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63002
63565
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63003
63566
|
* @param {*} [options] Override http request option.
|
|
@@ -63321,7 +63884,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
63321
63884
|
return localVarFp.recordManualPayment(createManualSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
63322
63885
|
},
|
|
63323
63886
|
/**
|
|
63324
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
63887
|
+
* 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.
|
|
63325
63888
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63326
63889
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63327
63890
|
* @param {*} [options] Override http request option.
|
|
@@ -63632,7 +64195,7 @@ export interface PaymentSessionApiInterface {
|
|
|
63632
64195
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
63633
64196
|
|
|
63634
64197
|
/**
|
|
63635
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
64198
|
+
* 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.
|
|
63636
64199
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63637
64200
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63638
64201
|
* @param {*} [options] Override http request option.
|
|
@@ -63977,7 +64540,7 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
63977
64540
|
}
|
|
63978
64541
|
|
|
63979
64542
|
/**
|
|
63980
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
64543
|
+
* 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.
|
|
63981
64544
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63982
64545
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63983
64546
|
* @param {*} [options] Override http request option.
|