@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/dist/generated/api.d.ts
CHANGED
|
@@ -5275,6 +5275,12 @@ export interface CreateVenueGiftCardDto {
|
|
|
5275
5275
|
* @memberof CreateVenueGiftCardDto
|
|
5276
5276
|
*/
|
|
5277
5277
|
'expiresAt'?: string | null;
|
|
5278
|
+
/**
|
|
5279
|
+
* 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.
|
|
5280
|
+
* @type {string}
|
|
5281
|
+
* @memberof CreateVenueGiftCardDto
|
|
5282
|
+
*/
|
|
5283
|
+
'sendAt'?: string;
|
|
5278
5284
|
}
|
|
5279
5285
|
/**
|
|
5280
5286
|
*
|
|
@@ -8753,6 +8759,7 @@ export declare const GiftCardEmailKind: {
|
|
|
8753
8759
|
readonly CardAgain: "CARD_AGAIN";
|
|
8754
8760
|
readonly Expiry30: "EXPIRY_30";
|
|
8755
8761
|
readonly Expiry7: "EXPIRY_7";
|
|
8762
|
+
readonly BuyerReceipt: "BUYER_RECEIPT";
|
|
8756
8763
|
};
|
|
8757
8764
|
export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
|
|
8758
8765
|
/**
|
|
@@ -8847,6 +8854,12 @@ export interface GiftCardHistoryEventDto {
|
|
|
8847
8854
|
* @memberof GiftCardHistoryEventDto
|
|
8848
8855
|
*/
|
|
8849
8856
|
'orderId': string | null;
|
|
8857
|
+
/**
|
|
8858
|
+
* 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
|
|
8859
|
+
* @type {string}
|
|
8860
|
+
* @memberof GiftCardHistoryEventDto
|
|
8861
|
+
*/
|
|
8862
|
+
'orderNumber'?: string | null;
|
|
8850
8863
|
/**
|
|
8851
8864
|
* The address of an EMAILED, EMAIL_FAILED or EMAIL_CHANGED line; null for the others
|
|
8852
8865
|
* @type {string}
|
|
@@ -8859,6 +8872,12 @@ export interface GiftCardHistoryEventDto {
|
|
|
8859
8872
|
* @memberof GiftCardHistoryEventDto
|
|
8860
8873
|
*/
|
|
8861
8874
|
'emailKind': GiftCardEmailKind | null;
|
|
8875
|
+
/**
|
|
8876
|
+
* When the card\'s email is set to go, ISO 8601, on a SCHEDULED line (\"Scheduled for …\"); null for the others
|
|
8877
|
+
* @type {string}
|
|
8878
|
+
* @memberof GiftCardHistoryEventDto
|
|
8879
|
+
*/
|
|
8880
|
+
'scheduledFor': string | null;
|
|
8862
8881
|
/**
|
|
8863
8882
|
* When it happened, ISO 8601
|
|
8864
8883
|
* @type {string}
|
|
@@ -8883,6 +8902,8 @@ export declare const GiftCardHistoryKind: {
|
|
|
8883
8902
|
readonly Emailed: "EMAILED";
|
|
8884
8903
|
readonly EmailFailed: "EMAIL_FAILED";
|
|
8885
8904
|
readonly EmailChanged: "EMAIL_CHANGED";
|
|
8905
|
+
readonly Refunded: "REFUNDED";
|
|
8906
|
+
readonly Scheduled: "SCHEDULED";
|
|
8886
8907
|
};
|
|
8887
8908
|
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
8888
8909
|
/**
|
|
@@ -9115,6 +9136,12 @@ export interface GiftCardMovementDto {
|
|
|
9115
9136
|
* @memberof GiftCardMovementDto
|
|
9116
9137
|
*/
|
|
9117
9138
|
'orderId': string | null;
|
|
9139
|
+
/**
|
|
9140
|
+
* 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
|
|
9141
|
+
* @type {string}
|
|
9142
|
+
* @memberof GiftCardMovementDto
|
|
9143
|
+
*/
|
|
9144
|
+
'orderNumber'?: string | null;
|
|
9118
9145
|
/**
|
|
9119
9146
|
* 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
|
|
9120
9147
|
* @type {boolean}
|
|
@@ -9141,6 +9168,104 @@ export interface GiftCardMovementsDto {
|
|
|
9141
9168
|
*/
|
|
9142
9169
|
'nextCursor': string | null;
|
|
9143
9170
|
}
|
|
9171
|
+
/**
|
|
9172
|
+
*
|
|
9173
|
+
* @export
|
|
9174
|
+
* @interface GiftCardOfferDto
|
|
9175
|
+
*/
|
|
9176
|
+
export interface GiftCardOfferDto {
|
|
9177
|
+
/**
|
|
9178
|
+
* 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.
|
|
9179
|
+
* @type {boolean}
|
|
9180
|
+
* @memberof GiftCardOfferDto
|
|
9181
|
+
*/
|
|
9182
|
+
'sells': boolean;
|
|
9183
|
+
/**
|
|
9184
|
+
* The amounts offered, in cents, ascending: at most 3, the smallest ones when a store saved more before; with anyAmount, buyers also see Other
|
|
9185
|
+
* @type {Array<number>}
|
|
9186
|
+
* @memberof GiftCardOfferDto
|
|
9187
|
+
*/
|
|
9188
|
+
'amounts': Array<number>;
|
|
9189
|
+
/**
|
|
9190
|
+
* Whether a buyer may choose any amount
|
|
9191
|
+
* @type {boolean}
|
|
9192
|
+
* @memberof GiftCardOfferDto
|
|
9193
|
+
*/
|
|
9194
|
+
'anyAmount': boolean;
|
|
9195
|
+
/**
|
|
9196
|
+
* The smallest amount a buyer may choose, in cents
|
|
9197
|
+
* @type {number}
|
|
9198
|
+
* @memberof GiftCardOfferDto
|
|
9199
|
+
*/
|
|
9200
|
+
'minAmount': number;
|
|
9201
|
+
/**
|
|
9202
|
+
* The largest amount a buyer may choose, in cents
|
|
9203
|
+
* @type {number}
|
|
9204
|
+
* @memberof GiftCardOfferDto
|
|
9205
|
+
*/
|
|
9206
|
+
'maxAmount': number;
|
|
9207
|
+
/**
|
|
9208
|
+
*
|
|
9209
|
+
* @type {CurrencyCode}
|
|
9210
|
+
* @memberof GiftCardOfferDto
|
|
9211
|
+
*/
|
|
9212
|
+
'currency': CurrencyCode;
|
|
9213
|
+
/**
|
|
9214
|
+
* The text printed on the card; null when none
|
|
9215
|
+
* @type {string}
|
|
9216
|
+
* @memberof GiftCardOfferDto
|
|
9217
|
+
*/
|
|
9218
|
+
'cardText': string | null;
|
|
9219
|
+
/**
|
|
9220
|
+
* The card\'s picture, an https URL; null when none
|
|
9221
|
+
* @type {string}
|
|
9222
|
+
* @memberof GiftCardOfferDto
|
|
9223
|
+
*/
|
|
9224
|
+
'imageUrl': string | null;
|
|
9225
|
+
/**
|
|
9226
|
+
* The store\'s name
|
|
9227
|
+
* @type {string}
|
|
9228
|
+
* @memberof GiftCardOfferDto
|
|
9229
|
+
*/
|
|
9230
|
+
'storeName': string;
|
|
9231
|
+
/**
|
|
9232
|
+
* How many months a card stays valid from the day its email goes; null when cards never expire
|
|
9233
|
+
* @type {number}
|
|
9234
|
+
* @memberof GiftCardOfferDto
|
|
9235
|
+
*/
|
|
9236
|
+
'validityMonths': number | null;
|
|
9237
|
+
}
|
|
9238
|
+
/**
|
|
9239
|
+
*
|
|
9240
|
+
* @export
|
|
9241
|
+
* @interface GiftCardPaymentsOnlineDto
|
|
9242
|
+
*/
|
|
9243
|
+
export interface GiftCardPaymentsOnlineDto {
|
|
9244
|
+
/**
|
|
9245
|
+
*
|
|
9246
|
+
* @type {StripeConnectionState}
|
|
9247
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9248
|
+
*/
|
|
9249
|
+
'stripe': StripeConnectionState;
|
|
9250
|
+
/**
|
|
9251
|
+
*
|
|
9252
|
+
* @type {VivaOnlineState}
|
|
9253
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9254
|
+
*/
|
|
9255
|
+
'vivaOnline': VivaOnlineState;
|
|
9256
|
+
/**
|
|
9257
|
+
* Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
|
|
9258
|
+
* @type {boolean}
|
|
9259
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9260
|
+
*/
|
|
9261
|
+
'vivaOnPos': boolean;
|
|
9262
|
+
/**
|
|
9263
|
+
* 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
|
|
9264
|
+
* @type {boolean}
|
|
9265
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9266
|
+
*/
|
|
9267
|
+
'vivaIsv': boolean;
|
|
9268
|
+
}
|
|
9144
9269
|
/**
|
|
9145
9270
|
*
|
|
9146
9271
|
* @export
|
|
@@ -9223,6 +9348,25 @@ export interface GiftCardPeriodTotalsDtoSpent {
|
|
|
9223
9348
|
*/
|
|
9224
9349
|
'orderCount': number;
|
|
9225
9350
|
}
|
|
9351
|
+
/**
|
|
9352
|
+
*
|
|
9353
|
+
* @export
|
|
9354
|
+
* @interface GiftCardPersonDto
|
|
9355
|
+
*/
|
|
9356
|
+
export interface GiftCardPersonDto {
|
|
9357
|
+
/**
|
|
9358
|
+
* 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.
|
|
9359
|
+
* @type {string}
|
|
9360
|
+
* @memberof GiftCardPersonDto
|
|
9361
|
+
*/
|
|
9362
|
+
'name'?: string;
|
|
9363
|
+
/**
|
|
9364
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
9365
|
+
* @type {string}
|
|
9366
|
+
* @memberof GiftCardPersonDto
|
|
9367
|
+
*/
|
|
9368
|
+
'email': string;
|
|
9369
|
+
}
|
|
9226
9370
|
/**
|
|
9227
9371
|
*
|
|
9228
9372
|
* @export
|
|
@@ -9422,12 +9566,74 @@ export interface GiftCardReportDtoSpent {
|
|
|
9422
9566
|
*/
|
|
9423
9567
|
'orderCount': number;
|
|
9424
9568
|
}
|
|
9569
|
+
/**
|
|
9570
|
+
*
|
|
9571
|
+
* @export
|
|
9572
|
+
* @interface GiftCardSellingDto
|
|
9573
|
+
*/
|
|
9574
|
+
export interface GiftCardSellingDto {
|
|
9575
|
+
/**
|
|
9576
|
+
*
|
|
9577
|
+
* @type {GiftCardSellingDtoCardPayments}
|
|
9578
|
+
* @memberof GiftCardSellingDto
|
|
9579
|
+
*/
|
|
9580
|
+
'cardPayments': GiftCardSellingDtoCardPayments;
|
|
9581
|
+
/**
|
|
9582
|
+
* Whether a buyer has an amount to choose: at least one amount, or any amount
|
|
9583
|
+
* @type {boolean}
|
|
9584
|
+
* @memberof GiftCardSellingDto
|
|
9585
|
+
*/
|
|
9586
|
+
'amountsSet': boolean;
|
|
9587
|
+
/**
|
|
9588
|
+
* 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.
|
|
9589
|
+
* @type {boolean}
|
|
9590
|
+
* @memberof GiftCardSellingDto
|
|
9591
|
+
*/
|
|
9592
|
+
'ready': boolean;
|
|
9593
|
+
}
|
|
9594
|
+
/**
|
|
9595
|
+
* What the store can take card payments online with
|
|
9596
|
+
* @export
|
|
9597
|
+
* @interface GiftCardSellingDtoCardPayments
|
|
9598
|
+
*/
|
|
9599
|
+
export interface GiftCardSellingDtoCardPayments {
|
|
9600
|
+
/**
|
|
9601
|
+
*
|
|
9602
|
+
* @type {StripeConnectionState}
|
|
9603
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9604
|
+
*/
|
|
9605
|
+
'stripe': StripeConnectionState;
|
|
9606
|
+
/**
|
|
9607
|
+
*
|
|
9608
|
+
* @type {VivaOnlineState}
|
|
9609
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9610
|
+
*/
|
|
9611
|
+
'vivaOnline': VivaOnlineState;
|
|
9612
|
+
/**
|
|
9613
|
+
* Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
|
|
9614
|
+
* @type {boolean}
|
|
9615
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9616
|
+
*/
|
|
9617
|
+
'vivaOnPos': boolean;
|
|
9618
|
+
/**
|
|
9619
|
+
* 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
|
|
9620
|
+
* @type {boolean}
|
|
9621
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9622
|
+
*/
|
|
9623
|
+
'vivaIsv': boolean;
|
|
9624
|
+
}
|
|
9425
9625
|
/**
|
|
9426
9626
|
*
|
|
9427
9627
|
* @export
|
|
9428
9628
|
* @interface GiftCardSettingsDto
|
|
9429
9629
|
*/
|
|
9430
9630
|
export interface GiftCardSettingsDto {
|
|
9631
|
+
/**
|
|
9632
|
+
* 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
|
|
9633
|
+
* @type {boolean}
|
|
9634
|
+
* @memberof GiftCardSettingsDto
|
|
9635
|
+
*/
|
|
9636
|
+
'saved': boolean;
|
|
9431
9637
|
/**
|
|
9432
9638
|
*
|
|
9433
9639
|
* @type {GiftCardSettingsDtoChannels}
|
|
@@ -9441,7 +9647,7 @@ export interface GiftCardSettingsDto {
|
|
|
9441
9647
|
*/
|
|
9442
9648
|
'availableChannels': Array<GiftCardChannel>;
|
|
9443
9649
|
/**
|
|
9444
|
-
* The amounts offered, in cents, ascending
|
|
9650
|
+
* The amounts offered, in cents, ascending: at most 3, though a store saved with more before keeps them until its next change of amounts
|
|
9445
9651
|
* @type {Array<number>}
|
|
9446
9652
|
* @memberof GiftCardSettingsDto
|
|
9447
9653
|
*/
|
|
@@ -9500,6 +9706,12 @@ export interface GiftCardSettingsDto {
|
|
|
9500
9706
|
* @memberof GiftCardSettingsDto
|
|
9501
9707
|
*/
|
|
9502
9708
|
'emailLanguage': GiftCardLanguage | null;
|
|
9709
|
+
/**
|
|
9710
|
+
* 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.
|
|
9711
|
+
* @type {boolean}
|
|
9712
|
+
* @memberof GiftCardSettingsDto
|
|
9713
|
+
*/
|
|
9714
|
+
'sellOnline': boolean;
|
|
9503
9715
|
}
|
|
9504
9716
|
/**
|
|
9505
9717
|
* Where the store\'s gift cards can be spent
|
|
@@ -9925,6 +10137,68 @@ export interface InitiateNetsTerminalPaymentResponseDto {
|
|
|
9925
10137
|
*/
|
|
9926
10138
|
'connectCloudRequestId': string;
|
|
9927
10139
|
}
|
|
10140
|
+
/**
|
|
10141
|
+
*
|
|
10142
|
+
* @export
|
|
10143
|
+
* @interface InitiateNexiSessionDto
|
|
10144
|
+
*/
|
|
10145
|
+
export interface InitiateNexiSessionDto {
|
|
10146
|
+
/**
|
|
10147
|
+
*
|
|
10148
|
+
* @type {CreateManualSessionDtoDevice}
|
|
10149
|
+
* @memberof InitiateNexiSessionDto
|
|
10150
|
+
*/
|
|
10151
|
+
'device'?: CreateManualSessionDtoDevice | null;
|
|
10152
|
+
/**
|
|
10153
|
+
* The venue\'s orderingBusinessId. Must be the venue of the station calling.
|
|
10154
|
+
* @type {number}
|
|
10155
|
+
* @memberof InitiateNexiSessionDto
|
|
10156
|
+
*/
|
|
10157
|
+
'businessId': number;
|
|
10158
|
+
/**
|
|
10159
|
+
* The POS order this payment is for.
|
|
10160
|
+
* @type {string}
|
|
10161
|
+
* @memberof InitiateNexiSessionDto
|
|
10162
|
+
*/
|
|
10163
|
+
'orderId': string;
|
|
10164
|
+
/**
|
|
10165
|
+
* 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.
|
|
10166
|
+
* @type {number}
|
|
10167
|
+
* @memberof InitiateNexiSessionDto
|
|
10168
|
+
*/
|
|
10169
|
+
'amount': number;
|
|
10170
|
+
/**
|
|
10171
|
+
*
|
|
10172
|
+
* @type {InitiateNexiSessionDtoSplitContext}
|
|
10173
|
+
* @memberof InitiateNexiSessionDto
|
|
10174
|
+
*/
|
|
10175
|
+
'splitContext'?: InitiateNexiSessionDtoSplitContext;
|
|
10176
|
+
}
|
|
10177
|
+
/**
|
|
10178
|
+
* Split context. Omit for a full-cart payment, or send { mode, partId|seatId } for a split. Must match the order\'s checkoutModel.
|
|
10179
|
+
* @export
|
|
10180
|
+
* @interface InitiateNexiSessionDtoSplitContext
|
|
10181
|
+
*/
|
|
10182
|
+
export interface InitiateNexiSessionDtoSplitContext {
|
|
10183
|
+
/**
|
|
10184
|
+
*
|
|
10185
|
+
* @type {CheckoutModelEnum}
|
|
10186
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10187
|
+
*/
|
|
10188
|
+
'mode': CheckoutModelEnum;
|
|
10189
|
+
/**
|
|
10190
|
+
* Equal-split part id. Required when mode=EQUAL_SPLIT; ignored otherwise.
|
|
10191
|
+
* @type {string}
|
|
10192
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10193
|
+
*/
|
|
10194
|
+
'partId'?: string;
|
|
10195
|
+
/**
|
|
10196
|
+
* Item-split seat id. Required when mode=ITEM_SPLIT; ignored otherwise.
|
|
10197
|
+
* @type {string}
|
|
10198
|
+
* @memberof InitiateNexiSessionDtoSplitContext
|
|
10199
|
+
*/
|
|
10200
|
+
'seatId'?: string;
|
|
10201
|
+
}
|
|
9928
10202
|
/**
|
|
9929
10203
|
*
|
|
9930
10204
|
* @export
|
|
@@ -15097,6 +15371,61 @@ export interface NewKdsStationDto {
|
|
|
15097
15371
|
*/
|
|
15098
15372
|
'categoryIds': Array<string>;
|
|
15099
15373
|
}
|
|
15374
|
+
/**
|
|
15375
|
+
*
|
|
15376
|
+
* @export
|
|
15377
|
+
* @enum {string}
|
|
15378
|
+
*/
|
|
15379
|
+
export declare const NexiPauseReason: {
|
|
15380
|
+
readonly NexiUnheard: "nexi unheard";
|
|
15381
|
+
readonly NexiPaused: "nexi paused";
|
|
15382
|
+
readonly ConfirmNotTaken: "confirm not taken";
|
|
15383
|
+
readonly OrderNotWritten: "order not written";
|
|
15384
|
+
};
|
|
15385
|
+
export type NexiPauseReason = typeof NexiPauseReason[keyof typeof NexiPauseReason];
|
|
15386
|
+
/**
|
|
15387
|
+
*
|
|
15388
|
+
* @export
|
|
15389
|
+
* @interface NexiWaitRoundDto
|
|
15390
|
+
*/
|
|
15391
|
+
export interface NexiWaitRoundDto {
|
|
15392
|
+
/**
|
|
15393
|
+
* The session\'s id, which Nexi knows as the sale\'s external_id.
|
|
15394
|
+
* @type {string}
|
|
15395
|
+
* @memberof NexiWaitRoundDto
|
|
15396
|
+
*/
|
|
15397
|
+
'sessionId': string;
|
|
15398
|
+
/**
|
|
15399
|
+
* This round\'s number, from 1. It names the Cloud Task, so one round is never queued twice.
|
|
15400
|
+
* @type {number}
|
|
15401
|
+
* @memberof NexiWaitRoundDto
|
|
15402
|
+
*/
|
|
15403
|
+
'round': number;
|
|
15404
|
+
/**
|
|
15405
|
+
* 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.
|
|
15406
|
+
* @type {number}
|
|
15407
|
+
* @memberof NexiWaitRoundDto
|
|
15408
|
+
*/
|
|
15409
|
+
'pausedRounds': number;
|
|
15410
|
+
/**
|
|
15411
|
+
*
|
|
15412
|
+
* @type {NexiPauseReason}
|
|
15413
|
+
* @memberof NexiWaitRoundDto
|
|
15414
|
+
*/
|
|
15415
|
+
'pausedFor'?: NexiPauseReason;
|
|
15416
|
+
/**
|
|
15417
|
+
* When the pauses for `pausedFor` began, as an ISO 8601 time; absent when this round was booked at once.
|
|
15418
|
+
* @type {string}
|
|
15419
|
+
* @memberof NexiWaitRoundDto
|
|
15420
|
+
*/
|
|
15421
|
+
'pausedSince'?: string;
|
|
15422
|
+
/**
|
|
15423
|
+
* 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.
|
|
15424
|
+
* @type {boolean}
|
|
15425
|
+
* @memberof NexiWaitRoundDto
|
|
15426
|
+
*/
|
|
15427
|
+
'personTold'?: boolean;
|
|
15428
|
+
}
|
|
15100
15429
|
/**
|
|
15101
15430
|
*
|
|
15102
15431
|
* @export
|
|
@@ -15394,6 +15723,44 @@ export interface OnboardingStoresDto {
|
|
|
15394
15723
|
*/
|
|
15395
15724
|
'stores': Array<OnboardingStoreDto>;
|
|
15396
15725
|
}
|
|
15726
|
+
/**
|
|
15727
|
+
*
|
|
15728
|
+
* @export
|
|
15729
|
+
* @interface OnlineGiftCardRefundDto
|
|
15730
|
+
*/
|
|
15731
|
+
export interface OnlineGiftCardRefundDto {
|
|
15732
|
+
/**
|
|
15733
|
+
* The card\'s id
|
|
15734
|
+
* @type {string}
|
|
15735
|
+
* @memberof OnlineGiftCardRefundDto
|
|
15736
|
+
*/
|
|
15737
|
+
'cardId': string;
|
|
15738
|
+
/**
|
|
15739
|
+
* When the card was blocked for the refund, ISO 8601: the first refund\'s moment on a repeat.
|
|
15740
|
+
* @type {string}
|
|
15741
|
+
* @memberof OnlineGiftCardRefundDto
|
|
15742
|
+
*/
|
|
15743
|
+
'refundedAt': string;
|
|
15744
|
+
}
|
|
15745
|
+
/**
|
|
15746
|
+
*
|
|
15747
|
+
* @export
|
|
15748
|
+
* @interface OnlineGiftCardSaleDto
|
|
15749
|
+
*/
|
|
15750
|
+
export interface OnlineGiftCardSaleDto {
|
|
15751
|
+
/**
|
|
15752
|
+
* The card\'s id
|
|
15753
|
+
* @type {string}
|
|
15754
|
+
* @memberof OnlineGiftCardSaleDto
|
|
15755
|
+
*/
|
|
15756
|
+
'cardId': string;
|
|
15757
|
+
/**
|
|
15758
|
+
* The card\'s 6-digit code. Never shown to the buyer of a gift: only the person it is for gets it, by email.
|
|
15759
|
+
* @type {string}
|
|
15760
|
+
* @memberof OnlineGiftCardSaleDto
|
|
15761
|
+
*/
|
|
15762
|
+
'code': string;
|
|
15763
|
+
}
|
|
15397
15764
|
/**
|
|
15398
15765
|
*
|
|
15399
15766
|
* @export
|
|
@@ -22958,6 +23325,19 @@ export interface PosUpdateOrderDto {
|
|
|
22958
23325
|
*/
|
|
22959
23326
|
'isTicket'?: boolean;
|
|
22960
23327
|
}
|
|
23328
|
+
/**
|
|
23329
|
+
*
|
|
23330
|
+
* @export
|
|
23331
|
+
* @interface PosVivaMerchantDto
|
|
23332
|
+
*/
|
|
23333
|
+
export interface PosVivaMerchantDto {
|
|
23334
|
+
/**
|
|
23335
|
+
* 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.
|
|
23336
|
+
* @type {string}
|
|
23337
|
+
* @memberof PosVivaMerchantDto
|
|
23338
|
+
*/
|
|
23339
|
+
'merchantId': string | null;
|
|
23340
|
+
}
|
|
22961
23341
|
/**
|
|
22962
23342
|
*
|
|
22963
23343
|
* @export
|
|
@@ -26424,6 +26804,25 @@ export declare const RefundMode: {
|
|
|
26424
26804
|
readonly Item: "ITEM";
|
|
26425
26805
|
};
|
|
26426
26806
|
export type RefundMode = typeof RefundMode[keyof typeof RefundMode];
|
|
26807
|
+
/**
|
|
26808
|
+
*
|
|
26809
|
+
* @export
|
|
26810
|
+
* @interface RefundOnlineGiftCardSaleDto
|
|
26811
|
+
*/
|
|
26812
|
+
export interface RefundOnlineGiftCardSaleDto {
|
|
26813
|
+
/**
|
|
26814
|
+
* The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
|
|
26815
|
+
* @type {string}
|
|
26816
|
+
* @memberof RefundOnlineGiftCardSaleDto
|
|
26817
|
+
*/
|
|
26818
|
+
'orderCode': string;
|
|
26819
|
+
/**
|
|
26820
|
+
* The id of the Vendure order line that holds the gift card, 1 to 64 characters.
|
|
26821
|
+
* @type {string}
|
|
26822
|
+
* @memberof RefundOnlineGiftCardSaleDto
|
|
26823
|
+
*/
|
|
26824
|
+
'orderLineId': string;
|
|
26825
|
+
}
|
|
26427
26826
|
/**
|
|
26428
26827
|
*
|
|
26429
26828
|
* @export
|
|
@@ -30813,6 +31212,111 @@ export interface SearchUserInfoResponseDtoLinksValue {
|
|
|
30813
31212
|
*/
|
|
30814
31213
|
'method'?: string;
|
|
30815
31214
|
}
|
|
31215
|
+
/**
|
|
31216
|
+
*
|
|
31217
|
+
* @export
|
|
31218
|
+
* @interface SellGiftCardOnlineDto
|
|
31219
|
+
*/
|
|
31220
|
+
export interface SellGiftCardOnlineDto {
|
|
31221
|
+
/**
|
|
31222
|
+
* The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
|
|
31223
|
+
* @type {string}
|
|
31224
|
+
* @memberof SellGiftCardOnlineDto
|
|
31225
|
+
*/
|
|
31226
|
+
'orderCode': string;
|
|
31227
|
+
/**
|
|
31228
|
+
* The id of the Vendure order line that holds the gift card, 1 to 64 characters.
|
|
31229
|
+
* @type {string}
|
|
31230
|
+
* @memberof SellGiftCardOnlineDto
|
|
31231
|
+
*/
|
|
31232
|
+
'orderLineId': string;
|
|
31233
|
+
/**
|
|
31234
|
+
* The store that sold it: its orderingBusinessId, the Vendure seller of the storefront channel the order was placed on.
|
|
31235
|
+
* @type {number}
|
|
31236
|
+
* @memberof SellGiftCardOnlineDto
|
|
31237
|
+
*/
|
|
31238
|
+
'orderingBusinessId': number;
|
|
31239
|
+
/**
|
|
31240
|
+
* 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.
|
|
31241
|
+
* @type {number}
|
|
31242
|
+
* @memberof SellGiftCardOnlineDto
|
|
31243
|
+
*/
|
|
31244
|
+
'amount': number;
|
|
31245
|
+
/**
|
|
31246
|
+
*
|
|
31247
|
+
* @type {CurrencyCode}
|
|
31248
|
+
* @memberof SellGiftCardOnlineDto
|
|
31249
|
+
*/
|
|
31250
|
+
'currency': CurrencyCode;
|
|
31251
|
+
/**
|
|
31252
|
+
*
|
|
31253
|
+
* @type {SellGiftCardOnlineDtoBuyer}
|
|
31254
|
+
* @memberof SellGiftCardOnlineDto
|
|
31255
|
+
*/
|
|
31256
|
+
'buyer': SellGiftCardOnlineDtoBuyer;
|
|
31257
|
+
/**
|
|
31258
|
+
*
|
|
31259
|
+
* @type {SellGiftCardOnlineDtoRecipient}
|
|
31260
|
+
* @memberof SellGiftCardOnlineDto
|
|
31261
|
+
*/
|
|
31262
|
+
'recipient'?: SellGiftCardOnlineDtoRecipient;
|
|
31263
|
+
/**
|
|
31264
|
+
* The buyer\'s message, shown in the card\'s email, 1 to 300 characters. Absent: none.
|
|
31265
|
+
* @type {string}
|
|
31266
|
+
* @memberof SellGiftCardOnlineDto
|
|
31267
|
+
*/
|
|
31268
|
+
'message'?: string;
|
|
31269
|
+
/**
|
|
31270
|
+
*
|
|
31271
|
+
* @type {GiftCardLanguage}
|
|
31272
|
+
* @memberof SellGiftCardOnlineDto
|
|
31273
|
+
*/
|
|
31274
|
+
'language'?: GiftCardLanguage;
|
|
31275
|
+
/**
|
|
31276
|
+
* 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.
|
|
31277
|
+
* @type {string}
|
|
31278
|
+
* @memberof SellGiftCardOnlineDto
|
|
31279
|
+
*/
|
|
31280
|
+
'sendAt'?: string;
|
|
31281
|
+
}
|
|
31282
|
+
/**
|
|
31283
|
+
* Who bought the card: its receipt goes to this email, and the card too when it is for them.
|
|
31284
|
+
* @export
|
|
31285
|
+
* @interface SellGiftCardOnlineDtoBuyer
|
|
31286
|
+
*/
|
|
31287
|
+
export interface SellGiftCardOnlineDtoBuyer {
|
|
31288
|
+
/**
|
|
31289
|
+
* 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.
|
|
31290
|
+
* @type {string}
|
|
31291
|
+
* @memberof SellGiftCardOnlineDtoBuyer
|
|
31292
|
+
*/
|
|
31293
|
+
'name'?: string;
|
|
31294
|
+
/**
|
|
31295
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
31296
|
+
* @type {string}
|
|
31297
|
+
* @memberof SellGiftCardOnlineDtoBuyer
|
|
31298
|
+
*/
|
|
31299
|
+
'email': string;
|
|
31300
|
+
}
|
|
31301
|
+
/**
|
|
31302
|
+
* 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.
|
|
31303
|
+
* @export
|
|
31304
|
+
* @interface SellGiftCardOnlineDtoRecipient
|
|
31305
|
+
*/
|
|
31306
|
+
export interface SellGiftCardOnlineDtoRecipient {
|
|
31307
|
+
/**
|
|
31308
|
+
* 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.
|
|
31309
|
+
* @type {string}
|
|
31310
|
+
* @memberof SellGiftCardOnlineDtoRecipient
|
|
31311
|
+
*/
|
|
31312
|
+
'name'?: string;
|
|
31313
|
+
/**
|
|
31314
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
31315
|
+
* @type {string}
|
|
31316
|
+
* @memberof SellGiftCardOnlineDtoRecipient
|
|
31317
|
+
*/
|
|
31318
|
+
'email': string;
|
|
31319
|
+
}
|
|
30816
31320
|
/**
|
|
30817
31321
|
*
|
|
30818
31322
|
* @export
|
|
@@ -31866,6 +32370,17 @@ export interface StripeConfigResponseDto {
|
|
|
31866
32370
|
*/
|
|
31867
32371
|
'locationId': string | null;
|
|
31868
32372
|
}
|
|
32373
|
+
/**
|
|
32374
|
+
*
|
|
32375
|
+
* @export
|
|
32376
|
+
* @enum {string}
|
|
32377
|
+
*/
|
|
32378
|
+
export declare const StripeConnectionState: {
|
|
32379
|
+
readonly Active: "active";
|
|
32380
|
+
readonly Pending: "pending";
|
|
32381
|
+
readonly None: "none";
|
|
32382
|
+
};
|
|
32383
|
+
export type StripeConnectionState = typeof StripeConnectionState[keyof typeof StripeConnectionState];
|
|
31869
32384
|
/**
|
|
31870
32385
|
*
|
|
31871
32386
|
* @export
|
|
@@ -36002,7 +36517,7 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36002
36517
|
*/
|
|
36003
36518
|
'channels'?: UpdateGiftCardSettingsDtoChannels;
|
|
36004
36519
|
/**
|
|
36005
|
-
* The amounts offered, in cents: 1 to
|
|
36520
|
+
* The amounts offered, in cents: 1 to 3 different amounts, each 100 to 100000 (with anyAmount, buyers also see Other). Stored ascending. Absent: unchanged.
|
|
36006
36521
|
* @type {Array<number>}
|
|
36007
36522
|
* @memberof UpdateGiftCardSettingsDto
|
|
36008
36523
|
*/
|
|
@@ -36061,6 +36576,12 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36061
36576
|
* @memberof UpdateGiftCardSettingsDto
|
|
36062
36577
|
*/
|
|
36063
36578
|
'emailLanguage'?: GiftCardLanguage | null;
|
|
36579
|
+
/**
|
|
36580
|
+
* 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.
|
|
36581
|
+
* @type {boolean}
|
|
36582
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36583
|
+
*/
|
|
36584
|
+
'sellOnline'?: boolean;
|
|
36064
36585
|
}
|
|
36065
36586
|
/**
|
|
36066
36587
|
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
@@ -36560,7 +37081,7 @@ export interface UpdateTableStatusDto {
|
|
|
36560
37081
|
*/
|
|
36561
37082
|
export interface UpdateVenueGiftCardDto {
|
|
36562
37083
|
/**
|
|
36563
|
-
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
37084
|
+
* 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.
|
|
36564
37085
|
* @type {string}
|
|
36565
37086
|
* @memberof UpdateVenueGiftCardDto
|
|
36566
37087
|
*/
|
|
@@ -36571,6 +37092,24 @@ export interface UpdateVenueGiftCardDto {
|
|
|
36571
37092
|
* @memberof UpdateVenueGiftCardDto
|
|
36572
37093
|
*/
|
|
36573
37094
|
'language'?: GiftCardLanguage | null;
|
|
37095
|
+
/**
|
|
37096
|
+
* 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.
|
|
37097
|
+
* @type {string}
|
|
37098
|
+
* @memberof UpdateVenueGiftCardDto
|
|
37099
|
+
*/
|
|
37100
|
+
'sendAt'?: string | null;
|
|
37101
|
+
/**
|
|
37102
|
+
* 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.
|
|
37103
|
+
* @type {string}
|
|
37104
|
+
* @memberof UpdateVenueGiftCardDto
|
|
37105
|
+
*/
|
|
37106
|
+
'recipientEmail'?: string;
|
|
37107
|
+
/**
|
|
37108
|
+
* 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.
|
|
37109
|
+
* @type {string}
|
|
37110
|
+
* @memberof UpdateVenueGiftCardDto
|
|
37111
|
+
*/
|
|
37112
|
+
'recipientName'?: string;
|
|
36574
37113
|
}
|
|
36575
37114
|
/**
|
|
36576
37115
|
*
|
|
@@ -37814,6 +38353,24 @@ export interface VenueGiftCardDetailDto {
|
|
|
37814
38353
|
* @memberof VenueGiftCardDetailDto
|
|
37815
38354
|
*/
|
|
37816
38355
|
'language': GiftCardLanguage | null;
|
|
38356
|
+
/**
|
|
38357
|
+
* When the card\'s email is set to go, ISO 8601: a day the dashboard or the online buyer chose; null for at once
|
|
38358
|
+
* @type {string}
|
|
38359
|
+
* @memberof VenueGiftCardDetailDto
|
|
38360
|
+
*/
|
|
38361
|
+
'sendAt': string | null;
|
|
38362
|
+
/**
|
|
38363
|
+
* 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
|
|
38364
|
+
* @type {string}
|
|
38365
|
+
* @memberof VenueGiftCardDetailDto
|
|
38366
|
+
*/
|
|
38367
|
+
'recipientName': string | null;
|
|
38368
|
+
/**
|
|
38369
|
+
* Where an online gift\'s card email and reminders go; null for every other card, whose emails go to buyerEmail
|
|
38370
|
+
* @type {string}
|
|
38371
|
+
* @memberof VenueGiftCardDetailDto
|
|
38372
|
+
*/
|
|
38373
|
+
'recipientEmail': string | null;
|
|
37817
38374
|
/**
|
|
37818
38375
|
*
|
|
37819
38376
|
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
@@ -39207,6 +39764,16 @@ export declare const VivaEventId: {
|
|
|
39207
39764
|
readonly NUMBER_7005: 7005;
|
|
39208
39765
|
};
|
|
39209
39766
|
export type VivaEventId = typeof VivaEventId[keyof typeof VivaEventId];
|
|
39767
|
+
/**
|
|
39768
|
+
*
|
|
39769
|
+
* @export
|
|
39770
|
+
* @enum {string}
|
|
39771
|
+
*/
|
|
39772
|
+
export declare const VivaOnlineState: {
|
|
39773
|
+
readonly Active: "active";
|
|
39774
|
+
readonly None: "none";
|
|
39775
|
+
};
|
|
39776
|
+
export type VivaOnlineState = typeof VivaOnlineState[keyof typeof VivaOnlineState];
|
|
39210
39777
|
/**
|
|
39211
39778
|
*
|
|
39212
39779
|
* @export
|
|
@@ -46168,11 +46735,11 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46168
46735
|
*/
|
|
46169
46736
|
blockVenueGiftCard: (businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46170
46737
|
/**
|
|
46171
|
-
* 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.
|
|
46738
|
+
* 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.
|
|
46172
46739
|
* @summary Make a gift card by hand, given for free
|
|
46173
46740
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46174
46741
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46175
|
-
* @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.
|
|
46742
|
+
* @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.
|
|
46176
46743
|
* @param {*} [options] Override http request option.
|
|
46177
46744
|
* @throws {RequiredError}
|
|
46178
46745
|
*/
|
|
@@ -46206,6 +46773,14 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46206
46773
|
* @throws {RequiredError}
|
|
46207
46774
|
*/
|
|
46208
46775
|
getVenueGiftCardReport: (businessId: number, from: string, to: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46776
|
+
/**
|
|
46777
|
+
* 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.
|
|
46778
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
46779
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46780
|
+
* @param {*} [options] Override http request option.
|
|
46781
|
+
* @throws {RequiredError}
|
|
46782
|
+
*/
|
|
46783
|
+
getVenueGiftCardSelling: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46209
46784
|
/**
|
|
46210
46785
|
* 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.
|
|
46211
46786
|
* @summary Read a store\'s gift card settings
|
|
@@ -46233,7 +46808,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46233
46808
|
* 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.
|
|
46234
46809
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46235
46810
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46236
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
46811
|
+
* @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.
|
|
46237
46812
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46238
46813
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46239
46814
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46243,7 +46818,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46243
46818
|
*/
|
|
46244
46819
|
listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46245
46820
|
/**
|
|
46246
|
-
* 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.
|
|
46821
|
+
* 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.
|
|
46247
46822
|
* @summary Unblock a gift card
|
|
46248
46823
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46249
46824
|
* @param {string} cardId The card\'s id
|
|
@@ -46252,8 +46827,8 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46252
46827
|
*/
|
|
46253
46828
|
unblockVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46254
46829
|
/**
|
|
46255
|
-
*
|
|
46256
|
-
* @summary Correct a gift card\'s email address
|
|
46830
|
+
* 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.
|
|
46831
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46257
46832
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46258
46833
|
* @param {string} cardId The card\'s id
|
|
46259
46834
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46262,7 +46837,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46262
46837
|
*/
|
|
46263
46838
|
updateVenueGiftCard: (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46264
46839
|
/**
|
|
46265
|
-
* 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.
|
|
46840
|
+
* 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.
|
|
46266
46841
|
* @summary Change a store\'s gift card settings
|
|
46267
46842
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46268
46843
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46296,11 +46871,11 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46296
46871
|
*/
|
|
46297
46872
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46298
46873
|
/**
|
|
46299
|
-
* 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.
|
|
46874
|
+
* 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.
|
|
46300
46875
|
* @summary Make a gift card by hand, given for free
|
|
46301
46876
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46302
46877
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46303
|
-
* @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.
|
|
46878
|
+
* @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.
|
|
46304
46879
|
* @param {*} [options] Override http request option.
|
|
46305
46880
|
* @throws {RequiredError}
|
|
46306
46881
|
*/
|
|
@@ -46334,6 +46909,14 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46334
46909
|
* @throws {RequiredError}
|
|
46335
46910
|
*/
|
|
46336
46911
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardReportDto>>;
|
|
46912
|
+
/**
|
|
46913
|
+
* 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.
|
|
46914
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
46915
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46916
|
+
* @param {*} [options] Override http request option.
|
|
46917
|
+
* @throws {RequiredError}
|
|
46918
|
+
*/
|
|
46919
|
+
getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSellingDto>>;
|
|
46337
46920
|
/**
|
|
46338
46921
|
* 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.
|
|
46339
46922
|
* @summary Read a store\'s gift card settings
|
|
@@ -46361,7 +46944,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46361
46944
|
* 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.
|
|
46362
46945
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46363
46946
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46364
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
46947
|
+
* @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.
|
|
46365
46948
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46366
46949
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46367
46950
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46371,7 +46954,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46371
46954
|
*/
|
|
46372
46955
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
|
|
46373
46956
|
/**
|
|
46374
|
-
* 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.
|
|
46957
|
+
* 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.
|
|
46375
46958
|
* @summary Unblock a gift card
|
|
46376
46959
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46377
46960
|
* @param {string} cardId The card\'s id
|
|
@@ -46380,8 +46963,8 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46380
46963
|
*/
|
|
46381
46964
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46382
46965
|
/**
|
|
46383
|
-
*
|
|
46384
|
-
* @summary Correct a gift card\'s email address
|
|
46966
|
+
* 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.
|
|
46967
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46385
46968
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46386
46969
|
* @param {string} cardId The card\'s id
|
|
46387
46970
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46390,7 +46973,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46390
46973
|
*/
|
|
46391
46974
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46392
46975
|
/**
|
|
46393
|
-
* 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.
|
|
46976
|
+
* 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.
|
|
46394
46977
|
* @summary Change a store\'s gift card settings
|
|
46395
46978
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46396
46979
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46424,11 +47007,11 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46424
47007
|
*/
|
|
46425
47008
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46426
47009
|
/**
|
|
46427
|
-
* 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.
|
|
47010
|
+
* 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.
|
|
46428
47011
|
* @summary Make a gift card by hand, given for free
|
|
46429
47012
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46430
47013
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46431
|
-
* @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.
|
|
47014
|
+
* @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.
|
|
46432
47015
|
* @param {*} [options] Override http request option.
|
|
46433
47016
|
* @throws {RequiredError}
|
|
46434
47017
|
*/
|
|
@@ -46462,6 +47045,14 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46462
47045
|
* @throws {RequiredError}
|
|
46463
47046
|
*/
|
|
46464
47047
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: any): AxiosPromise<GiftCardReportDto>;
|
|
47048
|
+
/**
|
|
47049
|
+
* 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.
|
|
47050
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
47051
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
47052
|
+
* @param {*} [options] Override http request option.
|
|
47053
|
+
* @throws {RequiredError}
|
|
47054
|
+
*/
|
|
47055
|
+
getVenueGiftCardSelling(businessId: number, options?: any): AxiosPromise<GiftCardSellingDto>;
|
|
46465
47056
|
/**
|
|
46466
47057
|
* 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.
|
|
46467
47058
|
* @summary Read a store\'s gift card settings
|
|
@@ -46489,7 +47080,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46489
47080
|
* 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.
|
|
46490
47081
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46491
47082
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46492
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
47083
|
+
* @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.
|
|
46493
47084
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46494
47085
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46495
47086
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46499,7 +47090,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46499
47090
|
*/
|
|
46500
47091
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto>;
|
|
46501
47092
|
/**
|
|
46502
|
-
* 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.
|
|
47093
|
+
* 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.
|
|
46503
47094
|
* @summary Unblock a gift card
|
|
46504
47095
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46505
47096
|
* @param {string} cardId The card\'s id
|
|
@@ -46508,8 +47099,8 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46508
47099
|
*/
|
|
46509
47100
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46510
47101
|
/**
|
|
46511
|
-
*
|
|
46512
|
-
* @summary Correct a gift card\'s email address
|
|
47102
|
+
* 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.
|
|
47103
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46513
47104
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46514
47105
|
* @param {string} cardId The card\'s id
|
|
46515
47106
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46518,7 +47109,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46518
47109
|
*/
|
|
46519
47110
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46520
47111
|
/**
|
|
46521
|
-
* 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.
|
|
47112
|
+
* 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.
|
|
46522
47113
|
* @summary Change a store\'s gift card settings
|
|
46523
47114
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46524
47115
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46555,11 +47146,11 @@ export interface GiftCardsApiInterface {
|
|
|
46555
47146
|
*/
|
|
46556
47147
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46557
47148
|
/**
|
|
46558
|
-
* 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.
|
|
47149
|
+
* 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.
|
|
46559
47150
|
* @summary Make a gift card by hand, given for free
|
|
46560
47151
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46561
47152
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46562
|
-
* @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.
|
|
47153
|
+
* @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.
|
|
46563
47154
|
* @param {*} [options] Override http request option.
|
|
46564
47155
|
* @throws {RequiredError}
|
|
46565
47156
|
* @memberof GiftCardsApiInterface
|
|
@@ -46597,6 +47188,15 @@ export interface GiftCardsApiInterface {
|
|
|
46597
47188
|
* @memberof GiftCardsApiInterface
|
|
46598
47189
|
*/
|
|
46599
47190
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<GiftCardReportDto>;
|
|
47191
|
+
/**
|
|
47192
|
+
* 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.
|
|
47193
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
47194
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
47195
|
+
* @param {*} [options] Override http request option.
|
|
47196
|
+
* @throws {RequiredError}
|
|
47197
|
+
* @memberof GiftCardsApiInterface
|
|
47198
|
+
*/
|
|
47199
|
+
getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSellingDto>;
|
|
46600
47200
|
/**
|
|
46601
47201
|
* 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.
|
|
46602
47202
|
* @summary Read a store\'s gift card settings
|
|
@@ -46626,7 +47226,7 @@ export interface GiftCardsApiInterface {
|
|
|
46626
47226
|
* 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.
|
|
46627
47227
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46628
47228
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46629
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
47229
|
+
* @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.
|
|
46630
47230
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46631
47231
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46632
47232
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46637,7 +47237,7 @@ export interface GiftCardsApiInterface {
|
|
|
46637
47237
|
*/
|
|
46638
47238
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
46639
47239
|
/**
|
|
46640
|
-
* 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.
|
|
47240
|
+
* 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.
|
|
46641
47241
|
* @summary Unblock a gift card
|
|
46642
47242
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46643
47243
|
* @param {string} cardId The card\'s id
|
|
@@ -46647,8 +47247,8 @@ export interface GiftCardsApiInterface {
|
|
|
46647
47247
|
*/
|
|
46648
47248
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46649
47249
|
/**
|
|
46650
|
-
*
|
|
46651
|
-
* @summary Correct a gift card\'s email address
|
|
47250
|
+
* 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.
|
|
47251
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46652
47252
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46653
47253
|
* @param {string} cardId The card\'s id
|
|
46654
47254
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46658,7 +47258,7 @@ export interface GiftCardsApiInterface {
|
|
|
46658
47258
|
*/
|
|
46659
47259
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46660
47260
|
/**
|
|
46661
|
-
* 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.
|
|
47261
|
+
* 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.
|
|
46662
47262
|
* @summary Change a store\'s gift card settings
|
|
46663
47263
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46664
47264
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46697,11 +47297,11 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46697
47297
|
*/
|
|
46698
47298
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46699
47299
|
/**
|
|
46700
|
-
* 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.
|
|
47300
|
+
* 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.
|
|
46701
47301
|
* @summary Make a gift card by hand, given for free
|
|
46702
47302
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46703
47303
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46704
|
-
* @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.
|
|
47304
|
+
* @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.
|
|
46705
47305
|
* @param {*} [options] Override http request option.
|
|
46706
47306
|
* @throws {RequiredError}
|
|
46707
47307
|
* @memberof GiftCardsApi
|
|
@@ -46739,6 +47339,15 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46739
47339
|
* @memberof GiftCardsApi
|
|
46740
47340
|
*/
|
|
46741
47341
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardReportDto, any, {}>>;
|
|
47342
|
+
/**
|
|
47343
|
+
* 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.
|
|
47344
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
47345
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
47346
|
+
* @param {*} [options] Override http request option.
|
|
47347
|
+
* @throws {RequiredError}
|
|
47348
|
+
* @memberof GiftCardsApi
|
|
47349
|
+
*/
|
|
47350
|
+
getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardSellingDto, any, {}>>;
|
|
46742
47351
|
/**
|
|
46743
47352
|
* 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.
|
|
46744
47353
|
* @summary Read a store\'s gift card settings
|
|
@@ -46768,7 +47377,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46768
47377
|
* 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.
|
|
46769
47378
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46770
47379
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46771
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
47380
|
+
* @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.
|
|
46772
47381
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46773
47382
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46774
47383
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46779,7 +47388,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46779
47388
|
*/
|
|
46780
47389
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
|
|
46781
47390
|
/**
|
|
46782
|
-
* 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.
|
|
47391
|
+
* 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.
|
|
46783
47392
|
* @summary Unblock a gift card
|
|
46784
47393
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46785
47394
|
* @param {string} cardId The card\'s id
|
|
@@ -46789,8 +47398,8 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46789
47398
|
*/
|
|
46790
47399
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46791
47400
|
/**
|
|
46792
|
-
*
|
|
46793
|
-
* @summary Correct a gift card\'s email address
|
|
47401
|
+
* 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.
|
|
47402
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46794
47403
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46795
47404
|
* @param {string} cardId The card\'s id
|
|
46796
47405
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46800,7 +47409,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46800
47409
|
*/
|
|
46801
47410
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46802
47411
|
/**
|
|
46803
|
-
* 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.
|
|
47412
|
+
* 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.
|
|
46804
47413
|
* @summary Change a store\'s gift card settings
|
|
46805
47414
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46806
47415
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -47533,6 +48142,207 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
47533
48142
|
*/
|
|
47534
48143
|
listOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryPosResponseDtoV2, any, {}>>;
|
|
47535
48144
|
}
|
|
48145
|
+
/**
|
|
48146
|
+
* InternalGiftCardsApi - axios parameter creator
|
|
48147
|
+
* @export
|
|
48148
|
+
*/
|
|
48149
|
+
export declare const InternalGiftCardsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
48150
|
+
/**
|
|
48151
|
+
* 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.
|
|
48152
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48153
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48154
|
+
* @param {*} [options] Override http request option.
|
|
48155
|
+
* @throws {RequiredError}
|
|
48156
|
+
*/
|
|
48157
|
+
getVenueGiftCardOffer: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48158
|
+
/**
|
|
48159
|
+
* 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.
|
|
48160
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48161
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48162
|
+
* @param {*} [options] Override http request option.
|
|
48163
|
+
* @throws {RequiredError}
|
|
48164
|
+
*/
|
|
48165
|
+
getVenuePosVivaMerchant: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48166
|
+
/**
|
|
48167
|
+
* 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.
|
|
48168
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48169
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48170
|
+
* @param {*} [options] Override http request option.
|
|
48171
|
+
* @throws {RequiredError}
|
|
48172
|
+
*/
|
|
48173
|
+
refundOnlineGiftCardSale: (refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48174
|
+
/**
|
|
48175
|
+
* 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.
|
|
48176
|
+
* @summary Make the gift card an online order line paid for
|
|
48177
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48178
|
+
* @param {*} [options] Override http request option.
|
|
48179
|
+
* @throws {RequiredError}
|
|
48180
|
+
*/
|
|
48181
|
+
sellGiftCardOnline: (sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48182
|
+
};
|
|
48183
|
+
/**
|
|
48184
|
+
* InternalGiftCardsApi - functional programming interface
|
|
48185
|
+
* @export
|
|
48186
|
+
*/
|
|
48187
|
+
export declare const InternalGiftCardsApiFp: (configuration?: Configuration) => {
|
|
48188
|
+
/**
|
|
48189
|
+
* 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.
|
|
48190
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48191
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48192
|
+
* @param {*} [options] Override http request option.
|
|
48193
|
+
* @throws {RequiredError}
|
|
48194
|
+
*/
|
|
48195
|
+
getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardOfferDto>>;
|
|
48196
|
+
/**
|
|
48197
|
+
* 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.
|
|
48198
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48199
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48200
|
+
* @param {*} [options] Override http request option.
|
|
48201
|
+
* @throws {RequiredError}
|
|
48202
|
+
*/
|
|
48203
|
+
getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosVivaMerchantDto>>;
|
|
48204
|
+
/**
|
|
48205
|
+
* 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.
|
|
48206
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48207
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48208
|
+
* @param {*} [options] Override http request option.
|
|
48209
|
+
* @throws {RequiredError}
|
|
48210
|
+
*/
|
|
48211
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardRefundDto>>;
|
|
48212
|
+
/**
|
|
48213
|
+
* 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.
|
|
48214
|
+
* @summary Make the gift card an online order line paid for
|
|
48215
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48216
|
+
* @param {*} [options] Override http request option.
|
|
48217
|
+
* @throws {RequiredError}
|
|
48218
|
+
*/
|
|
48219
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardSaleDto>>;
|
|
48220
|
+
};
|
|
48221
|
+
/**
|
|
48222
|
+
* InternalGiftCardsApi - factory interface
|
|
48223
|
+
* @export
|
|
48224
|
+
*/
|
|
48225
|
+
export declare const InternalGiftCardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
48226
|
+
/**
|
|
48227
|
+
* 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.
|
|
48228
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48229
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48230
|
+
* @param {*} [options] Override http request option.
|
|
48231
|
+
* @throws {RequiredError}
|
|
48232
|
+
*/
|
|
48233
|
+
getVenueGiftCardOffer(businessId: number, options?: any): AxiosPromise<GiftCardOfferDto>;
|
|
48234
|
+
/**
|
|
48235
|
+
* 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.
|
|
48236
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48237
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48238
|
+
* @param {*} [options] Override http request option.
|
|
48239
|
+
* @throws {RequiredError}
|
|
48240
|
+
*/
|
|
48241
|
+
getVenuePosVivaMerchant(businessId: number, options?: any): AxiosPromise<PosVivaMerchantDto>;
|
|
48242
|
+
/**
|
|
48243
|
+
* 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.
|
|
48244
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48245
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48246
|
+
* @param {*} [options] Override http request option.
|
|
48247
|
+
* @throws {RequiredError}
|
|
48248
|
+
*/
|
|
48249
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: any): AxiosPromise<OnlineGiftCardRefundDto>;
|
|
48250
|
+
/**
|
|
48251
|
+
* 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.
|
|
48252
|
+
* @summary Make the gift card an online order line paid for
|
|
48253
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48254
|
+
* @param {*} [options] Override http request option.
|
|
48255
|
+
* @throws {RequiredError}
|
|
48256
|
+
*/
|
|
48257
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: any): AxiosPromise<OnlineGiftCardSaleDto>;
|
|
48258
|
+
};
|
|
48259
|
+
/**
|
|
48260
|
+
* InternalGiftCardsApi - interface
|
|
48261
|
+
* @export
|
|
48262
|
+
* @interface InternalGiftCardsApi
|
|
48263
|
+
*/
|
|
48264
|
+
export interface InternalGiftCardsApiInterface {
|
|
48265
|
+
/**
|
|
48266
|
+
* 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.
|
|
48267
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48268
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48269
|
+
* @param {*} [options] Override http request option.
|
|
48270
|
+
* @throws {RequiredError}
|
|
48271
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48272
|
+
*/
|
|
48273
|
+
getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardOfferDto>;
|
|
48274
|
+
/**
|
|
48275
|
+
* 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.
|
|
48276
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48277
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48278
|
+
* @param {*} [options] Override http request option.
|
|
48279
|
+
* @throws {RequiredError}
|
|
48280
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48281
|
+
*/
|
|
48282
|
+
getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosVivaMerchantDto>;
|
|
48283
|
+
/**
|
|
48284
|
+
* 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.
|
|
48285
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48286
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48287
|
+
* @param {*} [options] Override http request option.
|
|
48288
|
+
* @throws {RequiredError}
|
|
48289
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48290
|
+
*/
|
|
48291
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardRefundDto>;
|
|
48292
|
+
/**
|
|
48293
|
+
* 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.
|
|
48294
|
+
* @summary Make the gift card an online order line paid for
|
|
48295
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48296
|
+
* @param {*} [options] Override http request option.
|
|
48297
|
+
* @throws {RequiredError}
|
|
48298
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48299
|
+
*/
|
|
48300
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardSaleDto>;
|
|
48301
|
+
}
|
|
48302
|
+
/**
|
|
48303
|
+
* InternalGiftCardsApi - object-oriented interface
|
|
48304
|
+
* @export
|
|
48305
|
+
* @class InternalGiftCardsApi
|
|
48306
|
+
* @extends {BaseAPI}
|
|
48307
|
+
*/
|
|
48308
|
+
export declare class InternalGiftCardsApi extends BaseAPI implements InternalGiftCardsApiInterface {
|
|
48309
|
+
/**
|
|
48310
|
+
* 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.
|
|
48311
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48312
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48313
|
+
* @param {*} [options] Override http request option.
|
|
48314
|
+
* @throws {RequiredError}
|
|
48315
|
+
* @memberof InternalGiftCardsApi
|
|
48316
|
+
*/
|
|
48317
|
+
getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardOfferDto, any, {}>>;
|
|
48318
|
+
/**
|
|
48319
|
+
* 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.
|
|
48320
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48321
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48322
|
+
* @param {*} [options] Override http request option.
|
|
48323
|
+
* @throws {RequiredError}
|
|
48324
|
+
* @memberof InternalGiftCardsApi
|
|
48325
|
+
*/
|
|
48326
|
+
getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosVivaMerchantDto, any, {}>>;
|
|
48327
|
+
/**
|
|
48328
|
+
* 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.
|
|
48329
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48330
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48331
|
+
* @param {*} [options] Override http request option.
|
|
48332
|
+
* @throws {RequiredError}
|
|
48333
|
+
* @memberof InternalGiftCardsApi
|
|
48334
|
+
*/
|
|
48335
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OnlineGiftCardRefundDto, any, {}>>;
|
|
48336
|
+
/**
|
|
48337
|
+
* 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.
|
|
48338
|
+
* @summary Make the gift card an online order line paid for
|
|
48339
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48340
|
+
* @param {*} [options] Override http request option.
|
|
48341
|
+
* @throws {RequiredError}
|
|
48342
|
+
* @memberof InternalGiftCardsApi
|
|
48343
|
+
*/
|
|
48344
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OnlineGiftCardSaleDto, any, {}>>;
|
|
48345
|
+
}
|
|
47536
48346
|
/**
|
|
47537
48347
|
* InvoiceCompaniesApi - axios parameter creator
|
|
47538
48348
|
* @export
|
|
@@ -52407,6 +53217,15 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
52407
53217
|
* @throws {RequiredError}
|
|
52408
53218
|
*/
|
|
52409
53219
|
initiateNetsSession: (initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53220
|
+
/**
|
|
53221
|
+
* 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).
|
|
53222
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53223
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53224
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
53225
|
+
* @param {*} [options] Override http request option.
|
|
53226
|
+
* @throws {RequiredError}
|
|
53227
|
+
*/
|
|
53228
|
+
initiateNexiSession: (initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52410
53229
|
/**
|
|
52411
53230
|
* 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.
|
|
52412
53231
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -52587,6 +53406,14 @@ export declare const PaymentSessionApiAxiosParamCreator: (configuration?: Config
|
|
|
52587
53406
|
* @throws {RequiredError}
|
|
52588
53407
|
*/
|
|
52589
53408
|
voidManualPayment: (voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53409
|
+
/**
|
|
53410
|
+
* 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.
|
|
53411
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
53412
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
53413
|
+
* @param {*} [options] Override http request option.
|
|
53414
|
+
* @throws {RequiredError}
|
|
53415
|
+
*/
|
|
53416
|
+
waitForNexiSession: (nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52590
53417
|
};
|
|
52591
53418
|
/**
|
|
52592
53419
|
* PaymentSessionApi - functional programming interface
|
|
@@ -52657,6 +53484,15 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
52657
53484
|
* @throws {RequiredError}
|
|
52658
53485
|
*/
|
|
52659
53486
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InitiateNetsSessionResponseDto>>;
|
|
53487
|
+
/**
|
|
53488
|
+
* 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).
|
|
53489
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53490
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53491
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
53492
|
+
* @param {*} [options] Override http request option.
|
|
53493
|
+
* @throws {RequiredError}
|
|
53494
|
+
*/
|
|
53495
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PaymentSessionViewDto>>;
|
|
52660
53496
|
/**
|
|
52661
53497
|
* 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.
|
|
52662
53498
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -52837,6 +53673,14 @@ export declare const PaymentSessionApiFp: (configuration?: Configuration) => {
|
|
|
52837
53673
|
* @throws {RequiredError}
|
|
52838
53674
|
*/
|
|
52839
53675
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RecordManualPaymentResultDto>>;
|
|
53676
|
+
/**
|
|
53677
|
+
* 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.
|
|
53678
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
53679
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
53680
|
+
* @param {*} [options] Override http request option.
|
|
53681
|
+
* @throws {RequiredError}
|
|
53682
|
+
*/
|
|
53683
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
52840
53684
|
};
|
|
52841
53685
|
/**
|
|
52842
53686
|
* PaymentSessionApi - factory interface
|
|
@@ -52907,6 +53751,15 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
52907
53751
|
* @throws {RequiredError}
|
|
52908
53752
|
*/
|
|
52909
53753
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
53754
|
+
/**
|
|
53755
|
+
* 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).
|
|
53756
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
53757
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
53758
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
53759
|
+
* @param {*} [options] Override http request option.
|
|
53760
|
+
* @throws {RequiredError}
|
|
53761
|
+
*/
|
|
53762
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: any): AxiosPromise<PaymentSessionViewDto>;
|
|
52910
53763
|
/**
|
|
52911
53764
|
* 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.
|
|
52912
53765
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -53087,6 +53940,14 @@ export declare const PaymentSessionApiFactory: (configuration?: Configuration, b
|
|
|
53087
53940
|
* @throws {RequiredError}
|
|
53088
53941
|
*/
|
|
53089
53942
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: any): AxiosPromise<RecordManualPaymentResultDto>;
|
|
53943
|
+
/**
|
|
53944
|
+
* 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.
|
|
53945
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
53946
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
53947
|
+
* @param {*} [options] Override http request option.
|
|
53948
|
+
* @throws {RequiredError}
|
|
53949
|
+
*/
|
|
53950
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: any): AxiosPromise<void>;
|
|
53090
53951
|
};
|
|
53091
53952
|
/**
|
|
53092
53953
|
* PaymentSessionApi - interface
|
|
@@ -53165,6 +54026,16 @@ export interface PaymentSessionApiInterface {
|
|
|
53165
54026
|
* @memberof PaymentSessionApiInterface
|
|
53166
54027
|
*/
|
|
53167
54028
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<InitiateNetsSessionResponseDto>;
|
|
54029
|
+
/**
|
|
54030
|
+
* 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).
|
|
54031
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54032
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54033
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
54034
|
+
* @param {*} [options] Override http request option.
|
|
54035
|
+
* @throws {RequiredError}
|
|
54036
|
+
* @memberof PaymentSessionApiInterface
|
|
54037
|
+
*/
|
|
54038
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<PaymentSessionViewDto>;
|
|
53168
54039
|
/**
|
|
53169
54040
|
* 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.
|
|
53170
54041
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -53367,6 +54238,15 @@ export interface PaymentSessionApiInterface {
|
|
|
53367
54238
|
* @memberof PaymentSessionApiInterface
|
|
53368
54239
|
*/
|
|
53369
54240
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
54241
|
+
/**
|
|
54242
|
+
* 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.
|
|
54243
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
54244
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
54245
|
+
* @param {*} [options] Override http request option.
|
|
54246
|
+
* @throws {RequiredError}
|
|
54247
|
+
* @memberof PaymentSessionApiInterface
|
|
54248
|
+
*/
|
|
54249
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
53370
54250
|
}
|
|
53371
54251
|
/**
|
|
53372
54252
|
* PaymentSessionApi - object-oriented interface
|
|
@@ -53446,6 +54326,16 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
53446
54326
|
* @memberof PaymentSessionApi
|
|
53447
54327
|
*/
|
|
53448
54328
|
initiateNetsSession(initiateNetsSessionDto: InitiateNetsSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InitiateNetsSessionResponseDto, any, {}>>;
|
|
54329
|
+
/**
|
|
54330
|
+
* 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).
|
|
54331
|
+
* @summary Start a card payment on the station\'s Nexi terminal
|
|
54332
|
+
* @param {InitiateNexiSessionDto} initiateNexiSessionDto
|
|
54333
|
+
* @param {string} [xIdempotencyKey] A UUID the app makes for this payment. A repeated key answers the session it started, without charging again.
|
|
54334
|
+
* @param {*} [options] Override http request option.
|
|
54335
|
+
* @throws {RequiredError}
|
|
54336
|
+
* @memberof PaymentSessionApi
|
|
54337
|
+
*/
|
|
54338
|
+
initiateNexiSession(initiateNexiSessionDto: InitiateNexiSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PaymentSessionViewDto, any, {}>>;
|
|
53449
54339
|
/**
|
|
53450
54340
|
* 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.
|
|
53451
54341
|
* @summary Initiate a Viva app-to-app payment session
|
|
@@ -53648,6 +54538,15 @@ export declare class PaymentSessionApi extends BaseAPI implements PaymentSession
|
|
|
53648
54538
|
* @memberof PaymentSessionApi
|
|
53649
54539
|
*/
|
|
53650
54540
|
voidManualPayment(voidManualSessionDto: VoidManualSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RecordManualPaymentResultDto, any, {}>>;
|
|
54541
|
+
/**
|
|
54542
|
+
* 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.
|
|
54543
|
+
* @summary Internal: ask Nexi about a sale once more (Cloud Task callback)
|
|
54544
|
+
* @param {NexiWaitRoundDto} nexiWaitRoundDto
|
|
54545
|
+
* @param {*} [options] Override http request option.
|
|
54546
|
+
* @throws {RequiredError}
|
|
54547
|
+
* @memberof PaymentSessionApi
|
|
54548
|
+
*/
|
|
54549
|
+
waitForNexiSession(nexiWaitRoundDto: NexiWaitRoundDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
53651
54550
|
}
|
|
53652
54551
|
/**
|
|
53653
54552
|
* PrintersApi - axios parameter creator
|