@munchi_oy/core 2.13.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 +320 -16
- 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 +427 -18
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -5196,6 +5196,18 @@ export interface CreateVenueGiftCardDto {
|
|
|
5196
5196
|
* @memberof CreateVenueGiftCardDto
|
|
5197
5197
|
*/
|
|
5198
5198
|
'note'?: string;
|
|
5199
|
+
/**
|
|
5200
|
+
* The message shown in the card\'s email, 1 to 300 characters: the buyer\'s or the store\'s own words. Absent: none.
|
|
5201
|
+
* @type {string}
|
|
5202
|
+
* @memberof CreateVenueGiftCardDto
|
|
5203
|
+
*/
|
|
5204
|
+
'message'?: string;
|
|
5205
|
+
/**
|
|
5206
|
+
* Whether the card is emailed to buyerEmail at once. Absent: true. Without buyerEmail nothing is sent.
|
|
5207
|
+
* @type {boolean}
|
|
5208
|
+
* @memberof CreateVenueGiftCardDto
|
|
5209
|
+
*/
|
|
5210
|
+
'sendEmail'?: boolean;
|
|
5199
5211
|
/**
|
|
5200
5212
|
* The buyer\'s email, at most 254 characters once the spaces around it are dropped. Absent or only spaces: none. Answered as buyerEmail.
|
|
5201
5213
|
* @type {string}
|
|
@@ -8565,6 +8577,8 @@ export interface GiftCardAttentionDtoStalePending {
|
|
|
8565
8577
|
export declare const GiftCardChannel: {
|
|
8566
8578
|
readonly Till: "TILL";
|
|
8567
8579
|
readonly OnlineStore: "ONLINE_STORE";
|
|
8580
|
+
readonly Kiosk: "KIOSK";
|
|
8581
|
+
readonly MobileApp: "MOBILE_APP";
|
|
8568
8582
|
};
|
|
8569
8583
|
export type GiftCardChannel = typeof GiftCardChannel[keyof typeof GiftCardChannel];
|
|
8570
8584
|
/**
|
|
@@ -8585,6 +8599,18 @@ export interface GiftCardChannelsDto {
|
|
|
8585
8599
|
* @memberof GiftCardChannelsDto
|
|
8586
8600
|
*/
|
|
8587
8601
|
'onlineStore': boolean;
|
|
8602
|
+
/**
|
|
8603
|
+
* 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.
|
|
8604
|
+
* @type {boolean}
|
|
8605
|
+
* @memberof GiftCardChannelsDto
|
|
8606
|
+
*/
|
|
8607
|
+
'kiosk'?: boolean;
|
|
8608
|
+
/**
|
|
8609
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
8610
|
+
* @type {boolean}
|
|
8611
|
+
* @memberof GiftCardChannelsDto
|
|
8612
|
+
*/
|
|
8613
|
+
'mobileApp'?: boolean;
|
|
8588
8614
|
}
|
|
8589
8615
|
/**
|
|
8590
8616
|
*
|
|
@@ -8674,6 +8700,30 @@ export interface GiftCardCredentialsViewDto {
|
|
|
8674
8700
|
*/
|
|
8675
8701
|
'uniquePosDeviceId': string | null;
|
|
8676
8702
|
}
|
|
8703
|
+
/**
|
|
8704
|
+
*
|
|
8705
|
+
* @export
|
|
8706
|
+
* @enum {string}
|
|
8707
|
+
*/
|
|
8708
|
+
export declare const GiftCardEmailKind: {
|
|
8709
|
+
readonly Card: "CARD";
|
|
8710
|
+
readonly CardAgain: "CARD_AGAIN";
|
|
8711
|
+
readonly Expiry30: "EXPIRY_30";
|
|
8712
|
+
readonly Expiry7: "EXPIRY_7";
|
|
8713
|
+
};
|
|
8714
|
+
export type GiftCardEmailKind = typeof GiftCardEmailKind[keyof typeof GiftCardEmailKind];
|
|
8715
|
+
/**
|
|
8716
|
+
*
|
|
8717
|
+
* @export
|
|
8718
|
+
* @enum {string}
|
|
8719
|
+
*/
|
|
8720
|
+
export declare const GiftCardEmailStatus: {
|
|
8721
|
+
readonly Pending: "PENDING";
|
|
8722
|
+
readonly Sent: "SENT";
|
|
8723
|
+
readonly Failed: "FAILED";
|
|
8724
|
+
readonly Skipped: "SKIPPED";
|
|
8725
|
+
};
|
|
8726
|
+
export type GiftCardEmailStatus = typeof GiftCardEmailStatus[keyof typeof GiftCardEmailStatus];
|
|
8677
8727
|
/**
|
|
8678
8728
|
*
|
|
8679
8729
|
* @export
|
|
@@ -8754,6 +8804,18 @@ export interface GiftCardHistoryEventDto {
|
|
|
8754
8804
|
* @memberof GiftCardHistoryEventDto
|
|
8755
8805
|
*/
|
|
8756
8806
|
'orderId': string | null;
|
|
8807
|
+
/**
|
|
8808
|
+
* The address of an EMAILED, EMAIL_FAILED or EMAIL_CHANGED line; null for the others
|
|
8809
|
+
* @type {string}
|
|
8810
|
+
* @memberof GiftCardHistoryEventDto
|
|
8811
|
+
*/
|
|
8812
|
+
'to': string | null;
|
|
8813
|
+
/**
|
|
8814
|
+
*
|
|
8815
|
+
* @type {GiftCardEmailKind}
|
|
8816
|
+
* @memberof GiftCardHistoryEventDto
|
|
8817
|
+
*/
|
|
8818
|
+
'emailKind': GiftCardEmailKind | null;
|
|
8757
8819
|
/**
|
|
8758
8820
|
* When it happened, ISO 8601
|
|
8759
8821
|
* @type {string}
|
|
@@ -8775,6 +8837,9 @@ export declare const GiftCardHistoryKind: {
|
|
|
8775
8837
|
readonly Blocked: "BLOCKED";
|
|
8776
8838
|
readonly Unblocked: "UNBLOCKED";
|
|
8777
8839
|
readonly SwitchedOn: "SWITCHED_ON";
|
|
8840
|
+
readonly Emailed: "EMAILED";
|
|
8841
|
+
readonly EmailFailed: "EMAIL_FAILED";
|
|
8842
|
+
readonly EmailChanged: "EMAIL_CHANGED";
|
|
8778
8843
|
};
|
|
8779
8844
|
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
8780
8845
|
/**
|
|
@@ -8831,6 +8896,37 @@ export declare const GiftCardIssue: {
|
|
|
8831
8896
|
readonly ByHand: "BY_HAND";
|
|
8832
8897
|
};
|
|
8833
8898
|
export type GiftCardIssue = typeof GiftCardIssue[keyof typeof GiftCardIssue];
|
|
8899
|
+
/**
|
|
8900
|
+
*
|
|
8901
|
+
* @export
|
|
8902
|
+
* @interface GiftCardLastEmailDto
|
|
8903
|
+
*/
|
|
8904
|
+
export interface GiftCardLastEmailDto {
|
|
8905
|
+
/**
|
|
8906
|
+
*
|
|
8907
|
+
* @type {GiftCardEmailKind}
|
|
8908
|
+
* @memberof GiftCardLastEmailDto
|
|
8909
|
+
*/
|
|
8910
|
+
'kind': GiftCardEmailKind;
|
|
8911
|
+
/**
|
|
8912
|
+
*
|
|
8913
|
+
* @type {GiftCardEmailStatus}
|
|
8914
|
+
* @memberof GiftCardLastEmailDto
|
|
8915
|
+
*/
|
|
8916
|
+
'status': GiftCardEmailStatus;
|
|
8917
|
+
/**
|
|
8918
|
+
* The address it goes to
|
|
8919
|
+
* @type {string}
|
|
8920
|
+
* @memberof GiftCardLastEmailDto
|
|
8921
|
+
*/
|
|
8922
|
+
'to': string;
|
|
8923
|
+
/**
|
|
8924
|
+
* When it was sent, else when it last changed, ISO 8601
|
|
8925
|
+
* @type {string}
|
|
8926
|
+
* @memberof GiftCardLastEmailDto
|
|
8927
|
+
*/
|
|
8928
|
+
'at': string;
|
|
8929
|
+
}
|
|
8834
8930
|
/**
|
|
8835
8931
|
*
|
|
8836
8932
|
* @export
|
|
@@ -9286,7 +9382,7 @@ export interface GiftCardSettingsDto {
|
|
|
9286
9382
|
*/
|
|
9287
9383
|
'channels': GiftCardSettingsDtoChannels;
|
|
9288
9384
|
/**
|
|
9289
|
-
* The store\'s own channels that are on and can take gift cards: TILL for its till, ONLINE_STORE for its online store
|
|
9385
|
+
* 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).
|
|
9290
9386
|
* @type {Array<GiftCardChannel>}
|
|
9291
9387
|
* @memberof GiftCardSettingsDto
|
|
9292
9388
|
*/
|
|
@@ -9333,6 +9429,18 @@ export interface GiftCardSettingsDto {
|
|
|
9333
9429
|
* @memberof GiftCardSettingsDto
|
|
9334
9430
|
*/
|
|
9335
9431
|
'imageUrl': string | null;
|
|
9432
|
+
/**
|
|
9433
|
+
* Whether holders are reminded by email 30 and 7 days before their card expires
|
|
9434
|
+
* @type {boolean}
|
|
9435
|
+
* @memberof GiftCardSettingsDto
|
|
9436
|
+
*/
|
|
9437
|
+
'remindBeforeExpiry': boolean;
|
|
9438
|
+
/**
|
|
9439
|
+
* The store\'s own gift card terms, shown in every card email; null for Munchi\'s standard terms
|
|
9440
|
+
* @type {string}
|
|
9441
|
+
* @memberof GiftCardSettingsDto
|
|
9442
|
+
*/
|
|
9443
|
+
'terms': string | null;
|
|
9336
9444
|
}
|
|
9337
9445
|
/**
|
|
9338
9446
|
* Where the store\'s gift cards can be spent
|
|
@@ -9352,6 +9460,18 @@ export interface GiftCardSettingsDtoChannels {
|
|
|
9352
9460
|
* @memberof GiftCardSettingsDtoChannels
|
|
9353
9461
|
*/
|
|
9354
9462
|
'onlineStore': boolean;
|
|
9463
|
+
/**
|
|
9464
|
+
* 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.
|
|
9465
|
+
* @type {boolean}
|
|
9466
|
+
* @memberof GiftCardSettingsDtoChannels
|
|
9467
|
+
*/
|
|
9468
|
+
'kiosk'?: boolean;
|
|
9469
|
+
/**
|
|
9470
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
9471
|
+
* @type {boolean}
|
|
9472
|
+
* @memberof GiftCardSettingsDtoChannels
|
|
9473
|
+
*/
|
|
9474
|
+
'mobileApp'?: boolean;
|
|
9355
9475
|
}
|
|
9356
9476
|
/**
|
|
9357
9477
|
*
|
|
@@ -35834,6 +35954,18 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
35834
35954
|
* @memberof UpdateGiftCardSettingsDto
|
|
35835
35955
|
*/
|
|
35836
35956
|
'imageUrl'?: string | null;
|
|
35957
|
+
/**
|
|
35958
|
+
* Whether holders are reminded by email 30 and 7 days before their card expires. Absent: unchanged.
|
|
35959
|
+
* @type {boolean}
|
|
35960
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
35961
|
+
*/
|
|
35962
|
+
'remindBeforeExpiry'?: boolean;
|
|
35963
|
+
/**
|
|
35964
|
+
* 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.
|
|
35965
|
+
* @type {string}
|
|
35966
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
35967
|
+
*/
|
|
35968
|
+
'terms'?: string | null;
|
|
35837
35969
|
}
|
|
35838
35970
|
/**
|
|
35839
35971
|
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
@@ -35853,6 +35985,18 @@ export interface UpdateGiftCardSettingsDtoChannels {
|
|
|
35853
35985
|
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
35854
35986
|
*/
|
|
35855
35987
|
'onlineStore': boolean;
|
|
35988
|
+
/**
|
|
35989
|
+
* 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.
|
|
35990
|
+
* @type {boolean}
|
|
35991
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
35992
|
+
*/
|
|
35993
|
+
'kiosk'?: boolean;
|
|
35994
|
+
/**
|
|
35995
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
35996
|
+
* @type {boolean}
|
|
35997
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
35998
|
+
*/
|
|
35999
|
+
'mobileApp'?: boolean;
|
|
35856
36000
|
}
|
|
35857
36001
|
/**
|
|
35858
36002
|
*
|
|
@@ -36314,6 +36458,19 @@ export interface UpdateTableStatusDto {
|
|
|
36314
36458
|
*/
|
|
36315
36459
|
'status': TableStatus;
|
|
36316
36460
|
}
|
|
36461
|
+
/**
|
|
36462
|
+
*
|
|
36463
|
+
* @export
|
|
36464
|
+
* @interface UpdateVenueGiftCardDto
|
|
36465
|
+
*/
|
|
36466
|
+
export interface UpdateVenueGiftCardDto {
|
|
36467
|
+
/**
|
|
36468
|
+
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
36469
|
+
* @type {string}
|
|
36470
|
+
* @memberof UpdateVenueGiftCardDto
|
|
36471
|
+
*/
|
|
36472
|
+
'buyerEmail': string | null;
|
|
36473
|
+
}
|
|
36317
36474
|
/**
|
|
36318
36475
|
*
|
|
36319
36476
|
* @export
|
|
@@ -37544,6 +37701,49 @@ export interface VenueGiftCardDetailDto {
|
|
|
37544
37701
|
* @memberof VenueGiftCardDetailDto
|
|
37545
37702
|
*/
|
|
37546
37703
|
'history': Array<GiftCardHistoryEventDto>;
|
|
37704
|
+
/**
|
|
37705
|
+
* The message shown in the card\'s email; null when none
|
|
37706
|
+
* @type {string}
|
|
37707
|
+
* @memberof VenueGiftCardDetailDto
|
|
37708
|
+
*/
|
|
37709
|
+
'message': string | null;
|
|
37710
|
+
/**
|
|
37711
|
+
*
|
|
37712
|
+
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
37713
|
+
* @memberof VenueGiftCardDetailDto
|
|
37714
|
+
*/
|
|
37715
|
+
'lastEmail': VenueGiftCardDetailDtoLastEmail | null;
|
|
37716
|
+
}
|
|
37717
|
+
/**
|
|
37718
|
+
* The card\'s newest email; null when it has none
|
|
37719
|
+
* @export
|
|
37720
|
+
* @interface VenueGiftCardDetailDtoLastEmail
|
|
37721
|
+
*/
|
|
37722
|
+
export interface VenueGiftCardDetailDtoLastEmail {
|
|
37723
|
+
/**
|
|
37724
|
+
*
|
|
37725
|
+
* @type {GiftCardEmailKind}
|
|
37726
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
37727
|
+
*/
|
|
37728
|
+
'kind': GiftCardEmailKind;
|
|
37729
|
+
/**
|
|
37730
|
+
*
|
|
37731
|
+
* @type {GiftCardEmailStatus}
|
|
37732
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
37733
|
+
*/
|
|
37734
|
+
'status': GiftCardEmailStatus;
|
|
37735
|
+
/**
|
|
37736
|
+
* The address it goes to
|
|
37737
|
+
* @type {string}
|
|
37738
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
37739
|
+
*/
|
|
37740
|
+
'to': string;
|
|
37741
|
+
/**
|
|
37742
|
+
* When it was sent, else when it last changed, ISO 8601
|
|
37743
|
+
* @type {string}
|
|
37744
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
37745
|
+
*/
|
|
37746
|
+
'at': string;
|
|
37547
37747
|
}
|
|
37548
37748
|
/**
|
|
37549
37749
|
*
|
|
@@ -43372,7 +43572,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
43372
43572
|
*/
|
|
43373
43573
|
configSaveEpassiCredentials: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43374
43574
|
/**
|
|
43375
|
-
* 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.
|
|
43575
|
+
* 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.
|
|
43376
43576
|
* @summary Create or update a venue
|
|
43377
43577
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43378
43578
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -43430,7 +43630,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
43430
43630
|
*/
|
|
43431
43631
|
configUpsertPaymentOptions: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43432
43632
|
/**
|
|
43433
|
-
* 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
|
|
43633
|
+
* 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.
|
|
43434
43634
|
* @summary Set active provider and upsert its credentials
|
|
43435
43635
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43436
43636
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43450,7 +43650,7 @@ export declare const ConfigManagementApiAxiosParamCreator: (configuration?: Conf
|
|
|
43450
43650
|
*/
|
|
43451
43651
|
configUpsertStripe: (businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43452
43652
|
/**
|
|
43453
|
-
* 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.
|
|
43653
|
+
* 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.
|
|
43454
43654
|
* @summary Create or update a channel\'s Viva config
|
|
43455
43655
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43456
43656
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43515,7 +43715,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
43515
43715
|
*/
|
|
43516
43716
|
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EpassiCredentialsSavedDto>>;
|
|
43517
43717
|
/**
|
|
43518
|
-
* 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.
|
|
43718
|
+
* 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.
|
|
43519
43719
|
* @summary Create or update a venue
|
|
43520
43720
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43521
43721
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -43573,7 +43773,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
43573
43773
|
*/
|
|
43574
43774
|
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
43575
43775
|
/**
|
|
43576
|
-
* 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
|
|
43776
|
+
* 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.
|
|
43577
43777
|
* @summary Set active provider and upsert its credentials
|
|
43578
43778
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43579
43779
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43593,7 +43793,7 @@ export declare const ConfigManagementApiFp: (configuration?: Configuration) => {
|
|
|
43593
43793
|
*/
|
|
43594
43794
|
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ConfigManagementResponseDto>>;
|
|
43595
43795
|
/**
|
|
43596
|
-
* 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.
|
|
43796
|
+
* 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.
|
|
43597
43797
|
* @summary Create or update a channel\'s Viva config
|
|
43598
43798
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43599
43799
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43658,7 +43858,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
43658
43858
|
*/
|
|
43659
43859
|
configSaveEpassiCredentials(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: any): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
43660
43860
|
/**
|
|
43661
|
-
* 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.
|
|
43861
|
+
* 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.
|
|
43662
43862
|
* @summary Create or update a venue
|
|
43663
43863
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43664
43864
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -43716,7 +43916,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
43716
43916
|
*/
|
|
43717
43917
|
configUpsertPaymentOptions(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
43718
43918
|
/**
|
|
43719
|
-
* 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
|
|
43919
|
+
* 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.
|
|
43720
43920
|
* @summary Set active provider and upsert its credentials
|
|
43721
43921
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43722
43922
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43736,7 +43936,7 @@ export declare const ConfigManagementApiFactory: (configuration?: Configuration,
|
|
|
43736
43936
|
*/
|
|
43737
43937
|
configUpsertStripe(businessId: number, xAppX: "Wolt" | "MunchiOnline" | "MunchiKiosk" | "MunchiPos" | "UberEats" | "Foodora" | "Bolt" | "MunchiKioskV2" | "Kiosk" | "WoltStorefront" | "Storefront" | "MunchiPay" | "ResQ", upsertStripeDto: UpsertStripeDto, options?: any): AxiosPromise<ConfigManagementResponseDto>;
|
|
43738
43938
|
/**
|
|
43739
|
-
* 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.
|
|
43939
|
+
* 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.
|
|
43740
43940
|
* @summary Create or update a channel\'s Viva config
|
|
43741
43941
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43742
43942
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43807,7 +44007,7 @@ export interface ConfigManagementApiInterface {
|
|
|
43807
44007
|
*/
|
|
43808
44008
|
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>;
|
|
43809
44009
|
/**
|
|
43810
|
-
* 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.
|
|
44010
|
+
* 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.
|
|
43811
44011
|
* @summary Create or update a venue
|
|
43812
44012
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43813
44013
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -43871,7 +44071,7 @@ export interface ConfigManagementApiInterface {
|
|
|
43871
44071
|
*/
|
|
43872
44072
|
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
43873
44073
|
/**
|
|
43874
|
-
* 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
|
|
44074
|
+
* 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.
|
|
43875
44075
|
* @summary Set active provider and upsert its credentials
|
|
43876
44076
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43877
44077
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43893,7 +44093,7 @@ export interface ConfigManagementApiInterface {
|
|
|
43893
44093
|
*/
|
|
43894
44094
|
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
43895
44095
|
/**
|
|
43896
|
-
* 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.
|
|
44096
|
+
* 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.
|
|
43897
44097
|
* @summary Create or update a channel\'s Viva config
|
|
43898
44098
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43899
44099
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -43966,7 +44166,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
43966
44166
|
*/
|
|
43967
44167
|
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EpassiCredentialsSavedDto, any, {}>>;
|
|
43968
44168
|
/**
|
|
43969
|
-
* 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.
|
|
44169
|
+
* 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.
|
|
43970
44170
|
* @summary Create or update a venue
|
|
43971
44171
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
43972
44172
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -44030,7 +44230,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44030
44230
|
*/
|
|
44031
44231
|
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
44032
44232
|
/**
|
|
44033
|
-
* 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
|
|
44233
|
+
* 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.
|
|
44034
44234
|
* @summary Set active provider and upsert its credentials
|
|
44035
44235
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44036
44236
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -44052,7 +44252,7 @@ export declare class ConfigManagementApi extends BaseAPI implements ConfigManage
|
|
|
44052
44252
|
*/
|
|
44053
44253
|
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ConfigManagementResponseDto, any, {}>>;
|
|
44054
44254
|
/**
|
|
44055
|
-
* 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.
|
|
44255
|
+
* 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.
|
|
44056
44256
|
* @summary Create or update a channel\'s Viva config
|
|
44057
44257
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
44058
44258
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -45864,6 +46064,16 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
45864
46064
|
* @throws {RequiredError}
|
|
45865
46065
|
*/
|
|
45866
46066
|
createVenueGiftCard: (businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46067
|
+
/**
|
|
46068
|
+
* 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.
|
|
46069
|
+
* @summary Send a gift card again to its saved email address
|
|
46070
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46071
|
+
* @param {string} cardId The card\'s id
|
|
46072
|
+
* @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.
|
|
46073
|
+
* @param {*} [options] Override http request option.
|
|
46074
|
+
* @throws {RequiredError}
|
|
46075
|
+
*/
|
|
46076
|
+
emailVenueGiftCard: (businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45867
46077
|
/**
|
|
45868
46078
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
45869
46079
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -45928,6 +46138,16 @@ export declare const GiftCardsApiAxiosParamCreator: (configuration?: Configurati
|
|
|
45928
46138
|
* @throws {RequiredError}
|
|
45929
46139
|
*/
|
|
45930
46140
|
unblockVenueGiftCard: (businessId: number, cardId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
46141
|
+
/**
|
|
46142
|
+
* 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.
|
|
46143
|
+
* @summary Correct a gift card\'s email address
|
|
46144
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46145
|
+
* @param {string} cardId The card\'s id
|
|
46146
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
46147
|
+
* @param {*} [options] Override http request option.
|
|
46148
|
+
* @throws {RequiredError}
|
|
46149
|
+
*/
|
|
46150
|
+
updateVenueGiftCard: (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45931
46151
|
/**
|
|
45932
46152
|
* 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.
|
|
45933
46153
|
* @summary Change a store\'s gift card settings
|
|
@@ -45972,6 +46192,16 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
45972
46192
|
* @throws {RequiredError}
|
|
45973
46193
|
*/
|
|
45974
46194
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46195
|
+
/**
|
|
46196
|
+
* 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.
|
|
46197
|
+
* @summary Send a gift card again to its saved email address
|
|
46198
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46199
|
+
* @param {string} cardId The card\'s id
|
|
46200
|
+
* @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.
|
|
46201
|
+
* @param {*} [options] Override http request option.
|
|
46202
|
+
* @throws {RequiredError}
|
|
46203
|
+
*/
|
|
46204
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
45975
46205
|
/**
|
|
45976
46206
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
45977
46207
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -46036,6 +46266,16 @@ export declare const GiftCardsApiFp: (configuration?: Configuration) => {
|
|
|
46036
46266
|
* @throws {RequiredError}
|
|
46037
46267
|
*/
|
|
46038
46268
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46269
|
+
/**
|
|
46270
|
+
* 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.
|
|
46271
|
+
* @summary Correct a gift card\'s email address
|
|
46272
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46273
|
+
* @param {string} cardId The card\'s id
|
|
46274
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
46275
|
+
* @param {*} [options] Override http request option.
|
|
46276
|
+
* @throws {RequiredError}
|
|
46277
|
+
*/
|
|
46278
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>>;
|
|
46039
46279
|
/**
|
|
46040
46280
|
* 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.
|
|
46041
46281
|
* @summary Change a store\'s gift card settings
|
|
@@ -46080,6 +46320,16 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46080
46320
|
* @throws {RequiredError}
|
|
46081
46321
|
*/
|
|
46082
46322
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46323
|
+
/**
|
|
46324
|
+
* 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.
|
|
46325
|
+
* @summary Send a gift card again to its saved email address
|
|
46326
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46327
|
+
* @param {string} cardId The card\'s id
|
|
46328
|
+
* @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.
|
|
46329
|
+
* @param {*} [options] Override http request option.
|
|
46330
|
+
* @throws {RequiredError}
|
|
46331
|
+
*/
|
|
46332
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46083
46333
|
/**
|
|
46084
46334
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
46085
46335
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -46144,6 +46394,16 @@ export declare const GiftCardsApiFactory: (configuration?: Configuration, basePa
|
|
|
46144
46394
|
* @throws {RequiredError}
|
|
46145
46395
|
*/
|
|
46146
46396
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46397
|
+
/**
|
|
46398
|
+
* 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.
|
|
46399
|
+
* @summary Correct a gift card\'s email address
|
|
46400
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46401
|
+
* @param {string} cardId The card\'s id
|
|
46402
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
46403
|
+
* @param {*} [options] Override http request option.
|
|
46404
|
+
* @throws {RequiredError}
|
|
46405
|
+
*/
|
|
46406
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46147
46407
|
/**
|
|
46148
46408
|
* 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.
|
|
46149
46409
|
* @summary Change a store\'s gift card settings
|
|
@@ -46192,6 +46452,17 @@ export interface GiftCardsApiInterface {
|
|
|
46192
46452
|
* @memberof GiftCardsApiInterface
|
|
46193
46453
|
*/
|
|
46194
46454
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46455
|
+
/**
|
|
46456
|
+
* 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.
|
|
46457
|
+
* @summary Send a gift card again to its saved email address
|
|
46458
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46459
|
+
* @param {string} cardId The card\'s id
|
|
46460
|
+
* @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.
|
|
46461
|
+
* @param {*} [options] Override http request option.
|
|
46462
|
+
* @throws {RequiredError}
|
|
46463
|
+
* @memberof GiftCardsApiInterface
|
|
46464
|
+
*/
|
|
46465
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46195
46466
|
/**
|
|
46196
46467
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
46197
46468
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -46262,6 +46533,17 @@ export interface GiftCardsApiInterface {
|
|
|
46262
46533
|
* @memberof GiftCardsApiInterface
|
|
46263
46534
|
*/
|
|
46264
46535
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46536
|
+
/**
|
|
46537
|
+
* 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.
|
|
46538
|
+
* @summary Correct a gift card\'s email address
|
|
46539
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46540
|
+
* @param {string} cardId The card\'s id
|
|
46541
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
46542
|
+
* @param {*} [options] Override http request option.
|
|
46543
|
+
* @throws {RequiredError}
|
|
46544
|
+
* @memberof GiftCardsApiInterface
|
|
46545
|
+
*/
|
|
46546
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
46265
46547
|
/**
|
|
46266
46548
|
* 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.
|
|
46267
46549
|
* @summary Change a store\'s gift card settings
|
|
@@ -46312,6 +46594,17 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46312
46594
|
* @memberof GiftCardsApi
|
|
46313
46595
|
*/
|
|
46314
46596
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46597
|
+
/**
|
|
46598
|
+
* 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.
|
|
46599
|
+
* @summary Send a gift card again to its saved email address
|
|
46600
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46601
|
+
* @param {string} cardId The card\'s id
|
|
46602
|
+
* @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.
|
|
46603
|
+
* @param {*} [options] Override http request option.
|
|
46604
|
+
* @throws {RequiredError}
|
|
46605
|
+
* @memberof GiftCardsApi
|
|
46606
|
+
*/
|
|
46607
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46315
46608
|
/**
|
|
46316
46609
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
46317
46610
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -46382,6 +46675,17 @@ export declare class GiftCardsApi extends BaseAPI implements GiftCardsApiInterfa
|
|
|
46382
46675
|
* @memberof GiftCardsApi
|
|
46383
46676
|
*/
|
|
46384
46677
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46678
|
+
/**
|
|
46679
|
+
* 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.
|
|
46680
|
+
* @summary Correct a gift card\'s email address
|
|
46681
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
46682
|
+
* @param {string} cardId The card\'s id
|
|
46683
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
46684
|
+
* @param {*} [options] Override http request option.
|
|
46685
|
+
* @throws {RequiredError}
|
|
46686
|
+
* @memberof GiftCardsApi
|
|
46687
|
+
*/
|
|
46688
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<VenueGiftCardDetailDto, any, {}>>;
|
|
46385
46689
|
/**
|
|
46386
46690
|
* 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.
|
|
46387
46691
|
* @summary Change a store\'s gift card settings
|