@munchi_oy/core 2.11.1 → 2.12.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.
@@ -709,6 +709,19 @@ export declare const BasketNotPricedReason: {
709
709
  readonly Unavailable: "UNAVAILABLE";
710
710
  };
711
711
  export type BasketNotPricedReason = typeof BasketNotPricedReason[keyof typeof BasketNotPricedReason];
712
+ /**
713
+ *
714
+ * @export
715
+ * @interface BlockVenueGiftCardDto
716
+ */
717
+ export interface BlockVenueGiftCardDto {
718
+ /**
719
+ * Why the card is blocked, 1 to 200 characters. Absent: no reason.
720
+ * @type {string}
721
+ * @memberof BlockVenueGiftCardDto
722
+ */
723
+ 'reason'?: string;
724
+ }
712
725
  /**
713
726
  *
714
727
  * @export
@@ -1458,6 +1471,8 @@ export interface BusinessLoyaltyPlan {
1458
1471
  */
1459
1472
  export declare const BusinessPaymentIntegrationType: {
1460
1473
  readonly GiftCard: "GiftCard";
1474
+ readonly MunchiGiftCard: "MunchiGiftCard";
1475
+ readonly Epassi: "Epassi";
1461
1476
  };
1462
1477
  export type BusinessPaymentIntegrationType = typeof BusinessPaymentIntegrationType[keyof typeof BusinessPaymentIntegrationType];
1463
1478
  /**
@@ -4599,6 +4614,12 @@ export interface CreateMunchiGiftCardDto {
4599
4614
  * @memberof CreateMunchiGiftCardDto
4600
4615
  */
4601
4616
  'expiresAt'?: string;
4617
+ /**
4618
+ * The till order the card is sold on. With it the card is PENDING, so it cannot pay, until that order is paid; without it (older tills) the card can pay at once, as before
4619
+ * @type {string}
4620
+ * @memberof CreateMunchiGiftCardDto
4621
+ */
4622
+ 'orderId'?: string;
4602
4623
  }
4603
4624
  /**
4604
4625
  *
@@ -4690,6 +4711,12 @@ export interface CreateMunchiGiftCardResponseDto {
4690
4711
  * @memberof CreateMunchiGiftCardResponseDto
4691
4712
  */
4692
4713
  'createdAt': string;
4714
+ /**
4715
+ *
4716
+ * @type {GiftCardStatus}
4717
+ * @memberof CreateMunchiGiftCardResponseDto
4718
+ */
4719
+ 'status'?: GiftCardStatus;
4693
4720
  }
4694
4721
  /**
4695
4722
  *
@@ -5145,6 +5172,37 @@ export interface CreateTerminalPaymentDto {
5145
5172
  */
5146
5173
  'showTransactionResult'?: boolean;
5147
5174
  }
5175
+ /**
5176
+ *
5177
+ * @export
5178
+ * @interface CreateVenueGiftCardDto
5179
+ */
5180
+ export interface CreateVenueGiftCardDto {
5181
+ /**
5182
+ * The card\'s balance, in cents, 100 to 100000
5183
+ * @type {number}
5184
+ * @memberof CreateVenueGiftCardDto
5185
+ */
5186
+ 'amount': number;
5187
+ /**
5188
+ * Whom the card is for, 1 to 120 characters. Absent: nobody is named.
5189
+ * @type {string}
5190
+ * @memberof CreateVenueGiftCardDto
5191
+ */
5192
+ 'recipientName'?: string;
5193
+ /**
5194
+ * A note for the merchant, 1 to 500 characters. Absent: none.
5195
+ * @type {string}
5196
+ * @memberof CreateVenueGiftCardDto
5197
+ */
5198
+ 'note'?: string;
5199
+ /**
5200
+ * When the card stops working, ISO 8601 date-time, not in the past. Absent or null: the settings\' validityMonths from now, or never when that is null.
5201
+ * @type {string}
5202
+ * @memberof CreateVenueGiftCardDto
5203
+ */
5204
+ 'expiresAt'?: string | null;
5205
+ }
5148
5206
  /**
5149
5207
  *
5150
5208
  * @export
@@ -8424,6 +8482,35 @@ export interface GetStationResponseDtoStation {
8424
8482
  */
8425
8483
  'paymentTerminal'?: StationDetailsDtoPaymentTerminal | null;
8426
8484
  }
8485
+ /**
8486
+ *
8487
+ * @export
8488
+ * @enum {string}
8489
+ */
8490
+ export declare const GiftCardChannel: {
8491
+ readonly Till: "TILL";
8492
+ readonly OnlineStore: "ONLINE_STORE";
8493
+ };
8494
+ export type GiftCardChannel = typeof GiftCardChannel[keyof typeof GiftCardChannel];
8495
+ /**
8496
+ *
8497
+ * @export
8498
+ * @interface GiftCardChannelsDto
8499
+ */
8500
+ export interface GiftCardChannelsDto {
8501
+ /**
8502
+ * Whether the store\'s till takes gift cards
8503
+ * @type {boolean}
8504
+ * @memberof GiftCardChannelsDto
8505
+ */
8506
+ 'till': boolean;
8507
+ /**
8508
+ * Whether the store\'s online store takes gift cards
8509
+ * @type {boolean}
8510
+ * @memberof GiftCardChannelsDto
8511
+ */
8512
+ 'onlineStore': boolean;
8513
+ }
8427
8514
  /**
8428
8515
  *
8429
8516
  * @export
@@ -8537,6 +8624,71 @@ export declare const GiftCardErrorCode: {
8537
8624
  readonly NUMBER_4001: 4001;
8538
8625
  };
8539
8626
  export type GiftCardErrorCode = typeof GiftCardErrorCode[keyof typeof GiftCardErrorCode];
8627
+ /**
8628
+ *
8629
+ * @export
8630
+ * @interface GiftCardHistoryEventDto
8631
+ */
8632
+ export interface GiftCardHistoryEventDto {
8633
+ /**
8634
+ *
8635
+ * @type {GiftCardHistoryKind}
8636
+ * @memberof GiftCardHistoryEventDto
8637
+ */
8638
+ 'kind': GiftCardHistoryKind;
8639
+ /**
8640
+ * How much moved, in cents: never negative, except CORRECTED, which is negative when the correction took money off the card; 0 for BLOCKED, UNBLOCKED and SWITCHED_ON
8641
+ * @type {number}
8642
+ * @memberof GiftCardHistoryEventDto
8643
+ */
8644
+ 'amount': number;
8645
+ /**
8646
+ * The card\'s balance after it, in cents; null for BLOCKED, UNBLOCKED and SWITCHED_ON
8647
+ * @type {number}
8648
+ * @memberof GiftCardHistoryEventDto
8649
+ */
8650
+ 'balanceAfter': number | null;
8651
+ /**
8652
+ * The store where it happened; null when the history did not record one
8653
+ * @type {number}
8654
+ * @memberof GiftCardHistoryEventDto
8655
+ */
8656
+ 'venueId': number | null;
8657
+ /**
8658
+ * That store\'s name; null with venueId, or when the store is gone
8659
+ * @type {string}
8660
+ * @memberof GiftCardHistoryEventDto
8661
+ */
8662
+ 'venueName': string | null;
8663
+ /**
8664
+ * The till order it belongs to; null when none
8665
+ * @type {string}
8666
+ * @memberof GiftCardHistoryEventDto
8667
+ */
8668
+ 'orderId': string | null;
8669
+ /**
8670
+ * When it happened, ISO 8601
8671
+ * @type {string}
8672
+ * @memberof GiftCardHistoryEventDto
8673
+ */
8674
+ 'at': string;
8675
+ }
8676
+ /**
8677
+ *
8678
+ * @export
8679
+ * @enum {string}
8680
+ */
8681
+ export declare const GiftCardHistoryKind: {
8682
+ readonly Sold: "SOLD";
8683
+ readonly CreatedByHand: "CREATED_BY_HAND";
8684
+ readonly Spent: "SPENT";
8685
+ readonly GivenBack: "GIVEN_BACK";
8686
+ readonly Corrected: "CORRECTED";
8687
+ readonly Blocked: "BLOCKED";
8688
+ readonly Unblocked: "UNBLOCKED";
8689
+ readonly SwitchedOn: "SWITCHED_ON";
8690
+ };
8691
+ export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
8540
8692
  /**
8541
8693
  *
8542
8694
  * @export
@@ -8580,6 +8732,17 @@ export interface GiftCardInfoDto {
8580
8732
  */
8581
8733
  'giftCardNumber': string;
8582
8734
  }
