@munchi_oy/core 2.15.0 → 2.16.0

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
package/generated/api.ts CHANGED
@@ -4757,6 +4757,18 @@ export interface CreateMunchiGiftCardDto {
4757
4757
  * @memberof CreateMunchiGiftCardDto
4758
4758
  */
4759
4759
  'purchaserEmail'?: string;
4760
+ /**
4761
+ * Whether the card is emailed to purchaserEmail once it is ACTIVE: at once for a card sold ACTIVE, when its order is paid for one sold PENDING. Absent: true. Without purchaserEmail nothing is sent.
4762
+ * @type {boolean}
4763
+ * @memberof CreateMunchiGiftCardDto
4764
+ */
4765
+ 'sendEmail'?: boolean;
4766
+ /**
4767
+ * The message shown in the card\'s email, 1 to 300 characters once the spaces around it are dropped: the buyer\'s own words. Absent or only spaces: none.
4768
+ * @type {string}
4769
+ * @memberof CreateMunchiGiftCardDto
4770
+ */
4771
+ 'message'?: string;
4760
4772
  /**
4761
4773
  * The country code of the buyer\'s phone, 1 to 8 characters as sent; spaces around it are dropped
4762
4774
  * @type {string}
@@ -5045,6 +5057,33 @@ export interface CreatePaymentMethodDtoGiftCardCredentials {
5045
5057
  */
5046
5058
  'uniquePosDeviceId'?: string;
5047
5059
  }
5060
+ /**
5061
+ *
5062
+ * @export
5063
+ * @interface CreatePaymentTerminalDto
5064
+ */
5065
+ export interface CreatePaymentTerminalDto {
5066
+ /**
5067
+ *
5068
+ * @type {TerminalProvider}
5069
+ * @memberof CreatePaymentTerminalDto
5070
+ */
5071
+ 'provider': TerminalProvider;
5072
+ /**
5073
+ * The provider\'s own id of the terminal, trimmed: for viva the terminal ID (TID) in Viva\'s portal, digits only (16010572); for nets the terminal ID (TID), digits only (72102200); for worldline the terminal\'s serial number, letters and digits (253SKD884468). The payment is sent to the provider with this id, so it must be the id the provider knows
5074
+ * @type {string}
5075
+ * @memberof CreatePaymentTerminalDto
5076
+ */
5077
+ 'hardwareId': string;
5078
+ /**
5079
+ * The terminal\'s name, as the venue\'s staff call it
5080
+ * @type {string}
5081
+ * @memberof CreatePaymentTerminalDto
5082
+ */
5083
+ 'label': string;
5084
+ }
5085
+
5086
+
5048
5087
  /**
5049
5088
  *
5050
5089
  * @export
@@ -5374,7 +5413,7 @@ export interface CreateVenueGiftCardDto {
5374
5413
  */
5375
5414
  'note'?: string;
5376
5415
  /**
5377
- * The message shown in the card\'s email, 1 to 300 characters: the buyer\'s or the store\'s own words. Absent: none.
5416
+ * The message shown in the card\'s email, 1 to 300 characters once the spaces around it are dropped: the buyer\'s or the store\'s own words. Absent or only spaces: none.
5378
5417
  * @type {string}
5379
5418
  * @memberof CreateVenueGiftCardDto
5380
5419
  */
@@ -5415,6 +5454,12 @@ export interface CreateVenueGiftCardDto {
5415
5454
  * @memberof CreateVenueGiftCardDto
5416
5455
  */
5417
5456
  'expiresAt'?: string | null;
5457
+ /**
5458
+ * When the card\'s email goes, ISO 8601 date-time, ahead and at most a year from now; it needs buyerEmail and sendEmail not false. Without expiresAt, the validity counts from this moment. Absent: at once.
5459
+ * @type {string}
5460
+ * @memberof CreateVenueGiftCardDto
5461
+ */
5462
+ 'sendAt'?: string;
5418
5463
  }
5419
5464
 
5420
5465
 
@@ -9031,7 +9076,8 @@ export const GiftCardEmailKind = {
9031
9076
  Card: 'CARD',
9032
9077
  CardAgain: 'CARD_AGAIN',
9033
9078
  Expiry30: 'EXPIRY_30',
9034
- Expiry7: 'EXPIRY_7'
9079
+ Expiry7: 'EXPIRY_7',
9080
+ BuyerReceipt: 'BUYER_RECEIPT'
9035
9081
  } as const;
9036
9082
 
9037
9083
  export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
@@ -9149,6 +9195,12 @@ export interface GiftCardHistoryEventDto {
9149
9195
  * @memberof GiftCardHistoryEventDto
9150
9196
  */
9151
9197
  'emailKind': GiftCardEmailKind | null;
9198
+ /**
9199
+ * When the card\'s email is set to go, ISO 8601, on a SCHEDULED line (\"Scheduled for …\"); null for the others
9200
+ * @type {string}
9201
+ * @memberof GiftCardHistoryEventDto
9202
+ */
9203
+ 'scheduledFor': string | null;
9152
9204
  /**
9153
9205
  * When it happened, ISO 8601
9154
9206
  * @type {string}
@@ -9175,7 +9227,9 @@ export const GiftCardHistoryKind = {
9175
9227
  SwitchedOn: 'SWITCHED_ON',
9176
9228
  Emailed: 'EMAILED',
9177
9229
  EmailFailed: 'EMAIL_FAILED',
9178
- EmailChanged: 'EMAIL_CHANGED'
9230
+ EmailChanged: 'EMAIL_CHANGED',
9231
+ Refunded: 'REFUNDED',
9232
+ Scheduled: 'SCHEDULED'
9179
9233
  } as const;
9180
9234
 
9181
9235
  export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
@@ -9449,6 +9503,108 @@ export interface GiftCardMovementsDto {
9449
9503
  */
9450
9504
  'nextCursor': string | null;
9451
9505
  }
9506
+ /**
9507
+ *
9508
+ * @export
9509
+ * @interface GiftCardOfferDto
9510
+ */
9511
+ export interface GiftCardOfferDto {
9512
+ /**
9513
+ * 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.
9514
+ * @type {boolean}
9515
+ * @memberof GiftCardOfferDto
9516
+ */
9517
+ 'sells': boolean;
9518
+ /**
9519
+ * The amounts offered, in cents, ascending: at most 3, the smallest ones when a store saved more before; with anyAmount, buyers also see Other
9520
+ * @type {Array<number>}
9521
+ * @memberof GiftCardOfferDto
9522
+ */
9523
+ 'amounts': Array<number>;
9524
+ /**
9525
+ * Whether a buyer may choose any amount
9526
+ * @type {boolean}
9527
+ * @memberof GiftCardOfferDto
9528
+ */
9529
+ 'anyAmount': boolean;
9530
+ /**
9531
+ * The smallest amount a buyer may choose, in cents
9532
+ * @type {number}
9533
+ * @memberof GiftCardOfferDto
9534
+ */
9535
+ 'minAmount': number;
9536
+ /**
9537
+ * The largest amount a buyer may choose, in cents
9538
+ * @type {number}
9539
+ * @memberof GiftCardOfferDto
9540
+ */
9541
+ 'maxAmount': number;
9542
+ /**
9543
+ *
9544
+ * @type {CurrencyCode}
9545
+ * @memberof GiftCardOfferDto
9546
+ */
9547
+ 'currency': CurrencyCode;
9548
+ /**
9549
+ * The text printed on the card; null when none
9550
+ * @type {string}
9551
+ * @memberof GiftCardOfferDto
9552
+ */
9553
+ 'cardText': string | null;
9554
+ /**
9555
+ * The card\'s picture, an https URL; null when none
9556
+ * @type {string}
9557
+ * @memberof GiftCardOfferDto
9558
+ */
9559
+ 'imageUrl': string | null;
9560
+ /**
9561
+ * The store\'s name
9562
+ * @type {string}
9563
+ * @memberof GiftCardOfferDto
9564
+ */
9565
+ 'storeName': string;
9566
+ /**
9567
+ * How many months a card stays valid from the day its email goes; null when cards never expire
9568
+ * @type {number}
9569
+ * @memberof GiftCardOfferDto
9570
+ */
9571
+ 'validityMonths': number | null;
9572
+ }
9573
+
9574
+
9575
+ /**
9576
+ *
9577
+ * @export
9578
+ * @interface GiftCardPaymentsOnlineDto
9579
+ */
9580
+ export interface GiftCardPaymentsOnlineDto {
9581
+ /**
9582
+ *
9583
+ * @type {StripeConnectionState}
9584
+ * @memberof GiftCardPaymentsOnlineDto
9585
+ */
9586
+ 'stripe': StripeConnectionState;
9587
+ /**
9588
+ *
9589
+ * @type {VivaOnlineState}
9590
+ * @memberof GiftCardPaymentsOnlineDto
9591
+ */
9592
+ 'vivaOnline': VivaOnlineState;
9593
+ /**
9594
+ * Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
9595
+ * @type {boolean}
9596
+ * @memberof GiftCardPaymentsOnlineDto
9597
+ */
9598
+ 'vivaOnPos': boolean;
9599
+ /**
9600
+ * 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
9601
+ * @type {boolean}
9602
+ * @memberof GiftCardPaymentsOnlineDto
9603
+ */
9604
+ 'vivaIsv': boolean;
9605
+ }
9606
+
9607
+
9452
9608
  /**
9453
9609
  *
9454
9610
  * @export
@@ -9531,6 +9687,25 @@ export interface GiftCardPeriodTotalsDtoSpent {
9531
9687
  */
9532
9688
  'orderCount': number;
9533
9689
  }
