@munchi_oy/core 2.10.0 → 2.11.1
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 +299 -50
- 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 +446 -50
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -2789,6 +2789,25 @@ export interface ChangeShiftDto {
|
|
|
2789
2789
|
*/
|
|
2790
2790
|
'clockOutTime'?: string;
|
|
2791
2791
|
}
|
|
2792
|
+
/**
|
|
2793
|
+
*
|
|
2794
|
+
* @export
|
|
2795
|
+
* @interface ChangeStoreAppDto
|
|
2796
|
+
*/
|
|
2797
|
+
export interface ChangeStoreAppDto {
|
|
2798
|
+
/**
|
|
2799
|
+
* true adds the app to the store\'s list (kept once, at the end); false removes it
|
|
2800
|
+
* @type {boolean}
|
|
2801
|
+
* @memberof ChangeStoreAppDto
|
|
2802
|
+
*/
|
|
2803
|
+
'added': boolean;
|
|
2804
|
+
/**
|
|
2805
|
+
* The list the store shows today, saved as the store\'s list when it has none yet, with this change applied on top; ignored once the store has a list. Each app at most once; an empty list is a store that shows none.
|
|
2806
|
+
* @type {Array<StoreApp>}
|
|
2807
|
+
* @memberof ChangeStoreAppDto
|
|
2808
|
+
*/
|
|
2809
|
+
'startWith': Array<StoreApp>;
|
|
2810
|
+
}
|
|
2792
2811
|
/**
|
|
2793
2812
|
*
|
|
2794
2813
|
* @export
|
|
@@ -29502,6 +29521,19 @@ export declare const SavedReportVisibility: {
|
|
|
29502
29521
|
readonly Public: "public";
|
|
29503
29522
|
};
|
|
29504
29523
|
export type SavedReportVisibility = typeof SavedReportVisibility[keyof typeof SavedReportVisibility];
|
|
29524
|
+
/**
|
|
29525
|
+
*
|
|
29526
|
+
* @export
|
|
29527
|
+
* @interface SavedStoreAppsDto
|
|
29528
|
+
*/
|
|
29529
|
+
export interface SavedStoreAppsDto {
|
|
29530
|
+
/**
|
|
29531
|
+
* The store\'s list as saved now, in the order the apps were added
|
|
29532
|
+
* @type {Array<StoreApp>}
|
|
29533
|
+
* @memberof SavedStoreAppsDto
|
|
29534
|
+
*/
|
|
29535
|
+
'apps': Array<StoreApp>;
|
|
29536
|
+
}
|
|
29505
29537
|
/**
|
|
29506
29538
|
*
|
|
29507
29539
|
* @export
|
|
@@ -30328,6 +30360,19 @@ export interface StaffShiftDto {
|
|
|
30328
30360
|
*/
|
|
30329
30361
|
'name': string;
|
|
30330
30362
|
}
|
|
30363
|
+
/**
|
|
30364
|
+
*
|
|
30365
|
+
* @export
|
|
30366
|
+
* @interface StartStoreAppsDto
|
|
30367
|
+
*/
|
|
30368
|
+
export interface StartStoreAppsDto {
|
|
30369
|
+
/**
|
|
30370
|
+
* The apps the store shows today, saved as its list only when it has none yet; a list already saved is kept as it is. Each app at most once; an empty list is a store that shows none.
|
|
30371
|
+
* @type {Array<StoreApp>}
|
|
30372
|
+
* @memberof StartStoreAppsDto
|
|
30373
|
+
*/
|
|
30374
|
+
'apps': Array<StoreApp>;
|
|
30375
|
+
}
|
|
30331
30376
|
/**
|
|
30332
30377
|
*
|
|
30333
30378
|
* @export
|
|
@@ -30592,6 +30637,36 @@ export declare const Status: {
|
|
|
30592
30637
|
readonly Inactive: "INACTIVE";
|
|
30593
30638
|
};
|
|
30594
30639
|
export type Status = typeof Status[keyof typeof Status];
|
|
30640
|
+
/**
|
|
30641
|
+
*
|
|
30642
|
+
* @export
|
|
30643
|
+
* @enum {string}
|
|
30644
|
+
*/
|
|
30645
|
+
export declare const StoreApp: {
|
|
30646
|
+
readonly OnlineStore: "online_store";
|
|
30647
|
+
readonly Kiosk: "kiosk";
|
|
30648
|
+
readonly Kitchen: "kitchen";
|
|
30649
|
+
readonly Loyalty: "loyalty";
|
|
30650
|
+
readonly OrderStatus: "order_status";
|
|
30651
|
+
readonly Reservation: "reservation";
|
|
30652
|
+
readonly GiftCard: "gift_card";
|
|
30653
|
+
readonly AriCalls: "ari_calls";
|
|
30654
|
+
readonly AriOrders: "ari_orders";
|
|
30655
|
+
};
|
|
30656
|
+
export type StoreApp = typeof StoreApp[keyof typeof StoreApp];
|
|
30657
|
+
/**
|
|
30658
|
+
*
|
|
30659
|
+
* @export
|
|
30660
|
+
* @interface StoreAppsDto
|
|
30661
|
+
*/
|
|
30662
|
+
export interface StoreAppsDto {
|
|
30663
|
+
/**
|
|
30664
|
+
* The store\'s saved list, in the order the apps were added; null while nobody has saved one for the store yet, when the dashboard shows the apps the store uses.
|
|
30665
|
+
* @type {Array<StoreApp>}
|
|
30666
|
+
* @memberof StoreAppsDto
|
|
30667
|
+
*/
|
|
30668
|
+
'apps': Array<StoreApp> | null;
|
|
30669
|
+
}
|
|
30595
30670
|
/**
|
|
30596
30671
|
*
|
|
30597
30672
|
* @export
|
|
@@ -41274,7 +41349,7 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
41274
41349
|
*/
|
|
41275
41350
|
create: (businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41276
41351
|
/**
|
|
41277
|
-
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries).
|
|
41352
|
+
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries). A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
41278
41353
|
* @summary One page of the venue\'s cash entries in a period
|
|
41279
41354
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41280
41355
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41340,7 +41415,7 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
41340
41415
|
*/
|
|
41341
41416
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashSessionDto>>;
|
|
41342
41417
|
/**
|
|
41343
|
-
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries).
|
|
41418
|
+
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries). A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
41344
41419
|
* @summary One page of the venue\'s cash entries in a period
|
|
41345
41420
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41346
41421
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41406,7 +41481,7 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
41406
41481
|
*/
|
|
41407
41482
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: any): AxiosPromise<CashSessionDto>;
|
|
41408
41483
|
/**
|
|
41409
|
-
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries).
|
|
41484
|
+
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries). A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
41410
41485
|
* @summary One page of the venue\'s cash entries in a period
|
|
41411
41486
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41412
41487
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41474,7 +41549,7 @@ export interface CashManagementApiInterface {
|
|
|
41474
41549
|
*/
|
|
41475
41550
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig): AxiosPromise<CashSessionDto>;
|
|
41476
41551
|
/**
|
|
41477
|
-
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries).
|
|
41552
|
+
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries). A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
41478
41553
|
* @summary One page of the venue\'s cash entries in a period
|
|
41479
41554
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41480
41555
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41548,7 +41623,7 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
41548
41623
|
*/
|
|
41549
41624
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashSessionDto, any, {}>>;
|
|
41550
41625
|
/**
|
|
41551
|
-
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries).
|
|
41626
|
+
* Every entry of the venue in the period, oldest first, without the closing counts (CLOSING entries). A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
41552
41627
|
* @summary One page of the venue\'s cash entries in a period
|
|
41553
41628
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41554
41629
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -43319,7 +43394,7 @@ export declare const EmployeeRolesApiAxiosParamCreator: (configuration?: Configu
|
|
|
43319
43394
|
*/
|
|
43320
43395
|
changeEmployeeRole: (businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43321
43396
|
/**
|
|
43322
|
-
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
43397
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43323
43398
|
* @summary List the venue\'s employee roles
|
|
43324
43399
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43325
43400
|
* @param {*} [options] Override http request option.
|
|
@@ -43369,7 +43444,7 @@ export declare const EmployeeRolesApiFp: (configuration?: Configuration) => {
|
|
|
43369
43444
|
*/
|
|
43370
43445
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>>;
|
|
43371
43446
|
/**
|
|
43372
|
-
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
43447
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43373
43448
|
* @summary List the venue\'s employee roles
|
|
43374
43449
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43375
43450
|
* @param {*} [options] Override http request option.
|
|
@@ -43419,7 +43494,7 @@ export declare const EmployeeRolesApiFactory: (configuration?: Configuration, ba
|
|
|
43419
43494
|
*/
|
|
43420
43495
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto>;
|
|
43421
43496
|
/**
|
|
43422
|
-
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
43497
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43423
43498
|
* @summary List the venue\'s employee roles
|
|
43424
43499
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43425
43500
|
* @param {*} [options] Override http request option.
|
|
@@ -43473,7 +43548,7 @@ export interface EmployeeRolesApiInterface {
|
|
|
43473
43548
|
*/
|
|
43474
43549
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
43475
43550
|
/**
|
|
43476
|
-
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
43551
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43477
43552
|
* @summary List the venue\'s employee roles
|
|
43478
43553
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43479
43554
|
* @param {*} [options] Override http request option.
|
|
@@ -43530,7 +43605,7 @@ export declare class EmployeeRolesApi extends BaseAPI implements EmployeeRolesAp
|
|
|
43530
43605
|
*/
|
|
43531
43606
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto, any, {}>>;
|
|
43532
43607
|
/**
|
|
43533
|
-
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
43608
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43534
43609
|
* @summary List the venue\'s employee roles
|
|
43535
43610
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43536
43611
|
* @param {*} [options] Override http request option.
|
|
@@ -43574,7 +43649,7 @@ export declare const EmployeesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
43574
43649
|
*/
|
|
43575
43650
|
changeEmployee: (businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43576
43651
|
/**
|
|
43577
|
-
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
43652
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43578
43653
|
* @summary List the venue\'s employees
|
|
43579
43654
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43580
43655
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43628,7 +43703,7 @@ export declare const EmployeesApiFp: (configuration?: Configuration) => {
|
|
|
43628
43703
|
*/
|
|
43629
43704
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
43630
43705
|
/**
|
|
43631
|
-
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
43706
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43632
43707
|
* @summary List the venue\'s employees
|
|
43633
43708
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43634
43709
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43682,7 +43757,7 @@ export declare const EmployeesApiFactory: (configuration?: Configuration, basePa
|
|
|
43682
43757
|
*/
|
|
43683
43758
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
43684
43759
|
/**
|
|
43685
|
-
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
43760
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43686
43761
|
* @summary List the venue\'s employees
|
|
43687
43762
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43688
43763
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43739,7 +43814,7 @@ export interface EmployeesApiInterface {
|
|
|
43739
43814
|
*/
|
|
43740
43815
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
43741
43816
|
/**
|
|
43742
|
-
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
43817
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43743
43818
|
* @summary List the venue\'s employees
|
|
43744
43819
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43745
43820
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43800,7 +43875,7 @@ export declare class EmployeesApi extends BaseAPI implements EmployeesApiInterfa
|
|
|
43800
43875
|
*/
|
|
43801
43876
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
43802
43877
|
/**
|
|
43803
|
-
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
43878
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
43804
43879
|
* @summary List the venue\'s employees
|
|
43805
43880
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43806
43881
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -44882,7 +44957,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44882
44957
|
*/
|
|
44883
44958
|
listOnlineOrderHistoryForServices: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44884
44959
|
/**
|
|
44885
|
-
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till.
|
|
44960
|
+
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
44886
44961
|
* @summary Online order history of the venues, every order and total
|
|
44887
44962
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44888
44963
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44903,7 +44978,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44903
44978
|
*/
|
|
44904
44979
|
listOnlineOrderHistoryForTill: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44905
44980
|
/**
|
|
44906
|
-
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
44981
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server, or a Munchi-internal Clerk API key, gets the v5 answer unchanged; a partner\'s key is refused.
|
|
44907
44982
|
* @summary POS order history, narrowed to the person working on the till
|
|
44908
44983
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44909
44984
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44951,7 +45026,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
44951
45026
|
*/
|
|
44952
45027
|
listOnlineOrderHistoryForServices(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryResponseDto>>;
|
|
44953
45028
|
/**
|
|
44954
|
-
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till.
|
|
45029
|
+
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
44955
45030
|
* @summary Online order history of the venues, every order and total
|
|
44956
45031
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44957
45032
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44972,7 +45047,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
44972
45047
|
*/
|
|
44973
45048
|
listOnlineOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<OrderHistoryResponseDto>>;
|
|
44974
45049
|
/**
|
|
44975
|
-
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
45050
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server, or a Munchi-internal Clerk API key, gets the v5 answer unchanged; a partner\'s key is refused.
|
|
44976
45051
|
* @summary POS order history, narrowed to the person working on the till
|
|
44977
45052
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44978
45053
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45020,7 +45095,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
45020
45095
|
*/
|
|
45021
45096
|
listOnlineOrderHistoryForServices(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: any): AxiosPromise<OrderHistoryResponseDto>;
|
|
45022
45097
|
/**
|
|
45023
|
-
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till.
|
|
45098
|
+
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
45024
45099
|
* @summary Online order history of the venues, every order and total
|
|
45025
45100
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45026
45101
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45041,7 +45116,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
45041
45116
|
*/
|
|
45042
45117
|
listOnlineOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: any): AxiosPromise<OrderHistoryResponseDto>;
|
|
45043
45118
|
/**
|
|
45044
|
-
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
45119
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server, or a Munchi-internal Clerk API key, gets the v5 answer unchanged; a partner\'s key is refused.
|
|
45045
45120
|
* @summary POS order history, narrowed to the person working on the till
|
|
45046
45121
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45047
45122
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45091,7 +45166,7 @@ export interface HistoryV6ApiInterface {
|
|
|
45091
45166
|
*/
|
|
45092
45167
|
listOnlineOrderHistoryForServices(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<OrderHistoryResponseDto>;
|
|
45093
45168
|
/**
|
|
45094
|
-
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till.
|
|
45169
|
+
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
45095
45170
|
* @summary Online order history of the venues, every order and total
|
|
45096
45171
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45097
45172
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45113,7 +45188,7 @@ export interface HistoryV6ApiInterface {
|
|
|
45113
45188
|
*/
|
|
45114
45189
|
listOnlineOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): AxiosPromise<OrderHistoryResponseDto>;
|
|
45115
45190
|
/**
|
|
45116
|
-
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
45191
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server, or a Munchi-internal Clerk API key, gets the v5 answer unchanged; a partner\'s key is refused.
|
|
45117
45192
|
* @summary POS order history, narrowed to the person working on the till
|
|
45118
45193
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45119
45194
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45165,7 +45240,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
45165
45240
|
*/
|
|
45166
45241
|
listOnlineOrderHistoryForServices(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryResponseDto, any, {}>>;
|
|
45167
45242
|
/**
|
|
45168
|
-
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till.
|
|
45243
|
+
* One page of the venues\' online orders, newest first, with the order counts and sales totals of the period. Online orders span venues and are not staff\'s, so they are answered whole whoever is unlocked on the till. A Munchi-internal Clerk API key reads every venue; a partner\'s key is refused.
|
|
45169
45244
|
* @summary Online order history of the venues, every order and total
|
|
45170
45245
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45171
45246
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45187,7 +45262,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
45187
45262
|
*/
|
|
45188
45263
|
listOnlineOrderHistoryForTill(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, page?: number, rowPerPage?: number, provider?: Array<ProviderEnum>, paymentType?: Array<PaymentTypeEnum>, orderStatus?: Array<OrderStatusEnum>, paymentStatus?: Array<PaymentStatus>, orderType?: Array<OrderType>, paymentTypePos?: Array<PaymentMethod>, invoiceCompanyId?: string, timezone?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<OrderHistoryResponseDto, any, {}>>;
|
|
45189
45264
|
/**
|
|
45190
|
-
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server gets the v5 answer unchanged.
|
|
45265
|
+
* The same answer as v5. In team mode, what the role of the person unlocked on the till may not see is returned as zero or an empty list, and without Transaction::ViewAll only that person\'s orders are listed and counted. A till with nobody unlocked on the server, or a Munchi-internal Clerk API key, gets the v5 answer unchanged; a partner\'s key is refused.
|
|
45191
45266
|
* @summary POS order history, narrowed to the person working on the till
|
|
45192
45267
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45193
45268
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -52880,7 +52955,7 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
52880
52955
|
*/
|
|
52881
52956
|
getBoughtTogether: (businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
52882
52957
|
/**
|
|
52883
|
-
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
52958
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is; a Munchi-internal Clerk API key gets the venue\'s whole report, and a partner\'s key is refused. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
52884
52959
|
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
52885
52960
|
* @param {number} businessId The venue the file is of, by business id
|
|
52886
52961
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -53043,7 +53118,7 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
53043
53118
|
*/
|
|
53044
53119
|
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SalesReportBoughtTogetherResponseDto>>;
|
|
53045
53120
|
/**
|
|
53046
|
-
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53121
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is; a Munchi-internal Clerk API key gets the venue\'s whole report, and a partner\'s key is refused. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53047
53122
|
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
53048
53123
|
* @param {number} businessId The venue the file is of, by business id
|
|
53049
53124
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -53206,7 +53281,7 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
53206
53281
|
*/
|
|
53207
53282
|
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: any): AxiosPromise<SalesReportBoughtTogetherResponseDto>;
|
|
53208
53283
|
/**
|
|
53209
|
-
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53284
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is; a Munchi-internal Clerk API key gets the venue\'s whole report, and a partner\'s key is refused. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53210
53285
|
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
53211
53286
|
* @param {number} businessId The venue the file is of, by business id
|
|
53212
53287
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -53371,7 +53446,7 @@ export interface ReportApiInterface {
|
|
|
53371
53446
|
*/
|
|
53372
53447
|
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<SalesReportBoughtTogetherResponseDto>;
|
|
53373
53448
|
/**
|
|
53374
|
-
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53449
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is; a Munchi-internal Clerk API key gets the venue\'s whole report, and a partner\'s key is refused. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53375
53450
|
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
53376
53451
|
* @param {number} businessId The venue the file is of, by business id
|
|
53377
53452
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -53546,7 +53621,7 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
53546
53621
|
*/
|
|
53547
53622
|
getBoughtTogether(businessIds: Array<number>, timeSpan?: TimeSpan, start?: string, end?: string, timezone?: string, apps?: Array<ReportApp>, breakdown?: ReportBreakdown, language?: string, itemKey?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SalesReportBoughtTogetherResponseDto, any, {}>>;
|
|
53548
53623
|
/**
|
|
53549
|
-
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53624
|
+
* The same report, rendered by the same generator, as the PDF the report e-mail (POST /api/v6/report/email) attaches, answered as the file itself instead of e-mailed. The period is the e-mail\'s: timeSpan DAY (the venue\'s business day), WEEK, MONTH, YEAR, or CUSTOM between start and end. A till\'s ticket gets it narrowed to the person on the till, as the e-mail is; a Munchi-internal Clerk API key gets the venue\'s whole report, and a partner\'s key is refused. Answers application/pdf with Content-Disposition attachment and the file\'s name.
|
|
53550
53625
|
* @summary End-of-day sales report of a venue as a PDF file to download, for a day, week, month, year or custom period
|
|
53551
53626
|
* @param {number} businessId The venue the file is of, by business id
|
|
53552
53627
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -56121,7 +56196,7 @@ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiI
|
|
|
56121
56196
|
*/
|
|
56122
56197
|
export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
56123
56198
|
/**
|
|
56124
|
-
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56199
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56125
56200
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56126
56201
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56127
56202
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56130,7 +56205,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56130
56205
|
*/
|
|
56131
56206
|
addShiftAtVenue: (businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56132
56207
|
/**
|
|
56133
|
-
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56208
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56134
56209
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56135
56210
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56136
56211
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56175,7 +56250,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56175
56250
|
*/
|
|
56176
56251
|
lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56177
56252
|
/**
|
|
56178
|
-
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56253
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56179
56254
|
* @summary Remove a shift recorded by mistake
|
|
56180
56255
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56181
56256
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56184,7 +56259,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56184
56259
|
*/
|
|
56185
56260
|
removeShiftAtVenue: (businessId: number, shiftId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56186
56261
|
/**
|
|
56187
|
-
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56262
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a Munchi-internal Clerk API key reads every venue; a partner\'s key is refused; a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56188
56263
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56189
56264
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56190
56265
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56234,7 +56309,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56234
56309
|
*/
|
|
56235
56310
|
export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
56236
56311
|
/**
|
|
56237
|
-
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56312
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56238
56313
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56239
56314
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56240
56315
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56243,7 +56318,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56243
56318
|
*/
|
|
56244
56319
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>>;
|
|
56245
56320
|
/**
|
|
56246
|
-
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56321
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56247
56322
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56248
56323
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56249
56324
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56288,7 +56363,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56288
56363
|
*/
|
|
56289
56364
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56290
56365
|
/**
|
|
56291
|
-
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56366
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56292
56367
|
* @summary Remove a shift recorded by mistake
|
|
56293
56368
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56294
56369
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56297,7 +56372,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56297
56372
|
*/
|
|
56298
56373
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56299
56374
|
/**
|
|
56300
|
-
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56375
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a Munchi-internal Clerk API key reads every venue; a partner\'s key is refused; a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56301
56376
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56302
56377
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56303
56378
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56347,7 +56422,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56347
56422
|
*/
|
|
56348
56423
|
export declare const ShiftTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
56349
56424
|
/**
|
|
56350
|
-
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56425
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56351
56426
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56352
56427
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56353
56428
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56356,7 +56431,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56356
56431
|
*/
|
|
56357
56432
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: any): AxiosPromise<StaffShiftDto>;
|
|
56358
56433
|
/**
|
|
56359
|
-
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56434
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56360
56435
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56361
56436
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56362
56437
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56401,7 +56476,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56401
56476
|
*/
|
|
56402
56477
|
lockTill(businessId: number, options?: any): AxiosPromise<void>;
|
|
56403
56478
|
/**
|
|
56404
|
-
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56479
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56405
56480
|
* @summary Remove a shift recorded by mistake
|
|
56406
56481
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56407
56482
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56410,7 +56485,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56410
56485
|
*/
|
|
56411
56486
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: any): AxiosPromise<void>;
|
|
56412
56487
|
/**
|
|
56413
|
-
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56488
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a Munchi-internal Clerk API key reads every venue; a partner\'s key is refused; a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56414
56489
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56415
56490
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56416
56491
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56461,7 +56536,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56461
56536
|
*/
|
|
56462
56537
|
export interface ShiftTrackingApiInterface {
|
|
56463
56538
|
/**
|
|
56464
|
-
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56539
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56465
56540
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56466
56541
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56467
56542
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56471,7 +56546,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56471
56546
|
*/
|
|
56472
56547
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
56473
56548
|
/**
|
|
56474
|
-
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56549
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56475
56550
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56476
56551
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56477
56552
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56521,7 +56596,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56521
56596
|
*/
|
|
56522
56597
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56523
56598
|
/**
|
|
56524
|
-
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56599
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56525
56600
|
* @summary Remove a shift recorded by mistake
|
|
56526
56601
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56527
56602
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56531,7 +56606,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56531
56606
|
*/
|
|
56532
56607
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56533
56608
|
/**
|
|
56534
|
-
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56609
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a Munchi-internal Clerk API key reads every venue; a partner\'s key is refused; a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56535
56610
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56536
56611
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56537
56612
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56587,7 +56662,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56587
56662
|
*/
|
|
56588
56663
|
export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterface {
|
|
56589
56664
|
/**
|
|
56590
|
-
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56665
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56591
56666
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56592
56667
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56593
56668
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56597,7 +56672,7 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56597
56672
|
*/
|
|
56598
56673
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffShiftDto, any, {}>>;
|
|
56599
56674
|
/**
|
|
56600
|
-
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56675
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56601
56676
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56602
56677
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56603
56678
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56647,7 +56722,7 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56647
56722
|
*/
|
|
56648
56723
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56649
56724
|
/**
|
|
56650
|
-
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56725
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it, on a person or on a Munchi-internal Clerk API key\'s scopes; a till\'s own ticket is always refused, so the person on the till never changes their own hours, and a partner\'s key is refused.
|
|
56651
56726
|
* @summary Remove a shift recorded by mistake
|
|
56652
56727
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56653
56728
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56657,7 +56732,7 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56657
56732
|
*/
|
|
56658
56733
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56659
56734
|
/**
|
|
56660
|
-
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56735
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a Munchi-internal Clerk API key reads every venue; a partner\'s key is refused; a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56661
56736
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56662
56737
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56663
56738
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56854,6 +56929,180 @@ export declare class StationsApi extends BaseAPI implements StationsApiInterface
|
|
|
56854
56929
|
*/
|
|
56855
56930
|
syncStation(syncStationDto: SyncStationDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StationSyncResponseDto, any, {}>>;
|
|
56856
56931
|
}
|
|
56932
|
+
/**
|
|
56933
|
+
* StoreAppsApi - axios parameter creator
|
|
56934
|
+
* @export
|
|
56935
|
+
*/
|
|
56936
|
+
export declare const StoreAppsApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
56937
|
+
/**
|
|
56938
|
+
* Adds the app at the end of the store\'s list (once) or removes it, in one statement on the saved list, so two people changing the store at once both land. A store with no list yet gets startWith with the change applied. Only the store\'s managers and its organisation\'s management may.
|
|
56939
|
+
* @summary Add one app to a store\'s Your apps, or remove it
|
|
56940
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
56941
|
+
* @param {StoreApp} app The app added to the store\'s Your apps, or removed from it
|
|
56942
|
+
* @param {ChangeStoreAppDto} changeStoreAppDto
|
|
56943
|
+
* @param {*} [options] Override http request option.
|
|
56944
|
+
* @throws {RequiredError}
|
|
56945
|
+
*/
|
|
56946
|
+
changeStoreApp: (businessId: number, app: StoreApp, changeStoreAppDto: ChangeStoreAppDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56947
|
+
/**
|
|
56948
|
+
* The store\'s saved list, shared by everyone working at the store; null while nobody has saved one yet. Read from the database every time.
|
|
56949
|
+
* @summary Read the apps a store added to Your apps
|
|
56950
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
56951
|
+
* @param {*} [options] Override http request option.
|
|
56952
|
+
* @throws {RequiredError}
|
|
56953
|
+
*/
|
|
56954
|
+
getStoreApps: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56955
|
+
/**
|
|
56956
|
+
* Saves the apps sent as the store\'s list only while the store has none, in one statement; a list already saved is kept as it is and answered, so it never overwrites anyone\'s change. Everyone working at the store may.
|
|
56957
|
+
* @summary Record the apps a store shows today as its list, unless it has one
|
|
56958
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
56959
|
+
* @param {StartStoreAppsDto} startStoreAppsDto
|
|
56960
|
+
* @param {*} [options] Override http request option.
|
|
56961
|
+
* @throws {RequiredError}
|
|
56962
|
+
*/
|
|
56963
|
+
startStoreApps: (businessId: number, startStoreAppsDto: StartStoreAppsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56964
|
+
};
|
|
56965
|
+
/**
|
|
56966
|
+
* StoreAppsApi - functional programming interface
|
|
56967
|
+
* @export
|
|
56968
|
+
*/
|
|
56969
|
+
export declare const StoreAppsApiFp: (configuration?: Configuration) => {
|
|
56970
|
+
/**
|
|
56971
|
+
* Adds the app at the end of the store\'s list (once) or removes it, in one statement on the saved list, so two people changing the store at once both land. A store with no list yet gets startWith with the change applied. Only the store\'s managers and its organisation\'s management may.
|
|
56972
|
+
* @summary Add one app to a store\'s Your apps, or remove it
|
|
56973
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
56974
|
+
* @param {StoreApp} app The app added to the store\'s Your apps, or removed from it
|
|
56975
|
+
* @param {ChangeStoreAppDto} changeStoreAppDto
|
|
56976
|
+
* @param {*} [options] Override http request option.
|
|
56977
|
+
* @throws {RequiredError}
|
|
56978
|
+
*/
|
|
56979
|
+
changeStoreApp(businessId: number, app: StoreApp, changeStoreAppDto: ChangeStoreAppDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedStoreAppsDto>>;
|
|
56980
|
+
/**
|
|
56981
|
+
* The store\'s saved list, shared by everyone working at the store; null while nobody has saved one yet. Read from the database every time.
|
|
56982
|
+
* @summary Read the apps a store added to Your apps
|
|
56983
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
56984
|
+
* @param {*} [options] Override http request option.
|
|
56985
|
+
* @throws {RequiredError}
|
|
56986
|
+
*/
|
|
56987
|
+
getStoreApps(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StoreAppsDto>>;
|
|
56988
|
+
/**
|
|
56989
|
+
* Saves the apps sent as the store\'s list only while the store has none, in one statement; a list already saved is kept as it is and answered, so it never overwrites anyone\'s change. Everyone working at the store may.
|
|
56990
|
+
* @summary Record the apps a store shows today as its list, unless it has one
|
|
56991
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
56992
|
+
* @param {StartStoreAppsDto} startStoreAppsDto
|
|
56993
|
+
* @param {*} [options] Override http request option.
|
|
56994
|
+
* @throws {RequiredError}
|
|
56995
|
+
*/
|
|
56996
|
+
startStoreApps(businessId: number, startStoreAppsDto: StartStoreAppsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<SavedStoreAppsDto>>;
|
|
56997
|
+
};
|
|
56998
|
+
/**
|
|
56999
|
+
* StoreAppsApi - factory interface
|
|
57000
|
+
* @export
|
|
57001
|
+
*/
|
|
57002
|
+
export declare const StoreAppsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
57003
|
+
/**
|
|
57004
|
+
* Adds the app at the end of the store\'s list (once) or removes it, in one statement on the saved list, so two people changing the store at once both land. A store with no list yet gets startWith with the change applied. Only the store\'s managers and its organisation\'s management may.
|
|
57005
|
+
* @summary Add one app to a store\'s Your apps, or remove it
|
|
57006
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57007
|
+
* @param {StoreApp} app The app added to the store\'s Your apps, or removed from it
|
|
57008
|
+
* @param {ChangeStoreAppDto} changeStoreAppDto
|
|
57009
|
+
* @param {*} [options] Override http request option.
|
|
57010
|
+
* @throws {RequiredError}
|
|
57011
|
+
*/
|
|
57012
|
+
changeStoreApp(businessId: number, app: StoreApp, changeStoreAppDto: ChangeStoreAppDto, options?: any): AxiosPromise<SavedStoreAppsDto>;
|
|
57013
|
+
/**
|
|
57014
|
+
* The store\'s saved list, shared by everyone working at the store; null while nobody has saved one yet. Read from the database every time.
|
|
57015
|
+
* @summary Read the apps a store added to Your apps
|
|
57016
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57017
|
+
* @param {*} [options] Override http request option.
|
|
57018
|
+
* @throws {RequiredError}
|
|
57019
|
+
*/
|
|
57020
|
+
getStoreApps(businessId: number, options?: any): AxiosPromise<StoreAppsDto>;
|
|
57021
|
+
/**
|
|
57022
|
+
* Saves the apps sent as the store\'s list only while the store has none, in one statement; a list already saved is kept as it is and answered, so it never overwrites anyone\'s change. Everyone working at the store may.
|
|
57023
|
+
* @summary Record the apps a store shows today as its list, unless it has one
|
|
57024
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57025
|
+
* @param {StartStoreAppsDto} startStoreAppsDto
|
|
57026
|
+
* @param {*} [options] Override http request option.
|
|
57027
|
+
* @throws {RequiredError}
|
|
57028
|
+
*/
|
|
57029
|
+
startStoreApps(businessId: number, startStoreAppsDto: StartStoreAppsDto, options?: any): AxiosPromise<SavedStoreAppsDto>;
|
|
57030
|
+
};
|
|
57031
|
+
/**
|
|
57032
|
+
* StoreAppsApi - interface
|
|
57033
|
+
* @export
|
|
57034
|
+
* @interface StoreAppsApi
|
|
57035
|
+
*/
|
|
57036
|
+
export interface StoreAppsApiInterface {
|
|
57037
|
+
/**
|
|
57038
|
+
* Adds the app at the end of the store\'s list (once) or removes it, in one statement on the saved list, so two people changing the store at once both land. A store with no list yet gets startWith with the change applied. Only the store\'s managers and its organisation\'s management may.
|
|
57039
|
+
* @summary Add one app to a store\'s Your apps, or remove it
|
|
57040
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57041
|
+
* @param {StoreApp} app The app added to the store\'s Your apps, or removed from it
|
|
57042
|
+
* @param {ChangeStoreAppDto} changeStoreAppDto
|
|
57043
|
+
* @param {*} [options] Override http request option.
|
|
57044
|
+
* @throws {RequiredError}
|
|
57045
|
+
* @memberof StoreAppsApiInterface
|
|
57046
|
+
*/
|
|
57047
|
+
changeStoreApp(businessId: number, app: StoreApp, changeStoreAppDto: ChangeStoreAppDto, options?: AxiosRequestConfig): AxiosPromise<SavedStoreAppsDto>;
|
|
57048
|
+
/**
|
|
57049
|
+
* The store\'s saved list, shared by everyone working at the store; null while nobody has saved one yet. Read from the database every time.
|
|
57050
|
+
* @summary Read the apps a store added to Your apps
|
|
57051
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57052
|
+
* @param {*} [options] Override http request option.
|
|
57053
|
+
* @throws {RequiredError}
|
|
57054
|
+
* @memberof StoreAppsApiInterface
|
|
57055
|
+
*/
|
|
57056
|
+
getStoreApps(businessId: number, options?: AxiosRequestConfig): AxiosPromise<StoreAppsDto>;
|
|
57057
|
+
/**
|
|
57058
|
+
* Saves the apps sent as the store\'s list only while the store has none, in one statement; a list already saved is kept as it is and answered, so it never overwrites anyone\'s change. Everyone working at the store may.
|
|
57059
|
+
* @summary Record the apps a store shows today as its list, unless it has one
|
|
57060
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57061
|
+
* @param {StartStoreAppsDto} startStoreAppsDto
|
|
57062
|
+
* @param {*} [options] Override http request option.
|
|
57063
|
+
* @throws {RequiredError}
|
|
57064
|
+
* @memberof StoreAppsApiInterface
|
|
57065
|
+
*/
|
|
57066
|
+
startStoreApps(businessId: number, startStoreAppsDto: StartStoreAppsDto, options?: AxiosRequestConfig): AxiosPromise<SavedStoreAppsDto>;
|
|
57067
|
+
}
|
|
57068
|
+
/**
|
|
57069
|
+
* StoreAppsApi - object-oriented interface
|
|
57070
|
+
* @export
|
|
57071
|
+
* @class StoreAppsApi
|
|
57072
|
+
* @extends {BaseAPI}
|
|
57073
|
+
*/
|
|
57074
|
+
export declare class StoreAppsApi extends BaseAPI implements StoreAppsApiInterface {
|
|
57075
|
+
/**
|
|
57076
|
+
* Adds the app at the end of the store\'s list (once) or removes it, in one statement on the saved list, so two people changing the store at once both land. A store with no list yet gets startWith with the change applied. Only the store\'s managers and its organisation\'s management may.
|
|
57077
|
+
* @summary Add one app to a store\'s Your apps, or remove it
|
|
57078
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57079
|
+
* @param {StoreApp} app The app added to the store\'s Your apps, or removed from it
|
|
57080
|
+
* @param {ChangeStoreAppDto} changeStoreAppDto
|
|
57081
|
+
* @param {*} [options] Override http request option.
|
|
57082
|
+
* @throws {RequiredError}
|
|
57083
|
+
* @memberof StoreAppsApi
|
|
57084
|
+
*/
|
|
57085
|
+
changeStoreApp(businessId: number, app: StoreApp, changeStoreAppDto: ChangeStoreAppDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedStoreAppsDto, any, {}>>;
|
|
57086
|
+
/**
|
|
57087
|
+
* The store\'s saved list, shared by everyone working at the store; null while nobody has saved one yet. Read from the database every time.
|
|
57088
|
+
* @summary Read the apps a store added to Your apps
|
|
57089
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57090
|
+
* @param {*} [options] Override http request option.
|
|
57091
|
+
* @throws {RequiredError}
|
|
57092
|
+
* @memberof StoreAppsApi
|
|
57093
|
+
*/
|
|
57094
|
+
getStoreApps(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StoreAppsDto, any, {}>>;
|
|
57095
|
+
/**
|
|
57096
|
+
* Saves the apps sent as the store\'s list only while the store has none, in one statement; a list already saved is kept as it is and answered, so it never overwrites anyone\'s change. Everyone working at the store may.
|
|
57097
|
+
* @summary Record the apps a store shows today as its list, unless it has one
|
|
57098
|
+
* @param {number} businessId The store\'s orderingBusinessId
|
|
57099
|
+
* @param {StartStoreAppsDto} startStoreAppsDto
|
|
57100
|
+
* @param {*} [options] Override http request option.
|
|
57101
|
+
* @throws {RequiredError}
|
|
57102
|
+
* @memberof StoreAppsApi
|
|
57103
|
+
*/
|
|
57104
|
+
startStoreApps(businessId: number, startStoreAppsDto: StartStoreAppsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<SavedStoreAppsDto, any, {}>>;
|
|
57105
|
+
}
|
|
56857
57106
|
/**
|
|
56858
57107
|
* TerminalApi - axios parameter creator
|
|
56859
57108
|
* @export
|