8735
+ /**
8736
+ *
8737
+ * @export
8738
+ * @enum {string}
8739
+ */
8740
+ export declare const GiftCardIssue: {
8741
+ readonly TillSale: "TILL_SALE";
8742
+ readonly OnlineSale: "ONLINE_SALE";
8743
+ readonly ByHand: "BY_HAND";
8744
+ };
8745
+ export type GiftCardIssue = typeof GiftCardIssue[keyof typeof GiftCardIssue];
8583
8746
  /**
8584
8747
  *
8585
8748
  * @export
@@ -8599,6 +8762,403 @@ export interface GiftCardLinksDto {
8599
8762
  */
8600
8763
  'validate'?: string;
8601
8764
  }
8765
+ /**
8766
+ *
8767
+ * @export
8768
+ * @interface GiftCardMoneyDto
8769
+ */
8770
+ export interface GiftCardMoneyDto {
8771
+ /**
8772
+ * The sum, in cents
8773
+ * @type {number}
8774
+ * @memberof GiftCardMoneyDto
8775
+ */
8776
+ 'amount': number;
8777
+ /**
8778
+ * How many cards
8779
+ * @type {number}
8780
+ * @memberof GiftCardMoneyDto
8781
+ */
8782
+ 'count': number;
8783
+ }
8784
+ /**
8785
+ *
8786
+ * @export
8787
+ * @interface GiftCardReportDto
8788
+ */
8789
+ export interface GiftCardReportDto {
8790
+ /**
8791
+ *
8792
+ * @type {CurrencyCode}
8793
+ * @memberof GiftCardReportDto
8794
+ */
8795
+ 'currency': CurrencyCode;
8796
+ /**
8797
+ *
8798
+ * @type {GiftCardReportDtoSold}
8799
+ * @memberof GiftCardReportDto
8800
+ */
8801
+ 'sold': GiftCardReportDtoSold;
8802
+ /**
8803
+ *
8804
+ * @type {GiftCardReportDtoGivenFree}
8805
+ * @memberof GiftCardReportDto
8806
+ */
8807
+ 'givenFree': GiftCardReportDtoGivenFree;
8808
+ /**
8809
+ *
8810
+ * @type {GiftCardReportDtoSpent}
8811
+ * @memberof GiftCardReportDto
8812
+ */
8813
+ 'spent': GiftCardReportDtoSpent;
8814
+ /**
8815
+ * Right now, what is left on the owner\'s cards that are ACTIVE, in cents
8816
+ * @type {number}
8817
+ * @memberof GiftCardReportDto
8818
+ */
8819
+ 'leftOnCards': number;
8820
+ /**
8821
+ * One row per store with any movement in the period
8822
+ * @type {Array<GiftCardStoreReportDto>}
8823
+ * @memberof GiftCardReportDto
8824
+ */
8825
+ 'stores': Array<GiftCardStoreReportDto>;
8826
+ }
8827
+ /**
8828
+ * Cards made by hand in the period
8829
+ * @export
8830
+ * @interface GiftCardReportDtoGivenFree
8831
+ */
8832
+ export interface GiftCardReportDtoGivenFree {
8833
+ /**
8834
+ * The sum, in cents
8835
+ * @type {number}
8836
+ * @memberof GiftCardReportDtoGivenFree
8837
+ */
8838
+ 'amount': number;
8839
+ /**
8840
+ * How many cards
8841
+ * @type {number}
8842
+ * @memberof GiftCardReportDtoGivenFree
8843
+ */
8844
+ 'count': number;
8845
+ }
8846
+ /**
8847
+ * Cards sold in the period, at the till or online
8848
+ * @export
8849
+ * @interface GiftCardReportDtoSold
8850
+ */
8851
+ export interface GiftCardReportDtoSold {
8852
+ /**
8853
+ * The sum, in cents
8854
+ * @type {number}
8855
+ * @memberof GiftCardReportDtoSold
8856
+ */
8857
+ 'amount': number;
8858
+ /**
8859
+ * How many cards
8860
+ * @type {number}
8861
+ * @memberof GiftCardReportDtoSold
8862
+ */
8863
+ 'count': number;
8864
+ }
8865
+ /**
8866
+ * Cards spent in the period
8867
+ * @export
8868
+ * @interface GiftCardReportDtoSpent
8869
+ */
8870
+ export interface GiftCardReportDtoSpent {
8871
+ /**
8872
+ * Taken off cards, less what went back on them, in cents
8873
+ * @type {number}
8874
+ * @memberof GiftCardReportDtoSpent
8875
+ */
8876
+ 'amount': number;
8877
+ /**
8878
+ * How many orders cards paid that kept the payment
8879
+ * @type {number}
8880
+ * @memberof GiftCardReportDtoSpent
8881
+ */
8882
+ 'orderCount': number;
8883
+ }
8884
+ /**
8885
+ *
8886
+ * @export
8887
+ * @interface GiftCardSettingsDto
8888
+ */
8889
+ export interface GiftCardSettingsDto {
8890
+ /**
8891
+ *
8892
+ * @type {GiftCardSettingsDtoChannels}
8893
+ * @memberof GiftCardSettingsDto
8894
+ */
8895
+ 'channels': GiftCardSettingsDtoChannels;
8896
+ /**
8897
+ * The store\'s own channels that are on and can take gift cards: TILL for its till, ONLINE_STORE for its online store. A kiosk is never listed.
8898
+ * @type {Array<GiftCardChannel>}
8899
+ * @memberof GiftCardSettingsDto
8900
+ */
8901
+ 'availableChannels': Array<GiftCardChannel>;
8902
+ /**
8903
+ * The amounts offered, in cents, ascending
8904
+ * @type {Array<number>}
8905
+ * @memberof GiftCardSettingsDto
8906
+ */
8907
+ 'amounts': Array<number>;
8908
+ /**
8909
+ * Whether a buyer may choose any amount
8910
+ * @type {boolean}
8911
+ * @memberof GiftCardSettingsDto
8912
+ */
8913
+ 'anyAmount': boolean;
8914
+ /**
8915
+ * The smallest amount a buyer may choose, in cents
8916
+ * @type {number}
8917
+ * @memberof GiftCardSettingsDto
8918
+ */
8919
+ 'minAmount': number;
8920
+ /**
8921
+ * The largest amount a buyer may choose, in cents
8922
+ * @type {number}
8923
+ * @memberof GiftCardSettingsDto
8924
+ */
8925
+ 'maxAmount': number;
8926
+ /**
8927
+ * How many months a new card stays valid; null when cards never expire
8928
+ * @type {number}
8929
+ * @memberof GiftCardSettingsDto
8930
+ */
8931
+ 'validityMonths': number | null;
8932
+ /**
8933
+ * The text printed on the card; null when none
8934
+ * @type {string}
8935
+ * @memberof GiftCardSettingsDto
8936
+ */
8937
+ 'cardText': string | null;
8938
+ /**
8939
+ * The card\'s picture, an https URL; null when none
8940
+ * @type {string}
8941
+ * @memberof GiftCardSettingsDto
8942
+ */
8943
+ 'imageUrl': string | null;
8944
+ }
8945
+ /**
8946
+ * Where the store\'s gift cards can be spent
8947
+ * @export
8948
+ * @interface GiftCardSettingsDtoChannels
8949
+ */
8950
+ export interface GiftCardSettingsDtoChannels {
8951
+ /**
8952
+ * Whether the store\'s till takes gift cards
8953
+ * @type {boolean}
8954
+ * @memberof GiftCardSettingsDtoChannels
8955
+ */
8956
+ 'till': boolean;
8957
+ /**
8958
+ * Whether the store\'s online store takes gift cards
8959
+ * @type {boolean}
8960
+ * @memberof GiftCardSettingsDtoChannels
8961
+ */
8962
+ 'onlineStore': boolean;
8963
+ }
8964
+ /**
8965
+ *
8966
+ * @export
8967
+ * @interface GiftCardSpentDto
8968
+ */
8969
+ export interface GiftCardSpentDto {
8970
+ /**
8971
+ * Taken off cards, less what went back on them, in cents
8972
+ * @type {number}
8973
+ * @memberof GiftCardSpentDto
8974
+ */
8975
+ 'amount': number;
8976
+ /**
8977
+ * How many orders cards paid that kept the payment
8978
+ * @type {number}
8979
+ * @memberof GiftCardSpentDto
8980
+ */
8981
+ 'orderCount': number;
8982
+ }
8983
+ /**
8984
+ *
8985
+ * @export
8986
+ * @enum {string}
8987
+ */
8988
+ export declare const GiftCardState: {
8989
+ readonly Blocked: "BLOCKED";
8990
+ readonly NotYetValid: "NOT_YET_VALID";
8991
+ readonly Expired: "EXPIRED";
8992
+ readonly UsedUp: "USED_UP";
8993
+ readonly Active: "ACTIVE";
8994
+ };
8995
+ export type GiftCardState = typeof GiftCardState[keyof typeof GiftCardState];
8996
+ /**
8997
+ *
8998
+ * @export
8999
+ * @enum {string}
9000
+ */
9001
+ export declare const GiftCardStatus: {
9002
+ readonly Pending: "PENDING";
9003
+ readonly Active: "ACTIVE";
9004
+ };
9005
+ export type GiftCardStatus = typeof GiftCardStatus[keyof typeof GiftCardStatus];
9006
+ /**
9007
+ *
9008
+ * @export
9009
+ * @interface GiftCardStoreReportDto
9010
+ */
9011
+ export interface GiftCardStoreReportDto {
9012
+ /**
9013
+ * The store; null for the history of a merchant\'s cards sold before it recorded the store
9014
+ * @type {number}
9015
+ * @memberof GiftCardStoreReportDto
9016
+ */
9017
+ 'venueId': number | null;
9018
+ /**
9019
+ * The store\'s name; null with venueId, or when the store is gone
9020
+ * @type {string}
9021
+ * @memberof GiftCardStoreReportDto
9022
+ */
9023
+ 'venueName': string | null;
9024
+ /**
9025
+ *
9026
+ * @type {GiftCardStoreReportDtoSold}
9027
+ * @memberof GiftCardStoreReportDto
9028
+ */
9029
+ 'sold': GiftCardStoreReportDtoSold;
9030
+ /**
9031
+ *
9032
+ * @type {GiftCardStoreReportDtoGivenFree}
9033
+ * @memberof GiftCardStoreReportDto
9034
+ */
9035
+ 'givenFree': GiftCardStoreReportDtoGivenFree;
9036
+ /**
9037
+ *
9038
+ * @type {GiftCardStoreReportDtoSpent}
9039
+ * @memberof GiftCardStoreReportDto
9040
+ */
9041
+ 'spent': GiftCardStoreReportDtoSpent;
9042
+ /**
9043
+ * Sold less spent, in cents: what the store took in for cards less what it gave out
9044
+ * @type {number}
9045
+ * @memberof GiftCardStoreReportDto
9046
+ */
9047
+ 'difference': number;
9048
+ }
9049
+ /**
9050
+ * Cards made by hand at the store
9051
+ * @export
9052
+ * @interface GiftCardStoreReportDtoGivenFree
9053
+ */
9054
+ export interface GiftCardStoreReportDtoGivenFree {
9055
+ /**
9056
+ * The sum, in cents
9057
+ * @type {number}
9058
+ * @memberof GiftCardStoreReportDtoGivenFree
9059
+ */
9060
+ 'amount': number;
9061
+ /**
9062
+ * How many cards
9063
+ * @type {number}
9064
+ * @memberof GiftCardStoreReportDtoGivenFree
9065
+ */
9066
+ 'count': number;
9067
+ }
9068
+ /**
9069
+ * Cards sold at the store
9070
+ * @export
9071
+ * @interface GiftCardStoreReportDtoSold
9072
+ */
9073
+ export interface GiftCardStoreReportDtoSold {
9074
+ /**
9075
+ * The sum, in cents
9076
+ * @type {number}
9077
+ * @memberof GiftCardStoreReportDtoSold
9078
+ */
9079
+ 'amount': number;
9080
+ /**
9081
+ * How many cards
9082
+ * @type {number}
9083
+ * @memberof GiftCardStoreReportDtoSold
9084
+ */
9085
+ 'count': number;
9086
+ }
9087
+ /**
9088
+ * Cards spent at the store
9089
+ * @export
9090
+ * @interface GiftCardStoreReportDtoSpent
9091
+ */
9092
+ export interface GiftCardStoreReportDtoSpent {
9093
+ /**
9094
+ * Taken off cards, less what went back on them, in cents
9095
+ * @type {number}
9096
+ * @memberof GiftCardStoreReportDtoSpent
9097
+ */
9098
+ 'amount': number;
9099
+ /**
9100
+ * How many orders cards paid that kept the payment
9101
+ * @type {number}
9102
+ * @memberof GiftCardStoreReportDtoSpent
9103
+ */
9104
+ 'orderCount': number;
9105
+ }
9106
+ /**
9107
+ *
9108
+ * @export
9109
+ * @interface GiveBackMunchiGiftCardDto
9110
+ */
9111
+ export interface GiveBackMunchiGiftCardDto {
9112
+ /**
9113
+ * The venue\'s orderingBusinessId: the venue whose till made the redemption
9114
+ * @type {number}
9115
+ * @memberof GiveBackMunchiGiftCardDto
9116
+ */
9117
+ 'orderingBusinessId': number;
9118
+ /**
9119
+ * The X-Idempotency-Key the till sent with the redemption to give back; 8 to 100 letters, digits, \'-\' or \'_\'
9120
+ * @type {string}
9121
+ * @memberof GiveBackMunchiGiftCardDto
9122
+ */
9123
+ 'idempotencyKey': string;
9124
+ }
9125
+ /**
9126
+ *
9127
+ * @export
9128
+ * @interface GiveBackMunchiGiftCardResponseDto
9129
+ */
9130
+ export interface GiveBackMunchiGiftCardResponseDto {
9131
+ /**
9132
+ * true when the redemption\'s amount is back on the card: given back now, or already before
9133
+ * @type {boolean}
9134
+ * @memberof GiveBackMunchiGiftCardResponseDto
9135
+ */
9136
+ 'success': boolean;
9137
+ /**
9138
+ *
9139
+ * @type {GiftCardErrorCode}
9140
+ * @memberof GiveBackMunchiGiftCardResponseDto
9141
+ */
9142
+ 'errorCode'?: GiftCardErrorCode | null;
9143
+ /**
9144
+ * On success: the amount put back on the card, in cents
9145
+ * @type {number}
9146
+ * @memberof GiveBackMunchiGiftCardResponseDto
9147
+ */
9148
+ 'givenBackAmount'?: number;
9149
+ /**
9150
+ * On success: what the card holds now, in units of its currency (euros for EUR, not cents)
9151
+ * @type {number}
9152
+ * @memberof GiveBackMunchiGiftCardResponseDto
9153
+ */
9154
+ 'remainingBalance'?: number;
9155
+ /**
9156
+ *
9157
+ * @type {CurrencyCode}
9158
+ * @memberof GiveBackMunchiGiftCardResponseDto
9159
+ */
9160
+ 'currency'?: CurrencyCode;
9161
+ }
8602
9162
  /**
8603
9163
  *
8604
9164
  * @export
@@ -13157,6 +13717,18 @@ export interface MunchiGiftCardDataItemDto {
13157
13717
  * @memberof MunchiGiftCardDataItemDto
13158
13718
  */