9690
+ /**
9691
+ *
9692
+ * @export
9693
+ * @interface GiftCardPersonDto
9694
+ */
9695
+ export interface GiftCardPersonDto {
9696
+ /**
9697
+ * 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.
9698
+ * @type {string}
9699
+ * @memberof GiftCardPersonDto
9700
+ */
9701
+ 'name'?: string;
9702
+ /**
9703
+ * The person\'s email, at most 254 characters once the spaces around it are dropped.
9704
+ * @type {string}
9705
+ * @memberof GiftCardPersonDto
9706
+ */
9707
+ 'email': string;
9708
+ }
9534
9709
  /**
9535
9710
  *
9536
9711
  * @export
@@ -9732,12 +9907,76 @@ export interface GiftCardReportDtoSpent {
9732
9907
  */
9733
9908
  'orderCount': number;
9734
9909
  }
9910
+ /**
9911
+ *
9912
+ * @export
9913
+ * @interface GiftCardSellingDto
9914
+ */
9915
+ export interface GiftCardSellingDto {
9916
+ /**
9917
+ *
9918
+ * @type {GiftCardSellingDtoCardPayments}
9919
+ * @memberof GiftCardSellingDto
9920
+ */
9921
+ 'cardPayments': GiftCardSellingDtoCardPayments;
9922
+ /**
9923
+ * Whether a buyer has an amount to choose: at least one amount, or any amount
9924
+ * @type {boolean}
9925
+ * @memberof GiftCardSellingDto
9926
+ */
9927
+ 'amountsSet': boolean;
9928
+ /**
9929
+ * 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.
9930
+ * @type {boolean}
9931
+ * @memberof GiftCardSellingDto
9932
+ */
9933
+ 'ready': boolean;
9934
+ }
9935
+ /**
9936
+ * What the store can take card payments online with
9937
+ * @export
9938
+ * @interface GiftCardSellingDtoCardPayments
9939
+ */
9940
+ export interface GiftCardSellingDtoCardPayments {
9941
+ /**
9942
+ *
9943
+ * @type {StripeConnectionState}
9944
+ * @memberof GiftCardSellingDtoCardPayments
9945
+ */
9946
+ 'stripe': StripeConnectionState;
9947
+ /**
9948
+ *
9949
+ * @type {VivaOnlineState}
9950
+ * @memberof GiftCardSellingDtoCardPayments
9951
+ */
9952
+ 'vivaOnline': VivaOnlineState;
9953
+ /**
9954
+ * Whether the store takes Viva card payments at its POS (an active Viva config on MunchiPos)
9955
+ * @type {boolean}
9956
+ * @memberof GiftCardSellingDtoCardPayments
9957
+ */
9958
+ 'vivaOnPos': boolean;
9959
+ /**
9960
+ * 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
9961
+ * @type {boolean}
9962
+ * @memberof GiftCardSellingDtoCardPayments
9963
+ */
9964
+ 'vivaIsv': boolean;
9965
+ }
9966
+
9967
+
9735
9968
  /**
9736
9969
  *
9737
9970
  * @export
9738
9971
  * @interface GiftCardSettingsDto
9739
9972
  */
9740
9973
  export interface GiftCardSettingsDto {
9974
+ /**
9975
+ * 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
9976
+ * @type {boolean}
9977
+ * @memberof GiftCardSettingsDto
9978
+ */
9979
+ 'saved': boolean;
9741
9980
  /**
9742
9981
  *
9743
9982
  * @type {GiftCardSettingsDtoChannels}
@@ -9751,7 +9990,7 @@ export interface GiftCardSettingsDto {
9751
9990
  */
9752
9991
  'availableChannels': Array<GiftCardChannel>;
9753
9992
  /**
9754
- * The amounts offered, in cents, ascending
9993
+ * The amounts offered, in cents, ascending: at most 3, though a store saved with more before keeps them until its next change of amounts
9755
9994
  * @type {Array<number>}
9756
9995
  * @memberof GiftCardSettingsDto
9757
9996
  */
@@ -9810,6 +10049,12 @@ export interface GiftCardSettingsDto {
9810
10049
  * @memberof GiftCardSettingsDto
9811
10050
  */
9812
10051
  'emailLanguage': GiftCardLanguage | null;
10052
+ /**
10053
+ * 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.
10054
+ * @type {boolean}
10055
+ * @memberof GiftCardSettingsDto
10056
+ */
10057
+ 'sellOnline': boolean;
9813
10058
  }
9814
10059
 
9815
10060
 
@@ -15880,6 +16125,44 @@ export interface OnboardingStoresDto {
15880
16125
  */
15881
16126
  'stores': Array<OnboardingStoreDto>;
15882
16127
  }
16128
+ /**
16129
+ *
16130
+ * @export
16131
+ * @interface OnlineGiftCardRefundDto
16132
+ */
16133
+ export interface OnlineGiftCardRefundDto {
16134
+ /**
16135
+ * The card\'s id
16136
+ * @type {string}
16137
+ * @memberof OnlineGiftCardRefundDto
16138
+ */
16139
+ 'cardId': string;
16140
+ /**
16141
+ * When the card was blocked for the refund, ISO 8601: the first refund\'s moment on a repeat.
16142
+ * @type {string}
16143
+ * @memberof OnlineGiftCardRefundDto
16144
+ */
16145
+ 'refundedAt': string;
16146
+ }
16147
+ /**
16148
+ *
16149
+ * @export
16150
+ * @interface OnlineGiftCardSaleDto
16151
+ */
16152
+ export interface OnlineGiftCardSaleDto {
16153
+ /**
16154
+ * The card\'s id
16155
+ * @type {string}
16156
+ * @memberof OnlineGiftCardSaleDto
16157
+ */
16158
+ 'cardId': string;
16159
+ /**
16160
+ * The card\'s 6-digit code. Never shown to the buyer of a gift: only the person it is for gets it, by email.
16161
+ * @type {string}
16162
+ * @memberof OnlineGiftCardSaleDto
16163
+ */
16164
+ 'code': string;
16165
+ }
15883
16166
  /**
15884
16167
  *
15885
16168
  * @export
@@ -23646,6 +23929,19 @@ export interface PosUpdateOrderDto {
23646
23929
  }
23647
23930
 
23648
23931
 
23932
+ /**
23933
+ *
23934
+ * @export
23935
+ * @interface PosVivaMerchantDto
23936
+ */
23937
+ export interface PosVivaMerchantDto {
23938
+ /**
23939
+ * 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.
23940
+ * @type {string}
23941
+ * @memberof PosVivaMerchantDto
23942
+ */
23943
+ 'merchantId': string | null;
23944
+ }
23649
23945
  /**
23650
23946
  *
23651
23947
  * @export
@@ -27216,6 +27512,25 @@ export const RefundMode = {
27216
27512
  export type RefundMode = typeof RefundMode[keyof typeof RefundMode];
27217
27513
 
27218
27514
 
27515
+ /**
27516
+ *
27517
+ * @export
27518
+ * @interface RefundOnlineGiftCardSaleDto
27519
+ */
27520
+ export interface RefundOnlineGiftCardSaleDto {
27521
+ /**
27522
+ * The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
27523
+ * @type {string}
27524
+ * @memberof RefundOnlineGiftCardSaleDto
27525
+ */
27526
+ 'orderCode': string;
27527
+ /**
27528
+ * The id of the Vendure order line that holds the gift card, 1 to 64 characters.
27529
+ * @type {string}
27530
+ * @memberof RefundOnlineGiftCardSaleDto
27531
+ */
27532
+ 'orderLineId': string;
27533
+ }
27219
27534
  /**
27220
27535
  *
27221
27536
  * @export
@@ -27616,6 +27931,19 @@ export interface ReleasedLicenceHoldsDto {
27616
27931
  */
27617
27932
  'nextAfterVenueId': number | null;
27618
27933
  }
27934
+ /**
27935
+ *
27936
+ * @export
27937
+ * @interface RenamePaymentTerminalDto
27938
+ */
27939
+ export interface RenamePaymentTerminalDto {
27940
+ /**
27941
+ * The terminal\'s new name; nothing else of the terminal changes
27942
+ * @type {string}
27943
+ * @memberof RenamePaymentTerminalDto
27944
+ */
27945
+ 'label': string;
27946
+ }
27619
27947
  /**
27620
27948
  *
27621
27949
  * @export
@@ -31706,6 +32034,113 @@ export interface SearchUserInfoResponseDtoLinksValue {
31706
32034
  */
31707
32035
  'method'?: string;
31708
32036
  }
