@munchi_oy/core 2.15.1 → 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 +719 -38
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +933 -40
- package/package.json +15 -13
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -5275,6 +5275,12 @@ export interface CreateVenueGiftCardDto {
|
|
|
5275
5275
|
* @memberof CreateVenueGiftCardDto
|
|
5276
5276
|
*/
|
|
5277
5277
|
'expiresAt'?: string | null;
|
|
5278
|
+
/**
|
|
5279
|
+
* When the card\'s email goes, ISO 8601 date-time, ahead and at most a year from now; it needs buyerEmail and sendEmail not false. Without expiresAt, the validity counts from this moment. Absent: at once.
|
|
5280
|
+
* @type {string}
|
|
5281
|
+
* @memberof CreateVenueGiftCardDto
|
|
5282
|
+
*/
|
|
5283
|
+
'sendAt'?: string;
|
|
5278
5284
|
}
|
|
5279
5285
|
/**
|
|
5280
5286
|
*
|
|
@@ -8753,6 +8759,7 @@ export declare const GiftCardEmailKind: {
|
|
|
8753
8759
|
readonly CardAgain: "CARD_AGAIN";
|
|
8754
8760
|
readonly Expiry30: "EXPIRY_30";
|
|
8755
8761
|
readonly Expiry7: "EXPIRY_7";
|
|
8762
|
+
readonly BuyerReceipt: "BUYER_RECEIPT";
|
|
8756
8763
|
};
|
|
8757
8764
|
export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
|
|
8758
8765
|
/**
|
|
@@ -8859,6 +8866,12 @@ export interface GiftCardHistoryEventDto {
|
|
|
8859
8866
|
* @memberof GiftCardHistoryEventDto
|
|
8860
8867
|
*/
|
|
8861
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;
|
|
8862
8875
|
/**
|
|
8863
8876
|
* When it happened, ISO 8601
|
|
8864
8877
|
* @type {string}
|
|
@@ -8883,6 +8896,8 @@ export declare const GiftCardHistoryKind: {
|
|
|
8883
8896
|
readonly Emailed: "EMAILED";
|
|
8884
8897
|
readonly EmailFailed: "EMAIL_FAILED";
|
|
8885
8898
|
readonly EmailChanged: "EMAIL_CHANGED";
|
|
8899
|
+
readonly Refunded: "REFUNDED";
|
|
8900
|
+
readonly Scheduled: "SCHEDULED";
|
|
8886
8901
|
};
|
|
8887
8902
|
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
8888
8903
|
/**
|
|
@@ -9141,6 +9156,104 @@ export interface GiftCardMovementsDto {
|
|
|
9141
9156
|
*/
|
|
9142
9157
|
'nextCursor': string | null;
|
|
9143
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
|
+
}
|
|
9144
9257
|
/**
|
|
9145
9258
|
*
|
|
9146
9259
|
* @export
|
|
@@ -9223,6 +9336,25 @@ export interface GiftCardPeriodTotalsDtoSpent {
|
|
|
9223
9336
|
*/
|
|
9224
9337
|
'orderCount': number;
|
|
9225
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
|
+
}
|
|
9226
9358
|
/**
|
|
9227
9359
|
*
|
|
9228
9360
|
* @export
|
|
@@ -9422,12 +9554,74 @@ export interface GiftCardReportDtoSpent {
|
|
|
9422
9554
|
*/
|
|
9423
9555
|
'orderCount': number;
|
|
9424
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
|
+
}
|
|
9425
9613
|
/**
|
|
9426
9614
|
*
|
|
9427
9615
|
* @export
|
|
9428
9616
|
* @interface GiftCardSettingsDto
|
|
9429
9617
|
*/
|
|
9430
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;
|
|
9431
9625
|
/**
|
|
9432
9626
|
*
|
|
9433
9627
|
* @type {GiftCardSettingsDtoChannels}
|
|
@@ -9441,7 +9635,7 @@ export interface GiftCardSettingsDto {
|
|
|
9441
9635
|
*/
|
|
9442
9636
|
'availableChannels': Array<GiftCardChannel>;
|
|
9443
9637
|
/**
|
|
9444
|
-
* 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
|
|
9445
9639
|
* @type {Array<number>}
|
|
9446
9640
|
* @memberof GiftCardSettingsDto
|
|
9447
9641
|
*/
|
|
@@ -9500,6 +9694,12 @@ export interface GiftCardSettingsDto {
|
|
|
9500
9694
|
* @memberof GiftCardSettingsDto
|
|
9501
9695
|
*/
|
|
9502
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;
|
|
9503
9703
|
}
|
|
9504
9704
|
/**
|
|
9505
9705
|
* Where the store\'s gift cards can be spent
|
|
@@ -15394,6 +15594,44 @@ export interface OnboardingStoresDto {
|
|
|
15394
15594
|
*/
|
|
15395
15595
|
'stores': Array<OnboardingStoreDto>;
|
|
15396
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
|
+
}
|
|
15397
15635
|
/**
|
|
15398
15636
|
*
|
|
15399
15637
|
* @export
|
|
@@ -22958,6 +23196,19 @@ export interface PosUpdateOrderDto {
|
|
|
22958
23196
|
*/
|
|
22959
23197
|
'isTicket'?: boolean;
|
|
22960
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
|
+
}
|
|
22961
23212
|
/**
|
|
22962
23213
|
*
|
|
22963
23214
|
* @export
|
|
@@ -26424,6 +26675,25 @@ export declare const RefundMode: {
|
|
|
26424
26675
|
readonly Item: "ITEM";
|
|
26425
26676
|
};
|
|
26426
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
|
+
}
|
|
26427
26697
|
/**
|
|
26428
26698
|
*
|
|
26429
26699
|
* @export
|
|
@@ -30813,6 +31083,111 @@ export interface SearchUserInfoResponseDtoLinksValue {
|
|
|
30813
31083
|
*/
|
|
30814
31084
|
'method'?: string;
|
|
30815
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
|
+
}
|
|
30816
31191
|
/**
|
|
30817
31192
|
*
|
|
30818
31193
|
* @export
|
|
@@ -31866,6 +32241,17 @@ export interface StripeConfigResponseDto {
|
|
|
31866
32241
|
*/
|
|
31867
32242
|
'locationId': string | null;
|
|
31868
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];
|
|
31869
32255
|
/**
|
|
31870
32256
|
*
|
|
31871
32257
|
* @export
|
|
@@ -36002,7 +36388,7 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36002
36388
|
*/
|
|
36003
36389
|
'channels'?: UpdateGiftCardSettingsDtoChannels;
|
|
36004
36390
|
/**
|
|
36005
|
-
* 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.
|
|
36006
36392
|
* @type {Array<number>}
|
|
36007
36393
|
* @memberof UpdateGiftCardSettingsDto
|
|
36008
36394
|
*/
|
|
@@ -36061,6 +36447,12 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36061
36447
|
* @memberof UpdateGiftCardSettingsDto
|
|
36062
36448
|
*/
|
|
36063
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;
|
|
36064
36456
|
}
|
|
36065
36457
|
/**
|
|
36066
36458
|
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
@@ -36560,7 +36952,7 @@ export interface UpdateTableStatusDto {
|
|
|
36560
36952
|
*/
|
|
36561
36953
|
export interface UpdateVenueGiftCardDto {
|
|
36562
36954
|
/**
|
|
36563
|
-
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
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.
|
|
36564
36956
|
* @type {string}
|
|
36565
36957
|
* @memberof UpdateVenueGiftCardDto
|
|
36566
36958
|
*/
|
|
@@ -36571,6 +36963,24 @@ export interface UpdateVenueGiftCardDto {
|
|
|
36571
36963
|
* @memberof UpdateVenueGiftCardDto
|
|
36572
36964
|
*/
|
|
36573
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;
|
|
36574
36984
|
}
|
|
36575
36985
|
/**
|
|
36576
36986
|
*
|
|
@@ -37814,6 +38224,24 @@ export interface VenueGiftCardDetailDto {
|
|
|
37814
38224
|
* @memberof VenueGiftCardDetailDto
|
|
37815
38225
|
*/
|
|
37816
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;
|
|
37817
38245
|
/**
|
|
37818
38246
|
*
|
|
37819
38247
|
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
@@ -39207,6 +39635,16 @@ export declare const VivaEventId: {
|
|
|
39207
39635
|
readonly NUMBER_7005: 7005;
|
|
39208
39636
|
};
|
|
39209
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];
|
|
39210
39648
|
/**
|
|
39211
39649
|
*
|
|
39212
39650
|
* @export
|
|
@@ -46168,11 +46606,11 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46168
46606
|
*/
|
|
46169
46607
|
blockVenueGiftCard: (businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46170
46608
|
/**
|
|
46171
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
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.
|
|
46172
46610
|
* @summary Make a gift card by hand, given for free
|
|
46173
46611
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46174
46612
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46175
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
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.
|
|
46176
46614
|
* @param {*} [options] Override http request option.
|
|
46177
46615
|
* @throws {RequiredError}
|
|
46178
46616
|
*/
|
|
@@ -46206,6 +46644,14 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46206
46644
|
* @throws {RequiredError}
|
|
46207
46645
|
*/
|
|
46208
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>;
|
|
46209
46655
|
/**
|
|
46210
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.
|
|
46211
46657
|
* @summary Read a store\'s gift card settings
|
|
@@ -46233,7 +46679,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46233
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.
|
|
46234
46680
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46235
46681
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46236
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
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.
|
|
46237
46683
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46238
46684
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46239
46685
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46243,7 +46689,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46243
46689
|
*/
|
|
46244
46690
|
listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46245
46691
|
/**
|
|
46246
|
-
* The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
|
|
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.
|
|
46247
46693
|
* @summary Unblock a gift card
|
|
46248
46694
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46249
46695
|
* @param {string} cardId The card\'s id
|
|
@@ -46252,8 +46698,8 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46252
46698
|
*/
|
|
46253
46699
|
unblockVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46254
46700
|
/**
|
|
46255
|
-
*
|
|
46256
|
-
* @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
|
|
46257
46703
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46258
46704
|
* @param {string} cardId The card\'s id
|
|
46259
46705
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46262,7 +46708,7 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
46262
46708
|
*/
|
|
46263
46709
|
updateVenueGiftCard: (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46264
46710
|
/**
|
|
46265
|
-
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
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.
|
|
46266
46712
|
* @summary Change a store\'s gift card settings
|
|
46267
46713
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46268
46714
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46296,11 +46742,11 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46296
46742
|
*/
|
|
46297
46743
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46298
46744
|
/**
|
|
46299
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
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.
|
|
46300
46746
|
* @summary Make a gift card by hand, given for free
|
|
46301
46747
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46302
46748
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46303
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
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.
|
|
46304
46750
|
* @param {*} [options] Override http request option.
|
|
46305
46751
|
* @throws {RequiredError}
|
|
46306
46752
|
*/
|
|
@@ -46334,6 +46780,14 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46334
46780
|
* @throws {RequiredError}
|
|
46335
46781
|
*/
|
|
46336
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>>;
|
|
46337
46791
|
/**
|
|
46338
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.
|
|
46339
46793
|
* @summary Read a store\'s gift card settings
|
|
@@ -46361,7 +46815,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46361
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.
|
|
46362
46816
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46363
46817
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46364
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
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.
|
|
46365
46819
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46366
46820
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46367
46821
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46371,7 +46825,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46371
46825
|
*/
|
|
46372
46826
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
|
|
46373
46827
|
/**
|
|
46374
|
-
* The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
|
|
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.
|
|
46375
46829
|
* @summary Unblock a gift card
|
|
46376
46830
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46377
46831
|
* @param {string} cardId The card\'s id
|
|
@@ -46380,8 +46834,8 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46380
46834
|
*/
|
|
46381
46835
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46382
46836
|
/**
|
|
46383
|
-
*
|
|
46384
|
-
* @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
|
|
46385
46839
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46386
46840
|
* @param {string} cardId The card\'s id
|
|
46387
46841
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46390,7 +46844,7 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46390
46844
|
*/
|
|
46391
46845
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46392
46846
|
/**
|
|
46393
|
-
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
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.
|
|
46394
46848
|
* @summary Change a store\'s gift card settings
|
|
46395
46849
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46396
46850
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46424,11 +46878,11 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46424
46878
|
*/
|
|
46425
46879
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46426
46880
|
/**
|
|
46427
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
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.
|
|
46428
46882
|
* @summary Make a gift card by hand, given for free
|
|
46429
46883
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46430
46884
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46431
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
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.
|
|
46432
46886
|
* @param {*} [options] Override http request option.
|
|
46433
46887
|
* @throws {RequiredError}
|
|
46434
46888
|
*/
|
|
@@ -46462,6 +46916,14 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46462
46916
|
* @throws {RequiredError}
|
|
46463
46917
|
*/
|
|
46464
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>;
|
|
46465
46927
|
/**
|
|
46466
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.
|
|
46467
46929
|
* @summary Read a store\'s gift card settings
|
|
@@ -46489,7 +46951,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46489
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.
|
|
46490
46952
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46491
46953
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46492
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
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.
|
|
46493
46955
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46494
46956
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46495
46957
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46499,7 +46961,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46499
46961
|
*/
|
|
46500
46962
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto>;
|
|
46501
46963
|
/**
|
|
46502
|
-
* The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
|
|
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.
|
|
46503
46965
|
* @summary Unblock a gift card
|
|
46504
46966
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46505
46967
|
* @param {string} cardId The card\'s id
|
|
@@ -46508,8 +46970,8 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46508
46970
|
*/
|
|
46509
46971
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46510
46972
|
/**
|
|
46511
|
-
*
|
|
46512
|
-
* @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
|
|
46513
46975
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46514
46976
|
* @param {string} cardId The card\'s id
|
|
46515
46977
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46518,7 +46980,7 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46518
46980
|
*/
|
|
46519
46981
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46520
46982
|
/**
|
|
46521
|
-
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
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.
|
|
46522
46984
|
* @summary Change a store\'s gift card settings
|
|
46523
46985
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46524
46986
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46555,11 +47017,11 @@ export interface GiftCardsApiInterface {
|
|
|
46555
47017
|
*/
|
|
46556
47018
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46557
47019
|
/**
|
|
46558
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
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.
|
|
46559
47021
|
* @summary Make a gift card by hand, given for free
|
|
46560
47022
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46561
47023
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46562
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
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.
|
|
46563
47025
|
* @param {*} [options] Override http request option.
|
|
46564
47026
|
* @throws {RequiredError}
|
|
46565
47027
|
* @memberof GiftCardsApiInterface
|
|
@@ -46597,6 +47059,15 @@ export interface GiftCardsApiInterface {
|
|
|
46597
47059
|
* @memberof GiftCardsApiInterface
|
|
46598
47060
|
*/
|
|
46599
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>;
|
|
46600
47071
|
/**
|
|
46601
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.
|
|
46602
47073
|
* @summary Read a store\'s gift card settings
|
|
@@ -46626,7 +47097,7 @@ export interface GiftCardsApiInterface {
|
|
|
46626
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.
|
|
46627
47098
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46628
47099
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46629
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
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.
|
|
46630
47101
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46631
47102
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46632
47103
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46637,7 +47108,7 @@ export interface GiftCardsApiInterface {
|
|
|
46637
47108
|
*/
|
|
46638
47109
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
46639
47110
|
/**
|
|
46640
|
-
* The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
|
|
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.
|
|
46641
47112
|
* @summary Unblock a gift card
|
|
46642
47113
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46643
47114
|
* @param {string} cardId The card\'s id
|
|
@@ -46647,8 +47118,8 @@ export interface GiftCardsApiInterface {
|
|
|
46647
47118
|
*/
|
|
46648
47119
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46649
47120
|
/**
|
|
46650
|
-
*
|
|
46651
|
-
* @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
|
|
46652
47123
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46653
47124
|
* @param {string} cardId The card\'s id
|
|
46654
47125
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46658,7 +47129,7 @@ export interface GiftCardsApiInterface {
|
|
|
46658
47129
|
*/
|
|
46659
47130
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46660
47131
|
/**
|
|
46661
|
-
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
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.
|
|
46662
47133
|
* @summary Change a store\'s gift card settings
|
|
46663
47134
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46664
47135
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -46697,11 +47168,11 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46697
47168
|
*/
|
|
46698
47169
|
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46699
47170
|
/**
|
|
46700
|
-
* A card of the amount, ACTIVE at once, made BY_HAND at this store and owned like a till sale (by the store\'s merchant when it has one), in the store\'s currency. Without expiresAt it expires the settings\' validityMonths from now, or never. The till channel does not need to be on. Who made it is stored.
|
|
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.
|
|
46701
47172
|
* @summary Make a gift card by hand, given for free
|
|
46702
47173
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46703
47174
|
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
46704
|
-
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
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.
|
|
46705
47176
|
* @param {*} [options] Override http request option.
|
|
46706
47177
|
* @throws {RequiredError}
|
|
46707
47178
|
* @memberof GiftCardsApi
|
|
@@ -46739,6 +47210,15 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46739
47210
|
* @memberof GiftCardsApi
|
|
46740
47211
|
*/
|
|
46741
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, {}>>;
|
|
46742
47222
|
/**
|
|
46743
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.
|
|
46744
47224
|
* @summary Read a store\'s gift card settings
|
|
@@ -46768,7 +47248,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46768
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.
|
|
46769
47249
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
46770
47250
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46771
|
-
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
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.
|
|
46772
47252
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
46773
47253
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
46774
47254
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
@@ -46779,7 +47259,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46779
47259
|
*/
|
|
46780
47260
|
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
|
|
46781
47261
|
/**
|
|
46782
|
-
* The card works again as its state says. The block stays in its history, followed by the unblock and who made it. A card not blocked is answered as it is.
|
|
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.
|
|
46783
47263
|
* @summary Unblock a gift card
|
|
46784
47264
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46785
47265
|
* @param {string} cardId The card\'s id
|
|
@@ -46789,8 +47269,8 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46789
47269
|
*/
|
|
46790
47270
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46791
47271
|
/**
|
|
46792
|
-
*
|
|
46793
|
-
* @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
|
|
46794
47274
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46795
47275
|
* @param {string} cardId The card\'s id
|
|
46796
47276
|
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
@@ -46800,7 +47280,7 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46800
47280
|
*/
|
|
46801
47281
|
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46802
47282
|
/**
|
|
46803
|
-
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
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.
|
|
46804
47284
|
* @summary Change a store\'s gift card settings
|
|
46805
47285
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
46806
47286
|
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
@@ -47533,6 +48013,207 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
47533
48013
|
*/
|
|
47534
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, {}>>;
|
|
47535
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
|
+
}
|
|
47536
48217
|
/**
|
|
47537
48218
|
* InvoiceCompaniesApi - axios parameter creator
|
|
47538
48219
|
* @export
|