@munchi_oy/core 2.13.0 → 2.14.3
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 +332 -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 +443 -18
- package/package.json +13 -15
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -5373,6 +5373,18 @@ 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;
|
|
5376
5388
|
/**
|
|
5377
5389
|
* The buyer\'s email, at most 254 characters once the spaces around it are dropped. Absent or only spaces: none. Answered as buyerEmail.
|
|
5378
5390
|
* @type {string}
|
|
@@ -8874,7 +8886,9 @@ export interface GiftCardAttentionDtoStalePending {
|
|
|
8874
8886
|
|
|
8875
8887
|
export const GiftCardChannel = {
|
|
8876
8888
|
Till: 'TILL',
|
|
8877
|
-
OnlineStore: 'ONLINE_STORE'
|
|
8889
|
+
OnlineStore: 'ONLINE_STORE',
|
|
8890
|
+
Kiosk: 'KIOSK',
|
|
8891
|
+
MobileApp: 'MOBILE_APP'
|
|
8878
8892
|
} as const;
|
|
8879
8893
|
|
|
8880
8894
|
export type GiftCardChannel = typeof GiftCardChannel[keyof typeof GiftCardChannel];
|
|
@@ -8898,6 +8912,18 @@ export interface GiftCardChannelsDto {
|
|
|
8898
8912
|
* @memberof GiftCardChannelsDto
|
|
8899
8913
|
*/
|
|
8900
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;
|
|
8901
8927
|
}
|
|
8902
8928
|
/**
|
|
8903
8929
|
*
|
|
@@ -8987,6 +9013,38 @@ export interface GiftCardCredentialsViewDto {
|
|
|
8987
9013
|
*/
|
|
8988
9014
|
'uniquePosDeviceId': string | null;
|
|
8989
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
|
+
|
|
8990
9048
|
/**
|
|
8991
9049
|
*
|
|
8992
9050
|
* @export
|
|
@@ -9071,6 +9129,18 @@ export interface GiftCardHistoryEventDto {
|
|
|
9071
9129
|
* @memberof GiftCardHistoryEventDto
|
|
9072
9130
|
*/
|
|
9073
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;
|
|
9074
9144
|
/**
|
|
9075
9145
|
* When it happened, ISO 8601
|
|
9076
9146
|
* @type {string}
|
|
@@ -9094,7 +9164,10 @@ export const GiftCardHistoryKind = {
|
|
|
9094
9164
|
Corrected: 'CORRECTED',
|
|
9095
9165
|
Blocked: 'BLOCKED',
|
|
9096
9166
|
Unblocked: 'UNBLOCKED',
|
|
9097
|
-
SwitchedOn: 'SWITCHED_ON'
|
|
9167
|
+
SwitchedOn: 'SWITCHED_ON',
|
|
9168
|
+
Emailed: 'EMAILED',
|
|
9169
|
+
EmailFailed: 'EMAIL_FAILED',
|
|
9170
|
+
EmailChanged: 'EMAIL_CHANGED'
|
|
9098
9171
|
} as const;
|
|
9099
9172
|
|
|
9100
9173
|
export type GiftCardHistoryKind = typeof GiftCardHistoryKind[keyof typeof GiftCardHistoryKind];
|
|
@@ -9158,6 +9231,39 @@ export const GiftCardIssue = {
|
|
|
9158
9231
|
export type GiftCardIssue = typeof GiftCardIssue[keyof typeof GiftCardIssue];
|
|
9159
9232
|
|
|
9160
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
|
+
|
|
9161
9267
|
/**
|
|
9162
9268
|
*
|
|
9163
9269
|
* @export
|
|
@@ -9617,7 +9723,7 @@ export interface GiftCardSettingsDto {
|
|
|
9617
9723
|
*/
|
|
9618
9724
|
'channels': GiftCardSettingsDtoChannels;
|
|
9619
9725
|
/**
|
|
9620
|
-
* 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).
|
|
9621
9727
|
* @type {Array<GiftCardChannel>}
|
|
9622
9728
|
* @memberof GiftCardSettingsDto
|
|
9623
9729
|
*/
|
|
@@ -9664,6 +9770,18 @@ export interface GiftCardSettingsDto {
|
|
|
9664
9770
|
* @memberof GiftCardSettingsDto
|
|
9665
9771
|
*/
|
|
9666
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;
|
|
9667
9785
|
}
|
|
9668
9786
|
/**
|
|
9669
9787
|
* Where the store\'s gift cards can be spent
|
|
@@ -9683,6 +9801,18 @@ export interface GiftCardSettingsDtoChannels {
|
|
|
9683
9801
|
* @memberof GiftCardSettingsDtoChannels
|
|
9684
9802
|
*/
|
|
9685
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;
|
|
9686
9816
|
}
|
|
9687
9817
|
/**
|
|
9688
9818
|
*
|
|
@@ -25298,7 +25428,15 @@ export interface ProvidersConfigResponseDtoViva {
|
|
|
25298
25428
|
* @memberof ProvidersConfigResponseDtoViva
|
|
25299
25429
|
*/
|
|
25300
25430
|
'additionalAmount': number | null;
|
|
25431
|
+
/**
|
|
25432
|
+
*
|
|
25433
|
+
* @type {PaymentSurchargePaidBy}
|
|
25434
|
+
* @memberof ProvidersConfigResponseDtoViva
|
|
25435
|
+
*/
|
|
25436
|
+
'surchargePaidBy': PaymentSurchargePaidBy;
|
|
25301
25437
|
}
|
|
25438
|
+
|
|
25439
|
+
|
|
25302
25440
|
/**
|
|
25303
25441
|
* The channel\'s Worldline settings; null when it has none.
|
|
25304
25442
|
* @export
|
|
@@ -36910,6 +37048,18 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36910
37048
|
* @memberof UpdateGiftCardSettingsDto
|
|
36911
37049
|
*/
|
|
36912
37050
|
'imageUrl'?: string | null;
|
|
37051
|
+
/**
|
|
37052
|
+
* Whether holders are reminded by email 30 and 7 days before their card expires. Absent: unchanged.
|
|
37053
|
+
* @type {boolean}
|
|
37054
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
37055
|
+
*/
|
|
37056
|
+
'remindBeforeExpiry'?: boolean;
|
|
37057
|
+
/**
|
|
37058
|
+
* 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.
|
|
37059
|
+
* @type {string}
|
|
37060
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
37061
|
+
*/
|
|
37062
|
+
'terms'?: string | null;
|
|
36913
37063
|
}
|
|
36914
37064
|
/**
|
|
36915
37065
|
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
@@ -36929,6 +37079,18 @@ export interface UpdateGiftCardSettingsDtoChannels {
|
|
|
36929
37079
|
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
36930
37080
|
*/
|
|
36931
37081
|
'onlineStore': boolean;
|
|
37082
|
+
/**
|
|
37083
|
+
* 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.
|
|
37084
|
+
* @type {boolean}
|
|
37085
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
37086
|
+
*/
|
|
37087
|
+
'kiosk'?: boolean;
|
|
37088
|
+
/**
|
|
37089
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
37090
|
+
* @type {boolean}
|
|
37091
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
37092
|
+
*/
|
|
37093
|
+
'mobileApp'?: boolean;
|
|
36932
37094
|
}
|
|
36933
37095
|
/**
|
|
36934
37096
|
*
|
|
@@ -37398,6 +37560,19 @@ export interface UpdateTableStatusDto {
|
|
|
37398
37560
|
}
|
|
37399
37561
|
|
|
37400
37562
|
|
|
37563
|
+
/**
|
|
37564
|
+
*
|
|
37565
|
+
* @export
|
|
37566
|
+
* @interface UpdateVenueGiftCardDto
|
|
37567
|
+
*/
|
|
37568
|
+
export interface UpdateVenueGiftCardDto {
|
|
37569
|
+
/**
|
|
37570
|
+
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
37571
|
+
* @type {string}
|
|
37572
|
+
* @memberof UpdateVenueGiftCardDto
|
|
37573
|
+
*/
|
|
37574
|
+
'buyerEmail': string | null;
|
|
37575
|
+
}
|
|
37401
37576
|
/**
|
|
37402
37577
|
*
|
|
37403
37578
|
* @export
|
|
@@ -38650,6 +38825,51 @@ export interface VenueGiftCardDetailDto {
|
|
|
38650
38825
|
* @memberof VenueGiftCardDetailDto
|
|
38651
38826
|
*/
|
|
38652
38827
|
'history': Array<GiftCardHistoryEventDto>;
|
|
38828
|
+
/**
|
|
38829
|
+
* The message shown in the card\'s email; null when none
|
|
38830
|
+
* @type {string}
|
|
38831
|
+
* @memberof VenueGiftCardDetailDto
|
|
38832
|
+
*/
|
|
38833
|
+
'message': string | null;
|
|
38834
|
+
/**
|
|
38835
|
+
*
|
|
38836
|
+
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
38837
|
+
* @memberof VenueGiftCardDetailDto
|
|
38838
|
+
*/
|
|
38839
|
+
'lastEmail': VenueGiftCardDetailDtoLastEmail | null;
|
|
38840
|
+
}
|
|
38841
|
+
|
|
38842
|
+
|
|
38843
|
+
/**
|
|
38844
|
+
* The card\'s newest email; null when it has none
|
|
38845
|
+
* @export
|
|
38846
|
+
* @interface VenueGiftCardDetailDtoLastEmail
|
|
38847
|
+
*/
|
|
38848
|
+
export interface VenueGiftCardDetailDtoLastEmail {
|
|
38849
|
+
/**
|
|
38850
|
+
*
|
|
38851
|
+
* @type {GiftCardEmailKind}
|
|
38852
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38853
|
+
*/
|
|
38854
|
+
'kind': GiftCardEmailKind;
|
|
38855
|
+
/**
|
|
38856
|
+
*
|
|
38857
|
+
* @type {GiftCardEmailStatus}
|
|
38858
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38859
|
+
*/
|
|
38860
|
+
'status': GiftCardEmailStatus;
|
|
38861
|
+
/**
|
|
38862
|
+
* The address it goes to
|
|
38863
|
+
* @type {string}
|
|
38864
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38865
|
+
*/
|
|
38866
|
+
'to': string;
|
|
38867
|
+
/**
|
|
38868
|
+
* When it was sent, else when it last changed, ISO 8601
|
|
38869
|
+
* @type {string}
|
|
38870
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38871
|
+
*/
|
|
38872
|
+
'at': string;
|
|
38653
38873
|
}
|
|
38654
38874
|
|
|
38655
38875
|
|
|
@@ -39593,7 +39813,15 @@ export interface VivaConfigResponseDto {
|
|
|
39593
39813
|
* @memberof VivaConfigResponseDto
|
|
39594
39814
|
*/
|
|
39595
39815
|
'additionalAmount': number | null;
|
|
39816
|
+
/**
|
|
39817
|
+
*
|
|
39818
|
+
* @type {PaymentSurchargePaidBy}
|
|
39819
|
+
* @memberof VivaConfigResponseDto
|
|
39820
|
+
*/
|
|
39821
|
+
'surchargePaidBy': PaymentSurchargePaidBy;
|
|
39596
39822
|
}
|
|
39823
|
+
|
|
39824
|
+
|
|
39597
39825
|
/**
|
|
39598
39826
|
*
|
|
39599
39827
|
* @export
|
|
@@ -46530,7 +46758,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46530
46758
|
};
|
|
46531
46759
|
},
|
|
46532
46760
|
/**
|
|
46533
|
-
* 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.
|
|
46761
|
+
* 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.
|
|
46534
46762
|
* @summary Create or update a venue
|
|
46535
46763
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46536
46764
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -46822,7 +47050,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46822
47050
|
};
|
|
46823
47051
|
},
|
|
46824
47052
|
/**
|
|
46825
|
-
* 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
|
|
47053
|
+
* 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.
|
|
46826
47054
|
* @summary Set active provider and upsert its credentials
|
|
46827
47055
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46828
47056
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -46924,7 +47152,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46924
47152
|
};
|
|
46925
47153
|
},
|
|
46926
47154
|
/**
|
|
46927
|
-
* 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.
|
|
47155
|
+
* 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.
|
|
46928
47156
|
* @summary Create or update a channel\'s Viva config
|
|
46929
47157
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46930
47158
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47049,7 +47277,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
47049
47277
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47050
47278
|
},
|
|
47051
47279
|
/**
|
|
47052
|
-
* 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.
|
|
47280
|
+
* 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.
|
|
47053
47281
|
* @summary Create or update a venue
|
|
47054
47282
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47055
47283
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47125,7 +47353,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
47125
47353
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47126
47354
|
},
|
|
47127
47355
|
/**
|
|
47128
|
-
* 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
|
|
47356
|
+
* 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.
|
|
47129
47357
|
* @summary Set active provider and upsert its credentials
|
|
47130
47358
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47131
47359
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47151,7 +47379,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
47151
47379
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47152
47380
|
},
|
|
47153
47381
|
/**
|
|
47154
|
-
* 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.
|
|
47382
|
+
* 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.
|
|
47155
47383
|
* @summary Create or update a channel\'s Viva config
|
|
47156
47384
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47157
47385
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47233,7 +47461,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
47233
47461
|
return localVarFp.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(axios, basePath));
|
|
47234
47462
|
},
|
|
47235
47463
|
/**
|
|
47236
|
-
* 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.
|
|
47464
|
+
* 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.
|
|
47237
47465
|
* @summary Create or update a venue
|
|
47238
47466
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47239
47467
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47303,7 +47531,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
47303
47531
|
return localVarFp.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(axios, basePath));
|
|
47304
47532
|
},
|
|
47305
47533
|
/**
|
|
47306
|
-
* 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
|
|
47534
|
+
* 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.
|
|
47307
47535
|
* @summary Set active provider and upsert its credentials
|
|
47308
47536
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47309
47537
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47327,7 +47555,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
47327
47555
|
return localVarFp.configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(axios, basePath));
|
|
47328
47556
|
},
|
|
47329
47557
|
/**
|
|
47330
|
-
* 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.
|
|
47558
|
+
* 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.
|
|
47331
47559
|
* @summary Create or update a channel\'s Viva config
|
|
47332
47560
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47333
47561
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47407,7 +47635,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47407
47635
|
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>;
|
|
47408
47636
|
|
|
47409
47637
|
/**
|
|
47410
|
-
* 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.
|
|
47638
|
+
* 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.
|
|
47411
47639
|
* @summary Create or update a venue
|
|
47412
47640
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47413
47641
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47477,7 +47705,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47477
47705
|
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
47478
47706
|
|
|
47479
47707
|
/**
|
|
47480
|
-
* 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
|
|
47708
|
+
* 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.
|
|
47481
47709
|
* @summary Set active provider and upsert its credentials
|
|
47482
47710
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47483
47711
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47501,7 +47729,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47501
47729
|
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
47502
47730
|
|
|
47503
47731
|
/**
|
|
47504
|
-
* 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.
|
|
47732
|
+
* 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.
|
|
47505
47733
|
* @summary Create or update a channel\'s Viva config
|
|
47506
47734
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47507
47735
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47591,7 +47819,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47591
47819
|
}
|
|
47592
47820
|
|
|
47593
47821
|
/**
|
|
47594
|
-
* 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.
|
|
47822
|
+
* 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.
|
|
47595
47823
|
* @summary Create or update a venue
|
|
47596
47824
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47597
47825
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47673,7 +47901,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47673
47901
|
}
|
|
47674
47902
|
|
|
47675
47903
|
/**
|
|
47676
|
-
* 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
|
|
47904
|
+
* 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.
|
|
47677
47905
|
* @summary Set active provider and upsert its credentials
|
|
47678
47906
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47679
47907
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47701,7 +47929,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47701
47929
|
}
|
|
47702
47930
|
|
|
47703
47931
|
/**
|
|
47704
|
-
* 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.
|
|
47932
|
+
* 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.
|
|
47705
47933
|
* @summary Create or update a channel\'s Viva config
|
|
47706
47934
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47707
47935
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -51141,6 +51369,53 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51141
51369
|
options: localVarRequestOptions,
|
|
51142
51370
|
};
|
|
51143
51371
|
},
|
|
51372
|
+
/**
|
|
51373
|
+
* 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.
|
|
51374
|
+
* @summary Send a gift card again to its saved email address
|
|
51375
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51376
|
+
* @param {string} cardId The card\'s id
|
|
51377
|
+
* @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.
|
|
51378
|
+
* @param {*} [options] Override http request option.
|
|
51379
|
+
* @throws {RequiredError}
|
|
51380
|
+
*/
|
|
51381
|
+
emailVenueGiftCard: async (businessId: number, cardId: string, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51382
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51383
|
+
assertParamExists('emailVenueGiftCard', 'businessId', businessId)
|
|
51384
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
51385
|
+
assertParamExists('emailVenueGiftCard', 'cardId', cardId)
|
|
51386
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}/email`
|
|
51387
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
51388
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
51389
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51390
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51391
|
+
let baseOptions;
|
|
51392
|
+
if (configuration) {
|
|
51393
|
+
baseOptions = configuration.baseOptions;
|
|
51394
|
+
}
|
|
51395
|
+
|
|
51396
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
51397
|
+
const localVarHeaderParameter = {} as any;
|
|
51398
|
+
const localVarQueryParameter = {} as any;
|
|
51399
|
+
|
|
51400
|
+
// authentication JWT-auth required
|
|
51401
|
+
// http bearer authentication required
|
|
51402
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51403
|
+
|
|
51404
|
+
if (xIdempotencyKey != null) {
|
|
51405
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
51406
|
+
}
|
|
51407
|
+
|
|
51408
|
+
|
|
51409
|
+
|
|
51410
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51411
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51412
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51413
|
+
|
|
51414
|
+
return {
|
|
51415
|
+
url: toPathString(localVarUrlObj),
|
|
51416
|
+
options: localVarRequestOptions,
|
|
51417
|
+
};
|
|
51418
|
+
},
|
|
51144
51419
|
/**
|
|
51145
51420
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51146
51421
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51455,6 +51730,54 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51455
51730
|
options: localVarRequestOptions,
|
|
51456
51731
|
};
|
|
51457
51732
|
},
|
|
51733
|
+
/**
|
|
51734
|
+
* 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.
|
|
51735
|
+
* @summary Correct a gift card\'s email address
|
|
51736
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51737
|
+
* @param {string} cardId The card\'s id
|
|
51738
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
51739
|
+
* @param {*} [options] Override http request option.
|
|
51740
|
+
* @throws {RequiredError}
|
|
51741
|
+
*/
|
|
51742
|
+
updateVenueGiftCard: async (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51743
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51744
|
+
assertParamExists('updateVenueGiftCard', 'businessId', businessId)
|
|
51745
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
51746
|
+
assertParamExists('updateVenueGiftCard', 'cardId', cardId)
|
|
51747
|
+
// verify required parameter 'updateVenueGiftCardDto' is not null or undefined
|
|
51748
|
+
assertParamExists('updateVenueGiftCard', 'updateVenueGiftCardDto', updateVenueGiftCardDto)
|
|
51749
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}`
|
|
51750
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
51751
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
51752
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51753
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51754
|
+
let baseOptions;
|
|
51755
|
+
if (configuration) {
|
|
51756
|
+
baseOptions = configuration.baseOptions;
|
|
51757
|
+
}
|
|
51758
|
+
|
|
51759
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
51760
|
+
const localVarHeaderParameter = {} as any;
|
|
51761
|
+
const localVarQueryParameter = {} as any;
|
|
51762
|
+
|
|
51763
|
+
// authentication JWT-auth required
|
|
51764
|
+
// http bearer authentication required
|
|
51765
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51766
|
+
|
|
51767
|
+
|
|
51768
|
+
|
|
51769
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
51770
|
+
|
|
51771
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51772
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51773
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51774
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateVenueGiftCardDto, localVarRequestOptions, configuration)
|
|
51775
|
+
|
|
51776
|
+
return {
|
|
51777
|
+
url: toPathString(localVarUrlObj),
|
|
51778
|
+
options: localVarRequestOptions,
|
|
51779
|
+
};
|
|
51780
|
+
},
|
|
51458
51781
|
/**
|
|
51459
51782
|
* 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.
|
|
51460
51783
|
* @summary Change a store\'s gift card settings
|
|
@@ -51547,6 +51870,19 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51547
51870
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options);
|
|
51548
51871
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51549
51872
|
},
|
|
51873
|
+
/**
|
|
51874
|
+
* 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.
|
|
51875
|
+
* @summary Send a gift card again to its saved email address
|
|
51876
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51877
|
+
* @param {string} cardId The card\'s id
|
|
51878
|
+
* @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.
|
|
51879
|
+
* @param {*} [options] Override http request option.
|
|
51880
|
+
* @throws {RequiredError}
|
|
51881
|
+
*/
|
|
51882
|
+
async emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51883
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options);
|
|
51884
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51885
|
+
},
|
|
51550
51886
|
/**
|
|
51551
51887
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51552
51888
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51629,6 +51965,19 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51629
51965
|
const localVarAxiosArgs = await localVarAxiosParamCreator.unblockVenueGiftCard(businessId, cardId, options);
|
|
51630
51966
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51631
51967
|
},
|
|
51968
|
+
/**
|
|
51969
|
+
* 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.
|
|
51970
|
+
* @summary Correct a gift card\'s email address
|
|
51971
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51972
|
+
* @param {string} cardId The card\'s id
|
|
51973
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
51974
|
+
* @param {*} [options] Override http request option.
|
|
51975
|
+
* @throws {RequiredError}
|
|
51976
|
+
*/
|
|
51977
|
+
async updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51978
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options);
|
|
51979
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51980
|
+
},
|
|
51632
51981
|
/**
|
|
51633
51982
|
* 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.
|
|
51634
51983
|
* @summary Change a store\'s gift card settings
|
|
@@ -51686,6 +52035,18 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51686
52035
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51687
52036
|
return localVarFp.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
51688
52037
|
},
|
|
52038
|
+
/**
|
|
52039
|
+
* 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.
|
|
52040
|
+
* @summary Send a gift card again to its saved email address
|
|
52041
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52042
|
+
* @param {string} cardId The card\'s id
|
|
52043
|
+
* @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.
|
|
52044
|
+
* @param {*} [options] Override http request option.
|
|
52045
|
+
* @throws {RequiredError}
|
|
52046
|
+
*/
|
|
52047
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
52048
|
+
return localVarFp.emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
52049
|
+
},
|
|
51689
52050
|
/**
|
|
51690
52051
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51691
52052
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51762,6 +52123,18 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51762
52123
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51763
52124
|
return localVarFp.unblockVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51764
52125
|
},
|
|
52126
|
+
/**
|
|
52127
|
+
* 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.
|
|
52128
|
+
* @summary Correct a gift card\'s email address
|
|
52129
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52130
|
+
* @param {string} cardId The card\'s id
|
|
52131
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52132
|
+
* @param {*} [options] Override http request option.
|
|
52133
|
+
* @throws {RequiredError}
|
|
52134
|
+
*/
|
|
52135
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
52136
|
+
return localVarFp.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(axios, basePath));
|
|
52137
|
+
},
|
|
51765
52138
|
/**
|
|
51766
52139
|
* 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.
|
|
51767
52140
|
* @summary Change a store\'s gift card settings
|
|
@@ -51817,6 +52190,18 @@ export interface GiftCardsApiInterface {
|
|
|
51817
52190
|
*/
|
|
51818
52191
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51819
52192
|
|
|
52193
|
+
/**
|
|
52194
|
+
* 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.
|
|
52195
|
+
* @summary Send a gift card again to its saved email address
|
|
52196
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52197
|
+
* @param {string} cardId The card\'s id
|
|
52198
|
+
* @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.
|
|
52199
|
+
* @param {*} [options] Override http request option.
|
|
52200
|
+
* @throws {RequiredError}
|
|
52201
|
+
* @memberof GiftCardsApiInterface
|
|
52202
|
+
*/
|
|
52203
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52204
|
+
|
|
51820
52205
|
/**
|
|
51821
52206
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51822
52207
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51893,6 +52278,18 @@ export interface GiftCardsApiInterface {
|
|
|
51893
52278
|
*/
|
|
51894
52279
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51895
52280
|
|
|
52281
|
+
/**
|
|
52282
|
+
* 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.
|
|
52283
|
+
* @summary Correct a gift card\'s email address
|
|
52284
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52285
|
+
* @param {string} cardId The card\'s id
|
|
52286
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52287
|
+
* @param {*} [options] Override http request option.
|
|
52288
|
+
* @throws {RequiredError}
|
|
52289
|
+
* @memberof GiftCardsApiInterface
|
|
52290
|
+
*/
|
|
52291
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52292
|
+
|
|
51896
52293
|
/**
|
|
51897
52294
|
* 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.
|
|
51898
52295
|
* @summary Change a store\'s gift card settings
|
|
@@ -51954,6 +52351,20 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51954
52351
|
return GiftCardsApiFp(this.configuration).createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
51955
52352
|
}
|
|
51956
52353
|
|
|
52354
|
+
/**
|
|
52355
|
+
* 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.
|
|
52356
|
+
* @summary Send a gift card again to its saved email address
|
|
52357
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52358
|
+
* @param {string} cardId The card\'s id
|
|
52359
|
+
* @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.
|
|
52360
|
+
* @param {*} [options] Override http request option.
|
|
52361
|
+
* @throws {RequiredError}
|
|
52362
|
+
* @memberof GiftCardsApi
|
|
52363
|
+
*/
|
|
52364
|
+
public emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
52365
|
+
return GiftCardsApiFp(this.configuration).emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
52366
|
+
}
|
|
52367
|
+
|
|
51957
52368
|
/**
|
|
51958
52369
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51959
52370
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -52042,6 +52453,20 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52042
52453
|
return GiftCardsApiFp(this.configuration).unblockVenueGiftCard(businessId, cardId, options).then((request) => request(this.axios, this.basePath));
|
|
52043
52454
|
}
|
|
52044
52455
|
|
|
52456
|
+
/**
|
|
52457
|
+
* 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.
|
|
52458
|
+
* @summary Correct a gift card\'s email address
|
|
52459
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52460
|
+
* @param {string} cardId The card\'s id
|
|
52461
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52462
|
+
* @param {*} [options] Override http request option.
|
|
52463
|
+
* @throws {RequiredError}
|
|
52464
|
+
* @memberof GiftCardsApi
|
|
52465
|
+
*/
|
|
52466
|
+
public updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) {
|
|
52467
|
+
return GiftCardsApiFp(this.configuration).updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
52468
|
+
}
|
|
52469
|
+
|
|
52045
52470
|
/**
|
|
52046
52471
|
* 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.
|
|
52047
52472
|
* @summary Change a store\'s gift card settings
|