@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.
@@ -120,6 +120,25 @@ export interface AcceptOrderDto {
120
120
  */
121
121
  'preparedIn'?: number;
122
122
  }
123
+ /**
124
+ *
125
+ * @export
126
+ * @interface ActionPasscodeCheckResponseDto
127
+ */
128
+ export interface ActionPasscodeCheckResponseDto {
129
+ /**
130
+ * The passcode that approves this one action. Nothing is stored: the protected request carries the passcode again, and the next action asks again.
131
+ * @type {string}
132
+ * @memberof ActionPasscodeCheckResponseDto
133
+ */
134
+ 'passcodeId': string;
135
+ /**
136
+ * The passcode\'s name, as the merchant set it
137
+ * @type {string}
138
+ * @memberof ActionPasscodeCheckResponseDto
139
+ */
140
+ 'name': string;
141
+ }
123
142
  /**
124
143
  *
125
144
  * @export
@@ -2737,6 +2756,19 @@ export interface ChargeStatusResponseDto {
2737
2756
  */
2738
2757
  'errorCode'?: string | null;
2739
2758
  }
2759
+ /**
2760
+ *
2761
+ * @export
2762
+ * @interface CheckActionPasscodeDto
2763
+ */
2764
+ export interface CheckActionPasscodeDto {
2765
+ /**
2766
+ *
2767
+ * @type {PosPermission}
2768
+ * @memberof CheckActionPasscodeDto
2769
+ */
2770
+ 'key': PosPermission;
2771
+ }
2740
2772
  /**
2741
2773
  *
2742
2774
  * @export
@@ -3599,7 +3631,7 @@ export interface CreateManualSessionDto {
3599
3631
  */
3600
3632
  'order': CreateManualSessionDtoOrder;
3601
3633
  /**
3602
- * Cash handling config forwarded from the client. When enabled the backend additionally records a cash session.
3634
+ * 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.
3603
3635
  * @type {object}
3604
3636
  * @memberof CreateManualSessionDto
3605
3637
  */
