@munchi_oy/core 2.12.0 → 2.14.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 +828 -38
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +1015 -43
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -5373,6 +5373,36 @@ export interface CreateVenueGiftCardDto {
|
|
|
5373
5373
|
* @memberof CreateVenueGiftCardDto
|
|
5374
5374
|
*/
|
|
5375
5375
|
'note'?: string;
|
|
5376
|
+
/**
|
|
5377
|
+
* The message shown in the card\'s email, 1 to 300 characters: the buyer\'s or the store\'s own words. Absent: none.
|
|
5378
|
+
* @type {string}
|
|
5379
|
+
* @memberof CreateVenueGiftCardDto
|
|
5380
|
+
*/
|
|
5381
|
+
'message'?: string;
|
|
5382
|
+
/**
|
|
5383
|
+
* Whether the card is emailed to buyerEmail at once. Absent: true. Without buyerEmail nothing is sent.
|
|
5384
|
+
* @type {boolean}
|
|
5385
|
+
* @memberof CreateVenueGiftCardDto
|
|
5386
|
+
*/
|
|
5387
|
+
'sendEmail'?: boolean;
|
|
5388
|
+
/**
|
|
5389
|
+
* The buyer\'s email, at most 254 characters once the spaces around it are dropped. Absent or only spaces: none. Answered as buyerEmail.
|
|
5390
|
+
* @type {string}
|
|
5391
|
+
* @memberof CreateVenueGiftCardDto
|
|
5392
|
+
*/
|
|
5393
|
+
'buyerEmail'?: string;
|
|
5394
|
+
/**
|
|
5395
|
+
* The country code of the buyer\'s phone, 1 to 8 characters once the spaces around it are dropped; sent with phoneNumber or not at all. Absent: none.
|
|
5396
|
+
* @type {string}
|
|
5397
|
+
* @memberof CreateVenueGiftCardDto
|
|
5398
|
+
*/
|
|
5399
|
+
'phoneCountryCode'?: string;
|
|
5400
|
+
/**
|
|
5401
|
+
* The buyer\'s phone number without its country code, 3 to 32 characters once the spaces around it are dropped; sent with phoneCountryCode or not at all. Absent: none.
|
|
5402
|
+
* @type {string}
|
|
5403
|
+
* @memberof CreateVenueGiftCardDto
|
|
5404
|
+
*/
|
|
5405
|
+
'phoneNumber'?: string;
|
|
5376
5406
|
/**
|
|
5377
5407
|
* 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
5408
|
* @type {string}
|
|
@@ -8791,6 +8821,63 @@ export interface GetStationResponseDtoStation {
|
|
|
8791
8821
|
}
|
|
8792
8822
|
|
|
8793
8823
|
|
|
8824
|
+
/**
|
|
8825
|
+
*
|
|
8826
|
+
* @export
|
|
8827
|
+
* @interface GiftCardAttentionDto
|
|
8828
|
+
*/
|
|
8829
|
+
export interface GiftCardAttentionDto {
|
|
8830
|
+
/**
|
|
8831
|
+
*
|
|
8832
|
+
* @type {GiftCardAttentionDtoExpiringSoon}
|
|
8833
|
+
* @memberof GiftCardAttentionDto
|
|
8834
|
+
*/
|
|
8835
|
+
'expiringSoon': GiftCardAttentionDtoExpiringSoon;
|
|
8836
|
+
/**
|
|
8837
|
+
*
|
|
8838
|
+
* @type {GiftCardAttentionDtoStalePending}
|
|
8839
|
+
* @memberof GiftCardAttentionDto
|
|
8840
|
+
*/
|
|
8841
|
+
'stalePending': GiftCardAttentionDtoStalePending;
|
|
8842
|
+
/**
|
|
8843
|
+
* The days ahead expiringSoon looks
|
|
8844
|
+
* @type {number}
|
|
8845
|
+
* @memberof GiftCardAttentionDto
|
|
8846
|
+
*/
|
|
8847
|
+
'expiringWithinDays': number;
|
|
8848
|
+
}
|
|
8849
|
+
/**
|
|
8850
|
+
* ACTIVE cards that expire within the next expiringWithinDays days: what is on them and how many
|
|
8851
|
+
* @export
|
|
8852
|
+
* @interface GiftCardAttentionDtoExpiringSoon
|
|
8853
|
+
*/
|
|
8854
|
+
export interface GiftCardAttentionDtoExpiringSoon {
|
|
8855
|
+
/**
|
|
8856
|
+
* The sum, in cents
|
|
8857
|
+
* @type {number}
|
|
8858
|
+
* @memberof GiftCardAttentionDtoExpiringSoon
|
|
8859
|
+
*/
|
|
8860
|
+
'amount': number;
|
|
8861
|
+
/**
|
|
8862
|
+
* How many cards
|
|
8863
|
+
* @type {number}
|
|
8864
|
+
* @memberof GiftCardAttentionDtoExpiringSoon
|
|
8865
|
+
*/
|
|
8866
|
+
'count': number;
|
|
8867
|
+
}
|
|
8868
|
+
/**
|
|
8869
|
+
* NOT_YET_VALID cards made more than 24 hours ago: their POS order may never have been paid
|
|
8870
|
+
* @export
|
|
8871
|
+
* @interface GiftCardAttentionDtoStalePending
|
|
8872
|
+
*/
|
|
8873
|
+
export interface GiftCardAttentionDtoStalePending {
|
|
8874
|
+
/**
|
|
8875
|
+
* How many cards
|
|
8876
|
+
* @type {number}
|
|
8877
|
+
* @memberof GiftCardAttentionDtoStalePending
|
|
8878
|
+
*/
|
|
8879
|
+
'count': number;
|
|
8880
|
+
}
|
|
8794
8881
|
/**
|
|
8795
8882
|
*
|
|
8796
8883
|
* @export
|
|
@@ -8799,7 +8886,9 @@ export interface GetStationResponseDtoStation {
|
|
|
8799
8886
|
|
|
8800
8887
|
export const GiftCardChannel = {
|
|
8801
8888
|
Till: 'TILL',
|
|
8802
|
-
OnlineStore: 'ONLINE_STORE'
|
|
8889
|
+
OnlineStore: 'ONLINE_STORE',
|
|
8890
|
+
Kiosk: 'KIOSK',
|
|
8891
|
+
MobileApp: 'MOBILE_APP'
|
|
8803
8892
|
} as const;
|
|
8804
8893
|
|
|
8805
8894
|
export type GiftCardChannel = typeof GiftCardChannel[keyof typeof GiftCardChannel];
|
|
@@ -8823,6 +8912,31 @@ export interface GiftCardChannelsDto {
|
|
|
8823
8912
|
* @memberof GiftCardChannelsDto
|
|
8824
8913
|
*/
|
|
8825
8914
|
'onlineStore': boolean;
|
|
8915
|
+
/**
|
|
8916
|
+
* Whether the store\'s kiosk takes gift cards. Always answered; absent in a change: unchanged, so a dashboard that sends only till and onlineStore keeps working.
|
|
8917
|
+
* @type {boolean}
|
|
8918
|
+
* @memberof GiftCardChannelsDto
|
|
8919
|
+
*/
|
|
8920
|
+
'kiosk'?: boolean;
|
|
8921
|
+
/**
|
|
8922
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
8923
|
+
* @type {boolean}
|
|
8924
|
+
* @memberof GiftCardChannelsDto
|
|
8925
|
+
*/
|
|
8926
|
+
'mobileApp'?: boolean;
|
|
8927
|
+
}
|
|
8928
|
+
/**
|
|
8929
|
+
*
|
|
8930
|
+
* @export
|
|
8931
|
+
* @interface GiftCardCountDto
|
|
8932
|
+
*/
|
|
8933
|
+
export interface GiftCardCountDto {
|
|
8934
|
+
/**
|
|
8935
|
+
* How many cards
|
|
8936
|
+
* @type {number}
|
|
8937
|
+
* @memberof GiftCardCountDto
|
|
8938
|
+
*/
|
|
8939
|
+
'count': number;
|
|
8826
8940
|
}
|
|
8827
8941
|
/**
|
|
8828
8942
|
*
|
|
@@ -8899,6 +9013,38 @@ export interface GiftCardCredentialsViewDto {
|
|
|
8899
9013
|
*/
|
|
8900
9014
|
'uniquePosDeviceId': string | null;
|
|
8901
9015
|
}
|
|
9016
|
+
/**
|
|
9017
|
+
*
|
|
9018
|
+
* @export
|
|
9019
|
+
* @enum {string}
|
|
9020
|
+
*/
|
|
9021
|
+
|
|
9022
|
+
export const GiftCardEmailKind = {
|
|
9023
|
+
Card: 'CARD',
|
|
9024
|
+
CardAgain: 'CARD_AGAIN',
|
|
9025
|
+
Expiry30: 'EXPIRY_30',
|
|
9026
|
+
Expiry7: 'EXPIRY_7'
|
|
9027
|
+
} as const;
|
|
9028
|
+
|
|
9029
|
+
export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
|
|
9030
|
+
|
|
9031
|
+
|
|
9032
|
+
/**
|
|
9033
|
+
*
|
|
9034
|
+
* @export
|
|
9035
|
+
* @enum {string}
|
|
9036
|
+
*/
|
|
9037
|
+
|
|
9038
|
+
export const GiftCardEmailStatus = {
|
|
9039
|
+
Pending: 'PENDING',
|
|
9040
|
+
Sent: 'SENT',
|
|
9041
|
+
Failed: 'FAILED',
|
|
9042
|
+
Skipped: 'SKIPPED'
|
|
9043
|
+
} as const;
|
|
9044
|
+
|
|
9045
|
+
export type GiftCardEmailStatus = typeof GiftCardEmailStatus[keyof typeof GiftCardEmailStatus];
|
|
9046
|
+
|
|
9047
|
+
|
|
8902
9048
|
/**
|
|
8903
9049
|
*
|
|
8904
9050
|
* @export
|
|
@@ -8983,6 +9129,18 @@ export interface GiftCardHistoryEventDto {
|
|
|
8983
9129
|
* @memberof GiftCardHistoryEventDto
|
|
8984
9130
|
*/
|
|
8985
9131
|
'orderId': string | null;
|
|
9132
|
+
/**
|
|
9133
|
+
* The address of an EMAILED, EMAIL_FAILED or EMAIL_CHANGED line; null for the others
|
|
9134
|
+
* @type {string}
|
|
9135
|
+
* @memberof GiftCardHistoryEventDto
|
|
9136
|
+
*/
|
|
9137
|
+
'to': string | null;
|
|
9138
|
+
/**
|
|
9139
|
+
*
|
|
9140
|
+
* @type {GiftCardEmailKind}
|
|
9141
|
+
* @memberof GiftCardHistoryEventDto
|
|
9142
|
+
*/
|
|
9143
|
+
'emailKind': GiftCardEmailKind | null;
|
|
8986
9144
|
/**
|
|
8987
9145
|
* When it happened, ISO 8601
|
|
8988
9146
|
* @type {string}
|
|
@@ -9006,7 +9164,10 @@ export const GiftCardHistoryKind = {
|
|
|
9006
9164
|
Corrected: 'CORRECTED',
|
|
9007
9165
|
Blocked: 'BLOCKED',
|
|
9008
9166
|
Unblocked: 'UNBLOCKED',
|
|
9009
|
-
SwitchedOn: 'SWITCHED_ON'
|
|
9167
|
+
SwitchedOn: 'SWITCHED_ON',
|
|
9168
|
+
Emailed: 'EMAILED',
|
|
9169
|
+
EmailFailed: 'EMAIL_FAILED',
|
|
9170
|
+
EmailChanged: 'EMAIL_CHANGED'
|
|
9010
9171
|
} as const;
|
|
9011
9172
|
|
|
9012
9173
|
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
@@ -9070,6 +9231,39 @@ export const GiftCardIssue = {
|
|
|
9070
9231
|
export type GiftCardIssue = typeof GiftCardIssue[keyof typeof GiftCardIssue];
|
|
9071
9232
|
|
|
9072
9233
|
|
|
9234
|
+
/**
|
|
9235
|
+
*
|
|
9236
|
+
* @export
|
|
9237
|
+
* @interface GiftCardLastEmailDto
|
|
9238
|
+
*/
|
|
9239
|
+
export interface GiftCardLastEmailDto {
|
|
9240
|
+
/**
|
|
9241
|
+
*
|
|
9242
|
+
* @type {GiftCardEmailKind}
|
|
9243
|
+
* @memberof GiftCardLastEmailDto
|
|
9244
|
+
*/
|
|
9245
|
+
'kind': GiftCardEmailKind;
|
|
9246
|
+
/**
|
|
9247
|
+
*
|
|
9248
|
+
* @type {GiftCardEmailStatus}
|
|
9249
|
+
* @memberof GiftCardLastEmailDto
|
|
9250
|
+
*/
|
|
9251
|
+
'status': GiftCardEmailStatus;
|
|
9252
|
+
/**
|
|
9253
|
+
* The address it goes to
|
|
9254
|
+
* @type {string}
|
|
9255
|
+
* @memberof GiftCardLastEmailDto
|
|
9256
|
+
*/
|
|
9257
|
+
'to': string;
|
|
9258
|
+
/**
|
|
9259
|
+
* When it was sent, else when it last changed, ISO 8601
|
|
9260
|
+
* @type {string}
|
|
9261
|
+
* @memberof GiftCardLastEmailDto
|
|
9262
|
+
*/
|
|
9263
|
+
'at': string;
|
|
9264
|
+
}
|
|
9265
|
+
|
|
9266
|
+
|
|
9073
9267
|
/**
|
|
9074
9268
|
*
|
|
9075
9269
|
* @export
|
|
@@ -9108,6 +9302,213 @@ export interface GiftCardMoneyDto {
|
|
|
9108
9302
|
*/
|
|
9109
9303
|
'count': number;
|
|
9110
9304
|
}
|
|
9305
|
+
/**
|
|
9306
|
+
*
|
|
9307
|
+
* @export
|
|
9308
|
+
* @interface GiftCardMoneyWentDto
|
|
9309
|
+
*/
|
|
9310
|
+
export interface GiftCardMoneyWentDto {
|
|
9311
|
+
/**
|
|
9312
|
+
* What has left the cards, in cents: their first balances less what is on them now. A card\'s balance always equals its history added up, so this is every payment less every give-back, and any correction of the history (a correction that took money off counts here).
|
|
9313
|
+
* @type {number}
|
|
9314
|
+
* @memberof GiftCardMoneyWentDto
|
|
9315
|
+
*/
|
|
9316
|
+
'spent': number;
|
|
9317
|
+
/**
|
|
9318
|
+
* On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
|
|
9319
|
+
* @type {number}
|
|
9320
|
+
* @memberof GiftCardMoneyWentDto
|
|
9321
|
+
*/
|
|
9322
|
+
'onCards': number;
|
|
9323
|
+
/**
|
|
9324
|
+
* Left on EXPIRED cards, in cents
|
|
9325
|
+
* @type {number}
|
|
9326
|
+
* @memberof GiftCardMoneyWentDto
|
|
9327
|
+
*/
|
|
9328
|
+
'expiredUnused': number;
|
|
9329
|
+
/**
|
|
9330
|
+
* Left on BLOCKED cards, in cents
|
|
9331
|
+
* @type {number}
|
|
9332
|
+
* @memberof GiftCardMoneyWentDto
|
|
9333
|
+
*/
|
|
9334
|
+
'blocked': number;
|
|
9335
|
+
}
|
|
9336
|
+
/**
|
|
9337
|
+
*
|
|
9338
|
+
* @export
|
|
9339
|
+
* @interface GiftCardMovementDto
|
|
9340
|
+
*/
|
|
9341
|
+
export interface GiftCardMovementDto {
|
|
9342
|
+
/**
|
|
9343
|
+
* The movement\'s id
|
|
9344
|
+
* @type {string}
|
|
9345
|
+
* @memberof GiftCardMovementDto
|
|
9346
|
+
*/
|
|
9347
|
+
'id': string;
|
|
9348
|
+
/**
|
|
9349
|
+
* When it happened, ISO 8601
|
|
9350
|
+
* @type {string}
|
|
9351
|
+
* @memberof GiftCardMovementDto
|
|
9352
|
+
*/
|
|
9353
|
+
'at': string;
|
|
9354
|
+
/**
|
|
9355
|
+
* The card\'s id
|
|
9356
|
+
* @type {string}
|
|
9357
|
+
* @memberof GiftCardMovementDto
|
|
9358
|
+
*/
|
|
9359
|
+
'cardId': string;
|
|
9360
|
+
/**
|
|
9361
|
+
* The card\'s 6-digit code
|
|
9362
|
+
* @type {string}
|
|
9363
|
+
* @memberof GiftCardMovementDto
|
|
9364
|
+
*/
|
|
9365
|
+
'code': string;
|
|
9366
|
+
/**
|
|
9367
|
+
*
|
|
9368
|
+
* @type {GiftCardHistoryKind}
|
|
9369
|
+
* @memberof GiftCardMovementDto
|
|
9370
|
+
*/
|
|
9371
|
+
'kind': GiftCardHistoryKind;
|
|
9372
|
+
/**
|
|
9373
|
+
* How the card\'s balance moved, in cents: positive for SOLD, CREATED_BY_HAND and GIVEN_BACK, negative for SPENT, either for CORRECTED
|
|
9374
|
+
* @type {number}
|
|
9375
|
+
* @memberof GiftCardMovementDto
|
|
9376
|
+
*/
|
|
9377
|
+
'amount': number;
|
|
9378
|
+
/**
|
|
9379
|
+
* The card\'s balance after it, in cents
|
|
9380
|
+
* @type {number}
|
|
9381
|
+
* @memberof GiftCardMovementDto
|
|
9382
|
+
*/
|
|
9383
|
+
'balanceAfter': number;
|
|
9384
|
+
/**
|
|
9385
|
+
* The store where it happened; null when the history did not record one
|
|
9386
|
+
* @type {number}
|
|
9387
|
+
* @memberof GiftCardMovementDto
|
|
9388
|
+
*/
|
|
9389
|
+
'venueId': number | null;
|
|
9390
|
+
/**
|
|
9391
|
+
* That store\'s name; null with venueId, or when the store is gone
|
|
9392
|
+
* @type {string}
|
|
9393
|
+
* @memberof GiftCardMovementDto
|
|
9394
|
+
*/
|
|
9395
|
+
'venueName': string | null;
|
|
9396
|
+
/**
|
|
9397
|
+
* The POS order it belongs to; null when none
|
|
9398
|
+
* @type {string}
|
|
9399
|
+
* @memberof GiftCardMovementDto
|
|
9400
|
+
*/
|
|
9401
|
+
'orderId': string | null;
|
|
9402
|
+
/**
|
|
9403
|
+
* True for a SOLD movement whose card is still NOT_YET_VALID: its POS order is not paid yet, and the report\'s sold leaves it out
|
|
9404
|
+
* @type {boolean}
|
|
9405
|
+
* @memberof GiftCardMovementDto
|
|
9406
|
+
*/
|
|
9407
|
+
'pending': boolean;
|
|
9408
|
+
}
|
|
9409
|
+
|
|
9410
|
+
|
|
9411
|
+
/**
|
|
9412
|
+
*
|
|
9413
|
+
* @export
|
|
9414
|
+
* @interface GiftCardMovementsDto
|
|
9415
|
+
*/
|
|
9416
|
+
export interface GiftCardMovementsDto {
|
|
9417
|
+
/**
|
|
9418
|
+
* The page\'s movements, newest first
|
|
9419
|
+
* @type {Array<GiftCardMovementDto>}
|
|
9420
|
+
* @memberof GiftCardMovementsDto
|
|
9421
|
+
*/
|
|
9422
|
+
'movements': Array<GiftCardMovementDto>;
|
|
9423
|
+
/**
|
|
9424
|
+
* The cursor of the next page; null when this page is the last
|
|
9425
|
+
* @type {string}
|
|
9426
|
+
* @memberof GiftCardMovementsDto
|
|
9427
|
+
*/
|
|
9428
|
+
'nextCursor': string | null;
|
|
9429
|
+
}
|
|
9430
|
+
/**
|
|
9431
|
+
*
|
|
9432
|
+
* @export
|
|
9433
|
+
* @interface GiftCardPeriodTotalsDto
|
|
9434
|
+
*/
|
|
9435
|
+
export interface GiftCardPeriodTotalsDto {
|
|
9436
|
+
/**
|
|
9437
|
+
*
|
|
9438
|
+
* @type {GiftCardPeriodTotalsDtoSold}
|
|
9439
|
+
* @memberof GiftCardPeriodTotalsDto
|
|
9440
|
+
*/
|
|
9441
|
+
'sold': GiftCardPeriodTotalsDtoSold;
|
|
9442
|
+
/**
|
|
9443
|
+
*
|
|
9444
|
+
* @type {GiftCardPeriodTotalsDtoGivenFree}
|
|
9445
|
+
* @memberof GiftCardPeriodTotalsDto
|
|
9446
|
+
*/
|
|
9447
|
+
'givenFree': GiftCardPeriodTotalsDtoGivenFree;
|
|
9448
|
+
/**
|
|
9449
|
+
*
|
|
9450
|
+
* @type {GiftCardPeriodTotalsDtoSpent}
|
|
9451
|
+
* @memberof GiftCardPeriodTotalsDto
|
|
9452
|
+
*/
|
|
9453
|
+
'spent': GiftCardPeriodTotalsDtoSpent;
|
|
9454
|
+
}
|
|
9455
|
+
/**
|
|
9456
|
+
* Cards made by hand
|
|
9457
|
+
* @export
|
|
9458
|
+
* @interface GiftCardPeriodTotalsDtoGivenFree
|
|
9459
|
+
*/
|
|
9460
|
+
export interface GiftCardPeriodTotalsDtoGivenFree {
|
|
9461
|
+
/**
|
|
9462
|
+
* The sum, in cents
|
|
9463
|
+
* @type {number}
|
|
9464
|
+
* @memberof GiftCardPeriodTotalsDtoGivenFree
|
|
9465
|
+
*/
|
|
9466
|
+
'amount': number;
|
|
9467
|
+
/**
|
|
9468
|
+
* How many cards
|
|
9469
|
+
* @type {number}
|
|
9470
|
+
* @memberof GiftCardPeriodTotalsDtoGivenFree
|
|
9471
|
+
*/
|
|
9472
|
+
'count': number;
|
|
9473
|
+
}
|
|
9474
|
+
/**
|
|
9475
|
+
* Cards sold, at the till or online
|
|
9476
|
+
* @export
|
|
9477
|
+
* @interface GiftCardPeriodTotalsDtoSold
|
|
9478
|
+
*/
|
|
9479
|
+
export interface GiftCardPeriodTotalsDtoSold {
|
|
9480
|
+
/**
|
|
9481
|
+
* The sum, in cents
|
|
9482
|
+
* @type {number}
|
|
9483
|
+
* @memberof GiftCardPeriodTotalsDtoSold
|
|
9484
|
+
*/
|
|
9485
|
+
'amount': number;
|
|
9486
|
+
/**
|
|
9487
|
+
* How many cards
|
|
9488
|
+
* @type {number}
|
|
9489
|
+
* @memberof GiftCardPeriodTotalsDtoSold
|
|
9490
|
+
*/
|
|
9491
|
+
'count': number;
|
|
9492
|
+
}
|
|
9493
|
+
/**
|
|
9494
|
+
* Cards spent
|
|
9495
|
+
* @export
|
|
9496
|
+
* @interface GiftCardPeriodTotalsDtoSpent
|
|
9497
|
+
*/
|
|
9498
|
+
export interface GiftCardPeriodTotalsDtoSpent {
|
|
9499
|
+
/**
|
|
9500
|
+
* Taken off cards, less what went back on them, in cents
|
|
9501
|
+
* @type {number}
|
|
9502
|
+
* @memberof GiftCardPeriodTotalsDtoSpent
|
|
9503
|
+
*/
|
|
9504
|
+
'amount': number;
|
|
9505
|
+
/**
|
|
9506
|
+
* How many orders cards paid that kept the payment
|
|
9507
|
+
* @type {number}
|
|
9508
|
+
* @memberof GiftCardPeriodTotalsDtoSpent
|
|
9509
|
+
*/
|
|
9510
|
+
'orderCount': number;
|
|
9511
|
+
}
|
|
9111
9512
|
/**
|
|
9112
9513
|
*
|
|
9113
9514
|
* @export
|
|
@@ -9150,9 +9551,52 @@ export interface GiftCardReportDto {
|
|
|
9150
9551
|
* @memberof GiftCardReportDto
|
|
9151
9552
|
*/
|
|
9152
9553
|
'stores': Array<GiftCardStoreReportDto>;
|
|
9554
|
+
/**
|
|
9555
|
+
*
|
|
9556
|
+
* @type {GiftCardReportDtoPrevious}
|
|
9557
|
+
* @memberof GiftCardReportDto
|
|
9558
|
+
*/
|
|
9559
|
+
'previous': GiftCardReportDtoPrevious;
|
|
9560
|
+
/**
|
|
9561
|
+
*
|
|
9562
|
+
* @type {GiftCardReportDtoMoneyWent}
|
|
9563
|
+
* @memberof GiftCardReportDto
|
|
9564
|
+
*/
|
|
9565
|
+
'moneyWent': GiftCardReportDtoMoneyWent;
|
|
9566
|
+
/**
|
|
9567
|
+
*
|
|
9568
|
+
* @type {GiftCardReportDtoAttention}
|
|
9569
|
+
* @memberof GiftCardReportDto
|
|
9570
|
+
*/
|
|
9571
|
+
'attention': GiftCardReportDtoAttention;
|
|
9153
9572
|
}
|
|
9154
9573
|
|
|
9155
9574
|
|
|
9575
|
+
/**
|
|
9576
|
+
* Right now: what may need the store\'s attention
|
|
9577
|
+
* @export
|
|
9578
|
+
* @interface GiftCardReportDtoAttention
|
|
9579
|
+
*/
|
|
9580
|
+
export interface GiftCardReportDtoAttention {
|
|
9581
|
+
/**
|
|
9582
|
+
*
|
|
9583
|
+
* @type {GiftCardAttentionDtoExpiringSoon}
|
|
9584
|
+
* @memberof GiftCardReportDtoAttention
|
|
9585
|
+
*/
|
|
9586
|
+
'expiringSoon': GiftCardAttentionDtoExpiringSoon;
|
|
9587
|
+
/**
|
|
9588
|
+
*
|
|
9589
|
+
* @type {GiftCardAttentionDtoStalePending}
|
|
9590
|
+
* @memberof GiftCardReportDtoAttention
|
|
9591
|
+
*/
|
|
9592
|
+
'stalePending': GiftCardAttentionDtoStalePending;
|
|
9593
|
+
/**
|
|
9594
|
+
* The days ahead expiringSoon looks
|
|
9595
|
+
* @type {number}
|
|
9596
|
+
* @memberof GiftCardReportDtoAttention
|
|
9597
|
+
*/
|
|
9598
|
+
'expiringWithinDays': number;
|
|
9599
|
+
}
|
|
9156
9600
|
/**
|
|
9157
9601
|
* Cards made by hand in the period
|
|
9158
9602
|
* @export
|
|
@@ -9172,6 +9616,62 @@ export interface GiftCardReportDtoGivenFree {
|
|
|
9172
9616
|
*/
|
|
9173
9617
|
'count': number;
|
|
9174
9618
|
}
|
|
9619
|
+
/**
|
|
9620
|
+
* Right now, over every card of the owner in the currency: where the money paid onto cards went
|
|
9621
|
+
* @export
|
|
9622
|
+
* @interface GiftCardReportDtoMoneyWent
|
|
9623
|
+
*/
|
|
9624
|
+
export interface GiftCardReportDtoMoneyWent {
|
|
9625
|
+
/**
|
|
9626
|
+
* What has left the cards, in cents: their first balances less what is on them now. A card\'s balance always equals its history added up, so this is every payment less every give-back, and any correction of the history (a correction that took money off counts here).
|
|
9627
|
+
* @type {number}
|
|
9628
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9629
|
+
*/
|
|
9630
|
+
'spent': number;
|
|
9631
|
+
/**
|
|
9632
|
+
* On cards that are ACTIVE or NOT_YET_VALID, in cents: customers can still spend it
|
|
9633
|
+
* @type {number}
|
|
9634
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9635
|
+
*/
|
|
9636
|
+
'onCards': number;
|
|
9637
|
+
/**
|
|
9638
|
+
* Left on EXPIRED cards, in cents
|
|
9639
|
+
* @type {number}
|
|
9640
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9641
|
+
*/
|
|
9642
|
+
'expiredUnused': number;
|
|
9643
|
+
/**
|
|
9644
|
+
* Left on BLOCKED cards, in cents
|
|
9645
|
+
* @type {number}
|
|
9646
|
+
* @memberof GiftCardReportDtoMoneyWent
|
|
9647
|
+
*/
|
|
9648
|
+
'blocked': number;
|
|
9649
|
+
}
|
|
9650
|
+
/**
|
|
9651
|
+
* The same sums over the period of the same number of days that ends the day before from
|
|
9652
|
+
* @export
|
|
9653
|
+
* @interface GiftCardReportDtoPrevious
|
|
9654
|
+
*/
|
|
9655
|
+
export interface GiftCardReportDtoPrevious {
|
|
9656
|
+
/**
|
|
9657
|
+
*
|
|
9658
|
+
* @type {GiftCardPeriodTotalsDtoSold}
|
|
9659
|
+
* @memberof GiftCardReportDtoPrevious
|
|
9660
|
+
*/
|
|
9661
|
+
'sold': GiftCardPeriodTotalsDtoSold;
|
|
9662
|
+
/**
|
|
9663
|
+
*
|
|
9664
|
+
* @type {GiftCardPeriodTotalsDtoGivenFree}
|
|
9665
|
+
* @memberof GiftCardReportDtoPrevious
|
|
9666
|
+
*/
|
|
9667
|
+
'givenFree': GiftCardPeriodTotalsDtoGivenFree;
|
|
9668
|
+
/**
|
|
9669
|
+
*
|
|
9670
|
+
* @type {GiftCardPeriodTotalsDtoSpent}
|
|
9671
|
+
* @memberof GiftCardReportDtoPrevious
|
|
9672
|
+
*/
|
|
9673
|
+
'spent': GiftCardPeriodTotalsDtoSpent;
|
|
9674
|
+
}
|
|
9175
9675
|
/**
|
|
9176
9676
|
* Cards sold in the period, at the till or online
|
|
9177
9677
|
* @export
|
|
@@ -9223,7 +9723,7 @@ export interface GiftCardSettingsDto {
|
|
|
9223
9723
|
*/
|
|
9224
9724
|
'channels': GiftCardSettingsDtoChannels;
|
|
9225
9725
|
/**
|
|
9226
|
-
* The store\'s own channels that are on and can take gift cards: TILL for its till, ONLINE_STORE for its online store
|
|
9726
|
+
* The store\'s own channels that are on and can take gift cards: TILL for its till (an active MunchiPos row), ONLINE_STORE for its online store and MOBILE_APP for its mobile app (both an active Storefront row: the app orders through the same storefront), KIOSK for its kiosk (an active MunchiKiosk, MunchiKioskV2 or Kiosk row).
|
|
9227
9727
|
* @type {Array<GiftCardChannel>}
|
|
9228
9728
|
* @memberof GiftCardSettingsDto
|
|
9229
9729
|
*/
|
|
@@ -9270,6 +9770,18 @@ export interface GiftCardSettingsDto {
|
|
|
9270
9770
|
* @memberof GiftCardSettingsDto
|
|
9271
9771
|
*/
|
|
9272
9772
|
'imageUrl': string | null;
|
|
9773
|
+
/**
|
|
9774
|
+
* Whether holders are reminded by email 30 and 7 days before their card expires
|
|
9775
|
+
* @type {boolean}
|
|
9776
|
+
* @memberof GiftCardSettingsDto
|
|
9777
|
+
*/
|
|
9778
|
+
'remindBeforeExpiry': boolean;
|
|
9779
|
+
/**
|
|
9780
|
+
* The store\'s own gift card terms, shown in every card email; null for Munchi\'s standard terms
|
|
9781
|
+
* @type {string}
|
|
9782
|
+
* @memberof GiftCardSettingsDto
|
|
9783
|
+
*/
|
|
9784
|
+
'terms': string | null;
|
|
9273
9785
|
}
|
|
9274
9786
|
/**
|
|
9275
9787
|
* Where the store\'s gift cards can be spent
|
|
@@ -9289,6 +9801,18 @@ export interface GiftCardSettingsDtoChannels {
|
|
|
9289
9801
|
* @memberof GiftCardSettingsDtoChannels
|
|
9290
9802
|
*/
|
|
9291
9803
|
'onlineStore': boolean;
|
|
9804
|
+
/**
|
|
9805
|
+
* Whether the store\'s kiosk takes gift cards. Always answered; absent in a change: unchanged, so a dashboard that sends only till and onlineStore keeps working.
|
|
9806
|
+
* @type {boolean}
|
|
9807
|
+
* @memberof GiftCardSettingsDtoChannels
|
|
9808
|
+
*/
|
|
9809
|
+
'kiosk'?: boolean;
|
|
9810
|
+
/**
|
|
9811
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
9812
|
+
* @type {boolean}
|
|
9813
|
+
* @memberof GiftCardSettingsDtoChannels
|
|
9814
|
+
*/
|
|
9815
|
+
'mobileApp'?: boolean;
|
|
9292
9816
|
}
|
|
9293
9817
|
/**
|
|
9294
9818
|
*
|
|
@@ -26335,7 +26859,7 @@ export interface RecordWorldlineA2aResultDtoAnswer {
|
|
|
26335
26859
|
*/
|
|
26336
26860
|
'remark'?: string;
|
|
26337
26861
|
/**
|
|
26338
|
-
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s
|
|
26862
|
+
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it (WPI answers a cancel without a reference) and then only ends the wait. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
|
|
26339
26863
|
* @type {string}
|
|
26340
26864
|
* @memberof RecordWorldlineA2aResultDtoAnswer
|
|
26341
26865
|
*/
|
|
@@ -36516,6 +37040,18 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36516
37040
|
* @memberof UpdateGiftCardSettingsDto
|
|
36517
37041
|
*/
|
|
36518
37042
|
'imageUrl'?: string | null;
|
|
37043
|
+
/**
|
|
37044
|
+
* Whether holders are reminded by email 30 and 7 days before their card expires. Absent: unchanged.
|
|
37045
|
+
* @type {boolean}
|
|
37046
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
37047
|
+
*/
|
|
37048
|
+
'remindBeforeExpiry'?: boolean;
|
|
37049
|
+
/**
|
|
37050
|
+
* The store\'s own gift card terms, 1 to 5000 characters, shown in every card email, or null for Munchi\'s standard terms. Absent: unchanged.
|
|
37051
|
+
* @type {string}
|
|
37052
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
37053
|
+
*/
|
|
37054
|
+
'terms'?: string | null;
|
|
36519
37055
|
}
|
|
36520
37056
|
/**
|
|
36521
37057
|
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
@@ -36535,6 +37071,18 @@ export interface UpdateGiftCardSettingsDtoChannels {
|
|
|
36535
37071
|
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
36536
37072
|
*/
|
|
36537
37073
|
'onlineStore': boolean;
|
|
37074
|
+
/**
|
|
37075
|
+
* Whether the store\'s kiosk takes gift cards. Always answered; absent in a change: unchanged, so a dashboard that sends only till and onlineStore keeps working.
|
|
37076
|
+
* @type {boolean}
|
|
37077
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
37078
|
+
*/
|
|
37079
|
+
'kiosk'?: boolean;
|
|
37080
|
+
/**
|
|
37081
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
37082
|
+
* @type {boolean}
|
|
37083
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
37084
|
+
*/
|
|
37085
|
+
'mobileApp'?: boolean;
|
|
36538
37086
|
}
|
|
36539
37087
|
/**
|
|
36540
37088
|
*
|
|
@@ -37004,6 +37552,19 @@ export interface UpdateTableStatusDto {
|
|
|
37004
37552
|
}
|
|
37005
37553
|
|
|
37006
37554
|
|
|
37555
|
+
/**
|
|
37556
|
+
*
|
|
37557
|
+
* @export
|
|
37558
|
+
* @interface UpdateVenueGiftCardDto
|
|
37559
|
+
*/
|
|
37560
|
+
export interface UpdateVenueGiftCardDto {
|
|
37561
|
+
/**
|
|
37562
|
+
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
37563
|
+
* @type {string}
|
|
37564
|
+
* @memberof UpdateVenueGiftCardDto
|
|
37565
|
+
*/
|
|
37566
|
+
'buyerEmail': string | null;
|
|
37567
|
+
}
|
|
37007
37568
|
/**
|
|
37008
37569
|
*
|
|
37009
37570
|
* @export
|
|
@@ -38202,6 +38763,12 @@ export interface VenueGiftCardDetailDto {
|
|
|
38202
38763
|
* @memberof VenueGiftCardDetailDto
|
|
38203
38764
|
*/
|
|
38204
38765
|
'buyerEmail': string | null;
|
|
38766
|
+
/**
|
|
38767
|
+
* The buyer\'s phone: its country code and number, a space between; null when no number was given
|
|
38768
|
+
* @type {string}
|
|
38769
|
+
* @memberof VenueGiftCardDetailDto
|
|
38770
|
+
*/
|
|
38771
|
+
'buyerPhone': string | null;
|
|
38205
38772
|
/**
|
|
38206
38773
|
* The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
|
|
38207
38774
|
* @type {number}
|
|
@@ -38250,6 +38817,51 @@ export interface VenueGiftCardDetailDto {
|
|
|
38250
38817
|
* @memberof VenueGiftCardDetailDto
|
|
38251
38818
|
*/
|
|
38252
38819
|
'history': Array<GiftCardHistoryEventDto>;
|
|
38820
|
+
/**
|
|
38821
|
+
* The message shown in the card\'s email; null when none
|
|
38822
|
+
* @type {string}
|
|
38823
|
+
* @memberof VenueGiftCardDetailDto
|
|
38824
|
+
*/
|
|
38825
|
+
'message': string | null;
|
|
38826
|
+
/**
|
|
38827
|
+
*
|
|
38828
|
+
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
38829
|
+
* @memberof VenueGiftCardDetailDto
|
|
38830
|
+
*/
|
|
38831
|
+
'lastEmail': VenueGiftCardDetailDtoLastEmail | null;
|
|
38832
|
+
}
|
|
38833
|
+
|
|
38834
|
+
|
|
38835
|
+
/**
|
|
38836
|
+
* The card\'s newest email; null when it has none
|
|
38837
|
+
* @export
|
|
38838
|
+
* @interface VenueGiftCardDetailDtoLastEmail
|
|
38839
|
+
*/
|
|
38840
|
+
export interface VenueGiftCardDetailDtoLastEmail {
|
|
38841
|
+
/**
|
|
38842
|
+
*
|
|
38843
|
+
* @type {GiftCardEmailKind}
|
|
38844
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38845
|
+
*/
|
|
38846
|
+
'kind': GiftCardEmailKind;
|
|
38847
|
+
/**
|
|
38848
|
+
*
|
|
38849
|
+
* @type {GiftCardEmailStatus}
|
|
38850
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38851
|
+
*/
|
|
38852
|
+
'status': GiftCardEmailStatus;
|
|
38853
|
+
/**
|
|
38854
|
+
* The address it goes to
|
|
38855
|
+
* @type {string}
|
|
38856
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38857
|
+
*/
|
|
38858
|
+
'to': string;
|
|
38859
|
+
/**
|
|
38860
|
+
* When it was sent, else when it last changed, ISO 8601
|
|
38861
|
+
* @type {string}
|
|
38862
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38863
|
+
*/
|
|
38864
|
+
'at': string;
|
|
38253
38865
|
}
|
|
38254
38866
|
|
|
38255
38867
|
|
|
@@ -38313,6 +38925,12 @@ export interface VenueGiftCardDto {
|
|
|
38313
38925
|
* @memberof VenueGiftCardDto
|
|
38314
38926
|
*/
|
|
38315
38927
|
'buyerEmail': string | null;
|
|
38928
|
+
/**
|
|
38929
|
+
* The buyer\'s phone: its country code and number, a space between; null when no number was given
|
|
38930
|
+
* @type {string}
|
|
38931
|
+
* @memberof VenueGiftCardDto
|
|
38932
|
+
*/
|
|
38933
|
+
'buyerPhone': string | null;
|
|
38316
38934
|
/**
|
|
38317
38935
|
* The store the card was sold or made at; null for a merchant\'s card sold before its history was kept
|
|
38318
38936
|
* @type {number}
|
|
@@ -40961,7 +41579,7 @@ export interface WorldlineAppAnswerDto {
|
|
|
40961
41579
|
*/
|
|
40962
41580
|
'remark'?: string;
|
|
40963
41581
|
/**
|
|
40964
|
-
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s
|
|
41582
|
+
* The reference the payment app was given, which it echoes: the session\'s sessionId. Required on a sale\'s or a refund\'s approval, which is refused when it is not the session\'s. A decline or a cancel may come without it (WPI answers a cancel without a reference) and then only ends the wait. Absent on a revert\'s answer: WPI_SVC_CANCEL_PAYMENT takes no reference.
|
|
40965
41583
|
* @type {string}
|
|
40966
41584
|
* @memberof WorldlineAppAnswerDto
|
|
40967
41585
|
*/
|
|
@@ -46124,7 +46742,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46124
46742
|
};
|
|
46125
46743
|
},
|
|
46126
46744
|
/**
|
|
46127
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
46745
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
46128
46746
|
* @summary Create or update a venue
|
|
46129
46747
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46130
46748
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -46416,7 +47034,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46416
47034
|
};
|
|
46417
47035
|
},
|
|
46418
47036
|
/**
|
|
46419
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The
|
|
47037
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
46420
47038
|
* @summary Set active provider and upsert its credentials
|
|
46421
47039
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46422
47040
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -46518,7 +47136,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46518
47136
|
};
|
|
46519
47137
|
},
|
|
46520
47138
|
/**
|
|
46521
|
-
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
|
|
47139
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
46522
47140
|
* @summary Create or update a channel\'s Viva config
|
|
46523
47141
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46524
47142
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -46643,7 +47261,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
46643
47261
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46644
47262
|
},
|
|
46645
47263
|
/**
|
|
46646
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47264
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
46647
47265
|
* @summary Create or update a venue
|
|
46648
47266
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46649
47267
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -46719,7 +47337,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
46719
47337
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46720
47338
|
},
|
|
46721
47339
|
/**
|
|
46722
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The
|
|
47340
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
46723
47341
|
* @summary Set active provider and upsert its credentials
|
|
46724
47342
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46725
47343
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -46745,7 +47363,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
46745
47363
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
46746
47364
|
},
|
|
46747
47365
|
/**
|
|
46748
|
-
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
|
|
47366
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
46749
47367
|
* @summary Create or update a channel\'s Viva config
|
|
46750
47368
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46751
47369
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -46827,7 +47445,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
46827
47445
|
return localVarFp.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(axios, basePath));
|
|
46828
47446
|
},
|
|
46829
47447
|
/**
|
|
46830
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47448
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
46831
47449
|
* @summary Create or update a venue
|
|
46832
47450
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46833
47451
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -46897,7 +47515,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
46897
47515
|
return localVarFp.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(axios, basePath));
|
|
46898
47516
|
},
|
|
46899
47517
|
/**
|
|
46900
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The
|
|
47518
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
46901
47519
|
* @summary Set active provider and upsert its credentials
|
|
46902
47520
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46903
47521
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -46921,7 +47539,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
46921
47539
|
return localVarFp.configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(axios, basePath));
|
|
46922
47540
|
},
|
|
46923
47541
|
/**
|
|
46924
|
-
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
|
|
47542
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
46925
47543
|
* @summary Create or update a channel\'s Viva config
|
|
46926
47544
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46927
47545
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47001,7 +47619,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47001
47619
|
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
47002
47620
|
|
|
47003
47621
|
/**
|
|
47004
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47622
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47005
47623
|
* @summary Create or update a venue
|
|
47006
47624
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47007
47625
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47071,7 +47689,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47071
47689
|
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
47072
47690
|
|
|
47073
47691
|
/**
|
|
47074
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The
|
|
47692
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
47075
47693
|
* @summary Set active provider and upsert its credentials
|
|
47076
47694
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47077
47695
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47095,7 +47713,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47095
47713
|
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
47096
47714
|
|
|
47097
47715
|
/**
|
|
47098
|
-
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
|
|
47716
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
47099
47717
|
* @summary Create or update a channel\'s Viva config
|
|
47100
47718
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47101
47719
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47185,7 +47803,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47185
47803
|
}
|
|
47186
47804
|
|
|
47187
47805
|
/**
|
|
47188
|
-
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47806
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47189
47807
|
* @summary Create or update a venue
|
|
47190
47808
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47191
47809
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47267,7 +47885,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47267
47885
|
}
|
|
47268
47886
|
|
|
47269
47887
|
/**
|
|
47270
|
-
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The
|
|
47888
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
47271
47889
|
* @summary Set active provider and upsert its credentials
|
|
47272
47890
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47273
47891
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47295,7 +47913,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47295
47913
|
}
|
|
47296
47914
|
|
|
47297
47915
|
/**
|
|
47298
|
-
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent; a changed rate or additionalAmount is saved on the license server first.
|
|
47916
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
47299
47917
|
* @summary Create or update a channel\'s Viva config
|
|
47300
47918
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47301
47919
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -50691,7 +51309,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50691
51309
|
* @summary Make a gift card by hand, given for free
|
|
50692
51310
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
50693
51311
|
* @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
|
|
51312
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
50695
51313
|
* @param {*} [options] Override http request option.
|
|
50696
51314
|
* @throws {RequiredError}
|
|
50697
51315
|
*/
|
|
@@ -50735,6 +51353,53 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50735
51353
|
options: localVarRequestOptions,
|
|
50736
51354
|
};
|
|
50737
51355
|
},
|
|
51356
|
+
/**
|
|
51357
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
51358
|
+
* @summary Send a gift card again to its saved email address
|
|
51359
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51360
|
+
* @param {string} cardId The card\'s id
|
|
51361
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
51362
|
+
* @param {*} [options] Override http request option.
|
|
51363
|
+
* @throws {RequiredError}
|
|
51364
|
+
*/
|
|
51365
|
+
emailVenueGiftCard: async (businessId: number, cardId: string, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51366
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51367
|
+
assertParamExists('emailVenueGiftCard', 'businessId', businessId)
|
|
51368
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
51369
|
+
assertParamExists('emailVenueGiftCard', 'cardId', cardId)
|
|
51370
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}/email`
|
|
51371
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
51372
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
51373
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51374
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51375
|
+
let baseOptions;
|
|
51376
|
+
if (configuration) {
|
|
51377
|
+
baseOptions = configuration.baseOptions;
|
|
51378
|
+
}
|
|
51379
|
+
|
|
51380
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
51381
|
+
const localVarHeaderParameter = {} as any;
|
|
51382
|
+
const localVarQueryParameter = {} as any;
|
|
51383
|
+
|
|
51384
|
+
// authentication JWT-auth required
|
|
51385
|
+
// http bearer authentication required
|
|
51386
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51387
|
+
|
|
51388
|
+
if (xIdempotencyKey != null) {
|
|
51389
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
51390
|
+
}
|
|
51391
|
+
|
|
51392
|
+
|
|
51393
|
+
|
|
51394
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51395
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51396
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51397
|
+
|
|
51398
|
+
return {
|
|
51399
|
+
url: toPathString(localVarUrlObj),
|
|
51400
|
+
options: localVarRequestOptions,
|
|
51401
|
+
};
|
|
51402
|
+
},
|
|
50738
51403
|
/**
|
|
50739
51404
|
* 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
51405
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -50778,7 +51443,7 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50778
51443
|
};
|
|
50779
51444
|
},
|
|
50780
51445
|
/**
|
|
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.
|
|
51446
|
+
* 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. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
|
|
50782
51447
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
50783
51448
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
50784
51449
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -50858,6 +51523,83 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50858
51523
|
|
|
50859
51524
|
|
|
50860
51525
|
|
|
51526
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51527
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51528
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51529
|
+
|
|
51530
|
+
return {
|
|
51531
|
+
url: toPathString(localVarUrlObj),
|
|
51532
|
+
options: localVarRequestOptions,
|
|
51533
|
+
};
|
|
51534
|
+
},
|
|
51535
|
+
/**
|
|
51536
|
+
* Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
|
|
51537
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
51538
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51539
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51540
|
+
* @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
|
|
51541
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
51542
|
+
* @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
|
|
51543
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
51544
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
51545
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
51546
|
+
* @param {*} [options] Override http request option.
|
|
51547
|
+
* @throws {RequiredError}
|
|
51548
|
+
*/
|
|
51549
|
+
listVenueGiftCardMovements: async (businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51550
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51551
|
+
assertParamExists('listVenueGiftCardMovements', 'businessId', businessId)
|
|
51552
|
+
// verify required parameter 'from' is not null or undefined
|
|
51553
|
+
assertParamExists('listVenueGiftCardMovements', 'from', from)
|
|
51554
|
+
// verify required parameter 'to' is not null or undefined
|
|
51555
|
+
assertParamExists('listVenueGiftCardMovements', 'to', to)
|
|
51556
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-card-movements`
|
|
51557
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
51558
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51559
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51560
|
+
let baseOptions;
|
|
51561
|
+
if (configuration) {
|
|
51562
|
+
baseOptions = configuration.baseOptions;
|
|
51563
|
+
}
|
|
51564
|
+
|
|
51565
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
51566
|
+
const localVarHeaderParameter = {} as any;
|
|
51567
|
+
const localVarQueryParameter = {} as any;
|
|
51568
|
+
|
|
51569
|
+
// authentication JWT-auth required
|
|
51570
|
+
// http bearer authentication required
|
|
51571
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51572
|
+
|
|
51573
|
+
if (from !== undefined) {
|
|
51574
|
+
localVarQueryParameter['from'] = from;
|
|
51575
|
+
}
|
|
51576
|
+
|
|
51577
|
+
if (to !== undefined) {
|
|
51578
|
+
localVarQueryParameter['to'] = to;
|
|
51579
|
+
}
|
|
51580
|
+
|
|
51581
|
+
if (search !== undefined) {
|
|
51582
|
+
localVarQueryParameter['search'] = search;
|
|
51583
|
+
}
|
|
51584
|
+
|
|
51585
|
+
if (kinds) {
|
|
51586
|
+
localVarQueryParameter['kinds'] = kinds;
|
|
51587
|
+
}
|
|
51588
|
+
|
|
51589
|
+
if (venueIds) {
|
|
51590
|
+
localVarQueryParameter['venueIds'] = venueIds;
|
|
51591
|
+
}
|
|
51592
|
+
|
|
51593
|
+
if (cursor !== undefined) {
|
|
51594
|
+
localVarQueryParameter['cursor'] = cursor;
|
|
51595
|
+
}
|
|
51596
|
+
|
|
51597
|
+
if (limit !== undefined) {
|
|
51598
|
+
localVarQueryParameter['limit'] = limit;
|
|
51599
|
+
}
|
|
51600
|
+
|
|
51601
|
+
|
|
51602
|
+
|
|
50861
51603
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
50862
51604
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
50863
51605
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -50875,10 +51617,11 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50875
51617
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
50876
51618
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
50877
51619
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51620
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
50878
51621
|
* @param {*} [options] Override http request option.
|
|
50879
51622
|
* @throws {RequiredError}
|
|
50880
51623
|
*/
|
|
50881
|
-
listVenueGiftCards: async (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51624
|
+
listVenueGiftCards: async (businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
50882
51625
|
// verify required parameter 'businessId' is not null or undefined
|
|
50883
51626
|
assertParamExists('listVenueGiftCards', 'businessId', businessId)
|
|
50884
51627
|
const localVarPath = `/api/v2/venues/{businessId}/gift-cards`
|
|
@@ -50914,6 +51657,10 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50914
51657
|
localVarQueryParameter['limit'] = limit;
|
|
50915
51658
|
}
|
|
50916
51659
|
|
|
51660
|
+
if (expiresBefore !== undefined) {
|
|
51661
|
+
localVarQueryParameter['expiresBefore'] = expiresBefore;
|
|
51662
|
+
}
|
|
51663
|
+
|
|
50917
51664
|
|
|
50918
51665
|
|
|
50919
51666
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -50967,6 +51714,54 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
50967
51714
|
options: localVarRequestOptions,
|
|
50968
51715
|
};
|
|
50969
51716
|
},
|
|
51717
|
+
/**
|
|
51718
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
51719
|
+
* @summary Correct a gift card\'s email address
|
|
51720
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51721
|
+
* @param {string} cardId The card\'s id
|
|
51722
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
51723
|
+
* @param {*} [options] Override http request option.
|
|
51724
|
+
* @throws {RequiredError}
|
|
51725
|
+
*/
|
|
51726
|
+
updateVenueGiftCard: async (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51727
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51728
|
+
assertParamExists('updateVenueGiftCard', 'businessId', businessId)
|
|
51729
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
51730
|
+
assertParamExists('updateVenueGiftCard', 'cardId', cardId)
|
|
51731
|
+
// verify required parameter 'updateVenueGiftCardDto' is not null or undefined
|
|
51732
|
+
assertParamExists('updateVenueGiftCard', 'updateVenueGiftCardDto', updateVenueGiftCardDto)
|
|
51733
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}`
|
|
51734
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
51735
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
51736
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51737
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51738
|
+
let baseOptions;
|
|
51739
|
+
if (configuration) {
|
|
51740
|
+
baseOptions = configuration.baseOptions;
|
|
51741
|
+
}
|
|
51742
|
+
|
|
51743
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
51744
|
+
const localVarHeaderParameter = {} as any;
|
|
51745
|
+
const localVarQueryParameter = {} as any;
|
|
51746
|
+
|
|
51747
|
+
// authentication JWT-auth required
|
|
51748
|
+
// http bearer authentication required
|
|
51749
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51750
|
+
|
|
51751
|
+
|
|
51752
|
+
|
|
51753
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
51754
|
+
|
|
51755
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51756
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51757
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51758
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateVenueGiftCardDto, localVarRequestOptions, configuration)
|
|
51759
|
+
|
|
51760
|
+
return {
|
|
51761
|
+
url: toPathString(localVarUrlObj),
|
|
51762
|
+
options: localVarRequestOptions,
|
|
51763
|
+
};
|
|
51764
|
+
},
|
|
50970
51765
|
/**
|
|
50971
51766
|
* 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
51767
|
* @summary Change a store\'s gift card settings
|
|
@@ -51051,7 +51846,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51051
51846
|
* @summary Make a gift card by hand, given for free
|
|
51052
51847
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51053
51848
|
* @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
|
|
51849
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51055
51850
|
* @param {*} [options] Override http request option.
|
|
51056
51851
|
* @throws {RequiredError}
|
|
51057
51852
|
*/
|
|
@@ -51059,6 +51854,19 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51059
51854
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options);
|
|
51060
51855
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51061
51856
|
},
|
|
51857
|
+
/**
|
|
51858
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
51859
|
+
* @summary Send a gift card again to its saved email address
|
|
51860
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51861
|
+
* @param {string} cardId The card\'s id
|
|
51862
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
51863
|
+
* @param {*} [options] Override http request option.
|
|
51864
|
+
* @throws {RequiredError}
|
|
51865
|
+
*/
|
|
51866
|
+
async emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51867
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options);
|
|
51868
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51869
|
+
},
|
|
51062
51870
|
/**
|
|
51063
51871
|
* 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
51872
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51072,7 +51880,7 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51072
51880
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51073
51881
|
},
|
|
51074
51882
|
/**
|
|
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.
|
|
51883
|
+
* 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. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
|
|
51076
51884
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51077
51885
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51078
51886
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51095,6 +51903,24 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51095
51903
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getVenueGiftCardSettings(businessId, options);
|
|
51096
51904
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51097
51905
|
},
|
|
51906
|
+
/**
|
|
51907
|
+
* Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
|
|
51908
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
51909
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51910
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
51911
|
+
* @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
|
|
51912
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
51913
|
+
* @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
|
|
51914
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
51915
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
51916
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
51917
|
+
* @param {*} [options] Override http request option.
|
|
51918
|
+
* @throws {RequiredError}
|
|
51919
|
+
*/
|
|
51920
|
+
async listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GiftCardMovementsDto>> {
|
|
51921
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueGiftCardMovements(businessId, from, to, search, kinds, venueIds, cursor, limit, options);
|
|
51922
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51923
|
+
},
|
|
51098
51924
|
/**
|
|
51099
51925
|
* 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
51926
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51103,11 +51929,12 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51103
51929
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51104
51930
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51105
51931
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
51932
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51106
51933
|
* @param {*} [options] Override http request option.
|
|
51107
51934
|
* @throws {RequiredError}
|
|
51108
51935
|
*/
|
|
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);
|
|
51936
|
+
async listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardsDto>> {
|
|
51937
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options);
|
|
51111
51938
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51112
51939
|
},
|
|
51113
51940
|
/**
|
|
@@ -51122,6 +51949,19 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51122
51949
|
const localVarAxiosArgs = await localVarAxiosParamCreator.unblockVenueGiftCard(businessId, cardId, options);
|
|
51123
51950
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51124
51951
|
},
|
|
51952
|
+
/**
|
|
51953
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
51954
|
+
* @summary Correct a gift card\'s email address
|
|
51955
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51956
|
+
* @param {string} cardId The card\'s id
|
|
51957
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
51958
|
+
* @param {*} [options] Override http request option.
|
|
51959
|
+
* @throws {RequiredError}
|
|
51960
|
+
*/
|
|
51961
|
+
async updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51962
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options);
|
|
51963
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51964
|
+
},
|
|
51125
51965
|
/**
|
|
51126
51966
|
* 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
51967
|
* @summary Change a store\'s gift card settings
|
|
@@ -51172,13 +52012,25 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51172
52012
|
* @summary Make a gift card by hand, given for free
|
|
51173
52013
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51174
52014
|
* @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
|
|
52015
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51176
52016
|
* @param {*} [options] Override http request option.
|
|
51177
52017
|
* @throws {RequiredError}
|
|
51178
52018
|
*/
|
|
51179
52019
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51180
52020
|
return localVarFp.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
51181
52021
|
},
|
|
52022
|
+
/**
|
|
52023
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
52024
|
+
* @summary Send a gift card again to its saved email address
|
|
52025
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52026
|
+
* @param {string} cardId The card\'s id
|
|
52027
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
52028
|
+
* @param {*} [options] Override http request option.
|
|
52029
|
+
* @throws {RequiredError}
|
|
52030
|
+
*/
|
|
52031
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
52032
|
+
return localVarFp.emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
52033
|
+
},
|
|
51182
52034
|
/**
|
|
51183
52035
|
* 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
52036
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51191,7 +52043,7 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51191
52043
|
return localVarFp.getVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51192
52044
|
},
|
|
51193
52045
|
/**
|
|
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.
|
|
52046
|
+
* 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. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
|
|
51195
52047
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51196
52048
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51197
52049
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51212,6 +52064,23 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51212
52064
|
getVenueGiftCardSettings(businessId: number, options?: any): AxiosPromise<GiftCardSettingsDto> {
|
|
51213
52065
|
return localVarFp.getVenueGiftCardSettings(businessId, options).then((request) => request(axios, basePath));
|
|
51214
52066
|
},
|
|
52067
|
+
/**
|
|
52068
|
+
* Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
|
|
52069
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
52070
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52071
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
52072
|
+
* @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
|
|
52073
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
52074
|
+
* @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
|
|
52075
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
52076
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
52077
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
52078
|
+
* @param {*} [options] Override http request option.
|
|
52079
|
+
* @throws {RequiredError}
|
|
52080
|
+
*/
|
|
52081
|
+
listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: any): AxiosPromise<GiftCardMovementsDto> {
|
|
52082
|
+
return localVarFp.listVenueGiftCardMovements(businessId, from, to, search, kinds, venueIds, cursor, limit, options).then((request) => request(axios, basePath));
|
|
52083
|
+
},
|
|
51215
52084
|
/**
|
|
51216
52085
|
* 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
52086
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51220,11 +52089,12 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51220
52089
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51221
52090
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51222
52091
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
52092
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51223
52093
|
* @param {*} [options] Override http request option.
|
|
51224
52094
|
* @throws {RequiredError}
|
|
51225
52095
|
*/
|
|
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));
|
|
52096
|
+
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: any): AxiosPromise<VenueGiftCardsDto> {
|
|
52097
|
+
return localVarFp.listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options).then((request) => request(axios, basePath));
|
|
51228
52098
|
},
|
|
51229
52099
|
/**
|
|
51230
52100
|
* 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.
|
|
@@ -51237,6 +52107,18 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51237
52107
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51238
52108
|
return localVarFp.unblockVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51239
52109
|
},
|
|
52110
|
+
/**
|
|
52111
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
52112
|
+
* @summary Correct a gift card\'s email address
|
|
52113
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52114
|
+
* @param {string} cardId The card\'s id
|
|
52115
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52116
|
+
* @param {*} [options] Override http request option.
|
|
52117
|
+
* @throws {RequiredError}
|
|
52118
|
+
*/
|
|
52119
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
52120
|
+
return localVarFp.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(axios, basePath));
|
|
52121
|
+
},
|
|
51240
52122
|
/**
|
|
51241
52123
|
* 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
52124
|
* @summary Change a store\'s gift card settings
|
|
@@ -51285,13 +52167,25 @@ export interface GiftCardsApiInterface {
|
|
|
51285
52167
|
* @summary Make a gift card by hand, given for free
|
|
51286
52168
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51287
52169
|
* @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
|
|
52170
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51289
52171
|
* @param {*} [options] Override http request option.
|
|
51290
52172
|
* @throws {RequiredError}
|
|
51291
52173
|
* @memberof GiftCardsApiInterface
|
|
51292
52174
|
*/
|
|
51293
52175
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51294
52176
|
|
|
52177
|
+
/**
|
|
52178
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
52179
|
+
* @summary Send a gift card again to its saved email address
|
|
52180
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52181
|
+
* @param {string} cardId The card\'s id
|
|
52182
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
52183
|
+
* @param {*} [options] Override http request option.
|
|
52184
|
+
* @throws {RequiredError}
|
|
52185
|
+
* @memberof GiftCardsApiInterface
|
|
52186
|
+
*/
|
|
52187
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52188
|
+
|
|
51295
52189
|
/**
|
|
51296
52190
|
* 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
52191
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51304,7 +52198,7 @@ export interface GiftCardsApiInterface {
|
|
|
51304
52198
|
getVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51305
52199
|
|
|
51306
52200
|
/**
|
|
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.
|
|
52201
|
+
* 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. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
|
|
51308
52202
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51309
52203
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51310
52204
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51325,6 +52219,23 @@ export interface GiftCardsApiInterface {
|
|
|
51325
52219
|
*/
|
|
51326
52220
|
getVenueGiftCardSettings(businessId: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardSettingsDto>;
|
|
51327
52221
|
|
|
52222
|
+
/**
|
|
52223
|
+
* Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
|
|
52224
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
52225
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52226
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
52227
|
+
* @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
|
|
52228
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
52229
|
+
* @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
|
|
52230
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
52231
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
52232
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
52233
|
+
* @param {*} [options] Override http request option.
|
|
52234
|
+
* @throws {RequiredError}
|
|
52235
|
+
* @memberof GiftCardsApiInterface
|
|
52236
|
+
*/
|
|
52237
|
+
listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<GiftCardMovementsDto>;
|
|
52238
|
+
|
|
51328
52239
|
/**
|
|
51329
52240
|
* The cards of the store\'s owner, newest first (createdAt, then id). search finds a code that starts with it, or a buyer\'s name or email that contains it; state keeps the cards in that state now. Send nextCursor as cursor for the next page. Three statements; nothing is written.
|
|
51330
52241
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51333,11 +52244,12 @@ export interface GiftCardsApiInterface {
|
|
|
51333
52244
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51334
52245
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51335
52246
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
52247
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51336
52248
|
* @param {*} [options] Override http request option.
|
|
51337
52249
|
* @throws {RequiredError}
|
|
51338
52250
|
* @memberof GiftCardsApiInterface
|
|
51339
52251
|
*/
|
|
51340
|
-
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
52252
|
+
listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardsDto>;
|
|
51341
52253
|
|
|
51342
52254
|
/**
|
|
51343
52255
|
* 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.
|
|
@@ -51350,6 +52262,18 @@ export interface GiftCardsApiInterface {
|
|
|
51350
52262
|
*/
|
|
51351
52263
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51352
52264
|
|
|
52265
|
+
/**
|
|
52266
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
52267
|
+
* @summary Correct a gift card\'s email address
|
|
52268
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52269
|
+
* @param {string} cardId The card\'s id
|
|
52270
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52271
|
+
* @param {*} [options] Override http request option.
|
|
52272
|
+
* @throws {RequiredError}
|
|
52273
|
+
* @memberof GiftCardsApiInterface
|
|
52274
|
+
*/
|
|
52275
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52276
|
+
|
|
51353
52277
|
/**
|
|
51354
52278
|
* 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
52279
|
* @summary Change a store\'s gift card settings
|
|
@@ -51402,7 +52326,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51402
52326
|
* @summary Make a gift card by hand, given for free
|
|
51403
52327
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51404
52328
|
* @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
|
|
52329
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per card made; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers 201 with the card it made and makes no other, also when two arrive at once, when it matches that card: the same store\'s owner, amount, recipientName and note, and expiresAt, buyerEmail, phoneCountryCode and phoneNumber when it sends them (one left out is not compared, since it was worked out from the first request\'s time). Any other repeat, or a key a till\'s sale used, is refused 400. Without the header every request makes a card.
|
|
51406
52330
|
* @param {*} [options] Override http request option.
|
|
51407
52331
|
* @throws {RequiredError}
|
|
51408
52332
|
* @memberof GiftCardsApi
|
|
@@ -51411,6 +52335,20 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51411
52335
|
return GiftCardsApiFp(this.configuration).createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
51412
52336
|
}
|
|
51413
52337
|
|
|
52338
|
+
/**
|
|
52339
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
52340
|
+
* @summary Send a gift card again to its saved email address
|
|
52341
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52342
|
+
* @param {string} cardId The card\'s id
|
|
52343
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
52344
|
+
* @param {*} [options] Override http request option.
|
|
52345
|
+
* @throws {RequiredError}
|
|
52346
|
+
* @memberof GiftCardsApi
|
|
52347
|
+
*/
|
|
52348
|
+
public emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
52349
|
+
return GiftCardsApiFp(this.configuration).emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
52350
|
+
}
|
|
52351
|
+
|
|
51414
52352
|
/**
|
|
51415
52353
|
* 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
52354
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51425,7 +52363,7 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51425
52363
|
}
|
|
51426
52364
|
|
|
51427
52365
|
/**
|
|
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.
|
|
52366
|
+
* 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. previous holds the same sums over the period of the same length ending the day before from. moneyWent and attention are read now, over every card of the owner in the currency: where the money went (what has left the cards, still on ACTIVE and NOT_YET_VALID cards, expired unused, blocked), the ACTIVE cards expiring before the end of the 30th day from today in the store\'s time zone (as listVenueGiftCards\' expiresBefore of that day lists them), and the NOT_YET_VALID cards made more than 24 hours ago. Three statements; nothing is written.
|
|
51429
52367
|
* @summary Report what a store\'s gift cards sold, gave away and paid in a period
|
|
51430
52368
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
51431
52369
|
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
@@ -51450,6 +52388,25 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51450
52388
|
return GiftCardsApiFp(this.configuration).getVenueGiftCardSettings(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
51451
52389
|
}
|
|
51452
52390
|
|
|
52391
|
+
/**
|
|
52392
|
+
* Each sale, card made by hand, payment, give-back and correction of the owner\'s cards in the store\'s currency, from the first day\'s 00:00 to the end of the last in the store\'s time zone, newest first (createdAt, then id), with the balance\'s signed change. A sale on a POS order not paid yet is listed too, marked pending. Filters: a code\'s start, the kinds, the stores. Send nextCursor as cursor for the next page. Three statements; nothing is written.
|
|
52393
|
+
* @summary List every movement of a store\'s gift cards in a period, newest first
|
|
52394
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52395
|
+
* @param {string} from The first day, YYYY-MM-DD, in the store\'s time zone
|
|
52396
|
+
* @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
|
|
52397
|
+
* @param {string} [search] Only the cards whose code starts with this, 1 to 64 characters. Absent: every card.
|
|
52398
|
+
* @param {Array<GiftCardHistoryKind>} [kinds] Only these kinds of movement, the parameter repeated or a JSON list: SOLD, CREATED_BY_HAND, SPENT, GIVEN_BACK, CORRECTED. Absent: every kind.
|
|
52399
|
+
* @param {Array<number>} [venueIds] Only the movements at these stores, the parameter repeated or a JSON list of orderingBusinessIds. Absent: every store.
|
|
52400
|
+
* @param {string} [cursor] The nextCursor of the page before: a movement\'s id. Absent for the first page.
|
|
52401
|
+
* @param {number} [limit] How many movements a page holds, 1 to 200. Absent: 100.
|
|
52402
|
+
* @param {*} [options] Override http request option.
|
|
52403
|
+
* @throws {RequiredError}
|
|
52404
|
+
* @memberof GiftCardsApi
|
|
52405
|
+
*/
|
|
52406
|
+
public listVenueGiftCardMovements(businessId: number, from: string, to: string, search?: string, kinds?: Array<GiftCardHistoryKind>, venueIds?: Array<number>, cursor?: string, limit?: number, options?: AxiosRequestConfig) {
|
|
52407
|
+
return GiftCardsApiFp(this.configuration).listVenueGiftCardMovements(businessId, from, to, search, kinds, venueIds, cursor, limit, options).then((request) => request(this.axios, this.basePath));
|
|
52408
|
+
}
|
|
52409
|
+
|
|
51453
52410
|
/**
|
|
51454
52411
|
* 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
52412
|
* @summary List a store\'s gift cards, newest first, a page at a time
|
|
@@ -51458,12 +52415,13 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51458
52415
|
* @param {GiftCardState} [state] Only the cards in this state now. Absent: every state.
|
|
51459
52416
|
* @param {string} [cursor] The nextCursor of the page before: a card\'s id. Absent for the first page.
|
|
51460
52417
|
* @param {number} [limit] How many cards a page holds, 1 to 100. Absent: 50.
|
|
52418
|
+
* @param {string} [expiresBefore] Only ACTIVE cards that expire on or before this day, YYYY-MM-DD in the store\'s time zone. Absent: any expiry.
|
|
51461
52419
|
* @param {*} [options] Override http request option.
|
|
51462
52420
|
* @throws {RequiredError}
|
|
51463
52421
|
* @memberof GiftCardsApi
|
|
51464
52422
|
*/
|
|
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));
|
|
52423
|
+
public listVenueGiftCards(businessId: number, search?: string, state?: GiftCardState, cursor?: string, limit?: number, expiresBefore?: string, options?: AxiosRequestConfig) {
|
|
52424
|
+
return GiftCardsApiFp(this.configuration).listVenueGiftCards(businessId, search, state, cursor, limit, expiresBefore, options).then((request) => request(this.axios, this.basePath));
|
|
51467
52425
|
}
|
|
51468
52426
|
|
|
51469
52427
|
/**
|
|
@@ -51479,6 +52437,20 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51479
52437
|
return GiftCardsApiFp(this.configuration).unblockVenueGiftCard(businessId, cardId, options).then((request) => request(this.axios, this.basePath));
|
|
51480
52438
|
}
|
|
51481
52439
|
|
|
52440
|
+
/**
|
|
52441
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
52442
|
+
* @summary Correct a gift card\'s email address
|
|
52443
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52444
|
+
* @param {string} cardId The card\'s id
|
|
52445
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52446
|
+
* @param {*} [options] Override http request option.
|
|
52447
|
+
* @throws {RequiredError}
|
|
52448
|
+
* @memberof GiftCardsApi
|
|
52449
|
+
*/
|
|
52450
|
+
public updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) {
|
|
52451
|
+
return GiftCardsApiFp(this.configuration).updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
52452
|
+
}
|
|
52453
|
+
|
|
51482
52454
|
/**
|
|
51483
52455
|
* 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
52456
|
* @summary Change a store\'s gift card settings
|
|
@@ -62356,7 +63328,7 @@ export const PaymentSessionApiAxiosParamCreator = function (configuration?: Conf
|
|
|
62356
63328
|
};
|
|
62357
63329
|
},
|
|
62358
63330
|
/**
|
|
62359
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
63331
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
62360
63332
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
62361
63333
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
62362
63334
|
* @param {*} [options] Override http request option.
|
|
@@ -62997,7 +63969,7 @@ export const PaymentSessionApiFp = function(configuration?: Configuration) {
|
|
|
62997
63969
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
62998
63970
|
},
|
|
62999
63971
|
/**
|
|
63000
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
63972
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
63001
63973
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63002
63974
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63003
63975
|
* @param {*} [options] Override http request option.
|
|
@@ -63321,7 +64293,7 @@ export const PaymentSessionApiFactory = function (configuration?: Configuration,
|
|
|
63321
64293
|
return localVarFp.recordManualPayment(createManualSessionDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
63322
64294
|
},
|
|
63323
64295
|
/**
|
|
63324
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
64296
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
63325
64297
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63326
64298
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63327
64299
|
* @param {*} [options] Override http request option.
|
|
@@ -63632,7 +64604,7 @@ export interface PaymentSessionApiInterface {
|
|
|
63632
64604
|
recordManualPayment(createManualSessionDto: CreateManualSessionDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<RecordManualPaymentResultDto>;
|
|
63633
64605
|
|
|
63634
64606
|
/**
|
|
63635
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
64607
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
63636
64608
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63637
64609
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63638
64610
|
* @param {*} [options] Override http request option.
|
|
@@ -63977,7 +64949,7 @@ export class PaymentSessionApi extends BaseAPI implements PaymentSessionApiInter
|
|
|
63977
64949
|
}
|
|
63978
64950
|
|
|
63979
64951
|
/**
|
|
63980
|
-
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s
|
|
64952
|
+
* Settles a handheld Worldline sale, refund or revert with the payment app\'s answer (WPI_RESPONSE). A sale\'s or a refund\'s approval carries the session\'s sessionId as its reference, and so does its decline, except that WPI may answer a decline or a cancel without one; a revert\'s (WPI_SVC_CANCEL_PAYMENT) carries none and names the sale\'s paymentSolutionReference instead. An approval makes a sale SUCCESS, a refund REFUNDED and a revert REFUNDING; reconciliation then writes the payment or the reversal onto the order. A sale\'s approval may carry a tip the cardholder added on the payment app: it is recorded with the session\'s tip. A failure makes it FAILED, or CANCELLED when the app reports WPI_ERR_COND_USER_CANCEL. An approval may replace a failure; a failure never replaces anything. A repeated answer is answered as the session stands. The payment event\'s time is the server\'s. A signed-in ticket only.
|
|
63981
64953
|
* @summary Record the Worldline payment app\'s answer for a handheld session
|
|
63982
64954
|
* @param {RecordWorldlineA2aResultDto} recordWorldlineA2aResultDto
|
|
63983
64955
|
* @param {*} [options] Override http request option.
|