@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/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
|
*
|
|
@@ -36910,6 +37040,18 @@ export interface UpdateGiftCardSettingsDto {
|
|
|
36910
37040
|
* @memberof UpdateGiftCardSettingsDto
|
|
36911
37041
|
*/
|
|
36912
37042
|
'imageUrl'?: string | null;
|
|
37043
|
+
/**
|
|
37044
|
+
* Whether holders are reminded by email 30 and 7 days before their card expires. Absent: unchanged.
|
|
37045
|
+
* @type {boolean}
|
|
37046
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
37047
|
+
*/
|
|
37048
|
+
'remindBeforeExpiry'?: boolean;
|
|
37049
|
+
/**
|
|
37050
|
+
* The store\'s own gift card terms, 1 to 5000 characters, shown in every card email, or null for Munchi\'s standard terms. Absent: unchanged.
|
|
37051
|
+
* @type {string}
|
|
37052
|
+
* @memberof UpdateGiftCardSettingsDto
|
|
37053
|
+
*/
|
|
37054
|
+
'terms'?: string | null;
|
|
36913
37055
|
}
|
|
36914
37056
|
/**
|
|
36915
37057
|
* Where the store\'s gift cards can be spent, both channels. Absent: unchanged.
|
|
@@ -36929,6 +37071,18 @@ export interface UpdateGiftCardSettingsDtoChannels {
|
|
|
36929
37071
|
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
36930
37072
|
*/
|
|
36931
37073
|
'onlineStore': boolean;
|
|
37074
|
+
/**
|
|
37075
|
+
* Whether the store\'s kiosk takes gift cards. Always answered; absent in a change: unchanged, so a dashboard that sends only till and onlineStore keeps working.
|
|
37076
|
+
* @type {boolean}
|
|
37077
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
37078
|
+
*/
|
|
37079
|
+
'kiosk'?: boolean;
|
|
37080
|
+
/**
|
|
37081
|
+
* Whether the store\'s mobile app takes gift cards. Always answered; absent in a change: unchanged.
|
|
37082
|
+
* @type {boolean}
|
|
37083
|
+
* @memberof UpdateGiftCardSettingsDtoChannels
|
|
37084
|
+
*/
|
|
37085
|
+
'mobileApp'?: boolean;
|
|
36932
37086
|
}
|
|
36933
37087
|
/**
|
|
36934
37088
|
*
|
|
@@ -37398,6 +37552,19 @@ export interface UpdateTableStatusDto {
|
|
|
37398
37552
|
}
|
|
37399
37553
|
|
|
37400
37554
|
|
|
37555
|
+
/**
|
|
37556
|
+
*
|
|
37557
|
+
* @export
|
|
37558
|
+
* @interface UpdateVenueGiftCardDto
|
|
37559
|
+
*/
|
|
37560
|
+
export interface UpdateVenueGiftCardDto {
|
|
37561
|
+
/**
|
|
37562
|
+
* The card\'s email address, at most 254 characters once the spaces around it are dropped, or null to remove it. Nothing is sent.
|
|
37563
|
+
* @type {string}
|
|
37564
|
+
* @memberof UpdateVenueGiftCardDto
|
|
37565
|
+
*/
|
|
37566
|
+
'buyerEmail': string | null;
|
|
37567
|
+
}
|
|
37401
37568
|
/**
|
|
37402
37569
|
*
|
|
37403
37570
|
* @export
|
|
@@ -38650,6 +38817,51 @@ export interface VenueGiftCardDetailDto {
|
|
|
38650
38817
|
* @memberof VenueGiftCardDetailDto
|
|
38651
38818
|
*/
|
|
38652
38819
|
'history': Array<GiftCardHistoryEventDto>;
|
|
38820
|
+
/**
|
|
38821
|
+
* The message shown in the card\'s email; null when none
|
|
38822
|
+
* @type {string}
|
|
38823
|
+
* @memberof VenueGiftCardDetailDto
|
|
38824
|
+
*/
|
|
38825
|
+
'message': string | null;
|
|
38826
|
+
/**
|
|
38827
|
+
*
|
|
38828
|
+
* @type {VenueGiftCardDetailDtoLastEmail}
|
|
38829
|
+
* @memberof VenueGiftCardDetailDto
|
|
38830
|
+
*/
|
|
38831
|
+
'lastEmail': VenueGiftCardDetailDtoLastEmail | null;
|
|
38832
|
+
}
|
|
38833
|
+
|
|
38834
|
+
|
|
38835
|
+
/**
|
|
38836
|
+
* The card\'s newest email; null when it has none
|
|
38837
|
+
* @export
|
|
38838
|
+
* @interface VenueGiftCardDetailDtoLastEmail
|
|
38839
|
+
*/
|
|
38840
|
+
export interface VenueGiftCardDetailDtoLastEmail {
|
|
38841
|
+
/**
|
|
38842
|
+
*
|
|
38843
|
+
* @type {GiftCardEmailKind}
|
|
38844
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38845
|
+
*/
|
|
38846
|
+
'kind': GiftCardEmailKind;
|
|
38847
|
+
/**
|
|
38848
|
+
*
|
|
38849
|
+
* @type {GiftCardEmailStatus}
|
|
38850
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38851
|
+
*/
|
|
38852
|
+
'status': GiftCardEmailStatus;
|
|
38853
|
+
/**
|
|
38854
|
+
* The address it goes to
|
|
38855
|
+
* @type {string}
|
|
38856
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38857
|
+
*/
|
|
38858
|
+
'to': string;
|
|
38859
|
+
/**
|
|
38860
|
+
* When it was sent, else when it last changed, ISO 8601
|
|
38861
|
+
* @type {string}
|
|
38862
|
+
* @memberof VenueGiftCardDetailDtoLastEmail
|
|
38863
|
+
*/
|
|
38864
|
+
'at': string;
|
|
38653
38865
|
}
|
|
38654
38866
|
|
|
38655
38867
|
|
|
@@ -46530,7 +46742,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46530
46742
|
};
|
|
46531
46743
|
},
|
|
46532
46744
|
/**
|
|
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.
|
|
46745
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
46534
46746
|
* @summary Create or update a venue
|
|
46535
46747
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46536
46748
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -46822,7 +47034,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46822
47034
|
};
|
|
46823
47035
|
},
|
|
46824
47036
|
/**
|
|
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
|
|
47037
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
46826
47038
|
* @summary Set active provider and upsert its credentials
|
|
46827
47039
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46828
47040
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -46924,7 +47136,7 @@ export const ConfigManagementApiAxiosParamCreator = function (configuration?: Co
|
|
|
46924
47136
|
};
|
|
46925
47137
|
},
|
|
46926
47138
|
/**
|
|
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.
|
|
47139
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
46928
47140
|
* @summary Create or update a channel\'s Viva config
|
|
46929
47141
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
46930
47142
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47049,7 +47261,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
47049
47261
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47050
47262
|
},
|
|
47051
47263
|
/**
|
|
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.
|
|
47264
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47053
47265
|
* @summary Create or update a venue
|
|
47054
47266
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47055
47267
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47125,7 +47337,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
47125
47337
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47126
47338
|
},
|
|
47127
47339
|
/**
|
|
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
|
|
47340
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
47129
47341
|
* @summary Set active provider and upsert its credentials
|
|
47130
47342
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47131
47343
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47151,7 +47363,7 @@ export const ConfigManagementApiFp = function(configuration?: Configuration) {
|
|
|
47151
47363
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
47152
47364
|
},
|
|
47153
47365
|
/**
|
|
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.
|
|
47366
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
47155
47367
|
* @summary Create or update a channel\'s Viva config
|
|
47156
47368
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47157
47369
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47233,7 +47445,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
47233
47445
|
return localVarFp.configSaveEpassiCredentials(businessId, xAppX, xEpassiAccessKey, saveEpassiCredentialsDto, options).then((request) => request(axios, basePath));
|
|
47234
47446
|
},
|
|
47235
47447
|
/**
|
|
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.
|
|
47448
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47237
47449
|
* @summary Create or update a venue
|
|
47238
47450
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47239
47451
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47303,7 +47515,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
47303
47515
|
return localVarFp.configUpsertPaymentOptions(businessId, xAppX, upsertPaymentOptionsDto, options).then((request) => request(axios, basePath));
|
|
47304
47516
|
},
|
|
47305
47517
|
/**
|
|
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
|
|
47518
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
47307
47519
|
* @summary Set active provider and upsert its credentials
|
|
47308
47520
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47309
47521
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47327,7 +47539,7 @@ export const ConfigManagementApiFactory = function (configuration?: Configuratio
|
|
|
47327
47539
|
return localVarFp.configUpsertStripe(businessId, xAppX, upsertStripeDto, options).then((request) => request(axios, basePath));
|
|
47328
47540
|
},
|
|
47329
47541
|
/**
|
|
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.
|
|
47542
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
47331
47543
|
* @summary Create or update a channel\'s Viva config
|
|
47332
47544
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47333
47545
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47407,7 +47619,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47407
47619
|
configSaveEpassiCredentials(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', xEpassiAccessKey: string, saveEpassiCredentialsDto: SaveEpassiCredentialsDto, options?: AxiosRequestConfig): AxiosPromise<EpassiCredentialsSavedDto>;
|
|
47408
47620
|
|
|
47409
47621
|
/**
|
|
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.
|
|
47622
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47411
47623
|
* @summary Create or update a venue
|
|
47412
47624
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47413
47625
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47477,7 +47689,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47477
47689
|
configUpsertPaymentOptions(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertPaymentOptionsDto: UpsertPaymentOptionsDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
47478
47690
|
|
|
47479
47691
|
/**
|
|
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
|
|
47692
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
47481
47693
|
* @summary Set active provider and upsert its credentials
|
|
47482
47694
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47483
47695
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47501,7 +47713,7 @@ export interface ConfigManagementApiInterface {
|
|
|
47501
47713
|
configUpsertStripe(businessId: number, xAppX: 'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ', upsertStripeDto: UpsertStripeDto, options?: AxiosRequestConfig): AxiosPromise<ConfigManagementResponseDto>;
|
|
47502
47714
|
|
|
47503
47715
|
/**
|
|
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.
|
|
47716
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
47505
47717
|
* @summary Create or update a channel\'s Viva config
|
|
47506
47718
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47507
47719
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47591,7 +47803,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47591
47803
|
}
|
|
47592
47804
|
|
|
47593
47805
|
/**
|
|
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.
|
|
47806
|
+
* A new venue is saved enabled, named `Business <businessId>`, in Europe/Helsinki unless the body says otherwise, and the license server is asked for its license on every save, which leaves a venue it has a license for as it is: a venue whose license was missed when it was created gets it here. The fields below are written as sent; any other field is dropped and its name logged.
|
|
47595
47807
|
* @summary Create or update a venue
|
|
47596
47808
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47597
47809
|
* @param {UpsertBusinessDto} upsertBusinessDto
|
|
@@ -47673,7 +47885,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47673
47885
|
}
|
|
47674
47886
|
|
|
47675
47887
|
/**
|
|
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
|
|
47888
|
+
* Saves the chosen provider\'s own fields (Viva as the Viva route would, Nets and Stripe as their routes would; Worldline, which has no route of its own, the same way as Nets and Stripe), then selects it on the channel as the channel config route would, and answers the providers as read afterwards. The provider\'s settings and the selection are saved in one transaction: both or neither. A new Viva config without a rate is refused, as on the Viva route, when the venue has no licence or the license server cannot be read.
|
|
47677
47889
|
* @summary Set active provider and upsert its credentials
|
|
47678
47890
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47679
47891
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -47701,7 +47913,7 @@ export class ConfigManagementApi extends BaseAPI implements ConfigManagementApiI
|
|
|
47701
47913
|
}
|
|
47702
47914
|
|
|
47703
47915
|
/**
|
|
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.
|
|
47916
|
+
* Creates the channel\'s config first if it has none. A new Viva config needs a merchantId and takes the license server\'s ISV when no rate is sent, and is refused when the venue has no licence or the license server cannot be read; a changed rate or additionalAmount is saved on the license server first.
|
|
47705
47917
|
* @summary Create or update a channel\'s Viva config
|
|
47706
47918
|
* @param {number} businessId The venue\'s orderingBusinessId, not its cuid
|
|
47707
47919
|
* @param {'Wolt' | 'MunchiOnline' | 'MunchiKiosk' | 'MunchiPos' | 'UberEats' | 'Foodora' | 'Bolt' | 'MunchiKioskV2' | 'Kiosk' | 'WoltStorefront' | 'Storefront' | 'MunchiPay' | 'ResQ'} xAppX The app channel whose config is read or written
|
|
@@ -51141,6 +51353,53 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51141
51353
|
options: localVarRequestOptions,
|
|
51142
51354
|
};
|
|
51143
51355
|
},
|
|
51356
|
+
/**
|
|
51357
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
51358
|
+
* @summary Send a gift card again to its saved email address
|
|
51359
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51360
|
+
* @param {string} cardId The card\'s id
|
|
51361
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
51362
|
+
* @param {*} [options] Override http request option.
|
|
51363
|
+
* @throws {RequiredError}
|
|
51364
|
+
*/
|
|
51365
|
+
emailVenueGiftCard: async (businessId: number, cardId: string, xIdempotencyKey?: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51366
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51367
|
+
assertParamExists('emailVenueGiftCard', 'businessId', businessId)
|
|
51368
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
51369
|
+
assertParamExists('emailVenueGiftCard', 'cardId', cardId)
|
|
51370
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}/email`
|
|
51371
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
51372
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
51373
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51374
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51375
|
+
let baseOptions;
|
|
51376
|
+
if (configuration) {
|
|
51377
|
+
baseOptions = configuration.baseOptions;
|
|
51378
|
+
}
|
|
51379
|
+
|
|
51380
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
51381
|
+
const localVarHeaderParameter = {} as any;
|
|
51382
|
+
const localVarQueryParameter = {} as any;
|
|
51383
|
+
|
|
51384
|
+
// authentication JWT-auth required
|
|
51385
|
+
// http bearer authentication required
|
|
51386
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51387
|
+
|
|
51388
|
+
if (xIdempotencyKey != null) {
|
|
51389
|
+
localVarHeaderParameter['X-Idempotency-Key'] = String(xIdempotencyKey);
|
|
51390
|
+
}
|
|
51391
|
+
|
|
51392
|
+
|
|
51393
|
+
|
|
51394
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51395
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51396
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51397
|
+
|
|
51398
|
+
return {
|
|
51399
|
+
url: toPathString(localVarUrlObj),
|
|
51400
|
+
options: localVarRequestOptions,
|
|
51401
|
+
};
|
|
51402
|
+
},
|
|
51144
51403
|
/**
|
|
51145
51404
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51146
51405
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51455,6 +51714,54 @@ export const GiftCardsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
51455
51714
|
options: localVarRequestOptions,
|
|
51456
51715
|
};
|
|
51457
51716
|
},
|
|
51717
|
+
/**
|
|
51718
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
51719
|
+
* @summary Correct a gift card\'s email address
|
|
51720
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51721
|
+
* @param {string} cardId The card\'s id
|
|
51722
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
51723
|
+
* @param {*} [options] Override http request option.
|
|
51724
|
+
* @throws {RequiredError}
|
|
51725
|
+
*/
|
|
51726
|
+
updateVenueGiftCard: async (businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
51727
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
51728
|
+
assertParamExists('updateVenueGiftCard', 'businessId', businessId)
|
|
51729
|
+
// verify required parameter 'cardId' is not null or undefined
|
|
51730
|
+
assertParamExists('updateVenueGiftCard', 'cardId', cardId)
|
|
51731
|
+
// verify required parameter 'updateVenueGiftCardDto' is not null or undefined
|
|
51732
|
+
assertParamExists('updateVenueGiftCard', 'updateVenueGiftCardDto', updateVenueGiftCardDto)
|
|
51733
|
+
const localVarPath = `/api/v2/venues/{businessId}/gift-cards/{cardId}`
|
|
51734
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
51735
|
+
.replace(`{${"cardId"}}`, encodeURIComponent(String(cardId)));
|
|
51736
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
51737
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
51738
|
+
let baseOptions;
|
|
51739
|
+
if (configuration) {
|
|
51740
|
+
baseOptions = configuration.baseOptions;
|
|
51741
|
+
}
|
|
51742
|
+
|
|
51743
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
51744
|
+
const localVarHeaderParameter = {} as any;
|
|
51745
|
+
const localVarQueryParameter = {} as any;
|
|
51746
|
+
|
|
51747
|
+
// authentication JWT-auth required
|
|
51748
|
+
// http bearer authentication required
|
|
51749
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
51750
|
+
|
|
51751
|
+
|
|
51752
|
+
|
|
51753
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
51754
|
+
|
|
51755
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
51756
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
51757
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
51758
|
+
localVarRequestOptions.data = serializeDataIfNeeded(updateVenueGiftCardDto, localVarRequestOptions, configuration)
|
|
51759
|
+
|
|
51760
|
+
return {
|
|
51761
|
+
url: toPathString(localVarUrlObj),
|
|
51762
|
+
options: localVarRequestOptions,
|
|
51763
|
+
};
|
|
51764
|
+
},
|
|
51458
51765
|
/**
|
|
51459
51766
|
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
51460
51767
|
* @summary Change a store\'s gift card settings
|
|
@@ -51547,6 +51854,19 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51547
51854
|
const localVarAxiosArgs = await localVarAxiosParamCreator.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options);
|
|
51548
51855
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51549
51856
|
},
|
|
51857
|
+
/**
|
|
51858
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
51859
|
+
* @summary Send a gift card again to its saved email address
|
|
51860
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51861
|
+
* @param {string} cardId The card\'s id
|
|
51862
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
51863
|
+
* @param {*} [options] Override http request option.
|
|
51864
|
+
* @throws {RequiredError}
|
|
51865
|
+
*/
|
|
51866
|
+
async emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51867
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options);
|
|
51868
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51869
|
+
},
|
|
51550
51870
|
/**
|
|
51551
51871
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51552
51872
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51629,6 +51949,19 @@ export const GiftCardsApiFp = function(configuration?: Configuration) {
|
|
|
51629
51949
|
const localVarAxiosArgs = await localVarAxiosParamCreator.unblockVenueGiftCard(businessId, cardId, options);
|
|
51630
51950
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51631
51951
|
},
|
|
51952
|
+
/**
|
|
51953
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
51954
|
+
* @summary Correct a gift card\'s email address
|
|
51955
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
51956
|
+
* @param {string} cardId The card\'s id
|
|
51957
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
51958
|
+
* @param {*} [options] Override http request option.
|
|
51959
|
+
* @throws {RequiredError}
|
|
51960
|
+
*/
|
|
51961
|
+
async updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<VenueGiftCardDetailDto>> {
|
|
51962
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options);
|
|
51963
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51964
|
+
},
|
|
51632
51965
|
/**
|
|
51633
51966
|
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
51634
51967
|
* @summary Change a store\'s gift card settings
|
|
@@ -51686,6 +52019,18 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51686
52019
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51687
52020
|
return localVarFp.createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
51688
52021
|
},
|
|
52022
|
+
/**
|
|
52023
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
52024
|
+
* @summary Send a gift card again to its saved email address
|
|
52025
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52026
|
+
* @param {string} cardId The card\'s id
|
|
52027
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
52028
|
+
* @param {*} [options] Override http request option.
|
|
52029
|
+
* @throws {RequiredError}
|
|
52030
|
+
*/
|
|
52031
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
52032
|
+
return localVarFp.emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options).then((request) => request(axios, basePath));
|
|
52033
|
+
},
|
|
51689
52034
|
/**
|
|
51690
52035
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51691
52036
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51762,6 +52107,18 @@ export const GiftCardsApiFactory = function (configuration?: Configuration, base
|
|
|
51762
52107
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
51763
52108
|
return localVarFp.unblockVenueGiftCard(businessId, cardId, options).then((request) => request(axios, basePath));
|
|
51764
52109
|
},
|
|
52110
|
+
/**
|
|
52111
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
52112
|
+
* @summary Correct a gift card\'s email address
|
|
52113
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52114
|
+
* @param {string} cardId The card\'s id
|
|
52115
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52116
|
+
* @param {*} [options] Override http request option.
|
|
52117
|
+
* @throws {RequiredError}
|
|
52118
|
+
*/
|
|
52119
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: any): AxiosPromise<VenueGiftCardDetailDto> {
|
|
52120
|
+
return localVarFp.updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(axios, basePath));
|
|
52121
|
+
},
|
|
51765
52122
|
/**
|
|
51766
52123
|
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
51767
52124
|
* @summary Change a store\'s gift card settings
|
|
@@ -51817,6 +52174,18 @@ export interface GiftCardsApiInterface {
|
|
|
51817
52174
|
*/
|
|
51818
52175
|
createVenueGiftCard(businessId: number, createVenueGiftCardDto: CreateVenueGiftCardDto, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51819
52176
|
|
|
52177
|
+
/**
|
|
52178
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
52179
|
+
* @summary Send a gift card again to its saved email address
|
|
52180
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52181
|
+
* @param {string} cardId The card\'s id
|
|
52182
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
52183
|
+
* @param {*} [options] Override http request option.
|
|
52184
|
+
* @throws {RequiredError}
|
|
52185
|
+
* @memberof GiftCardsApiInterface
|
|
52186
|
+
*/
|
|
52187
|
+
emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52188
|
+
|
|
51820
52189
|
/**
|
|
51821
52190
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51822
52191
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -51893,6 +52262,18 @@ export interface GiftCardsApiInterface {
|
|
|
51893
52262
|
*/
|
|
51894
52263
|
unblockVenueGiftCard(businessId: number, cardId: string, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
51895
52264
|
|
|
52265
|
+
/**
|
|
52266
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
52267
|
+
* @summary Correct a gift card\'s email address
|
|
52268
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52269
|
+
* @param {string} cardId The card\'s id
|
|
52270
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52271
|
+
* @param {*} [options] Override http request option.
|
|
52272
|
+
* @throws {RequiredError}
|
|
52273
|
+
* @memberof GiftCardsApiInterface
|
|
52274
|
+
*/
|
|
52275
|
+
updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig): AxiosPromise<VenueGiftCardDetailDto>;
|
|
52276
|
+
|
|
51896
52277
|
/**
|
|
51897
52278
|
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
51898
52279
|
* @summary Change a store\'s gift card settings
|
|
@@ -51954,6 +52335,20 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
51954
52335
|
return GiftCardsApiFp(this.configuration).createVenueGiftCard(businessId, createVenueGiftCardDto, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
51955
52336
|
}
|
|
51956
52337
|
|
|
52338
|
+
/**
|
|
52339
|
+
* Queues the card\'s email again, to the address the card has saved; it goes within the minute, its subject starting \"Again: \". Only an ACTIVE card with an address is sent, at most 3 times in a rolling hour. Who asked is stored. The answer is the card, its lastEmail the one queued.
|
|
52340
|
+
* @summary Send a gift card again to its saved email address
|
|
52341
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52342
|
+
* @param {string} cardId The card\'s id
|
|
52343
|
+
* @param {string} [xIdempotencyKey] Client-generated UUID, one per press of Send again; 8 to 100 letters, digits, \'-\' or \'_\'. A repeat with the same key answers the card and queues nothing. Without the header every request queues an email.
|
|
52344
|
+
* @param {*} [options] Override http request option.
|
|
52345
|
+
* @throws {RequiredError}
|
|
52346
|
+
* @memberof GiftCardsApi
|
|
52347
|
+
*/
|
|
52348
|
+
public emailVenueGiftCard(businessId: number, cardId: string, xIdempotencyKey?: string, options?: AxiosRequestConfig) {
|
|
52349
|
+
return GiftCardsApiFp(this.configuration).emailVenueGiftCard(businessId, cardId, xIdempotencyKey, options).then((request) => request(this.axios, this.basePath));
|
|
52350
|
+
}
|
|
52351
|
+
|
|
51957
52352
|
/**
|
|
51958
52353
|
* The card with every movement of its balance and its latest block, unblock and activation by hand, oldest first. Three statements; nothing is written.
|
|
51959
52354
|
* @summary Read one of a store\'s gift cards with its history
|
|
@@ -52042,6 +52437,20 @@ export class GiftCardsApi extends BaseAPI implements GiftCardsApiInterface {
|
|
|
52042
52437
|
return GiftCardsApiFp(this.configuration).unblockVenueGiftCard(businessId, cardId, options).then((request) => request(this.axios, this.basePath));
|
|
52043
52438
|
}
|
|
52044
52439
|
|
|
52440
|
+
/**
|
|
52441
|
+
* Saves the address, or removes it with null; who did it and when show in the card\'s history as EMAIL_CHANGED. Nothing is sent: send the card again to email the new address.
|
|
52442
|
+
* @summary Correct a gift card\'s email address
|
|
52443
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
52444
|
+
* @param {string} cardId The card\'s id
|
|
52445
|
+
* @param {UpdateVenueGiftCardDto} updateVenueGiftCardDto
|
|
52446
|
+
* @param {*} [options] Override http request option.
|
|
52447
|
+
* @throws {RequiredError}
|
|
52448
|
+
* @memberof GiftCardsApi
|
|
52449
|
+
*/
|
|
52450
|
+
public updateVenueGiftCard(businessId: number, cardId: string, updateVenueGiftCardDto: UpdateVenueGiftCardDto, options?: AxiosRequestConfig) {
|
|
52451
|
+
return GiftCardsApiFp(this.configuration).updateVenueGiftCard(businessId, cardId, updateVenueGiftCardDto, options).then((request) => request(this.axios, this.basePath));
|
|
52452
|
+
}
|
|
52453
|
+
|
|
52045
52454
|
/**
|
|
52046
52455
|
* Changes the fields sent and keeps the others; null clears validityMonths (cards never expire), cardText or imageUrl. With the Till channel off, the store\'s till refuses to sell, validate or redeem a card (1012). Of two changes at once the last to commit wins whole.
|
|
52047
52456
|
* @summary Change a store\'s gift card settings
|