13159
13719
  'id': string;
13720
+ /**
13721
+ *
13722
+ * @type {GiftCardStatus}
13723
+ * @memberof MunchiGiftCardDataItemDto
13724
+ */
13725
+ 'status'?: GiftCardStatus;
13726
+ /**
13727
+ * Whether the card is blocked: no till or store takes it, whatever its status says. Absent from servers before it.
13728
+ * @type {boolean}
13729
+ * @memberof MunchiGiftCardDataItemDto
13730
+ */
13731
+ 'blocked'?: boolean;
13160
13732
  /**
13161
13733
  * The card\'s 6-digit code
13162
13734
  * @type {string}
@@ -25072,6 +25644,12 @@ export interface RedeemGiftCardDto {
25072
25644
  * @memberof RedeemGiftCardDto
25073
25645
  */
25074
25646
  'orderingBusinessId': number;
25647
+ /**
25648
+ * The id of the till order the card pays for. Munchi\'s own cards keep it on the redemption, so the redemption can be traced to its order; Luckiefun cards do not read it. Absent from older tills
25649
+ * @type {string}
25650
+ * @memberof RedeemGiftCardDto
25651
+ */
25652
+ 'orderId'?: string;
25075
25653
  }
25076
25654
  /**
25077
25655
  *
@@ -34810,6 +35388,80 @@ export interface UpdateFloorSectionDto {
34810
35388
  */
34811
35389
  'sortOrder'?: number;
34812
35390
  }
