@munchi_oy/core 2.15.0 → 2.16.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 +934 -46
- 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 +1287 -48
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -4596,6 +4596,18 @@ export interface CreateMunchiGiftCardDto {
|
|
|
4596
4596
|
* @memberof CreateMunchiGiftCardDto
|
|
4597
4597
|
*/
|
|
4598
4598
|
'purchaserEmail'?: string;
|
|
4599
|
+
/**
|
|
4600
|
+
* Whether the card is emailed to purchaserEmail once it is ACTIVE: at once for a card sold ACTIVE, when its order is paid for one sold PENDING. Absent: true. Without purchaserEmail nothing is sent.
|
|
4601
|
+
* @type {boolean}
|
|
4602
|
+
* @memberof CreateMunchiGiftCardDto
|
|
4603
|
+
*/
|
|
4604
|
+
'sendEmail'?: boolean;
|
|
4605
|
+
/**
|
|
4606
|
+
* The message shown in the card\'s email, 1 to 300 characters once the spaces around it are dropped: the buyer\'s own words. Absent or only spaces: none.
|
|
4607
|
+
* @type {string}
|
|
4608
|
+
* @memberof CreateMunchiGiftCardDto
|
|
4609
|
+
*/
|
|
4610
|
+
'message'?: string;
|
|
4599
4611
|
/**
|
|
4600
4612
|
* The country code of the buyer\'s phone, 1 to 8 characters as sent; spaces around it are dropped
|
|
4601
4613
|
* @type {string}
|
|
@@ -4878,6 +4890,31 @@ export interface CreatePaymentMethodDtoGiftCardCredentials {
|
|
|
4878
4890
|
*/
|
|
4879
4891
|
'uniquePosDeviceId'?: string;
|
|
4880
4892
|
}
|
|
4893
|
+
/**
|
|
4894
|
+
*
|
|
4895
|
+
* @export
|
|
4896
|
+
* @interface CreatePaymentTerminalDto
|
|
4897
|
+
*/
|
|
4898
|
+
export interface CreatePaymentTerminalDto {
|
|
4899
|
+
/**
|
|
4900
|
+
*
|
|
4901
|
+
* @type {TerminalProvider}
|
|
4902
|
+
* @memberof CreatePaymentTerminalDto
|
|
4903
|
+
*/
|
|
4904
|
+
'provider': TerminalProvider;
|
|
4905
|
+
/**
|
|
4906
|
+
* The provider\'s own id of the terminal, trimmed: for viva the terminal ID (TID) in Viva\'s portal, digits only (16010572); for nets the terminal ID (TID), digits only (72102200); for worldline the terminal\'s serial number, letters and digits (253SKD884468). The payment is sent to the provider with this id, so it must be the id the provider knows
|
|
4907
|
+
* @type {string}
|
|
4908
|
+
* @memberof CreatePaymentTerminalDto
|
|
4909
|
+
*/
|
|
4910
|
+
'hardwareId': string;
|
|
4911
|
+
/**
|
|
4912
|
+
* The terminal\'s name, as the venue\'s staff call it
|
|
4913
|
+
* @type {string}
|
|
4914
|
+
* @memberof CreatePaymentTerminalDto
|
|
4915
|
+
*/
|
|
4916
|
+
'label': string;
|
|
4917
|
+
}
|
|
4881
4918
|
/**
|
|
4882
4919
|
*
|
|
4883
4920
|
* @export
|
|
@@ -5197,7 +5234,7 @@ export interface CreateVenueGiftCardDto {
|
|
|
5197
5234
|
*/
|
|
5198
5235
|
'note'?: string;
|
|
5199
5236
|
/**
|
|
5200
|
-
* The message shown in the card\'s email, 1 to 300 characters: the buyer\'s or the store\'s own words. Absent: none.
|
|
5237
|
+
* The message shown in the card\'s email, 1 to 300 characters once the spaces around it are dropped: the buyer\'s or the store\'s own words. Absent or only spaces: none.
|
|
5201
5238
|
* @type {string}
|
|
5202
5239
|
* @memberof CreateVenueGiftCardDto
|
|
5203
5240
|
*/
|
|
@@ -5238,6 +5275,12 @@ export interface CreateVenueGiftCardDto {
|
|
|
5238
5275
|
* @memberof CreateVenueGiftCardDto
|
|
5239
5276
|
*/
|
|
5240
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;
|
|
5241
5284
|
}
|
|
5242
5285
|
/**
|
|
5243
5286
|
*
|
|
@@ -8716,6 +8759,7 @@ export declare const GiftCardEmailKind: {
|
|
|
8716
8759
|
readonly CardAgain: "CARD_AGAIN";
|
|
8717
8760
|
readonly Expiry30: "EXPIRY_30";
|
|
8718
8761
|
readonly Expiry7: "EXPIRY_7";
|
|
8762
|
+
readonly BuyerReceipt: "BUYER_RECEIPT";
|
|
8719
8763
|
};
|
|
8720
8764
|
export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
|
|
8721
8765
|
/**
|
|
@@ -8822,6 +8866,12 @@ export interface GiftCardHistoryEventDto {
|
|
|
8822
8866
|
* @memberof GiftCardHistoryEventDto
|
|
8823
8867
|
*/
|
|
8824
8868
|
'emailKind': GiftCardEmailKind | null;
|
|
8869
|
+
/**
|
|
8870
|
+
* When the card\'s email is set to go, ISO 8601, on a SCHEDULED line (\"Scheduled for …\"); null for the others
|
|
8871
|
+
* @type {string}
|
|
8872
|
+
* @memberof GiftCardHistoryEventDto
|
|
8873
|
+
*/
|
|
8874
|
+
'scheduledFor': string | null;
|
|
8825
8875
|
/**
|
|
8826
8876
|
* When it happened, ISO 8601
|
|
8827
8877
|
* @type {string}
|
|
@@ -8846,6 +8896,8 @@ export declare const GiftCardHistoryKind: {
|
|
|
8846
8896
|
readonly Emailed: "EMAILED";
|
|
8847
8897
|
readonly EmailFailed: "EMAIL_FAILED";
|
|
8848
8898
|
readonly EmailChanged: "EMAIL_CHANGED";
|
|
8899
|
+
readonly Refunded: "REFUNDED";
|
|
8900
|
+
readonly Scheduled: "SCHEDULED";
|
|
8849
8901
|
};
|
|
8850
8902
|
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
8851
8903
|
/**
|
|
@@ -9104,6 +9156,104 @@ export interface GiftCardMovementsDto {
|
|
|
9104
9156
|
*/
|
|
9105
9157
|
'nextCursor': string | null;
|
|
9106
9158
|
}
|
|
9159
|
+
/**
|
|
9160
|
+
*
|
|
9161
|
+
* @export
|
|
9162
|
+
* @interface GiftCardOfferDto
|
|
9163
|
+
*/
|
|
9164
|
+
export interface GiftCardOfferDto {
|
|
9165
|
+
/**
|
|
9166
|
+
* 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.
|
|
9167
|
+
* @type {boolean}
|
|
9168
|
+
* @memberof GiftCardOfferDto
|
|
9169
|
+
*/
|
|
9170
|
+
'sells': boolean;
|
|
9171
|
+
/**
|
|
9172
|
+
* The amounts offered, in cents, ascending: at most 3, the smallest ones when a store saved more before; with anyAmount, buyers also see Other
|
|
9173
|
+
* @type {Array<number>}
|
|
9174
|
+
* @memberof GiftCardOfferDto
|
|
9175
|
+
*/
|
|
9176
|
+
'amounts': Array<number>;
|
|
9177
|
+
/**
|
|
9178
|
+
* Whether a buyer may choose any amount
|
|
9179
|
+
* @type {boolean}
|
|
9180
|
+
* @memberof GiftCardOfferDto
|
|
9181
|
+
*/
|
|
9182
|
+
'anyAmount': boolean;
|
|
9183
|
+
/**
|
|
9184
|
+
* The smallest amount a buyer may choose, in cents
|
|
9185
|
+
* @type {number}
|
|
9186
|
+
* @memberof GiftCardOfferDto
|
|
9187
|
+
*/
|
|
9188
|
+
'minAmount': number;
|
|
9189
|
+
/**
|
|
9190
|
+
* The largest amount a buyer may choose, in cents
|
|
9191
|
+
* @type {number}
|
|
9192
|
+
* @memberof GiftCardOfferDto
|
|
9193
|
+
*/
|
|
9194
|
+
'maxAmount': number;
|
|
9195
|
+
/**
|
|
9196
|
+
*
|
|
9197
|
+
* @type {CurrencyCode}
|
|
9198
|
+
* @memberof GiftCardOfferDto
|
|
9199
|
+
*/
|
|
9200
|
+
'currency': CurrencyCode;
|
|
9201
|
+
/**
|
|
9202
|
+
* The text printed on the card; null when none
|
|
9203
|
+
* @type {string}
|
|
9204
|
+
* @memberof GiftCardOfferDto
|
|
9205
|
+
*/
|
|
9206
|
+
'cardText': string | null;
|
|
9207
|
+
/**
|
|
9208
|
+
* The card\'s picture, an https URL; null when none
|
|
9209
|
+
* @type {string}
|
|
9210
|
+
* @memberof GiftCardOfferDto
|
|
9211
|
+
*/
|
|
9212
|
+
'imageUrl': string | null;
|
|
9213
|
+
/**
|
|
9214
|
+
* The store\'s name
|
|
9215
|
+
* @type {string}
|
|
9216
|
+
* @memberof GiftCardOfferDto
|
|
9217
|
+
*/
|
|
9218
|
+
'storeName': string;
|
|
9219
|
+
/**
|
|
9220
|
+
* How many months a card stays valid from the day its email goes; null when cards never expire
|
|
9221
|
+
* @type {number}
|
|
9222
|
+
* @memberof GiftCardOfferDto
|
|
9223
|
+
*/
|
|
9224
|
+
'validityMonths': number | null;
|
|
9225
|
+
}
|
|
9226
|
+
/**
|
|
9227
|
+
*
|
|
9228
|
+
* @export
|
|
9229
|
+
* @interface GiftCardPaymentsOnlineDto
|
|
9230
|
+
*/
|
|
9231
|
+
export interface GiftCardPaymentsOnlineDto {
|
|
9232
|
+
/**
|
|
9233
|
+
*
|
|
9234
|
+
* @type {StripeConnectionState}
|
|
9235
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9236
|
+
*/
|
|
9237
|
+
'stripe': StripeConnectionState;
|
|
9238
|
+
/**
|
|
9239
|
+
*
|
|
9240
|
+
* @type {VivaOnlineState}
|
|
9241
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9242
|
+
*/
|
|
9243
|
+
'vivaOnline': VivaOnlineState;
|
|
9244
|
+
/**
|
|
9245
|
+
* Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
|
|
9246
|
+
* @type {boolean}
|
|
9247
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9248
|
+
*/
|
|
9249
|
+
'vivaOnPos': boolean;
|
|
9250
|
+
/**
|
|
9251
|
+
* 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
|
|
9252
|
+
* @type {boolean}
|
|
9253
|
+
* @memberof GiftCardPaymentsOnlineDto
|
|
9254
|
+
*/
|
|
9255
|
+
'vivaIsv': boolean;
|
|
9256
|
+
}
|
|
9107
9257
|
/**
|
|
9108
9258
|
*
|
|
9109
9259
|
* @export
|
|
@@ -9186,6 +9336,25 @@ export interface GiftCardPeriodTotalsDtoSpent {
|
|
|
9186
9336
|
*/
|
|
9187
9337
|
'orderCount': number;
|
|
9188
9338
|
}
|
|
9339
|
+
/**
|
|
9340
|
+
*
|
|
9341
|
+
* @export
|
|
9342
|
+
* @interface GiftCardPersonDto
|
|
9343
|
+
*/
|
|
9344
|
+
export interface GiftCardPersonDto {
|
|
9345
|
+
/**
|
|
9346
|
+
* 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.
|
|
9347
|
+
* @type {string}
|
|
9348
|
+
* @memberof GiftCardPersonDto
|
|
9349
|
+
*/
|
|
9350
|
+
'name'?: string;
|
|
9351
|
+
/**
|
|
9352
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
9353
|
+
* @type {string}
|
|
9354
|
+
* @memberof GiftCardPersonDto
|
|
9355
|
+
*/
|
|
9356
|
+
'email': string;
|
|
9357
|
+
}
|
|
9189
9358
|
/**
|
|
9190
9359
|
*
|
|
9191
9360
|
* @export
|
|
@@ -9385,12 +9554,74 @@ export interface GiftCardReportDtoSpent {
|
|
|
9385
9554
|
*/
|
|
9386
9555
|
'orderCount': number;
|
|
9387
9556
|
}
|
|
9557
|
+
/**
|
|
9558
|
+
*
|
|
9559
|
+
* @export
|
|
9560
|
+
* @interface GiftCardSellingDto
|
|
9561
|
+
*/
|
|
9562
|
+
export interface GiftCardSellingDto {
|
|
9563
|
+
/**
|
|
9564
|
+
*
|
|
9565
|
+
* @type {GiftCardSellingDtoCardPayments}
|
|
9566
|
+
* @memberof GiftCardSellingDto
|
|
9567
|
+
*/
|
|
9568
|
+
'cardPayments': GiftCardSellingDtoCardPayments;
|
|
9569
|
+
/**
|
|
9570
|
+
* Whether a buyer has an amount to choose: at least one amount, or any amount
|
|
9571
|
+
* @type {boolean}
|
|
9572
|
+
* @memberof GiftCardSellingDto
|
|
9573
|
+
*/
|
|
9574
|
+
'amountsSet': boolean;
|
|
9575
|
+
/**
|
|
9576
|
+
* 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.
|
|
9577
|
+
* @type {boolean}
|
|
9578
|
+
* @memberof GiftCardSellingDto
|
|
9579
|
+
*/
|
|
9580
|
+
'ready': boolean;
|
|
9581
|
+
}
|
|
9582
|
+
/**
|
|
9583
|
+
* What the store can take card payments online with
|
|
9584
|
+
* @export
|
|
9585
|
+
* @interface GiftCardSellingDtoCardPayments
|
|
9586
|
+
*/
|
|
9587
|
+
export interface GiftCardSellingDtoCardPayments {
|
|
9588
|
+
/**
|
|
9589
|
+
*
|
|
9590
|
+
* @type {StripeConnectionState}
|
|
9591
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9592
|
+
*/
|
|
9593
|
+
'stripe': StripeConnectionState;
|
|
9594
|
+
/**
|
|
9595
|
+
*
|
|
9596
|
+
* @type {VivaOnlineState}
|
|
9597
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9598
|
+
*/
|
|
9599
|
+
'vivaOnline': VivaOnlineState;
|
|
9600
|
+
/**
|
|
9601
|
+
* Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
|
|
9602
|
+
* @type {boolean}
|
|
9603
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9604
|
+
*/
|
|
9605
|
+
'vivaOnPos': boolean;
|
|
9606
|
+
/**
|
|
9607
|
+
* 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
|
|
9608
|
+
* @type {boolean}
|
|
9609
|
+
* @memberof GiftCardSellingDtoCardPayments
|
|
9610
|
+
*/
|
|
9611
|
+
'vivaIsv': boolean;
|
|
9612
|
+
}
|
|
9388
9613
|
/**
|
|
9389
9614
|
*
|
|
9390
9615
|
* @export
|
|
9391
9616
|
* @interface GiftCardSettingsDto
|
|
9392
9617
|
*/
|
|
9393
9618
|
export interface GiftCardSettingsDto {
|
|
9619
|
+
/**
|
|
9620
|
+
* 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
|
|
9621
|
+
* @type {boolean}
|
|
9622
|
+
* @memberof GiftCardSettingsDto
|
|
9623
|
+
*/
|
|
9624
|
+
'saved': boolean;
|
|
9394
9625
|
/**
|
|
9395
9626
|
*
|
|
9396
9627
|
* @type {GiftCardSettingsDtoChannels}
|
|
@@ -9404,7 +9635,7 @@ export interface GiftCardSettingsDto {
|
|
|
9404
9635
|
*/
|
|
9405
9636
|
'availableChannels': Array<GiftCardChannel>;
|
|
9406
9637
|
/**
|
|
9407
|
-
* The amounts offered, in cents, ascending
|
|
9638
|
+
* The amounts offered, in cents, ascending: at most 3, though a store saved with more before keeps them until its next change of amounts
|
|
9408
9639
|
* @type {Array<number>}
|
|
9409
9640
|
* @memberof GiftCardSettingsDto
|
|
9410
9641
|
*/
|
|
@@ -9463,6 +9694,12 @@ export interface GiftCardSettingsDto {
|
|
|
9463
9694
|
* @memberof GiftCardSettingsDto
|
|
9464
9695
|
*/
|
|
9465
9696
|
'emailLanguage': GiftCardLanguage | null;
|
|
9697
|
+
/**
|
|
9698
|
+
* 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.
|
|
9699
|
+
* @type {boolean}
|
|
9700
|
+
* @memberof GiftCardSettingsDto
|
|
9701
|
+
*/
|
|
9702
|
+
'sellOnline': boolean;
|
|
9466
9703
|
}
|
|
9467
9704
|
/**
|
|
9468
9705
|
* Where the store\'s gift cards can be spent
|
|
@@ -15357,6 +15594,44 @@ export interface OnboardingStoresDto {
|
|
|
15357
15594
|
*/
|
|
15358
15595
|
'stores': Array<OnboardingStoreDto>;
|
|
15359
15596
|
}
|
|
15597
|
+
/**
|
|
15598
|
+
*
|
|
15599
|
+
* @export
|
|
15600
|
+
* @interface OnlineGiftCardRefundDto
|
|
15601
|
+
*/
|
|
15602
|
+
export interface OnlineGiftCardRefundDto {
|
|
15603
|
+
/**
|
|
15604
|
+
* The card\'s id
|
|
15605
|
+
* @type {string}
|
|
15606
|
+
* @memberof OnlineGiftCardRefundDto
|
|
15607
|
+
*/
|
|
15608
|
+
'cardId': string;
|
|
15609
|
+
/**
|
|
15610
|
+
* When the card was blocked for the refund, ISO 8601: the first refund\'s moment on a repeat.
|
|
15611
|
+
* @type {string}
|
|
15612
|
+
* @memberof OnlineGiftCardRefundDto
|
|
15613
|
+
*/
|
|
15614
|
+
'refundedAt': string;
|
|
15615
|
+
}
|
|
15616
|
+
/**
|
|
15617
|
+
*
|
|
15618
|
+
* @export
|
|
15619
|
+
* @interface OnlineGiftCardSaleDto
|
|
15620
|
+
*/
|
|
15621
|
+
export interface OnlineGiftCardSaleDto {
|
|
15622
|
+
/**
|
|
15623
|
+
* The card\'s id
|
|
15624
|
+
* @type {string}
|
|
15625
|
+
* @memberof OnlineGiftCardSaleDto
|
|
15626
|
+
*/
|
|
15627
|
+
'cardId': string;
|
|
15628
|
+
/**
|
|
15629
|
+
* The card\'s 6-digit code. Never shown to the buyer of a gift: only the person it is for gets it, by email.
|
|
15630
|
+
* @type {string}
|
|
15631
|
+
* @memberof OnlineGiftCardSaleDto
|
|
15632
|
+
*/
|
|
15633
|
+
'code': string;
|
|
15634
|
+
}
|
|
15360
15635
|
/**
|
|
15361
15636
|
*
|
|
15362
15637
|
* @export
|
|
@@ -22921,6 +23196,19 @@ export interface PosUpdateOrderDto {
|
|
|
22921
23196
|
*/
|
|
22922
23197
|
'isTicket'?: boolean;
|
|
22923
23198
|
}
|
|
23199
|
+
/**
|
|
23200
|
+
*
|
|
23201
|
+
* @export
|
|
23202
|
+
* @interface PosVivaMerchantDto
|
|
23203
|
+
*/
|
|
23204
|
+
export interface PosVivaMerchantDto {
|
|
23205
|
+
/**
|
|
23206
|
+
* 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.
|
|
23207
|
+
* @type {string}
|
|
23208
|
+
* @memberof PosVivaMerchantDto
|
|
23209
|
+
*/
|
|
23210
|
+
'merchantId': string | null;
|
|
23211
|
+
}
|
|
22924
23212
|
/**
|
|
22925
23213
|
*
|
|
22926
23214
|
* @export
|
|
@@ -26387,6 +26675,25 @@ export declare const RefundMode: {
|
|
|
26387
26675
|
readonly Item: "ITEM";
|
|
26388
26676
|
};
|
|
26389
26677
|
export type RefundMode = typeof RefundMode[keyof typeof RefundMode];
|
|
26678
|
+
/**
|
|
26679
|
+
*
|
|
26680
|
+
* @export
|
|
26681
|
+
* @interface RefundOnlineGiftCardSaleDto
|
|
26682
|
+
*/
|
|
26683
|
+
export interface RefundOnlineGiftCardSaleDto {
|
|
26684
|
+
/**
|
|
26685
|
+
* The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
|
|
26686
|
+
* @type {string}
|
|
26687
|
+
* @memberof RefundOnlineGiftCardSaleDto
|
|
26688
|
+
*/
|
|
26689
|
+
'orderCode': string;
|
|
26690
|
+
/**
|
|
26691
|
+
* The id of the Vendure order line that holds the gift card, 1 to 64 characters.
|
|
26692
|
+
* @type {string}
|
|
26693
|
+
* @memberof RefundOnlineGiftCardSaleDto
|
|
26694
|
+
*/
|
|
26695
|
+
'orderLineId': string;
|
|
26696
|
+
}
|
|
26390
26697
|
/**
|
|
26391
26698
|
*
|
|
26392
26699
|
* @export
|
|
@@ -26771,6 +27078,19 @@ export interface ReleasedLicenceHoldsDto {
|
|
|
26771
27078
|
*/
|
|
26772
27079
|
'nextAfterVenueId': number | null;
|
|
26773
27080
|
}
|
|
27081
|
+
/**
|
|
27082
|
+
*
|
|
27083
|
+
* @export
|
|
27084
|
+
* @interface RenamePaymentTerminalDto
|
|
27085
|
+
*/
|
|
27086
|
+
export interface RenamePaymentTerminalDto {
|
|
27087
|
+
/**
|
|
27088
|
+
* The terminal\'s new name; nothing else of the terminal changes
|
|
27089
|
+
* @type {string}
|
|
27090
|
+
* @memberof RenamePaymentTerminalDto
|
|
27091
|
+
*/
|
|
27092
|
+
'label': string;
|
|
27093
|
+
}
|
|
26774
27094
|
/**
|
|
26775
27095
|
*
|
|
26776
27096
|
* @export
|
|
@@ -30763,6 +31083,111 @@ export interface SearchUserInfoResponseDtoLinksValue {
|
|
|
30763
31083
|
*/
|
|
30764
31084
|
'method'?: string;
|
|
30765
31085
|
}
|
|
31086
|
+
/**
|
|
31087
|
+
*
|
|
31088
|
+
* @export
|
|
31089
|
+
* @interface SellGiftCardOnlineDto
|
|
31090
|
+
*/
|
|
31091
|
+
export interface SellGiftCardOnlineDto {
|
|
31092
|
+
/**
|
|
31093
|
+
* The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
|
|
31094
|
+
* @type {string}
|
|
31095
|
+
* @memberof SellGiftCardOnlineDto
|
|
31096
|
+
*/
|
|
31097
|
+
'orderCode': string;
|
|
31098
|
+
/**
|
|
31099
|
+
* The id of the Vendure order line that holds the gift card, 1 to 64 characters.
|
|
31100
|
+
* @type {string}
|
|
31101
|
+
* @memberof SellGiftCardOnlineDto
|
|
31102
|
+
*/
|
|
31103
|
+
'orderLineId': string;
|
|
31104
|
+
/**
|
|
31105
|
+
* The store that sold it: its orderingBusinessId, the Vendure seller of the storefront channel the order was placed on.
|
|
31106
|
+
* @type {number}
|
|
31107
|
+
* @memberof SellGiftCardOnlineDto
|
|
31108
|
+
*/
|
|
31109
|
+
'orderingBusinessId': number;
|
|
31110
|
+
/**
|
|
31111
|
+
* 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.
|
|
31112
|
+
* @type {number}
|
|
31113
|
+
* @memberof SellGiftCardOnlineDto
|
|
31114
|
+
*/
|
|
31115
|
+
'amount': number;
|
|
31116
|
+
/**
|
|
31117
|
+
*
|
|
31118
|
+
* @type {CurrencyCode}
|
|
31119
|
+
* @memberof SellGiftCardOnlineDto
|
|
31120
|
+
*/
|
|
31121
|
+
'currency': CurrencyCode;
|
|
31122
|
+
/**
|
|
31123
|
+
*
|
|
31124
|
+
* @type {SellGiftCardOnlineDtoBuyer}
|
|
31125
|
+
* @memberof SellGiftCardOnlineDto
|
|
31126
|
+
*/
|
|
31127
|
+
'buyer': SellGiftCardOnlineDtoBuyer;
|
|
31128
|
+
/**
|
|
31129
|
+
*
|
|
31130
|
+
* @type {SellGiftCardOnlineDtoRecipient}
|
|
31131
|
+
* @memberof SellGiftCardOnlineDto
|
|
31132
|
+
*/
|
|
31133
|
+
'recipient'?: SellGiftCardOnlineDtoRecipient;
|
|
31134
|
+
/**
|
|
31135
|
+
* The buyer\'s message, shown in the card\'s email, 1 to 300 characters. Absent: none.
|
|
31136
|
+
* @type {string}
|
|
31137
|
+
* @memberof SellGiftCardOnlineDto
|
|
31138
|
+
*/
|
|
31139
|
+
'message'?: string;
|
|
31140
|
+
/**
|
|
31141
|
+
*
|
|
31142
|
+
* @type {GiftCardLanguage}
|
|
31143
|
+
* @memberof SellGiftCardOnlineDto
|
|
31144
|
+
*/
|
|
31145
|
+
'language'?: GiftCardLanguage;
|
|
31146
|
+
/**
|
|
31147
|
+
* 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.
|
|
31148
|
+
* @type {string}
|
|
31149
|
+
* @memberof SellGiftCardOnlineDto
|
|
31150
|
+
*/
|
|
31151
|
+
'sendAt'?: string;
|
|
31152
|
+
}
|
|
31153
|
+
/**
|
|
31154
|
+
* Who bought the card: its receipt goes to this email, and the card too when it is for them.
|
|
31155
|
+
* @export
|
|
31156
|
+
* @interface SellGiftCardOnlineDtoBuyer
|
|
31157
|
+
*/
|
|
31158
|
+
export interface SellGiftCardOnlineDtoBuyer {
|
|
31159
|
+
/**
|
|
31160
|
+
* 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.
|
|
31161
|
+
* @type {string}
|
|
31162
|
+
* @memberof SellGiftCardOnlineDtoBuyer
|
|
31163
|
+
*/
|
|
31164
|
+
'name'?: string;
|
|
31165
|
+
/**
|
|
31166
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
31167
|
+
* @type {string}
|
|
31168
|
+
* @memberof SellGiftCardOnlineDtoBuyer
|
|
31169
|
+
*/
|
|
31170
|
+
'email': string;
|
|
31171
|
+
}
|
|
31172
|
+
/**
|
|
31173
|
+
* 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.
|
|
31174
|
+
* @export
|
|
31175
|
+
* @interface SellGiftCardOnlineDtoRecipient
|
|
31176
|
+
*/
|
|
31177
|
+
export interface SellGiftCardOnlineDtoRecipient {
|
|
31178
|
+
/**
|
|
31179
|
+
* 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.
|
|
31180
|
+
* @type {string}
|
|
31181
|
+
* @memberof SellGiftCardOnlineDtoRecipient
|
|
31182
|
+
*/
|
|
31183
|
+
'name'?: string;
|
|
31184
|
+
/**
|
|
31185
|
+
* The person\'s email, at most 254 characters once the spaces around it are dropped.
|
|
31186
|
+
* @type {string}
|
|
31187
|
+
* @memberof SellGiftCardOnlineDtoRecipient
|
|
31188
|
+
*/
|
|
31189
|
+
'email': string;
|
|
31190
|
+
}
|
|
30766
31191
|
/**
|
|
30767
31192
|
*
|
|
30768
31193
|
* @export
|
|
@@ -31816,6 +32241,17 @@ export interface StripeConfigResponseDto {
|
|
|
31816
32241
|
*/
|
|
31817
32242
|
'locationId': string | null;
|
|
31818
32243
|
}
|
|
32244
|
+
/**
|
|
32245
|
+
*
|
|
32246
|
+
* @export
|
|
32247
|
+
* @enum {string}
|
|
32248
|
+
*/
|
|
32249
|
+
export declare const StripeConnectionState: {
|
|
32250
|
+
readonly Active: "active";
|
|
32251
|
+
readonly Pending: "pending";
|
|
32252
|
+
readonly None: "none";
|
|
32253
|
+
};
|
|
32254
|
+
export type StripeConnectionState = typeof StripeConnectionState[keyof typeof StripeConnectionState];
|
|
31819
32255
|
/**
|
|
31820
32256
|
*
|
|
31821
32257
|
* @export
|
|
@@ -33441,6 +33877,17 @@ export declare const TerminalConnectionType: {
|
|
|
33441
33877
|
readonly Network: "NETWORK";
|
|
33442
33878
|
};
|
|
33443
33879
|
export type TerminalConnectionType = typeof TerminalConnectionType[keyof typeof TerminalConnectionType];
|
|
33880
|
+
/**
|
|
33881
|
+
*
|
|
33882
|
+
* @export
|
|
33883
|
+
* @enum {string}
|
|
33884
|
+
*/
|
|
33885
|
+
export declare const TerminalProvider: {
|
|
33886
|
+
readonly Viva: "viva";
|
|
33887
|
+
readonly Nets: "nets";
|
|
33888
|
+
readonly Worldline: "worldline";
|
|
33889
|
+
};
|
|
33890
|
+
export type TerminalProvider = typeof TerminalProvider[keyof typeof TerminalProvider];
|
|
33444
33891
|
/**
|
|
33445
33892
|
*
|
|
33446
33893
|
* @export
|
|
@@ -35941,7 +36388,7 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
35941
36388
|
*/
|
|
35942
36389
|
'channels'?: UpdateGiftCardSettingsDtoChannels;
|
|
35943
36390
|
/**
|
|
35944
|
-
* The amounts offered, in cents: 1 to
|
|
36391
|
+
* The amounts offered, in cents: 1 to 3 different amounts, each 100 to 100000 (with anyAmount, buyers also see Other). Stored ascending. Absent: unchanged.
|
|
35945
36392
|
* @type {Array<number>}
|
|
35946
36393
|
* @memberof UpdateGiftCardSettingsDto
|
|
35947
36394
|
*/
|
|
@@ -36000,6 +36447,12 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36000
36447
|
* @memberof UpdateGiftCardSettingsDto
|
|
36001
36448
|
*/
|
|
36002
36449
|
'emailLanguage'?: GiftCardLanguage | null;
|
|
36450
|
+
/**
|
|
36451
|
+
* 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.
|
|
36452
|
+
* @type {boolean}
|
|
36453
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36454
|
+
*/
|
|
36455
|
+
'sellOnline'?: boolean;
|
|
36003
36456
|
}
|
|
36004
36457
|
/**
|
|
36005
36458
|
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
@@ -36499,7 +36952,7 @@ export interface UpdateTableStatusDto {
|
|
|
36499
36952
|
*/
|
|
36500
36953
|
export interface UpdateVenueGiftCardDto {
|
|
36501
36954
|
/**
|
|
36502
|
-
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
36955
|
+
* 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.
|
|
36503
36956
|
* @type {string}
|
|
36504
36957
|
* @memberof UpdateVenueGiftCardDto
|
|
36505
36958
|
*/
|
|
@@ -36509,7 +36962,25 @@ export interface UpdateVenueGiftCardDto {
|
|
|
36509
36962
|
* @type {GiftCardLanguage}
|
|
36510
36963
|
* @memberof UpdateVenueGiftCardDto
|
|
36511
36964
|
*/
|
|
36512
|
-
'language'?: GiftCardLanguage;
|
|
36965
|
+
'language'?: GiftCardLanguage | null;
|
|
36966
|
+
/**
|
|
36967
|
+
* 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.
|
|
36968
|
+
* @type {string}
|
|
36969
|
+
* @memberof UpdateVenueGiftCardDto
|
|
36970
|
+
*/
|
|
36971
|
+
'sendAt'?: string | null;
|
|
36972
|
+
/**
|
|
36973
|
+
* 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.
|
|
36974
|
+
* @type {string}
|
|
36975
|
+
* @memberof UpdateVenueGiftCardDto
|
|
36976
|
+
*/
|
|
36977
|
+
'recipientEmail'?: string;
|
|
36978
|
+
/**
|
|
36979
|
+
* 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.
|
|
36980
|
+
* @type {string}
|
|
36981
|
+
* @memberof UpdateVenueGiftCardDto
|
|
36982
|
+
*/
|
|
36983
|
+
'recipientName'?: string;
|
|
36513
36984
|
}
|
|
36514
36985
|
/**
|
|
36515
36986
|
*
|
|
@@ -37753,6 +38224,24 @@ export interface VenueGiftCardDetailDto {
|
|
|
37753
38224
|
* @memberof VenueGiftCardDetailDto
|
|
37754
38225
|
*/
|
|
37755
38226
|
'language': GiftCardLanguage | null;
|
|
38227
|
+
/**
|
|
38228
|
+
* When the card\'s email is set to go, ISO 8601: a day the dashboard or the online buyer chose; null for at once
|
|
38229
|
+
* @type {string}
|
|
38230
|
+
* @memberof VenueGiftCardDetailDto
|
|
38231
|
+
*/
|
|
38232
|
+
'sendAt': string | null;
|
|
38233
|
+
/**
|
|
38234
|
+
* 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
|
|
38235
|
+
* @type {string}
|
|
38236
|
+
* @memberof VenueGiftCardDetailDto
|
|
38237
|
+
*/
|
|
38238
|
+
'recipientName': string | null;
|
|
38239
|
+
/**
|
|
38240
|
+
* Where an online gift\'s card email and reminders go; null for every other card, whose emails go to buyerEmail
|
|
38241
|
+
* @type {string}
|
|
38242
|
+
* @memberof VenueGiftCardDetailDto
|
|
38243
|
+
*/
|
|
38244
|
+
'recipientEmail': string | null;
|
|
37756
38245
|
/**
|
|
37757
38246
|
*
|
|
37758
38247
|
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
@@ -38063,7 +38552,7 @@ export interface VenuePaymentTerminalDto {
|
|
|
38063
38552
|
*/
|
|
38064
38553
|
export interface VenuePaymentTerminalsDto {
|
|
38065
38554
|
/**
|
|
38066
|
-
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
|
|
38555
|
+
* The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it at its provider, or once Munchi ops added it
|
|
38067
38556
|
* @type {Array<VenuePaymentTerminalDto>}
|
|
38068
38557
|
* @memberof VenuePaymentTerminalsDto
|
|
38069
38558
|
*/
|
|
@@ -39146,6 +39635,16 @@ export declare const VivaEventId: {
|
|
|
39146
39635
|
readonly NUMBER_7005: 7005;
|
|
39147
39636
|
};
|
|
39148
39637
|
export type VivaEventId = typeof VivaEventId[keyof typeof VivaEventId];
|
|
39638
|
+
/**
|
|
39639
|
+
*
|
|
39640
|
+
* @export
|
|
39641
|
+
* @enum {string}
|
|
39642
|
+
*/
|
|
39643
|
+
export declare const VivaOnlineState: {
|
|
39644
|
+
readonly Active: "active";
|
|
39645
|
+
readonly None: "none";
|
|
39646
|
+
};
|
|
39647
|
+
export type VivaOnlineState = typeof VivaOnlineState[keyof typeof VivaOnlineState];
|
|
39149
39648
|
/**
|
|
39150
39649
|
*
|
|
39151
39650
|
* @export
|
|
@@ -46107,11 +46606,11 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46107
46606
|
*/
|
|
46108
46607
|
blockVenueGiftCard: (businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46109
46608
|
/**
|
|
46110
|
-
* 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.
|
|
46609
|
+
* 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.
|
|
46111
46610
|
* @summary Make a gift card by hand, given for free
|
|
46112
46611
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46113
46612
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46114
|
-
* @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.
|
|
46613
|
+
* @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.
|
|
46115
46614
|
* @param {*} [options] Override http request option.
|
|
46116
46615
|
* @throws {RequiredError}
|
|
46117
46616
|
*/
|
|
@@ -46145,6 +46644,14 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46145
46644
|
* @throws {RequiredError}
|
|
46146
46645
|
*/
|
|
46147
46646
|
getVenueGiftCardReport: (businessId: number, from: string, to: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46647
|
+
/**
|
|
46648
|
+
* 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.
|
|
46649
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
46650
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46651
|
+
* @param {*} [options] Override http request option.
|
|
46652
|
+
* @throws {RequiredError}
|
|
46653
|
+
*/
|
|
46654
|
+
getVenueGiftCardSelling: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46148
46655
|
/**
|
|
46149
46656
|
* 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.
|
|
46150
46657
|
* @summary Read a store\'s gift card settings
|
|
@@ -46172,7 +46679,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46172
46679
|
* 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.
|
|
46173
46680
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46174
46681
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46175
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
46682
|
+
* @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.
|
|
46176
46683
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46177
46684
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46178
46685
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46182,7 +46689,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46182
46689
|
*/
|
|
46183
46690
|
listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46184
46691
|
/**
|
|
46185
|
-
* 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.
|
|
46692
|
+
* 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.
|
|
46186
46693
|
* @summary Unblock a gift card
|
|
46187
46694
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46188
46695
|
* @param {string} cardId The card\'s id
|
|
@@ -46191,8 +46698,8 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46191
46698
|
*/
|
|
46192
46699
|
unblockVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46193
46700
|
/**
|
|
46194
|
-
*
|
|
46195
|
-
* @summary Correct a gift card\'s email address
|
|
46701
|
+
* 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.
|
|
46702
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46196
46703
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46197
46704
|
* @param {string} cardId The card\'s id
|
|
46198
46705
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46201,7 +46708,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46201
46708
|
*/
|
|
46202
46709
|
updateVenueGiftCard: (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46203
46710
|
/**
|
|
46204
|
-
* 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.
|
|
46711
|
+
* 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.
|
|
46205
46712
|
* @summary Change a store\'s gift card settings
|
|
46206
46713
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46207
46714
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46235,11 +46742,11 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46235
46742
|
*/
|
|
46236
46743
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46237
46744
|
/**
|
|
46238
|
-
* 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.
|
|
46745
|
+
* 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.
|
|
46239
46746
|
* @summary Make a gift card by hand, given for free
|
|
46240
46747
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46241
46748
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46242
|
-
* @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.
|
|
46749
|
+
* @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.
|
|
46243
46750
|
* @param {*} [options] Override http request option.
|
|
46244
46751
|
* @throws {RequiredError}
|
|
46245
46752
|
*/
|
|
@@ -46273,6 +46780,14 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46273
46780
|
* @throws {RequiredError}
|
|
46274
46781
|
*/
|
|
46275
46782
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardReportDto>>;
|
|
46783
|
+
/**
|
|
46784
|
+
* 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.
|
|
46785
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
46786
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46787
|
+
* @param {*} [options] Override http request option.
|
|
46788
|
+
* @throws {RequiredError}
|
|
46789
|
+
*/
|
|
46790
|
+
getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSellingDto>>;
|
|
46276
46791
|
/**
|
|
46277
46792
|
* 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.
|
|
46278
46793
|
* @summary Read a store\'s gift card settings
|
|
@@ -46300,7 +46815,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46300
46815
|
* 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.
|
|
46301
46816
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46302
46817
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46303
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
46818
|
+
* @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.
|
|
46304
46819
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46305
46820
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46306
46821
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46310,7 +46825,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46310
46825
|
*/
|
|
46311
46826
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
|
|
46312
46827
|
/**
|
|
46313
|
-
* 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.
|
|
46828
|
+
* 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.
|
|
46314
46829
|
* @summary Unblock a gift card
|
|
46315
46830
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46316
46831
|
* @param {string} cardId The card\'s id
|
|
@@ -46319,8 +46834,8 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46319
46834
|
*/
|
|
46320
46835
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46321
46836
|
/**
|
|
46322
|
-
*
|
|
46323
|
-
* @summary Correct a gift card\'s email address
|
|
46837
|
+
* 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.
|
|
46838
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46324
46839
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46325
46840
|
* @param {string} cardId The card\'s id
|
|
46326
46841
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46329,7 +46844,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46329
46844
|
*/
|
|
46330
46845
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46331
46846
|
/**
|
|
46332
|
-
* 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.
|
|
46847
|
+
* 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.
|
|
46333
46848
|
* @summary Change a store\'s gift card settings
|
|
46334
46849
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46335
46850
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46363,11 +46878,11 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46363
46878
|
*/
|
|
46364
46879
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46365
46880
|
/**
|
|
46366
|
-
* 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.
|
|
46881
|
+
* 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.
|
|
46367
46882
|
* @summary Make a gift card by hand, given for free
|
|
46368
46883
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46369
46884
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46370
|
-
* @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.
|
|
46885
|
+
* @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.
|
|
46371
46886
|
* @param {*} [options] Override http request option.
|
|
46372
46887
|
* @throws {RequiredError}
|
|
46373
46888
|
*/
|
|
@@ -46401,6 +46916,14 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46401
46916
|
* @throws {RequiredError}
|
|
46402
46917
|
*/
|
|
46403
46918
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: any): AxiosPromise<GiftCardReportDto>;
|
|
46919
|
+
/**
|
|
46920
|
+
* 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.
|
|
46921
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
46922
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46923
|
+
* @param {*} [options] Override http request option.
|
|
46924
|
+
* @throws {RequiredError}
|
|
46925
|
+
*/
|
|
46926
|
+
getVenueGiftCardSelling(businessId: number, options?: any): AxiosPromise<GiftCardSellingDto>;
|
|
46404
46927
|
/**
|
|
46405
46928
|
* 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.
|
|
46406
46929
|
* @summary Read a store\'s gift card settings
|
|
@@ -46428,7 +46951,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46428
46951
|
* 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.
|
|
46429
46952
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46430
46953
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46431
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
46954
|
+
* @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.
|
|
46432
46955
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46433
46956
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46434
46957
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46438,7 +46961,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46438
46961
|
*/
|
|
46439
46962
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto>;
|
|
46440
46963
|
/**
|
|
46441
|
-
* 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.
|
|
46964
|
+
* 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.
|
|
46442
46965
|
* @summary Unblock a gift card
|
|
46443
46966
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46444
46967
|
* @param {string} cardId The card\'s id
|
|
@@ -46447,8 +46970,8 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46447
46970
|
*/
|
|
46448
46971
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46449
46972
|
/**
|
|
46450
|
-
*
|
|
46451
|
-
* @summary Correct a gift card\'s email address
|
|
46973
|
+
* 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.
|
|
46974
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46452
46975
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46453
46976
|
* @param {string} cardId The card\'s id
|
|
46454
46977
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46457,7 +46980,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46457
46980
|
*/
|
|
46458
46981
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46459
46982
|
/**
|
|
46460
|
-
* 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.
|
|
46983
|
+
* 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.
|
|
46461
46984
|
* @summary Change a store\'s gift card settings
|
|
46462
46985
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46463
46986
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46494,11 +47017,11 @@ export interface GiftCardsApiInterface {
|
|
|
46494
47017
|
*/
|
|
46495
47018
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46496
47019
|
/**
|
|
46497
|
-
* 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.
|
|
47020
|
+
* 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.
|
|
46498
47021
|
* @summary Make a gift card by hand, given for free
|
|
46499
47022
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46500
47023
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46501
|
-
* @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.
|
|
47024
|
+
* @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.
|
|
46502
47025
|
* @param {*} [options] Override http request option.
|
|
46503
47026
|
* @throws {RequiredError}
|
|
46504
47027
|
* @memberof GiftCardsApiInterface
|
|
@@ -46536,6 +47059,15 @@ export interface GiftCardsApiInterface {
|
|
|
46536
47059
|
* @memberof GiftCardsApiInterface
|
|
46537
47060
|
*/
|
|
46538
47061
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<GiftCardReportDto>;
|
|
47062
|
+
/**
|
|
47063
|
+
* 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.
|
|
47064
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
47065
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
47066
|
+
* @param {*} [options] Override http request option.
|
|
47067
|
+
* @throws {RequiredError}
|
|
47068
|
+
* @memberof GiftCardsApiInterface
|
|
47069
|
+
*/
|
|
47070
|
+
getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSellingDto>;
|
|
46539
47071
|
/**
|
|
46540
47072
|
* 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.
|
|
46541
47073
|
* @summary Read a store\'s gift card settings
|
|
@@ -46565,7 +47097,7 @@ export interface GiftCardsApiInterface {
|
|
|
46565
47097
|
* 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.
|
|
46566
47098
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46567
47099
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46568
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
47100
|
+
* @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.
|
|
46569
47101
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46570
47102
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46571
47103
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46576,7 +47108,7 @@ export interface GiftCardsApiInterface {
|
|
|
46576
47108
|
*/
|
|
46577
47109
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
46578
47110
|
/**
|
|
46579
|
-
* 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.
|
|
47111
|
+
* 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.
|
|
46580
47112
|
* @summary Unblock a gift card
|
|
46581
47113
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46582
47114
|
* @param {string} cardId The card\'s id
|
|
@@ -46586,8 +47118,8 @@ export interface GiftCardsApiInterface {
|
|
|
46586
47118
|
*/
|
|
46587
47119
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46588
47120
|
/**
|
|
46589
|
-
*
|
|
46590
|
-
* @summary Correct a gift card\'s email address
|
|
47121
|
+
* 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.
|
|
47122
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46591
47123
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46592
47124
|
* @param {string} cardId The card\'s id
|
|
46593
47125
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46597,7 +47129,7 @@ export interface GiftCardsApiInterface {
|
|
|
46597
47129
|
*/
|
|
46598
47130
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46599
47131
|
/**
|
|
46600
|
-
* 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.
|
|
47132
|
+
* 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.
|
|
46601
47133
|
* @summary Change a store\'s gift card settings
|
|
46602
47134
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46603
47135
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46636,11 +47168,11 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46636
47168
|
*/
|
|
46637
47169
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46638
47170
|
/**
|
|
46639
|
-
* 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.
|
|
47171
|
+
* 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.
|
|
46640
47172
|
* @summary Make a gift card by hand, given for free
|
|
46641
47173
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46642
47174
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46643
|
-
* @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.
|
|
47175
|
+
* @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.
|
|
46644
47176
|
* @param {*} [options] Override http request option.
|
|
46645
47177
|
* @throws {RequiredError}
|
|
46646
47178
|
* @memberof GiftCardsApi
|
|
@@ -46678,6 +47210,15 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46678
47210
|
* @memberof GiftCardsApi
|
|
46679
47211
|
*/
|
|
46680
47212
|
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardReportDto, any, {}>>;
|
|
47213
|
+
/**
|
|
47214
|
+
* 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.
|
|
47215
|
+
* @summary Read a store\'s checklist for selling gift cards online
|
|
47216
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
47217
|
+
* @param {*} [options] Override http request option.
|
|
47218
|
+
* @throws {RequiredError}
|
|
47219
|
+
* @memberof GiftCardsApi
|
|
47220
|
+
*/
|
|
47221
|
+
getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardSellingDto, any, {}>>;
|
|
46681
47222
|
/**
|
|
46682
47223
|
* 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.
|
|
46683
47224
|
* @summary Read a store\'s gift card settings
|
|
@@ -46707,7 +47248,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46707
47248
|
* 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.
|
|
46708
47249
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46709
47250
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46710
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
47251
|
+
* @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.
|
|
46711
47252
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46712
47253
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46713
47254
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46718,7 +47259,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46718
47259
|
*/
|
|
46719
47260
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
|
|
46720
47261
|
/**
|
|
46721
|
-
* 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.
|
|
47262
|
+
* 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.
|
|
46722
47263
|
* @summary Unblock a gift card
|
|
46723
47264
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46724
47265
|
* @param {string} cardId The card\'s id
|
|
@@ -46728,8 +47269,8 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46728
47269
|
*/
|
|
46729
47270
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46730
47271
|
/**
|
|
46731
|
-
*
|
|
46732
|
-
* @summary Correct a gift card\'s email address
|
|
47272
|
+
* 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.
|
|
47273
|
+
* @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
|
|
46733
47274
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46734
47275
|
* @param {string} cardId The card\'s id
|
|
46735
47276
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46739,7 +47280,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46739
47280
|
*/
|
|
46740
47281
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46741
47282
|
/**
|
|
46742
|
-
* 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.
|
|
47283
|
+
* 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.
|
|
46743
47284
|
* @summary Change a store\'s gift card settings
|
|
46744
47285
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46745
47286
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -47472,6 +48013,207 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
47472
48013
|
*/
|
|
47473
48014
|
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, {}>>;
|
|
47474
48015
|
}
|
|
48016
|
+
/**
|
|
48017
|
+
* InternalGiftCardsApi - axios parameter creator
|
|
48018
|
+
* @export
|
|
48019
|
+
*/
|
|
48020
|
+
export declare const InternalGiftCardsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
48021
|
+
/**
|
|
48022
|
+
* 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.
|
|
48023
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48024
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48025
|
+
* @param {*} [options] Override http request option.
|
|
48026
|
+
* @throws {RequiredError}
|
|
48027
|
+
*/
|
|
48028
|
+
getVenueGiftCardOffer: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48029
|
+
/**
|
|
48030
|
+
* 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.
|
|
48031
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48032
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48033
|
+
* @param {*} [options] Override http request option.
|
|
48034
|
+
* @throws {RequiredError}
|
|
48035
|
+
*/
|
|
48036
|
+
getVenuePosVivaMerchant: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48037
|
+
/**
|
|
48038
|
+
* 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.
|
|
48039
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48040
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48041
|
+
* @param {*} [options] Override http request option.
|
|
48042
|
+
* @throws {RequiredError}
|
|
48043
|
+
*/
|
|
48044
|
+
refundOnlineGiftCardSale: (refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48045
|
+
/**
|
|
48046
|
+
* 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.
|
|
48047
|
+
* @summary Make the gift card an online order line paid for
|
|
48048
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48049
|
+
* @param {*} [options] Override http request option.
|
|
48050
|
+
* @throws {RequiredError}
|
|
48051
|
+
*/
|
|
48052
|
+
sellGiftCardOnline: (sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
48053
|
+
};
|
|
48054
|
+
/**
|
|
48055
|
+
* InternalGiftCardsApi - functional programming interface
|
|
48056
|
+
* @export
|
|
48057
|
+
*/
|
|
48058
|
+
export declare const InternalGiftCardsApiFp: (configuration?: Configuration) => {
|
|
48059
|
+
/**
|
|
48060
|
+
* 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.
|
|
48061
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48062
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48063
|
+
* @param {*} [options] Override http request option.
|
|
48064
|
+
* @throws {RequiredError}
|
|
48065
|
+
*/
|
|
48066
|
+
getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardOfferDto>>;
|
|
48067
|
+
/**
|
|
48068
|
+
* 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.
|
|
48069
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48070
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48071
|
+
* @param {*} [options] Override http request option.
|
|
48072
|
+
* @throws {RequiredError}
|
|
48073
|
+
*/
|
|
48074
|
+
getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosVivaMerchantDto>>;
|
|
48075
|
+
/**
|
|
48076
|
+
* 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.
|
|
48077
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48078
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48079
|
+
* @param {*} [options] Override http request option.
|
|
48080
|
+
* @throws {RequiredError}
|
|
48081
|
+
*/
|
|
48082
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardRefundDto>>;
|
|
48083
|
+
/**
|
|
48084
|
+
* 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.
|
|
48085
|
+
* @summary Make the gift card an online order line paid for
|
|
48086
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48087
|
+
* @param {*} [options] Override http request option.
|
|
48088
|
+
* @throws {RequiredError}
|
|
48089
|
+
*/
|
|
48090
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardSaleDto>>;
|
|
48091
|
+
};
|
|
48092
|
+
/**
|
|
48093
|
+
* InternalGiftCardsApi - factory interface
|
|
48094
|
+
* @export
|
|
48095
|
+
*/
|
|
48096
|
+
export declare const InternalGiftCardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
48097
|
+
/**
|
|
48098
|
+
* 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.
|
|
48099
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48100
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48101
|
+
* @param {*} [options] Override http request option.
|
|
48102
|
+
* @throws {RequiredError}
|
|
48103
|
+
*/
|
|
48104
|
+
getVenueGiftCardOffer(businessId: number, options?: any): AxiosPromise<GiftCardOfferDto>;
|
|
48105
|
+
/**
|
|
48106
|
+
* 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.
|
|
48107
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48108
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48109
|
+
* @param {*} [options] Override http request option.
|
|
48110
|
+
* @throws {RequiredError}
|
|
48111
|
+
*/
|
|
48112
|
+
getVenuePosVivaMerchant(businessId: number, options?: any): AxiosPromise<PosVivaMerchantDto>;
|
|
48113
|
+
/**
|
|
48114
|
+
* 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.
|
|
48115
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48116
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48117
|
+
* @param {*} [options] Override http request option.
|
|
48118
|
+
* @throws {RequiredError}
|
|
48119
|
+
*/
|
|
48120
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: any): AxiosPromise<OnlineGiftCardRefundDto>;
|
|
48121
|
+
/**
|
|
48122
|
+
* 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.
|
|
48123
|
+
* @summary Make the gift card an online order line paid for
|
|
48124
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48125
|
+
* @param {*} [options] Override http request option.
|
|
48126
|
+
* @throws {RequiredError}
|
|
48127
|
+
*/
|
|
48128
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: any): AxiosPromise<OnlineGiftCardSaleDto>;
|
|
48129
|
+
};
|
|
48130
|
+
/**
|
|
48131
|
+
* InternalGiftCardsApi - interface
|
|
48132
|
+
* @export
|
|
48133
|
+
* @interface InternalGiftCardsApi
|
|
48134
|
+
*/
|
|
48135
|
+
export interface InternalGiftCardsApiInterface {
|
|
48136
|
+
/**
|
|
48137
|
+
* 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.
|
|
48138
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48139
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48140
|
+
* @param {*} [options] Override http request option.
|
|
48141
|
+
* @throws {RequiredError}
|
|
48142
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48143
|
+
*/
|
|
48144
|
+
getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardOfferDto>;
|
|
48145
|
+
/**
|
|
48146
|
+
* 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.
|
|
48147
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48148
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48149
|
+
* @param {*} [options] Override http request option.
|
|
48150
|
+
* @throws {RequiredError}
|
|
48151
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48152
|
+
*/
|
|
48153
|
+
getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosVivaMerchantDto>;
|
|
48154
|
+
/**
|
|
48155
|
+
* 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.
|
|
48156
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48157
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48158
|
+
* @param {*} [options] Override http request option.
|
|
48159
|
+
* @throws {RequiredError}
|
|
48160
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48161
|
+
*/
|
|
48162
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardRefundDto>;
|
|
48163
|
+
/**
|
|
48164
|
+
* 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.
|
|
48165
|
+
* @summary Make the gift card an online order line paid for
|
|
48166
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48167
|
+
* @param {*} [options] Override http request option.
|
|
48168
|
+
* @throws {RequiredError}
|
|
48169
|
+
* @memberof InternalGiftCardsApiInterface
|
|
48170
|
+
*/
|
|
48171
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardSaleDto>;
|
|
48172
|
+
}
|
|
48173
|
+
/**
|
|
48174
|
+
* InternalGiftCardsApi - object-oriented interface
|
|
48175
|
+
* @export
|
|
48176
|
+
* @class InternalGiftCardsApi
|
|
48177
|
+
* @extends {BaseAPI}
|
|
48178
|
+
*/
|
|
48179
|
+
export declare class InternalGiftCardsApi extends BaseAPI implements InternalGiftCardsApiInterface {
|
|
48180
|
+
/**
|
|
48181
|
+
* 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.
|
|
48182
|
+
* @summary Read what a store\'s online store offers of its gift cards
|
|
48183
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48184
|
+
* @param {*} [options] Override http request option.
|
|
48185
|
+
* @throws {RequiredError}
|
|
48186
|
+
* @memberof InternalGiftCardsApi
|
|
48187
|
+
*/
|
|
48188
|
+
getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardOfferDto, any, {}>>;
|
|
48189
|
+
/**
|
|
48190
|
+
* 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.
|
|
48191
|
+
* @summary Read the Viva merchant a store\'s POS takes card payments with
|
|
48192
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
48193
|
+
* @param {*} [options] Override http request option.
|
|
48194
|
+
* @throws {RequiredError}
|
|
48195
|
+
* @memberof InternalGiftCardsApi
|
|
48196
|
+
*/
|
|
48197
|
+
getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosVivaMerchantDto, any, {}>>;
|
|
48198
|
+
/**
|
|
48199
|
+
* 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.
|
|
48200
|
+
* @summary Block the gift card of an online order line before its order is refunded
|
|
48201
|
+
* @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
|
|
48202
|
+
* @param {*} [options] Override http request option.
|
|
48203
|
+
* @throws {RequiredError}
|
|
48204
|
+
* @memberof InternalGiftCardsApi
|
|
48205
|
+
*/
|
|
48206
|
+
refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OnlineGiftCardRefundDto, any, {}>>;
|
|
48207
|
+
/**
|
|
48208
|
+
* 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.
|
|
48209
|
+
* @summary Make the gift card an online order line paid for
|
|
48210
|
+
* @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
|
|
48211
|
+
* @param {*} [options] Override http request option.
|
|
48212
|
+
* @throws {RequiredError}
|
|
48213
|
+
* @memberof InternalGiftCardsApi
|
|
48214
|
+
*/
|
|
48215
|
+
sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OnlineGiftCardSaleDto, any, {}>>;
|
|
48216
|
+
}
|
|
47475
48217
|
/**
|
|
47476
48218
|
* InvoiceCompaniesApi - axios parameter creator
|
|
47477
48219
|
* @export
|
|
@@ -59782,6 +60524,15 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
59782
60524
|
* @throws {RequiredError}
|
|
59783
60525
|
*/
|
|
59784
60526
|
claimVenueKiosk: (businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60527
|
+
/**
|
|
60528
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60529
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60530
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60531
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60532
|
+
* @param {*} [options] Override http request option.
|
|
60533
|
+
* @throws {RequiredError}
|
|
60534
|
+
*/
|
|
60535
|
+
createVenuePaymentTerminal: (businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59785
60536
|
/**
|
|
59786
60537
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59787
60538
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59801,7 +60552,7 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
59801
60552
|
*/
|
|
59802
60553
|
listVenueKiosks: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59803
60554
|
/**
|
|
59804
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60555
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59805
60556
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59806
60557
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59807
60558
|
* @param {*} [options] Override http request option.
|
|
@@ -59817,6 +60568,25 @@ export declare const VenueKiosksApiAxiosParamCreator: (configuration?: Configura
|
|
|
59817
60568
|
* @throws {RequiredError}
|
|
59818
60569
|
*/
|
|
59819
60570
|
removeVenueKiosk: (businessId: number, stationId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60571
|
+
/**
|
|
60572
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60573
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60574
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60575
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60576
|
+
* @param {*} [options] Override http request option.
|
|
60577
|
+
* @throws {RequiredError}
|
|
60578
|
+
*/
|
|
60579
|
+
removeVenuePaymentTerminal: (businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
60580
|
+
/**
|
|
60581
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60582
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60583
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60584
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60585
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60586
|
+
* @param {*} [options] Override http request option.
|
|
60587
|
+
* @throws {RequiredError}
|
|
60588
|
+
*/
|
|
60589
|
+
renameVenuePaymentTerminal: (businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
59820
60590
|
};
|
|
59821
60591
|
/**
|
|
59822
60592
|
* VenueKiosksApi - functional programming interface
|
|
@@ -59842,6 +60612,15 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
59842
60612
|
* @throws {RequiredError}
|
|
59843
60613
|
*/
|
|
59844
60614
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
60615
|
+
/**
|
|
60616
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60617
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60618
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60619
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60620
|
+
* @param {*} [options] Override http request option.
|
|
60621
|
+
* @throws {RequiredError}
|
|
60622
|
+
*/
|
|
60623
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>>;
|
|
59845
60624
|
/**
|
|
59846
60625
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59847
60626
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59861,7 +60640,7 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
59861
60640
|
*/
|
|
59862
60641
|
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKiosksDto>>;
|
|
59863
60642
|
/**
|
|
59864
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60643
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59865
60644
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59866
60645
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59867
60646
|
* @param {*} [options] Override http request option.
|
|
@@ -59877,6 +60656,25 @@ export declare const VenueKiosksApiFp: (configuration?: Configuration) => {
|
|
|
59877
60656
|
* @throws {RequiredError}
|
|
59878
60657
|
*/
|
|
59879
60658
|
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueKioskDto>>;
|
|
60659
|
+
/**
|
|
60660
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60661
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60662
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60663
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60664
|
+
* @param {*} [options] Override http request option.
|
|
60665
|
+
* @throws {RequiredError}
|
|
60666
|
+
*/
|
|
60667
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>>;
|
|
60668
|
+
/**
|
|
60669
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60670
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60671
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60672
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60673
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60674
|
+
* @param {*} [options] Override http request option.
|
|
60675
|
+
* @throws {RequiredError}
|
|
60676
|
+
*/
|
|
60677
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>>;
|
|
59880
60678
|
};
|
|
59881
60679
|
/**
|
|
59882
60680
|
* VenueKiosksApi - factory interface
|
|
@@ -59902,6 +60700,15 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
59902
60700
|
* @throws {RequiredError}
|
|
59903
60701
|
*/
|
|
59904
60702
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto>;
|
|
60703
|
+
/**
|
|
60704
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60705
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60706
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60707
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60708
|
+
* @param {*} [options] Override http request option.
|
|
60709
|
+
* @throws {RequiredError}
|
|
60710
|
+
*/
|
|
60711
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: any): AxiosPromise<VenuePaymentTerminalDto>;
|
|
59905
60712
|
/**
|
|
59906
60713
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59907
60714
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59921,7 +60728,7 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
59921
60728
|
*/
|
|
59922
60729
|
listVenueKiosks(businessId: number, options?: any): AxiosPromise<VenueKiosksDto>;
|
|
59923
60730
|
/**
|
|
59924
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60731
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59925
60732
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59926
60733
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59927
60734
|
* @param {*} [options] Override http request option.
|
|
@@ -59937,6 +60744,25 @@ export declare const VenueKiosksApiFactory: (configuration?: Configuration, base
|
|
|
59937
60744
|
* @throws {RequiredError}
|
|
59938
60745
|
*/
|
|
59939
60746
|
removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto>;
|
|
60747
|
+
/**
|
|
60748
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60749
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60750
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60751
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60752
|
+
* @param {*} [options] Override http request option.
|
|
60753
|
+
* @throws {RequiredError}
|
|
60754
|
+
*/
|
|
60755
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: any): AxiosPromise<VenuePaymentTerminalDto>;
|
|
60756
|
+
/**
|
|
60757
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60758
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60759
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60760
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60761
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60762
|
+
* @param {*} [options] Override http request option.
|
|
60763
|
+
* @throws {RequiredError}
|
|
60764
|
+
*/
|
|
60765
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: any): AxiosPromise<VenuePaymentTerminalDto>;
|
|
59940
60766
|
};
|
|
59941
60767
|
/**
|
|
59942
60768
|
* VenueKiosksApi - interface
|
|
@@ -59965,6 +60791,16 @@ export interface VenueKiosksApiInterface {
|
|
|
59965
60791
|
* @memberof VenueKiosksApiInterface
|
|
59966
60792
|
*/
|
|
59967
60793
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
60794
|
+
/**
|
|
60795
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60796
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60797
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60798
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60799
|
+
* @param {*} [options] Override http request option.
|
|
60800
|
+
* @throws {RequiredError}
|
|
60801
|
+
* @memberof VenueKiosksApiInterface
|
|
60802
|
+
*/
|
|
60803
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
|
|
59968
60804
|
/**
|
|
59969
60805
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
59970
60806
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -59986,7 +60822,7 @@ export interface VenueKiosksApiInterface {
|
|
|
59986
60822
|
*/
|
|
59987
60823
|
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
|
|
59988
60824
|
/**
|
|
59989
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60825
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
59990
60826
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
59991
60827
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
59992
60828
|
* @param {*} [options] Override http request option.
|
|
@@ -60004,6 +60840,27 @@ export interface VenueKiosksApiInterface {
|
|
|
60004
60840
|
* @memberof VenueKiosksApiInterface
|
|
60005
60841
|
*/
|
|
60006
60842
|
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
|
|
60843
|
+
/**
|
|
60844
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60845
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60846
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60847
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60848
|
+
* @param {*} [options] Override http request option.
|
|
60849
|
+
* @throws {RequiredError}
|
|
60850
|
+
* @memberof VenueKiosksApiInterface
|
|
60851
|
+
*/
|
|
60852
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
|
|
60853
|
+
/**
|
|
60854
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60855
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60856
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60857
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60858
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60859
|
+
* @param {*} [options] Override http request option.
|
|
60860
|
+
* @throws {RequiredError}
|
|
60861
|
+
* @memberof VenueKiosksApiInterface
|
|
60862
|
+
*/
|
|
60863
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
|
|
60007
60864
|
}
|
|
60008
60865
|
/**
|
|
60009
60866
|
* VenueKiosksApi - object-oriented interface
|
|
@@ -60033,6 +60890,16 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
60033
60890
|
* @memberof VenueKiosksApi
|
|
60034
60891
|
*/
|
|
60035
60892
|
claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
60893
|
+
/**
|
|
60894
|
+
* Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
|
|
60895
|
+
* @summary Add a payment terminal to the venue (Munchi admins only)
|
|
60896
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60897
|
+
* @param {CreatePaymentTerminalDto} createPaymentTerminalDto
|
|
60898
|
+
* @param {*} [options] Override http request option.
|
|
60899
|
+
* @throws {RequiredError}
|
|
60900
|
+
* @memberof VenueKiosksApi
|
|
60901
|
+
*/
|
|
60902
|
+
createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalDto, any, {}>>;
|
|
60036
60903
|
/**
|
|
60037
60904
|
* paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
|
|
60038
60905
|
* @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
|
|
@@ -60054,7 +60921,7 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
60054
60921
|
*/
|
|
60055
60922
|
listVenueKiosks(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKiosksDto, any, {}>>;
|
|
60056
60923
|
/**
|
|
60057
|
-
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
|
|
60924
|
+
* The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
|
|
60058
60925
|
* @summary List the venue\'s payment terminals, for linking one to a kiosk
|
|
60059
60926
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60060
60927
|
* @param {*} [options] Override http request option.
|
|
@@ -60072,6 +60939,27 @@ export declare class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInt
|
|
|
60072
60939
|
* @memberof VenueKiosksApi
|
|
60073
60940
|
*/
|
|
60074
60941
|
removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueKioskDto, any, {}>>;
|
|
60942
|
+
/**
|
|
60943
|
+
* The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
|
|
60944
|
+
* @summary Remove a payment terminal from the venue (Munchi admins only)
|
|
60945
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60946
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60947
|
+
* @param {*} [options] Override http request option.
|
|
60948
|
+
* @throws {RequiredError}
|
|
60949
|
+
* @memberof VenueKiosksApi
|
|
60950
|
+
*/
|
|
60951
|
+
removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalDto, any, {}>>;
|
|
60952
|
+
/**
|
|
60953
|
+
* Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
|
|
60954
|
+
* @summary Rename one of the venue\'s payment terminals (Munchi admins only)
|
|
60955
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
60956
|
+
* @param {string} paymentTerminalId The payment terminal\'s id, as the venue\'s terminal list answers it
|
|
60957
|
+
* @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
|
|
60958
|
+
* @param {*} [options] Override http request option.
|
|
60959
|
+
* @throws {RequiredError}
|
|
60960
|
+
* @memberof VenueKiosksApi
|
|
60961
|
+
*/
|
|
60962
|
+
renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenuePaymentTerminalDto, any, {}>>;
|
|
60075
60963
|
}
|
|
60076
60964
|
/**
|
|
60077
60965
|
* VivaApi - axios parameter creator
|