32037
+ /**
32038
+ *
32039
+ * @export
32040
+ * @interface SellGiftCardOnlineDto
32041
+ */
32042
+ export interface SellGiftCardOnlineDto {
32043
+ /**
32044
+ * The Vendure order\'s code, 1 to 64 characters: with orderLineId, it names the sale.
32045
+ * @type {string}
32046
+ * @memberof SellGiftCardOnlineDto
32047
+ */
32048
+ 'orderCode': string;
32049
+ /**
32050
+ * The id of the Vendure order line that holds the gift card, 1 to 64 characters.
32051
+ * @type {string}
32052
+ * @memberof SellGiftCardOnlineDto
32053
+ */
32054
+ 'orderLineId': string;
32055
+ /**
32056
+ * The store that sold it: its orderingBusinessId, the Vendure seller of the storefront channel the order was placed on.
32057
+ * @type {number}
32058
+ * @memberof SellGiftCardOnlineDto
32059
+ */
32060
+ 'orderingBusinessId': number;
32061
+ /**
32062
+ * 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.
32063
+ * @type {number}
32064
+ * @memberof SellGiftCardOnlineDto
32065
+ */
32066
+ 'amount': number;
32067
+ /**
32068
+ *
32069
+ * @type {CurrencyCode}
32070
+ * @memberof SellGiftCardOnlineDto
32071
+ */
32072
+ 'currency': CurrencyCode;
32073
+ /**
32074
+ *
32075
+ * @type {SellGiftCardOnlineDtoBuyer}
32076
+ * @memberof SellGiftCardOnlineDto
32077
+ */
32078
+ 'buyer': SellGiftCardOnlineDtoBuyer;
32079
+ /**
32080
+ *
32081
+ * @type {SellGiftCardOnlineDtoRecipient}
32082
+ * @memberof SellGiftCardOnlineDto
32083
+ */
32084
+ 'recipient'?: SellGiftCardOnlineDtoRecipient;
32085
+ /**
32086
+ * The buyer\'s message, shown in the card\'s email, 1 to 300 characters. Absent: none.
32087
+ * @type {string}
32088
+ * @memberof SellGiftCardOnlineDto
32089
+ */
32090
+ 'message'?: string;
32091
+ /**
32092
+ *
32093
+ * @type {GiftCardLanguage}
32094
+ * @memberof SellGiftCardOnlineDto
32095
+ */
32096
+ 'language'?: GiftCardLanguage;
32097
+ /**
32098
+ * 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.
32099
+ * @type {string}
32100
+ * @memberof SellGiftCardOnlineDto
32101
+ */
32102
+ 'sendAt'?: string;
32103
+ }
32104
+
32105
+
32106
+ /**
32107
+ * Who bought the card: its receipt goes to this email, and the card too when it is for them.
32108
+ * @export
32109
+ * @interface SellGiftCardOnlineDtoBuyer
32110
+ */
32111
+ export interface SellGiftCardOnlineDtoBuyer {
32112
+ /**
32113
+ * 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.
32114
+ * @type {string}
32115
+ * @memberof SellGiftCardOnlineDtoBuyer
32116
+ */
32117
+ 'name'?: string;
32118
+ /**
32119
+ * The person\'s email, at most 254 characters once the spaces around it are dropped.
32120
+ * @type {string}
32121
+ * @memberof SellGiftCardOnlineDtoBuyer
32122
+ */
32123
+ 'email': string;
32124
+ }
32125
+ /**
32126
+ * 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.
32127
+ * @export
32128
+ * @interface SellGiftCardOnlineDtoRecipient
32129
+ */
32130
+ export interface SellGiftCardOnlineDtoRecipient {
32131
+ /**
32132
+ * 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.
32133
+ * @type {string}
32134
+ * @memberof SellGiftCardOnlineDtoRecipient
32135
+ */
32136
+ 'name'?: string;
32137
+ /**
32138
+ * The person\'s email, at most 254 characters once the spaces around it are dropped.
32139
+ * @type {string}
32140
+ * @memberof SellGiftCardOnlineDtoRecipient
32141
+ */
32142
+ 'email': string;
32143
+ }
31709
32144
  /**
31710
32145
  *
31711
32146
  * @export
@@ -32824,6 +33259,21 @@ export interface StripeConfigResponseDto {
32824
33259
  */
32825
33260
  'locationId': string | null;
32826
33261
  }
33262
+ /**
33263
+ *
33264
+ * @export
33265
+ * @enum {string}
33266
+ */
33267
+
33268
+ export const StripeConnectionState = {
33269
+ Active: 'active',
33270
+ Pending: 'pending',
33271
+ None: 'none'
33272
+ } as const;
33273
+
33274
+ export type StripeConnectionState = typeof StripeConnectionState[keyof typeof StripeConnectionState];
33275
+
33276
+
32827
33277
  /**
32828
33278
  *
32829
33279
  * @export
@@ -34487,6 +34937,21 @@ export const TerminalConnectionType = {
34487
34937
  export type TerminalConnectionType = typeof TerminalConnectionType[keyof typeof TerminalConnectionType];
34488
34938
 
34489
34939
 
34940
+ /**
34941
+ *
34942
+ * @export
34943
+ * @enum {string}
34944
+ */
34945
+
34946
+ export const TerminalProvider = {
34947
+ Viva: 'viva',
34948
+ Nets: 'nets',
34949
+ Worldline: 'worldline'
34950
+ } as const;
34951
+
34952
+ export type TerminalProvider = typeof TerminalProvider[keyof typeof TerminalProvider];
34953
+
34954
+
34490
34955
  /**
34491
34956
  *
34492
34957
  * @export
@@ -37037,7 +37502,7 @@ export interface UpdateGiftCardSettingsDto {
37037
37502
  */
37038
37503
  'channels'?: UpdateGiftCardSettingsDtoChannels;
37039
37504
  /**
37040
- * The amounts offered, in cents: 1 to 6 different amounts, each 100 to 100000. Stored ascending. Absent: unchanged.
37505
+ * The amounts offered, in cents: 1 to 3 different amounts, each 100 to 100000 (with anyAmount, buyers also see Other). Stored ascending. Absent: unchanged.
37041
37506
  * @type {Array<number>}
37042
37507
  * @memberof UpdateGiftCardSettingsDto
37043
37508
  */
@@ -37096,6 +37561,12 @@ export interface UpdateGiftCardSettingsDto {
37096
37561
  * @memberof UpdateGiftCardSettingsDto
37097
37562
  */
37098
37563
  'emailLanguage'?: GiftCardLanguage | null;
37564
+ /**
37565
+ * 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.
37566
+ * @type {boolean}
37567
+ * @memberof UpdateGiftCardSettingsDto
37568
+ */
37569
+ 'sellOnline'?: boolean;
37099
37570
  }
37100
37571
 
37101
37572
 