35391
+ /**
35392
+ *
35393
+ * @export
35394
+ * @interface UpdateGiftCardSettingsDto
35395
+ */
35396
+ export interface UpdateGiftCardSettingsDto {
35397
+ /**
35398
+ *
35399
+ * @type {UpdateGiftCardSettingsDtoChannels}
35400
+ * @memberof UpdateGiftCardSettingsDto
35401
+ */
35402
+ 'channels'?: UpdateGiftCardSettingsDtoChannels;
35403
+ /**
35404
+ * The amounts offered, in cents: 1 to 6 different amounts, each 100 to 100000. Stored ascending. Absent: unchanged.
35405
+ * @type {Array<number>}
35406
+ * @memberof UpdateGiftCardSettingsDto
35407
+ */
35408
+ 'amounts'?: Array<number>;
35409
+ /**
35410
+ * Whether a buyer may choose any amount. Absent: unchanged.
35411
+ * @type {boolean}
35412
+ * @memberof UpdateGiftCardSettingsDto
35413
+ */
35414
+ 'anyAmount'?: boolean;
35415
+ /**
35416
+ * The smallest amount a buyer may choose, in cents, 100 to 100000; not above maxAmount once merged with what is stored. Absent: unchanged.
35417
+ * @type {number}
35418
+ * @memberof UpdateGiftCardSettingsDto
35419
+ */
35420
+ 'minAmount'?: number;
35421
+ /**
35422
+ * The largest amount a buyer may choose, in cents, 100 to 100000; not below minAmount once merged with what is stored. Absent: unchanged.
35423
+ * @type {number}
35424
+ * @memberof UpdateGiftCardSettingsDto
35425
+ */
35426
+ 'maxAmount'?: number;
35427
+ /**
35428
+ * How many months a new card stays valid, 1 to 60, or null for never. Absent: unchanged.
35429
+ * @type {number}
35430
+ * @memberof UpdateGiftCardSettingsDto
35431
+ */
35432
+ 'validityMonths'?: number | null;
35433
+ /**
35434
+ * The text printed on the card, 1 to 120 characters, or null for none. Absent: unchanged.
35435
+ * @type {string}
35436
+ * @memberof UpdateGiftCardSettingsDto
35437
+ */
35438
+ 'cardText'?: string | null;
35439
+ /**
35440
+ * The card\'s picture, an https URL of at most 2048 characters, or null for none. Absent: unchanged.
35441
+ * @type {string}
35442
+ * @memberof UpdateGiftCardSettingsDto
35443
+ */
35444
+ 'imageUrl'?: string | null;
35445
+ }
35446
+ /**
35447
+ * Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
35448
+ * @export
35449
+ * @interface UpdateGiftCardSettingsDtoChannels
35450
+ */
35451
+ export interface UpdateGiftCardSettingsDtoChannels {
35452
+ /**
35453
+ * Whether the store\'s till takes gift cards
35454
+ * @type {boolean}
35455
+ * @memberof UpdateGiftCardSettingsDtoChannels
35456
+ */
35457
+ 'till': boolean;
35458
+ /**
35459
+ * Whether the store\'s online store takes gift cards
35460
+ * @type {boolean}
35461
+ * @memberof UpdateGiftCardSettingsDtoChannels
35462
+ */
35463
+ 'onlineStore': boolean;
35464
+ }
34813
35465
  /**
34814
35466
  *
34815
35467
  * @export
@@ -36386,6 +37038,219 @@ export interface VenueFoundDto {
36386
37038
  */
36387
37039
  'chainId': string | null;
36388
37040
  }
37041
+ /**
37042
+ *
37043
+ * @export
37044
+ * @interface VenueGiftCardDetailDto
37045
+ */
37046
+ export interface VenueGiftCardDetailDto {
37047
+ /**
37048
+ * The card\'s id
37049
+ * @type {string}
37050
+ * @memberof VenueGiftCardDetailDto
37051
+ */
37052
+ 'id': string;
37053
+ /**
37054
+ * The 6-digit code the customer gives
37055
+ * @type {string}
37056
+ * @memberof VenueGiftCardDetailDto
37057
+ */
37058
+ 'code': string;
37059
+ /**
37060
+ *
37061
+ * @type {GiftCardState}
37062
+ * @memberof VenueGiftCardDetailDto
37063
+ */
37064
+ 'state': GiftCardState;
37065
+ /**
37066
+ *
37067
+ * @type {GiftCardIssue}
37068
+ * @memberof VenueGiftCardDetailDto
37069
+ */
37070
+ 'issuedAs': GiftCardIssue;
37071
+ /**
37072
+ *
37073
+ * @type {CurrencyCode}
37074
+ * @memberof VenueGiftCardDetailDto
37075
+ */
37076
+ 'currency': CurrencyCode;
37077
+ /**
37078
+ * The card\'s first balance, in cents
37079
+ * @type {number}
37080
+ * @memberof VenueGiftCardDetailDto
37081
+ */
37082
+ 'initialBalance': number;
37083
+ /**
37084
+ * What is left on the card, in cents
37085
+ * @type {number}
37086
+ * @memberof VenueGiftCardDetailDto
37087
+ */
37088
+ 'remainingBalance': number;
37089
+ /**
37090
+ * Who bought the card, or whom a card made by hand is for; null when nobody was named
37091
+ * @type {string}
37092
+ * @memberof VenueGiftCardDetailDto
37093
+ */
37094
+ 'buyerName': string | null;
37095
+ /**
37096
+ * The buyer\'s email; null when none was given
37097
+ * @type {string}
37098
+ * @memberof VenueGiftCardDetailDto
37099
+ */
37100
+ 'buyerEmail': string | null;
37101
+ /**
37102
+ * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37103
+ * @type {number}
37104
+ * @memberof VenueGiftCardDetailDto
37105
+ */
37106
+ 'soldAtVenueId': number | null;
37107
+ /**
37108
+ * That store\'s name; null with soldAtVenueId, or when the store is gone
37109
+ * @type {string}
37110
+ * @memberof VenueGiftCardDetailDto
37111
+ */
37112
+ 'soldAtVenueName': string | null;
37113
+ /**
37114
+ * When the card stops working, ISO 8601; null when it never expires
37115
+ * @type {string}
37116
+ * @memberof VenueGiftCardDetailDto
37117
+ */
37118
+ 'expiresAt': string | null;
37119
+ /**
37120
+ * When the card was made, ISO 8601
37121
+ * @type {string}
37122
+ * @memberof VenueGiftCardDetailDto
37123
+ */
37124
+ 'createdAt': string;
37125
+ /**
37126
+ * The note written on a card made by hand; null when none
37127
+ * @type {string}
37128
+ * @memberof VenueGiftCardDetailDto
37129
+ */
37130
+ 'note': string | null;
37131
+ /**
37132
+ * When the card was blocked, ISO 8601; null while it is not blocked
37133
+ * @type {string}
37134
+ * @memberof VenueGiftCardDetailDto
37135
+ */
37136
+ 'blockedAt': string | null;
37137
+ /**
37138
+ * Why it was blocked; null while it is not blocked or no reason was given
37139
+ * @type {string}
37140
+ * @memberof VenueGiftCardDetailDto
37141
+ */
37142
+ 'blockReason': string | null;
37143
+ /**
37144
+ * What happened to the card, oldest first
37145
+ * @type {Array<GiftCardHistoryEventDto>}
37146
+ * @memberof VenueGiftCardDetailDto
37147
+ */
37148
+ 'history': Array<GiftCardHistoryEventDto>;
37149
+ }
37150
+ /**
37151
+ *
37152
+ * @export
37153
+ * @interface VenueGiftCardDto
37154
+ */
37155
+ export interface VenueGiftCardDto {
37156
+ /**
37157
+ * The card\'s id
37158
+ * @type {string}
37159
+ * @memberof VenueGiftCardDto
37160
+ */
37161
+ 'id': string;
37162
+ /**
37163
+ * The 6-digit code the customer gives
37164
+ * @type {string}
37165
+ * @memberof VenueGiftCardDto
37166
+ */
37167
+ 'code': string;
37168
+ /**
37169
+ *
37170
+ * @type {GiftCardState}
37171
+ * @memberof VenueGiftCardDto
37172
+ */
37173
+ 'state': GiftCardState;
37174
+ /**
37175
+ *
37176
+ * @type {GiftCardIssue}
37177
+ * @memberof VenueGiftCardDto
37178
+ */
37179
+ 'issuedAs': GiftCardIssue;
37180
+ /**
37181
+ *
37182
+ * @type {CurrencyCode}
37183
+ * @memberof VenueGiftCardDto
37184
+ */
37185
+ 'currency': CurrencyCode;
37186
+ /**
37187
+ * The card\'s first balance, in cents
37188
+ * @type {number}
37189
+ * @memberof VenueGiftCardDto
37190
+ */
37191
+ 'initialBalance': number;
37192
+ /**
37193
+ * What is left on the card, in cents
37194
+ * @type {number}
37195
+ * @memberof VenueGiftCardDto
37196
+ */
37197
+ 'remainingBalance': number;
37198
+ /**
37199
+ * Who bought the card, or whom a card made by hand is for; null when nobody was named
37200
+ * @type {string}
37201
+ * @memberof VenueGiftCardDto
37202
+ */
37203
+ 'buyerName': string | null;
37204
+ /**
37205
+ * The buyer\'s email; null when none was given
37206
+ * @type {string}
37207
+ * @memberof VenueGiftCardDto
37208
+ */
37209
+ 'buyerEmail': string | null;
37210
+ /**
37211
+ * The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
37212
+ * @type {number}
37213
+ * @memberof VenueGiftCardDto
37214
+ */
37215
+ 'soldAtVenueId': number | null;
37216
+ /**
37217
+ * That store\'s name; null with soldAtVenueId, or when the store is gone
37218
+ * @type {string}
37219
+ * @memberof VenueGiftCardDto
37220
+ */
37221
+ 'soldAtVenueName': string | null;
37222
+ /**
37223
+ * When the card stops working, ISO 8601; null when it never expires
37224
+ * @type {string}
37225
+ * @memberof VenueGiftCardDto
37226
+ */
37227
+ 'expiresAt': string | null;
37228
+ /**
37229
+ * When the card was made, ISO 8601
37230
+ * @type {string}
37231
+ * @memberof VenueGiftCardDto
37232
+ */
37233
+ 'createdAt': string;
37234
+ }
37235
+ /**
37236
+ *
37237
+ * @export
37238
+ * @interface VenueGiftCardsDto
37239
+ */
37240
+ export interface VenueGiftCardsDto {
37241
+ /**
37242
+ * The page\'s cards, newest first
37243
+ * @type {Array<VenueGiftCardDto>}
37244
+ * @memberof VenueGiftCardsDto
37245
+ */
37246
+ 'cards': Array<VenueGiftCardDto>;
37247
+ /**
37248
+ * The cursor of the next page; null when this page is the last
37249
+ * @type {string}
37250
+ * @memberof VenueGiftCardsDto
37251
+ */
37252
+ 'nextCursor': string | null;
37253
+ }
36389
37254
  /**
36390
37255
  *
36391
37256
  * @export
@@ -44561,6 +45426,487 @@ export declare class FloorPlanApi extends BaseAPI implements FloorPlanApiInterfa
44561
45426
  */
