@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.
- package/dist/generated/api.d.ts +1428 -30
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +1944 -44
- package/package.json +15 -13
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -744,6 +744,19 @@ export const BasketNotPricedReason = {
|
|
|
744
744
|
export type BasketNotPricedReason = typeof BasketNotPricedReason[keyof typeof BasketNotPricedReason];
|
|
745
745
|
|
|
746
746
|
|
|
747
|
+
/**
|
|
748
|
+
*
|
|
749
|
+
* @export
|
|
750
|
+
* @interface BlockVenueGiftCardDto
|
|
751
|
+
*/
|
|
752
|
+
export interface BlockVenueGiftCardDto {
|
|
753
|
+
/**
|
|
754
|
+
* Why the card is blocked, 1 to 200 characters. Absent: no reason.
|
|
755
|
+
* @type {string}
|
|
756
|
+
* @memberof BlockVenueGiftCardDto
|
|
757
|
+
*/
|
|
758
|
+
'reason'?: string;
|
|
759
|
+
}
|
|
747
760
|
/**
|
|
748
761
|
*
|
|
749
762
|
* @export
|
|
@@ -1511,7 +1524,9 @@ export interface BusinessLoyaltyPlan {
|
|
|
1511
1524
|
*/
|
|
1512
1525
|
|
|
1513
1526
|
export const BusinessPaymentIntegrationType = {
|
|
1514
|
-
GiftCard: 'GiftCard'
|
|
1527
|
+
GiftCard: 'GiftCard',
|
|
1528
|
+
MunchiGiftCard: 'MunchiGiftCard',
|
|
1529
|
+
Epassi: 'Epassi'
|
|
1515
1530
|
} as const;
|
|
1516
1531
|
|
|
1517
1532
|
export type BusinessPaymentIntegrationType = typeof BusinessPaymentIntegrationType[keyof typeof BusinessPaymentIntegrationType];
|
|
@@ -4760,6 +4775,12 @@ export interface CreateMunchiGiftCardDto {
|
|
|
4760
4775
|
* @memberof CreateMunchiGiftCardDto
|
|
4761
4776
|
*/
|
|
4762
4777
|
'expiresAt'?: string;
|
|
4778
|
+
/**
|
|
4779
|
+
* 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
|
|
4780
|
+
* @type {string}
|
|
4781
|
+
* @memberof CreateMunchiGiftCardDto
|
|
4782
|
+
*/
|
|
4783
|
+
'orderId'?: string;
|
|
4763
4784
|
}
|
|
4764
4785
|
|
|
4765
4786
|
|
|
@@ -4853,6 +4874,12 @@ export interface CreateMunchiGiftCardResponseDto {
|
|
|
4853
4874
|
* @memberof CreateMunchiGiftCardResponseDto
|
|
4854
4875
|
*/
|
|
4855
4876
|
'createdAt': string;
|
|
4877
|
+
/**
|
|
4878
|
+
*
|
|
4879
|
+
* @type {GiftCardStatus}
|
|
4880
|
+
* @memberof CreateMunchiGiftCardResponseDto
|
|
4881
|
+
*/
|
|
4882
|
+
'status'?: GiftCardStatus;
|
|
4856
4883
|
}
|
|
4857
4884
|
|
|
4858
4885
|
|
|
@@ -5322,6 +5349,37 @@ export interface CreateTerminalPaymentDto {
|
|
|
5322
5349
|
}
|
|
5323
5350
|
|
|
5324
5351
|
|
|
5352
|
+
/**
|
|
5353
|
+
*
|
|
5354
|
+
* @export
|
|
5355
|
+
* @interface CreateVenueGiftCardDto
|
|
5356
|
+
*/
|
|
5357
|
+
export interface CreateVenueGiftCardDto {
|
|
5358
|
+
/**
|
|
5359
|
+
* The card\'s balance, in cents, 100 to 100000
|
|
5360
|
+
* @type {number}
|
|
5361
|
+
* @memberof CreateVenueGiftCardDto
|
|
5362
|
+
*/
|
|
5363
|
+
'amount': number;
|
|
5364
|
+
/**
|
|
5365
|
+
* Whom the card is for, 1 to 120 characters. Absent: nobody is named.
|
|
5366
|
+
* @type {string}
|
|
5367
|
+
* @memberof CreateVenueGiftCardDto
|
|
5368
|
+
*/
|
|
5369
|
+
'recipientName'?: string;
|
|
5370
|
+
/**
|
|
5371
|
+
* A note for the merchant, 1 to 500 characters. Absent: none.
|
|
5372
|
+
* @type {string}
|
|
5373
|
+
* @memberof CreateVenueGiftCardDto
|
|
5374
|
+
*/
|
|
5375
|
+
'note'?: string;
|
|
5376
|
+
/**
|
|
5377
|
+
* 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.
|
|
5378
|
+
* @type {string}
|
|
5379
|
+
* @memberof CreateVenueGiftCardDto
|
|
5380
|
+
*/
|
|
5381
|
+
'expiresAt'?: string | null;
|
|
5382
|
+
}
|
|
5325
5383
|
/**
|
|
5326
5384
|
*
|
|
5327
5385
|
* @export
|
|
@@ -8733,6 +8791,39 @@ export interface GetStationResponseDtoStation {
|
|
|
8733
8791
|
}
|
|
8734
8792
|
|
|
8735
8793
|
|
|
8794
|
+
/**
|
|
8795
|
+
*
|
|
8796
|
+
* @export
|
|
8797
|
+
* @enum {string}
|
|
8798
|
+
*/
|
|
8799
|
+
|
|
8800
|
+
export const GiftCardChannel = {
|
|
8801
|
+
Till: 'TILL',
|
|
8802
|
+
OnlineStore: 'ONLINE_STORE'
|
|
8803
|
+
} as const;
|
|
8804
|
+
|
|
8805
|
+
export type GiftCardChannel = typeof GiftCardChannel[keyof typeof GiftCardChannel];
|
|
8806
|
+
|
|
8807
|
+
|
|
8808
|
+
/**
|
|
8809
|
+
*
|
|
8810
|
+
* @export
|
|
8811
|
+
* @interface GiftCardChannelsDto
|
|
8812
|
+
*/
|
|
8813
|
+
export interface GiftCardChannelsDto {
|
|
8814
|
+
/**
|
|
8815
|
+
* Whether the store\'s till takes gift cards
|
|
8816
|
+
* @type {boolean}
|
|
8817
|
+
* @memberof GiftCardChannelsDto
|
|
8818
|
+
*/
|
|
8819
|
+
'till': boolean;
|
|
8820
|
+
/**
|
|
8821
|
+
* Whether the store\'s online store takes gift cards
|
|
8822
|
+
* @type {boolean}
|
|
8823
|
+
* @memberof GiftCardChannelsDto
|
|
8824
|
+
*/
|
|
8825
|
+
'onlineStore': boolean;
|
|
8826
|
+
}
|
|
8736
8827
|
/**
|
|
8737
8828
|
*
|
|
8738
8829
|
* @export
|
|
@@ -8850,6 +8941,77 @@ export const GiftCardErrorCode = {
|
|
|
8850
8941
|
export type GiftCardErrorCode = typeof GiftCardErrorCode[keyof typeof GiftCardErrorCode];
|
|
8851
8942
|
|
|
8852
8943
|
|
|
8944
|
+
/**
|
|
8945
|
+
*
|
|
8946
|
+
* @export
|
|
8947
|
+
* @interface GiftCardHistoryEventDto
|
|
8948
|
+
*/
|
|
8949
|
+
export interface GiftCardHistoryEventDto {
|
|
8950
|
+
/**
|
|
8951
|
+
*
|
|
8952
|
+
* @type {GiftCardHistoryKind}
|
|
8953
|
+
* @memberof GiftCardHistoryEventDto
|
|
8954
|
+
*/
|
|
8955
|
+
'kind': GiftCardHistoryKind;
|
|
8956
|
+
/**
|
|
8957
|
+
* 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
|
|
8958
|
+
* @type {number}
|
|
8959
|
+
* @memberof GiftCardHistoryEventDto
|
|
8960
|
+
*/
|
|
8961
|
+
'amount': number;
|
|
8962
|
+
/**
|
|
8963
|
+
* The card\'s balance after it, in cents; null for BLOCKED, UNBLOCKED and SWITCHED_ON
|
|
8964
|
+
* @type {number}
|
|
8965
|
+
* @memberof GiftCardHistoryEventDto
|
|
8966
|
+
*/
|
|
8967
|
+
'balanceAfter': number | null;
|
|
8968
|
+
/**
|
|
8969
|
+
* The store where it happened; null when the history did not record one
|
|
8970
|
+
* @type {number}
|
|
8971
|
+
* @memberof GiftCardHistoryEventDto
|
|
8972
|
+
*/
|
|
8973
|
+
'venueId': number | null;
|
|
8974
|
+
/**
|
|
8975
|
+
* That store\'s name; null with venueId, or when the store is gone
|
|
8976
|
+
* @type {string}
|
|
8977
|
+
* @memberof GiftCardHistoryEventDto
|
|
8978
|
+
*/
|
|
8979
|
+
'venueName': string | null;
|
|
8980
|
+
/**
|
|
8981
|
+
* The till order it belongs to; null when none
|
|
8982
|
+
* @type {string}
|
|
8983
|
+
* @memberof GiftCardHistoryEventDto
|
|
8984
|
+
*/
|
|
8985
|
+
'orderId': string | null;
|
|
8986
|
+
/**
|
|
8987
|
+
* When it happened, ISO 8601
|
|
8988
|
+
* @type {string}
|
|
8989
|
+
* @memberof GiftCardHistoryEventDto
|
|
8990
|
+
*/
|
|
8991
|
+
'at': string;
|
|
8992
|
+
}
|
|
8993
|
+
|
|
8994
|
+
|
|
8995
|
+
/**
|
|
8996
|
+
*
|
|
8997
|
+
* @export
|
|
8998
|
+
* @enum {string}
|
|
8999
|
+
*/
|
|
9000
|
+
|
|
9001
|
+
export const GiftCardHistoryKind = {
|
|
9002
|
+
Sold: 'SOLD',
|
|
9003
|
+
CreatedByHand: 'CREATED_BY_HAND',
|
|
9004
|
+
Spent: 'SPENT',
|
|
9005
|
+
GivenBack: 'GIVEN_BACK',
|
|
9006
|
+
Corrected: 'CORRECTED',
|
|
9007
|
+
Blocked: 'BLOCKED',
|
|
9008
|
+
Unblocked: 'UNBLOCKED',
|
|
9009
|
+
SwitchedOn: 'SWITCHED_ON'
|
|
9010
|
+
} as const;
|
|
9011
|
+
|
|
9012
|
+
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
9013
|
+
|
|
9014
|
+
|
|
8853
9015
|
/**
|
|
8854
9016
|
*
|
|
8855
9017
|
* @export
|
|
@@ -8893,6 +9055,21 @@ export interface GiftCardInfoDto {
|
|
|
8893
9055
|
*/
|
|
8894
9056
|
'giftCardNumber': string;
|
|
8895
9057
|
}
|
|
9058
|
+
/**
|
|
9059
|
+
*
|
|
9060
|
+
* @export
|
|
9061
|
+
* @enum {string}
|
|
9062
|
+
*/
|
|
9063
|
+
|
|
9064
|
+
export const GiftCardIssue = {
|
|
9065
|
+
TillSale: 'TILL_SALE',
|
|
9066
|
+
OnlineSale: 'ONLINE_SALE',
|
|
9067
|
+
ByHand: 'BY_HAND'
|
|
9068
|
+
} as const;
|
|
9069
|
+
|
|
9070
|
+
export type GiftCardIssue = typeof GiftCardIssue[keyof typeof GiftCardIssue];
|
|
9071
|
+
|
|
9072
|
+
|
|
8896
9073
|
/**
|
|
8897
9074
|
*
|
|
8898
9075
|
* @export
|
|
@@ -8912,6 +9089,415 @@ export interface GiftCardLinksDto {
|
|
|
8912
9089
|
*/
|
|
8913
9090
|
'validate'?: string;
|
|
8914
9091
|
}
|
|
9092
|
+
/**
|
|
9093
|
+
*
|
|
9094
|
+
* @export
|
|
9095
|
+
* @interface GiftCardMoneyDto
|
|
9096
|
+
*/
|
|
9097
|
+
export interface GiftCardMoneyDto {
|
|
9098
|
+
/**
|
|
9099
|
+
* The sum, in cents
|
|
9100
|
+
* @type {number}
|
|
9101
|
+
* @memberof GiftCardMoneyDto
|
|
9102
|
+
*/
|
|
9103
|
+
'amount': number;
|
|
9104
|
+
/**
|
|
9105
|
+
* How many cards
|
|
9106
|
+
* @type {number}
|
|
9107
|
+
* @memberof GiftCardMoneyDto
|
|
9108
|
+
*/
|
|
9109
|
+
'count': number;
|
|
9110
|
+
}
|
|
9111
|
+
/**
|
|
9112
|
+
*
|
|
9113
|
+
* @export
|
|
9114
|
+
* @interface GiftCardReportDto
|
|
9115
|
+
*/
|
|
9116
|
+
export interface GiftCardReportDto {
|
|
9117
|
+
/**
|
|
9118
|
+
*
|
|
9119
|
+
* @type {CurrencyCode}
|
|
9120
|
+
* @memberof GiftCardReportDto
|
|
9121
|
+
*/
|
|
9122
|
+
'currency': CurrencyCode;
|
|
9123
|
+
/**
|
|
9124
|
+
*
|
|
9125
|
+
* @type {GiftCardReportDtoSold}
|
|
9126
|
+
* @memberof GiftCardReportDto
|
|
9127
|
+
*/
|
|
9128
|
+
'sold': GiftCardReportDtoSold;
|
|
9129
|
+
/**
|
|
9130
|
+
*
|
|
9131
|
+
* @type {GiftCardReportDtoGivenFree}
|
|
9132
|
+
* @memberof GiftCardReportDto
|
|
9133
|
+
*/
|
|
9134
|
+
'givenFree': GiftCardReportDtoGivenFree;
|
|
9135
|
+
/**
|
|
9136
|
+
*
|
|
9137
|
+
* @type {GiftCardReportDtoSpent}
|
|
9138
|
+
* @memberof GiftCardReportDto
|
|
9139
|
+
*/
|
|
9140
|
+
'spent': GiftCardReportDtoSpent;
|
|
9141
|
+
/**
|
|
9142
|
+
* Right now, what is left on the owner\'s cards that are ACTIVE, in cents
|
|
9143
|
+
* @type {number}
|
|
9144
|
+
* @memberof GiftCardReportDto
|
|
9145
|
+
*/
|
|
9146
|
+
'leftOnCards': number;
|
|
9147
|
+
/**
|
|
9148
|
+
* One row per store with any movement in the period
|
|
9149
|
+
* @type {Array<GiftCardStoreReportDto>}
|
|
9150
|
+
* @memberof GiftCardReportDto
|
|
9151
|
+
*/
|
|
9152
|
+
'stores': Array<GiftCardStoreReportDto>;
|
|
9153
|
+
}
|
|
9154
|
+
|
|
9155
|
+
|
|
9156
|
+
/**
|
|
9157
|
+
* Cards made by hand in the period
|
|
9158
|
+
* @export
|
|
9159
|
+
* @interface GiftCardReportDtoGivenFree
|
|
9160
|
+
*/
|
|
9161
|
+
export interface GiftCardReportDtoGivenFree {
|
|
9162
|
+
/**
|
|
9163
|
+
* The sum, in cents
|
|
9164
|
+
* @type {number}
|
|
9165
|
+
* @memberof GiftCardReportDtoGivenFree
|
|
9166
|
+
*/
|
|
9167
|
+
'amount': number;
|
|
9168
|
+
/**
|
|
9169
|
+
* How many cards
|
|
9170
|
+
* @type {number}
|
|
9171
|
+
* @memberof GiftCardReportDtoGivenFree
|
|
9172
|
+
*/
|
|
9173
|
+
'count': number;
|
|
9174
|
+
}
|
|
9175
|
+
/**
|
|
9176
|
+
* Cards sold in the period, at the till or online
|
|
9177
|
+
* @export
|
|
9178
|
+
* @interface GiftCardReportDtoSold
|
|
9179
|
+
*/
|
|
9180
|
+
export interface GiftCardReportDtoSold {
|
|
9181
|
+
/**
|
|
9182
|
+
* The sum, in cents
|
|
9183
|
+
* @type {number}
|
|
9184
|
+
* @memberof GiftCardReportDtoSold
|
|
9185
|
+
*/
|
|
9186
|
+
'amount': number;
|
|
9187
|
+
/**
|
|
9188
|
+
* How many cards
|
|
9189
|
+
* @type {number}
|
|
9190
|
+
* @memberof GiftCardReportDtoSold
|
|
9191
|
+
*/
|
|
9192
|
+
'count': number;
|
|
9193
|
+
}
|
|
9194
|
+
/**
|
|
9195
|
+
* Cards spent in the period
|
|
9196
|
+
* @export
|
|
9197
|
+
* @interface GiftCardReportDtoSpent
|
|
9198
|
+
*/
|
|
9199
|
+
export interface GiftCardReportDtoSpent {
|
|
9200
|
+
/**
|
|
9201
|
+
* Taken off cards, less what went back on them, in cents
|
|
9202
|
+
* @type {number}
|
|
9203
|
+
* @memberof GiftCardReportDtoSpent
|
|
9204
|
+
*/
|
|
9205
|
+
'amount': number;
|
|
9206
|
+
/**
|
|
9207
|
+
* How many orders cards paid that kept the payment
|
|
9208
|
+
* @type {number}
|
|
9209
|
+
* @memberof GiftCardReportDtoSpent
|
|
9210
|
+
*/
|
|
9211
|
+
'orderCount': number;
|
|
9212
|
+
}
|
|
9213
|
+
/**
|
|
9214
|
+
*
|
|
9215
|
+
* @export
|
|
9216
|
+
* @interface GiftCardSettingsDto
|
|
9217
|
+
*/
|
|
9218
|
+
export interface GiftCardSettingsDto {
|
|
9219
|
+
/**
|
|
9220
|
+
*
|
|
9221
|
+
* @type {GiftCardSettingsDtoChannels}
|
|
9222
|
+
* @memberof GiftCardSettingsDto
|
|
9223
|
+
*/
|
|
9224
|
+
'channels': GiftCardSettingsDtoChannels;
|
|
9225
|
+
/**
|
|
9226
|
+
* 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.
|
|
9227
|
+
* @type {Array<GiftCardChannel>}
|
|
9228
|
+
* @memberof GiftCardSettingsDto
|
|
9229
|
+
*/
|
|
9230
|
+
'availableChannels': Array<GiftCardChannel>;
|
|
9231
|
+
/**
|
|
9232
|
+
* The amounts offered, in cents, ascending
|
|
9233
|
+
* @type {Array<number>}
|
|
9234
|
+
* @memberof GiftCardSettingsDto
|
|
9235
|
+
*/
|
|
9236
|
+
'amounts': Array<number>;
|
|
9237
|
+
/**
|
|
9238
|
+
* Whether a buyer may choose any amount
|
|
9239
|
+
* @type {boolean}
|
|
9240
|
+
* @memberof GiftCardSettingsDto
|
|
9241
|
+
*/
|
|
9242
|
+
'anyAmount': boolean;
|
|
9243
|
+
/**
|
|
9244
|
+
* The smallest amount a buyer may choose, in cents
|
|
9245
|
+
* @type {number}
|
|
9246
|
+
* @memberof GiftCardSettingsDto
|
|
9247
|
+
*/
|
|
9248
|
+
'minAmount': number;
|
|
9249
|
+
/**
|
|
9250
|
+
* The largest amount a buyer may choose, in cents
|
|
9251
|
+
* @type {number}
|
|
9252
|
+
* @memberof GiftCardSettingsDto
|
|
9253
|
+
*/
|
|
9254
|
+
'maxAmount': number;
|
|
9255
|
+
/**
|
|
9256
|
+
* How many months a new card stays valid; null when cards never expire
|
|
9257
|
+
* @type {number}
|
|
9258
|
+
* @memberof GiftCardSettingsDto
|
|
9259
|
+
*/
|
|
9260
|
+
'validityMonths': number | null;
|
|
9261
|
+
/**
|
|
9262
|
+
* The text printed on the card; null when none
|
|
9263
|
+
* @type {string}
|
|
9264
|
+
* @memberof GiftCardSettingsDto
|
|
9265
|
+
*/
|
|
9266
|
+
'cardText': string | null;
|
|
9267
|
+
/**
|
|
9268
|
+
* The card\'s picture, an https URL; null when none
|
|
9269
|
+
* @type {string}
|
|
9270
|
+
* @memberof GiftCardSettingsDto
|
|
9271
|
+
*/
|
|
9272
|
+
'imageUrl': string | null;
|
|
9273
|
+
}
|
|
9274
|
+
/**
|
|
9275
|
+
* Where the store\'s gift cards can be spent
|
|
9276
|
+
* @export
|
|
9277
|
+
* @interface GiftCardSettingsDtoChannels
|
|
9278
|
+
*/
|
|
9279
|
+
export interface GiftCardSettingsDtoChannels {
|
|
9280
|
+
/**
|
|
9281
|
+
* Whether the store\'s till takes gift cards
|
|
9282
|
+
* @type {boolean}
|
|
9283
|
+
* @memberof GiftCardSettingsDtoChannels
|
|
9284
|
+
*/
|
|
9285
|
+
'till': boolean;
|
|
9286
|
+
/**
|
|
9287
|
+
* Whether the store\'s online store takes gift cards
|
|
9288
|
+
* @type {boolean}
|
|
9289
|
+
* @memberof GiftCardSettingsDtoChannels
|
|
9290
|
+
*/
|
|
9291
|
+
'onlineStore': boolean;
|
|
9292
|
+
}
|
|
9293
|
+
/**
|
|
9294
|
+
*
|
|
9295
|
+
* @export
|
|
9296
|
+
* @interface GiftCardSpentDto
|
|
9297
|
+
*/
|
|
9298
|
+
export interface GiftCardSpentDto {
|
|
9299
|
+
/**
|
|
9300
|
+
* Taken off cards, less what went back on them, in cents
|
|
9301
|
+
* @type {number}
|
|
9302
|
+
* @memberof GiftCardSpentDto
|
|
9303
|
+
*/
|
|
9304
|
+
'amount': number;
|
|
9305
|
+
/**
|
|
9306
|
+
* How many orders cards paid that kept the payment
|
|
9307
|
+
* @type {number}
|
|
9308
|
+
* @memberof GiftCardSpentDto
|
|
9309
|
+
*/
|
|
9310
|
+
'orderCount': number;
|
|
9311
|
+
}
|
|
9312
|
+
/**
|
|
9313
|
+
*
|
|
9314
|
+
* @export
|
|
9315
|
+
* @enum {string}
|
|
9316
|
+
*/
|
|
9317
|
+
|
|
9318
|
+
export const GiftCardState = {
|
|
9319
|
+
Blocked: 'BLOCKED',
|
|
9320
|
+
NotYetValid: 'NOT_YET_VALID',
|
|
9321
|
+
Expired: 'EXPIRED',
|
|
9322
|
+
UsedUp: 'USED_UP',
|
|
9323
|
+
Active: 'ACTIVE'
|
|
9324
|
+
} as const;
|
|
9325
|
+
|
|
9326
|
+
export type GiftCardState = typeof GiftCardState[keyof typeof GiftCardState];
|
|
9327
|
+
|
|
9328
|
+
|
|
9329
|
+
/**
|
|
9330
|
+
*
|
|
9331
|
+
* @export
|
|
9332
|
+
* @enum {string}
|
|
9333
|
+
*/
|
|
9334
|
+
|
|
9335
|
+
export const GiftCardStatus = {
|
|
9336
|
+
Pending: 'PENDING',
|
|
9337
|
+
Active: 'ACTIVE'
|
|
9338
|
+
} as const;
|
|
9339
|
+
|
|
9340
|
+
export type GiftCardStatus = typeof GiftCardStatus[keyof typeof GiftCardStatus];
|
|
9341
|
+
|
|
9342
|
+
|
|
9343
|
+
/**
|
|
9344
|
+
*
|
|
9345
|
+
* @export
|
|
9346
|
+
* @interface GiftCardStoreReportDto
|
|
9347
|
+
*/
|
|
9348
|
+
export interface GiftCardStoreReportDto {
|
|
9349
|
+
/**
|
|
9350
|
+
* The store; null for the history of a merchant\'s cards sold before it recorded the store
|
|
9351
|
+
* @type {number}
|
|
9352
|
+
* @memberof GiftCardStoreReportDto
|
|
9353
|
+
*/
|
|
9354
|
+
'venueId': number | null;
|
|
9355
|
+
/**
|
|
9356
|
+
* The store\'s name; null with venueId, or when the store is gone
|
|
9357
|
+
* @type {string}
|
|
9358
|
+
* @memberof GiftCardStoreReportDto
|
|
9359
|
+
*/
|
|
9360
|
+
'venueName': string | null;
|
|
9361
|
+
/**
|
|
9362
|
+
*
|
|
9363
|
+
* @type {GiftCardStoreReportDtoSold}
|
|
9364
|
+
* @memberof GiftCardStoreReportDto
|
|
9365
|
+
*/
|
|
9366
|
+
'sold': GiftCardStoreReportDtoSold;
|
|
9367
|
+
/**
|
|
9368
|
+
*
|
|
9369
|
+
* @type {GiftCardStoreReportDtoGivenFree}
|
|
9370
|
+
* @memberof GiftCardStoreReportDto
|
|
9371
|
+
*/
|
|
9372
|
+
'givenFree': GiftCardStoreReportDtoGivenFree;
|
|
9373
|
+
/**
|
|
9374
|
+
*
|
|
9375
|
+
* @type {GiftCardStoreReportDtoSpent}
|
|
9376
|
+
* @memberof GiftCardStoreReportDto
|
|
9377
|
+
*/
|
|
9378
|
+
'spent': GiftCardStoreReportDtoSpent;
|
|
9379
|
+
/**
|
|
9380
|
+
* Sold less spent, in cents: what the store took in for cards less what it gave out
|
|
9381
|
+
* @type {number}
|
|
9382
|
+
* @memberof GiftCardStoreReportDto
|
|
9383
|
+
*/
|
|
9384
|
+
'difference': number;
|
|
9385
|
+
}
|
|
9386
|
+
/**
|
|
9387
|
+
* Cards made by hand at the store
|
|
9388
|
+
* @export
|
|
9389
|
+
* @interface GiftCardStoreReportDtoGivenFree
|
|
9390
|
+
*/
|
|
9391
|
+
export interface GiftCardStoreReportDtoGivenFree {
|
|
9392
|
+
/**
|
|
9393
|
+
* The sum, in cents
|
|
9394
|
+
* @type {number}
|
|
9395
|
+
* @memberof GiftCardStoreReportDtoGivenFree
|
|
9396
|
+
*/
|
|
9397
|
+
'amount': number;
|
|
9398
|
+
/**
|
|
9399
|
+
* How many cards
|
|
9400
|
+
* @type {number}
|
|
9401
|
+
* @memberof GiftCardStoreReportDtoGivenFree
|
|
9402
|
+
*/
|
|
9403
|
+
'count': number;
|
|
9404
|
+
}
|
|
9405
|
+
/**
|
|
9406
|
+
* Cards sold at the store
|
|
9407
|
+
* @export
|
|
9408
|
+
* @interface GiftCardStoreReportDtoSold
|
|
9409
|
+
*/
|
|
9410
|
+
export interface GiftCardStoreReportDtoSold {
|
|
9411
|
+
/**
|
|
9412
|
+
* The sum, in cents
|
|
9413
|
+
* @type {number}
|
|
9414
|
+
* @memberof GiftCardStoreReportDtoSold
|
|
9415
|
+
*/
|
|
9416
|
+
'amount': number;
|
|
9417
|
+
/**
|
|
9418
|
+
* How many cards
|
|
9419
|
+
* @type {number}
|
|
9420
|
+
* @memberof GiftCardStoreReportDtoSold
|
|
9421
|
+
*/
|
|
9422
|
+
'count': number;
|
|
9423
|
+
}
|
|
9424
|
+
/**
|
|
9425
|
+
* Cards spent at the store
|
|
9426
|
+
* @export
|
|
9427
|
+
* @interface GiftCardStoreReportDtoSpent
|
|
9428
|
+
*/
|
|
9429
|
+
export interface GiftCardStoreReportDtoSpent {
|
|
9430
|
+
/**
|
|
9431
|
+
* Taken off cards, less what went back on them, in cents
|
|
9432
|
+
* @type {number}
|
|
9433
|
+
* @memberof GiftCardStoreReportDtoSpent
|
|
9434
|
+
*/
|
|
9435
|
+
'amount': number;
|
|
9436
|
+
/**
|
|
9437
|
+
* How many orders cards paid that kept the payment
|
|
9438
|
+
* @type {number}
|
|
9439
|
+
* @memberof GiftCardStoreReportDtoSpent
|
|
9440
|
+
*/
|
|
9441
|
+
'orderCount': number;
|
|
9442
|
+
}
|
|
9443
|
+
/**
|
|
9444
|
+
*
|
|
9445
|
+
* @export
|
|
9446
|
+
* @interface GiveBackMunchiGiftCardDto
|
|
9447
|
+
*/
|
|
9448
|
+
export interface GiveBackMunchiGiftCardDto {
|
|
9449
|
+
/**
|
|
9450
|
+
* The venue\'s orderingBusinessId: the venue whose till made the redemption
|
|
9451
|
+
* @type {number}
|
|
9452
|
+
* @memberof GiveBackMunchiGiftCardDto
|
|
9453
|
+
*/
|
|
9454
|
+
'orderingBusinessId': number;
|
|
9455
|
+
/**
|
|
9456
|
+
* The X-Idempotency-Key the till sent with the redemption to give back; 8 to 100 letters, digits, \'-\' or \'_\'
|
|
9457
|
+
* @type {string}
|
|
9458
|
+
* @memberof GiveBackMunchiGiftCardDto
|
|
9459
|
+
*/
|
|
9460
|
+
'idempotencyKey': string;
|
|
9461
|
+
}
|
|
9462
|
+
/**
|
|
9463
|
+
*
|
|
9464
|
+
* @export
|
|
9465
|
+
* @interface GiveBackMunchiGiftCardResponseDto
|
|
9466
|
+
*/
|
|
9467
|
+
export interface GiveBackMunchiGiftCardResponseDto {
|
|
9468
|
+
/**
|
|
9469
|
+
* true when the redemption\'s amount is back on the card: given back now, or already before
|
|
9470
|
+
* @type {boolean}
|
|
9471
|
+
* @memberof GiveBackMunchiGiftCardResponseDto
|
|
9472
|
+
*/
|
|
9473
|
+
'success': boolean;
|
|
9474
|
+
/**
|
|
9475
|
+
*
|
|
9476
|
+
* @type {GiftCardErrorCode}
|
|
9477
|
+
* @memberof GiveBackMunchiGiftCardResponseDto
|
|
9478
|
+
*/
|
|
9479
|
+
'errorCode'?: GiftCardErrorCode | null;
|
|
9480
|
+
/**
|
|
9481
|
+
* On success: the amount put back on the card, in cents
|
|
9482
|
+
* @type {number}
|
|
9483
|
+
* @memberof GiveBackMunchiGiftCardResponseDto
|
|
9484
|
+
*/
|
|
9485
|
+
'givenBackAmount'?: number;
|
|
9486
|
+
/**
|
|
9487
|
+
* On success: what the card holds now, in units of its currency (euros for EUR, not cents)
|
|
9488
|
+
* @type {number}
|
|
9489
|
+
* @memberof GiveBackMunchiGiftCardResponseDto
|
|
9490
|
+
*/
|
|
9491
|
+
'remainingBalance'?: number;
|
|
9492
|
+
/**
|
|
9493
|
+
*
|
|
9494
|
+
* @type {CurrencyCode}
|
|
9495
|
+
* @memberof GiveBackMunchiGiftCardResponseDto
|
|
9496
|
+
*/
|
|
9497
|
+
'currency'?: CurrencyCode;
|
|
9498
|
+
}
|
|
9499
|
+
|
|
9500
|
+
|
|
8915
9501
|
/**
|
|
8916
9502
|
*
|
|
8917
9503
|
* @export
|
|
@@ -13630,6 +14216,18 @@ export interface MunchiGiftCardDataItemDto {
|
|
|
13630
14216
|
* @memberof MunchiGiftCardDataItemDto
|
|
13631
14217
|
*/
|
|
13632
14218
|
'id': string;
|
|
14219
|
+
/**
|
|
14220
|
+
*
|
|
14221
|
+
* @type {GiftCardStatus}
|
|
14222
|
+
* @memberof MunchiGiftCardDataItemDto
|
|
14223
|
+
*/
|
|
14224
|
+
'status'?: GiftCardStatus;
|
|
14225
|
+
/**
|
|
14226
|
+
* Whether the card is blocked: no till or store takes it, whatever its status says. Absent from servers before it.
|
|
14227
|
+
* @type {boolean}
|
|
14228
|
+
* @memberof MunchiGiftCardDataItemDto
|
|
14229
|
+
*/
|
|
14230
|
+
'blocked'?: boolean;
|
|
13633
14231
|
/**
|
|
13634
14232
|
* The card\'s 6-digit code
|
|
13635
14233
|
* @type {string}
|
|
@@ -25841,6 +26439,12 @@ export interface RedeemGiftCardDto {
|
|
|
25841
26439
|
* @memberof RedeemGiftCardDto
|
|
25842
26440
|
*/
|
|
25843
26441
|
'orderingBusinessId': number;
|
|
26442
|
+
/**
|
|
26443
|
+
* 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
|
|
26444
|
+
* @type {string}
|
|
26445
|
+
* @memberof RedeemGiftCardDto
|
|
26446
|
+
*/
|
|
26447
|
+
'orderId'?: string;
|
|
25844
26448
|
}
|
|
25845
26449
|
/**
|
|
25846
26450
|
*
|
|
@@ -35858,6 +36462,80 @@ export interface UpdateFloorSectionDto {
|
|
|
35858
36462
|
*/
|
|
35859
36463
|
'sortOrder'?: number;
|
|
35860
36464
|
}
|
|
36465
|
+
/**
|
|
36466
|
+
*
|
|
36467
|
+
* @export
|
|
36468
|
+
* @interface UpdateGiftCardSettingsDto
|
|
36469
|
+
*/
|
|
36470
|
+
export interface UpdateGiftCardSettingsDto {
|
|
36471
|
+
/**
|
|
36472
|
+
*
|
|
36473
|
+
* @type {UpdateGiftCardSettingsDtoChannels}
|
|
36474
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36475
|
+
*/
|
|
36476
|
+
'channels'?: UpdateGiftCardSettingsDtoChannels;
|
|
36477
|
+
/**
|
|
36478
|
+
* The amounts offered, in cents: 1 to 6 different amounts, each 100 to 100000. Stored ascending. Absent: unchanged.
|
|
36479
|
+
* @type {Array<number>}
|
|
36480
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36481
|
+
*/
|
|
36482
|
+
'amounts'?: Array<number>;
|
|
36483
|
+
/**
|
|
36484
|
+
* Whether a buyer may choose any amount. Absent: unchanged.
|
|
36485
|
+
* @type {boolean}
|
|
36486
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36487
|
+
*/
|
|
36488
|
+
'anyAmount'?: boolean;
|
|
36489
|
+
/**
|
|
36490
|
+
* The smallest amount a buyer may choose, in cents, 100 to 100000; not above maxAmount once merged with what is stored. Absent: unchanged.
|
|
36491
|
+
* @type {number}
|
|
36492
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36493
|
+
*/
|
|
36494
|
+
'minAmount'?: number;
|
|
36495
|
+
/**
|
|
36496
|
+
* The largest amount a buyer may choose, in cents, 100 to 100000; not below minAmount once merged with what is stored. Absent: unchanged.
|
|
36497
|
+
* @type {number}
|
|
36498
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36499
|
+
*/
|
|
36500
|
+
'maxAmount'?: number;
|
|
36501
|
+
/**
|
|
36502
|
+
* How many months a new card stays valid, 1 to 60, or null for never. Absent: unchanged.
|
|
36503
|
+
* @type {number}
|
|
36504
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36505
|
+
*/
|
|
36506
|
+
'validityMonths'?: number | null;
|
|
36507
|
+
/**
|
|
36508
|
+
* The text printed on the card, 1 to 120 characters, or null for none. Absent: unchanged.
|
|
36509
|
+
* @type {string}
|
|
36510
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36511
|
+
*/
|
|
36512
|
+
'cardText'?: string | null;
|
|
36513
|
+
/**
|
|
36514
|
+
* The card\'s picture, an https URL of at most 2048 characters, or null for none. Absent: unchanged.
|
|
36515
|
+
* @type {string}
|
|
36516
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
36517
|
+
*/
|
|
36518
|
+
'imageUrl'?: string | null;
|
|
36519
|
+
}
|
|
36520
|
+
/**
|
|
36521
|
+
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
36522
|
+
* @export
|
|
36523
|
+
* @interface UpdateGiftCardSettingsDtoChannels
|
|
36524
|
+
*/
|
|
36525
|
+
export interface UpdateGiftCardSettingsDtoChannels {
|
|
36526
|
+
/**
|
|
36527
|
+
* Whether the store\'s till takes gift cards
|
|
36528
|
+
* @type {boolean}
|
|
36529
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
36530
|
+
*/
|
|
36531
|
+
'till': boolean;
|
|
36532
|
+
/**
|
|
36533
|
+
* Whether the store\'s online store takes gift cards
|
|
36534
|
+
* @type {boolean}
|
|
36535
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
36536
|
+
*/
|
|
36537
|
+
'onlineStore': boolean;
|
|
36538
|
+
}
|
|
35861
36539
|
/**
|
|
35862
36540
|
*
|
|
35863
36541
|
* @export
|
|
@@ -37464,6 +38142,223 @@ export interface VenueFoundDto {
|
|
|
37464
38142
|
*/
|
|
37465
38143
|
'chainId': string | null;
|
|
37466
38144
|
}
|
|
38145
|
+
/**
|
|
38146
|
+
*
|
|
38147
|
+
* @export
|
|
38148
|
+
* @interface VenueGiftCardDetailDto
|
|
38149
|
+
*/
|
|
38150
|
+
export interface VenueGiftCardDetailDto {
|
|
38151
|
+
/**
|
|
38152
|
+
* The card\'s id
|
|
38153
|
+
* @type {string}
|
|
38154
|
+
* @memberof VenueGiftCardDetailDto
|
|
38155
|
+
*/
|
|
38156
|
+
'id': string;
|
|
38157
|
+
/**
|
|
38158
|
+
* The 6-digit code the customer gives
|
|
38159
|
+
* @type {string}
|
|
38160
|
+
* @memberof VenueGiftCardDetailDto
|
|
38161
|
+
*/
|
|
38162
|
+
'code': string;
|
|
38163
|
+
/**
|
|
38164
|
+
*
|
|
38165
|
+
* @type {GiftCardState}
|
|
38166
|
+
* @memberof VenueGiftCardDetailDto
|
|
38167
|
+
*/
|
|
38168
|
+
'state': GiftCardState;
|
|
38169
|
+
/**
|
|
38170
|
+
*
|
|
38171
|
+
* @type {GiftCardIssue}
|
|
38172
|
+
* @memberof VenueGiftCardDetailDto
|
|
38173
|
+
*/
|
|
38174
|
+
'issuedAs': GiftCardIssue;
|
|
38175
|
+
/**
|
|
38176
|
+
*
|
|
38177
|
+
* @type {CurrencyCode}
|
|
38178
|
+
* @memberof VenueGiftCardDetailDto
|
|
38179
|
+
*/
|
|
38180
|
+
'currency': CurrencyCode;
|
|
38181
|
+
/**
|
|
38182
|
+
* The card\'s first balance, in cents
|
|
38183
|
+
* @type {number}
|
|
38184
|
+
* @memberof VenueGiftCardDetailDto
|
|
38185
|
+
*/
|
|
38186
|
+
'initialBalance': number;
|
|
38187
|
+
/**
|
|
38188
|
+
* What is left on the card, in cents
|
|
38189
|
+
* @type {number}
|
|
38190
|
+
* @memberof VenueGiftCardDetailDto
|
|
38191
|
+
*/
|
|
38192
|
+
'remainingBalance': number;
|
|
38193
|
+
/**
|
|
38194
|
+
* Who bought the card, or whom a card made by hand is for; null when nobody was named
|
|
38195
|
+
* @type {string}
|
|
38196
|
+
* @memberof VenueGiftCardDetailDto
|
|
38197
|
+
*/
|
|
38198
|
+
'buyerName': string | null;
|
|
38199
|
+
/**
|
|
38200
|
+
* The buyer\'s email; null when none was given
|
|
38201
|
+
* @type {string}
|
|
38202
|
+
* @memberof VenueGiftCardDetailDto
|
|
38203
|
+
*/
|
|
38204
|
+
'buyerEmail': string | null;
|
|
38205
|
+
/**
|
|
38206
|
+
* The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
|
|
38207
|
+
* @type {number}
|
|
38208
|
+
* @memberof VenueGiftCardDetailDto
|
|
38209
|
+
*/
|
|
38210
|
+
'soldAtVenueId': number | null;
|
|
38211
|
+
/**
|
|
38212
|
+
* That store\'s name; null with soldAtVenueId, or when the store is gone
|
|
38213
|
+
* @type {string}
|
|
38214
|
+
* @memberof VenueGiftCardDetailDto
|
|
38215
|
+
*/
|
|
38216
|
+
'soldAtVenueName': string | null;
|
|
38217
|
+
/**
|
|
38218
|
+
* When the card stops working, ISO 8601; null when it never expires
|
|
38219
|
+
* @type {string}
|
|
38220
|
+
* @memberof VenueGiftCardDetailDto
|
|
38221
|
+
*/
|
|
38222
|
+
'expiresAt': string | null;
|
|
38223
|
+
/**
|
|
38224
|
+
* When the card was made, ISO 8601
|
|
38225
|
+
* @type {string}
|
|
38226
|
+
* @memberof VenueGiftCardDetailDto
|
|
38227
|
+
*/
|
|
38228
|
+
'createdAt': string;
|
|
38229
|
+
/**
|
|
38230
|
+
* The note written on a card made by hand; null when none
|
|
38231
|
+
* @type {string}
|
|
38232
|
+
* @memberof VenueGiftCardDetailDto
|
|
38233
|
+
*/
|
|
38234
|
+
'note': string | null;
|
|
38235
|
+
/**
|
|
38236
|
+
* When the card was blocked, ISO 8601; null while it is not blocked
|
|
38237
|
+
* @type {string}
|
|
38238
|
+
* @memberof VenueGiftCardDetailDto
|
|
38239
|
+
*/
|
|
38240
|
+
'blockedAt': string | null;
|
|
38241
|
+
/**
|
|
38242
|
+
* Why it was blocked; null while it is not blocked or no reason was given
|
|
38243
|
+
* @type {string}
|
|
38244
|
+
* @memberof VenueGiftCardDetailDto
|
|
38245
|
+
*/
|
|
38246
|
+
'blockReason': string | null;
|
|
38247
|
+
/**
|
|
38248
|
+
* What happened to the card, oldest first
|
|
38249
|
+
* @type {Array<GiftCardHistoryEventDto>}
|
|
38250
|
+
* @memberof VenueGiftCardDetailDto
|
|
38251
|
+
*/
|
|
38252
|
+
'history': Array<GiftCardHistoryEventDto>;
|
|
38253
|
+
}
|
|
38254
|
+
|
|
38255
|
+
|
|
38256
|
+
/**
|
|
38257
|
+
*
|
|
38258
|
+
* @export
|
|
38259
|
+
* @interface VenueGiftCardDto
|
|
38260
|
+
*/
|
|
38261
|
+
export interface VenueGiftCardDto {
|
|
38262
|
+
/**
|
|
38263
|
+
* The card\'s id
|
|
38264
|
+
* @type {string}
|
|
38265
|
+
* @memberof VenueGiftCardDto
|
|
38266
|
+
*/
|
|
38267
|
+
'id': string;
|
|
38268
|
+
/**
|
|
38269
|
+
* The 6-digit code the customer gives
|
|
38270
|
+
* @type {string}
|
|
38271
|
+
* @memberof VenueGiftCardDto
|
|
38272
|
+
*/
|
|
38273
|
+
'code': string;
|
|
38274
|
+
/**
|
|
38275
|
+
*
|
|
38276
|
+
* @type {GiftCardState}
|
|
38277
|
+
* @memberof VenueGiftCardDto
|
|
38278
|
+
*/
|
|
38279
|
+
'state': GiftCardState;
|
|
38280
|
+
/**
|
|
38281
|
+
*
|
|
38282
|
+
* @type {GiftCardIssue}
|
|
38283
|
+
* @memberof VenueGiftCardDto
|
|
38284
|
+
*/
|
|
38285
|
+
'issuedAs': GiftCardIssue;
|
|
38286
|
+
/**
|
|
38287
|
+
*
|
|
38288
|
+
* @type {CurrencyCode}
|
|
38289
|
+
* @memberof VenueGiftCardDto
|
|
38290
|
+
*/
|
|
38291
|
+
'currency': CurrencyCode;
|
|
38292
|
+
/**
|
|
38293
|
+
* The card\'s first balance, in cents
|
|
38294
|
+
* @type {number}
|
|
38295
|
+
* @memberof VenueGiftCardDto
|
|
38296
|
+
*/
|
|
38297
|
+
'initialBalance': number;
|
|
38298
|
+
/**
|
|
38299
|
+
* What is left on the card, in cents
|
|
38300
|
+
* @type {number}
|
|
38301
|
+
* @memberof VenueGiftCardDto
|
|
38302
|
+
*/
|
|
38303
|
+
'remainingBalance': number;
|
|
38304
|
+
/**
|
|
38305
|
+
* Who bought the card, or whom a card made by hand is for; null when nobody was named
|
|
38306
|
+
* @type {string}
|
|
38307
|
+
* @memberof VenueGiftCardDto
|
|
38308
|
+
*/
|
|
38309
|
+
'buyerName': string | null;
|
|
38310
|
+
/**
|
|
38311
|
+
* The buyer\'s email; null when none was given
|
|
38312
|
+
* @type {string}
|
|
38313
|
+
* @memberof VenueGiftCardDto
|
|
38314
|
+
*/
|
|
38315
|
+
'buyerEmail': string | null;
|
|
38316
|
+
/**
|
|
38317
|
+
* The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
|
|
38318
|
+
* @type {number}
|
|
38319
|
+
* @memberof VenueGiftCardDto
|
|
38320
|
+
*/
|
|
38321
|
+
'soldAtVenueId': number | null;
|
|
38322
|
+
/**
|
|
38323
|
+
* That store\'s name; null with soldAtVenueId, or when the store is gone
|
|
38324
|
+
* @type {string}
|
|
38325
|
+
* @memberof VenueGiftCardDto
|
|
38326
|
+
*/
|
|
38327
|
+
'soldAtVenueName': string | null;
|
|
38328
|
+
/**
|
|
38329
|
+
* When the card stops working, ISO 8601; null when it never expires
|
|
38330
|
+
* @type {string}
|
|
38331
|
+
* @memberof VenueGiftCardDto
|
|
38332
|
+
*/
|
|
38333
|
+
'expiresAt': string | null;
|
|
38334
|
+
/**
|
|
38335
|
+
* When the card was made, ISO 8601
|
|
38336
|
+
* @type {string}
|
|
38337
|
+
* @memberof VenueGiftCardDto
|
|
38338
|
+
*/
|
|
38339
|
+
'createdAt': string;
|
|
38340
|
+
}
|
|
38341
|
+
|
|
38342
|
+
|
|
38343
|
+
/**
|
|
38344
|
+
*
|
|
38345
|
+
* @export
|
|
38346
|
+
* @interface VenueGiftCardsDto
|
|
38347
|
+
*/
|
|
38348
|
+
export interface VenueGiftCardsDto {
|
|
38349
|
+
/**
|
|
38350
|
+
* The page\'s cards, newest first
|
|
38351
|
+
* @type {Array<VenueGiftCardDto>}
|
|
38352
|
+
* @memberof VenueGiftCardsDto
|
|
38353
|
+
*/
|
|
38354
|
+
'cards': Array<VenueGiftCardDto>;
|
|
38355
|
+
/**
|
|
38356
|
+
* The cursor of the next page; null when this page is the last
|
|
38357
|
+
* @type {string}
|
|
38358
|
+
* @memberof VenueGiftCardsDto
|
|
38359
|
+
*/
|
|
38360
|
+
'nextCursor': string | null;
|
|
38361
|
+
}
|
|
37467
38362
|
/**
|
|
37468
38363
|
*
|
|
37469
38364
|
* @export
|
|
@@ -49695,6 +50590,910 @@ export class FloorPlanApi extends BaseAPI implements FloorPlanApiInterface {
|
|
|
49695
50590
|
}
|
|
49696
50591
|
|
|
49697
50592
|
|
|
50593
|
+
/**
|
|
50594
|
+
* GiftCardsApi - axios parameter creator
|
|
50595
|
+
* @export
|
|
50596
|
+
*/
|
|
50597
|
+
export const GiftCardsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
50598
|
+
return {
|
|
50599
|
+
/**
|
|
50600
|
+
* 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.
|
|
50601
|
+
* @summary Switch on a gift card whose till order is not paid yet
|
|
50602
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50603
|
+
* @param {string} cardId The card\'s id
|
|
50604
|
+
* @param {*} [options] Override http request option.
|
|
50605
|
+
* @throws {RequiredError}
|
|
50606
|
+
*/
|
|
50607
|
+
activateVenueGiftCard: async (businessId: number, cardId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50608
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50609
|
+
assertParamExists('activateVenueGiftCard', 'businessId', businessId)
|
|
50610
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
50611
|
+
assertParamExists('activateVenueGiftCard', 'cardId', cardId)
|
|
50612
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}/activate`
|
|
50613
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
50614
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
50615
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50616
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50617
|
+
let baseOptions;
|
|
50618
|
+
if (configuration) {
|
|
50619
|
+
baseOptions = configuration.baseOptions;
|
|
50620
|
+
}
|
|
50621
|
+
|
|
50622
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
50623
|
+
const localVarHeaderParameter = {} as any;
|
|
50624
|
+
const localVarQueryParameter = {} as any;
|
|
50625
|
+
|
|
50626
|
+
// authentication JWT-auth required
|
|
50627
|
+
// http bearer authentication required
|
|
50628
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50629
|
+
|
|
50630
|
+
|
|
50631
|
+
|
|
50632
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50633
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50634
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50635
|
+
|
|
50636
|
+
return {
|
|
50637
|
+
url: toPathString(localVarUrlObj),
|
|
50638
|
+
options: localVarRequestOptions,
|
|
50639
|
+
};
|
|
50640
|
+
},
|
|
50641
|
+
/**
|
|
50642
|
+
* 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.
|
|
50643
|
+
* @summary Block a gift card
|
|
50644
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50645
|
+
* @param {string} cardId The card\'s id
|
|
50646
|
+
* @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
|
|
50647
|
+
* @param {*} [options] Override http request option.
|
|
50648
|
+
* @throws {RequiredError}
|
|
50649
|
+
*/
|
|
50650
|
+
blockVenueGiftCard: async (businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50651
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50652
|
+
assertParamExists('blockVenueGiftCard', 'businessId', businessId)
|
|
50653
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
50654
|
+
assertParamExists('blockVenueGiftCard', 'cardId', cardId)
|
|
50655
|
+
// verify required parameter 'blockVenueGiftCardDto' is not null or undefined
|
|
50656
|
+
assertParamExists('blockVenueGiftCard', 'blockVenueGiftCardDto', blockVenueGiftCardDto)
|
|
50657
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}/block`
|
|
50658
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
50659
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
50660
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50661
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50662
|
+
let baseOptions;
|
|
50663
|
+
if (configuration) {
|
|
50664
|
+
baseOptions = configuration.baseOptions;
|
|
50665
|
+
}
|
|
50666
|
+
|
|
50667
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
50668
|
+
const localVarHeaderParameter = {} as any;
|
|
50669
|
+
const localVarQueryParameter = {} as any;
|
|
50670
|
+
|
|
50671
|
+
// authentication JWT-auth required
|
|
50672
|
+
// http bearer authentication required
|
|
50673
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50674
|
+
|
|
50675
|
+
|
|
50676
|
+
|
|
50677
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
50678
|
+
|
|
50679
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50680
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50681
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50682
|
+
localVarRequestOptions.data = serializeDataIfNeeded(blockVenueGiftCardDto, localVarRequestOptions, configuration)
|
|
50683
|
+
|
|
50684
|
+
return {
|
|
50685
|
+
url: toPathString(localVarUrlObj),
|
|
50686
|
+
options: localVarRequestOptions,
|
|
50687
|
+
};
|
|
50688
|
+
},
|
|
50689
|
+
/**
|
|
50690
|
+
* 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.
|
|
50691
|
+
* @summary Make a gift card by hand, given for free
|
|
50692
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50693
|
+
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
50694
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt when it sends one (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
50695
|
+
* @param {*} [options] Override http request option.
|
|
50696
|
+
* @throws {RequiredError}
|
|
50697
|
+
*/
|
|
50698
|
+
createVenueGiftCard: async (businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50699
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50700
|
+
assertParamExists('createVenueGiftCard', 'businessId', businessId)
|
|
50701
|
+
// verify required parameter 'createVenueGiftCardDto' is not null or undefined
|
|
50702
|
+
assertParamExists('createVenueGiftCard', 'createVenueGiftCardDto', createVenueGiftCardDto)
|
|
50703
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards`
|
|
50704
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
50705
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50706
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50707
|
+
let baseOptions;
|
|
50708
|
+
if (configuration) {
|
|
50709
|
+
baseOptions = configuration.baseOptions;
|
|
50710
|
+
}
|
|
50711
|
+
|
|
50712
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
50713
|
+
const localVarHeaderParameter = {} as any;
|
|
50714
|
+
const localVarQueryParameter = {} as any;
|
|
50715
|
+
|
|
50716
|
+
// authentication JWT-auth required
|
|
50717
|
+
// http bearer authentication required
|
|
50718
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50719
|
+
|
|
50720
|
+
if (xIdempotencyKey != null) {
|
|
50721
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
50722
|
+
}
|
|
50723
|
+
|
|
50724
|
+
|
|
50725
|
+
|
|
50726
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
50727
|
+
|
|
50728
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50729
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50730
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50731
|
+
localVarRequestOptions.data = serializeDataIfNeeded(createVenueGiftCardDto, localVarRequestOptions, configuration)
|
|
50732
|
+
|
|
50733
|
+
return {
|
|
50734
|
+
url: toPathString(localVarUrlObj),
|
|
50735
|
+
options: localVarRequestOptions,
|
|
50736
|
+
};
|
|
50737
|
+
},
|
|
50738
|
+
/**
|
|
50739
|
+
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
50740
|
+
* @summary Read one of a store\'s gift cards with its history
|
|
50741
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50742
|
+
* @param {string} cardId The card\'s id
|
|
50743
|
+
* @param {*} [options] Override http request option.
|
|
50744
|
+
* @throws {RequiredError}
|
|
50745
|
+
*/
|
|
50746
|
+
getVenueGiftCard: async (businessId: number, cardId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50747
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50748
|
+
assertParamExists('getVenueGiftCard', 'businessId', businessId)
|
|
50749
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
50750
|
+
assertParamExists('getVenueGiftCard', 'cardId', cardId)
|
|
50751
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}`
|
|
50752
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
50753
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
50754
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50755
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50756
|
+
let baseOptions;
|
|
50757
|
+
if (configuration) {
|
|
50758
|
+
baseOptions = configuration.baseOptions;
|
|
50759
|
+
}
|
|
50760
|
+
|
|
50761
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
50762
|
+
const localVarHeaderParameter = {} as any;
|
|
50763
|
+
const localVarQueryParameter = {} as any;
|
|
50764
|
+
|
|
50765
|
+
// authentication JWT-auth required
|
|
50766
|
+
// http bearer authentication required
|
|
50767
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50768
|
+
|
|
50769
|
+
|
|
50770
|
+
|
|
50771
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50772
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50773
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50774
|
+
|
|
50775
|
+
return {
|
|
50776
|
+
url: toPathString(localVarUrlObj),
|
|
50777
|
+
options: localVarRequestOptions,
|
|
50778
|
+
};
|
|
50779
|
+
},
|
|
50780
|
+
/**
|
|
50781
|
+
* 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.
|
|
50782
|
+
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
50783
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50784
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
50785
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
50786
|
+
* @param {*} [options] Override http request option.
|
|
50787
|
+
* @throws {RequiredError}
|
|
50788
|
+
*/
|
|
50789
|
+
getVenueGiftCardReport: async (businessId: number, from: string, to: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50790
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50791
|
+
assertParamExists('getVenueGiftCardReport', 'businessId', businessId)
|
|
50792
|
+
// verify required parameter 'from' is not null or undefined
|
|
50793
|
+
assertParamExists('getVenueGiftCardReport', 'from', from)
|
|
50794
|
+
// verify required parameter 'to' is not null or undefined
|
|
50795
|
+
assertParamExists('getVenueGiftCardReport', 'to', to)
|
|
50796
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-card-report`
|
|
50797
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
50798
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50799
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50800
|
+
let baseOptions;
|
|
50801
|
+
if (configuration) {
|
|
50802
|
+
baseOptions = configuration.baseOptions;
|
|
50803
|
+
}
|
|
50804
|
+
|
|
50805
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
50806
|
+
const localVarHeaderParameter = {} as any;
|
|
50807
|
+
const localVarQueryParameter = {} as any;
|
|
50808
|
+
|
|
50809
|
+
// authentication JWT-auth required
|
|
50810
|
+
// http bearer authentication required
|
|
50811
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50812
|
+
|
|
50813
|
+
if (from !== undefined) {
|
|
50814
|
+
localVarQueryParameter['from'] = from;
|
|
50815
|
+
}
|
|
50816
|
+
|
|
50817
|
+
if (to !== undefined) {
|
|
50818
|
+
localVarQueryParameter['to'] = to;
|
|
50819
|
+
}
|
|
50820
|
+
|
|
50821
|
+
|
|
50822
|
+
|
|
50823
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50824
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50825
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50826
|
+
|
|
50827
|
+
return {
|
|
50828
|
+
url: toPathString(localVarUrlObj),
|
|
50829
|
+
options: localVarRequestOptions,
|
|
50830
|
+
};
|
|
50831
|
+
},
|
|
50832
|
+
/**
|
|
50833
|
+
* 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.
|
|
50834
|
+
* @summary Read a store\'s gift card settings
|
|
50835
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50836
|
+
* @param {*} [options] Override http request option.
|
|
50837
|
+
* @throws {RequiredError}
|
|
50838
|
+
*/
|
|
50839
|
+
getVenueGiftCardSettings: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50840
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50841
|
+
assertParamExists('getVenueGiftCardSettings', 'businessId', businessId)
|
|
50842
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-card-settings`
|
|
50843
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
50844
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50845
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50846
|
+
let baseOptions;
|
|
50847
|
+
if (configuration) {
|
|
50848
|
+
baseOptions = configuration.baseOptions;
|
|
50849
|
+
}
|
|
50850
|
+
|
|
50851
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
50852
|
+
const localVarHeaderParameter = {} as any;
|
|
50853
|
+
const localVarQueryParameter = {} as any;
|
|
50854
|
+
|
|
50855
|
+
// authentication JWT-auth required
|
|
50856
|
+
// http bearer authentication required
|
|
50857
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50858
|
+
|
|
50859
|
+
|
|
50860
|
+
|
|
50861
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50862
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50863
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50864
|
+
|
|
50865
|
+
return {
|
|
50866
|
+
url: toPathString(localVarUrlObj),
|
|
50867
|
+
options: localVarRequestOptions,
|
|
50868
|
+
};
|
|
50869
|
+
},
|
|
50870
|
+
/**
|
|
50871
|
+
* 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.
|
|
50872
|
+
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
50873
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50874
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
50875
|
+
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
50876
|
+
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
50877
|
+
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
50878
|
+
* @param {*} [options] Override http request option.
|
|
50879
|
+
* @throws {RequiredError}
|
|
50880
|
+
*/
|
|
50881
|
+
listVenueGiftCards: async (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50882
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50883
|
+
assertParamExists('listVenueGiftCards', 'businessId', businessId)
|
|
50884
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards`
|
|
50885
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
50886
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50887
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50888
|
+
let baseOptions;
|
|
50889
|
+
if (configuration) {
|
|
50890
|
+
baseOptions = configuration.baseOptions;
|
|
50891
|
+
}
|
|
50892
|
+
|
|
50893
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
50894
|
+
const localVarHeaderParameter = {} as any;
|
|
50895
|
+
const localVarQueryParameter = {} as any;
|
|
50896
|
+
|
|
50897
|
+
// authentication JWT-auth required
|
|
50898
|
+
// http bearer authentication required
|
|
50899
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50900
|
+
|
|
50901
|
+
if (search !== undefined) {
|
|
50902
|
+
localVarQueryParameter['search'] = search;
|
|
50903
|
+
}
|
|
50904
|
+
|
|
50905
|
+
if (state !== undefined) {
|
|
50906
|
+
localVarQueryParameter['state'] = state;
|
|
50907
|
+
}
|
|
50908
|
+
|
|
50909
|
+
if (cursor !== undefined) {
|
|
50910
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
50911
|
+
}
|
|
50912
|
+
|
|
50913
|
+
if (limit !== undefined) {
|
|
50914
|
+
localVarQueryParameter['limit'] = limit;
|
|
50915
|
+
}
|
|
50916
|
+
|
|
50917
|
+
|
|
50918
|
+
|
|
50919
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50920
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50921
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50922
|
+
|
|
50923
|
+
return {
|
|
50924
|
+
url: toPathString(localVarUrlObj),
|
|
50925
|
+
options: localVarRequestOptions,
|
|
50926
|
+
};
|
|
50927
|
+
},
|
|
50928
|
+
/**
|
|
50929
|
+
* 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.
|
|
50930
|
+
* @summary Unblock a gift card
|
|
50931
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50932
|
+
* @param {string} cardId The card\'s id
|
|
50933
|
+
* @param {*} [options] Override http request option.
|
|
50934
|
+
* @throws {RequiredError}
|
|
50935
|
+
*/
|
|
50936
|
+
unblockVenueGiftCard: async (businessId: number, cardId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50937
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50938
|
+
assertParamExists('unblockVenueGiftCard', 'businessId', businessId)
|
|
50939
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
50940
|
+
assertParamExists('unblockVenueGiftCard', 'cardId', cardId)
|
|
50941
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}/unblock`
|
|
50942
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
50943
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
50944
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50945
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50946
|
+
let baseOptions;
|
|
50947
|
+
if (configuration) {
|
|
50948
|
+
baseOptions = configuration.baseOptions;
|
|
50949
|
+
}
|
|
50950
|
+
|
|
50951
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
50952
|
+
const localVarHeaderParameter = {} as any;
|
|
50953
|
+
const localVarQueryParameter = {} as any;
|
|
50954
|
+
|
|
50955
|
+
// authentication JWT-auth required
|
|
50956
|
+
// http bearer authentication required
|
|
50957
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50958
|
+
|
|
50959
|
+
|
|
50960
|
+
|
|
50961
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50962
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50963
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
50964
|
+
|
|
50965
|
+
return {
|
|
50966
|
+
url: toPathString(localVarUrlObj),
|
|
50967
|
+
options: localVarRequestOptions,
|
|
50968
|
+
};
|
|
50969
|
+
},
|
|
50970
|
+
/**
|
|
50971
|
+
* 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.
|
|
50972
|
+
* @summary Change a store\'s gift card settings
|
|
50973
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
50974
|
+
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
50975
|
+
* @param {*} [options] Override http request option.
|
|
50976
|
+
* @throws {RequiredError}
|
|
50977
|
+
*/
|
|
50978
|
+
updateVenueGiftCardSettings: async (businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50979
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
50980
|
+
assertParamExists('updateVenueGiftCardSettings', 'businessId', businessId)
|
|
50981
|
+
// verify required parameter 'updateGiftCardSettingsDto' is not null or undefined
|
|
50982
|
+
assertParamExists('updateVenueGiftCardSettings', 'updateGiftCardSettingsDto', updateGiftCardSettingsDto)
|
|
50983
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-card-settings`
|
|
50984
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
50985
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
50986
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
50987
|
+
let baseOptions;
|
|
50988
|
+
if (configuration) {
|
|
50989
|
+
baseOptions = configuration.baseOptions;
|
|
50990
|
+
}
|
|
50991
|
+
|
|
50992
|
+
const localVarRequestOptions = { method: 'PUT', ...baseOptions, ...options};
|
|
50993
|
+
const localVarHeaderParameter = {} as any;
|
|
50994
|
+
const localVarQueryParameter = {} as any;
|
|
50995
|
+
|
|
50996
|
+
// authentication JWT-auth required
|
|
50997
|
+
// http bearer authentication required
|
|
50998
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
50999
|
+
|
|
51000
|
+
|
|
51001
|
+
|
|
51002
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
51003
|
+
|
|
51004
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51005
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51006
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51007
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateGiftCardSettingsDto, localVarRequestOptions, configuration)
|
|
51008
|
+
|
|
51009
|
+
return {
|
|
51010
|
+
url: toPathString(localVarUrlObj),
|
|
51011
|
+
options: localVarRequestOptions,
|
|
51012
|
+
};
|
|
51013
|
+
},
|
|
51014
|
+
}
|
|
51015
|
+
};
|
|
51016
|
+
|
|
51017
|
+
/**
|
|
51018
|
+
* GiftCardsApi - functional programming interface
|
|
51019
|
+
* @export
|
|
51020
|
+
*/
|
|
51021
|
+
export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
51022
|
+
const localVarAxiosParamCreator = GiftCardsApiAxiosParamCreator(configuration)
|
|
51023
|
+
return {
|
|
51024
|
+
/**
|
|
51025
|
+
* 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.
|
|
51026
|
+
* @summary Switch on a gift card whose till order is not paid yet
|
|
51027
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51028
|
+
* @param {string} cardId The card\'s id
|
|
51029
|
+
* @param {*} [options] Override http request option.
|
|
51030
|
+
* @throws {RequiredError}
|
|
51031
|
+
*/
|
|
51032
|
+
async activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51033
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.activateVenueGiftCard(businessId, cardId, options);
|
|
51034
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51035
|
+
},
|
|
51036
|
+
/**
|
|
51037
|
+
* 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.
|
|
51038
|
+
* @summary Block a gift card
|
|
51039
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51040
|
+
* @param {string} cardId The card\'s id
|
|
51041
|
+
* @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
|
|
51042
|
+
* @param {*} [options] Override http request option.
|
|
51043
|
+
* @throws {RequiredError}
|
|
51044
|
+
*/
|
|
51045
|
+
async blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51046
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.blockVenueGiftCard(businessId, cardId, blockVenueGiftCardDto, options);
|
|
51047
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51048
|
+
},
|
|
51049
|
+
/**
|
|
51050
|
+
* 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.
|
|
51051
|
+
* @summary Make a gift card by hand, given for free
|
|
51052
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51053
|
+
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51054
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt when it sends one (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51055
|
+
* @param {*} [options] Override http request option.
|
|
51056
|
+
* @throws {RequiredError}
|
|
51057
|
+
*/
|
|
51058
|
+
async createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51059
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options);
|
|
51060
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51061
|
+
},
|
|
51062
|
+
/**
|
|
51063
|
+
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51064
|
+
* @summary Read one of a store\'s gift cards with its history
|
|
51065
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51066
|
+
* @param {string} cardId The card\'s id
|
|
51067
|
+
* @param {*} [options] Override http request option.
|
|
51068
|
+
* @throws {RequiredError}
|
|
51069
|
+
*/
|
|
51070
|
+
async getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51071
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCard(businessId, cardId, options);
|
|
51072
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51073
|
+
},
|
|
51074
|
+
/**
|
|
51075
|
+
* 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.
|
|
51076
|
+
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51077
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51078
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51079
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51080
|
+
* @param {*} [options] Override http request option.
|
|
51081
|
+
* @throws {RequiredError}
|
|
51082
|
+
*/
|
|
51083
|
+
async getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardReportDto>> {
|
|
51084
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardReport(businessId, from, to, options);
|
|
51085
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51086
|
+
},
|
|
51087
|
+
/**
|
|
51088
|
+
* 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.
|
|
51089
|
+
* @summary Read a store\'s gift card settings
|
|
51090
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51091
|
+
* @param {*} [options] Override http request option.
|
|
51092
|
+
* @throws {RequiredError}
|
|
51093
|
+
*/
|
|
51094
|
+
async getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSettingsDto>> {
|
|
51095
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardSettings(businessId, options);
|
|
51096
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51097
|
+
},
|
|
51098
|
+
/**
|
|
51099
|
+
* 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.
|
|
51100
|
+
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
51101
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51102
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
51103
|
+
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51104
|
+
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51105
|
+
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51106
|
+
* @param {*} [options] Override http request option.
|
|
51107
|
+
* @throws {RequiredError}
|
|
51108
|
+
*/
|
|
51109
|
+
async listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>> {
|
|
51110
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueGiftCards(businessId, search, state, cursor, limit, options);
|
|
51111
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51112
|
+
},
|
|
51113
|
+
/**
|
|
51114
|
+
* 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.
|
|
51115
|
+
* @summary Unblock a gift card
|
|
51116
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51117
|
+
* @param {string} cardId The card\'s id
|
|
51118
|
+
* @param {*} [options] Override http request option.
|
|
51119
|
+
* @throws {RequiredError}
|
|
51120
|
+
*/
|
|
51121
|
+
async unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51122
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unblockVenueGiftCard(businessId, cardId, options);
|
|
51123
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51124
|
+
},
|
|
51125
|
+
/**
|
|
51126
|
+
* 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.
|
|
51127
|
+
* @summary Change a store\'s gift card settings
|
|
51128
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51129
|
+
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
51130
|
+
* @param {*} [options] Override http request option.
|
|
51131
|
+
* @throws {RequiredError}
|
|
51132
|
+
*/
|
|
51133
|
+
async updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardSettingsDto>> {
|
|
51134
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVenueGiftCardSettings(businessId, updateGiftCardSettingsDto, options);
|
|
51135
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51136
|
+
},
|
|
51137
|
+
}
|
|
51138
|
+
};
|
|
51139
|
+
|
|
51140
|
+
/**
|
|
51141
|
+
* GiftCardsApi - factory interface
|
|
51142
|
+
* @export
|
|
51143
|
+
*/
|
|
51144
|
+
export const GiftCardsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
51145
|
+
const localVarFp = GiftCardsApiFp(configuration)
|
|
51146
|
+
return {
|
|
51147
|
+
/**
|
|
51148
|
+
* 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.
|
|
51149
|
+
* @summary Switch on a gift card whose till order is not paid yet
|
|
51150
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51151
|
+
* @param {string} cardId The card\'s id
|
|
51152
|
+
* @param {*} [options] Override http request option.
|
|
51153
|
+
* @throws {RequiredError}
|
|
51154
|
+
*/
|
|
51155
|
+
activateVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51156
|
+
return localVarFp.activateVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51157
|
+
},
|
|
51158
|
+
/**
|
|
51159
|
+
* 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.
|
|
51160
|
+
* @summary Block a gift card
|
|
51161
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51162
|
+
* @param {string} cardId The card\'s id
|
|
51163
|
+
* @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
|
|
51164
|
+
* @param {*} [options] Override http request option.
|
|
51165
|
+
* @throws {RequiredError}
|
|
51166
|
+
*/
|
|
51167
|
+
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51168
|
+
return localVarFp.blockVenueGiftCard(businessId, cardId, blockVenueGiftCardDto, options).then((request) => request(axios, basePath));
|
|
51169
|
+
},
|
|
51170
|
+
/**
|
|
51171
|
+
* 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.
|
|
51172
|
+
* @summary Make a gift card by hand, given for free
|
|
51173
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51174
|
+
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51175
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt when it sends one (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51176
|
+
* @param {*} [options] Override http request option.
|
|
51177
|
+
* @throws {RequiredError}
|
|
51178
|
+
*/
|
|
51179
|
+
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51180
|
+
return localVarFp.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
51181
|
+
},
|
|
51182
|
+
/**
|
|
51183
|
+
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51184
|
+
* @summary Read one of a store\'s gift cards with its history
|
|
51185
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51186
|
+
* @param {string} cardId The card\'s id
|
|
51187
|
+
* @param {*} [options] Override http request option.
|
|
51188
|
+
* @throws {RequiredError}
|
|
51189
|
+
*/
|
|
51190
|
+
getVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51191
|
+
return localVarFp.getVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51192
|
+
},
|
|
51193
|
+
/**
|
|
51194
|
+
* 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.
|
|
51195
|
+
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51196
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51197
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51198
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51199
|
+
* @param {*} [options] Override http request option.
|
|
51200
|
+
* @throws {RequiredError}
|
|
51201
|
+
*/
|
|
51202
|
+
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: any): AxiosPromise<GiftCardReportDto> {
|
|
51203
|
+
return localVarFp.getVenueGiftCardReport(businessId, from, to, options).then((request) => request(axios, basePath));
|
|
51204
|
+
},
|
|
51205
|
+
/**
|
|
51206
|
+
* 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.
|
|
51207
|
+
* @summary Read a store\'s gift card settings
|
|
51208
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51209
|
+
* @param {*} [options] Override http request option.
|
|
51210
|
+
* @throws {RequiredError}
|
|
51211
|
+
*/
|
|
51212
|
+
getVenueGiftCardSettings(businessId: number, options?: any): AxiosPromise<GiftCardSettingsDto> {
|
|
51213
|
+
return localVarFp.getVenueGiftCardSettings(businessId, options).then((request) => request(axios, basePath));
|
|
51214
|
+
},
|
|
51215
|
+
/**
|
|
51216
|
+
* 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.
|
|
51217
|
+
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
51218
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51219
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
51220
|
+
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51221
|
+
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51222
|
+
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51223
|
+
* @param {*} [options] Override http request option.
|
|
51224
|
+
* @throws {RequiredError}
|
|
51225
|
+
*/
|
|
51226
|
+
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: any): AxiosPromise<VenueGiftCardsDto> {
|
|
51227
|
+
return localVarFp.listVenueGiftCards(businessId, search, state, cursor, limit, options).then((request) => request(axios, basePath));
|
|
51228
|
+
},
|
|
51229
|
+
/**
|
|
51230
|
+
* 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.
|
|
51231
|
+
* @summary Unblock a gift card
|
|
51232
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51233
|
+
* @param {string} cardId The card\'s id
|
|
51234
|
+
* @param {*} [options] Override http request option.
|
|
51235
|
+
* @throws {RequiredError}
|
|
51236
|
+
*/
|
|
51237
|
+
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51238
|
+
return localVarFp.unblockVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51239
|
+
},
|
|
51240
|
+
/**
|
|
51241
|
+
* 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.
|
|
51242
|
+
* @summary Change a store\'s gift card settings
|
|
51243
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51244
|
+
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
51245
|
+
* @param {*} [options] Override http request option.
|
|
51246
|
+
* @throws {RequiredError}
|
|
51247
|
+
*/
|
|
51248
|
+
updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: any): AxiosPromise<GiftCardSettingsDto> {
|
|
51249
|
+
return localVarFp.updateVenueGiftCardSettings(businessId, updateGiftCardSettingsDto, options).then((request) => request(axios, basePath));
|
|
51250
|
+
},
|
|
51251
|
+
};
|
|
51252
|
+
};
|
|
51253
|
+
|
|
51254
|
+
/**
|
|
51255
|
+
* GiftCardsApi - interface
|
|
51256
|
+
* @export
|
|
51257
|
+
* @interface GiftCardsApi
|
|
51258
|
+
*/
|
|
51259
|
+
export interface GiftCardsApiInterface {
|
|
51260
|
+
/**
|
|
51261
|
+
* 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.
|
|
51262
|
+
* @summary Switch on a gift card whose till order is not paid yet
|
|
51263
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51264
|
+
* @param {string} cardId The card\'s id
|
|
51265
|
+
* @param {*} [options] Override http request option.
|
|
51266
|
+
* @throws {RequiredError}
|
|
51267
|
+
* @memberof GiftCardsApiInterface
|
|
51268
|
+
*/
|
|
51269
|
+
activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51270
|
+
|
|
51271
|
+
/**
|
|
51272
|
+
* 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.
|
|
51273
|
+
* @summary Block a gift card
|
|
51274
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51275
|
+
* @param {string} cardId The card\'s id
|
|
51276
|
+
* @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
|
|
51277
|
+
* @param {*} [options] Override http request option.
|
|
51278
|
+
* @throws {RequiredError}
|
|
51279
|
+
* @memberof GiftCardsApiInterface
|
|
51280
|
+
*/
|
|
51281
|
+
blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51282
|
+
|
|
51283
|
+
/**
|
|
51284
|
+
* 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.
|
|
51285
|
+
* @summary Make a gift card by hand, given for free
|
|
51286
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51287
|
+
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51288
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt when it sends one (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51289
|
+
* @param {*} [options] Override http request option.
|
|
51290
|
+
* @throws {RequiredError}
|
|
51291
|
+
* @memberof GiftCardsApiInterface
|
|
51292
|
+
*/
|
|
51293
|
+
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51294
|
+
|
|
51295
|
+
/**
|
|
51296
|
+
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51297
|
+
* @summary Read one of a store\'s gift cards with its history
|
|
51298
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51299
|
+
* @param {string} cardId The card\'s id
|
|
51300
|
+
* @param {*} [options] Override http request option.
|
|
51301
|
+
* @throws {RequiredError}
|
|
51302
|
+
* @memberof GiftCardsApiInterface
|
|
51303
|
+
*/
|
|
51304
|
+
getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51305
|
+
|
|
51306
|
+
/**
|
|
51307
|
+
* 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.
|
|
51308
|
+
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51309
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51310
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51311
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51312
|
+
* @param {*} [options] Override http request option.
|
|
51313
|
+
* @throws {RequiredError}
|
|
51314
|
+
* @memberof GiftCardsApiInterface
|
|
51315
|
+
*/
|
|
51316
|
+
getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<GiftCardReportDto>;
|
|
51317
|
+
|
|
51318
|
+
/**
|
|
51319
|
+
* 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.
|
|
51320
|
+
* @summary Read a store\'s gift card settings
|
|
51321
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51322
|
+
* @param {*} [options] Override http request option.
|
|
51323
|
+
* @throws {RequiredError}
|
|
51324
|
+
* @memberof GiftCardsApiInterface
|
|
51325
|
+
*/
|
|
51326
|
+
getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
|
|
51327
|
+
|
|
51328
|
+
/**
|
|
51329
|
+
* 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.
|
|
51330
|
+
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
51331
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51332
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
51333
|
+
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51334
|
+
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51335
|
+
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51336
|
+
* @param {*} [options] Override http request option.
|
|
51337
|
+
* @throws {RequiredError}
|
|
51338
|
+
* @memberof GiftCardsApiInterface
|
|
51339
|
+
*/
|
|
51340
|
+
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
51341
|
+
|
|
51342
|
+
/**
|
|
51343
|
+
* 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.
|
|
51344
|
+
* @summary Unblock a gift card
|
|
51345
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51346
|
+
* @param {string} cardId The card\'s id
|
|
51347
|
+
* @param {*} [options] Override http request option.
|
|
51348
|
+
* @throws {RequiredError}
|
|
51349
|
+
* @memberof GiftCardsApiInterface
|
|
51350
|
+
*/
|
|
51351
|
+
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51352
|
+
|
|
51353
|
+
/**
|
|
51354
|
+
* 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.
|
|
51355
|
+
* @summary Change a store\'s gift card settings
|
|
51356
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51357
|
+
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
51358
|
+
* @param {*} [options] Override http request option.
|
|
51359
|
+
* @throws {RequiredError}
|
|
51360
|
+
* @memberof GiftCardsApiInterface
|
|
51361
|
+
*/
|
|
51362
|
+
updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
|
|
51363
|
+
|
|
51364
|
+
}
|
|
51365
|
+
|
|
51366
|
+
/**
|
|
51367
|
+
* GiftCardsApi - object-oriented interface
|
|
51368
|
+
* @export
|
|
51369
|
+
* @class GiftCardsApi
|
|
51370
|
+
* @extends {BaseAPI}
|
|
51371
|
+
*/
|
|
51372
|
+
export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
51373
|
+
/**
|
|
51374
|
+
* 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.
|
|
51375
|
+
* @summary Switch on a gift card whose till order is not paid yet
|
|
51376
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51377
|
+
* @param {string} cardId The card\'s id
|
|
51378
|
+
* @param {*} [options] Override http request option.
|
|
51379
|
+
* @throws {RequiredError}
|
|
51380
|
+
* @memberof GiftCardsApi
|
|
51381
|
+
*/
|
|
51382
|
+
public activateVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig) {
|
|
51383
|
+
return GiftCardsApiFp(this.configuration).activateVenueGiftCard(businessId, cardId, options).then((request) => request(this.axios, this.basePath));
|
|
51384
|
+
}
|
|
51385
|
+
|
|
51386
|
+
/**
|
|
51387
|
+
* 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.
|
|
51388
|
+
* @summary Block a gift card
|
|
51389
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51390
|
+
* @param {string} cardId The card\'s id
|
|
51391
|
+
* @param {BlockVenueGiftCardDto} blockVenueGiftCardDto
|
|
51392
|
+
* @param {*} [options] Override http request option.
|
|
51393
|
+
* @throws {RequiredError}
|
|
51394
|
+
* @memberof GiftCardsApi
|
|
51395
|
+
*/
|
|
51396
|
+
public blockVenueGiftCard(businessId: number, cardId: string, blockVenueGiftCardDto: BlockVenueGiftCardDto, options?: AxiosRequestConfig) {
|
|
51397
|
+
return GiftCardsApiFp(this.configuration).blockVenueGiftCard(businessId, cardId, blockVenueGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
51398
|
+
}
|
|
51399
|
+
|
|
51400
|
+
/**
|
|
51401
|
+
* 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.
|
|
51402
|
+
* @summary Make a gift card by hand, given for free
|
|
51403
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51404
|
+
* @param {CreateVenueGiftCardDto} createVenueGiftCardDto
|
|
51405
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt when it sends one (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51406
|
+
* @param {*} [options] Override http request option.
|
|
51407
|
+
* @throws {RequiredError}
|
|
51408
|
+
* @memberof GiftCardsApi
|
|
51409
|
+
*/
|
|
51410
|
+
public createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
51411
|
+
return GiftCardsApiFp(this.configuration).createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
51412
|
+
}
|
|
51413
|
+
|
|
51414
|
+
/**
|
|
51415
|
+
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51416
|
+
* @summary Read one of a store\'s gift cards with its history
|
|
51417
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51418
|
+
* @param {string} cardId The card\'s id
|
|
51419
|
+
* @param {*} [options] Override http request option.
|
|
51420
|
+
* @throws {RequiredError}
|
|
51421
|
+
* @memberof GiftCardsApi
|
|
51422
|
+
*/
|
|
51423
|
+
public getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig) {
|
|
51424
|
+
return GiftCardsApiFp(this.configuration).getVenueGiftCard(businessId, cardId, options).then((request) => request(this.axios, this.basePath));
|
|
51425
|
+
}
|
|
51426
|
+
|
|
51427
|
+
/**
|
|
51428
|
+
* 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.
|
|
51429
|
+
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51430
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51431
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51432
|
+
* @param {string} to The last day, YYYY-MM-DD, included, in the store\'s time zone; not before from, and at most 366 days from it
|
|
51433
|
+
* @param {*} [options] Override http request option.
|
|
51434
|
+
* @throws {RequiredError}
|
|
51435
|
+
* @memberof GiftCardsApi
|
|
51436
|
+
*/
|
|
51437
|
+
public getVenueGiftCardReport(businessId: number, from: string, to: string, options?: AxiosRequestConfig) {
|
|
51438
|
+
return GiftCardsApiFp(this.configuration).getVenueGiftCardReport(businessId, from, to, options).then((request) => request(this.axios, this.basePath));
|
|
51439
|
+
}
|
|
51440
|
+
|
|
51441
|
+
/**
|
|
51442
|
+
* 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.
|
|
51443
|
+
* @summary Read a store\'s gift card settings
|
|
51444
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51445
|
+
* @param {*} [options] Override http request option.
|
|
51446
|
+
* @throws {RequiredError}
|
|
51447
|
+
* @memberof GiftCardsApi
|
|
51448
|
+
*/
|
|
51449
|
+
public getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig) {
|
|
51450
|
+
return GiftCardsApiFp(this.configuration).getVenueGiftCardSettings(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
51451
|
+
}
|
|
51452
|
+
|
|
51453
|
+
/**
|
|
51454
|
+
* 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.
|
|
51455
|
+
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
51456
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51457
|
+
* @param {string} [search] A code that starts with this, or a buyer\'s name or email that contains it, case-insensitive. Absent: every card.
|
|
51458
|
+
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51459
|
+
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51460
|
+
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51461
|
+
* @param {*} [options] Override http request option.
|
|
51462
|
+
* @throws {RequiredError}
|
|
51463
|
+
* @memberof GiftCardsApi
|
|
51464
|
+
*/
|
|
51465
|
+
public listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig) {
|
|
51466
|
+
return GiftCardsApiFp(this.configuration).listVenueGiftCards(businessId, search, state, cursor, limit, options).then((request) => request(this.axios, this.basePath));
|
|
51467
|
+
}
|
|
51468
|
+
|
|
51469
|
+
/**
|
|
51470
|
+
* 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.
|
|
51471
|
+
* @summary Unblock a gift card
|
|
51472
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51473
|
+
* @param {string} cardId The card\'s id
|
|
51474
|
+
* @param {*} [options] Override http request option.
|
|
51475
|
+
* @throws {RequiredError}
|
|
51476
|
+
* @memberof GiftCardsApi
|
|
51477
|
+
*/
|
|
51478
|
+
public unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig) {
|
|
51479
|
+
return GiftCardsApiFp(this.configuration).unblockVenueGiftCard(businessId, cardId, options).then((request) => request(this.axios, this.basePath));
|
|
51480
|
+
}
|
|
51481
|
+
|
|
51482
|
+
/**
|
|
51483
|
+
* 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.
|
|
51484
|
+
* @summary Change a store\'s gift card settings
|
|
51485
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51486
|
+
* @param {UpdateGiftCardSettingsDto} updateGiftCardSettingsDto
|
|
51487
|
+
* @param {*} [options] Override http request option.
|
|
51488
|
+
* @throws {RequiredError}
|
|
51489
|
+
* @memberof GiftCardsApi
|
|
51490
|
+
*/
|
|
51491
|
+
public updateVenueGiftCardSettings(businessId: number, updateGiftCardSettingsDto: UpdateGiftCardSettingsDto, options?: AxiosRequestConfig) {
|
|
51492
|
+
return GiftCardsApiFp(this.configuration).updateVenueGiftCardSettings(businessId, updateGiftCardSettingsDto, options).then((request) => request(this.axios, this.basePath));
|
|
51493
|
+
}
|
|
51494
|
+
}
|
|
51495
|
+
|
|
51496
|
+
|
|
49698
51497
|
/**
|
|
49699
51498
|
* GiftcardApi - axios parameter creator
|
|
49700
51499
|
* @export
|
|
@@ -54497,13 +56296,14 @@ export class MenuApi extends BaseAPI implements MenuApiInterface {
|
|
|
54497
56296
|
export const MunchiGiftCardApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
54498
56297
|
return {
|
|
54499
56298
|
/**
|
|
54500
|
-
* 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.
|
|
56299
|
+
* 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.
|
|
54501
56300
|
* @summary Create a first-party Munchi gift card
|
|
54502
56301
|
* @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
|
|
56302
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\'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.
|
|
54503
56303
|
* @param {*} [options] Override http request option.
|
|
54504
56304
|
* @throws {RequiredError}
|
|
54505
56305
|
*/
|
|
54506
|
-
createMunchiGiftCard: async (createMunchiGiftCardDto: CreateMunchiGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56306
|
+
createMunchiGiftCard: async (createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54507
56307
|
// verify required parameter 'createMunchiGiftCardDto' is not null or undefined
|
|
54508
56308
|
assertParamExists('createMunchiGiftCard', 'createMunchiGiftCardDto', createMunchiGiftCardDto)
|
|
54509
56309
|
const localVarPath = `/api/v1/munchi-giftcard/create`;
|
|
@@ -54522,6 +56322,10 @@ export const MunchiGiftCardApiAxiosParamCreator = function (configuration?: Conf
|
|
|
54522
56322
|
// http bearer authentication required
|
|
54523
56323
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
54524
56324
|
|
|
56325
|
+
if (xIdempotencyKey != null) {
|
|
56326
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
56327
|
+
}
|
|
56328
|
+
|
|
54525
56329
|
|
|
54526
56330
|
|
|
54527
56331
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
@@ -54577,13 +56381,54 @@ export const MunchiGiftCardApiAxiosParamCreator = function (configuration?: Conf
|
|
|
54577
56381
|
};
|
|
54578
56382
|
},
|
|
54579
56383
|
/**
|
|
54580
|
-
* The till calls it
|
|
56384
|
+
* 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.
|
|
56385
|
+
* @summary Give back a Munchi gift card redemption the till order did not keep
|
|
56386
|
+
* @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
|
|
56387
|
+
* @param {*} [options] Override http request option.
|
|
56388
|
+
* @throws {RequiredError}
|
|
56389
|
+
*/
|
|
56390
|
+
giveBackMunchiGiftCardRedemption: async (giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56391
|
+
// verify required parameter 'giveBackMunchiGiftCardDto' is not null or undefined
|
|
56392
|
+
assertParamExists('giveBackMunchiGiftCardRedemption', 'giveBackMunchiGiftCardDto', giveBackMunchiGiftCardDto)
|
|
56393
|
+
const localVarPath = `/api/v1/munchi-giftcard/give-back`;
|
|
56394
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
56395
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
56396
|
+
let baseOptions;
|
|
56397
|
+
if (configuration) {
|
|
56398
|
+
baseOptions = configuration.baseOptions;
|
|
56399
|
+
}
|
|
56400
|
+
|
|
56401
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
56402
|
+
const localVarHeaderParameter = {} as any;
|
|
56403
|
+
const localVarQueryParameter = {} as any;
|
|
56404
|
+
|
|
56405
|
+
// authentication JWT-auth required
|
|
56406
|
+
// http bearer authentication required
|
|
56407
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
56408
|
+
|
|
56409
|
+
|
|
56410
|
+
|
|
56411
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
56412
|
+
|
|
56413
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
56414
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
56415
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
56416
|
+
localVarRequestOptions.data = serializeDataIfNeeded(giveBackMunchiGiftCardDto, localVarRequestOptions, configuration)
|
|
56417
|
+
|
|
56418
|
+
return {
|
|
56419
|
+
url: toPathString(localVarUrlObj),
|
|
56420
|
+
options: localVarRequestOptions,
|
|
56421
|
+
};
|
|
56422
|
+
},
|
|
56423
|
+
/**
|
|
56424
|
+
* 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.
|
|
54581
56425
|
* @summary Redeem a first-party Munchi gift card
|
|
54582
56426
|
* @param {RedeemGiftCardDto} redeemGiftCardDto
|
|
56427
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \'-\' or \'_\'. 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.
|
|
54583
56428
|
* @param {*} [options] Override http request option.
|
|
54584
56429
|
* @throws {RequiredError}
|
|
54585
56430
|
*/
|
|
54586
|
-
redeemMunchiGiftCard: async (redeemGiftCardDto: RedeemGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
56431
|
+
redeemMunchiGiftCard: async (redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54587
56432
|
// verify required parameter 'redeemGiftCardDto' is not null or undefined
|
|
54588
56433
|
assertParamExists('redeemMunchiGiftCard', 'redeemGiftCardDto', redeemGiftCardDto)
|
|
54589
56434
|
const localVarPath = `/api/v1/munchi-giftcard/redeem`;
|
|
@@ -54602,6 +56447,10 @@ export const MunchiGiftCardApiAxiosParamCreator = function (configuration?: Conf
|
|
|
54602
56447
|
// http bearer authentication required
|
|
54603
56448
|
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
54604
56449
|
|
|
56450
|
+
if (xIdempotencyKey != null) {
|
|
56451
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
56452
|
+
}
|
|
56453
|
+
|
|
54605
56454
|
|
|
54606
56455
|
|
|
54607
56456
|
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
@@ -54667,14 +56516,15 @@ export const MunchiGiftCardApiFp = function(configuration?: Configuration) {
|
|
|
54667
56516
|
const localVarAxiosParamCreator = MunchiGiftCardApiAxiosParamCreator(configuration)
|
|
54668
56517
|
return {
|
|
54669
56518
|
/**
|
|
54670
|
-
* 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.
|
|
56519
|
+
* 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.
|
|
54671
56520
|
* @summary Create a first-party Munchi gift card
|
|
54672
56521
|
* @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
|
|
56522
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\'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.
|
|
54673
56523
|
* @param {*} [options] Override http request option.
|
|
54674
56524
|
* @throws {RequiredError}
|
|
54675
56525
|
*/
|
|
54676
|
-
async createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMunchiGiftCardResponseDto>> {
|
|
54677
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.createMunchiGiftCard(createMunchiGiftCardDto, options);
|
|
56526
|
+
async createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateMunchiGiftCardResponseDto>> {
|
|
56527
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.createMunchiGiftCard(createMunchiGiftCardDto, xIdempotencyKey, options);
|
|
54678
56528
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54679
56529
|
},
|
|
54680
56530
|
/**
|
|
@@ -54689,14 +56539,26 @@ export const MunchiGiftCardApiFp = function(configuration?: Configuration) {
|
|
|
54689
56539
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54690
56540
|
},
|
|
54691
56541
|
/**
|
|
54692
|
-
* The till calls it
|
|
56542
|
+
* 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.
|
|
56543
|
+
* @summary Give back a Munchi gift card redemption the till order did not keep
|
|
56544
|
+
* @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
|
|
56545
|
+
* @param {*} [options] Override http request option.
|
|
56546
|
+
* @throws {RequiredError}
|
|
56547
|
+
*/
|
|
56548
|
+
async giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiveBackMunchiGiftCardResponseDto>> {
|
|
56549
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto, options);
|
|
56550
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
56551
|
+
},
|
|
56552
|
+
/**
|
|
56553
|
+
* 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.
|
|
54693
56554
|
* @summary Redeem a first-party Munchi gift card
|
|
54694
56555
|
* @param {RedeemGiftCardDto} redeemGiftCardDto
|
|
56556
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \'-\' or \'_\'. 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.
|
|
54695
56557
|
* @param {*} [options] Override http request option.
|
|
54696
56558
|
* @throws {RequiredError}
|
|
54697
56559
|
*/
|
|
54698
|
-
async redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedeemGiftCardResponseDto>> {
|
|
54699
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.redeemMunchiGiftCard(redeemGiftCardDto, options);
|
|
56560
|
+
async redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<RedeemGiftCardResponseDto>> {
|
|
56561
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.redeemMunchiGiftCard(redeemGiftCardDto, xIdempotencyKey, options);
|
|
54700
56562
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54701
56563
|
},
|
|
54702
56564
|
/**
|
|
@@ -54721,14 +56583,15 @@ export const MunchiGiftCardApiFactory = function (configuration?: Configuration,
|
|
|
54721
56583
|
const localVarFp = MunchiGiftCardApiFp(configuration)
|
|
54722
56584
|
return {
|
|
54723
56585
|
/**
|
|
54724
|
-
* 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.
|
|
56586
|
+
* 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.
|
|
54725
56587
|
* @summary Create a first-party Munchi gift card
|
|
54726
56588
|
* @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
|
|
56589
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\'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.
|
|
54727
56590
|
* @param {*} [options] Override http request option.
|
|
54728
56591
|
* @throws {RequiredError}
|
|
54729
56592
|
*/
|
|
54730
|
-
createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: any): AxiosPromise<CreateMunchiGiftCardResponseDto> {
|
|
54731
|
-
return localVarFp.createMunchiGiftCard(createMunchiGiftCardDto, options).then((request) => request(axios, basePath));
|
|
56593
|
+
createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<CreateMunchiGiftCardResponseDto> {
|
|
56594
|
+
return localVarFp.createMunchiGiftCard(createMunchiGiftCardDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
54732
56595
|
},
|
|
54733
56596
|
/**
|
|
54734
56597
|
* 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.
|
|
@@ -54741,14 +56604,25 @@ export const MunchiGiftCardApiFactory = function (configuration?: Configuration,
|
|
|
54741
56604
|
return localVarFp.getMunchiGiftCardData(getMunchiGiftCardDataDto, options).then((request) => request(axios, basePath));
|
|
54742
56605
|
},
|
|
54743
56606
|
/**
|
|
54744
|
-
* The till calls it
|
|
56607
|
+
* 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.
|
|
56608
|
+
* @summary Give back a Munchi gift card redemption the till order did not keep
|
|
56609
|
+
* @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
|
|
56610
|
+
* @param {*} [options] Override http request option.
|
|
56611
|
+
* @throws {RequiredError}
|
|
56612
|
+
*/
|
|
56613
|
+
giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: any): AxiosPromise<GiveBackMunchiGiftCardResponseDto> {
|
|
56614
|
+
return localVarFp.giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto, options).then((request) => request(axios, basePath));
|
|
56615
|
+
},
|
|
56616
|
+
/**
|
|
56617
|
+
* 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.
|
|
54745
56618
|
* @summary Redeem a first-party Munchi gift card
|
|
54746
56619
|
* @param {RedeemGiftCardDto} redeemGiftCardDto
|
|
56620
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \'-\' or \'_\'. 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.
|
|
54747
56621
|
* @param {*} [options] Override http request option.
|
|
54748
56622
|
* @throws {RequiredError}
|
|
54749
56623
|
*/
|
|
54750
|
-
redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: any): AxiosPromise<RedeemGiftCardResponseDto> {
|
|
54751
|
-
return localVarFp.redeemMunchiGiftCard(redeemGiftCardDto, options).then((request) => request(axios, basePath));
|
|
56624
|
+
redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<RedeemGiftCardResponseDto> {
|
|
56625
|
+
return localVarFp.redeemMunchiGiftCard(redeemGiftCardDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
54752
56626
|
},
|
|
54753
56627
|
/**
|
|
54754
56628
|
* 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.
|
|
@@ -54770,14 +56644,15 @@ export const MunchiGiftCardApiFactory = function (configuration?: Configuration,
|
|
|
54770
56644
|
*/
|
|
54771
56645
|
export interface MunchiGiftCardApiInterface {
|
|
54772
56646
|
/**
|
|
54773
|
-
* 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.
|
|
56647
|
+
* 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.
|
|
54774
56648
|
* @summary Create a first-party Munchi gift card
|
|
54775
56649
|
* @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
|
|
56650
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\'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.
|
|
54776
56651
|
* @param {*} [options] Override http request option.
|
|
54777
56652
|
* @throws {RequiredError}
|
|
54778
56653
|
* @memberof MunchiGiftCardApiInterface
|
|
54779
56654
|
*/
|
|
54780
|
-
createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<CreateMunchiGiftCardResponseDto>;
|
|
56655
|
+
createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<CreateMunchiGiftCardResponseDto>;
|
|
54781
56656
|
|
|
54782
56657
|
/**
|
|
54783
56658
|
* 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.
|
|
@@ -54790,14 +56665,25 @@ export interface MunchiGiftCardApiInterface {
|
|
|
54790
56665
|
getMunchiGiftCardData(getMunchiGiftCardDataDto: GetMunchiGiftCardDataDto, options?: AxiosRequestConfig): AxiosPromise<GetMunchiGiftCardDataResponseDto>;
|
|
54791
56666
|
|
|
54792
56667
|
/**
|
|
54793
|
-
* The till calls it
|
|
56668
|
+
* 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.
|
|
56669
|
+
* @summary Give back a Munchi gift card redemption the till order did not keep
|
|
56670
|
+
* @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
|
|
56671
|
+
* @param {*} [options] Override http request option.
|
|
56672
|
+
* @throws {RequiredError}
|
|
56673
|
+
* @memberof MunchiGiftCardApiInterface
|
|
56674
|
+
*/
|
|
56675
|
+
giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<GiveBackMunchiGiftCardResponseDto>;
|
|
56676
|
+
|
|
56677
|
+
/**
|
|
56678
|
+
* 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.
|
|
54794
56679
|
* @summary Redeem a first-party Munchi gift card
|
|
54795
56680
|
* @param {RedeemGiftCardDto} redeemGiftCardDto
|
|
56681
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \'-\' or \'_\'. 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.
|
|
54796
56682
|
* @param {*} [options] Override http request option.
|
|
54797
56683
|
* @throws {RequiredError}
|
|
54798
56684
|
* @memberof MunchiGiftCardApiInterface
|
|
54799
56685
|
*/
|
|
54800
|
-
redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<RedeemGiftCardResponseDto>;
|
|
56686
|
+
redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RedeemGiftCardResponseDto>;
|
|
54801
56687
|
|
|
54802
56688
|
/**
|
|
54803
56689
|
* 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.
|
|
@@ -54819,15 +56705,16 @@ export interface MunchiGiftCardApiInterface {
|
|
|
54819
56705
|
*/
|
|
54820
56706
|
export class MunchiGiftCardApi extends BaseAPI implements MunchiGiftCardApiInterface {
|
|
54821
56707
|
/**
|
|
54822
|
-
* 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.
|
|
56708
|
+
* 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.
|
|
54823
56709
|
* @summary Create a first-party Munchi gift card
|
|
54824
56710
|
* @param {CreateMunchiGiftCardDto} createMunchiGiftCardDto
|
|
56711
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card the till sells; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card that sale made and makes no other; the same key for another venue\'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.
|
|
54825
56712
|
* @param {*} [options] Override http request option.
|
|
54826
56713
|
* @throws {RequiredError}
|
|
54827
56714
|
* @memberof MunchiGiftCardApi
|
|
54828
56715
|
*/
|
|
54829
|
-
public createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, options?: AxiosRequestConfig) {
|
|
54830
|
-
return MunchiGiftCardApiFp(this.configuration).createMunchiGiftCard(createMunchiGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
56716
|
+
public createMunchiGiftCard(createMunchiGiftCardDto: CreateMunchiGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
56717
|
+
return MunchiGiftCardApiFp(this.configuration).createMunchiGiftCard(createMunchiGiftCardDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
54831
56718
|
}
|
|
54832
56719
|
|
|
54833
56720
|
/**
|
|
@@ -54843,15 +56730,28 @@ export class MunchiGiftCardApi extends BaseAPI implements MunchiGiftCardApiInter
|
|
|
54843
56730
|
}
|
|
54844
56731
|
|
|
54845
56732
|
/**
|
|
54846
|
-
* The till calls it
|
|
56733
|
+
* 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.
|
|
56734
|
+
* @summary Give back a Munchi gift card redemption the till order did not keep
|
|
56735
|
+
* @param {GiveBackMunchiGiftCardDto} giveBackMunchiGiftCardDto
|
|
56736
|
+
* @param {*} [options] Override http request option.
|
|
56737
|
+
* @throws {RequiredError}
|
|
56738
|
+
* @memberof MunchiGiftCardApi
|
|
56739
|
+
*/
|
|
56740
|
+
public giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto: GiveBackMunchiGiftCardDto, options?: AxiosRequestConfig) {
|
|
56741
|
+
return MunchiGiftCardApiFp(this.configuration).giveBackMunchiGiftCardRedemption(giveBackMunchiGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
56742
|
+
}
|
|
56743
|
+
|
|
56744
|
+
/**
|
|
56745
|
+
* 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.
|
|
54847
56746
|
* @summary Redeem a first-party Munchi gift card
|
|
54848
56747
|
* @param {RedeemGiftCardDto} redeemGiftCardDto
|
|
56748
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per gift card payment the till makes; 8 to 100 letters, digits, \'-\' or \'_\'. 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.
|
|
54849
56749
|
* @param {*} [options] Override http request option.
|
|
54850
56750
|
* @throws {RequiredError}
|
|
54851
56751
|
* @memberof MunchiGiftCardApi
|
|
54852
56752
|
*/
|
|
54853
|
-
public redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, options?: AxiosRequestConfig) {
|
|
54854
|
-
return MunchiGiftCardApiFp(this.configuration).redeemMunchiGiftCard(redeemGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
56753
|
+
public redeemMunchiGiftCard(redeemGiftCardDto: RedeemGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
56754
|
+
return MunchiGiftCardApiFp(this.configuration).redeemMunchiGiftCard(redeemGiftCardDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
54855
56755
|
}
|
|
54856
56756
|
|
|
54857
56757
|
/**
|
|
@@ -68803,13 +70703,13 @@ export const ReservationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
68803
70703
|
* @param {number} businessId The venue\'s business id; only its own bookings, policy and link are read or changed
|
|
68804
70704
|
* @param {string} date The day, YYYY-MM-DD, in the venue\'s own time zone
|
|
68805
70705
|
* @param {number} partySize How many guests the booking is for
|
|
70706
|
+
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
68806
70707
|
* @param {string} [sectionId] Only the tables of this floor section; every section when absent
|
|
68807
70708
|
* @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
|
|
68808
|
-
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
68809
70709
|
* @param {*} [options] Override http request option.
|
|
68810
70710
|
* @throws {RequiredError}
|
|
68811
70711
|
*/
|
|
68812
|
-
getReservationAvailability: async (businessId: number, date: string, partySize: number,
|
|
70712
|
+
getReservationAvailability: async (businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
68813
70713
|
// verify required parameter 'businessId' is not null or undefined
|
|
68814
70714
|
assertParamExists('getReservationAvailability', 'businessId', businessId)
|
|
68815
70715
|
// verify required parameter 'date' is not null or undefined
|
|
@@ -68844,6 +70744,10 @@ export const ReservationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
68844
70744
|
localVarQueryParameter['partySize'] = partySize;
|
|
68845
70745
|
}
|
|
68846
70746
|
|
|
70747
|
+
if (source !== undefined) {
|
|
70748
|
+
localVarQueryParameter['source'] = source;
|
|
70749
|
+
}
|
|
70750
|
+
|
|
68847
70751
|
if (sectionId !== undefined) {
|
|
68848
70752
|
localVarQueryParameter['sectionId'] = sectionId;
|
|
68849
70753
|
}
|
|
@@ -68852,10 +70756,6 @@ export const ReservationsApiAxiosParamCreator = function (configuration?: Config
|
|
|
68852
70756
|
localVarQueryParameter['excludeReservationId'] = excludeReservationId;
|
|
68853
70757
|
}
|
|
68854
70758
|
|
|
68855
|
-
if (source !== undefined) {
|
|
68856
|
-
localVarQueryParameter['source'] = source;
|
|
68857
|
-
}
|
|
68858
|
-
|
|
68859
70759
|
|
|
68860
70760
|
|
|
68861
70761
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -69249,14 +71149,14 @@ export const ReservationsApiFp = function(configuration?: Configuration) {
|
|
|
69249
71149
|
* @param {number} businessId The venue\'s business id; only its own bookings, policy and link are read or changed
|
|
69250
71150
|
* @param {string} date The day, YYYY-MM-DD, in the venue\'s own time zone
|
|
69251
71151
|
* @param {number} partySize How many guests the booking is for
|
|
71152
|
+
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69252
71153
|
* @param {string} [sectionId] Only the tables of this floor section; every section when absent
|
|
69253
71154
|
* @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
|
|
69254
|
-
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69255
71155
|
* @param {*} [options] Override http request option.
|
|
69256
71156
|
* @throws {RequiredError}
|
|
69257
71157
|
*/
|
|
69258
|
-
async getReservationAvailability(businessId: number, date: string, partySize: number,
|
|
69259
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.getReservationAvailability(businessId, date, partySize, sectionId, excludeReservationId,
|
|
71158
|
+
async getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReservationAvailabilityResponseDto>> {
|
|
71159
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getReservationAvailability(businessId, date, partySize, source, sectionId, excludeReservationId, options);
|
|
69260
71160
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
69261
71161
|
},
|
|
69262
71162
|
/**
|
|
@@ -69379,14 +71279,14 @@ export const ReservationsApiFactory = function (configuration?: Configuration, b
|
|
|
69379
71279
|
* @param {number} businessId The venue\'s business id; only its own bookings, policy and link are read or changed
|
|
69380
71280
|
* @param {string} date The day, YYYY-MM-DD, in the venue\'s own time zone
|
|
69381
71281
|
* @param {number} partySize How many guests the booking is for
|
|
71282
|
+
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69382
71283
|
* @param {string} [sectionId] Only the tables of this floor section; every section when absent
|
|
69383
71284
|
* @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
|
|
69384
|
-
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69385
71285
|
* @param {*} [options] Override http request option.
|
|
69386
71286
|
* @throws {RequiredError}
|
|
69387
71287
|
*/
|
|
69388
|
-
getReservationAvailability(businessId: number, date: string, partySize: number,
|
|
69389
|
-
return localVarFp.getReservationAvailability(businessId, date, partySize, sectionId, excludeReservationId,
|
|
71288
|
+
getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: any): AxiosPromise<ReservationAvailabilityResponseDto> {
|
|
71289
|
+
return localVarFp.getReservationAvailability(businessId, date, partySize, source, sectionId, excludeReservationId, options).then((request) => request(axios, basePath));
|
|
69390
71290
|
},
|
|
69391
71291
|
/**
|
|
69392
71292
|
* 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.
|
|
@@ -69499,14 +71399,14 @@ export interface ReservationsApiInterface {
|
|
|
69499
71399
|
* @param {number} businessId The venue\'s business id; only its own bookings, policy and link are read or changed
|
|
69500
71400
|
* @param {string} date The day, YYYY-MM-DD, in the venue\'s own time zone
|
|
69501
71401
|
* @param {number} partySize How many guests the booking is for
|
|
71402
|
+
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69502
71403
|
* @param {string} [sectionId] Only the tables of this floor section; every section when absent
|
|
69503
71404
|
* @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
|
|
69504
|
-
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69505
71405
|
* @param {*} [options] Override http request option.
|
|
69506
71406
|
* @throws {RequiredError}
|
|
69507
71407
|
* @memberof ReservationsApiInterface
|
|
69508
71408
|
*/
|
|
69509
|
-
getReservationAvailability(businessId: number, date: string, partySize: number,
|
|
71409
|
+
getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig): AxiosPromise<ReservationAvailabilityResponseDto>;
|
|
69510
71410
|
|
|
69511
71411
|
/**
|
|
69512
71412
|
* 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.
|
|
@@ -69621,15 +71521,15 @@ export class ReservationsApi extends BaseAPI implements ReservationsApiInterface
|
|
|
69621
71521
|
* @param {number} businessId The venue\'s business id; only its own bookings, policy and link are read or changed
|
|
69622
71522
|
* @param {string} date The day, YYYY-MM-DD, in the venue\'s own time zone
|
|
69623
71523
|
* @param {number} partySize How many guests the booking is for
|
|
71524
|
+
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69624
71525
|
* @param {string} [sectionId] Only the tables of this floor section; every section when absent
|
|
69625
71526
|
* @param {string} [excludeReservationId] A booking being edited: its own hold is left out, so its current slot shows as free
|
|
69626
|
-
* @param {ReservationSource} [source] How the booking is being made. WALK_IN, PHONE and POS are entered by staff, so they ignore the policy\'s minimum lead time; start times already past are still left out. Held to the lead time when absent
|
|
69627
71527
|
* @param {*} [options] Override http request option.
|
|
69628
71528
|
* @throws {RequiredError}
|
|
69629
71529
|
* @memberof ReservationsApi
|
|
69630
71530
|
*/
|
|
69631
|
-
public getReservationAvailability(businessId: number, date: string, partySize: number,
|
|
69632
|
-
return ReservationsApiFp(this.configuration).getReservationAvailability(businessId, date, partySize, sectionId, excludeReservationId,
|
|
71531
|
+
public getReservationAvailability(businessId: number, date: string, partySize: number, source?: ReservationSource, sectionId?: string, excludeReservationId?: string, options?: AxiosRequestConfig) {
|
|
71532
|
+
return ReservationsApiFp(this.configuration).getReservationAvailability(businessId, date, partySize, source, sectionId, excludeReservationId, options).then((request) => request(this.axios, this.basePath));
|
|
69633
71533
|
}
|
|
69634
71534
|
|
|
69635
71535
|
/**
|