@munchi_oy/core 1.9.131 → 1.9.134
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 +475 -3
- 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 +721 -4
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/generated/api.ts
CHANGED
|
@@ -140,6 +140,25 @@ export interface AcceptOrderDto {
|
|
|
140
140
|
}
|
|
141
141
|
|
|
142
142
|
|
|
143
|
+
/**
|
|
144
|
+
*
|
|
145
|
+
* @export
|
|
146
|
+
* @interface ActionPasscodeCheckResponseDto
|
|
147
|
+
*/
|
|
148
|
+
export interface ActionPasscodeCheckResponseDto {
|
|
149
|
+
/**
|
|
150
|
+
* The passcode that approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again.
|
|
151
|
+
* @type {string}
|
|
152
|
+
* @memberof ActionPasscodeCheckResponseDto
|
|
153
|
+
*/
|
|
154
|
+
'passcodeId': string;
|
|
155
|
+
/**
|
|
156
|
+
* The passcode\'s name, as the merchant set it
|
|
157
|
+
* @type {string}
|
|
158
|
+
* @memberof ActionPasscodeCheckResponseDto
|
|
159
|
+
*/
|
|
160
|
+
'name': string;
|
|
161
|
+
}
|
|
143
162
|
/**
|
|
144
163
|
*
|
|
145
164
|
* @export
|
|
@@ -2841,6 +2860,21 @@ export interface ChargeStatusResponseDto {
|
|
|
2841
2860
|
}
|
|
2842
2861
|
|
|
2843
2862
|
|
|
2863
|
+
/**
|
|
2864
|
+
*
|
|
2865
|
+
* @export
|
|
2866
|
+
* @interface CheckActionPasscodeDto
|
|
2867
|
+
*/
|
|
2868
|
+
export interface CheckActionPasscodeDto {
|
|
2869
|
+
/**
|
|
2870
|
+
*
|
|
2871
|
+
* @type {PosPermission}
|
|
2872
|
+
* @memberof CheckActionPasscodeDto
|
|
2873
|
+
*/
|
|
2874
|
+
'key': PosPermission;
|
|
2875
|
+
}
|
|
2876
|
+
|
|
2877
|
+
|
|
2844
2878
|
/**
|
|
2845
2879
|
*
|
|
2846
2880
|
* @export
|
|
@@ -3724,7 +3758,7 @@ export interface CreateManualSessionDto {
|
|
|
3724
3758
|
*/
|
|
3725
3759
|
'order': CreateManualSessionDtoOrder;
|
|
3726
3760
|
/**
|
|
3727
|
-
*
|
|
3761
|
+
* Staff to name on the cash log (staffId, staffName). A cash payment is recorded in the business\'s open cash session whether or not this is sent; enabled and sessionId are no longer read.
|
|
3728
3762
|
* @type {object}
|
|
3729
3763
|
* @memberof CreateManualSessionDto
|
|
3730
3764
|
*/
|
|
@@ -9419,7 +9453,7 @@ export interface LoginResponseDtoUserInfo {
|
|
|
9419
9453
|
*/
|
|
9420
9454
|
export interface LogoutResponseDto {
|
|
9421
9455
|
/**
|
|
9422
|
-
*
|
|
9456
|
+
* Confirmation that the session was deleted; the tokens of that session stop working
|
|
9423
9457
|
* @type {string}
|
|
9424
9458
|
* @memberof LogoutResponseDto
|
|
9425
9459
|
*/
|
|
@@ -10355,6 +10389,62 @@ export interface LoyaltyUserInfoResponseDto {
|
|
|
10355
10389
|
*/
|
|
10356
10390
|
'_links': { [key: string]: LoyaltyInfoResponseDtoLinksValue; };
|
|
10357
10391
|
}
|
|
10392
|
+
/**
|
|
10393
|
+
*
|
|
10394
|
+
* @export
|
|
10395
|
+
* @interface LoyaltyWalletRewardDto
|
|
10396
|
+
*/
|
|
10397
|
+
export interface LoyaltyWalletRewardDto {
|
|
10398
|
+
/**
|
|
10399
|
+
*
|
|
10400
|
+
* @type {number}
|
|
10401
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10402
|
+
*/
|
|
10403
|
+
'wallet_id': number;
|
|
10404
|
+
/**
|
|
10405
|
+
*
|
|
10406
|
+
* @type {number}
|
|
10407
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10408
|
+
*/
|
|
10409
|
+
'catalog_id': number;
|
|
10410
|
+
/**
|
|
10411
|
+
*
|
|
10412
|
+
* @type {string}
|
|
10413
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10414
|
+
*/
|
|
10415
|
+
'name': string | null;
|
|
10416
|
+
/**
|
|
10417
|
+
* When the reward stops being usable. A claim made before claims expired has none.
|
|
10418
|
+
* @type {string}
|
|
10419
|
+
* @memberof LoyaltyWalletRewardDto
|
|
10420
|
+
*/
|
|
10421
|
+
'expires_at': string | null;
|
|
10422
|
+
}
|
|
10423
|
+
/**
|
|
10424
|
+
*
|
|
10425
|
+
* @export
|
|
10426
|
+
* @interface LoyaltyWalletRewardsDto
|
|
10427
|
+
*/
|
|
10428
|
+
export interface LoyaltyWalletRewardsDto {
|
|
10429
|
+
/**
|
|
10430
|
+
*
|
|
10431
|
+
* @type {number}
|
|
10432
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10433
|
+
*/
|
|
10434
|
+
'user_id': number;
|
|
10435
|
+
/**
|
|
10436
|
+
* Rewards the member activated whose window is still open, soonest to expire first
|
|
10437
|
+
* @type {Array<LoyaltyWalletRewardDto>}
|
|
10438
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10439
|
+
*/
|
|
10440
|
+
'activated': Array<LoyaltyWalletRewardDto>;
|
|
10441
|
+
/**
|
|
10442
|
+
* Rewards the member claimed and has not activated, newest first
|
|
10443
|
+
* @type {Array<LoyaltyWalletRewardDto>}
|
|
10444
|
+
* @memberof LoyaltyWalletRewardsDto
|
|
10445
|
+
*/
|
|
10446
|
+
'claimed': Array<LoyaltyWalletRewardDto>;
|
|
10447
|
+
}
|
|
10358
10448
|
/**
|
|
10359
10449
|
*
|
|
10360
10450
|
* @export
|
|
@@ -18933,6 +19023,15 @@ export const PosPermission = {
|
|
|
18933
19023
|
CashSendReport: 'Cash::SendReport',
|
|
18934
19024
|
Transaction: 'Transaction::*',
|
|
18935
19025
|
TransactionRefund: 'Transaction::Refund',
|
|
19026
|
+
TransactionViewAll: 'Transaction::ViewAll',
|
|
19027
|
+
TransactionViewTips: 'Transaction::ViewTips',
|
|
19028
|
+
TransactionViewSurcharges: 'Transaction::ViewSurcharges',
|
|
19029
|
+
TransactionViewDiscounts: 'Transaction::ViewDiscounts',
|
|
19030
|
+
TransactionTotals: 'TransactionTotals::*',
|
|
19031
|
+
TransactionTotalsOrders: 'TransactionTotals::Orders',
|
|
19032
|
+
TransactionTotalsSales: 'TransactionTotals::Sales',
|
|
19033
|
+
TransactionTotalsRejectedOrders: 'TransactionTotals::RejectedOrders',
|
|
19034
|
+
TransactionTotalsRejectedSales: 'TransactionTotals::RejectedSales',
|
|
18936
19035
|
Order: 'Order::*',
|
|
18937
19036
|
OrderSendReceipt: 'Order::SendReceipt',
|
|
18938
19037
|
OpenOrdersDelete: 'OpenOrders::Delete',
|
|
@@ -18947,12 +19046,141 @@ export const PosPermission = {
|
|
|
18947
19046
|
Settings: 'Settings::*',
|
|
18948
19047
|
SettingsEditProfile: 'Settings::EditProfile',
|
|
18949
19048
|
Report: 'Report::*',
|
|
18950
|
-
ReportSendEmail: 'Report::SendEmail'
|
|
19049
|
+
ReportSendEmail: 'Report::SendEmail',
|
|
19050
|
+
ReportViewAll: 'Report::ViewAll',
|
|
19051
|
+
ReportViewSalesSummary: 'Report::ViewSalesSummary',
|
|
19052
|
+
ReportViewPaymentMethods: 'Report::ViewPaymentMethods',
|
|
19053
|
+
ReportViewItemSales: 'Report::ViewItemSales',
|
|
19054
|
+
ReportViewCashLogs: 'Report::ViewCashLogs',
|
|
19055
|
+
ReportTotals: 'ReportTotals::*',
|
|
19056
|
+
ReportTotalsOrders: 'ReportTotals::Orders',
|
|
19057
|
+
ReportTotalsSales: 'ReportTotals::Sales',
|
|
19058
|
+
ReportTotalsTips: 'ReportTotals::Tips',
|
|
19059
|
+
ReportTotalsSurcharges: 'ReportTotals::Surcharges',
|
|
19060
|
+
ReportTotalsRejectedOrders: 'ReportTotals::RejectedOrders',
|
|
19061
|
+
ReportTotalsRejectedSales: 'ReportTotals::RejectedSales',
|
|
19062
|
+
ReportTotalsAverageSale: 'ReportTotals::AverageSale',
|
|
19063
|
+
ReportTotalsItems: 'ReportTotals::Items',
|
|
19064
|
+
ReportTotalsRefunds: 'ReportTotals::Refunds',
|
|
19065
|
+
ReportTotalsDiscounts: 'ReportTotals::Discounts'
|
|
18951
19066
|
} as const;
|
|
18952
19067
|
|
|
18953
19068
|
export type PosPermission = typeof PosPermission[keyof typeof PosPermission];
|
|
18954
19069
|
|
|
18955
19070
|
|
|
19071
|
+
/**
|
|
19072
|
+
*
|
|
19073
|
+
* @export
|
|
19074
|
+
* @interface PosPermissionCatalogResponseDto
|
|
19075
|
+
*/
|
|
19076
|
+
export interface PosPermissionCatalogResponseDto {
|
|
19077
|
+
/**
|
|
19078
|
+
* Every POS key the server knows, grouped as the POS groups them
|
|
19079
|
+
* @type {Array<PosPermissionGroupDto>}
|
|
19080
|
+
* @memberof PosPermissionCatalogResponseDto
|
|
19081
|
+
*/
|
|
19082
|
+
'groups': Array<PosPermissionGroupDto>;
|
|
19083
|
+
}
|
|
19084
|
+
/**
|
|
19085
|
+
*
|
|
19086
|
+
* @export
|
|
19087
|
+
* @interface PosPermissionDetailDto
|
|
19088
|
+
*/
|
|
19089
|
+
export interface PosPermissionDetailDto {
|
|
19090
|
+
/**
|
|
19091
|
+
*
|
|
19092
|
+
* @type {PosPermission}
|
|
19093
|
+
* @memberof PosPermissionDetailDto
|
|
19094
|
+
*/
|
|
19095
|
+
'key': PosPermission;
|
|
19096
|
+
/**
|
|
19097
|
+
* The key\'s name, as the merchant sees it beside its checkbox
|
|
19098
|
+
* @type {string}
|
|
19099
|
+
* @memberof PosPermissionDetailDto
|
|
19100
|
+
*/
|
|
19101
|
+
'label': string;
|
|
19102
|
+
/**
|
|
19103
|
+
*
|
|
19104
|
+
* @type {PosPermissionKind}
|
|
19105
|
+
* @memberof PosPermissionDetailDto
|
|
19106
|
+
*/
|
|
19107
|
+
'kind': PosPermissionKind;
|
|
19108
|
+
}
|
|
19109
|
+
|
|
19110
|
+
|
|
19111
|
+
/**
|
|
19112
|
+
*
|
|
19113
|
+
* @export
|
|
19114
|
+
* @enum {string}
|
|
19115
|
+
*/
|
|
19116
|
+
|
|
19117
|
+
export const PosPermissionGroup = {
|
|
19118
|
+
Access: 'Access',
|
|
19119
|
+
Page: 'Page',
|
|
19120
|
+
Cart: 'Cart',
|
|
19121
|
+
Cash: 'Cash',
|
|
19122
|
+
Transaction: 'Transaction',
|
|
19123
|
+
TransactionTotals: 'TransactionTotals',
|
|
19124
|
+
Order: 'Order',
|
|
19125
|
+
OpenOrders: 'OpenOrders',
|
|
19126
|
+
Shift: 'Shift',
|
|
19127
|
+
FloorPlan: 'FloorPlan',
|
|
19128
|
+
Settings: 'Settings',
|
|
19129
|
+
Report: 'Report',
|
|
19130
|
+
ReportTotals: 'ReportTotals'
|
|
19131
|
+
} as const;
|
|
19132
|
+
|
|
19133
|
+
export type PosPermissionGroup = typeof PosPermissionGroup[keyof typeof PosPermissionGroup];
|
|
19134
|
+
|
|
19135
|
+
|
|
19136
|
+
/**
|
|
19137
|
+
*
|
|
19138
|
+
* @export
|
|
19139
|
+
* @interface PosPermissionGroupDto
|
|
19140
|
+
*/
|
|
19141
|
+
export interface PosPermissionGroupDto {
|
|
19142
|
+
/**
|
|
19143
|
+
*
|
|
19144
|
+
* @type {PosPermissionGroup}
|
|
19145
|
+
* @memberof PosPermissionGroupDto
|
|
19146
|
+
*/
|
|
19147
|
+
'group': PosPermissionGroup;
|
|
19148
|
+
/**
|
|
19149
|
+
* The group\'s name, as the merchant sees it
|
|
19150
|
+
* @type {string}
|
|
19151
|
+
* @memberof PosPermissionGroupDto
|
|
19152
|
+
*/
|
|
19153
|
+
'label': string;
|
|
19154
|
+
/**
|
|
19155
|
+
*
|
|
19156
|
+
* @type {PosPermission}
|
|
19157
|
+
* @memberof PosPermissionGroupDto
|
|
19158
|
+
*/
|
|
19159
|
+
'wildcardKey'?: PosPermission;
|
|
19160
|
+
/**
|
|
19161
|
+
* The group\'s keys, in the order the POS lists them, without the wildcard key
|
|
19162
|
+
* @type {Array<PosPermissionDetailDto>}
|
|
19163
|
+
* @memberof PosPermissionGroupDto
|
|
19164
|
+
*/
|
|
19165
|
+
'permissions': Array<PosPermissionDetailDto>;
|
|
19166
|
+
}
|
|
19167
|
+
|
|
19168
|
+
|
|
19169
|
+
/**
|
|
19170
|
+
*
|
|
19171
|
+
* @export
|
|
19172
|
+
* @enum {string}
|
|
19173
|
+
*/
|
|
19174
|
+
|
|
19175
|
+
export const PosPermissionKind = {
|
|
19176
|
+
Screen: 'screen',
|
|
19177
|
+
Action: 'action',
|
|
19178
|
+
Visibility: 'visibility'
|
|
19179
|
+
} as const;
|
|
19180
|
+
|
|
19181
|
+
export type PosPermissionKind = typeof PosPermissionKind[keyof typeof PosPermissionKind];
|
|
19182
|
+
|
|
19183
|
+
|
|
18956
19184
|
/**
|
|
18957
19185
|
*
|
|
18958
19186
|
* @export
|
|
@@ -29345,7 +29573,7 @@ export interface VoidManualSessionDto {
|
|
|
29345
29573
|
*/
|
|
29346
29574
|
'orderId': string;
|
|
29347
29575
|
/**
|
|
29348
|
-
*
|
|
29576
|
+
* Staff to name on the REFUND cash log (staffId, staffName). Reverting a cash payment is recorded in the business\'s open cash session whether or not this is sent; enabled and sessionId are no longer read.
|
|
29349
29577
|
* @type {object}
|
|
29350
29578
|
* @memberof VoidManualSessionDto
|
|
29351
29579
|
*/
|
|
@@ -30002,6 +30230,57 @@ export class AblyApi extends BaseAPI implements AblyApiInterface {
|
|
|
30002
30230
|
*/
|
|
30003
30231
|
export const ActionPasscodesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
30004
30232
|
return {
|
|
30233
|
+
/**
|
|
30234
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30235
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30236
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30237
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30238
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30239
|
+
* @param {*} [options] Override http request option.
|
|
30240
|
+
* @throws {RequiredError}
|
|
30241
|
+
*/
|
|
30242
|
+
checkActionPasscode: async (businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
30243
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
30244
|
+
assertParamExists('checkActionPasscode', 'businessId', businessId)
|
|
30245
|
+
// verify required parameter 'xPosPin' is not null or undefined
|
|
30246
|
+
assertParamExists('checkActionPasscode', 'xPosPin', xPosPin)
|
|
30247
|
+
// verify required parameter 'checkActionPasscodeDto' is not null or undefined
|
|
30248
|
+
assertParamExists('checkActionPasscode', 'checkActionPasscodeDto', checkActionPasscodeDto)
|
|
30249
|
+
const localVarPath = `/api/v2/businesses/{businessId}/action-passcodes/check`
|
|
30250
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
30251
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
30252
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
30253
|
+
let baseOptions;
|
|
30254
|
+
if (configuration) {
|
|
30255
|
+
baseOptions = configuration.baseOptions;
|
|
30256
|
+
}
|
|
30257
|
+
|
|
30258
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
30259
|
+
const localVarHeaderParameter = {} as any;
|
|
30260
|
+
const localVarQueryParameter = {} as any;
|
|
30261
|
+
|
|
30262
|
+
// authentication JWT-auth required
|
|
30263
|
+
// http bearer authentication required
|
|
30264
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
30265
|
+
|
|
30266
|
+
if (xPosPin != null) {
|
|
30267
|
+
localVarHeaderParameter['X-Pos-Pin'] = String(xPosPin);
|
|
30268
|
+
}
|
|
30269
|
+
|
|
30270
|
+
|
|
30271
|
+
|
|
30272
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
30273
|
+
|
|
30274
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
30275
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
30276
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
30277
|
+
localVarRequestOptions.data = serializeDataIfNeeded(checkActionPasscodeDto, localVarRequestOptions, configuration)
|
|
30278
|
+
|
|
30279
|
+
return {
|
|
30280
|
+
url: toPathString(localVarUrlObj),
|
|
30281
|
+
options: localVarRequestOptions,
|
|
30282
|
+
};
|
|
30283
|
+
},
|
|
30005
30284
|
/**
|
|
30006
30285
|
*
|
|
30007
30286
|
* @summary Create action passcode
|
|
@@ -30134,6 +30413,19 @@ export const ActionPasscodesApiAxiosParamCreator = function (configuration?: Con
|
|
|
30134
30413
|
export const ActionPasscodesApiFp = function(configuration?: Configuration) {
|
|
30135
30414
|
const localVarAxiosParamCreator = ActionPasscodesApiAxiosParamCreator(configuration)
|
|
30136
30415
|
return {
|
|
30416
|
+
/**
|
|
30417
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30418
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30419
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30420
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30421
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30422
|
+
* @param {*} [options] Override http request option.
|
|
30423
|
+
* @throws {RequiredError}
|
|
30424
|
+
*/
|
|
30425
|
+
async checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionPasscodeCheckResponseDto>> {
|
|
30426
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.checkActionPasscode(businessId, xPosPin, checkActionPasscodeDto, options);
|
|
30427
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
30428
|
+
},
|
|
30137
30429
|
/**
|
|
30138
30430
|
*
|
|
30139
30431
|
* @summary Create action passcode
|
|
@@ -30178,6 +30470,18 @@ export const ActionPasscodesApiFp = function(configuration?: Configuration) {
|
|
|
30178
30470
|
export const ActionPasscodesApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
30179
30471
|
const localVarFp = ActionPasscodesApiFp(configuration)
|
|
30180
30472
|
return {
|
|
30473
|
+
/**
|
|
30474
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30475
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30476
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30477
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30478
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30479
|
+
* @param {*} [options] Override http request option.
|
|
30480
|
+
* @throws {RequiredError}
|
|
30481
|
+
*/
|
|
30482
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: any): AxiosPromise<ActionPasscodeCheckResponseDto> {
|
|
30483
|
+
return localVarFp.checkActionPasscode(businessId, xPosPin, checkActionPasscodeDto, options).then((request) => request(axios, basePath));
|
|
30484
|
+
},
|
|
30181
30485
|
/**
|
|
30182
30486
|
*
|
|
30183
30487
|
* @summary Create action passcode
|
|
@@ -30218,6 +30522,18 @@ export const ActionPasscodesApiFactory = function (configuration?: Configuration
|
|
|
30218
30522
|
* @interface ActionPasscodesApi
|
|
30219
30523
|
*/
|
|
30220
30524
|
export interface ActionPasscodesApiInterface {
|
|
30525
|
+
/**
|
|
30526
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30527
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30528
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30529
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30530
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30531
|
+
* @param {*} [options] Override http request option.
|
|
30532
|
+
* @throws {RequiredError}
|
|
30533
|
+
* @memberof ActionPasscodesApiInterface
|
|
30534
|
+
*/
|
|
30535
|
+
checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): AxiosPromise<ActionPasscodeCheckResponseDto>;
|
|
30536
|
+
|
|
30221
30537
|
/**
|
|
30222
30538
|
*
|
|
30223
30539
|
* @summary Create action passcode
|
|
@@ -30258,6 +30574,20 @@ export interface ActionPasscodesApiInterface {
|
|
|
30258
30574
|
* @extends {BaseAPI}
|
|
30259
30575
|
*/
|
|
30260
30576
|
export class ActionPasscodesApi extends BaseAPI implements ActionPasscodesApiInterface {
|
|
30577
|
+
/**
|
|
30578
|
+
* Answers whether a passcode of the venue or its chain approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again (D102). A key for what a person may see is never approved. After 5 wrong PINs the till waits 60 seconds.
|
|
30579
|
+
* @summary Check a manager passcode for one action, in pin-lock mode
|
|
30580
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
30581
|
+
* @param {string} xPosPin The manager\'s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
30582
|
+
* @param {CheckActionPasscodeDto} checkActionPasscodeDto
|
|
30583
|
+
* @param {*} [options] Override http request option.
|
|
30584
|
+
* @throws {RequiredError}
|
|
30585
|
+
* @memberof ActionPasscodesApi
|
|
30586
|
+
*/
|
|
30587
|
+
public checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig) {
|
|
30588
|
+
return ActionPasscodesApiFp(this.configuration).checkActionPasscode(businessId, xPosPin, checkActionPasscodeDto, options).then((request) => request(this.axios, this.basePath));
|
|
30589
|
+
}
|
|
30590
|
+
|
|
30261
30591
|
/**
|
|
30262
30592
|
*
|
|
30263
30593
|
* @summary Create action passcode
|
|
@@ -40624,6 +40954,54 @@ export const LoyaltyIntegerationsApiAxiosParamCreator = function (configuration?
|
|
|
40624
40954
|
|
|
40625
40955
|
|
|
40626
40956
|
|
|
40957
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40958
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40959
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
40960
|
+
|
|
40961
|
+
return {
|
|
40962
|
+
url: toPathString(localVarUrlObj),
|
|
40963
|
+
options: localVarRequestOptions,
|
|
40964
|
+
};
|
|
40965
|
+
},
|
|
40966
|
+
/**
|
|
40967
|
+
*
|
|
40968
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
40969
|
+
* @param {number} businessId
|
|
40970
|
+
* @param {number} userId
|
|
40971
|
+
* @param {*} [options] Override http request option.
|
|
40972
|
+
* @throws {RequiredError}
|
|
40973
|
+
*/
|
|
40974
|
+
getWalletRewards: async (businessId: number, userId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
40975
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
40976
|
+
assertParamExists('getWalletRewards', 'businessId', businessId)
|
|
40977
|
+
// verify required parameter 'userId' is not null or undefined
|
|
40978
|
+
assertParamExists('getWalletRewards', 'userId', userId)
|
|
40979
|
+
const localVarPath = `/api/v1/loyalty/users/wallet-rewards`;
|
|
40980
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
40981
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
40982
|
+
let baseOptions;
|
|
40983
|
+
if (configuration) {
|
|
40984
|
+
baseOptions = configuration.baseOptions;
|
|
40985
|
+
}
|
|
40986
|
+
|
|
40987
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
40988
|
+
const localVarHeaderParameter = {} as any;
|
|
40989
|
+
const localVarQueryParameter = {} as any;
|
|
40990
|
+
|
|
40991
|
+
// authentication JWT-auth required
|
|
40992
|
+
// http bearer authentication required
|
|
40993
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
40994
|
+
|
|
40995
|
+
if (businessId !== undefined) {
|
|
40996
|
+
localVarQueryParameter['businessId'] = businessId;
|
|
40997
|
+
}
|
|
40998
|
+
|
|
40999
|
+
if (userId !== undefined) {
|
|
41000
|
+
localVarQueryParameter['userId'] = userId;
|
|
41001
|
+
}
|
|
41002
|
+
|
|
41003
|
+
|
|
41004
|
+
|
|
40627
41005
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
40628
41006
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
40629
41007
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -40975,6 +41353,18 @@ export const LoyaltyIntegerationsApiFp = function(configuration?: Configuration)
|
|
|
40975
41353
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getUserWallet(businessId, userId, options);
|
|
40976
41354
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
40977
41355
|
},
|
|
41356
|
+
/**
|
|
41357
|
+
*
|
|
41358
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
41359
|
+
* @param {number} businessId
|
|
41360
|
+
* @param {number} userId
|
|
41361
|
+
* @param {*} [options] Override http request option.
|
|
41362
|
+
* @throws {RequiredError}
|
|
41363
|
+
*/
|
|
41364
|
+
async getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoyaltyWalletRewardsDto>> {
|
|
41365
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.getWalletRewards(businessId, userId, options);
|
|
41366
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
41367
|
+
},
|
|
40978
41368
|
/**
|
|
40979
41369
|
*
|
|
40980
41370
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -41132,6 +41522,17 @@ export const LoyaltyIntegerationsApiFactory = function (configuration?: Configur
|
|
|
41132
41522
|
getUserWallet(businessId: number, userId: number, options?: any): AxiosPromise<UserWalletResponseDto> {
|
|
41133
41523
|
return localVarFp.getUserWallet(businessId, userId, options).then((request) => request(axios, basePath));
|
|
41134
41524
|
},
|
|
41525
|
+
/**
|
|
41526
|
+
*
|
|
41527
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
41528
|
+
* @param {number} businessId
|
|
41529
|
+
* @param {number} userId
|
|
41530
|
+
* @param {*} [options] Override http request option.
|
|
41531
|
+
* @throws {RequiredError}
|
|
41532
|
+
*/
|
|
41533
|
+
getWalletRewards(businessId: number, userId: number, options?: any): AxiosPromise<LoyaltyWalletRewardsDto> {
|
|
41534
|
+
return localVarFp.getWalletRewards(businessId, userId, options).then((request) => request(axios, basePath));
|
|
41535
|
+
},
|
|
41135
41536
|
/**
|
|
41136
41537
|
*
|
|
41137
41538
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -41283,6 +41684,17 @@ export interface LoyaltyIntegerationsApiInterface {
|
|
|
41283
41684
|
*/
|
|
41284
41685
|
getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<UserWalletResponseDto>;
|
|
41285
41686
|
|
|
41687
|
+
/**
|
|
41688
|
+
*
|
|
41689
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
41690
|
+
* @param {number} businessId
|
|
41691
|
+
* @param {number} userId
|
|
41692
|
+
* @param {*} [options] Override http request option.
|
|
41693
|
+
* @throws {RequiredError}
|
|
41694
|
+
* @memberof LoyaltyIntegerationsApiInterface
|
|
41695
|
+
*/
|
|
41696
|
+
getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<LoyaltyWalletRewardsDto>;
|
|
41697
|
+
|
|
41286
41698
|
/**
|
|
41287
41699
|
*
|
|
41288
41700
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -41450,6 +41862,19 @@ export class LoyaltyIntegerationsApi extends BaseAPI implements LoyaltyIntegerat
|
|
|
41450
41862
|
return LoyaltyIntegerationsApiFp(this.configuration).getUserWallet(businessId, userId, options).then((request) => request(this.axios, this.basePath));
|
|
41451
41863
|
}
|
|
41452
41864
|
|
|
41865
|
+
/**
|
|
41866
|
+
*
|
|
41867
|
+
* @summary Get a member\'s activated and claimed wallet rewards for a till
|
|
41868
|
+
* @param {number} businessId
|
|
41869
|
+
* @param {number} userId
|
|
41870
|
+
* @param {*} [options] Override http request option.
|
|
41871
|
+
* @throws {RequiredError}
|
|
41872
|
+
* @memberof LoyaltyIntegerationsApi
|
|
41873
|
+
*/
|
|
41874
|
+
public getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig) {
|
|
41875
|
+
return LoyaltyIntegerationsApiFp(this.configuration).getWalletRewards(businessId, userId, options).then((request) => request(this.axios, this.basePath));
|
|
41876
|
+
}
|
|
41877
|
+
|
|
41453
41878
|
/**
|
|
41454
41879
|
*
|
|
41455
41880
|
* @summary Resolve the loyalty member context for a member on a till surface
|
|
@@ -44649,6 +45074,125 @@ export class OrdersApi extends BaseAPI implements OrdersApiInterface {
|
|
|
44649
45074
|
}
|
|
44650
45075
|
|
|
44651
45076
|
|
|
45077
|
+
/**
|
|
45078
|
+
* POSPermissionsApi - axios parameter creator
|
|
45079
|
+
* @export
|
|
45080
|
+
*/
|
|
45081
|
+
export const POSPermissionsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
45082
|
+
return {
|
|
45083
|
+
/**
|
|
45084
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45085
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45086
|
+
* @param {*} [options] Override http request option.
|
|
45087
|
+
* @throws {RequiredError}
|
|
45088
|
+
*/
|
|
45089
|
+
listPosPermissions: async (options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
45090
|
+
const localVarPath = `/api/v1/pos-permissions`;
|
|
45091
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
45092
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
45093
|
+
let baseOptions;
|
|
45094
|
+
if (configuration) {
|
|
45095
|
+
baseOptions = configuration.baseOptions;
|
|
45096
|
+
}
|
|
45097
|
+
|
|
45098
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
45099
|
+
const localVarHeaderParameter = {} as any;
|
|
45100
|
+
const localVarQueryParameter = {} as any;
|
|
45101
|
+
|
|
45102
|
+
// authentication JWT-auth required
|
|
45103
|
+
// http bearer authentication required
|
|
45104
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
45105
|
+
|
|
45106
|
+
|
|
45107
|
+
|
|
45108
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
45109
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
45110
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
45111
|
+
|
|
45112
|
+
return {
|
|
45113
|
+
url: toPathString(localVarUrlObj),
|
|
45114
|
+
options: localVarRequestOptions,
|
|
45115
|
+
};
|
|
45116
|
+
},
|
|
45117
|
+
}
|
|
45118
|
+
};
|
|
45119
|
+
|
|
45120
|
+
/**
|
|
45121
|
+
* POSPermissionsApi - functional programming interface
|
|
45122
|
+
* @export
|
|
45123
|
+
*/
|
|
45124
|
+
export const POSPermissionsApiFp = function(configuration?: Configuration) {
|
|
45125
|
+
const localVarAxiosParamCreator = POSPermissionsApiAxiosParamCreator(configuration)
|
|
45126
|
+
return {
|
|
45127
|
+
/**
|
|
45128
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45129
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45130
|
+
* @param {*} [options] Override http request option.
|
|
45131
|
+
* @throws {RequiredError}
|
|
45132
|
+
*/
|
|
45133
|
+
async listPosPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosPermissionCatalogResponseDto>> {
|
|
45134
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.listPosPermissions(options);
|
|
45135
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
45136
|
+
},
|
|
45137
|
+
}
|
|
45138
|
+
};
|
|
45139
|
+
|
|
45140
|
+
/**
|
|
45141
|
+
* POSPermissionsApi - factory interface
|
|
45142
|
+
* @export
|
|
45143
|
+
*/
|
|
45144
|
+
export const POSPermissionsApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
45145
|
+
const localVarFp = POSPermissionsApiFp(configuration)
|
|
45146
|
+
return {
|
|
45147
|
+
/**
|
|
45148
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45149
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45150
|
+
* @param {*} [options] Override http request option.
|
|
45151
|
+
* @throws {RequiredError}
|
|
45152
|
+
*/
|
|
45153
|
+
listPosPermissions(options?: any): AxiosPromise<PosPermissionCatalogResponseDto> {
|
|
45154
|
+
return localVarFp.listPosPermissions(options).then((request) => request(axios, basePath));
|
|
45155
|
+
},
|
|
45156
|
+
};
|
|
45157
|
+
};
|
|
45158
|
+
|
|
45159
|
+
/**
|
|
45160
|
+
* POSPermissionsApi - interface
|
|
45161
|
+
* @export
|
|
45162
|
+
* @interface POSPermissionsApi
|
|
45163
|
+
*/
|
|
45164
|
+
export interface POSPermissionsApiInterface {
|
|
45165
|
+
/**
|
|
45166
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45167
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45168
|
+
* @param {*} [options] Override http request option.
|
|
45169
|
+
* @throws {RequiredError}
|
|
45170
|
+
* @memberof POSPermissionsApiInterface
|
|
45171
|
+
*/
|
|
45172
|
+
listPosPermissions(options?: AxiosRequestConfig): AxiosPromise<PosPermissionCatalogResponseDto>;
|
|
45173
|
+
|
|
45174
|
+
}
|
|
45175
|
+
|
|
45176
|
+
/**
|
|
45177
|
+
* POSPermissionsApi - object-oriented interface
|
|
45178
|
+
* @export
|
|
45179
|
+
* @class POSPermissionsApi
|
|
45180
|
+
* @extends {BaseAPI}
|
|
45181
|
+
*/
|
|
45182
|
+
export class POSPermissionsApi extends BaseAPI implements POSPermissionsApiInterface {
|
|
45183
|
+
/**
|
|
45184
|
+
* The back office builds its employee-role and passcode checkboxes from this list, so a key added on the server appears there without a new label in the app. The list is the same for every venue.
|
|
45185
|
+
* @summary Every POS key, with its group, its name and what it lets a person do
|
|
45186
|
+
* @param {*} [options] Override http request option.
|
|
45187
|
+
* @throws {RequiredError}
|
|
45188
|
+
* @memberof POSPermissionsApi
|
|
45189
|
+
*/
|
|
45190
|
+
public listPosPermissions(options?: AxiosRequestConfig) {
|
|
45191
|
+
return POSPermissionsApiFp(this.configuration).listPosPermissions(options).then((request) => request(this.axios, this.basePath));
|
|
45192
|
+
}
|
|
45193
|
+
}
|
|
45194
|
+
|
|
45195
|
+
|
|
44652
45196
|
/**
|
|
44653
45197
|
* POSSessionApi - axios parameter creator
|
|
44654
45198
|
* @export
|
|
@@ -54221,6 +54765,44 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
54221
54765
|
|
|
54222
54766
|
|
|
54223
54767
|
|
|
54768
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54769
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54770
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54771
|
+
|
|
54772
|
+
return {
|
|
54773
|
+
url: toPathString(localVarUrlObj),
|
|
54774
|
+
options: localVarRequestOptions,
|
|
54775
|
+
};
|
|
54776
|
+
},
|
|
54777
|
+
/**
|
|
54778
|
+
*
|
|
54779
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
54780
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54781
|
+
* @param {*} [options] Override http request option.
|
|
54782
|
+
* @throws {RequiredError}
|
|
54783
|
+
*/
|
|
54784
|
+
lockTill: async (businessId: number, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54785
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
54786
|
+
assertParamExists('lockTill', 'businessId', businessId)
|
|
54787
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/lock`
|
|
54788
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
54789
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54790
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54791
|
+
let baseOptions;
|
|
54792
|
+
if (configuration) {
|
|
54793
|
+
baseOptions = configuration.baseOptions;
|
|
54794
|
+
}
|
|
54795
|
+
|
|
54796
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
54797
|
+
const localVarHeaderParameter = {} as any;
|
|
54798
|
+
const localVarQueryParameter = {} as any;
|
|
54799
|
+
|
|
54800
|
+
// authentication JWT-auth required
|
|
54801
|
+
// http bearer authentication required
|
|
54802
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
54803
|
+
|
|
54804
|
+
|
|
54805
|
+
|
|
54224
54806
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54225
54807
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54226
54808
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -54264,6 +54846,51 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
54264
54846
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54265
54847
|
localVarRequestOptions.data = serializeDataIfNeeded(unlockTerminalDto, localVarRequestOptions, configuration)
|
|
54266
54848
|
|
|
54849
|
+
return {
|
|
54850
|
+
url: toPathString(localVarUrlObj),
|
|
54851
|
+
options: localVarRequestOptions,
|
|
54852
|
+
};
|
|
54853
|
+
},
|
|
54854
|
+
/**
|
|
54855
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
54856
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
54857
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54858
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
54859
|
+
* @param {*} [options] Override http request option.
|
|
54860
|
+
* @throws {RequiredError}
|
|
54861
|
+
*/
|
|
54862
|
+
unlockTillWithPin: async (businessId: number, xPosPin: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54863
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
54864
|
+
assertParamExists('unlockTillWithPin', 'businessId', businessId)
|
|
54865
|
+
// verify required parameter 'xPosPin' is not null or undefined
|
|
54866
|
+
assertParamExists('unlockTillWithPin', 'xPosPin', xPosPin)
|
|
54867
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/unlock`
|
|
54868
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
54869
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54870
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54871
|
+
let baseOptions;
|
|
54872
|
+
if (configuration) {
|
|
54873
|
+
baseOptions = configuration.baseOptions;
|
|
54874
|
+
}
|
|
54875
|
+
|
|
54876
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
54877
|
+
const localVarHeaderParameter = {} as any;
|
|
54878
|
+
const localVarQueryParameter = {} as any;
|
|
54879
|
+
|
|
54880
|
+
// authentication JWT-auth required
|
|
54881
|
+
// http bearer authentication required
|
|
54882
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
54883
|
+
|
|
54884
|
+
if (xPosPin != null) {
|
|
54885
|
+
localVarHeaderParameter['X-Pos-Pin'] = String(xPosPin);
|
|
54886
|
+
}
|
|
54887
|
+
|
|
54888
|
+
|
|
54889
|
+
|
|
54890
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54891
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54892
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54893
|
+
|
|
54267
54894
|
return {
|
|
54268
54895
|
url: toPathString(localVarUrlObj),
|
|
54269
54896
|
options: localVarRequestOptions,
|
|
@@ -54312,6 +54939,17 @@ export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
|
54312
54939
|
const localVarAxiosArgs = await localVarAxiosParamCreator.getTodayShift(businessId, employeeId, options);
|
|
54313
54940
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54314
54941
|
},
|
|
54942
|
+
/**
|
|
54943
|
+
*
|
|
54944
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
54945
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54946
|
+
* @param {*} [options] Override http request option.
|
|
54947
|
+
* @throws {RequiredError}
|
|
54948
|
+
*/
|
|
54949
|
+
async lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
54950
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.lockTill(businessId, options);
|
|
54951
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54952
|
+
},
|
|
54315
54953
|
/**
|
|
54316
54954
|
*
|
|
54317
54955
|
* @param {string} businessId
|
|
@@ -54323,6 +54961,18 @@ export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
|
54323
54961
|
const localVarAxiosArgs = await localVarAxiosParamCreator.unlock(businessId, unlockTerminalDto, options);
|
|
54324
54962
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54325
54963
|
},
|
|
54964
|
+
/**
|
|
54965
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
54966
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
54967
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
54968
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
54969
|
+
* @param {*} [options] Override http request option.
|
|
54970
|
+
* @throws {RequiredError}
|
|
54971
|
+
*/
|
|
54972
|
+
async unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeSessionResponseDto>> {
|
|
54973
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.unlockTillWithPin(businessId, xPosPin, options);
|
|
54974
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54975
|
+
},
|
|
54326
54976
|
}
|
|
54327
54977
|
};
|
|
54328
54978
|
|
|
@@ -54363,6 +55013,16 @@ export const ShiftTrackingApiFactory = function (configuration?: Configuration,
|
|
|
54363
55013
|
getTodayShift(businessId: string, employeeId: string, options?: any): AxiosPromise<TodayShiftResponseDto> {
|
|
54364
55014
|
return localVarFp.getTodayShift(businessId, employeeId, options).then((request) => request(axios, basePath));
|
|
54365
55015
|
},
|
|
55016
|
+
/**
|
|
55017
|
+
*
|
|
55018
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
55019
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55020
|
+
* @param {*} [options] Override http request option.
|
|
55021
|
+
* @throws {RequiredError}
|
|
55022
|
+
*/
|
|
55023
|
+
lockTill(businessId: number, options?: any): AxiosPromise<void> {
|
|
55024
|
+
return localVarFp.lockTill(businessId, options).then((request) => request(axios, basePath));
|
|
55025
|
+
},
|
|
54366
55026
|
/**
|
|
54367
55027
|
*
|
|
54368
55028
|
* @param {string} businessId
|
|
@@ -54373,6 +55033,17 @@ export const ShiftTrackingApiFactory = function (configuration?: Configuration,
|
|
|
54373
55033
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: any): AxiosPromise<EmployeeSessionResponseDto> {
|
|
54374
55034
|
return localVarFp.unlock(businessId, unlockTerminalDto, options).then((request) => request(axios, basePath));
|
|
54375
55035
|
},
|
|
55036
|
+
/**
|
|
55037
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
55038
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
55039
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55040
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
55041
|
+
* @param {*} [options] Override http request option.
|
|
55042
|
+
* @throws {RequiredError}
|
|
55043
|
+
*/
|
|
55044
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: any): AxiosPromise<EmployeeSessionResponseDto> {
|
|
55045
|
+
return localVarFp.unlockTillWithPin(businessId, xPosPin, options).then((request) => request(axios, basePath));
|
|
55046
|
+
},
|
|
54376
55047
|
};
|
|
54377
55048
|
};
|
|
54378
55049
|
|
|
@@ -54412,6 +55083,16 @@ export interface ShiftTrackingApiInterface {
|
|
|
54412
55083
|
*/
|
|
54413
55084
|
getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): AxiosPromise<TodayShiftResponseDto>;
|
|
54414
55085
|
|
|
55086
|
+
/**
|
|
55087
|
+
*
|
|
55088
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
55089
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55090
|
+
* @param {*} [options] Override http request option.
|
|
55091
|
+
* @throws {RequiredError}
|
|
55092
|
+
* @memberof ShiftTrackingApiInterface
|
|
55093
|
+
*/
|
|
55094
|
+
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
55095
|
+
|
|
54415
55096
|
/**
|
|
54416
55097
|
*
|
|
54417
55098
|
* @param {string} businessId
|
|
@@ -54422,6 +55103,17 @@ export interface ShiftTrackingApiInterface {
|
|
|
54422
55103
|
*/
|
|
54423
55104
|
unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
|
|
54424
55105
|
|
|
55106
|
+
/**
|
|
55107
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
55108
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
55109
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55110
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
55111
|
+
* @param {*} [options] Override http request option.
|
|
55112
|
+
* @throws {RequiredError}
|
|
55113
|
+
* @memberof ShiftTrackingApiInterface
|
|
55114
|
+
*/
|
|
55115
|
+
unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
|
|
55116
|
+
|
|
54425
55117
|
}
|
|
54426
55118
|
|
|
54427
55119
|
/**
|
|
@@ -54467,6 +55159,18 @@ export class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterfa
|
|
|
54467
55159
|
return ShiftTrackingApiFp(this.configuration).getTodayShift(businessId, employeeId, options).then((request) => request(this.axios, this.basePath));
|
|
54468
55160
|
}
|
|
54469
55161
|
|
|
55162
|
+
/**
|
|
55163
|
+
*
|
|
55164
|
+
* @summary Lock the till: nobody is working on it until the next PIN unlocks it
|
|
55165
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55166
|
+
* @param {*} [options] Override http request option.
|
|
55167
|
+
* @throws {RequiredError}
|
|
55168
|
+
* @memberof ShiftTrackingApi
|
|
55169
|
+
*/
|
|
55170
|
+
public lockTill(businessId: number, options?: AxiosRequestConfig) {
|
|
55171
|
+
return ShiftTrackingApiFp(this.configuration).lockTill(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
55172
|
+
}
|
|
55173
|
+
|
|
54470
55174
|
/**
|
|
54471
55175
|
*
|
|
54472
55176
|
* @param {string} businessId
|
|
@@ -54478,6 +55182,19 @@ export class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterfa
|
|
|
54478
55182
|
public unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig) {
|
|
54479
55183
|
return ShiftTrackingApiFp(this.configuration).unlock(businessId, unlockTerminalDto, options).then((request) => request(this.axios, this.basePath));
|
|
54480
55184
|
}
|
|
55185
|
+
|
|
55186
|
+
/**
|
|
55187
|
+
* Team mode only. The server finds the active staff member of the venue with this PIN, checks that their role may open the POS app, and records them as the person working on this till. The answer carries their open shift at the venue, if any; unlike v1, the shift\'s session is not rotated. After 5 wrong PINs the till waits 60 seconds.
|
|
55188
|
+
* @summary Unlock the till with a staff member\'s PIN, checked on the server
|
|
55189
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55190
|
+
* @param {string} xPosPin The staff member\'s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
|
|
55191
|
+
* @param {*} [options] Override http request option.
|
|
55192
|
+
* @throws {RequiredError}
|
|
55193
|
+
* @memberof ShiftTrackingApi
|
|
55194
|
+
*/
|
|
55195
|
+
public unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig) {
|
|
55196
|
+
return ShiftTrackingApiFp(this.configuration).unlockTillWithPin(businessId, xPosPin, options).then((request) => request(this.axios, this.basePath));
|
|
55197
|
+
}
|
|
54481
55198
|
}
|
|
54482
55199
|
|
|
54483
55200
|
|