44562
45427
  updateTableStatus(id: string, businessId: number, updateTableStatusDto: UpdateTableStatusDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DiningTableResponseDto, any, {}>>;
44563
45428
  }
45429
+ /**
45430
+ * GiftCardsApi - axios parameter creator
45431
+ * @export
45432
+ */
45433
+ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configuration) => {
45434
+ /**
45435
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
45436
+ * @summary Switch on a gift card whose till order is not paid yet
45437
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45438
+ * @param {string} cardId The card\&#39;s id
45439
+ * @param {*} [options] Override http request option.
45440
+ * @throws {RequiredError}
45441
+ */
45442
+ activateVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45443
+ /**
45444
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
45445
+ * @summary Block a gift card
45446
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45447
+ * @param {string} cardId The card\&#39;s id
45448
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
45449
+ * @param {*} [options] Override http request option.
45450
+ * @throws {RequiredError}
45451
+ */
45452
+ blockVenueGiftCard: (businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45453
+ /**
45454
+ * 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.
45455
+ * @summary Make a gift card by hand, given for free
45456
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45457
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45458
+ * @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 when it sends one (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.
45459
+ * @param {*} [options] Override http request option.
45460
+ * @throws {RequiredError}
45461
+ */
45462
+ createVenueGiftCard: (businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45463
+ /**
45464
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45465
+ * @summary Read one of a store\'s gift cards with its history
45466
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45467
+ * @param {string} cardId The card\&#39;s id
45468
+ * @param {*} [options] Override http request option.
45469
+ * @throws {RequiredError}
45470
+ */
45471
+ getVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45472
+ /**
45473
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. Three statements; nothing is written.
45474
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45475
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45476
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45477
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45478
+ * @param {*} [options] Override http request option.
45479
+ * @throws {RequiredError}
45480
+ */
45481
+ getVenueGiftCardReport: (businessId: number, from: string, to: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45482
+ /**
45483
+ * 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.
45484
+ * @summary Read a store\'s gift card settings
45485
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45486
+ * @param {*} [options] Override http request option.
45487
+ * @throws {RequiredError}
45488
+ */
45489
+ getVenueGiftCardSettings: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45490
+ /**
45491
+ * 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.
45492
+ * @summary List a store\'s gift cards, newest first, a page at a time
45493
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45494
+ * @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.
45495
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45496
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45497
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
45498
+ * @param {*} [options] Override http request option.
45499
+ * @throws {RequiredError}
45500
+ */
45501
+ listVenueGiftCards: (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45502
+ /**
45503
+ * 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.
45504
+ * @summary Unblock a gift card
45505
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45506
+ * @param {string} cardId The card\&#39;s id
45507
+ * @param {*} [options] Override http request option.
45508
+ * @throws {RequiredError}
45509
+ */
45510
+ unblockVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45511
+ /**
45512
+ * 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.
45513
+ * @summary Change a store\'s gift card settings
45514
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45515
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
45516
+ * @param {*} [options] Override http request option.
45517
+ * @throws {RequiredError}
45518
+ */
45519
+ updateVenueGiftCardSettings: (businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
45520
+ };
45521
+ /**
45522
+ * GiftCardsApi - functional programming interface
45523
+ * @export
45524
+ */
45525
+ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
45526
+ /**
45527
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
45528
+ * @summary Switch on a gift card whose till order is not paid yet
45529
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45530
+ * @param {string} cardId The card\&#39;s id
45531
+ * @param {*} [options] Override http request option.
45532
+ * @throws {RequiredError}
45533
+ */
45534
+ activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45535
+ /**
45536
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
45537
+ * @summary Block a gift card
45538
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45539
+ * @param {string} cardId The card\&#39;s id
45540
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
45541
+ * @param {*} [options] Override http request option.
45542
+ * @throws {RequiredError}
45543
+ */
45544
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45545
+ /**
45546
+ * 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.
45547
+ * @summary Make a gift card by hand, given for free
45548
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45549
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45550
+ * @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 when it sends one (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.
45551
+ * @param {*} [options] Override http request option.
45552
+ * @throws {RequiredError}
45553
+ */
45554
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45555
+ /**
45556
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45557
+ * @summary Read one of a store\'s gift cards with its history
45558
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45559
+ * @param {string} cardId The card\&#39;s id
45560
+ * @param {*} [options] Override http request option.
45561
+ * @throws {RequiredError}
45562
+ */
45563
+ getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45564
+ /**
45565
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. Three statements; nothing is written.
45566
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45567
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45568
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45569
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45570
+ * @param {*} [options] Override http request option.
45571
+ * @throws {RequiredError}
45572
+ */
45573
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardReportDto>>;
45574
+ /**
45575
+ * 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.
45576
+ * @summary Read a store\'s gift card settings
45577
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45578
+ * @param {*} [options] Override http request option.
45579
+ * @throws {RequiredError}
45580
+ */
45581
+ getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSettingsDto>>;
45582
+ /**
45583
+ * 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.
45584
+ * @summary List a store\'s gift cards, newest first, a page at a time
45585
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45586
+ * @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.
45587
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45588
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45589
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
45590
+ * @param {*} [options] Override http request option.
45591
+ * @throws {RequiredError}
45592
+ */
45593
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>>;
45594
+ /**
45595
+ * 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.
45596
+ * @summary Unblock a gift card
45597
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45598
+ * @param {string} cardId The card\&#39;s id
45599
+ * @param {*} [options] Override http request option.
45600
+ * @throws {RequiredError}
45601
+ */
45602
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
45603
+ /**
45604
+ * 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.
45605
+ * @summary Change a store\'s gift card settings
45606
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45607
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
45608
+ * @param {*} [options] Override http request option.
45609
+ * @throws {RequiredError}
45610
+ */
45611
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSettingsDto>>;
45612
+ };
45613
+ /**
45614
+ * GiftCardsApi - factory interface
45615
+ * @export
45616
+ */
45617
+ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
45618
+ /**
45619
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
45620
+ * @summary Switch on a gift card whose till order is not paid yet
45621
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45622
+ * @param {string} cardId The card\&#39;s id
45623
+ * @param {*} [options] Override http request option.
45624
+ * @throws {RequiredError}
45625
+ */
45626
+ activateVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45627
+ /**
45628
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
45629
+ * @summary Block a gift card
45630
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45631
+ * @param {string} cardId The card\&#39;s id
45632
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
45633
+ * @param {*} [options] Override http request option.
45634
+ * @throws {RequiredError}
45635
+ */
45636
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45637
+ /**
45638
+ * 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.
45639
+ * @summary Make a gift card by hand, given for free
45640
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45641
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45642
+ * @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 when it sends one (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.
45643
+ * @param {*} [options] Override http request option.
45644
+ * @throws {RequiredError}
45645
+ */
45646
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45647
+ /**
45648
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45649
+ * @summary Read one of a store\'s gift cards with its history
45650
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45651
+ * @param {string} cardId The card\&#39;s id
45652
+ * @param {*} [options] Override http request option.
45653
+ * @throws {RequiredError}
45654
+ */
45655
+ getVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45656
+ /**
45657
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. Three statements; nothing is written.
45658
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45659
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45660
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45661
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45662
+ * @param {*} [options] Override http request option.
45663
+ * @throws {RequiredError}
45664
+ */
45665
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: any): AxiosPromise<GiftCardReportDto>;
45666
+ /**
45667
+ * 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.
45668
+ * @summary Read a store\'s gift card settings
45669
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45670
+ * @param {*} [options] Override http request option.
45671
+ * @throws {RequiredError}
45672
+ */
45673
+ getVenueGiftCardSettings(businessId: number, options?: any): AxiosPromise<GiftCardSettingsDto>;
45674
+ /**
45675
+ * 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.
45676
+ * @summary List a store\'s gift cards, newest first, a page at a time
45677
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45678
+ * @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.
45679
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45680
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45681
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
45682
+ * @param {*} [options] Override http request option.
45683
+ * @throws {RequiredError}
45684
+ */
45685
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: any): AxiosPromise<VenueGiftCardsDto>;
45686
+ /**
45687
+ * 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.
45688
+ * @summary Unblock a gift card
45689
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45690
+ * @param {string} cardId The card\&#39;s id
45691
+ * @param {*} [options] Override http request option.
45692
+ * @throws {RequiredError}
45693
+ */
45694
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
45695
+ /**
45696
+ * 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.
45697
+ * @summary Change a store\'s gift card settings
45698
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45699
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
45700
+ * @param {*} [options] Override http request option.
45701
+ * @throws {RequiredError}
45702
+ */
45703
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: any): AxiosPromise<GiftCardSettingsDto>;
45704
+ };
45705
+ /**
45706
+ * GiftCardsApi - interface
45707
+ * @export
45708
+ * @interface GiftCardsApi
45709
+ */
45710
+ export interface GiftCardsApiInterface {
45711
+ /**
45712
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
45713
+ * @summary Switch on a gift card whose till order is not paid yet
45714
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45715
+ * @param {string} cardId The card\&#39;s id
45716
+ * @param {*} [options] Override http request option.
45717
+ * @throws {RequiredError}
45718
+ * @memberof GiftCardsApiInterface
45719
+ */
45720
+ activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45721
+ /**
45722
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
45723
+ * @summary Block a gift card
45724
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45725
+ * @param {string} cardId The card\&#39;s id
45726
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
45727
+ * @param {*} [options] Override http request option.
45728
+ * @throws {RequiredError}
45729
+ * @memberof GiftCardsApiInterface
45730
+ */
45731
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45732
+ /**
45733
+ * 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.
45734
+ * @summary Make a gift card by hand, given for free
45735
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45736
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45737
+ * @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 when it sends one (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.
45738
+ * @param {*} [options] Override http request option.
45739
+ * @throws {RequiredError}
45740
+ * @memberof GiftCardsApiInterface
45741
+ */
45742
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45743
+ /**
45744
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45745
+ * @summary Read one of a store\'s gift cards with its history
45746
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45747
+ * @param {string} cardId The card\&#39;s id
45748
+ * @param {*} [options] Override http request option.
45749
+ * @throws {RequiredError}
45750
+ * @memberof GiftCardsApiInterface
45751
+ */
45752
+ getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45753
+ /**
45754
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. Three statements; nothing is written.
45755
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45756
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45757
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45758
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45759
+ * @param {*} [options] Override http request option.
45760
+ * @throws {RequiredError}
45761
+ * @memberof GiftCardsApiInterface
45762
+ */
45763
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<GiftCardReportDto>;
45764
+ /**
45765
+ * 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.
45766
+ * @summary Read a store\'s gift card settings
45767
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45768
+ * @param {*} [options] Override http request option.
45769
+ * @throws {RequiredError}
45770
+ * @memberof GiftCardsApiInterface
45771
+ */
45772
+ getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
45773
+ /**
45774
+ * 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.
45775
+ * @summary List a store\'s gift cards, newest first, a page at a time
45776
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45777
+ * @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.
45778
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45779
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45780
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
45781
+ * @param {*} [options] Override http request option.
45782
+ * @throws {RequiredError}
45783
+ * @memberof GiftCardsApiInterface
45784
+ */
45785
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
45786
+ /**
45787
+ * 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.
45788
+ * @summary Unblock a gift card
45789
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45790
+ * @param {string} cardId The card\&#39;s id
45791
+ * @param {*} [options] Override http request option.
45792
+ * @throws {RequiredError}
45793
+ * @memberof GiftCardsApiInterface
45794
+ */
45795
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
45796
+ /**
45797
+ * 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.
45798
+ * @summary Change a store\'s gift card settings
45799
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45800
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
45801
+ * @param {*} [options] Override http request option.
45802
+ * @throws {RequiredError}
45803
+ * @memberof GiftCardsApiInterface
45804
+ */
45805
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
45806
+ }
45807
+ /**
45808
+ * GiftCardsApi - object-oriented interface
45809
+ * @export
45810
+ * @class GiftCardsApi
45811
+ * @extends {BaseAPI}
45812
+ */
45813
+ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
45814
+ /**
45815
+ * A PENDING card turns ACTIVE, and who did it and when are stored. Only the status changes: a blocked card stays blocked. A card ACTIVE already is answered as it is.
45816
+ * @summary Switch on a gift card whose till order is not paid yet
45817
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45818
+ * @param {string} cardId The card\&#39;s id
45819
+ * @param {*} [options] Override http request option.
45820
+ * @throws {RequiredError}
45821
+ * @memberof GiftCardsApi
45822
+ */
45823
+ activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45824
+ /**
45825
+ * No till or store takes the card until it is unblocked: the till\'s validate and redeem answer 1017. Who blocked it, when and why are stored. A card blocked already is answered as it is.
45826
+ * @summary Block a gift card
45827
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45828
+ * @param {string} cardId The card\&#39;s id
45829
+ * @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
45830
+ * @param {*} [options] Override http request option.
45831
+ * @throws {RequiredError}
45832
+ * @memberof GiftCardsApi
45833
+ */
45834
+ blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45835
+ /**
45836
+ * 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.
45837
+ * @summary Make a gift card by hand, given for free
45838
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45839
+ * @param {CreateVenueGiftCardDto} createVenueGiftCardDto
45840
+ * @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 when it sends one (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.
45841
+ * @param {*} [options] Override http request option.
45842
+ * @throws {RequiredError}
45843
+ * @memberof GiftCardsApi
45844
+ */
45845
+ createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45846
+ /**
45847
+ * The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
45848
+ * @summary Read one of a store\'s gift cards with its history
45849
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45850
+ * @param {string} cardId The card\&#39;s id
45851
+ * @param {*} [options] Override http request option.
45852
+ * @throws {RequiredError}
45853
+ * @memberof GiftCardsApi
45854
+ */
45855
+ getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45856
+ /**
45857
+ * The owner\'s cards in the store\'s currency, by the time their movements were recorded, from the first day\'s 00:00 to the end of the last day in the store\'s time zone: sold (till and online sales), givenFree (cards made by hand), spent (taken off cards less what went back on them; orderCount counts the orders whose payment was kept), one row per store, and what is left now on the owner\'s ACTIVE cards. Three statements; nothing is written.
45858
+ * @summary Report what a store\'s gift cards sold, gave away and paid in a period
45859
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45860
+ * @param {string} from The first day, YYYY-MM-DD, in the store\&#39;s time zone
45861
+ * @param {string} to The last day, YYYY-MM-DD, included, in the store\&#39;s time zone; not before from, and at most 366 days from it
45862
+ * @param {*} [options] Override http request option.
45863
+ * @throws {RequiredError}
45864
+ * @memberof GiftCardsApi
45865
+ */
45866
+ getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardReportDto, any, {}>>;
45867
+ /**
45868
+ * 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.
45869
+ * @summary Read a store\'s gift card settings
45870
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45871
+ * @param {*} [options] Override http request option.
45872
+ * @throws {RequiredError}
45873
+ * @memberof GiftCardsApi
45874
+ */
45875
+ getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardSettingsDto, any, {}>>;
45876
+ /**
45877
+ * 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.
45878
+ * @summary List a store\'s gift cards, newest first, a page at a time
45879
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45880
+ * @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.
45881
+ * @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
45882
+ * @param {string} [cursor] The nextCursor of the page before: a card\&#39;s id. Absent for the first page.
45883
+ * @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
45884
+ * @param {*} [options] Override http request option.
45885
+ * @throws {RequiredError}
45886
+ * @memberof GiftCardsApi
45887
+ */
45888
+ listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardsDto, any, {}>>;
45889
+ /**
45890
+ * 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.
45891
+ * @summary Unblock a gift card
45892
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45893
+ * @param {string} cardId The card\&#39;s id
45894
+ * @param {*} [options] Override http request option.
45895
+ * @throws {RequiredError}
45896
+ * @memberof GiftCardsApi
45897
+ */
45898
+ unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
45899
+ /**
45900
+ * 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.
45901
+ * @summary Change a store\'s gift card settings
45902
+ * @param {number} businessId The store\&#39;s orderingBusinessId
45903
+ * @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
45904
+ * @param {*} [options] Override http request option.
45905
+ * @throws {RequiredError}
45906
+ * @memberof GiftCardsApi
45907
+ */
45908
+ updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiftCardSettingsDto, any, {}>>;
45909
+ }
44564
45910
  /**
44565
45911
  * GiftcardApi - axios parameter creator
44566
45912
  * @export
@@ -47136,13 +48482,14 @@ export declare class MenuApi extends BaseAPI implements MenuApiInterface {
47136
48482
  */