@@ -37605,7 +38076,7 @@ export interface UpdateTableStatusDto {
37605
38076
  */
37606
38077
  export interface UpdateVenueGiftCardDto {
37607
38078
  /**
37608
- * The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
38079
+ * 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.
37609
38080
  * @type {string}
37610
38081
  * @memberof UpdateVenueGiftCardDto
37611
38082
  */
@@ -37615,7 +38086,25 @@ export interface UpdateVenueGiftCardDto {
37615
38086
  * @type {GiftCardLanguage}
37616
38087
  * @memberof UpdateVenueGiftCardDto
37617
38088
  */
37618
- 'language'?: GiftCardLanguage;
38089
+ 'language'?: GiftCardLanguage | null;
38090
+ /**
38091
+ * 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.
38092
+ * @type {string}
38093
+ * @memberof UpdateVenueGiftCardDto
38094
+ */
38095
+ 'sendAt'?: string | null;
38096
+ /**
38097
+ * 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.
38098
+ * @type {string}
38099
+ * @memberof UpdateVenueGiftCardDto
38100
+ */
38101
+ 'recipientEmail'?: string;
38102
+ /**
38103
+ * 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.
38104
+ * @type {string}
38105
+ * @memberof UpdateVenueGiftCardDto
38106
+ */
38107
+ 'recipientName'?: string;
37619
38108
  }
37620
38109
 
37621
38110
 
@@ -38883,6 +39372,24 @@ export interface VenueGiftCardDetailDto {
38883
39372
  * @memberof VenueGiftCardDetailDto
38884
39373
  */
38885
39374
  'language': GiftCardLanguage | null;
39375
+ /**
39376
+ * When the card\'s email is set to go, ISO 8601: a day the dashboard or the online buyer chose; null for at once
39377
+ * @type {string}
39378
+ * @memberof VenueGiftCardDetailDto
39379
+ */
39380
+ 'sendAt': string | null;
39381
+ /**
39382
+ * 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
39383
+ * @type {string}
39384
+ * @memberof VenueGiftCardDetailDto
39385
+ */
39386
+ 'recipientName': string | null;
39387
+ /**
39388
+ * Where an online gift\'s card email and reminders go; null for every other card, whose emails go to buyerEmail
39389
+ * @type {string}
39390
+ * @memberof VenueGiftCardDetailDto
39391
+ */
39392
+ 'recipientEmail': string | null;
38886
39393
  /**
38887
39394
  *
38888
39395
  * @type {VenueGiftCardDetailDtoLastEmail}
@@ -39205,7 +39712,7 @@ export interface VenuePaymentTerminalDto {
39205
39712
  */
39206
39713
  export interface VenuePaymentTerminalsDto {
39207
39714
  /**
39208
- * The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it
39715
+ * The venue\'s payment terminals as stored, oldest first; a terminal is stored once a till has discovered it at its provider, or once Munchi ops added it
39209
39716
  * @type {Array<VenuePaymentTerminalDto>}
39210
39717
  * @memberof VenuePaymentTerminalsDto
39211
39718
  */
@@ -40326,6 +40833,20 @@ export const VivaEventId = {
40326
40833
  export type VivaEventId = typeof VivaEventId[keyof typeof VivaEventId];
40327
40834
 
40328
40835
 
40836
+ /**
40837
+ *
40838
+ * @export
40839
+ * @enum {string}
40840
+ */
40841
+
40842
+ export const VivaOnlineState = {
40843
+ Active: 'active',
40844
+ None: 'none'
40845
+ } as const;
40846
+
40847
+ export type VivaOnlineState = typeof VivaOnlineState[keyof typeof VivaOnlineState];
40848
+
40849
+
40329
40850
  /**
40330
40851
  *
40331
40852
  * @export
@@ -51373,11 +51894,11 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
51373
51894
  };
51374
51895
  },
51375
51896
  /**
51376
- * 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.
51897
+ * 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.
51377
51898
  * @summary Make a gift card by hand, given for free
51378
51899
  * @param {number} businessId The store\&#39;s orderingBusinessId
51379
51900
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
51380
- * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
51901
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
51381
51902
  * @param {*} [options] Override http request option.
51382
51903
  * @throws {RequiredError}
51383
51904
  */
@@ -51553,6 +52074,44 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
51553
52074
 
51554
52075
 
51555
52076
 
52077
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
52078
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
52079
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
52080
+
52081
+ return {
52082
+ url: toPathString(localVarUrlObj),
52083
+ options: localVarRequestOptions,
52084
+ };
52085
+ },
52086
+ /**
52087
+ * 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.
52088
+ * @summary Read a store\'s checklist for selling gift cards online
52089
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52090
+ * @param {*} [options] Override http request option.
52091
+ * @throws {RequiredError}
52092
+ */
52093
+ getVenueGiftCardSelling: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
52094
+ // verify required parameter 'businessId' is not null or undefined
52095
+ assertParamExists('getVenueGiftCardSelling', 'businessId', businessId)
52096
+ const localVarPath = `/api/v2/venues/{businessId}/gift-card-selling`
52097
+ .replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
52098
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
52099
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
52100
+ let baseOptions;
52101
+ if (configuration) {
52102
+ baseOptions = configuration.baseOptions;
52103
+ }
52104
+
52105
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
52106
+ const localVarHeaderParameter = {} as any;
52107
+ const localVarQueryParameter = {} as any;
52108
+
52109
+ // authentication JWT-auth required
52110
+ // http bearer authentication required
52111
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
52112
+
52113
+
52114
+
51556
52115
  setSearchParams(localVarUrlObj, localVarQueryParameter);
51557
52116
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
51558
52117
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
@@ -51681,7 +52240,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
51681
52240
  * 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.
51682
52241
  * @summary List a store\'s gift cards, newest first, a page at a time
51683
52242
  * @param {number} businessId The store\&#39;s orderingBusinessId
51684
- * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
52243
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;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\&#39;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. \&quot;040 123 4567\&quot;, \&quot;+358401234567\&quot; and \&quot;401234567\&quot; all find +358 / 40 123 4567. Absent: every card.
51685
52244
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
51686
52245
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
51687
52246
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
@@ -51741,7 +52300,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
51741
52300
  };
51742
52301
  },
51743
52302
  /**
51744
- * 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.
52303
+ * 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.
51745
52304
  * @summary Unblock a gift card
51746
52305
  * @param {number} businessId The store\&#39;s orderingBusinessId
51747
52306
  * @param {string} cardId The card\&#39;s id
@@ -51783,8 +52342,8 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
51783
52342
  };
51784
52343
  },
51785
52344
  /**
51786
- * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
51787
- * @summary Correct a gift card\'s email address
52345
+ * 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.
52346
+ * @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
51788
52347
  * @param {number} businessId The store\&#39;s orderingBusinessId
51789
52348
  * @param {string} cardId The card\&#39;s id
51790
52349
  * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
@@ -51831,7 +52390,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
51831
52390
  };
51832
52391
  },
51833
52392
  /**
51834
- * 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.
52393
+ * 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.
51835
52394
  * @summary Change a store\'s gift card settings
51836
52395
  * @param {number} businessId The store\&#39;s orderingBusinessId
51837
52396
  * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
@@ -51910,11 +52469,11 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
51910
52469
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
51911
52470
  },
51912
52471
  /**
51913
- * 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.
52472
+ * 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.
51914
52473
  * @summary Make a gift card by hand, given for free
51915
52474
  * @param {number} businessId The store\&#39;s orderingBusinessId
51916
52475
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
51917
- * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
52476
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
51918
52477
  * @param {*} [options] Override http request option.
51919
52478
  * @throws {RequiredError}
51920
52479
  */
@@ -51960,6 +52519,17 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
51960
52519
  const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardReport(businessId, from, to, options);
51961
52520
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
51962
52521
  },
52522
+ /**
52523
+ * 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.
52524
+ * @summary Read a store\'s checklist for selling gift cards online
52525
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52526
+ * @param {*} [options] Override http request option.
52527
+ * @throws {RequiredError}
52528
+ */
52529
+ async getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSellingDto>> {
52530
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardSelling(businessId, options);
52531
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
52532
+ },
51963
52533
  /**
51964
52534
  * 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.
51965
52535
  * @summary Read a store\'s gift card settings
@@ -51993,7 +52563,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
51993
52563
  * 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.
51994
52564
  * @summary List a store\'s gift cards, newest first, a page at a time
51995
52565
  * @param {number} businessId The store\&#39;s orderingBusinessId
51996
- * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
52566
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;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\&#39;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. \&quot;040 123 4567\&quot;, \&quot;+358401234567\&quot; and \&quot;401234567\&quot; all find +358 / 40 123 4567. Absent: every card.
51997
52567
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
51998
52568
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
51999
52569
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
@@ -52006,7 +52576,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
52006
52576
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
52007
52577
  },
52008
52578
  /**
52009
- * 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.
52579
+ * 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.
52010
52580
  * @summary Unblock a gift card
52011
52581
  * @param {number} businessId The store\&#39;s orderingBusinessId
52012
52582
  * @param {string} cardId The card\&#39;s id
@@ -52018,8 +52588,8 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
52018
52588
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
52019
52589
  },
52020
52590
  /**
52021
- * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
52022
- * @summary Correct a gift card\'s email address
52591
+ * 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.
52592
+ * @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
52023
52593
  * @param {number} businessId The store\&#39;s orderingBusinessId
52024
52594
  * @param {string} cardId The card\&#39;s id
52025
52595
  * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
@@ -52031,7 +52601,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
52031
52601
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
52032
52602
  },
52033
52603
  /**
52034
- * 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.
52604
+ * 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.
52035
52605
  * @summary Change a store\'s gift card settings
52036
52606
  * @param {number} businessId The store\&#39;s orderingBusinessId
52037
52607
  * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
@@ -52076,11 +52646,11 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
52076
52646
  return localVarFp.blockVenueGiftCard(businessId, cardId, blockVenueGiftCardDto, options).then((request) => request(axios, basePath));
52077
52647
  },
52078
52648
  /**
52079
- * 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.
52649
+ * 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.
52080
52650
  * @summary Make a gift card by hand, given for free
52081
52651
  * @param {number} businessId The store\&#39;s orderingBusinessId
52082
52652
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
52083
- * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
52653
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
52084
52654
  * @param {*} [options] Override http request option.
52085
52655
  * @throws {RequiredError}
52086
52656
  */
@@ -52122,6 +52692,16 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
52122
52692
  getVenueGiftCardReport(businessId: number, from: string, to: string, options?: any): AxiosPromise<GiftCardReportDto> {
52123
52693
  return localVarFp.getVenueGiftCardReport(businessId, from, to, options).then((request) => request(axios, basePath));
52124
52694
  },
52695
+ /**
52696
+ * 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.
52697
+ * @summary Read a store\'s checklist for selling gift cards online
52698
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52699
+ * @param {*} [options] Override http request option.
52700
+ * @throws {RequiredError}
52701
+ */
52702
+ getVenueGiftCardSelling(businessId: number, options?: any): AxiosPromise<GiftCardSellingDto> {
52703
+ return localVarFp.getVenueGiftCardSelling(businessId, options).then((request) => request(axios, basePath));
52704
+ },
52125
52705
  /**
52126
52706
  * 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.
52127
52707
  * @summary Read a store\'s gift card settings
@@ -52153,7 +52733,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
52153
52733
  * 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.
52154
52734
  * @summary List a store\'s gift cards, newest first, a page at a time
52155
52735
  * @param {number} businessId The store\&#39;s orderingBusinessId
52156
- * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
52736
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;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\&#39;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. \&quot;040 123 4567\&quot;, \&quot;+358401234567\&quot; and \&quot;401234567\&quot; all find +358 / 40 123 4567. Absent: every card.
52157
52737
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
52158
52738
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
52159
52739
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
@@ -52165,7 +52745,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
52165
52745
  return localVarFp.listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options).then((request) => request(axios, basePath));
52166
52746
  },
52167
52747
  /**
52168
- * 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.
52748
+ * 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.
52169
52749
  * @summary Unblock a gift card
52170
52750
  * @param {number} businessId The store\&#39;s orderingBusinessId
52171
52751
  * @param {string} cardId The card\&#39;s id
@@ -52176,8 +52756,8 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
52176
52756
  return localVarFp.unblockVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
52177
52757
  },
52178
52758
  /**
52179
- * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
52180
- * @summary Correct a gift card\'s email address
52759
+ * 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.
52760
+ * @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
52181
52761
  * @param {number} businessId The store\&#39;s orderingBusinessId
52182
52762
  * @param {string} cardId The card\&#39;s id
52183
52763
  * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
@@ -52188,7 +52768,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
52188
52768
  return localVarFp.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(axios, basePath));
52189
52769
  },
52190
52770
  /**
52191
- * 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.
52771
+ * 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.
52192
52772
  * @summary Change a store\'s gift card settings
52193
52773
  * @param {number} businessId The store\&#39;s orderingBusinessId
52194
52774
  * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
@@ -52231,11 +52811,11 @@ export interface GiftCardsApiInterface {
52231
52811
  blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
52232
52812
 
52233
52813
  /**
52234
- * 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.
52814
+ * 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.
52235
52815
  * @summary Make a gift card by hand, given for free
52236
52816
  * @param {number} businessId The store\&#39;s orderingBusinessId
52237
52817
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
52238
- * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
52818
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
52239
52819
  * @param {*} [options] Override http request option.
52240
52820
  * @throws {RequiredError}
52241
52821
  * @memberof GiftCardsApiInterface
@@ -52277,6 +52857,16 @@ export interface GiftCardsApiInterface {
52277
52857
  */
52278
52858
  getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<GiftCardReportDto>;
52279
52859
 
52860
+ /**
52861
+ * 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.
52862
+ * @summary Read a store\'s checklist for selling gift cards online
52863
+ * @param {number} businessId The store\&#39;s orderingBusinessId
52864
+ * @param {*} [options] Override http request option.
52865
+ * @throws {RequiredError}
52866
+ * @memberof GiftCardsApiInterface
52867
+ */
52868
+ getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSellingDto>;
52869
+
52280
52870
  /**
52281
52871
  * 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.
52282
52872
  * @summary Read a store\'s gift card settings
@@ -52308,7 +52898,7 @@ export interface GiftCardsApiInterface {
52308
52898
  * 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.
52309
52899
  * @summary List a store\'s gift cards, newest first, a page at a time
52310
52900
  * @param {number} businessId The store\&#39;s orderingBusinessId
52311
- * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
52901
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;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\&#39;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. \&quot;040 123 4567\&quot;, \&quot;+358401234567\&quot; and \&quot;401234567\&quot; all find +358 / 40 123 4567. Absent: every card.
52312
52902
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
52313
52903
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
52314
52904
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
@@ -52320,7 +52910,7 @@ export interface GiftCardsApiInterface {
52320
52910
  listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
52321
52911
 
52322
52912
  /**
52323
- * 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.
52913
+ * 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.
52324
52914
  * @summary Unblock a gift card
52325
52915
  * @param {number} businessId The store\&#39;s orderingBusinessId
52326
52916
  * @param {string} cardId The card\&#39;s id
@@ -52331,8 +52921,8 @@ export interface GiftCardsApiInterface {
52331
52921
  unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
52332
52922
 
52333
52923
  /**
52334
- * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
52335
- * @summary Correct a gift card\'s email address
52924
+ * 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.
52925
+ * @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
52336
52926
  * @param {number} businessId The store\&#39;s orderingBusinessId
52337
52927
  * @param {string} cardId The card\&#39;s id
52338
52928
  * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
@@ -52343,7 +52933,7 @@ export interface GiftCardsApiInterface {
52343
52933
  updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
52344
52934
 
52345
52935
  /**
52346
- * 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.
52936
+ * 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.
52347
52937
  * @summary Change a store\'s gift card settings
52348
52938
  * @param {number} businessId The store\&#39;s orderingBusinessId
52349
52939
  * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
@@ -52390,11 +52980,11 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
52390
52980
  }
52391
52981
 
52392
52982
  /**
52393
- * 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.
52983
+ * 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.
52394
52984
  * @summary Make a gift card by hand, given for free
52395
52985
  * @param {number} businessId The store\&#39;s orderingBusinessId
52396
52986
  * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
52397
- * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
52987
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. 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\&#39;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\&#39;s time). Any other repeat, or a key a till\&#39;s sale used, is refused 400. Without the header every request makes a card.
52398
52988
  * @param {*} [options] Override http request option.
52399
52989
  * @throws {RequiredError}
52400
52990
  * @memberof GiftCardsApi
@@ -52444,6 +53034,18 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
52444
53034
  return GiftCardsApiFp(this.configuration).getVenueGiftCardReport(businessId, from, to, options).then((request) => request(this.axios, this.basePath));
52445
53035
  }
52446
53036
 
53037
+ /**
53038
+ * 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.
53039
+ * @summary Read a store\'s checklist for selling gift cards online
53040
+ * @param {number} businessId The store\&#39;s orderingBusinessId
53041
+ * @param {*} [options] Override http request option.
53042
+ * @throws {RequiredError}
53043
+ * @memberof GiftCardsApi
53044
+ */
53045
+ public getVenueGiftCardSelling(businessId: number, options?: AxiosRequestConfig) {
53046
+ return GiftCardsApiFp(this.configuration).getVenueGiftCardSelling(businessId, options).then((request) => request(this.axios, this.basePath));
53047
+ }
53048
+
52447
53049
  /**
52448
53050
  * 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.
52449
53051
  * @summary Read a store\'s gift card settings
@@ -52479,7 +53081,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
52479
53081
  * 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.
52480
53082
  * @summary List a store\'s gift cards, newest first, a page at a time
52481
53083
  * @param {number} businessId The store\&#39;s orderingBusinessId
52482
- * @param {string} [search] A code that starts with this, or a buyer\&#39;s name or email that contains it, case-insensitive. Absent: every card.
53084
+ * @param {string} [search] A code that starts with this, or a buyer\&#39;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\&#39;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. \&quot;040 123 4567\&quot;, \&quot;+358401234567\&quot; and \&quot;401234567\&quot; all find +358 / 40 123 4567. Absent: every card.
52483
53085
  * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
52484
53086
  * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
52485
53087
  * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
@@ -52493,7 +53095,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
52493
53095
  }
52494
53096
 
52495
53097
  /**
52496
- * 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.
53098
+ * 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.
52497
53099
  * @summary Unblock a gift card
52498
53100
  * @param {number} businessId The store\&#39;s orderingBusinessId
52499
53101
  * @param {string} cardId The card\&#39;s id
@@ -52506,8 +53108,8 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
52506
53108
  }
52507
53109
 
52508
53110
  /**
52509
- * Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
52510
- * @summary Correct a gift card\'s email address
53111
+ * 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.
53112
+ * @summary Correct a gift card\'s email address, its emails\' language, or when its email goes
52511
53113
  * @param {number} businessId The store\&#39;s orderingBusinessId
52512
53114
  * @param {string} cardId The card\&#39;s id
52513
53115
  * @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
@@ -52520,7 +53122,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
52520
53122
  }
52521
53123
 
52522
53124
  /**
52523
- * 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.
53125
+ * 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.
52524
53126
  * @summary Change a store\'s gift card settings
52525
53127
  * @param {number} businessId The store\&#39;s orderingBusinessId
52526
53128
  * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
@@ -53844,6 +54446,364 @@ export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
53844
54446
  }
53845
54447
 
53846
54448
 
54449
+ /**
54450
+ * InternalGiftCardsApi - axios parameter creator
54451
+ * @export
54452
+ */
54453
+ export const InternalGiftCardsApiAxiosParamCreator = function (configuration?: Configuration) {
54454
+ return {
54455
+ /**
54456
+ * 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.
54457
+ * @summary Read what a store\'s online store offers of its gift cards
54458
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54459
+ * @param {*} [options] Override http request option.
54460
+ * @throws {RequiredError}
54461
+ */
54462
+ getVenueGiftCardOffer: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
54463
+ // verify required parameter 'businessId' is not null or undefined
54464
+ assertParamExists('getVenueGiftCardOffer', 'businessId', businessId)
54465
+ const localVarPath = `/api/v2/internal/gift-cards/offers/{businessId}`
54466
+ .replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
54467
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
54468
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
54469
+ let baseOptions;
54470
+ if (configuration) {
54471
+ baseOptions = configuration.baseOptions;
54472
+ }
54473
+
54474
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
54475
+ const localVarHeaderParameter = {} as any;
54476
+ const localVarQueryParameter = {} as any;
54477
+
54478
+
54479
+
54480
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
54481
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
54482
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
54483
+
54484
+ return {
54485
+ url: toPathString(localVarUrlObj),
54486
+ options: localVarRequestOptions,
54487
+ };
54488
+ },
54489
+ /**
54490
+ * 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.
54491
+ * @summary Read the Viva merchant a store\'s POS takes card payments with
54492
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54493
+ * @param {*} [options] Override http request option.
54494
+ * @throws {RequiredError}
54495
+ */
54496
+ getVenuePosVivaMerchant: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
54497
+ // verify required parameter 'businessId' is not null or undefined
54498
+ assertParamExists('getVenuePosVivaMerchant', 'businessId', businessId)
54499
+ const localVarPath = `/api/v2/internal/gift-cards/pos-viva/{businessId}`
54500
+ .replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
54501
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
54502
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
54503
+ let baseOptions;
54504
+ if (configuration) {
54505
+ baseOptions = configuration.baseOptions;
54506
+ }
54507
+
54508
+ const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
54509
+ const localVarHeaderParameter = {} as any;
54510
+ const localVarQueryParameter = {} as any;
54511
+
54512
+
54513
+
54514
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
54515
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
54516
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
54517
+
54518
+ return {
54519
+ url: toPathString(localVarUrlObj),
54520
+ options: localVarRequestOptions,
54521
+ };
54522
+ },
54523
+ /**
54524
+ * 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.
54525
+ * @summary Block the gift card of an online order line before its order is refunded
54526
+ * @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
54527
+ * @param {*} [options] Override http request option.
54528
+ * @throws {RequiredError}
54529
+ */
54530
+ refundOnlineGiftCardSale: async (refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
54531
+ // verify required parameter 'refundOnlineGiftCardSaleDto' is not null or undefined
54532
+ assertParamExists('refundOnlineGiftCardSale', 'refundOnlineGiftCardSaleDto', refundOnlineGiftCardSaleDto)
54533
+ const localVarPath = `/api/v2/internal/gift-cards/online-sale/refund`;
54534
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
54535
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
54536
+ let baseOptions;
54537
+ if (configuration) {
54538
+ baseOptions = configuration.baseOptions;
54539
+ }
54540
+
54541
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
54542
+ const localVarHeaderParameter = {} as any;
54543
+ const localVarQueryParameter = {} as any;
54544
+
54545
+
54546
+
54547
+ localVarHeaderParameter['Content-Type'] = 'application/json';
54548
+
54549
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
54550
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
54551
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
54552
+ localVarRequestOptions.data = serializeDataIfNeeded(refundOnlineGiftCardSaleDto, localVarRequestOptions, configuration)
54553
+
54554
+ return {
54555
+ url: toPathString(localVarUrlObj),
54556
+ options: localVarRequestOptions,
54557
+ };
54558
+ },
54559
+ /**
54560
+ * 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.
54561
+ * @summary Make the gift card an online order line paid for
54562
+ * @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
54563
+ * @param {*} [options] Override http request option.
54564
+ * @throws {RequiredError}
54565
+ */
54566
+ sellGiftCardOnline: async (sellGiftCardOnlineDto: SellGiftCardOnlineDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
54567
+ // verify required parameter 'sellGiftCardOnlineDto' is not null or undefined
54568
+ assertParamExists('sellGiftCardOnline', 'sellGiftCardOnlineDto', sellGiftCardOnlineDto)
54569
+ const localVarPath = `/api/v2/internal/gift-cards/online-sale`;
54570
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
54571
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
54572
+ let baseOptions;
54573
+ if (configuration) {
54574
+ baseOptions = configuration.baseOptions;
54575
+ }
54576
+
54577
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
54578
+ const localVarHeaderParameter = {} as any;
54579
+ const localVarQueryParameter = {} as any;
54580
+
54581
+
54582
+
54583
+ localVarHeaderParameter['Content-Type'] = 'application/json';
54584
+
54585
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
54586
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
54587
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
54588
+ localVarRequestOptions.data = serializeDataIfNeeded(sellGiftCardOnlineDto, localVarRequestOptions, configuration)
54589
+
54590
+ return {
54591
+ url: toPathString(localVarUrlObj),
54592
+ options: localVarRequestOptions,
54593
+ };
54594
+ },
54595
+ }
54596
+ };
54597
+
54598
+ /**
54599
+ * InternalGiftCardsApi - functional programming interface
54600
+ * @export
54601
+ */
54602
+ export const InternalGiftCardsApiFp = function(configuration?: Configuration) {
54603
+ const localVarAxiosParamCreator = InternalGiftCardsApiAxiosParamCreator(configuration)
54604
+ return {
54605
+ /**
54606
+ * 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.
54607
+ * @summary Read what a store\'s online store offers of its gift cards
54608
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54609
+ * @param {*} [options] Override http request option.
54610
+ * @throws {RequiredError}
54611
+ */
54612
+ async getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardOfferDto>> {
54613
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardOffer(businessId, options);
54614
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
54615
+ },
54616
+ /**
54617
+ * 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.
54618
+ * @summary Read the Viva merchant a store\'s POS takes card payments with
54619
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54620
+ * @param {*} [options] Override http request option.
54621
+ * @throws {RequiredError}
54622
+ */
54623
+ async getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosVivaMerchantDto>> {
54624
+ const localVarAxiosArgs = await localVarAxiosParamCreator.getVenuePosVivaMerchant(businessId, options);
54625
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
54626
+ },
54627
+ /**
54628
+ * 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.
54629
+ * @summary Block the gift card of an online order line before its order is refunded
54630
+ * @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
54631
+ * @param {*} [options] Override http request option.
54632
+ * @throws {RequiredError}
54633
+ */
54634
+ async refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardRefundDto>> {
54635
+ const localVarAxiosArgs = await localVarAxiosParamCreator.refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto, options);
54636
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
54637
+ },
54638
+ /**
54639
+ * 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.
54640
+ * @summary Make the gift card an online order line paid for
54641
+ * @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
54642
+ * @param {*} [options] Override http request option.
54643
+ * @throws {RequiredError}
54644
+ */
54645
+ async sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OnlineGiftCardSaleDto>> {
54646
+ const localVarAxiosArgs = await localVarAxiosParamCreator.sellGiftCardOnline(sellGiftCardOnlineDto, options);
54647
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
54648
+ },
54649
+ }
54650
+ };
54651
+
54652
+ /**
54653
+ * InternalGiftCardsApi - factory interface
54654
+ * @export
54655
+ */
54656
+ export const InternalGiftCardsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
54657
+ const localVarFp = InternalGiftCardsApiFp(configuration)
54658
+ return {
54659
+ /**
54660
+ * 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.
54661
+ * @summary Read what a store\'s online store offers of its gift cards
54662
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54663
+ * @param {*} [options] Override http request option.
54664
+ * @throws {RequiredError}
54665
+ */
54666
+ getVenueGiftCardOffer(businessId: number, options?: any): AxiosPromise<GiftCardOfferDto> {
54667
+ return localVarFp.getVenueGiftCardOffer(businessId, options).then((request) => request(axios, basePath));
54668
+ },
54669
+ /**
54670
+ * 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.
54671
+ * @summary Read the Viva merchant a store\'s POS takes card payments with
54672
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54673
+ * @param {*} [options] Override http request option.
54674
+ * @throws {RequiredError}
54675
+ */
54676
+ getVenuePosVivaMerchant(businessId: number, options?: any): AxiosPromise<PosVivaMerchantDto> {
54677
+ return localVarFp.getVenuePosVivaMerchant(businessId, options).then((request) => request(axios, basePath));
54678
+ },
54679
+ /**
54680
+ * 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.
54681
+ * @summary Block the gift card of an online order line before its order is refunded
54682
+ * @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
54683
+ * @param {*} [options] Override http request option.
54684
+ * @throws {RequiredError}
54685
+ */
54686
+ refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: any): AxiosPromise<OnlineGiftCardRefundDto> {
54687
+ return localVarFp.refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto, options).then((request) => request(axios, basePath));
54688
+ },
54689
+ /**
54690
+ * 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.
54691
+ * @summary Make the gift card an online order line paid for
54692
+ * @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
54693
+ * @param {*} [options] Override http request option.
54694
+ * @throws {RequiredError}
54695
+ */
54696
+ sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: any): AxiosPromise<OnlineGiftCardSaleDto> {
54697
+ return localVarFp.sellGiftCardOnline(sellGiftCardOnlineDto, options).then((request) => request(axios, basePath));
54698
+ },
54699
+ };
54700
+ };
54701
+
54702
+ /**
54703
+ * InternalGiftCardsApi - interface
54704
+ * @export
54705
+ * @interface InternalGiftCardsApi
54706
+ */
54707
+ export interface InternalGiftCardsApiInterface {
54708
+ /**
54709
+ * 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.
54710
+ * @summary Read what a store\'s online store offers of its gift cards
54711
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54712
+ * @param {*} [options] Override http request option.
54713
+ * @throws {RequiredError}
54714
+ * @memberof InternalGiftCardsApiInterface
54715
+ */
54716
+ getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardOfferDto>;
54717
+
54718
+ /**
54719
+ * 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.
54720
+ * @summary Read the Viva merchant a store\'s POS takes card payments with
54721
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54722
+ * @param {*} [options] Override http request option.
54723
+ * @throws {RequiredError}
54724
+ * @memberof InternalGiftCardsApiInterface
54725
+ */
54726
+ getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig): AxiosPromise<PosVivaMerchantDto>;
54727
+
54728
+ /**
54729
+ * 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.
54730
+ * @summary Block the gift card of an online order line before its order is refunded
54731
+ * @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
54732
+ * @param {*} [options] Override http request option.
54733
+ * @throws {RequiredError}
54734
+ * @memberof InternalGiftCardsApiInterface
54735
+ */
54736
+ refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardRefundDto>;
54737
+
54738
+ /**
54739
+ * 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.
54740
+ * @summary Make the gift card an online order line paid for
54741
+ * @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
54742
+ * @param {*} [options] Override http request option.
54743
+ * @throws {RequiredError}
54744
+ * @memberof InternalGiftCardsApiInterface
54745
+ */
54746
+ sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig): AxiosPromise<OnlineGiftCardSaleDto>;
54747
+
54748
+ }
54749
+
54750
+ /**
54751
+ * InternalGiftCardsApi - object-oriented interface
54752
+ * @export
54753
+ * @class InternalGiftCardsApi
54754
+ * @extends {BaseAPI}
54755
+ */
54756
+ export class InternalGiftCardsApi extends BaseAPI implements InternalGiftCardsApiInterface {
54757
+ /**
54758
+ * 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.
54759
+ * @summary Read what a store\'s online store offers of its gift cards
54760
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54761
+ * @param {*} [options] Override http request option.
54762
+ * @throws {RequiredError}
54763
+ * @memberof InternalGiftCardsApi
54764
+ */
54765
+ public getVenueGiftCardOffer(businessId: number, options?: AxiosRequestConfig) {
54766
+ return InternalGiftCardsApiFp(this.configuration).getVenueGiftCardOffer(businessId, options).then((request) => request(this.axios, this.basePath));
54767
+ }
54768
+
54769
+ /**
54770
+ * 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.
54771
+ * @summary Read the Viva merchant a store\'s POS takes card payments with
54772
+ * @param {number} businessId The store\&#39;s orderingBusinessId
54773
+ * @param {*} [options] Override http request option.
54774
+ * @throws {RequiredError}
54775
+ * @memberof InternalGiftCardsApi
54776
+ */
54777
+ public getVenuePosVivaMerchant(businessId: number, options?: AxiosRequestConfig) {
54778
+ return InternalGiftCardsApiFp(this.configuration).getVenuePosVivaMerchant(businessId, options).then((request) => request(this.axios, this.basePath));
54779
+ }
54780
+
54781
+ /**
54782
+ * 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.
54783
+ * @summary Block the gift card of an online order line before its order is refunded
54784
+ * @param {RefundOnlineGiftCardSaleDto} refundOnlineGiftCardSaleDto
54785
+ * @param {*} [options] Override http request option.
54786
+ * @throws {RequiredError}
54787
+ * @memberof InternalGiftCardsApi
54788
+ */
54789
+ public refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto: RefundOnlineGiftCardSaleDto, options?: AxiosRequestConfig) {
54790
+ return InternalGiftCardsApiFp(this.configuration).refundOnlineGiftCardSale(refundOnlineGiftCardSaleDto, options).then((request) => request(this.axios, this.basePath));
54791
+ }
54792
+
54793
+ /**
54794
+ * 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.
54795
+ * @summary Make the gift card an online order line paid for
54796
+ * @param {SellGiftCardOnlineDto} sellGiftCardOnlineDto
54797
+ * @param {*} [options] Override http request option.
54798
+ * @throws {RequiredError}
54799
+ * @memberof InternalGiftCardsApi
54800
+ */
54801
+ public sellGiftCardOnline(sellGiftCardOnlineDto: SellGiftCardOnlineDto, options?: AxiosRequestConfig) {
54802
+ return InternalGiftCardsApiFp(this.configuration).sellGiftCardOnline(sellGiftCardOnlineDto, options).then((request) => request(this.axios, this.basePath));
54803
+ }
54804
+ }
54805
+
54806
+
53847
54807
  /**
53848
54808
  * InvoiceCompaniesApi - axios parameter creator
53849
54809
  * @export
@@ -76658,6 +77618,50 @@ export const VenueKiosksApiAxiosParamCreator = function (configuration?: Configu
76658
77618
  options: localVarRequestOptions,
76659
77619
  };
76660
77620
  },
77621
+ /**
77622
+ * Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
77623
+ * @summary Add a payment terminal to the venue (Munchi admins only)
77624
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
77625
+ * @param {CreatePaymentTerminalDto} createPaymentTerminalDto
77626
+ * @param {*} [options] Override http request option.
77627
+ * @throws {RequiredError}
77628
+ */
77629
+ createVenuePaymentTerminal: async (businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
77630
+ // verify required parameter 'businessId' is not null or undefined
77631
+ assertParamExists('createVenuePaymentTerminal', 'businessId', businessId)
77632
+ // verify required parameter 'createPaymentTerminalDto' is not null or undefined
77633
+ assertParamExists('createVenuePaymentTerminal', 'createPaymentTerminalDto', createPaymentTerminalDto)
77634
+ const localVarPath = `/api/v2/venues/{businessId}/payment-terminals`
77635
+ .replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
77636
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
77637
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
77638
+ let baseOptions;
77639
+ if (configuration) {
77640
+ baseOptions = configuration.baseOptions;
77641
+ }
77642
+
77643
+ const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
77644
+ const localVarHeaderParameter = {} as any;
77645
+ const localVarQueryParameter = {} as any;
77646
+
77647
+ // authentication JWT-auth required
77648
+ // http bearer authentication required
77649
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
77650
+
77651
+
77652
+
77653
+ localVarHeaderParameter['Content-Type'] = 'application/json';
77654
+
77655
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
77656
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
77657
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77658
+ localVarRequestOptions.data = serializeDataIfNeeded(createPaymentTerminalDto, localVarRequestOptions, configuration)
77659
+
77660
+ return {
77661
+ url: toPathString(localVarUrlObj),
77662
+ options: localVarRequestOptions,
77663
+ };
77664
+ },
76661
77665
  /**
76662
77666
  * paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
76663
77667
  * @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
@@ -76745,7 +77749,7 @@ export const VenueKiosksApiAxiosParamCreator = function (configuration?: Configu
76745
77749
  };
76746
77750
  },
76747
77751
  /**
76748
- * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
77752
+ * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
76749
77753
  * @summary List the venue\'s payment terminals, for linking one to a kiosk
76750
77754
  * @param {number} businessId The venue\&#39;s orderingBusinessId
76751
77755
  * @param {*} [options] Override http request option.
@@ -76819,6 +77823,96 @@ export const VenueKiosksApiAxiosParamCreator = function (configuration?: Configu
76819
77823
  let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
76820
77824
  localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
76821
77825
 
77826
+ return {
77827
+ url: toPathString(localVarUrlObj),
77828
+ options: localVarRequestOptions,
77829
+ };
77830
+ },
77831
+ /**
77832
+ * The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
77833
+ * @summary Remove a payment terminal from the venue (Munchi admins only)
77834
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
77835
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
77836
+ * @param {*} [options] Override http request option.
77837
+ * @throws {RequiredError}
77838
+ */
77839
+ removeVenuePaymentTerminal: async (businessId: number, paymentTerminalId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
77840
+ // verify required parameter 'businessId' is not null or undefined
77841
+ assertParamExists('removeVenuePaymentTerminal', 'businessId', businessId)
77842
+ // verify required parameter 'paymentTerminalId' is not null or undefined
77843
+ assertParamExists('removeVenuePaymentTerminal', 'paymentTerminalId', paymentTerminalId)
77844
+ const localVarPath = `/api/v2/venues/{businessId}/payment-terminals/{paymentTerminalId}`
77845
+ .replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
77846
+ .replace(`{${"paymentTerminalId"}}`, encodeURIComponent(String(paymentTerminalId)));
77847
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
77848
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
77849
+ let baseOptions;
77850
+ if (configuration) {
77851
+ baseOptions = configuration.baseOptions;
77852
+ }
77853
+
77854
+ const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
77855
+ const localVarHeaderParameter = {} as any;
77856
+ const localVarQueryParameter = {} as any;
77857
+
77858
+ // authentication JWT-auth required
77859
+ // http bearer authentication required
77860
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
77861
+
77862
+
77863
+
77864
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
77865
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
77866
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77867
+
77868
+ return {
77869
+ url: toPathString(localVarUrlObj),
77870
+ options: localVarRequestOptions,
77871
+ };
77872
+ },
77873
+ /**
77874
+ * Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
77875
+ * @summary Rename one of the venue\'s payment terminals (Munchi admins only)
77876
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
77877
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
77878
+ * @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
77879
+ * @param {*} [options] Override http request option.
77880
+ * @throws {RequiredError}
77881
+ */
77882
+ renameVenuePaymentTerminal: async (businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
77883
+ // verify required parameter 'businessId' is not null or undefined
77884
+ assertParamExists('renameVenuePaymentTerminal', 'businessId', businessId)
77885
+ // verify required parameter 'paymentTerminalId' is not null or undefined
77886
+ assertParamExists('renameVenuePaymentTerminal', 'paymentTerminalId', paymentTerminalId)
77887
+ // verify required parameter 'renamePaymentTerminalDto' is not null or undefined
77888
+ assertParamExists('renameVenuePaymentTerminal', 'renamePaymentTerminalDto', renamePaymentTerminalDto)
77889
+ const localVarPath = `/api/v2/venues/{businessId}/payment-terminals/{paymentTerminalId}`
77890
+ .replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
77891
+ .replace(`{${"paymentTerminalId"}}`, encodeURIComponent(String(paymentTerminalId)));
77892
+ // use dummy base URL string because the URL constructor only accepts absolute URLs.
77893
+ const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
77894
+ let baseOptions;
77895
+ if (configuration) {
77896
+ baseOptions = configuration.baseOptions;
77897
+ }
77898
+
77899
+ const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
77900
+ const localVarHeaderParameter = {} as any;
77901
+ const localVarQueryParameter = {} as any;
77902
+
77903
+ // authentication JWT-auth required
77904
+ // http bearer authentication required
77905
+ await setBearerAuthToObject(localVarHeaderParameter, configuration)
77906
+
77907
+
77908
+
77909
+ localVarHeaderParameter['Content-Type'] = 'application/json';
77910
+
77911
+ setSearchParams(localVarUrlObj, localVarQueryParameter);
77912
+ let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
77913
+ localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
77914
+ localVarRequestOptions.data = serializeDataIfNeeded(renamePaymentTerminalDto, localVarRequestOptions, configuration)
77915
+
76822
77916
  return {
76823
77917
  url: toPathString(localVarUrlObj),
76824
77918
  options: localVarRequestOptions,
@@ -76859,6 +77953,18 @@ export const VenueKiosksApiFp = function(configuration?: Configuration) {
76859
77953
  const localVarAxiosArgs = await localVarAxiosParamCreator.claimVenueKiosk(businessId, claimKioskDto, options);
76860
77954
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
76861
77955
  },
77956
+ /**
77957
+ * Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
77958
+ * @summary Add a payment terminal to the venue (Munchi admins only)
77959
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
77960
+ * @param {CreatePaymentTerminalDto} createPaymentTerminalDto
77961
+ * @param {*} [options] Override http request option.
77962
+ * @throws {RequiredError}
77963
+ */
77964
+ async createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>> {
77965
+ const localVarAxiosArgs = await localVarAxiosParamCreator.createVenuePaymentTerminal(businessId, createPaymentTerminalDto, options);
77966
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
77967
+ },
76862
77968
  /**
76863
77969
  * paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
76864
77970
  * @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
@@ -76884,7 +77990,7 @@ export const VenueKiosksApiFp = function(configuration?: Configuration) {
76884
77990
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
76885
77991
  },
76886
77992
  /**
76887
- * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
77993
+ * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
76888
77994
  * @summary List the venue\'s payment terminals, for linking one to a kiosk
76889
77995
  * @param {number} businessId The venue\&#39;s orderingBusinessId
76890
77996
  * @param {*} [options] Override http request option.
@@ -76906,6 +78012,31 @@ export const VenueKiosksApiFp = function(configuration?: Configuration) {
76906
78012
  const localVarAxiosArgs = await localVarAxiosParamCreator.removeVenueKiosk(businessId, stationId, options);
76907
78013
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
76908
78014
  },
78015
+ /**
78016
+ * The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
78017
+ * @summary Remove a payment terminal from the venue (Munchi admins only)
78018
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78019
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78020
+ * @param {*} [options] Override http request option.
78021
+ * @throws {RequiredError}
78022
+ */
78023
+ async removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>> {
78024
+ const localVarAxiosArgs = await localVarAxiosParamCreator.removeVenuePaymentTerminal(businessId, paymentTerminalId, options);
78025
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
78026
+ },
78027
+ /**
78028
+ * Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
78029
+ * @summary Rename one of the venue\'s payment terminals (Munchi admins only)
78030
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78031
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78032
+ * @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
78033
+ * @param {*} [options] Override http request option.
78034
+ * @throws {RequiredError}
78035
+ */
78036
+ async renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenuePaymentTerminalDto>> {
78037
+ const localVarAxiosArgs = await localVarAxiosParamCreator.renameVenuePaymentTerminal(businessId, paymentTerminalId, renamePaymentTerminalDto, options);
78038
+ return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
78039
+ },
76909
78040
  }
76910
78041
  };
