@munchi_oy/core 2.15.1 → 2.17.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 +937 -38
- 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 +1237 -40
- package/package.json +15 -13
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -5454,6 +5454,12 @@ export interface CreateVenueGiftCardDto {
|
|
|
5454
5454
|
* @memberof CreateVenueGiftCardDto
|
|
5455
5455
|
*/
|
|
5456
5456
|
'expiresAt'?: string | null;
|
|
5457
|
+
/**
|
|
5458
|
+
* When the card\'s email goes, ISO 8601 date-time, ahead and at most a year from now; it needs buyerEmail and sendEmail not false. Without expiresAt, the validity counts from this moment. Absent: at once.
|
|
5459
|
+
* @type {string}
|
|
5460
|
+
* @memberof CreateVenueGiftCardDto
|
|
5461
|
+
*/
|
|
5462
|
+
'sendAt'?: string;
|
|
5457
5463
|
}
|
|
5458
5464
|
|
|
5459
5465
|
|
|
@@ -9070,7 +9076,8 @@ export const GiftCardEmailKind = {
|
|
|
9070
9076
|
Card: 'CARD',
|
|
9071
9077
|
CardAgain: 'CARD_AGAIN',
|
|
9072
9078
|
Expiry30: 'EXPIRY_30',
|
|
9073
|
-
Expiry7: 'EXPIRY_7'
|
|
9079
|
+
Expiry7: 'EXPIRY_7',
|
|
9080
|
+
BuyerReceipt: 'BUYER_RECEIPT'
|
|
9074
9081
|
} as const;
|
|
9075
9082
|
|
|
9076
9083
|
export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
|
|
@@ -9176,6 +9183,12 @@ export interface GiftCardHistoryEventDto {
|
|
|
9176
9183
|
* @memberof GiftCardHistoryEventDto
|
|
9177
9184
|
*/
|
|
9178
9185
|
'orderId': string | null;
|
|
9186
|
+
/**
|
|
9187
|
+
* The number of that till order, as its receipt and the Orders screen show it; null when there is no order, or its number could not be read
|
|
9188
|
+
* @type {string}
|
|
9189
|
+
* @memberof GiftCardHistoryEventDto
|
|
9190
|
+
*/
|
|
9191
|
+
'orderNumber'?: string | null;
|
|
9179
9192
|
/**
|
|
9180
9193
|
* The address of an EMAILED, EMAIL_FAILED or EMAIL_CHANGED line; null for the others
|
|
9181
9194
|
* @type {string}
|
|
@@ -9188,6 +9201,12 @@ export interface GiftCardHistoryEventDto {
|
|
|
9188
9201
|
* @memberof GiftCardHistoryEventDto
|
|
9189
9202
|
*/
|
|
9190
9203
|
'emailKind': GiftCardEmailKind | null;
|
|
9204
|
+
/**
|
|
9205
|
+
* When the card\'s email is set to go, ISO 8601, on a SCHEDULED line (\"Scheduled for …\"); null for the others
|
|
9206
|
+
* @type {string}
|
|
9207
|
+
* @memberof GiftCardHistoryEventDto
|
|
9208
|
+
*/
|
|
9209
|
+
'scheduledFor': string | null;
|
|
9191
9210
|
/**
|
|
9192
9211
|
* When it happened, ISO 8601
|
|
9193
9212
|
* @type {string}
|
|
@@ -9214,7 +9233,9 @@ export const GiftCardHistoryKind = {
|
|
|
9214
9233
|
SwitchedOn: 'SWITCHED_ON',
|
|
9215
9234
|
Emailed: 'EMAILED',
|
|
9216
9235
|
EmailFailed: 'EMAIL_FAILED',
|
|
9217
|
-
EmailChanged: 'EMAIL_CHANGED'
|
|
9236
|
+
EmailChanged: 'EMAIL_CHANGED',
|
|
9237
|
+
Refunded: 'REFUNDED',
|
|
9238
|
+
Scheduled: 'SCHEDULED'
|
|
9218
9239
|
} as const;
|
|
9219
9240
|
|
|
9220
9241
|
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
@@ -9460,6 +9481,12 @@ export interface GiftCardMovementDto {
|
|
|
9460
9481
|
* @memberof GiftCardMovementDto
|
|
9461
9482
|
*/
|
|
9462
9483
|
'orderId': string | null;
|
|
9484
|
+
/**
|
|
9485
|
+
* The number of that till order, as its receipt and the Orders screen show it; null when there is no order, or its number could not be read
|
|
9486
|
+
* @type {string}
|
|
9487
|
+
* @memberof GiftCardMovementDto
|
|
9488
|
+
*/
|
|
9489
|
+
'orderNumber'?: string | null;
|
|
9463
9490
|
/**
|
|
9464
9491
|
* 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
|
|
9465
9492
|
* @type {boolean}
|
|
@@ -9488,6 +9515,108 @@ export interface GiftCardMovementsDto {
|
|
|
9488
9515
|
*/
|
|
9489
9516
|
'nextCursor': string | null;
|
|
9490
9517
|
}
|
|
9518
|
+
/**
|
|
9519
|
+
*
|
|
9520
|
+
* @export
|
|
9521
|
+
* @interface GiftCardOfferDto
|
|
9522
|
+
*/
|
|
9523
|
+
export interface GiftCardOfferDto {
|
|
9524
|
+
/**
|
|
9525
|
+
* Whether the store sells gift cards online now: its selling switch is on (the default) and a buyer has an amount to choose. Its online store (food ordering) may be off. Card payments online are checked by Vendure, not here.
|
|
9526
|
+
* @type {boolean}
|
|
9527
|
+
* @memberof GiftCardOfferDto
|
|
9528
|
+
*/
|
|
9529
|
+
'sells': boolean;
|
|
9530
|
+
/**
|
|
9531
|
+
* The amounts offered, in cents, ascending: at most 3, the smallest ones when a store saved more before; with anyAmount, buyers also see Other
|
|
9532
|
+
* @type {Array<number>}
|
|
9533
|
+
* @memberof GiftCardOfferDto
|
|
9534
|
+
*/
|
|
9535
|
+
'amounts': Array<number>;
|
|
9536
|
+
/**
|
|
9537
|
+
* Whether a buyer may choose any amount
|
|
9538
|
+
* @type {boolean}
|
|
9539
|
+
* @memberof GiftCardOfferDto
|
|
9540
|
+
*/
|
|
9541
|
+
'anyAmount': boolean;
|
|
9542
|
+
/**
|
|
9543
|
+
* The smallest amount a buyer may choose, in cents
|
|
9544
|
+
* @type {number}
|
|
9545
|
+
* @memberof GiftCardOfferDto
|
|
9546
|
+
*/
|
|
9547
|
+
'minAmount': number;
|
|
9548
|
+
/**
|
|
9549
|
+
* The largest amount a buyer may choose, in cents
|
|
9550
|
+
* @type {number}
|
|
9551
|
+
* @memberof GiftCardOfferDto
|
|
9552
|
+
*/
|
|
9553
|
+
'maxAmount': number;
|
|
9554
|
+
/**
|
|
9555
|
+
*
|
|
9556
|
+
* @type {CurrencyCode}
|
|
9557
|
+
* @memberof GiftCardOfferDto
|
|
9558
|
+
*/
|
|
9559
|
+
'currency': CurrencyCode;
|
|
9560
|
+
/**
|
|
9561
|
+
* The text printed on the card; null when none
|
|
9562
|
+
* @type {string}
|
|
9563
|
+
* @memberof GiftCardOfferDto
|
|
9564
|
+
*/
|
|
9565
|
+
'cardText': string | null;
|
|
9566
|
+
/**
|
|
9567
|
+
* The card\'s picture, an https URL; null when none
|
|
9568
|
+
* @type {string}
|
|
9569
|
+
* @memberof GiftCardOfferDto
|
|
9570
|
+
*/
|
|
9571
|
+
'imageUrl': string | null;
|
|
9572
|
+
/**
|
|
9573
|
+
* The store\'s name
|
|
9574
|
+
* @type {string}
|
|
9575
|
+
* @memberof GiftCardOfferDto
|
|
9576
|
+
*/
|
|
9577
|
+
'storeName': string;
|
|
9578
|
+
/**
|
|
9579
|
+
* How many months a card stays valid from the day its email goes; null when cards never expire
|
|
9580
|
+
* @type {number}
|
|
9581
|
+
* @memberof GiftCardOfferDto
|
|
9582
|
+
*/
|
|
9583
|
+
'validityMonths': number | null;
|
|
9584
|
+
}
|
|
9585
|
+
|
|
9586
|
+
|
|
9587
|
+
/**
|
|
9588
|
+
*
|
|
9589
|
+
* @export
|
|
9590
|
+
* @interface GiftCardPaymentsOnlineDto
|
|
9591
|
+
*/
|
|
9592
|
+
export interface GiftCardPaymentsOnlineDto {
|
|
9593
|
+
/**
|
|
9594
|
+
*
|
|
9595
|
+
* @type {StripeConnectionState}
|
|
9596
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9597
|
+
*/
|
|
9598
|
+
'stripe': StripeConnectionState;
|
|
9599
|
+
/**
|
|
9600
|
+
*
|
|
9601
|
+
* @type {VivaOnlineState}
|
|
9602
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9603
|
+
*/
|
|
9604
|
+
'vivaOnline': VivaOnlineState;
|
|
9605
|
+
/**
|
|
9606
|
+
* Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
|
|
9607
|
+
* @type {boolean}
|
|
9608
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9609
|
+
*/
|
|
9610
|
+
'vivaOnPos': boolean;
|
|
9611
|
+
/**
|
|
9612
|
+
* Whether that POS Viva config names a merchant id: POS Viva payments go through our Viva partner (ISV) account, so its merchant is under it and \"Use my Viva\" can set up online Viva from it
|
|
9613
|
+
* @type {boolean}
|
|
9614
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9615
|
+
*/
|
|
9616
|
+
'vivaIsv': boolean;
|
|
9617
|
+
}
|
|
9618
|
+
|
|
9619
|
+
|
|
9491
9620
|
/**
|
|
9492
9621
|
*
|
|
9493
9622
|
* @export
|
|
@@ -9570,6 +9699,25 @@ export interface GiftCardPeriodTotalsDtoSpent {
|
|
|
9570
9699
|
*/
|
|
9571
9700
|
'orderCount': number;
|
|
9572
9701
|
}
|
|
9702
|
+
/**
|
|
9703
|
+
*
|
|
9704
|
+
* @export
|
|
9705
|
+
* @interface GiftCardPersonDto
|
|
9706
|
+
*/
|
|
9707
|
+
export interface GiftCardPersonDto {
|
|
9708
|
+
/**
|
|
9709
|
+
* The person\'s name, 1 to 120 characters once the spaces around it are dropped. Absent or only spaces: none; the emails then greet nobody by name.
|
|
9710
|
+
* @type {string}
|
|
9711
|
+
* @memberof GiftCardPersonDto
|
|
9712
|
+
*/
|
|
9713
|
+
'name'?: string;
|
|
9714
|
+
/**
|
|
9715
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
9716
|
+
* @type {string}
|
|
9717
|
+
* @memberof GiftCardPersonDto
|
|
9718
|
+
*/
|
|
9719
|
+
'email': string;
|
|
9720
|
+
}
|
|
9573
9721
|
/**
|
|
9574
9722
|
*
|
|
9575
9723
|
* @export
|
|
@@ -9771,12 +9919,76 @@ export interface GiftCardReportDtoSpent {
|
|
|
9771
9919
|
*/
|
|
9772
9920
|
'orderCount': number;
|
|
9773
9921
|
}
|
|
9922
|
+
/**
|
|
9923
|
+
*
|
|
9924
|
+
* @export
|
|
9925
|
+
* @interface GiftCardSellingDto
|
|
9926
|
+
*/
|
|
9927
|
+
export interface GiftCardSellingDto {
|
|
9928
|
+
/**
|
|
9929
|
+
*
|
|
9930
|
+
* @type {GiftCardSellingDtoCardPayments}
|
|
9931
|
+
* @memberof GiftCardSellingDto
|
|
9932
|
+
*/
|
|
9933
|
+
'cardPayments': GiftCardSellingDtoCardPayments;
|
|
9934
|
+
/**
|
|
9935
|
+
* Whether a buyer has an amount to choose: at least one amount, or any amount
|
|
9936
|
+
* @type {boolean}
|
|
9937
|
+
* @memberof GiftCardSellingDto
|
|
9938
|
+
*/
|
|
9939
|
+
'amountsSet': boolean;
|
|
9940
|
+
/**
|
|
9941
|
+
* Whether every step is done, so selling online may be turned on: card payments online (Stripe active, or Viva online), and amounts. The online store (food ordering) need not be on.
|
|
9942
|
+
* @type {boolean}
|
|
9943
|
+
* @memberof GiftCardSellingDto
|
|
9944
|
+
*/
|
|
9945
|
+
'ready': boolean;
|
|
9946
|
+
}
|
|
9947
|
+
/**
|
|
9948
|
+
* What the store can take card payments online with
|
|
9949
|
+
* @export
|
|
9950
|
+
* @interface GiftCardSellingDtoCardPayments
|
|
9951
|
+
*/
|
|
9952
|
+
export interface GiftCardSellingDtoCardPayments {
|
|
9953
|
+
/**
|
|
9954
|
+
*
|
|
9955
|
+
* @type {StripeConnectionState}
|
|
9956
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9957
|
+
*/
|
|
9958
|
+
'stripe': StripeConnectionState;
|
|
9959
|
+
/**
|
|
9960
|
+
*
|
|
9961
|
+
* @type {VivaOnlineState}
|
|
9962
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9963
|
+
*/
|
|
9964
|
+
'vivaOnline': VivaOnlineState;
|
|
9965
|
+
/**
|
|
9966
|
+
* Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
|
|
9967
|
+
* @type {boolean}
|
|
9968
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9969
|
+
*/
|
|
9970
|
+
'vivaOnPos': boolean;
|
|
9971
|
+
/**
|
|
9972
|
+
* Whether that POS Viva config names a merchant id: POS Viva payments go through our Viva partner (ISV) account, so its merchant is under it and \"Use my Viva\" can set up online Viva from it
|
|
9973
|
+
* @type {boolean}
|
|
9974
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9975
|
+
*/
|
|
9976
|
+
'vivaIsv': boolean;
|
|
9977
|
+
}
|
|
9978
|
+
|
|
9979
|
+
|
|
9774
9980
|
/**
|
|
9775
9981
|
*
|
|
9776
9982
|
* @export
|
|
9777
9983
|
* @interface GiftCardSettingsDto
|
|
9778
9984
|
*/
|
|
9779
9985
|
export interface GiftCardSettingsDto {
|
|
9986
|
+
/**
|
|
9987
|
+
* Whether the store has saved its gift card settings: false while the answer is the defaults of a store that never saved them (the dashboard shows its setup then); true after any save
|
|
9988
|
+
* @type {boolean}
|
|
9989
|
+
* @memberof GiftCardSettingsDto
|
|
9990
|
+
*/
|
|
9991
|
+
'saved': boolean;
|
|
9780
9992
|
/**
|
|
9781
9993
|
*
|
|
9782
9994
|
* @type {GiftCardSettingsDtoChannels}
|
|
@@ -9790,7 +10002,7 @@ export interface GiftCardSettingsDto {
|
|
|
9790
10002
|
*/
|
|
9791
10003
|
'availableChannels': Array<GiftCardChannel>;
|
|
9792
10004
|
/**
|
|
9793
|
-
* The amounts offered, in cents, ascending
|
|
10005
|
+
* The amounts offered, in cents, ascending: at most 3, though a store saved with more before keeps them until its next change of amounts
|
|
9794
10006
|
* @type {Array<number>}
|
|
9795
10007
|
* @memberof GiftCardSettingsDto
|
|
9796
10008
|
*/
|
|
@@ -9849,6 +10061,12 @@ export interface GiftCardSettingsDto {
|
|
|
9849
10061
|
* @memberof GiftCardSettingsDto
|
|
9850
10062
|
*/
|
|
9851
10063
|
'emailLanguage': GiftCardLanguage | null;
|
|
10064
|
+
/**
|
|
10065
|
+
* Whether the store\'s switch for selling gift cards online is on; on by default, true for a store that never saved its settings. The store really sells only while GET gift-card-selling also answers ready; turning it back on after it was off is refused until then.
|
|
10066
|
+
* @type {boolean}
|
|
10067
|
+
* @memberof GiftCardSettingsDto
|
|
10068
|
+
*/
|
|
10069
|
+
'sellOnline': boolean;
|
|
9852
10070
|
}
|
|
9853
10071
|
|
|
9854
10072
|
|
|
@@ -10292,6 +10510,70 @@ export interface InitiateNetsTerminalPaymentResponseDto {
|
|
|
10292
10510
|
*/
|
|
10293
10511
|
'connectCloudRequestId': string;
|
|
10294
10512
|
}
|
|
10513
|
+
/**
|
|
10514
|
+
*
|
|
10515
|
+
* @export
|
|
10516
|
+
* @interface InitiateNexiSessionDto
|
|
10517
|
+
*/
|
|
10518
|
+
export interface InitiateNexiSessionDto {
|
|
10519
|
+
/**
|
|
10520
|
+
*
|
|
10521
|
+
* @type {CreateManualSessionDtoDevice}
|
|
10522
|
+
* @memberof InitiateNexiSessionDto
|
|
10523
|
+
*/
|
|
10524
|
+
'device'?: CreateManualSessionDtoDevice | null;
|
|
10525
|
+
/**
|
|
10526
|
+
* The venue\'s orderingBusinessId. Must be the venue of the station calling.
|
|
10527
|
+
* @type {number}
|
|
10528
|
+
* @memberof InitiateNexiSessionDto
|
|
10529
|
+
*/
|
|
10530
|
+
'businessId': number;
|
|
10531
|
+
/**
|
|
10532
|
+
* The POS order this payment is for.
|
|
10533
|
+
* @type {string}
|
|
10534
|
+
* @memberof InitiateNexiSessionDto
|
|
10535
|
+
*/
|
|
10536
|
+
'orderId': string;
|
|
10537
|
+
/**
|
|
10538
|
+
* Amount to charge, in cents, without a tip: a tip the customer adds on the Nexi terminal is recorded from Nexi\'s answer. Must not exceed what the order still owes.
|
|
10539
|
+
* @type {number}
|
|
10540
|
+
* @memberof InitiateNexiSessionDto
|
|
10541
|
+
*/
|
|
10542
|
+
'amount': number;
|
|
10543
|
+
/**
|
|
10544
|
+
*
|
|
10545
|
+
* @type {InitiateNexiSessionDtoSplitContext}
|
|
10546
|
+
* @memberof InitiateNexiSessionDto
|
|
10547
|
+
*/
|
|
10548
|
+
'splitContext'?: InitiateNexiSessionDtoSplitContext;
|
|
10549
|
+
}
|
|
10550
|
+
/**
|
|
10551
|
+
* Split context. Omit for a full-cart payment, or send { mode, partId|seatId } for a split. Must match the order\'s checkoutModel.
|
|
10552
|
+
* @export
|
|
10553
|
+
* @interface InitiateNexiSessionDtoSplitContext
|
|
10554
|
+
*/
|
|
10555
|
+
export interface InitiateNexiSessionDtoSplitContext {
|
|
10556
|
+
/**
|
|
10557
|
+
*
|
|
10558
|
+
* @type {CheckoutModelEnum}
|
|
10559
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10560
|
+
*/
|
|
10561
|
+
'mode': CheckoutModelEnum;
|
|
10562
|
+
/**
|
|
10563
|
+
* Equal-split part id. Required when mode=EQUAL_SPLIT; ignored otherwise.
|
|
10564
|
+
* @type {string}
|
|
10565
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10566
|
+
*/
|
|
10567
|
+
'partId'?: string;
|
|
10568
|
+
/**
|
|
10569
|
+
* Item-split seat id. Required when mode=ITEM_SPLIT; ignored otherwise.
|
|
10570
|
+
* @type {string}
|
|
10571
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10572
|
+
*/
|
|
10573
|
+
'seatId'?: string;
|
|
10574
|
+
}
|
|
10575
|
+
|
|
10576
|
+
|
|
10295
10577
|
/**
|
|
10296
10578
|
*
|
|
10297
10579
|
* @export
|
|
@@ -15622,6 +15904,67 @@ export interface NewKdsStationDto {
|
|
|
15622
15904
|
*/
|
|
15623
15905
|
'categoryIds': Array<string>;
|
|
15624
15906
|
}
|
|
15907
|
+
/**
|
|
15908
|
+
*
|
|
15909
|
+
* @export
|
|
15910
|
+
* @enum {string}
|
|
15911
|
+
*/
|
|
15912
|
+
|
|
15913
|
+
export const NexiPauseReason = {
|
|
15914
|
+
NexiUnheard: 'nexi unheard',
|
|
15915
|
+
NexiPaused: 'nexi paused',
|
|
15916
|
+
ConfirmNotTaken: 'confirm not taken',
|
|
15917
|
+
OrderNotWritten: 'order not written'
|
|
15918
|
+
} as const;
|
|
15919
|
+
|
|
15920
|
+
export type NexiPauseReason = typeof NexiPauseReason[keyof typeof NexiPauseReason];
|
|
15921
|
+
|
|
15922
|
+
|
|
15923
|
+
/**
|
|
15924
|
+
*
|
|
15925
|
+
* @export
|
|
15926
|
+
* @interface NexiWaitRoundDto
|
|
15927
|
+
*/
|
|
15928
|
+
export interface NexiWaitRoundDto {
|
|
15929
|
+
/**
|
|
15930
|
+
* The session\'s id, which Nexi knows as the sale\'s external_id.
|
|
15931
|
+
* @type {string}
|
|
15932
|
+
* @memberof NexiWaitRoundDto
|
|
15933
|
+
*/
|
|
15934
|
+
'sessionId': string;
|
|
15935
|
+
/**
|
|
15936
|
+
* This round\'s number, from 1. It names the Cloud Task, so one round is never queued twice.
|
|
15937
|
+
* @type {number}
|
|
15938
|
+
* @memberof NexiWaitRoundDto
|
|
15939
|
+
*/
|
|
15940
|
+
'round': number;
|
|
15941
|
+
/**
|
|
15942
|
+
* How many rounds in a row before this one were booked after a pause. The pause before the next round doubles with it, up to a minute.
|
|
15943
|
+
* @type {number}
|
|
15944
|
+
* @memberof NexiWaitRoundDto
|
|
15945
|
+
*/
|
|
15946
|
+
'pausedRounds': number;
|
|
15947
|
+
/**
|
|
15948
|
+
*
|
|
15949
|
+
* @type {NexiPauseReason}
|
|
15950
|
+
* @memberof NexiWaitRoundDto
|
|
15951
|
+
*/
|
|
15952
|
+
'pausedFor'?: NexiPauseReason;
|
|
15953
|
+
/**
|
|
15954
|
+
* When the pauses for `pausedFor` began, as an ISO 8601 time; absent when this round was booked at once.
|
|
15955
|
+
* @type {string}
|
|
15956
|
+
* @memberof NexiWaitRoundDto
|
|
15957
|
+
*/
|
|
15958
|
+
'pausedSince'?: string;
|
|
15959
|
+
/**
|
|
15960
|
+
* True once a person was alerted that the pauses for `pausedFor` outlasted their window; the server then keeps asking a minute apart and does not alert again. Absent before.
|
|
15961
|
+
* @type {boolean}
|
|
15962
|
+
* @memberof NexiWaitRoundDto
|
|
15963
|
+
*/
|
|
15964
|
+
'personTold'?: boolean;
|
|
15965
|
+
}
|
|
15966
|
+
|
|
15967
|
+
|
|
15625
15968
|
/**
|
|
15626
15969
|
*
|
|
15627
15970
|
* @export
|
|
@@ -15919,6 +16262,44 @@ export interface OnboardingStoresDto {
|
|
|
15919
16262
|
*/
|
|
15920
16263
|
'stores': Array<OnboardingStoreDto>;
|
|
15921
16264
|
}
|
|
16265
|
+
/**
|
|
16266
|
+
*
|
|
16267
|
+
* @export
|
|
16268
|
+
* @interface OnlineGiftCardRefundDto
|
|
16269
|
+
*/
|
|
16270
|
+
export interface OnlineGiftCardRefundDto {
|
|
16271
|
+
/**
|
|
16272
|
+
* The card\'s id
|
|
16273
|
+
* @type {string}
|
|
16274
|
+
* @memberof OnlineGiftCardRefundDto
|
|
16275
|
+
*/
|
|
16276
|
+
'cardId': string;
|
|
16277
|
+
/**
|
|
16278
|
+
* When the card was blocked for the refund, ISO 8601: the first refund\'s moment on a repeat.
|
|
16279
|
+
* @type {string}
|
|
16280
|
+
* @memberof OnlineGiftCardRefundDto
|
|
16281
|
+
*/
|
|
16282
|
+
'refundedAt': string;
|
|
16283
|
+
}
|
|
16284
|
+
/**
|
|
16285
|
+
*
|
|
16286
|
+
* @export
|
|
16287
|
+
* @interface OnlineGiftCardSaleDto
|
|
16288
|
+
*/
|
|
16289
|
+
export interface OnlineGiftCardSaleDto {
|
|
16290
|
+
/**
|
|
16291
|
+
* The card\'s id
|
|
16292
|
+
* @type {string}
|
|
16293
|
+
* @memberof OnlineGiftCardSaleDto
|
|
16294
|
+
*/
|
|
16295
|
+
'cardId': string;
|
|
16296
|
+
/**
|
|
16297
|
+
* The card\'s 6-digit code. Never shown to the buyer of a gift: only the person it is for gets it, by email.
|
|
16298
|
+
* @type {string}
|
|
16299
|
+
* @memberof OnlineGiftCardSaleDto
|
|
16300
|
+
*/
|
|
16301
|
+
'code': string;
|
|
16302
|
+
}
|
|
15922
16303
|
/**
|
|
15923
16304
|
*
|
|
15924
16305
|
* @export
|
|
@@ -23685,6 +24066,19 @@ export interface PosUpdateOrderDto {
|
|
|
23685
24066
|
}
|
|
23686
24067
|
|
|
23687
24068
|
|
|
24069
|
+
/**
|
|
24070
|
+
*
|
|
24071
|
+
* @export
|
|
24072
|
+
* @interface PosVivaMerchantDto
|
|
24073
|
+
*/
|
|
24074
|
+
export interface PosVivaMerchantDto {
|
|
24075
|
+
/**
|
|
24076
|
+
* The Viva merchant id of the store\'s active POS Viva config; null when its POS takes no Viva payments or the config names no merchant. Never a key.
|
|
24077
|
+
* @type {string}
|
|
24078
|
+
* @memberof PosVivaMerchantDto
|
|
24079
|
+
*/
|
|
24080
|
+
'merchantId': string | null;
|
|
24081
|
+
}
|
|
23688
24082
|
/**
|
|
23689
24083
|
*
|
|
23690
24084
|
* @export
|
|
@@ -27255,6 +27649,25 @@ export const RefundMode = {
|
|
|
27255
27649
|
export type RefundMode = typeof RefundMode[keyof typeof RefundMode];
|
|
27256
27650
|
|
|
27257
27651
|
|
|
27652
|
+
/**
|
|
27653
|
+
*
|
|
27654
|
+
* @export
|
|
27655
|
+
* @interface RefundOnlineGiftCardSaleDto
|
|
27656
|
+
*/
|
|
27657
|
+
export interface RefundOnlineGiftCardSaleDto {
|
|
27658
|
+
/**
|
|
27659
|
+
* The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
|
|
27660
|
+
* @type {string}
|
|
27661
|
+
* @memberof RefundOnlineGiftCardSaleDto
|
|
27662
|
+
*/
|
|
27663
|
+
'orderCode': string;
|
|
27664
|
+
/**
|
|
27665
|
+
* The id of the Vendure order line that holds the gift card, 1 to 64 characters.
|
|
27666
|
+
* @type {string}
|
|
27667
|
+
* @memberof RefundOnlineGiftCardSaleDto
|
|
27668
|
+
*/
|
|
27669
|
+
'orderLineId': string;
|
|
27670
|
+
}
|
|
27258
27671
|
/**
|
|
27259
27672
|
*
|
|
27260
27673
|
* @export
|
|
@@ -31758,6 +32171,113 @@ export interface SearchUserInfoResponseDtoLinksValue {
|
|
|
31758
32171
|
*/
|
|
31759
32172
|
'method'?: string;
|
|
31760
32173
|
}
|
|
32174
|
+
/**
|
|
32175
|
+
*
|
|
32176
|
+
* @export
|
|
32177
|
+
* @interface SellGiftCardOnlineDto
|
|
32178
|
+
*/
|
|
32179
|
+
export interface SellGiftCardOnlineDto {
|
|
32180
|
+
/**
|
|
32181
|
+
* The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
|
|
32182
|
+
* @type {string}
|
|
32183
|
+
* @memberof SellGiftCardOnlineDto
|
|
32184
|
+
*/
|
|
32185
|
+
'orderCode': string;
|
|
32186
|
+
/**
|
|
32187
|
+
* The id of the Vendure order line that holds the gift card, 1 to 64 characters.
|
|
32188
|
+
* @type {string}
|
|
32189
|
+
* @memberof SellGiftCardOnlineDto
|
|
32190
|
+
*/
|
|
32191
|
+
'orderLineId': string;
|
|
32192
|
+
/**
|
|
32193
|
+
* The store that sold it: its orderingBusinessId, the Vendure seller of the storefront channel the order was placed on.
|
|
32194
|
+
* @type {number}
|
|
32195
|
+
* @memberof SellGiftCardOnlineDto
|
|
32196
|
+
*/
|
|
32197
|
+
'orderingBusinessId': number;
|
|
32198
|
+
/**
|
|
32199
|
+
* The card\'s balance, in cents, 100 to 100000: what the line was paid. It must be one of the store\'s amounts, or within its smallest and largest when it takes any amount.
|
|
32200
|
+
* @type {number}
|
|
32201
|
+
* @memberof SellGiftCardOnlineDto
|
|
32202
|
+
*/
|
|
32203
|
+
'amount': number;
|
|
32204
|
+
/**
|
|
32205
|
+
*
|
|
32206
|
+
* @type {CurrencyCode}
|
|
32207
|
+
* @memberof SellGiftCardOnlineDto
|
|
32208
|
+
*/
|
|
32209
|
+
'currency': CurrencyCode;
|
|
32210
|
+
/**
|
|
32211
|
+
*
|
|
32212
|
+
* @type {SellGiftCardOnlineDtoBuyer}
|
|
32213
|
+
* @memberof SellGiftCardOnlineDto
|
|
32214
|
+
*/
|
|
32215
|
+
'buyer': SellGiftCardOnlineDtoBuyer;
|
|
32216
|
+
/**
|
|
32217
|
+
*
|
|
32218
|
+
* @type {SellGiftCardOnlineDtoRecipient}
|
|
32219
|
+
* @memberof SellGiftCardOnlineDto
|
|
32220
|
+
*/
|
|
32221
|
+
'recipient'?: SellGiftCardOnlineDtoRecipient;
|
|
32222
|
+
/**
|
|
32223
|
+
* The buyer\'s message, shown in the card\'s email, 1 to 300 characters. Absent: none.
|
|
32224
|
+
* @type {string}
|
|
32225
|
+
* @memberof SellGiftCardOnlineDto
|
|
32226
|
+
*/
|
|
32227
|
+
'message'?: string;
|
|
32228
|
+
/**
|
|
32229
|
+
*
|
|
32230
|
+
* @type {GiftCardLanguage}
|
|
32231
|
+
* @memberof SellGiftCardOnlineDto
|
|
32232
|
+
*/
|
|
32233
|
+
'language'?: GiftCardLanguage;
|
|
32234
|
+
/**
|
|
32235
|
+
* When the card\'s email goes to the person it is for, ISO 8601 date-time, at most a year from now. Absent, or already past when the payment settles: at once. The card\'s validity counts from this moment.
|
|
32236
|
+
* @type {string}
|
|
32237
|
+
* @memberof SellGiftCardOnlineDto
|
|
32238
|
+
*/
|
|
32239
|
+
'sendAt'?: string;
|
|
32240
|
+
}
|
|
32241
|
+
|
|
32242
|
+
|
|
32243
|
+
/**
|
|
32244
|
+
* Who bought the card: its receipt goes to this email, and the card too when it is for them.
|
|
32245
|
+
* @export
|
|
32246
|
+
* @interface SellGiftCardOnlineDtoBuyer
|
|
32247
|
+
*/
|
|
32248
|
+
export interface SellGiftCardOnlineDtoBuyer {
|
|
32249
|
+
/**
|
|
32250
|
+
* The person\'s name, 1 to 120 characters once the spaces around it are dropped. Absent or only spaces: none; the emails then greet nobody by name.
|
|
32251
|
+
* @type {string}
|
|
32252
|
+
* @memberof SellGiftCardOnlineDtoBuyer
|
|
32253
|
+
*/
|
|
32254
|
+
'name'?: string;
|
|
32255
|
+
/**
|
|
32256
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
32257
|
+
* @type {string}
|
|
32258
|
+
* @memberof SellGiftCardOnlineDtoBuyer
|
|
32259
|
+
*/
|
|
32260
|
+
'email': string;
|
|
32261
|
+
}
|
|
32262
|
+
/**
|
|
32263
|
+
* Whom the card is for, when it is a gift: the card\'s email and its reminders go to this email, and the buyer gets a receipt without the code. Absent, or the buyer\'s own email: the card is the buyer\'s, and only the card\'s email goes, to the buyer.
|
|
32264
|
+
* @export
|
|
32265
|
+
* @interface SellGiftCardOnlineDtoRecipient
|
|
32266
|
+
*/
|
|
32267
|
+
export interface SellGiftCardOnlineDtoRecipient {
|
|
32268
|
+
/**
|
|
32269
|
+
* The person\'s name, 1 to 120 characters once the spaces around it are dropped. Absent or only spaces: none; the emails then greet nobody by name.
|
|
32270
|
+
* @type {string}
|
|
32271
|
+
* @memberof SellGiftCardOnlineDtoRecipient
|
|
32272
|
+
*/
|
|
32273
|
+
'name'?: string;
|
|
32274
|
+
/**
|
|
32275
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
32276
|
+
* @type {string}
|
|
32277
|
+
* @memberof SellGiftCardOnlineDtoRecipient
|
|
32278
|
+
*/
|
|
32279
|
+
'email': string;
|
|
32280
|
+
}
|
|
31761
32281
|
/**
|
|
31762
32282
|
*
|
|
31763
32283
|
* @export
|
|
@@ -32876,6 +33396,21 @@ export interface StripeConfigResponseDto {
|
|
|
32876
33396
|
*/
|
|
32877
33397
|
'locationId': string | null;
|
|
32878
33398
|
}
|
|
33399
|
+
/**
|
|
33400
|
+
*
|
|
33401
|
+
* @export
|
|
33402
|
+
* @enum {string}
|
|
33403
|
+
*/
|
|
33404
|
+
|
|
33405
|
+
export const StripeConnectionState = {
|
|
33406
|
+
Active: 'active',
|
|
33407
|
+
Pending: 'pending',
|
|
33408
|
+
None: 'none'
|
|
33409
|
+
} as const;
|
|
33410
|
+
|
|
33411
|
+
export type StripeConnectionState = typeof StripeConnectionState[keyof typeof StripeConnectionState];
|
|
33412
|
+
|
|
33413
|
+
|
|
32879
33414
|
/**
|
|
32880
33415
|
*
|
|
32881
33416
|
* @export
|
|
@@ -37104,7 +37639,7 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
37104
37639
|
*/
|
|
37105
37640
|
'channels'?: UpdateGiftCardSettingsDtoChannels;
|
|
37106
37641
|
/**
|
|
37107
|
-
* The amounts offered, in cents: 1 to
|
|
37642
|
+
* The amounts offered, in cents: 1 to 3 different amounts, each 100 to 100000 (with anyAmount, buyers also see Other). Stored ascending. Absent: unchanged.
|
|
37108
37643
|
* @type {Array<number>}
|
|
37109
37644
|
* @memberof UpdateGiftCardSettingsDto
|
|
37110
37645
|
*/
|
|
@@ -37163,6 +37698,12 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
37163
37698
|
* @memberof UpdateGiftCardSettingsDto
|
|
37164
37699
|
*/
|
|
37165
37700
|
'emailLanguage'?: GiftCardLanguage | null;
|
|
37701
|
+
/**
|
|
37702
|
+
* Whether the store\'s switch for selling gift cards online is on. Turning it from false to true is refused 400 while GET gift-card-selling does not answer ready (card payments online, amounts; the online store need not be on); true while it is already on, and false, are always taken. Absent: unchanged.
|
|
37703
|
+
* @type {boolean}
|
|
37704
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
37705
|
+
*/
|
|
37706
|
+
'sellOnline'?: boolean;
|
|
37166
37707
|
}
|
|
37167
37708
|
|
|
37168
37709
|
|
|
@@ -37672,7 +38213,7 @@ export interface UpdateTableStatusDto {
|
|
|
37672
38213
|
*/
|
|
37673
38214
|
export interface UpdateVenueGiftCardDto {
|
|
37674
38215
|
/**
|
|
37675
|
-
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
38216
|
+
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. On an online gift it is the buyer\'s, where only the receipt went: the gift\'s own address is recipientEmail. Nothing is sent. Absent: unchanged.
|
|
37676
38217
|
* @type {string}
|
|
37677
38218
|
* @memberof UpdateVenueGiftCardDto
|
|
37678
38219
|
*/
|
|
@@ -37683,6 +38224,24 @@ export interface UpdateVenueGiftCardDto {
|
|
|
37683
38224
|
* @memberof UpdateVenueGiftCardDto
|
|
37684
38225
|
*/
|
|
37685
38226
|
'language'?: GiftCardLanguage | null;
|
|
38227
|
+
/**
|
|
38228
|
+
* When the card\'s email goes, ISO 8601 date-time, ahead and at most a year from now, or null to send it now; only while the card\'s email waits for its first try. Absent: unchanged.
|
|
38229
|
+
* @type {string}
|
|
38230
|
+
* @memberof UpdateVenueGiftCardDto
|
|
38231
|
+
*/
|
|
38232
|
+
'sendAt'?: string | null;
|
|
38233
|
+
/**
|
|
38234
|
+
* Corrects where an online gift\'s card email and reminders go, at most 254 characters once the spaces around it are dropped; recorded as EMAIL_CHANGED, and Send again uses it. Only on an online gift (a card answered with a recipientEmail): any other card is refused 400. Nothing is sent. Absent: unchanged.
|
|
38235
|
+
* @type {string}
|
|
38236
|
+
* @memberof UpdateVenueGiftCardDto
|
|
38237
|
+
*/
|
|
38238
|
+
'recipientEmail'?: string;
|
|
38239
|
+
/**
|
|
38240
|
+
* Corrects the name an online gift greets, 1 to 120 characters once the spaces around it are dropped. Only on an online gift: any other card is refused 400. Absent: unchanged.
|
|
38241
|
+
* @type {string}
|
|
38242
|
+
* @memberof UpdateVenueGiftCardDto
|
|
38243
|
+
*/
|
|
38244
|
+
'recipientName'?: string;
|
|
37686
38245
|
}
|
|
37687
38246
|
|
|
37688
38247
|
|
|
@@ -38950,6 +39509,24 @@ export interface VenueGiftCardDetailDto {
|
|
|
38950
39509
|
* @memberof VenueGiftCardDetailDto
|
|
38951
39510
|
*/
|
|
38952
39511
|
'language': GiftCardLanguage | null;
|
|
39512
|
+
/**
|
|
39513
|
+
* When the card\'s email is set to go, ISO 8601: a day the dashboard or the online buyer chose; null for at once
|
|
39514
|
+
* @type {string}
|
|
39515
|
+
* @memberof VenueGiftCardDetailDto
|
|
39516
|
+
*/
|
|
39517
|
+
'sendAt': string | null;
|
|
39518
|
+
/**
|
|
39519
|
+
* Whom an online gift is for: its card email and reminders go to recipientEmail, while buyerEmail is the buyer\'s, who got the receipt; null for every other card
|
|
39520
|
+
* @type {string}
|
|
39521
|
+
* @memberof VenueGiftCardDetailDto
|
|
39522
|
+
*/
|
|
39523
|
+
'recipientName': string | null;
|
|
39524
|
+
/**
|
|
39525
|
+
* Where an online gift\'s card email and reminders go; null for every other card, whose emails go to buyerEmail
|
|
39526
|
+
* @type {string}
|
|
39527
|
+
* @memberof VenueGiftCardDetailDto
|
|
39528
|
+
*/
|
|
39529
|
+
'recipientEmail': string | null;
|
|
38953
39530
|
/**
|
|
38954
39531
|
*
|
|
38955
39532
|
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
@@ -40393,6 +40970,20 @@ export const VivaEventId = {
|
|
|
40393
40970
|
export type VivaEventId = typeof VivaEventId[keyof typeof VivaEventId];
|
|
40394
40971
|
|
|
40395
40972
|
|
|
40973
|
+
/**
|
|
40974
|
+
*
|
|
40975
|
+
* @export
|
|
40976
|
+
* @enum {string}
|
|
40977
|
+
*/
|
|
40978
|
+
|
|
40979
|
+
export const VivaOnlineState = {
|
|
40980
|
+
Active: 'active',
|
|
40981
|
+
None: 'none'
|
|
40982
|
+
} as const;
|
|
40983
|
+
|
|
40984
|
+
export type VivaOnlineState = typeof VivaOnlineState[keyof typeof VivaOnlineState];
|
|
40985
|
+
|
|
40986
|
+
|
|
40396
40987
|
/**
|
|
40397
40988
|
*
|
|
40398
40989
|
* @export
|
|
@@ -51440,11 +52031,11 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51440
52031
|
};
|
|
51441
52032
|
},
|
|
51442
52033
|
/**
|
|
51443
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
52034
|
+
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now (from sendAt when one is sent), or never. With sendAt its email is queued for that moment instead of now. The till channel does not need to be on. Who made it is stored.
|
|
51444
52035
|
* @summary Make a gift card by hand, given for free
|
|
51445
52036
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51446
52037
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51447
|
-
* @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.
|
|
52038
|
+
* @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, sendAt, 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.
|
|
51448
52039
|
* @param {*} [options] Override http request option.
|
|
51449
52040
|
* @throws {RequiredError}
|
|
51450
52041
|
*/
|
|
@@ -51620,6 +52211,44 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51620
52211
|
|
|
51621
52212
|
|
|
51622
52213
|
|
|
52214
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
52215
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
52216
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
52217
|
+
|
|
52218
|
+
return {
|
|
52219
|
+
url: toPathString(localVarUrlObj),
|
|
52220
|
+
options: localVarRequestOptions,
|
|
52221
|
+
};
|
|
52222
|
+
},
|
|
52223
|
+
/**
|
|
52224
|
+
* Each step before the store may sell gift cards online, its online store (food ordering) on or off: card payments online (its Stripe connection and Viva in its online store, read from Vendure; Viva at its POS from its POS config) and amounts to choose; ready when every step is done. Two statements and two reads of Vendure at once; nothing is written.
|
|
52225
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
52226
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52227
|
+
* @param {*} [options] Override http request option.
|
|
52228
|
+
* @throws {RequiredError}
|
|
52229
|
+
*/
|
|
52230
|
+
getVenueGiftCardSelling: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
52231
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
52232
|
+
assertParamExists('getVenueGiftCardSelling', 'businessId', businessId)
|
|
52233
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-card-selling`
|
|
52234
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
52235
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
52236
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
52237
|
+
let baseOptions;
|
|
52238
|
+
if (configuration) {
|
|
52239
|
+
baseOptions = configuration.baseOptions;
|
|
52240
|
+
}
|
|
52241
|
+
|
|
52242
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
52243
|
+
const localVarHeaderParameter = {} as any;
|
|
52244
|
+
const localVarQueryParameter = {} as any;
|
|
52245
|
+
|
|
52246
|
+
// authentication JWT-auth required
|
|
52247
|
+
// http bearer authentication required
|
|
52248
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
52249
|
+
|
|
52250
|
+
|
|
52251
|
+
|
|
51623
52252
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51624
52253
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51625
52254
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -51748,7 +52377,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51748
52377
|
* 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.
|
|
51749
52378
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
51750
52379
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51751
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
52380
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive; or, when the search is a phone number (only digits, spaces, +, -, ( ) and dots, at least 6 digits), a buyer\'s phone number whose digits contain it. The search drops its spaces and dashes, a leading 00, and a leading 0; the stored number is read by its digits without a leading 0, however it was typed. A search with +358 or 00358 finds the Finnish number, and one with another country code finds a number stored with that code. \"040 123 4567\", \"+358401234567\" and \"401234567\" all find +358 / 40 123 4567. Absent: every card.
|
|
51752
52381
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51753
52382
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51754
52383
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -51808,7 +52437,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51808
52437
|
};
|
|
51809
52438
|
},
|
|
51810
52439
|
/**
|
|
51811
|
-
* 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.
|
|
52440
|
+
* 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; a card blocked because its online order was refunded stays blocked.
|
|
51812
52441
|
* @summary Unblock a gift card
|
|
51813
52442
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51814
52443
|
* @param {string} cardId The card\'s id
|
|
@@ -51850,8 +52479,8 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51850
52479
|
};
|
|
51851
52480
|
},
|
|
51852
52481
|
/**
|
|
51853
|
-
*
|
|
51854
|
-
* @summary Correct a gift card\'s email address
|
|
52482
|
+
* Changes the fields sent and keeps the others. buyerEmail saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED, and nothing is sent: send the card again to email the new address. sendAt moves the card\'s email while it waits for its first try: to that moment, or now with null; the card\'s sendAt and its history\'s SCHEDULED line follow.
|
|
52483
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
51855
52484
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51856
52485
|
* @param {string} cardId The card\'s id
|
|
51857
52486
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -51898,7 +52527,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51898
52527
|
};
|
|
51899
52528
|
},
|
|
51900
52529
|
/**
|
|
51901
|
-
* 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.
|
|
52530
|
+
* 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). The selling switch is on by default. Turning it from false to true is taken only while GET gift-card-selling answers ready, read again here; the amounts may always be cleared, and the offer then does not sell. The online store (food ordering) is never read. A change of other fields is never refused for the switch. Of two changes at once the last to commit wins whole.
|
|
51902
52531
|
* @summary Change a store\'s gift card settings
|
|
51903
52532
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51904
52533
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -51977,11 +52606,11 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51977
52606
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51978
52607
|
},
|
|
51979
52608
|
/**
|
|
51980
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
52609
|
+
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now (from sendAt when one is sent), or never. With sendAt its email is queued for that moment instead of now. The till channel does not need to be on. Who made it is stored.
|
|
51981
52610
|
* @summary Make a gift card by hand, given for free
|
|
51982
52611
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51983
52612
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51984
|
-
* @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.
|
|
52613
|
+
* @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, sendAt, 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.
|
|
51985
52614
|
* @param {*} [options] Override http request option.
|
|
51986
52615
|
* @throws {RequiredError}
|
|
51987
52616
|
*/
|
|
@@ -52027,6 +52656,17 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
52027
52656
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardReport(businessId, from, to, options);
|
|
52028
52657
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52029
52658
|
},
|
|
52659
|
+
/**
|
|
52660
|
+
* Each step before the store may sell gift cards online, its online store (food ordering) on or off: card payments online (its Stripe connection and Viva in its online store, read from Vendure; Viva at its POS from its POS config) and amounts to choose; ready when every step is done. Two statements and two reads of Vendure at once; nothing is written.
|
|
52661
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
52662
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52663
|
+
* @param {*} [options] Override http request option.
|
|
52664
|
+
* @throws {RequiredError}
|
|
52665
|
+
*/
|
|
52666
|
+
async getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSellingDto>> {
|
|
52667
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardSelling(businessId, options);
|
|
52668
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52669
|
+
},
|
|
52030
52670
|
/**
|
|
52031
52671
|
* Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
|
|
52032
52672
|
* @summary Read a store\'s gift card settings
|
|
@@ -52060,7 +52700,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
52060
52700
|
* 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.
|
|
52061
52701
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
52062
52702
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52063
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
52703
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive; or, when the search is a phone number (only digits, spaces, +, -, ( ) and dots, at least 6 digits), a buyer\'s phone number whose digits contain it. The search drops its spaces and dashes, a leading 00, and a leading 0; the stored number is read by its digits without a leading 0, however it was typed. A search with +358 or 00358 finds the Finnish number, and one with another country code finds a number stored with that code. \"040 123 4567\", \"+358401234567\" and \"401234567\" all find +358 / 40 123 4567. Absent: every card.
|
|
52064
52704
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
52065
52705
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
52066
52706
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -52073,7 +52713,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
52073
52713
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52074
52714
|
},
|
|
52075
52715
|
/**
|
|
52076
|
-
* 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.
|
|
52716
|
+
* 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; a card blocked because its online order was refunded stays blocked.
|
|
52077
52717
|
* @summary Unblock a gift card
|
|
52078
52718
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52079
52719
|
* @param {string} cardId The card\'s id
|
|
@@ -52085,8 +52725,8 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
52085
52725
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52086
52726
|
},
|
|
52087
52727
|
/**
|
|
52088
|
-
*
|
|
52089
|
-
* @summary Correct a gift card\'s email address
|
|
52728
|
+
* Changes the fields sent and keeps the others. buyerEmail saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED, and nothing is sent: send the card again to email the new address. sendAt moves the card\'s email while it waits for its first try: to that moment, or now with null; the card\'s sendAt and its history\'s SCHEDULED line follow.
|
|
52729
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
52090
52730
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52091
52731
|
* @param {string} cardId The card\'s id
|
|
52092
52732
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -52098,7 +52738,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
52098
52738
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
52099
52739
|
},
|
|
52100
52740
|
/**
|
|
52101
|
-
* 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.
|
|
52741
|
+
* 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). The selling switch is on by default. Turning it from false to true is taken only while GET gift-card-selling answers ready, read again here; the amounts may always be cleared, and the offer then does not sell. The online store (food ordering) is never read. A change of other fields is never refused for the switch. Of two changes at once the last to commit wins whole.
|
|
52102
52742
|
* @summary Change a store\'s gift card settings
|
|
52103
52743
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52104
52744
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -52143,11 +52783,11 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
52143
52783
|
return localVarFp.blockVenueGiftCard(businessId, cardId, blockVenueGiftCardDto, options).then((request) => request(axios, basePath));
|
|
52144
52784
|
},
|
|
52145
52785
|
/**
|
|
52146
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
52786
|
+
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now (from sendAt when one is sent), or never. With sendAt its email is queued for that moment instead of now. The till channel does not need to be on. Who made it is stored.
|
|
52147
52787
|
* @summary Make a gift card by hand, given for free
|
|
52148
52788
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52149
52789
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
52150
|
-
* @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.
|
|
52790
|
+
* @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, sendAt, 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.
|
|
52151
52791
|
* @param {*} [options] Override http request option.
|
|
52152
52792
|
* @throws {RequiredError}
|
|
52153
52793
|
*/
|
|
@@ -52189,6 +52829,16 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
52189
52829
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: any): AxiosPromise<GiftCardReportDto> {
|
|
52190
52830
|
return localVarFp.getVenueGiftCardReport(businessId, from, to, options).then((request) => request(axios, basePath));
|
|
52191
52831
|
},
|
|
52832
|
+
/**
|
|
52833
|
+
* Each step before the store may sell gift cards online, its online store (food ordering) on or off: card payments online (its Stripe connection and Viva in its online store, read from Vendure; Viva at its POS from its POS config) and amounts to choose; ready when every step is done. Two statements and two reads of Vendure at once; nothing is written.
|
|
52834
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
52835
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52836
|
+
* @param {*} [options] Override http request option.
|
|
52837
|
+
* @throws {RequiredError}
|
|
52838
|
+
*/
|
|
52839
|
+
getVenueGiftCardSelling(businessId: number, options?: any): AxiosPromise<GiftCardSellingDto> {
|
|
52840
|
+
return localVarFp.getVenueGiftCardSelling(businessId, options).then((request) => request(axios, basePath));
|
|
52841
|
+
},
|
|
52192
52842
|
/**
|
|
52193
52843
|
* Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
|
|
52194
52844
|
* @summary Read a store\'s gift card settings
|
|
@@ -52220,7 +52870,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
52220
52870
|
* 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.
|
|
52221
52871
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
52222
52872
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52223
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
52873
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive; or, when the search is a phone number (only digits, spaces, +, -, ( ) and dots, at least 6 digits), a buyer\'s phone number whose digits contain it. The search drops its spaces and dashes, a leading 00, and a leading 0; the stored number is read by its digits without a leading 0, however it was typed. A search with +358 or 00358 finds the Finnish number, and one with another country code finds a number stored with that code. \"040 123 4567\", \"+358401234567\" and \"401234567\" all find +358 / 40 123 4567. Absent: every card.
|
|
52224
52874
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
52225
52875
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
52226
52876
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -52232,7 +52882,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
52232
52882
|
return localVarFp.listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options).then((request) => request(axios, basePath));
|
|
52233
52883
|
},
|
|
52234
52884
|
/**
|
|
52235
|
-
* 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.
|
|
52885
|
+
* 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; a card blocked because its online order was refunded stays blocked.
|
|
52236
52886
|
* @summary Unblock a gift card
|
|
52237
52887
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52238
52888
|
* @param {string} cardId The card\'s id
|
|
@@ -52243,8 +52893,8 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
52243
52893
|
return localVarFp.unblockVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
52244
52894
|
},
|
|
52245
52895
|
/**
|
|
52246
|
-
*
|
|
52247
|
-
* @summary Correct a gift card\'s email address
|
|
52896
|
+
* Changes the fields sent and keeps the others. buyerEmail saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED, and nothing is sent: send the card again to email the new address. sendAt moves the card\'s email while it waits for its first try: to that moment, or now with null; the card\'s sendAt and its history\'s SCHEDULED line follow.
|
|
52897
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
52248
52898
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52249
52899
|
* @param {string} cardId The card\'s id
|
|
52250
52900
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -52255,7 +52905,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
52255
52905
|
return localVarFp.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(axios, basePath));
|
|
52256
52906
|
},
|
|
52257
52907
|
/**
|
|
52258
|
-
* 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.
|
|
52908
|
+
* 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). The selling switch is on by default. Turning it from false to true is taken only while GET gift-card-selling answers ready, read again here; the amounts may always be cleared, and the offer then does not sell. The online store (food ordering) is never read. A change of other fields is never refused for the switch. Of two changes at once the last to commit wins whole.
|
|
52259
52909
|
* @summary Change a store\'s gift card settings
|
|
52260
52910
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52261
52911
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -52298,11 +52948,11 @@ export interface GiftCardsApiInterface {
|
|
|
52298
52948
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52299
52949
|
|
|
52300
52950
|
/**
|
|
52301
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
52951
|
+
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now (from sendAt when one is sent), or never. With sendAt its email is queued for that moment instead of now. The till channel does not need to be on. Who made it is stored.
|
|
52302
52952
|
* @summary Make a gift card by hand, given for free
|
|
52303
52953
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52304
52954
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
52305
|
-
* @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.
|
|
52955
|
+
* @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, sendAt, 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.
|
|
52306
52956
|
* @param {*} [options] Override http request option.
|
|
52307
52957
|
* @throws {RequiredError}
|
|
52308
52958
|
* @memberof GiftCardsApiInterface
|
|
@@ -52344,6 +52994,16 @@ export interface GiftCardsApiInterface {
|
|
|
52344
52994
|
*/
|
|
52345
52995
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<GiftCardReportDto>;
|
|
52346
52996
|
|
|
52997
|
+
/**
|
|
52998
|
+
* Each step before the store may sell gift cards online, its online store (food ordering) on or off: card payments online (its Stripe connection and Viva in its online store, read from Vendure; Viva at its POS from its POS config) and amounts to choose; ready when every step is done. Two statements and two reads of Vendure at once; nothing is written.
|
|
52999
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
53000
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
53001
|
+
* @param {*} [options] Override http request option.
|
|
53002
|
+
* @throws {RequiredError}
|
|
53003
|
+
* @memberof GiftCardsApiInterface
|
|
53004
|
+
*/
|
|
53005
|
+
getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSellingDto>;
|
|
53006
|
+
|
|
52347
53007
|
/**
|
|
52348
53008
|
* Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
|
|
52349
53009
|
* @summary Read a store\'s gift card settings
|
|
@@ -52375,7 +53035,7 @@ export interface GiftCardsApiInterface {
|
|
|
52375
53035
|
* 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.
|
|
52376
53036
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
52377
53037
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52378
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
53038
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive; or, when the search is a phone number (only digits, spaces, +, -, ( ) and dots, at least 6 digits), a buyer\'s phone number whose digits contain it. The search drops its spaces and dashes, a leading 00, and a leading 0; the stored number is read by its digits without a leading 0, however it was typed. A search with +358 or 00358 finds the Finnish number, and one with another country code finds a number stored with that code. \"040 123 4567\", \"+358401234567\" and \"401234567\" all find +358 / 40 123 4567. Absent: every card.
|
|
52379
53039
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
52380
53040
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
52381
53041
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -52387,7 +53047,7 @@ export interface GiftCardsApiInterface {
|
|
|
52387
53047
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
52388
53048
|
|
|
52389
53049
|
/**
|
|
52390
|
-
* 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.
|
|
53050
|
+
* 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; a card blocked because its online order was refunded stays blocked.
|
|
52391
53051
|
* @summary Unblock a gift card
|
|
52392
53052
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52393
53053
|
* @param {string} cardId The card\'s id
|
|
@@ -52398,8 +53058,8 @@ export interface GiftCardsApiInterface {
|
|
|
52398
53058
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52399
53059
|
|
|
52400
53060
|
/**
|
|
52401
|
-
*
|
|
52402
|
-
* @summary Correct a gift card\'s email address
|
|
53061
|
+
* Changes the fields sent and keeps the others. buyerEmail saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED, and nothing is sent: send the card again to email the new address. sendAt moves the card\'s email while it waits for its first try: to that moment, or now with null; the card\'s sendAt and its history\'s SCHEDULED line follow.
|
|
53062
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
52403
53063
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52404
53064
|
* @param {string} cardId The card\'s id
|
|
52405
53065
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -52410,7 +53070,7 @@ export interface GiftCardsApiInterface {
|
|
|
52410
53070
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52411
53071
|
|
|
52412
53072
|
/**
|
|
52413
|
-
* 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.
|
|
53073
|
+
* 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). The selling switch is on by default. Turning it from false to true is taken only while GET gift-card-selling answers ready, read again here; the amounts may always be cleared, and the offer then does not sell. The online store (food ordering) is never read. A change of other fields is never refused for the switch. Of two changes at once the last to commit wins whole.
|
|
52414
53074
|
* @summary Change a store\'s gift card settings
|
|
52415
53075
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52416
53076
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -52457,11 +53117,11 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52457
53117
|
}
|
|
52458
53118
|
|
|
52459
53119
|
/**
|
|
52460
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
53120
|
+
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now (from sendAt when one is sent), or never. With sendAt its email is queued for that moment instead of now. The till channel does not need to be on. Who made it is stored.
|
|
52461
53121
|
* @summary Make a gift card by hand, given for free
|
|
52462
53122
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52463
53123
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
52464
|
-
* @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.
|
|
53124
|
+
* @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, sendAt, 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.
|
|
52465
53125
|
* @param {*} [options] Override http request option.
|
|
52466
53126
|
* @throws {RequiredError}
|
|
52467
53127
|
* @memberof GiftCardsApi
|
|
@@ -52511,6 +53171,18 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52511
53171
|
return GiftCardsApiFp(this.configuration).getVenueGiftCardReport(businessId, from, to, options).then((request) => request(this.axios, this.basePath));
|
|
52512
53172
|
}
|
|
52513
53173
|
|
|
53174
|
+
/**
|
|
53175
|
+
* Each step before the store may sell gift cards online, its online store (food ordering) on or off: card payments online (its Stripe connection and Viva in its online store, read from Vendure; Viva at its POS from its POS config) and amounts to choose; ready when every step is done. Two statements and two reads of Vendure at once; nothing is written.
|
|
53176
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
53177
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
53178
|
+
* @param {*} [options] Override http request option.
|
|
53179
|
+
* @throws {RequiredError}
|
|
53180
|
+
* @memberof GiftCardsApi
|
|
53181
|
+
*/
|
|
53182
|
+
public getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig) {
|
|
53183
|
+
return GiftCardsApiFp(this.configuration).getVenueGiftCardSelling(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
53184
|
+
}
|
|
53185
|
+
|
|
52514
53186
|
/**
|
|
52515
53187
|
* Where its cards can be spent, the amounts offered, how long a card stays valid, and its look; the defaults when the store never saved them (till on, online store off). availableChannels lists the store\'s own channels that are on and can take cards. Two statements; nothing is written.
|
|
52516
53188
|
* @summary Read a store\'s gift card settings
|
|
@@ -52546,7 +53218,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52546
53218
|
* 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.
|
|
52547
53219
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
52548
53220
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52549
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
53221
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive; or, when the search is a phone number (only digits, spaces, +, -, ( ) and dots, at least 6 digits), a buyer\'s phone number whose digits contain it. The search drops its spaces and dashes, a leading 00, and a leading 0; the stored number is read by its digits without a leading 0, however it was typed. A search with +358 or 00358 finds the Finnish number, and one with another country code finds a number stored with that code. \"040 123 4567\", \"+358401234567\" and \"401234567\" all find +358 / 40 123 4567. Absent: every card.
|
|
52550
53222
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
52551
53223
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
52552
53224
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -52560,7 +53232,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52560
53232
|
}
|
|
52561
53233
|
|
|
52562
53234
|
/**
|
|
52563
|
-
* 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.
|
|
53235
|
+
* 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; a card blocked because its online order was refunded stays blocked.
|
|
52564
53236
|
* @summary Unblock a gift card
|
|
52565
53237
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52566
53238
|
* @param {string} cardId The card\'s id
|
|
@@ -52573,8 +53245,8 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52573
53245
|
}
|
|
52574
53246
|
|
|
52575
53247
|
/**
|
|
52576
|
-
*
|
|
52577
|
-
* @summary Correct a gift card\'s email address
|
|
53248
|
+
* Changes the fields sent and keeps the others. buyerEmail saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED, and nothing is sent: send the card again to email the new address. sendAt moves the card\'s email while it waits for its first try: to that moment, or now with null; the card\'s sendAt and its history\'s SCHEDULED line follow.
|
|
53249
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
52578
53250
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52579
53251
|
* @param {string} cardId The card\'s id
|
|
52580
53252
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -52587,7 +53259,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52587
53259
|
}
|
|
52588
53260
|
|
|
52589
53261
|
/**
|
|
52590
|
-
* 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.
|
|
53262
|
+
* 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). The selling switch is on by default. Turning it from false to true is taken only while GET gift-card-selling answers ready, read again here; the amounts may always be cleared, and the offer then does not sell. The online store (food ordering) is never read. A change of other fields is never refused for the switch. Of two changes at once the last to commit wins whole.
|
|
52591
53263
|
* @summary Change a store\'s gift card settings
|
|
52592
53264
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
52593
53265
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -53911,6 +54583,364 @@ export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
|
53911
54583
|
}
|
|
53912
54584
|
|
|
53913
54585
|
|
|
54586
|
+
/**
|
|
54587
|
+
* InternalGiftCardsApi - axios parameter creator
|
|
54588
|
+
* @export
|
|
54589
|
+
*/
|
|
54590
|
+
export const InternalGiftCardsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
54591
|
+
return {
|
|
54592
|
+
/**
|
|
54593
|
+
* Vendure reads it to show the online store\'s gift card page and to check an order before it is placed: whether the store sells gift cards online now (its switch, on by default, and an amount to choose; its online store may be off), its amounts, look, currency, name and validity. Card payments online are Vendure\'s own check, not read here. One statement; nothing is written; no secret.
|
|
54594
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
54595
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54596
|
+
* @param {*} [options] Override http request option.
|
|
54597
|
+
* @throws {RequiredError}
|
|
54598
|
+
*/
|
|
54599
|
+
getVenueGiftCardOffer: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54600
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
54601
|
+
assertParamExists('getVenueGiftCardOffer', 'businessId', businessId)
|
|
54602
|
+
const localVarPath = `/api/v2/internal/gift-cards/offers/{businessId}`
|
|
54603
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
54604
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54605
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54606
|
+
let baseOptions;
|
|
54607
|
+
if (configuration) {
|
|
54608
|
+
baseOptions = configuration.baseOptions;
|
|
54609
|
+
}
|
|
54610
|
+
|
|
54611
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
54612
|
+
const localVarHeaderParameter = {} as any;
|
|
54613
|
+
const localVarQueryParameter = {} as any;
|
|
54614
|
+
|
|
54615
|
+
|
|
54616
|
+
|
|
54617
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54618
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54619
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54620
|
+
|
|
54621
|
+
return {
|
|
54622
|
+
url: toPathString(localVarUrlObj),
|
|
54623
|
+
options: localVarRequestOptions,
|
|
54624
|
+
};
|
|
54625
|
+
},
|
|
54626
|
+
/**
|
|
54627
|
+
* Vendure reads it for \"Use my Viva\", to set up the online store\'s Viva from the merchant the store already has: the merchant id of the store\'s active POS Viva config, null when there is none. Only the merchant id, never a key. One statement; nothing is written.
|
|
54628
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
54629
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54630
|
+
* @param {*} [options] Override http request option.
|
|
54631
|
+
* @throws {RequiredError}
|
|
54632
|
+
*/
|
|
54633
|
+
getVenuePosVivaMerchant: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54634
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
54635
|
+
assertParamExists('getVenuePosVivaMerchant', 'businessId', businessId)
|
|
54636
|
+
const localVarPath = `/api/v2/internal/gift-cards/pos-viva/{businessId}`
|
|
54637
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
54638
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54639
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54640
|
+
let baseOptions;
|
|
54641
|
+
if (configuration) {
|
|
54642
|
+
baseOptions = configuration.baseOptions;
|
|
54643
|
+
}
|
|
54644
|
+
|
|
54645
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
54646
|
+
const localVarHeaderParameter = {} as any;
|
|
54647
|
+
const localVarQueryParameter = {} as any;
|
|
54648
|
+
|
|
54649
|
+
|
|
54650
|
+
|
|
54651
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54652
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54653
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54654
|
+
|
|
54655
|
+
return {
|
|
54656
|
+
url: toPathString(localVarUrlObj),
|
|
54657
|
+
options: localVarRequestOptions,
|
|
54658
|
+
};
|
|
54659
|
+
},
|
|
54660
|
+
/**
|
|
54661
|
+
* Vendure calls it before it refunds a gift card order. The order line\'s card is blocked as refunded (its history shows REFUNDED, its block reason Refunded) only while nothing was spent of it, so it can no longer pay or be unblocked and none of its emails go any more. A repeat answers the first refund. A card of which anything was spent is refused 409: the card stays valid and the order must not be refunded.
|
|
54662
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
54663
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
54664
|
+
* @param {*} [options] Override http request option.
|
|
54665
|
+
* @throws {RequiredError}
|
|
54666
|
+
*/
|
|
54667
|
+
refundOnlineGiftCardSale: async (refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54668
|
+
// verify required parameter 'refundOnlineGiftCardSaleDto' is not null or undefined
|
|
54669
|
+
assertParamExists('refundOnlineGiftCardSale', 'refundOnlineGiftCardSaleDto', refundOnlineGiftCardSaleDto)
|
|
54670
|
+
const localVarPath = `/api/v2/internal/gift-cards/online-sale/refund`;
|
|
54671
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54672
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54673
|
+
let baseOptions;
|
|
54674
|
+
if (configuration) {
|
|
54675
|
+
baseOptions = configuration.baseOptions;
|
|
54676
|
+
}
|
|
54677
|
+
|
|
54678
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
54679
|
+
const localVarHeaderParameter = {} as any;
|
|
54680
|
+
const localVarQueryParameter = {} as any;
|
|
54681
|
+
|
|
54682
|
+
|
|
54683
|
+
|
|
54684
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
54685
|
+
|
|
54686
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54687
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54688
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54689
|
+
localVarRequestOptions.data = serializeDataIfNeeded(refundOnlineGiftCardSaleDto, localVarRequestOptions, configuration)
|
|
54690
|
+
|
|
54691
|
+
return {
|
|
54692
|
+
url: toPathString(localVarUrlObj),
|
|
54693
|
+
options: localVarRequestOptions,
|
|
54694
|
+
};
|
|
54695
|
+
},
|
|
54696
|
+
/**
|
|
54697
|
+
* Vendure calls it once the payment of a gift card order settles. The card is ACTIVE at once, sold online at orderingBusinessId and owned by its merchant when it has one, else by it; it expires the settings\' validityMonths after its email goes. Its email goes to recipient.email at sendAt (or at once); for a gift, the buyer gets a receipt without the code at once. Idempotent per orderCode and orderLineId: a repeat, also two at once, answers the card the line made, whatever the settings are now. Retry on no answer or 5xx; a 4xx is final: refund the order, after online-sale/refund when the 409 says a card exists.
|
|
54698
|
+
* @summary Make the gift card an online order line paid for
|
|
54699
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
54700
|
+
* @param {*} [options] Override http request option.
|
|
54701
|
+
* @throws {RequiredError}
|
|
54702
|
+
*/
|
|
54703
|
+
sellGiftCardOnline: async (sellGiftCardOnlineDto: SellGiftCardOnlineDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54704
|
+
// verify required parameter 'sellGiftCardOnlineDto' is not null or undefined
|
|
54705
|
+
assertParamExists('sellGiftCardOnline', 'sellGiftCardOnlineDto', sellGiftCardOnlineDto)
|
|
54706
|
+
const localVarPath = `/api/v2/internal/gift-cards/online-sale`;
|
|
54707
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54708
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54709
|
+
let baseOptions;
|
|
54710
|
+
if (configuration) {
|
|
54711
|
+
baseOptions = configuration.baseOptions;
|
|
54712
|
+
}
|
|
54713
|
+
|
|
54714
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
54715
|
+
const localVarHeaderParameter = {} as any;
|
|
54716
|
+
const localVarQueryParameter = {} as any;
|
|
54717
|
+
|
|
54718
|
+
|
|
54719
|
+
|
|
54720
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
54721
|
+
|
|
54722
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54723
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54724
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54725
|
+
localVarRequestOptions.data = serializeDataIfNeeded(sellGiftCardOnlineDto, localVarRequestOptions, configuration)
|
|
54726
|
+
|
|
54727
|
+
return {
|
|
54728
|
+
url: toPathString(localVarUrlObj),
|
|
54729
|
+
options: localVarRequestOptions,
|
|
54730
|
+
};
|
|
54731
|
+
},
|
|
54732
|
+
}
|
|
54733
|
+
};
|
|
54734
|
+
|
|
54735
|
+
/**
|
|
54736
|
+
* InternalGiftCardsApi - functional programming interface
|
|
54737
|
+
* @export
|
|
54738
|
+
*/
|
|
54739
|
+
export const InternalGiftCardsApiFp = function(configuration?: Configuration) {
|
|
54740
|
+
const localVarAxiosParamCreator = InternalGiftCardsApiAxiosParamCreator(configuration)
|
|
54741
|
+
return {
|
|
54742
|
+
/**
|
|
54743
|
+
* Vendure reads it to show the online store\'s gift card page and to check an order before it is placed: whether the store sells gift cards online now (its switch, on by default, and an amount to choose; its online store may be off), its amounts, look, currency, name and validity. Card payments online are Vendure\'s own check, not read here. One statement; nothing is written; no secret.
|
|
54744
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
54745
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54746
|
+
* @param {*} [options] Override http request option.
|
|
54747
|
+
* @throws {RequiredError}
|
|
54748
|
+
*/
|
|
54749
|
+
async getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardOfferDto>> {
|
|
54750
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardOffer(businessId, options);
|
|
54751
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54752
|
+
},
|
|
54753
|
+
/**
|
|
54754
|
+
* Vendure reads it for \"Use my Viva\", to set up the online store\'s Viva from the merchant the store already has: the merchant id of the store\'s active POS Viva config, null when there is none. Only the merchant id, never a key. One statement; nothing is written.
|
|
54755
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
54756
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54757
|
+
* @param {*} [options] Override http request option.
|
|
54758
|
+
* @throws {RequiredError}
|
|
54759
|
+
*/
|
|
54760
|
+
async getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosVivaMerchantDto>> {
|
|
54761
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenuePosVivaMerchant(businessId, options);
|
|
54762
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54763
|
+
},
|
|
54764
|
+
/**
|
|
54765
|
+
* Vendure calls it before it refunds a gift card order. The order line\'s card is blocked as refunded (its history shows REFUNDED, its block reason Refunded) only while nothing was spent of it, so it can no longer pay or be unblocked and none of its emails go any more. A repeat answers the first refund. A card of which anything was spent is refused 409: the card stays valid and the order must not be refunded.
|
|
54766
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
54767
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
54768
|
+
* @param {*} [options] Override http request option.
|
|
54769
|
+
* @throws {RequiredError}
|
|
54770
|
+
*/
|
|
54771
|
+
async refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardRefundDto>> {
|
|
54772
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto, options);
|
|
54773
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54774
|
+
},
|
|
54775
|
+
/**
|
|
54776
|
+
* Vendure calls it once the payment of a gift card order settles. The card is ACTIVE at once, sold online at orderingBusinessId and owned by its merchant when it has one, else by it; it expires the settings\' validityMonths after its email goes. Its email goes to recipient.email at sendAt (or at once); for a gift, the buyer gets a receipt without the code at once. Idempotent per orderCode and orderLineId: a repeat, also two at once, answers the card the line made, whatever the settings are now. Retry on no answer or 5xx; a 4xx is final: refund the order, after online-sale/refund when the 409 says a card exists.
|
|
54777
|
+
* @summary Make the gift card an online order line paid for
|
|
54778
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
54779
|
+
* @param {*} [options] Override http request option.
|
|
54780
|
+
* @throws {RequiredError}
|
|
54781
|
+
*/
|
|
54782
|
+
async sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardSaleDto>> {
|
|
54783
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.sellGiftCardOnline(sellGiftCardOnlineDto, options);
|
|
54784
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54785
|
+
},
|
|
54786
|
+
}
|
|
54787
|
+
};
|
|
54788
|
+
|
|
54789
|
+
/**
|
|
54790
|
+
* InternalGiftCardsApi - factory interface
|
|
54791
|
+
* @export
|
|
54792
|
+
*/
|
|
54793
|
+
export const InternalGiftCardsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
54794
|
+
const localVarFp = InternalGiftCardsApiFp(configuration)
|
|
54795
|
+
return {
|
|
54796
|
+
/**
|
|
54797
|
+
* Vendure reads it to show the online store\'s gift card page and to check an order before it is placed: whether the store sells gift cards online now (its switch, on by default, and an amount to choose; its online store may be off), its amounts, look, currency, name and validity. Card payments online are Vendure\'s own check, not read here. One statement; nothing is written; no secret.
|
|
54798
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
54799
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54800
|
+
* @param {*} [options] Override http request option.
|
|
54801
|
+
* @throws {RequiredError}
|
|
54802
|
+
*/
|
|
54803
|
+
getVenueGiftCardOffer(businessId: number, options?: any): AxiosPromise<GiftCardOfferDto> {
|
|
54804
|
+
return localVarFp.getVenueGiftCardOffer(businessId, options).then((request) => request(axios, basePath));
|
|
54805
|
+
},
|
|
54806
|
+
/**
|
|
54807
|
+
* Vendure reads it for \"Use my Viva\", to set up the online store\'s Viva from the merchant the store already has: the merchant id of the store\'s active POS Viva config, null when there is none. Only the merchant id, never a key. One statement; nothing is written.
|
|
54808
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
54809
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54810
|
+
* @param {*} [options] Override http request option.
|
|
54811
|
+
* @throws {RequiredError}
|
|
54812
|
+
*/
|
|
54813
|
+
getVenuePosVivaMerchant(businessId: number, options?: any): AxiosPromise<PosVivaMerchantDto> {
|
|
54814
|
+
return localVarFp.getVenuePosVivaMerchant(businessId, options).then((request) => request(axios, basePath));
|
|
54815
|
+
},
|
|
54816
|
+
/**
|
|
54817
|
+
* Vendure calls it before it refunds a gift card order. The order line\'s card is blocked as refunded (its history shows REFUNDED, its block reason Refunded) only while nothing was spent of it, so it can no longer pay or be unblocked and none of its emails go any more. A repeat answers the first refund. A card of which anything was spent is refused 409: the card stays valid and the order must not be refunded.
|
|
54818
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
54819
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
54820
|
+
* @param {*} [options] Override http request option.
|
|
54821
|
+
* @throws {RequiredError}
|
|
54822
|
+
*/
|
|
54823
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: any): AxiosPromise<OnlineGiftCardRefundDto> {
|
|
54824
|
+
return localVarFp.refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto, options).then((request) => request(axios, basePath));
|
|
54825
|
+
},
|
|
54826
|
+
/**
|
|
54827
|
+
* Vendure calls it once the payment of a gift card order settles. The card is ACTIVE at once, sold online at orderingBusinessId and owned by its merchant when it has one, else by it; it expires the settings\' validityMonths after its email goes. Its email goes to recipient.email at sendAt (or at once); for a gift, the buyer gets a receipt without the code at once. Idempotent per orderCode and orderLineId: a repeat, also two at once, answers the card the line made, whatever the settings are now. Retry on no answer or 5xx; a 4xx is final: refund the order, after online-sale/refund when the 409 says a card exists.
|
|
54828
|
+
* @summary Make the gift card an online order line paid for
|
|
54829
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
54830
|
+
* @param {*} [options] Override http request option.
|
|
54831
|
+
* @throws {RequiredError}
|
|
54832
|
+
*/
|
|
54833
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: any): AxiosPromise<OnlineGiftCardSaleDto> {
|
|
54834
|
+
return localVarFp.sellGiftCardOnline(sellGiftCardOnlineDto, options).then((request) => request(axios, basePath));
|
|
54835
|
+
},
|
|
54836
|
+
};
|
|
54837
|
+
};
|
|
54838
|
+
|
|
54839
|
+
/**
|
|
54840
|
+
* InternalGiftCardsApi - interface
|
|
54841
|
+
* @export
|
|
54842
|
+
* @interface InternalGiftCardsApi
|
|
54843
|
+
*/
|
|
54844
|
+
export interface InternalGiftCardsApiInterface {
|
|
54845
|
+
/**
|
|
54846
|
+
* Vendure reads it to show the online store\'s gift card page and to check an order before it is placed: whether the store sells gift cards online now (its switch, on by default, and an amount to choose; its online store may be off), its amounts, look, currency, name and validity. Card payments online are Vendure\'s own check, not read here. One statement; nothing is written; no secret.
|
|
54847
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
54848
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54849
|
+
* @param {*} [options] Override http request option.
|
|
54850
|
+
* @throws {RequiredError}
|
|
54851
|
+
* @memberof InternalGiftCardsApiInterface
|
|
54852
|
+
*/
|
|
54853
|
+
getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardOfferDto>;
|
|
54854
|
+
|
|
54855
|
+
/**
|
|
54856
|
+
* Vendure reads it for \"Use my Viva\", to set up the online store\'s Viva from the merchant the store already has: the merchant id of the store\'s active POS Viva config, null when there is none. Only the merchant id, never a key. One statement; nothing is written.
|
|
54857
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
54858
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54859
|
+
* @param {*} [options] Override http request option.
|
|
54860
|
+
* @throws {RequiredError}
|
|
54861
|
+
* @memberof InternalGiftCardsApiInterface
|
|
54862
|
+
*/
|
|
54863
|
+
getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosVivaMerchantDto>;
|
|
54864
|
+
|
|
54865
|
+
/**
|
|
54866
|
+
* Vendure calls it before it refunds a gift card order. The order line\'s card is blocked as refunded (its history shows REFUNDED, its block reason Refunded) only while nothing was spent of it, so it can no longer pay or be unblocked and none of its emails go any more. A repeat answers the first refund. A card of which anything was spent is refused 409: the card stays valid and the order must not be refunded.
|
|
54867
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
54868
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
54869
|
+
* @param {*} [options] Override http request option.
|
|
54870
|
+
* @throws {RequiredError}
|
|
54871
|
+
* @memberof InternalGiftCardsApiInterface
|
|
54872
|
+
*/
|
|
54873
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardRefundDto>;
|
|
54874
|
+
|
|
54875
|
+
/**
|
|
54876
|
+
* Vendure calls it once the payment of a gift card order settles. The card is ACTIVE at once, sold online at orderingBusinessId and owned by its merchant when it has one, else by it; it expires the settings\' validityMonths after its email goes. Its email goes to recipient.email at sendAt (or at once); for a gift, the buyer gets a receipt without the code at once. Idempotent per orderCode and orderLineId: a repeat, also two at once, answers the card the line made, whatever the settings are now. Retry on no answer or 5xx; a 4xx is final: refund the order, after online-sale/refund when the 409 says a card exists.
|
|
54877
|
+
* @summary Make the gift card an online order line paid for
|
|
54878
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
54879
|
+
* @param {*} [options] Override http request option.
|
|
54880
|
+
* @throws {RequiredError}
|
|
54881
|
+
* @memberof InternalGiftCardsApiInterface
|
|
54882
|
+
*/
|
|
54883
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardSaleDto>;
|
|
54884
|
+
|
|
54885
|
+
}
|
|
54886
|
+
|
|
54887
|
+
/**
|
|
54888
|
+
* InternalGiftCardsApi - object-oriented interface
|
|
54889
|
+
* @export
|
|
54890
|
+
* @class InternalGiftCardsApi
|
|
54891
|
+
* @extends {BaseAPI}
|
|
54892
|
+
*/
|
|
54893
|
+
export class InternalGiftCardsApi extends BaseAPI implements InternalGiftCardsApiInterface {
|
|
54894
|
+
/**
|
|
54895
|
+
* Vendure reads it to show the online store\'s gift card page and to check an order before it is placed: whether the store sells gift cards online now (its switch, on by default, and an amount to choose; its online store may be off), its amounts, look, currency, name and validity. Card payments online are Vendure\'s own check, not read here. One statement; nothing is written; no secret.
|
|
54896
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
54897
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54898
|
+
* @param {*} [options] Override http request option.
|
|
54899
|
+
* @throws {RequiredError}
|
|
54900
|
+
* @memberof InternalGiftCardsApi
|
|
54901
|
+
*/
|
|
54902
|
+
public getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig) {
|
|
54903
|
+
return InternalGiftCardsApiFp(this.configuration).getVenueGiftCardOffer(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
54904
|
+
}
|
|
54905
|
+
|
|
54906
|
+
/**
|
|
54907
|
+
* Vendure reads it for \"Use my Viva\", to set up the online store\'s Viva from the merchant the store already has: the merchant id of the store\'s active POS Viva config, null when there is none. Only the merchant id, never a key. One statement; nothing is written.
|
|
54908
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
54909
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
54910
|
+
* @param {*} [options] Override http request option.
|
|
54911
|
+
* @throws {RequiredError}
|
|
54912
|
+
* @memberof InternalGiftCardsApi
|
|
54913
|
+
*/
|
|
54914
|
+
public getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig) {
|
|
54915
|
+
return InternalGiftCardsApiFp(this.configuration).getVenuePosVivaMerchant(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
54916
|
+
}
|
|
54917
|
+
|
|
54918
|
+
/**
|
|
54919
|
+
* Vendure calls it before it refunds a gift card order. The order line\'s card is blocked as refunded (its history shows REFUNDED, its block reason Refunded) only while nothing was spent of it, so it can no longer pay or be unblocked and none of its emails go any more. A repeat answers the first refund. A card of which anything was spent is refused 409: the card stays valid and the order must not be refunded.
|
|
54920
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
54921
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
54922
|
+
* @param {*} [options] Override http request option.
|
|
54923
|
+
* @throws {RequiredError}
|
|
54924
|
+
* @memberof InternalGiftCardsApi
|
|
54925
|
+
*/
|
|
54926
|
+
public refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig) {
|
|
54927
|
+
return InternalGiftCardsApiFp(this.configuration).refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto, options).then((request) => request(this.axios, this.basePath));
|
|
54928
|
+
}
|
|
54929
|
+
|
|
54930
|
+
/**
|
|
54931
|
+
* Vendure calls it once the payment of a gift card order settles. The card is ACTIVE at once, sold online at orderingBusinessId and owned by its merchant when it has one, else by it; it expires the settings\' validityMonths after its email goes. Its email goes to recipient.email at sendAt (or at once); for a gift, the buyer gets a receipt without the code at once. Idempotent per orderCode and orderLineId: a repeat, also two at once, answers the card the line made, whatever the settings are now. Retry on no answer or 5xx; a 4xx is final: refund the order, after online-sale/refund when the 409 says a card exists.
|
|
54932
|
+
* @summary Make the gift card an online order line paid for
|
|
54933
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
54934
|
+
* @param {*} [options] Override http request option.
|
|
54935
|
+
* @throws {RequiredError}
|
|
54936
|
+
* @memberof InternalGiftCardsApi
|
|
54937
|
+
*/
|
|
54938
|
+
public sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig) {
|
|
54939
|
+
return InternalGiftCardsApiFp(this.configuration).sellGiftCardOnline(sellGiftCardOnlineDto, options).then((request) => request(this.axios, this.basePath));
|
|
54940
|
+
}
|
|
54941
|
+
}
|
|
54942
|
+
|
|
54943
|
+
|
|
53914
54944
|
/**
|
|
53915
54945
|
* InvoiceCompaniesApi - axios parameter creator
|
|
53916
54946
|
* @export
|
|
@@ -63084,6 +64114,47 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
63084
64114
|
options: localVarRequestOptions,
|
|
63085
64115
|
};
|
|
63086
64116
|
},
|
|
64117
|
+
/**
|
|
64118
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
64119
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
64120
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
64121
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
64122
|
+
* @param {*} [options] Override http request option.
|
|
64123
|
+
* @throws {RequiredError}
|
|
64124
|
+
*/
|
|
64125
|
+
initiateNexiSession: async (initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
64126
|
+
// verify required parameter 'initiateNexiSessionDto' is not null or undefined
|
|
64127
|
+
assertParamExists('initiateNexiSession', 'initiateNexiSessionDto', initiateNexiSessionDto)
|
|
64128
|
+
const localVarPath = `/api/v1/payment-session/nexi/initiate`;
|
|
64129
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
64130
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
64131
|
+
let baseOptions;
|
|
64132
|
+
if (configuration) {
|
|
64133
|
+
baseOptions = configuration.baseOptions;
|
|
64134
|
+
}
|
|
64135
|
+
|
|
64136
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
64137
|
+
const localVarHeaderParameter = {} as any;
|
|
64138
|
+
const localVarQueryParameter = {} as any;
|
|
64139
|
+
|
|
64140
|
+
if (xIdempotencyKey != null) {
|
|
64141
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
64142
|
+
}
|
|
64143
|
+
|
|
64144
|
+
|
|
64145
|
+
|
|
64146
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
64147
|
+
|
|
64148
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
64149
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
64150
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
64151
|
+
localVarRequestOptions.data = serializeDataIfNeeded(initiateNexiSessionDto, localVarRequestOptions, configuration)
|
|
64152
|
+
|
|
64153
|
+
return {
|
|
64154
|
+
url: toPathString(localVarUrlObj),
|
|
64155
|
+
options: localVarRequestOptions,
|
|
64156
|
+
};
|
|
64157
|
+
},
|
|
63087
64158
|
/**
|
|
63088
64159
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
63089
64160
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -63889,6 +64960,42 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
63889
64960
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
63890
64961
|
localVarRequestOptions.data = serializeDataIfNeeded(voidManualSessionDto, localVarRequestOptions, configuration)
|
|
63891
64962
|
|
|
64963
|
+
return {
|
|
64964
|
+
url: toPathString(localVarUrlObj),
|
|
64965
|
+
options: localVarRequestOptions,
|
|
64966
|
+
};
|
|
64967
|
+
},
|
|
64968
|
+
/**
|
|
64969
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
64970
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
64971
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
64972
|
+
* @param {*} [options] Override http request option.
|
|
64973
|
+
* @throws {RequiredError}
|
|
64974
|
+
*/
|
|
64975
|
+
waitForNexiSession: async (nexiWaitRoundDto: NexiWaitRoundDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
64976
|
+
// verify required parameter 'nexiWaitRoundDto' is not null or undefined
|
|
64977
|
+
assertParamExists('waitForNexiSession', 'nexiWaitRoundDto', nexiWaitRoundDto)
|
|
64978
|
+
const localVarPath = `/api/v1/payment-session/nexi/wait`;
|
|
64979
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
64980
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
64981
|
+
let baseOptions;
|
|
64982
|
+
if (configuration) {
|
|
64983
|
+
baseOptions = configuration.baseOptions;
|
|
64984
|
+
}
|
|
64985
|
+
|
|
64986
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
64987
|
+
const localVarHeaderParameter = {} as any;
|
|
64988
|
+
const localVarQueryParameter = {} as any;
|
|
64989
|
+
|
|
64990
|
+
|
|
64991
|
+
|
|
64992
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
64993
|
+
|
|
64994
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
64995
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
64996
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
64997
|
+
localVarRequestOptions.data = serializeDataIfNeeded(nexiWaitRoundDto, localVarRequestOptions, configuration)
|
|
64998
|
+
|
|
63892
64999
|
return {
|
|
63893
65000
|
url: toPathString(localVarUrlObj),
|
|
63894
65001
|
options: localVarRequestOptions,
|
|
@@ -63989,6 +65096,18 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
63989
65096
|
const localVarAxiosArgs = await localVarAxiosParamCreator.initiateNetsSession(initiateNetsSessionDto, xIdempotencyKey, options);
|
|
63990
65097
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
63991
65098
|
},
|
|
65099
|
+
/**
|
|
65100
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
65101
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
65102
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
65103
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
65104
|
+
* @param {*} [options] Override http request option.
|
|
65105
|
+
* @throws {RequiredError}
|
|
65106
|
+
*/
|
|
65107
|
+
async initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>> {
|
|
65108
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.initiateNexiSession(initiateNexiSessionDto, xIdempotencyKey, options);
|
|
65109
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65110
|
+
},
|
|
63992
65111
|
/**
|
|
63993
65112
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
63994
65113
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -64235,6 +65354,17 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
64235
65354
|
const localVarAxiosArgs = await localVarAxiosParamCreator.voidManualPayment(voidManualSessionDto, options);
|
|
64236
65355
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
64237
65356
|
},
|
|
65357
|
+
/**
|
|
65358
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
65359
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
65360
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
65361
|
+
* @param {*} [options] Override http request option.
|
|
65362
|
+
* @throws {RequiredError}
|
|
65363
|
+
*/
|
|
65364
|
+
async waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
65365
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.waitForNexiSession(nexiWaitRoundDto, options);
|
|
65366
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
65367
|
+
},
|
|
64238
65368
|
}
|
|
64239
65369
|
};
|
|
64240
65370
|
|
|
@@ -64323,6 +65453,17 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
64323
65453
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateNetsSessionResponseDto> {
|
|
64324
65454
|
return localVarFp.initiateNetsSession(initiateNetsSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
64325
65455
|
},
|
|
65456
|
+
/**
|
|
65457
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
65458
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
65459
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
65460
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
65461
|
+
* @param {*} [options] Override http request option.
|
|
65462
|
+
* @throws {RequiredError}
|
|
65463
|
+
*/
|
|
65464
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto> {
|
|
65465
|
+
return localVarFp.initiateNexiSession(initiateNexiSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
65466
|
+
},
|
|
64326
65467
|
/**
|
|
64327
65468
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
64328
65469
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -64547,6 +65688,16 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
64547
65688
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: any): AxiosPromise<RecordManualPaymentResultDto> {
|
|
64548
65689
|
return localVarFp.voidManualPayment(voidManualSessionDto, options).then((request) => request(axios, basePath));
|
|
64549
65690
|
},
|
|
65691
|
+
/**
|
|
65692
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
65693
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
65694
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
65695
|
+
* @param {*} [options] Override http request option.
|
|
65696
|
+
* @throws {RequiredError}
|
|
65697
|
+
*/
|
|
65698
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: any): AxiosPromise<void> {
|
|
65699
|
+
return localVarFp.waitForNexiSession(nexiWaitRoundDto, options).then((request) => request(axios, basePath));
|
|
65700
|
+
},
|
|
64550
65701
|
};
|
|
64551
65702
|
};
|
|
64552
65703
|
|
|
@@ -64634,6 +65785,17 @@ export interface PaymentSessionApiInterface {
|
|
|
64634
65785
|
*/
|
|
64635
65786
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
64636
65787
|
|
|
65788
|
+
/**
|
|
65789
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
65790
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
65791
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
65792
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
65793
|
+
* @param {*} [options] Override http request option.
|
|
65794
|
+
* @throws {RequiredError}
|
|
65795
|
+
* @memberof PaymentSessionApiInterface
|
|
65796
|
+
*/
|
|
65797
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
65798
|
+
|
|
64637
65799
|
/**
|
|
64638
65800
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
64639
65801
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -64858,6 +66020,16 @@ export interface PaymentSessionApiInterface {
|
|
|
64858
66020
|
*/
|
|
64859
66021
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
64860
66022
|
|
|
66023
|
+
/**
|
|
66024
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
66025
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
66026
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
66027
|
+
* @param {*} [options] Override http request option.
|
|
66028
|
+
* @throws {RequiredError}
|
|
66029
|
+
* @memberof PaymentSessionApiInterface
|
|
66030
|
+
*/
|
|
66031
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
66032
|
+
|
|
64861
66033
|
}
|
|
64862
66034
|
|
|
64863
66035
|
/**
|
|
@@ -64959,6 +66131,19 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
64959
66131
|
return PaymentSessionApiFp(this.configuration).initiateNetsSession(initiateNetsSessionDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
64960
66132
|
}
|
|
64961
66133
|
|
|
66134
|
+
/**
|
|
66135
|
+
* Saves the session first, its sessionId being the sale\'s external_id at Nexi, then asks Nexi to start the sale and answer at once. The customer then taps on the terminal; Cloud Tasks ask Nexi until the sale ends. When Nexi answers paid, in this order: Nexi\'s answer is kept on the session (the status unchanged), Nexi is confirmed (which takes the money), the session is stored SUCCESS, the payment is written on the order (reconciliation, which announces the settled order on the venue\'s channel), and only then SUCCESS is announced on the session\'s channel. So nothing tells the till \'paid\' before the money is taken. If the order cannot take the payment, it is asked again for up to 5 minutes, then the charge goes to the till as its own order and a person is alerted. Follow the session on the Ably channel nexi.<channel>.requests.<sessionId> (event payment:status-changed) or with GET /payment-session/:clientToken, which shows SUCCESS from the moment Nexi took the money. A tip or surcharge typed on the terminal is recorded from Nexi\'s answer. A Nexi sale is refused by :clientToken/cancel; Nexi\'s own cancel comes with a later route. Idempotent by the X-Idempotency-Key header within the venue: a repeat answers the session it started without asking Nexi again. A signed-in ticket only: the service key is not accepted (R27).
|
|
66136
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
66137
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
66138
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
66139
|
+
* @param {*} [options] Override http request option.
|
|
66140
|
+
* @throws {RequiredError}
|
|
66141
|
+
* @memberof PaymentSessionApi
|
|
66142
|
+
*/
|
|
66143
|
+
public initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
66144
|
+
return PaymentSessionApiFp(this.configuration).initiateNexiSession(initiateNexiSessionDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
66145
|
+
}
|
|
66146
|
+
|
|
64962
66147
|
/**
|
|
64963
66148
|
* Builds the Viva app-to-app launch params (same as the legacy viva/a2a/create-payment) and persists a PaymentSession keyed by the Viva clientTransactionId, so the webhook + reconciliation own the order mutation. Returns the launch params plus a clientToken to poll the session.
|
|
64964
66149
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -65226,6 +66411,18 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
65226
66411
|
public voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig) {
|
|
65227
66412
|
return PaymentSessionApiFp(this.configuration).voidManualPayment(voidManualSessionDto, options).then((request) => request(this.axios, this.basePath));
|
|
65228
66413
|
}
|
|
66414
|
+
|
|
66415
|
+
/**
|
|
66416
|
+
* Called by a Cloud Task with the scheduler key, never by an app. Repeats a waiting sale\'s purchase at Nexi, which holds the question up to 25 seconds and answers the moment the customer finishes. Still at the terminal: the next round is booked at once; paused at Nexi: after a pause. Paid: Nexi\'s answer is kept, Nexi is confirmed, the sale is stored SUCCESS, written on the order, then announced. Not paid: the failure is confirmed at Nexi with its code, then recorded FAILED in the till\'s words and announced. A sale already stored paid is put on the order from what the session keeps: Nexi is not asked and no login is read. Nexi busy or unreachable: the next round follows Nexi\'s Retry-After up to a minute, or a pause that doubles up to a minute, each with jitter. After 5 minutes of pauses for one reason: an order write that keeps failing hands the charge to the till as its own order and alerts a person; a confirm Nexi keeps refusing (Nexi: confirm until the server takes it) and a Nexi that cannot be heard alert a person once and are asked on every minute, never given up. Answers 500 when the next round could not be booked, so Cloud Tasks runs this round again.
|
|
66417
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
66418
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
66419
|
+
* @param {*} [options] Override http request option.
|
|
66420
|
+
* @throws {RequiredError}
|
|
66421
|
+
* @memberof PaymentSessionApi
|
|
66422
|
+
*/
|
|
66423
|
+
public waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig) {
|
|
66424
|
+
return PaymentSessionApiFp(this.configuration).waitForNexiSession(nexiWaitRoundDto, options).then((request) => request(this.axios, this.basePath));
|
|
66425
|
+
}
|
|
65229
66426
|
}
|
|
65230
66427
|
|
|
65231
66428
|
|