@@ -9126,7 +9158,7 @@ export interface LoginResponseDtoUserInfo {
9126
9158
  */
9127
9159
  export interface LogoutResponseDto {
9128
9160
  /**
9129
- *
9161
+ * Confirmation that the session was deleted; the tokens of that session stop working
9130
9162
  * @type {string}
9131
9163
  * @memberof LogoutResponseDto
9132
9164
  */
@@ -10002,6 +10034,62 @@ export interface LoyaltyUserInfoResponseDto {
10002
10034
  [key: string]: LoyaltyInfoResponseDtoLinksValue;
10003
10035
  };
10004
10036
  }
10037
+ /**
10038
+ *
10039
+ * @export
10040
+ * @interface LoyaltyWalletRewardDto
10041
+ */
10042
+ export interface LoyaltyWalletRewardDto {
10043
+ /**
10044
+ *
10045
+ * @type {number}
10046
+ * @memberof LoyaltyWalletRewardDto
10047
+ */
10048
+ 'wallet_id': number;
10049
+ /**
10050
+ *
10051
+ * @type {number}
10052
+ * @memberof LoyaltyWalletRewardDto
10053
+ */
10054
+ 'catalog_id': number;
10055
+ /**
10056
+ *
10057
+ * @type {string}
10058
+ * @memberof LoyaltyWalletRewardDto
10059
+ */
10060
+ 'name': string | null;
10061
+ /**
10062
+ * When the reward stops being usable. A claim made before claims expired has none.
10063
+ * @type {string}
10064
+ * @memberof LoyaltyWalletRewardDto
10065
+ */
10066
+ 'expires_at': string | null;
10067
+ }
10068
+ /**
10069
+ *
10070
+ * @export
10071
+ * @interface LoyaltyWalletRewardsDto
10072
+ */
10073
+ export interface LoyaltyWalletRewardsDto {
10074
+ /**
10075
+ *
10076
+ * @type {number}
10077
+ * @memberof LoyaltyWalletRewardsDto
10078
+ */
10079
+ 'user_id': number;
10080
+ /**
10081
+ * Rewards the member activated whose window is still open, soonest to expire first
10082
+ * @type {Array<LoyaltyWalletRewardDto>}
10083
+ * @memberof LoyaltyWalletRewardsDto
10084
+ */
10085
+ 'activated': Array<LoyaltyWalletRewardDto>;
10086
+ /**
10087
+ * Rewards the member claimed and has not activated, newest first
10088
+ * @type {Array<LoyaltyWalletRewardDto>}
10089
+ * @memberof LoyaltyWalletRewardsDto
10090
+ */
10091
+ 'claimed': Array<LoyaltyWalletRewardDto>;
10092
+ }
10005
10093
  /**
10006
10094
  *
10007
10095
  * @export
@@ -18405,6 +18493,15 @@ export declare const PosPermission: {
18405
18493
  readonly CashSendReport: "Cash::SendReport";
18406
18494
  readonly Transaction: "Transaction::*";
18407
18495
  readonly TransactionRefund: "Transaction::Refund";
18496
+ readonly TransactionViewAll: "Transaction::ViewAll";
18497
+ readonly TransactionViewTips: "Transaction::ViewTips";
18498
+ readonly TransactionViewSurcharges: "Transaction::ViewSurcharges";
18499
+ readonly TransactionViewDiscounts: "Transaction::ViewDiscounts";
18500
+ readonly TransactionTotals: "TransactionTotals::*";
18501
+ readonly TransactionTotalsOrders: "TransactionTotals::Orders";
18502
+ readonly TransactionTotalsSales: "TransactionTotals::Sales";
18503
+ readonly TransactionTotalsRejectedOrders: "TransactionTotals::RejectedOrders";
18504
+ readonly TransactionTotalsRejectedSales: "TransactionTotals::RejectedSales";
18408
18505
  readonly Order: "Order::*";
18409
18506
  readonly OrderSendReceipt: "Order::SendReceipt";
18410
18507
  readonly OpenOrdersDelete: "OpenOrders::Delete";
@@ -18420,8 +18517,125 @@ export declare const PosPermission: {
18420
18517
  readonly SettingsEditProfile: "Settings::EditProfile";
18421
18518
  readonly Report: "Report::*";
18422
18519
  readonly ReportSendEmail: "Report::SendEmail";
18520
+ readonly ReportViewAll: "Report::ViewAll";
18521
+ readonly ReportViewSalesSummary: "Report::ViewSalesSummary";
18522
+ readonly ReportViewPaymentMethods: "Report::ViewPaymentMethods";
18523
+ readonly ReportViewItemSales: "Report::ViewItemSales";
18524
+ readonly ReportViewCashLogs: "Report::ViewCashLogs";
18525
+ readonly ReportTotals: "ReportTotals::*";
18526
+ readonly ReportTotalsOrders: "ReportTotals::Orders";
18527
+ readonly ReportTotalsSales: "ReportTotals::Sales";
18528
+ readonly ReportTotalsTips: "ReportTotals::Tips";
18529
+ readonly ReportTotalsSurcharges: "ReportTotals::Surcharges";
18530
+ readonly ReportTotalsRejectedOrders: "ReportTotals::RejectedOrders";
18531
+ readonly ReportTotalsRejectedSales: "ReportTotals::RejectedSales";
18532
+ readonly ReportTotalsAverageSale: "ReportTotals::AverageSale";
18533
+ readonly ReportTotalsItems: "ReportTotals::Items";
18534
+ readonly ReportTotalsRefunds: "ReportTotals::Refunds";
18535
+ readonly ReportTotalsDiscounts: "ReportTotals::Discounts";
18423
18536
  };
18424
18537
  export type PosPermission = typeof PosPermission[keyof typeof PosPermission];
18538
+ /**
18539
+ *
18540
+ * @export
18541
+ * @interface PosPermissionCatalogResponseDto
18542
+ */
18543
+ export interface PosPermissionCatalogResponseDto {
18544
+ /**
18545
+ * Every POS key the server knows, grouped as the POS groups them
18546
+ * @type {Array<PosPermissionGroupDto>}
18547
+ * @memberof PosPermissionCatalogResponseDto
18548
+ */
18549
+ 'groups': Array<PosPermissionGroupDto>;
18550
+ }
18551
+ /**
18552
+ *
18553
+ * @export
18554
+ * @interface PosPermissionDetailDto
18555
+ */
18556
+ export interface PosPermissionDetailDto {
18557
+ /**
18558
+ *
18559
+ * @type {PosPermission}
18560
+ * @memberof PosPermissionDetailDto
18561
+ */
18562
+ 'key': PosPermission;
18563
+ /**
18564
+ * The key\'s name, as the merchant sees it beside its checkbox
18565
+ * @type {string}
18566
+ * @memberof PosPermissionDetailDto
18567
+ */
18568
+ 'label': string;
18569
+ /**
18570
+ *
18571
+ * @type {PosPermissionKind}
18572
+ * @memberof PosPermissionDetailDto
18573
+ */
18574
+ 'kind': PosPermissionKind;
18575
+ }
18576
+ /**
18577
+ *
18578
+ * @export
18579
+ * @enum {string}
18580
+ */
18581
+ export declare const PosPermissionGroup: {
18582
+ readonly Access: "Access";
18583
+ readonly Page: "Page";
18584
+ readonly Cart: "Cart";
18585
+ readonly Cash: "Cash";
18586
+ readonly Transaction: "Transaction";
18587
+ readonly TransactionTotals: "TransactionTotals";
18588
+ readonly Order: "Order";
18589
+ readonly OpenOrders: "OpenOrders";
18590
+ readonly Shift: "Shift";
18591
+ readonly FloorPlan: "FloorPlan";
18592
+ readonly Settings: "Settings";
18593
+ readonly Report: "Report";
18594
+ readonly ReportTotals: "ReportTotals";
18595
+ };
18596
+ export type PosPermissionGroup = typeof PosPermissionGroup[keyof typeof PosPermissionGroup];
18597
+ /**
18598
+ *
18599
+ * @export
18600
+ * @interface PosPermissionGroupDto
18601
+ */
18602
+ export interface PosPermissionGroupDto {
18603
+ /**
18604
+ *
18605
+ * @type {PosPermissionGroup}
18606
+ * @memberof PosPermissionGroupDto
18607
+ */
18608
+ 'group': PosPermissionGroup;
18609
+ /**
18610
+ * The group\'s name, as the merchant sees it
18611
+ * @type {string}
18612
+ * @memberof PosPermissionGroupDto
18613
+ */
18614
+ 'label': string;
18615
+ /**
18616
+ *
18617
+ * @type {PosPermission}
18618
+ * @memberof PosPermissionGroupDto
18619
+ */
18620
+ 'wildcardKey'?: PosPermission;
18621
+ /**
18622
+ * The group\'s keys, in the order the POS lists them, without the wildcard key
18623
+ * @type {Array<PosPermissionDetailDto>}
18624
+ * @memberof PosPermissionGroupDto
18625
+ */
18626
+ 'permissions': Array<PosPermissionDetailDto>;
18627
+ }
18628
+ /**
18629
+ *
18630
+ * @export
18631
+ * @enum {string}
18632
+ */
18633
+ export declare const PosPermissionKind: {
18634
+ readonly Screen: "screen";
18635
+ readonly Action: "action";
18636
+ readonly Visibility: "visibility";
18637
+ };
18638
+ export type PosPermissionKind = typeof PosPermissionKind[keyof typeof PosPermissionKind];
18425
18639
  /**
18426
18640
  *
18427
18641
  * @export
@@ -28506,7 +28720,7 @@ export interface VoidManualSessionDto {
28506
28720
  */
28507
28721
  'orderId': string;
28508
28722
  /**
28509
- * Cash handling config forwarded from the client. When enabled the backend additionally records a REFUND cash log for the reversal.
28723
+ * 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.
28510
28724
  * @type {object}
28511
28725
  * @memberof VoidManualSessionDto
28512
28726
  */
@@ -29072,6 +29286,16 @@ export declare class AblyApi extends BaseAPI implements AblyApiInterface {
29072
29286
  * @export
29073
29287
  */
29074
29288
  export declare const ActionPasscodesApiAxiosParamCreator: (configuration?: Configuration) => {
29289
+ /**
29290
+ * 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.
29291
+ * @summary Check a manager passcode for one action, in pin-lock mode
29292
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
29293
+ * @param {string} xPosPin The manager\&#39;s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
29294
+ * @param {CheckActionPasscodeDto} checkActionPasscodeDto
29295
+ * @param {*} [options] Override http request option.
29296
+ * @throws {RequiredError}
29297
+ */
29298
+ checkActionPasscode: (businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
29075
29299
  /**
29076
29300
  *
29077
29301
  * @summary Create action passcode
@@ -29103,6 +29327,16 @@ export declare const ActionPasscodesApiAxiosParamCreator: (configuration?: Confi
29103
29327
  * @export
29104
29328
  */
29105
29329
  export declare const ActionPasscodesApiFp: (configuration?: Configuration) => {
29330
+ /**
29331
+ * 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.
29332
+ * @summary Check a manager passcode for one action, in pin-lock mode
29333
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
29334
+ * @param {string} xPosPin The manager\&#39;s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
29335
+ * @param {CheckActionPasscodeDto} checkActionPasscodeDto
29336
+ * @param {*} [options] Override http request option.
29337
+ * @throws {RequiredError}
29338
+ */
29339
+ checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ActionPasscodeCheckResponseDto>>;
29106
29340
  /**
29107
29341
  *
29108
29342
  * @summary Create action passcode
@@ -29134,6 +29368,16 @@ export declare const ActionPasscodesApiFp: (configuration?: Configuration) => {
29134
29368
  * @export
29135
29369
  */
29136
29370
  export declare const ActionPasscodesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
29371
+ /**
29372
+ * 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.
29373
+ * @summary Check a manager passcode for one action, in pin-lock mode
29374
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
29375
+ * @param {string} xPosPin The manager\&#39;s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
29376
+ * @param {CheckActionPasscodeDto} checkActionPasscodeDto
29377
+ * @param {*} [options] Override http request option.
29378
+ * @throws {RequiredError}
29379
+ */
29380
+ checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: any): AxiosPromise<ActionPasscodeCheckResponseDto>;
29137
29381
  /**
29138
29382
  *
29139
29383
  * @summary Create action passcode
@@ -29166,6 +29410,17 @@ export declare const ActionPasscodesApiFactory: (configuration?: Configuration,
29166
29410
  * @interface ActionPasscodesApi
29167
29411
  */
29168
29412
  export interface ActionPasscodesApiInterface {
29413
+ /**
29414
+ * 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.
29415
+ * @summary Check a manager passcode for one action, in pin-lock mode
29416
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
29417
+ * @param {string} xPosPin The manager\&#39;s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
29418
+ * @param {CheckActionPasscodeDto} checkActionPasscodeDto
29419
+ * @param {*} [options] Override http request option.
29420
+ * @throws {RequiredError}
29421
+ * @memberof ActionPasscodesApiInterface
29422
+ */
29423
+ checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): AxiosPromise<ActionPasscodeCheckResponseDto>;
29169
29424
  /**
29170
29425
  *
29171
29426
  * @summary Create action passcode
@@ -29202,6 +29457,17 @@ export interface ActionPasscodesApiInterface {
29202
29457
  * @extends {BaseAPI}
29203
29458
  */
29204
29459
  export declare class ActionPasscodesApi extends BaseAPI implements ActionPasscodesApiInterface {
29460
+ /**
29461
+ * 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.
29462
+ * @summary Check a manager passcode for one action, in pin-lock mode
29463
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
29464
+ * @param {string} xPosPin The manager\&#39;s 4-digit passcode. Sent only in this header, never in a body or a query, so no request log holds it.
29465
+ * @param {CheckActionPasscodeDto} checkActionPasscodeDto
29466
+ * @param {*} [options] Override http request option.
29467
+ * @throws {RequiredError}
29468
+ * @memberof ActionPasscodesApi
29469
+ */
29470
+ checkActionPasscode(businessId: number, xPosPin: string, checkActionPasscodeDto: CheckActionPasscodeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ActionPasscodeCheckResponseDto, any, {}>>;
29205
29471
  /**
29206
29472
  *
29207
29473
  * @summary Create action passcode
@@ -34631,6 +34897,15 @@ export declare const LoyaltyIntegerationsApiAxiosParamCreator: (configuration?:
34631
34897
  * @throws {RequiredError}
34632
34898
  */
34633
34899
  getUserWallet: (businessId: number, userId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34900
+ /**
34901
+ *
34902
+ * @summary Get a member\'s activated and claimed wallet rewards for a till
34903
+ * @param {number} businessId
34904
+ * @param {number} userId
34905
+ * @param {*} [options] Override http request option.
34906
+ * @throws {RequiredError}
34907
+ */
34908
+ getWalletRewards: (businessId: number, userId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
34634
34909
  /**
34635
34910
  *
34636
34911
  * @summary Resolve the loyalty member context for a member on a till surface
@@ -34753,6 +35028,15 @@ export declare const LoyaltyIntegerationsApiFp: (configuration?: Configuration)
34753
35028
  * @throws {RequiredError}
34754
35029
  */
34755
35030
  getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UserWalletResponseDto>>;
35031
+ /**
35032
+ *
35033
+ * @summary Get a member\'s activated and claimed wallet rewards for a till
35034
+ * @param {number} businessId
35035
+ * @param {number} userId
35036
+ * @param {*} [options] Override http request option.
35037
+ * @throws {RequiredError}
35038
+ */
35039
+ getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<LoyaltyWalletRewardsDto>>;
34756
35040
  /**
34757
35041
  *
34758
35042
  * @summary Resolve the loyalty member context for a member on a till surface
@@ -34875,6 +35159,15 @@ export declare const LoyaltyIntegerationsApiFactory: (configuration?: Configurat
34875
35159
  * @throws {RequiredError}
34876
35160
  */
34877
35161
  getUserWallet(businessId: number, userId: number, options?: any): AxiosPromise<UserWalletResponseDto>;
35162
+ /**
35163
+ *
35164
+ * @summary Get a member\'s activated and claimed wallet rewards for a till
35165
+ * @param {number} businessId
35166
+ * @param {number} userId
35167
+ * @param {*} [options] Override http request option.
35168
+ * @throws {RequiredError}
35169
+ */
35170
+ getWalletRewards(businessId: number, userId: number, options?: any): AxiosPromise<LoyaltyWalletRewardsDto>;
34878
35171
  /**
34879
35172
  *
34880
35173
  * @summary Resolve the loyalty member context for a member on a till surface
@@ -35006,6 +35299,16 @@ export interface LoyaltyIntegerationsApiInterface {
35006
35299
  * @memberof LoyaltyIntegerationsApiInterface
35007
35300
  */
35008
35301
  getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<UserWalletResponseDto>;
35302
+ /**
35303
+ *
35304
+ * @summary Get a member\'s activated and claimed wallet rewards for a till
35305
+ * @param {number} businessId
35306
+ * @param {number} userId
35307
+ * @param {*} [options] Override http request option.
35308
+ * @throws {RequiredError}
35309
+ * @memberof LoyaltyIntegerationsApiInterface
35310
+ */
35311
+ getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): AxiosPromise<LoyaltyWalletRewardsDto>;
35009
35312
  /**
35010
35313
  *
35011
35314
  * @summary Resolve the loyalty member context for a member on a till surface
@@ -35143,6 +35446,16 @@ export declare class LoyaltyIntegerationsApi extends BaseAPI implements LoyaltyI
35143
35446
  * @memberof LoyaltyIntegerationsApi
35144
35447
  */
35145
35448
  getUserWallet(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UserWalletResponseDto, any, {}>>;
35449
+ /**
35450
+ *
35451
+ * @summary Get a member\'s activated and claimed wallet rewards for a till
35452
+ * @param {number} businessId
35453
+ * @param {number} userId
35454
+ * @param {*} [options] Override http request option.
35455
+ * @throws {RequiredError}
35456
+ * @memberof LoyaltyIntegerationsApi
35457
+ */
35458
+ getWalletRewards(businessId: number, userId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<LoyaltyWalletRewardsDto, any, {}>>;
35146
35459
  /**
35147
35460
  *
35148
35461
  * @summary Resolve the loyalty member context for a member on a till surface
@@ -36919,6 +37232,76 @@ export declare class OrdersApi extends BaseAPI implements OrdersApiInterface {
36919
37232
  */
36920
37233
  updatePosOrderV2(posUpdateOrderDto: PosUpdateOrderDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderStatusResponseDto, any, {}>>;
36921
37234
  }
37235
+ /**
37236
+ * POSPermissionsApi - axios parameter creator
37237
+ * @export
37238
+ */
37239
+ export declare const POSPermissionsApiAxiosParamCreator: (configuration?: Configuration) => {
37240
+ /**
37241
+ * 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.
37242
+ * @summary Every POS key, with its group, its name and what it lets a person do
37243
+ * @param {*} [options] Override http request option.
37244
+ * @throws {RequiredError}
37245
+ */
37246
+ listPosPermissions: (options?: AxiosRequestConfig) => Promise<RequestArgs>;
37247
+ };
37248
+ /**
37249
+ * POSPermissionsApi - functional programming interface
37250
+ * @export
37251
+ */
37252
+ export declare const POSPermissionsApiFp: (configuration?: Configuration) => {
37253
+ /**
37254
+ * 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.
37255
+ * @summary Every POS key, with its group, its name and what it lets a person do
37256
+ * @param {*} [options] Override http request option.
37257
+ * @throws {RequiredError}
37258
+ */
37259
+ listPosPermissions(options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<PosPermissionCatalogResponseDto>>;
37260
+ };
37261
+ /**
37262
+ * POSPermissionsApi - factory interface
37263
+ * @export
37264
+ */
37265
+ export declare const POSPermissionsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
37266
+ /**
37267
+ * 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.
37268
+ * @summary Every POS key, with its group, its name and what it lets a person do
37269
+ * @param {*} [options] Override http request option.
37270
+ * @throws {RequiredError}
37271
+ */
37272
+ listPosPermissions(options?: any): AxiosPromise<PosPermissionCatalogResponseDto>;
37273
+ };
37274
+ /**
37275
+ * POSPermissionsApi - interface
37276
+ * @export
37277
+ * @interface POSPermissionsApi
37278
+ */
37279
+ export interface POSPermissionsApiInterface {
37280
+ /**
37281
+ * 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.
37282
+ * @summary Every POS key, with its group, its name and what it lets a person do
37283
+ * @param {*} [options] Override http request option.
37284
+ * @throws {RequiredError}
37285
+ * @memberof POSPermissionsApiInterface
37286
+ */
37287
+ listPosPermissions(options?: AxiosRequestConfig): AxiosPromise<PosPermissionCatalogResponseDto>;
37288
+ }
37289
+ /**
37290
+ * POSPermissionsApi - object-oriented interface
37291
+ * @export
37292
+ * @class POSPermissionsApi
37293
+ * @extends {BaseAPI}
37294
+ */
37295
+ export declare class POSPermissionsApi extends BaseAPI implements POSPermissionsApiInterface {
37296
+ /**
37297
+ * 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.
37298
+ * @summary Every POS key, with its group, its name and what it lets a person do
37299
+ * @param {*} [options] Override http request option.
37300
+ * @throws {RequiredError}
37301
+ * @memberof POSPermissionsApi
37302
+ */
37303
+ listPosPermissions(options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<PosPermissionCatalogResponseDto, any, {}>>;
37304
+ }
36922
37305
  /**
36923
37306
  * POSSessionApi - axios parameter creator
36924
37307
  * @export
@@ -42030,6 +42413,14 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
42030
42413
  * @throws {RequiredError}
42031
42414
  */
42032
42415
  getTodayShift: (businessId: string, employeeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42416
+ /**
42417
+ *
42418
+ * @summary Lock the till: nobody is working on it until the next PIN unlocks it
42419
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42420
+ * @param {*} [options] Override http request option.
42421
+ * @throws {RequiredError}
42422
+ */
42423
+ lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42033
42424
  /**
42034
42425
  *
42035
42426
  * @param {string} businessId
@@ -42038,6 +42429,15 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
42038
42429
  * @throws {RequiredError}
42039
42430
  */
42040
42431
  unlock: (businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42432
+ /**
42433
+ * 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.
42434
+ * @summary Unlock the till with a staff member\'s PIN, checked on the server
42435
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42436
+ * @param {string} xPosPin The staff member\&#39;s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
42437
+ * @param {*} [options] Override http request option.
42438
+ * @throws {RequiredError}
42439
+ */
42440
+ unlockTillWithPin: (businessId: number, xPosPin: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
42041
42441
  };
42042
42442
  /**
42043
42443
  * ShiftTrackingApi - functional programming interface
@@ -42068,6 +42468,14 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
42068
42468
  * @throws {RequiredError}
42069
42469
  */
42070
42470
  getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<TodayShiftResponseDto>>;
42471
+ /**
42472
+ *
42473
+ * @summary Lock the till: nobody is working on it until the next PIN unlocks it
42474
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42475
+ * @param {*} [options] Override http request option.
42476
+ * @throws {RequiredError}
42477
+ */
42478
+ lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
42071
42479
  /**
42072
42480
  *
42073
42481
  * @param {string} businessId
@@ -42076,6 +42484,15 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
42076
42484
  * @throws {RequiredError}
42077
42485
  */
42078
42486
  unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeSessionResponseDto>>;
42487
+ /**
42488
+ * 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.
42489
+ * @summary Unlock the till with a staff member\'s PIN, checked on the server
42490
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42491
+ * @param {string} xPosPin The staff member\&#39;s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
42492
+ * @param {*} [options] Override http request option.
42493
+ * @throws {RequiredError}
42494
+ */
42495
+ unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeSessionResponseDto>>;
42079
42496
  };
42080
42497
  /**
42081
42498
  * ShiftTrackingApi - factory interface
@@ -42106,6 +42523,14 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
42106
42523
  * @throws {RequiredError}
42107
42524
  */
42108
42525
  getTodayShift(businessId: string, employeeId: string, options?: any): AxiosPromise<TodayShiftResponseDto>;
42526
+ /**
42527
+ *
42528
+ * @summary Lock the till: nobody is working on it until the next PIN unlocks it
42529
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42530
+ * @param {*} [options] Override http request option.
42531
+ * @throws {RequiredError}
42532
+ */
42533
+ lockTill(businessId: number, options?: any): AxiosPromise<void>;
42109
42534
  /**
42110
42535
  *
42111
42536
  * @param {string} businessId
@@ -42114,6 +42539,15 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
42114
42539
  * @throws {RequiredError}
42115
42540
  */
42116
42541
  unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: any): AxiosPromise<EmployeeSessionResponseDto>;
42542
+ /**
42543
+ * 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.
42544
+ * @summary Unlock the till with a staff member\'s PIN, checked on the server
42545
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42546
+ * @param {string} xPosPin The staff member\&#39;s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
42547
+ * @param {*} [options] Override http request option.
42548
+ * @throws {RequiredError}
42549
+ */
42550
+ unlockTillWithPin(businessId: number, xPosPin: string, options?: any): AxiosPromise<EmployeeSessionResponseDto>;
42117
42551
  };
42118
42552
  /**
42119
42553
  * ShiftTrackingApi - interface
@@ -42148,6 +42582,15 @@ export interface ShiftTrackingApiInterface {
42148
42582
  * @memberof ShiftTrackingApiInterface
42149
42583
  */
42150
42584
  getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): AxiosPromise<TodayShiftResponseDto>;
42585
+ /**
42586
+ *
42587
+ * @summary Lock the till: nobody is working on it until the next PIN unlocks it
42588
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42589
+ * @param {*} [options] Override http request option.
42590
+ * @throws {RequiredError}
42591
+ * @memberof ShiftTrackingApiInterface
42592
+ */
42593
+ lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
42151
42594
  /**
42152
42595
  *
42153
42596
  * @param {string} businessId
@@ -42157,6 +42600,16 @@ export interface ShiftTrackingApiInterface {
42157
42600
  * @memberof ShiftTrackingApiInterface
42158
42601
  */
42159
42602
  unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
42603
+ /**
42604
+ * 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.
42605
+ * @summary Unlock the till with a staff member\'s PIN, checked on the server
42606
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42607
+ * @param {string} xPosPin The staff member\&#39;s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
42608
+ * @param {*} [options] Override http request option.
42609
+ * @throws {RequiredError}
42610
+ * @memberof ShiftTrackingApiInterface
42611
+ */
42612
+ unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): AxiosPromise<EmployeeSessionResponseDto>;
42160
42613
  }
42161
42614
  /**
42162
42615
  * ShiftTrackingApi - object-oriented interface
@@ -42192,6 +42645,15 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
42192
42645
  * @memberof ShiftTrackingApi
42193
42646
  */
42194
42647
  getTodayShift(businessId: string, employeeId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<TodayShiftResponseDto, any, {}>>;
42648
+ /**
42649
+ *
42650
+ * @summary Lock the till: nobody is working on it until the next PIN unlocks it
42651
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42652
+ * @param {*} [options] Override http request option.
42653
+ * @throws {RequiredError}
42654
+ * @memberof ShiftTrackingApi
42655
+ */
42656
+ lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
42195
42657
  /**
42196
42658
  *
42197
42659
  * @param {string} businessId
@@ -42201,6 +42663,16 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
42201
42663
  * @memberof ShiftTrackingApi
42202
42664
  */
42203
42665
  unlock(businessId: string, unlockTerminalDto: UnlockTerminalDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeSessionResponseDto, any, {}>>;
42666
+ /**
42667
+ * 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.
42668
+ * @summary Unlock the till with a staff member\'s PIN, checked on the server
42669
+ * @param {number} businessId The venue\&#39;s orderingBusinessId
42670
+ * @param {string} xPosPin The staff member\&#39;s 4-digit PIN. Sent only in this header, never in a body or a query, so no request log holds it.
42671
+ * @param {*} [options] Override http request option.
42672
+ * @throws {RequiredError}
42673
+ * @memberof ShiftTrackingApi
42674
+ */
42675
+ unlockTillWithPin(businessId: number, xPosPin: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeSessionResponseDto, any, {}>>;
42204
42676
  }
42205
42677
  /**
42206
42678
  * StationsApi - axios parameter creator