76911
78042
 
@@ -76939,6 +78070,17 @@ export const VenueKiosksApiFactory = function (configuration?: Configuration, ba
76939
78070
  claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: any): AxiosPromise<VenueKioskDto> {
76940
78071
  return localVarFp.claimVenueKiosk(businessId, claimKioskDto, options).then((request) => request(axios, basePath));
76941
78072
  },
78073
+ /**
78074
+ * Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
78075
+ * @summary Add a payment terminal to the venue (Munchi admins only)
78076
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78077
+ * @param {CreatePaymentTerminalDto} createPaymentTerminalDto
78078
+ * @param {*} [options] Override http request option.
78079
+ * @throws {RequiredError}
78080
+ */
78081
+ createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: any): AxiosPromise<VenuePaymentTerminalDto> {
78082
+ return localVarFp.createVenuePaymentTerminal(businessId, createPaymentTerminalDto, options).then((request) => request(axios, basePath));
78083
+ },
76942
78084
  /**
76943
78085
  * paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
76944
78086
  * @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
@@ -76962,7 +78104,7 @@ export const VenueKiosksApiFactory = function (configuration?: Configuration, ba
76962
78104
  return localVarFp.listVenueKiosks(businessId, options).then((request) => request(axios, basePath));
76963
78105
  },
76964
78106
  /**
76965
- * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
78107
+ * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
76966
78108
  * @summary List the venue\'s payment terminals, for linking one to a kiosk
76967
78109
  * @param {number} businessId The venue\&#39;s orderingBusinessId
76968
78110
  * @param {*} [options] Override http request option.
@@ -76982,6 +78124,29 @@ export const VenueKiosksApiFactory = function (configuration?: Configuration, ba
76982
78124
  removeVenueKiosk(businessId: number, stationId: string, options?: any): AxiosPromise<VenueKioskDto> {
76983
78125
  return localVarFp.removeVenueKiosk(businessId, stationId, options).then((request) => request(axios, basePath));
76984
78126
  },
78127
+ /**
78128
+ * The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
78129
+ * @summary Remove a payment terminal from the venue (Munchi admins only)
78130
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78131
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78132
+ * @param {*} [options] Override http request option.
78133
+ * @throws {RequiredError}
78134
+ */
78135
+ removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: any): AxiosPromise<VenuePaymentTerminalDto> {
78136
+ return localVarFp.removeVenuePaymentTerminal(businessId, paymentTerminalId, options).then((request) => request(axios, basePath));
78137
+ },
78138
+ /**
78139
+ * Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
78140
+ * @summary Rename one of the venue\'s payment terminals (Munchi admins only)
78141
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78142
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78143
+ * @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
78144
+ * @param {*} [options] Override http request option.
78145
+ * @throws {RequiredError}
78146
+ */
78147
+ renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: any): AxiosPromise<VenuePaymentTerminalDto> {
78148
+ return localVarFp.renameVenuePaymentTerminal(businessId, paymentTerminalId, renamePaymentTerminalDto, options).then((request) => request(axios, basePath));
78149
+ },
76985
78150
  };