47137
48483
  export declare const MunchiGiftCardApiAxiosParamCreator: (configuration?: Configuration) => {
47138
48484
  /**
47139
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
48485
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47140
48486
  * @summary Create a first-party Munchi gift card
47141
48487
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
48488
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47142
48489
  * @param {*} [options] Override http request option.
47143
48490
  * @throws {RequiredError}
47144
48491
  */
47145
- createMunchiGiftCard: (createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48492
+ createMunchiGiftCard: (createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47146
48493
  /**
47147
48494
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47148
48495
  * @summary Get Munchi gift card data
@@ -47152,13 +48499,22 @@ export declare const MunchiGiftCardApiAxiosParamCreator: (configuration?: Config
47152
48499
  */
47153
48500
  getMunchiGiftCardData: (getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47154
48501
  /**
47155
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
48502
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
48503
+ * @summary Give back a Munchi gift card redemption the till order did not keep
48504
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
48505
+ * @param {*} [options] Override http request option.
48506
+ * @throws {RequiredError}
48507
+ */
48508
+ giveBackMunchiGiftCardRedemption: (giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48509
+ /**
48510
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47156
48511
  * @summary Redeem a first-party Munchi gift card
47157
48512
  * @param {RedeemGiftCardDto} redeemGiftCardDto
48513
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47158
48514
  * @param {*} [options] Override http request option.
47159
48515
  * @throws {RequiredError}
47160
48516
  */
47161
- redeemMunchiGiftCard: (redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
48517
+ redeemMunchiGiftCard: (redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
47162
48518
  /**
47163
48519
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47164
48520
  * @summary Validate a first-party Munchi gift card
@@ -47174,13 +48530,14 @@ export declare const MunchiGiftCardApiAxiosParamCreator: (configuration?: Config
47174
48530
  */
47175
48531
  export declare const MunchiGiftCardApiFp: (configuration?: Configuration) => {
47176
48532
  /**
47177
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
48533
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47178
48534
  * @summary Create a first-party Munchi gift card
47179
48535
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
48536
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47180
48537
  * @param {*} [options] Override http request option.
47181
48538
  * @throws {RequiredError}
47182
48539
  */
47183
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMunchiGiftCardResponseDto>>;
48540
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMunchiGiftCardResponseDto>>;
47184
48541
  /**
47185
48542
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47186
48543
  * @summary Get Munchi gift card data
@@ -47190,13 +48547,22 @@ export declare const MunchiGiftCardApiFp: (configuration?: Configuration) => {
47190
48547
  */
47191
48548
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetMunchiGiftCardDataResponseDto>>;
47192
48549
  /**
47193
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
48550
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
48551
+ * @summary Give back a Munchi gift card redemption the till order did not keep
48552
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
48553
+ * @param {*} [options] Override http request option.
48554
+ * @throws {RequiredError}
48555
+ */
48556
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiveBackMunchiGiftCardResponseDto>>;
48557
+ /**
48558
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47194
48559
  * @summary Redeem a first-party Munchi gift card
47195
48560
  * @param {RedeemGiftCardDto} redeemGiftCardDto
48561
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47196
48562
  * @param {*} [options] Override http request option.
47197
48563
  * @throws {RequiredError}
47198
48564
  */
47199
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedeemGiftCardResponseDto>>;
48565
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedeemGiftCardResponseDto>>;
47200
48566
  /**
47201
48567
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47202
48568
  * @summary Validate a first-party Munchi gift card
@@ -47212,13 +48578,14 @@ export declare const MunchiGiftCardApiFp: (configuration?: Configuration) => {
47212
48578
  */
47213
48579
  export declare const MunchiGiftCardApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
47214
48580
  /**
47215
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
48581
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47216
48582
  * @summary Create a first-party Munchi gift card
47217
48583
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
48584
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47218
48585
  * @param {*} [options] Override http request option.
47219
48586
  * @throws {RequiredError}
47220
48587
  */
47221
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: any): AxiosPromise<CreateMunchiGiftCardResponseDto>;
48588
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<CreateMunchiGiftCardResponseDto>;
47222
48589
  /**
47223
48590
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47224
48591
  * @summary Get Munchi gift card data
@@ -47228,13 +48595,22 @@ export declare const MunchiGiftCardApiFactory: (configuration?: Configuration, b
47228
48595
  */
47229
48596
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: any): AxiosPromise<GetMunchiGiftCardDataResponseDto>;
47230
48597
  /**
47231
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
48598
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
48599
+ * @summary Give back a Munchi gift card redemption the till order did not keep
48600
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
48601
+ * @param {*} [options] Override http request option.
48602
+ * @throws {RequiredError}
48603
+ */
48604
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: any): AxiosPromise<GiveBackMunchiGiftCardResponseDto>;
48605
+ /**
48606
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47232
48607
  * @summary Redeem a first-party Munchi gift card
47233
48608
  * @param {RedeemGiftCardDto} redeemGiftCardDto
48609
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47234
48610
  * @param {*} [options] Override http request option.
47235
48611
  * @throws {RequiredError}
47236
48612
  */
47237
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: any): AxiosPromise<RedeemGiftCardResponseDto>;
48613
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RedeemGiftCardResponseDto>;
47238
48614
  /**
47239
48615
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47240
48616
  * @summary Validate a first-party Munchi gift card
@@ -47251,14 +48627,15 @@ export declare const MunchiGiftCardApiFactory: (configuration?: Configuration, b
47251
48627
  */
47252
48628
  export interface MunchiGiftCardApiInterface {
47253
48629
  /**
47254
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
48630
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47255
48631
  * @summary Create a first-party Munchi gift card
47256
48632
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
48633
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47257
48634
  * @param {*} [options] Override http request option.
47258
48635
  * @throws {RequiredError}
47259
48636
  * @memberof MunchiGiftCardApiInterface
47260
48637
  */
47261
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<CreateMunchiGiftCardResponseDto>;
48638
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<CreateMunchiGiftCardResponseDto>;
47262
48639
  /**
47263
48640
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47264
48641
  * @summary Get Munchi gift card data
@@ -47269,14 +48646,24 @@ export interface MunchiGiftCardApiInterface {
47269
48646
  */
47270
48647
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig): AxiosPromise<GetMunchiGiftCardDataResponseDto>;
47271
48648
  /**
47272
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
48649
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
48650
+ * @summary Give back a Munchi gift card redemption the till order did not keep
48651
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
48652
+ * @param {*} [options] Override http request option.
48653
+ * @throws {RequiredError}
48654
+ * @memberof MunchiGiftCardApiInterface
48655
+ */
48656
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<GiveBackMunchiGiftCardResponseDto>;
48657
+ /**
48658
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47273
48659
  * @summary Redeem a first-party Munchi gift card
47274
48660
  * @param {RedeemGiftCardDto} redeemGiftCardDto
48661
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47275
48662
  * @param {*} [options] Override http request option.
47276
48663
  * @throws {RequiredError}
47277
48664
  * @memberof MunchiGiftCardApiInterface
47278
48665
  */
47279
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<RedeemGiftCardResponseDto>;
48666
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RedeemGiftCardResponseDto>;
47280
48667
  /**
47281
48668
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47282
48669
  * @summary Validate a first-party Munchi gift card
@@ -47295,14 +48682,15 @@ export interface MunchiGiftCardApiInterface {
47295
48682
  */
47296
48683
  export declare class MunchiGiftCardApi extends BaseAPI implements MunchiGiftCardApiInterface {
47297
48684
  /**
47298
- * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId.
48685
+ * The till sells one of Munchi\'s own gift cards. A 6-digit code is drawn until a free one comes up (at most 20 draws), and the card is stored with the amount as its balance. The card belongs to the venue\'s merchant when the venue has one, so every venue of the merchant can take it, otherwise to the venue; useMerchantScope is not read. The venue is the body\'s orderingBusinessId. With an X-Idempotency-Key, a sale sent twice makes one card and the repeat is answered with it; without one, every request makes a card, as before.
47299
48686
  * @summary Create a first-party Munchi gift card
47300
48687
  * @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
48688
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\&#39;s owner, another amount or order, or a card the dashboard made by hand is refused 400. Without the header every request makes a card, as before.
47301
48689
  * @param {*} [options] Override http request option.
47302
48690
  * @throws {RequiredError}
47303
48691
  * @memberof MunchiGiftCardApi
47304
48692
  */
47305
- createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMunchiGiftCardResponseDto, any, {}>>;
48693
+ createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateMunchiGiftCardResponseDto, any, {}>>;
47306
48694
  /**
47307
48695
  * gift-card-email-service reads a venue\'s cards with the service key, to email them. Answers the venue and every card it sold, or its merchant\'s cards when it belongs to one, newest first and all of them (not paged); with startDate and endDate, only the cards created between them, both included. Nothing is written.
47308
48696
  * @summary Get Munchi gift card data
@@ -47313,14 +48701,24 @@ export declare class MunchiGiftCardApi extends BaseAPI implements MunchiGiftCard
47313
48701
  */
47314
48702
  getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetMunchiGiftCardDataResponseDto, any, {}>>;
47315
48703
  /**
47316
- * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue, both in one transaction: of two tills redeeming the card at once, one is answered success. Not retried, and a redemption sent twice takes the amount twice.
48704
+ * The till calls it when it redeemed a card but the payment it then recorded was refused, so the order does not hold it. The redemption is found by the X-Idempotency-Key the till sent with it, at the venue, and its amount is put back on the card once: a second call answers the same and puts nothing back. While the till order still holds an active payment with that key, or the redemption names no order, nothing is given back. Voiding the payment gives it back too.
48705
+ * @summary Give back a Munchi gift card redemption the till order did not keep
48706
+ * @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
48707
+ * @param {*} [options] Override http request option.
48708
+ * @throws {RequiredError}
48709
+ * @memberof MunchiGiftCardApi
48710
+ */
48711
+ giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GiveBackMunchiGiftCardResponseDto, any, {}>>;
48712
+ /**
48713
+ * The till calls it through the redeem link of the venue\'s MunchiGiftCard payment integration. The amount is taken off the card\'s balance only if the balance is still the one just read, and the redemption is recorded against the venue with its order, both in one transaction: of two tills redeeming the card at once, one is answered success. With an X-Idempotency-Key, a redemption sent twice (a retry after no answer, two at once) takes the amount once and the repeat is answered as the first was; without one, a redemption sent twice takes the amount twice, as before.
47317
48714
  * @summary Redeem a first-party Munchi gift card
47318
48715
  * @param {RedeemGiftCardDto} redeemGiftCardDto
48716
+ * @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \&#39;-\&#39; or \&#39;_\&#39;. A repeat with the same key at the same venue answers the redemption already made, with its amount and the balance it left, and takes nothing again; the same key with another card or amount is refused with 1005. The till sends the same key as the X-Idempotency-Key of the payment it then records. Without the header every request redeems, as before.
47319
48717
  * @param {*} [options] Override http request option.
47320
48718
  * @throws {RequiredError}
47321
48719
  * @memberof MunchiGiftCardApi
47322
48720
  */
47323
- redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RedeemGiftCardResponseDto, any, {}>>;
48721
+ redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<RedeemGiftCardResponseDto, any, {}>>;
47324
48722
  /**
47325
48723
  * The till calls it before redeem, through the validate link of the venue\'s MunchiGiftCard payment integration. The card is found by its code; the venue may take it when the card is the venue\'s, or its merchant\'s and the venue belongs to that merchant. Nothing is written.
47326
48724
  * @summary Validate a first-party Munchi gift card
@@ -54928,13 +56326,13 @@ export declare const ReservationsApiAxiosParamCreator: (configuration?: Configur
54928
56326
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
54929
56327
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
54930
56328
  * @param {number} partySize How many guests the booking is for
56329
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
54931
56330
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
54932
56331
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
54933
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
54934
56332
  * @param {*} [options] Override http request option.
54935
56333
  * @throws {RequiredError}
54936
56334
  */
54937
- getReservationAvailability: (businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig) => Promise<RequestArgs>;
56335
+ getReservationAvailability: (businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
54938
56336
  /**
54939
56337
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
54940
56338
  * @summary Get the reservation policy
@@ -55025,13 +56423,13 @@ export declare const ReservationsApiFp: (configuration?: Configuration) => {
55025
56423
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55026
56424
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55027
56425
  * @param {number} partySize How many guests the booking is for
56426
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55028
56427
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55029
56428
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55030
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55031
56429
  * @param {*} [options] Override http request option.
55032
56430
  * @throws {RequiredError}
55033
56431
  */
55034
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReservationAvailabilityResponseDto>>;
56432
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReservationAvailabilityResponseDto>>;
55035
56433
  /**
55036
56434
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55037
56435
  * @summary Get the reservation policy
@@ -55122,13 +56520,13 @@ export declare const ReservationsApiFactory: (configuration?: Configuration, bas
55122
56520
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55123
56521
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55124
56522
  * @param {number} partySize How many guests the booking is for
56523
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55125
56524
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55126
56525
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55127
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55128
56526
  * @param {*} [options] Override http request option.
55129
56527
  * @throws {RequiredError}
55130
56528
  */
55131
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: any): AxiosPromise<ReservationAvailabilityResponseDto>;
56529
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: any): AxiosPromise<ReservationAvailabilityResponseDto>;
55132
56530
  /**
55133
56531
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55134
56532
  * @summary Get the reservation policy
@@ -55221,14 +56619,14 @@ export interface ReservationsApiInterface {
55221
56619
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55222
56620
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55223
56621
  * @param {number} partySize How many guests the booking is for
56622
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55224
56623
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55225
56624
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55226
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55227
56625
  * @param {*} [options] Override http request option.
55228
56626
  * @throws {RequiredError}
55229
56627
  * @memberof ReservationsApiInterface
55230
56628
  */
55231
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig): AxiosPromise<ReservationAvailabilityResponseDto>;
56629
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): AxiosPromise<ReservationAvailabilityResponseDto>;
55232
56630
  /**
55233
56631
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55234
56632
  * @summary Get the reservation policy
@@ -55330,14 +56728,14 @@ export declare class ReservationsApi extends BaseAPI implements ReservationsApiI
55330
56728
  * @param {number} businessId The venue\&#39;s business id; only its own bookings, policy and link are read or changed
55331
56729
  * @param {string} date The day, YYYY-MM-DD, in the venue\&#39;s own time zone
55332
56730
  * @param {number} partySize How many guests the booking is for
56731
+ * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55333
56732
  * @param {string} [sectionId] Only the tables of this floor section; every section when absent
55334
56733
  * @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
55335
- * @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\&#39;s minimum lead time; start times already past are still left out. Held to the lead time when absent
55336
56734
  * @param {*} [options] Override http request option.
55337
56735
  * @throws {RequiredError}
55338
56736
  * @memberof ReservationsApi
55339
56737
  */
55340
- getReservationAvailability(businessId: number, date: string, partySize: number, sectionId?: string, excludeReservationId?: string, source?: ReservationSource, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReservationAvailabilityResponseDto, any, {}>>;
56738
+ getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReservationAvailabilityResponseDto, any, {}>>;
55341
56739
  /**
55342
56740
  * The venue\'s policy row, kept 300 seconds. A venue without a policy is answered with an empty body and read from the database each time.
55343
56741
  * @summary Get the reservation policy