76986
78151
  };
76987
78152
 
@@ -77014,6 +78179,17 @@ export interface VenueKiosksApiInterface {
77014
78179
  */
77015
78180
  claimVenueKiosk(businessId: number, claimKioskDto: ClaimKioskDto, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
77016
78181
 
78182
+ /**
78183
+ * Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
78184
+ * @summary Add a payment terminal to the venue (Munchi admins only)
78185
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78186
+ * @param {CreatePaymentTerminalDto} createPaymentTerminalDto
78187
+ * @param {*} [options] Override http request option.
78188
+ * @throws {RequiredError}
78189
+ * @memberof VenueKiosksApiInterface
78190
+ */
78191
+ createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
78192
+
77017
78193
  /**
77018
78194
  * paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
77019
78195
  * @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
@@ -77037,7 +78213,7 @@ export interface VenueKiosksApiInterface {
77037
78213
  listVenueKiosks(businessId: number, options?: AxiosRequestConfig): AxiosPromise<VenueKiosksDto>;
77038
78214
 
77039
78215
  /**
77040
- * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
78216
+ * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
77041
78217
  * @summary List the venue\'s payment terminals, for linking one to a kiosk
77042
78218
  * @param {number} businessId The venue\&#39;s orderingBusinessId
77043
78219
  * @param {*} [options] Override http request option.
@@ -77057,6 +78233,29 @@ export interface VenueKiosksApiInterface {
77057
78233
  */
77058
78234
  removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig): AxiosPromise<VenueKioskDto>;
77059
78235
 
78236
+ /**
78237
+ * The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
78238
+ * @summary Remove a payment terminal from the venue (Munchi admins only)
78239
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78240
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78241
+ * @param {*} [options] Override http request option.
78242
+ * @throws {RequiredError}
78243
+ * @memberof VenueKiosksApiInterface
78244
+ */
78245
+ removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
78246
+
78247
+ /**
78248
+ * Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
78249
+ * @summary Rename one of the venue\'s payment terminals (Munchi admins only)
78250
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78251
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78252
+ * @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
78253
+ * @param {*} [options] Override http request option.
78254
+ * @throws {RequiredError}
78255
+ * @memberof VenueKiosksApiInterface
78256
+ */
78257
+ renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig): AxiosPromise<VenuePaymentTerminalDto>;
78258
+
77060
78259
  }
77061
78260
 
77062
78261
  /**
@@ -77093,6 +78292,19 @@ export class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
77093
78292
  return VenueKiosksApiFp(this.configuration).claimVenueKiosk(businessId, claimKioskDto, options).then((request) => request(this.axios, this.basePath));
77094
78293
  }
77095
78294
 
78295
+ /**
78296
+ * Munchi ops store a card terminal for the venue by the id its provider gives it, so a kiosk or till can take it. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161); the venue\'s own logins are refused. hardwareId is checked against its provider\'s shape: Viva\'s and Nets\' terminal ID (TID) are digits, a Worldline terminal\'s serial number letters and digits. The provider is not asked: the terminal must already be registered on the venue\'s account at the provider, or its payments are refused there. The terminal is stored free, linked to no station. A terminal id the venue already stores, under any provider, is refused; so is a Worldline terminal another venue stores, since Worldline finds a terminal by its id alone. Viva and Nets terminals may be stored at several venues, as discover stores them.
78297
+ * @summary Add a payment terminal to the venue (Munchi admins only)
78298
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78299
+ * @param {CreatePaymentTerminalDto} createPaymentTerminalDto
78300
+ * @param {*} [options] Override http request option.
78301
+ * @throws {RequiredError}
78302
+ * @memberof VenueKiosksApi
78303
+ */
78304
+ public createVenuePaymentTerminal(businessId: number, createPaymentTerminalDto: CreatePaymentTerminalDto, options?: AxiosRequestConfig) {
78305
+ return VenueKiosksApiFp(this.configuration).createVenuePaymentTerminal(businessId, createPaymentTerminalDto, options).then((request) => request(this.axios, this.basePath));
78306
+ }
78307
+
77096
78308
  /**
77097
78309
  * paymentTerminalId names one of the venue\'s stored terminals, or null unlinks the kiosk\'s terminal. A terminal another kiosk or till holds is refused, never taken from it. The kiosk\'s kept station is forgotten, so the kiosk pays on the new terminal from its next request.
77098
78310
  * @summary Link one of the venue\'s payment terminals to a kiosk, or unlink it
@@ -77120,7 +78332,7 @@ export class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
77120
78332
  }
77121
78333
 
77122
78334
  /**
77123
- * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover); this route asks no provider.
78335
+ * The venue\'s stored terminals, oldest first, each with the station it is linked to. A terminal is stored once a till discovered it at its provider (POST /v1/terminal/discover), or once Munchi ops added it (POST payment-terminals); this route asks no provider.
77124
78336
  * @summary List the venue\'s payment terminals, for linking one to a kiosk
77125
78337
  * @param {number} businessId The venue\&#39;s orderingBusinessId
77126
78338
  * @param {*} [options] Override http request option.
@@ -77143,6 +78355,33 @@ export class VenueKiosksApi extends BaseAPI implements VenueKiosksApiInterface {
77143
78355
  public removeVenueKiosk(businessId: number, stationId: string, options?: AxiosRequestConfig) {
77144
78356
  return VenueKiosksApiFp(this.configuration).removeVenueKiosk(businessId, stationId, options).then((request) => request(this.axios, this.basePath));
77145
78357
  }
78358
+
78359
+ /**
78360
+ * The terminal\'s row is deleted; payments made on it keep its id in their own records. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Refused while a kiosk or till holds the terminal, and while a payment, reversal or refund started on it in the last 24 hours is still waiting on the terminal. Both are read under a lock on the terminal, so a link made meanwhile is never undone silently. A Viva or Nets terminal still on the venue\'s provider account is stored again on a till\'s next discover.
78361
+ * @summary Remove a payment terminal from the venue (Munchi admins only)
78362
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78363
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78364
+ * @param {*} [options] Override http request option.
78365
+ * @throws {RequiredError}
78366
+ * @memberof VenueKiosksApi
78367
+ */
78368
+ public removeVenuePaymentTerminal(businessId: number, paymentTerminalId: string, options?: AxiosRequestConfig) {
78369
+ return VenueKiosksApiFp(this.configuration).removeVenuePaymentTerminal(businessId, paymentTerminalId, options).then((request) => request(this.axios, this.basePath));
78370
+ }
78371
+
78372
+ /**
78373
+ * Only the label changes; the provider and its terminal id stay, and a kiosk or till holding the terminal keeps paying on it and shows the new label from its next request. Only a Munchi admin\'s ticket or Munchi\'s own Clerk key may (D161). Two renames at once both write; the later one\'s label stays.
78374
+ * @summary Rename one of the venue\'s payment terminals (Munchi admins only)
78375
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
78376
+ * @param {string} paymentTerminalId The payment terminal\&#39;s id, as the venue\&#39;s terminal list answers it
78377
+ * @param {RenamePaymentTerminalDto} renamePaymentTerminalDto
78378
+ * @param {*} [options] Override http request option.
78379
+ * @throws {RequiredError}
78380
+ * @memberof VenueKiosksApi
78381
+ */
78382
+ public renameVenuePaymentTerminal(businessId: number, paymentTerminalId: string, renamePaymentTerminalDto: RenamePaymentTerminalDto, options?: AxiosRequestConfig) {
78383
+ return VenueKiosksApiFp(this.configuration).renameVenuePaymentTerminal(businessId, paymentTerminalId, renamePaymentTerminalDto, options).then((request) => request(this.axios, this.basePath));
78384
+ }
77146
78385
  }
77147
78386
 
77148
78387