@munchi_oy/core 2.9.0 → 2.11.0
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- package/dist/generated/api.d.ts +432 -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/src/version.d.ts.map +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +660 -50
- package/package.json +13 -15
- 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 {Set<StoreApp>}
|
|
2807
|
+
* @memberof ChangeStoreAppDto
|
|
2808
|
+
*/
|
|
2809
|
+
'startWith': Set<StoreApp>;
|
|
2810
|
+
}
|
|
2792
2811
|
/**
|
|
2793
2812
|
*
|
|
2794
2813
|
* @export
|
|
@@ -11129,6 +11148,31 @@ export interface KdsStationDto {
|
|
|
11129
11148
|
* @memberof KdsStationDto
|
|
11130
11149
|
*/
|
|
11131
11150
|
'categoryIds': Array<string>;
|
|
11151
|
+
/**
|
|
11152
|
+
* The ordering channels whose whole orders this station takes, whatever its categories list; an empty list when it takes none
|
|
11153
|
+
* @type {Array<ProviderEnum>}
|
|
11154
|
+
* @memberof KdsStationDto
|
|
11155
|
+
*/
|
|
11156
|
+
'channels': Array<ProviderEnum>;
|
|
11157
|
+
}
|
|
11158
|
+
/**
|
|
11159
|
+
*
|
|
11160
|
+
* @export
|
|
11161
|
+
* @interface KioskAutoRejectDto
|
|
11162
|
+
*/
|
|
11163
|
+
export interface KioskAutoRejectDto {
|
|
11164
|
+
/**
|
|
11165
|
+
* The kiosk order\'s id
|
|
11166
|
+
* @type {string}
|
|
11167
|
+
* @memberof KioskAutoRejectDto
|
|
11168
|
+
*/
|
|
11169
|
+
'orderId': string;
|
|
11170
|
+
/**
|
|
11171
|
+
* The venue whose order this is, by its venue id
|
|
11172
|
+
* @type {number}
|
|
11173
|
+
* @memberof KioskAutoRejectDto
|
|
11174
|
+
*/
|
|
11175
|
+
'orderingBusinessId': number;
|
|
11132
11176
|
}
|
|
11133
11177
|
/**
|
|
11134
11178
|
*
|
|
@@ -29477,6 +29521,19 @@ export declare const SavedReportVisibility: {
|
|
|
29477
29521
|
readonly Public: "public";
|
|
29478
29522
|
};
|
|
29479
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
|
+
}
|
|
29480
29537
|
/**
|
|
29481
29538
|
*
|
|
29482
29539
|
* @export
|
|
@@ -29676,6 +29733,25 @@ export interface SetEmployeeRoleDto {
|
|
|
29676
29733
|
*/
|
|
29677
29734
|
'roleId': string;
|
|
29678
29735
|
}
|
|
29736
|
+
/**
|
|
29737
|
+
*
|
|
29738
|
+
* @export
|
|
29739
|
+
* @interface SetKdsChannelStationsDto
|
|
29740
|
+
*/
|
|
29741
|
+
export interface SetKdsChannelStationsDto {
|
|
29742
|
+
/**
|
|
29743
|
+
* The Munchi venue id (orderingBusinessId) the stations belong to
|
|
29744
|
+
* @type {number}
|
|
29745
|
+
* @memberof SetKdsChannelStationsDto
|
|
29746
|
+
*/
|
|
29747
|
+
'businessId': number;
|
|
29748
|
+
/**
|
|
29749
|
+
* The complete set of stations taking the channel\'s whole orders, by their ids in kds-service: it replaces the set the channel had. An empty list clears it
|
|
29750
|
+
* @type {Array<string>}
|
|
29751
|
+
* @memberof SetKdsChannelStationsDto
|
|
29752
|
+
*/
|
|
29753
|
+
'stationIds': Array<string>;
|
|
29754
|
+
}
|
|
29679
29755
|
/**
|
|
29680
29756
|
*
|
|
29681
29757
|
* @export
|
|
@@ -30284,6 +30360,19 @@ export interface StaffShiftDto {
|
|
|
30284
30360
|
*/
|
|
30285
30361
|
'name': string;
|
|
30286
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 {Set<StoreApp>}
|
|
30372
|
+
* @memberof StartStoreAppsDto
|
|
30373
|
+
*/
|
|
30374
|
+
'apps': Set<StoreApp>;
|
|
30375
|
+
}
|
|
30287
30376
|
/**
|
|
30288
30377
|
*
|
|
30289
30378
|
* @export
|
|
@@ -30548,6 +30637,36 @@ export declare const Status: {
|
|
|
30548
30637
|
readonly Inactive: "INACTIVE";
|
|
30549
30638
|
};
|
|
30550
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
|
+
}
|
|
30551
30670
|
/**
|
|
30552
30671
|
*
|
|
30553
30672
|
* @export
|
|
@@ -41230,7 +41349,7 @@ export declare const CashManagementApiAxiosParamCreator: (configuration?: Config
|
|
|
41230
41349
|
*/
|
|
41231
41350
|
create: (businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
41232
41351
|
/**
|
|
41233
|
-
* 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.
|
|
41234
41353
|
* @summary One page of the venue\'s cash entries in a period
|
|
41235
41354
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41236
41355
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41296,7 +41415,7 @@ export declare const CashManagementApiFp: (configuration?: Configuration) => {
|
|
|
41296
41415
|
*/
|
|
41297
41416
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CashSessionDto>>;
|
|
41298
41417
|
/**
|
|
41299
|
-
* 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.
|
|
41300
41419
|
* @summary One page of the venue\'s cash entries in a period
|
|
41301
41420
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41302
41421
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41362,7 +41481,7 @@ export declare const CashManagementApiFactory: (configuration?: Configuration, b
|
|
|
41362
41481
|
*/
|
|
41363
41482
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: any): AxiosPromise<CashSessionDto>;
|
|
41364
41483
|
/**
|
|
41365
|
-
* 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.
|
|
41366
41485
|
* @summary One page of the venue\'s cash entries in a period
|
|
41367
41486
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41368
41487
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41430,7 +41549,7 @@ export interface CashManagementApiInterface {
|
|
|
41430
41549
|
*/
|
|
41431
41550
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig): AxiosPromise<CashSessionDto>;
|
|
41432
41551
|
/**
|
|
41433
|
-
* 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.
|
|
41434
41553
|
* @summary One page of the venue\'s cash entries in a period
|
|
41435
41554
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41436
41555
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -41504,7 +41623,7 @@ export declare class CashManagementApi extends BaseAPI implements CashManagement
|
|
|
41504
41623
|
*/
|
|
41505
41624
|
create(businessId: string, cashSessionDto: CashSessionDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CashSessionDto, any, {}>>;
|
|
41506
41625
|
/**
|
|
41507
|
-
* 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.
|
|
41508
41627
|
* @summary One page of the venue\'s cash entries in a period
|
|
41509
41628
|
* @param {string} businessId The venue\'s id (its orderingBusinessId), as text
|
|
41510
41629
|
* @param {TimeSpan} [timeSpan] The period to read; with no time span, today from midnight until now
|
|
@@ -43275,7 +43394,7 @@ export declare const EmployeeRolesApiAxiosParamCreator: (configuration?: Configu
|
|
|
43275
43394
|
*/
|
|
43276
43395
|
changeEmployeeRole: (businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43277
43396
|
/**
|
|
43278
|
-
* 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.
|
|
43279
43398
|
* @summary List the venue\'s employee roles
|
|
43280
43399
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43281
43400
|
* @param {*} [options] Override http request option.
|
|
@@ -43325,7 +43444,7 @@ export declare const EmployeeRolesApiFp: (configuration?: Configuration) => {
|
|
|
43325
43444
|
*/
|
|
43326
43445
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>>;
|
|
43327
43446
|
/**
|
|
43328
|
-
* 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.
|
|
43329
43448
|
* @summary List the venue\'s employee roles
|
|
43330
43449
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43331
43450
|
* @param {*} [options] Override http request option.
|
|
@@ -43375,7 +43494,7 @@ export declare const EmployeeRolesApiFactory: (configuration?: Configuration, ba
|
|
|
43375
43494
|
*/
|
|
43376
43495
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto>;
|
|
43377
43496
|
/**
|
|
43378
|
-
* 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.
|
|
43379
43498
|
* @summary List the venue\'s employee roles
|
|
43380
43499
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43381
43500
|
* @param {*} [options] Override http request option.
|
|
@@ -43429,7 +43548,7 @@ export interface EmployeeRolesApiInterface {
|
|
|
43429
43548
|
*/
|
|
43430
43549
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
43431
43550
|
/**
|
|
43432
|
-
* 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.
|
|
43433
43552
|
* @summary List the venue\'s employee roles
|
|
43434
43553
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43435
43554
|
* @param {*} [options] Override http request option.
|
|
@@ -43486,7 +43605,7 @@ export declare class EmployeeRolesApi extends BaseAPI implements EmployeeRolesAp
|
|
|
43486
43605
|
*/
|
|
43487
43606
|
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto, any, {}>>;
|
|
43488
43607
|
/**
|
|
43489
|
-
* 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.
|
|
43490
43609
|
* @summary List the venue\'s employee roles
|
|
43491
43610
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43492
43611
|
* @param {*} [options] Override http request option.
|
|
@@ -43530,7 +43649,7 @@ export declare const EmployeesApiAxiosParamCreator: (configuration?: Configurati
|
|
|
43530
43649
|
*/
|
|
43531
43650
|
changeEmployee: (businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
43532
43651
|
/**
|
|
43533
|
-
* 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.
|
|
43534
43653
|
* @summary List the venue\'s employees
|
|
43535
43654
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43536
43655
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43584,7 +43703,7 @@ export declare const EmployeesApiFp: (configuration?: Configuration) => {
|
|
|
43584
43703
|
*/
|
|
43585
43704
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
43586
43705
|
/**
|
|
43587
|
-
* 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.
|
|
43588
43707
|
* @summary List the venue\'s employees
|
|
43589
43708
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43590
43709
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43638,7 +43757,7 @@ export declare const EmployeesApiFactory: (configuration?: Configuration, basePa
|
|
|
43638
43757
|
*/
|
|
43639
43758
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
43640
43759
|
/**
|
|
43641
|
-
* 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.
|
|
43642
43761
|
* @summary List the venue\'s employees
|
|
43643
43762
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43644
43763
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43695,7 +43814,7 @@ export interface EmployeesApiInterface {
|
|
|
43695
43814
|
*/
|
|
43696
43815
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
43697
43816
|
/**
|
|
43698
|
-
* 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.
|
|
43699
43818
|
* @summary List the venue\'s employees
|
|
43700
43819
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43701
43820
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -43756,7 +43875,7 @@ export declare class EmployeesApi extends BaseAPI implements EmployeesApiInterfa
|
|
|
43756
43875
|
*/
|
|
43757
43876
|
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
43758
43877
|
/**
|
|
43759
|
-
* 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.
|
|
43760
43879
|
* @summary List the venue\'s employees
|
|
43761
43880
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
43762
43881
|
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
@@ -44838,7 +44957,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44838
44957
|
*/
|
|
44839
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>;
|
|
44840
44959
|
/**
|
|
44841
|
-
* 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.
|
|
44842
44961
|
* @summary Online order history of the venues, every order and total
|
|
44843
44962
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44844
44963
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44859,7 +44978,7 @@ export declare const HistoryV6ApiAxiosParamCreator: (configuration?: Configurati
|
|
|
44859
44978
|
*/
|
|
44860
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>;
|
|
44861
44980
|
/**
|
|
44862
|
-
* 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.
|
|
44863
44982
|
* @summary POS order history, narrowed to the person working on the till
|
|
44864
44983
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44865
44984
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44907,7 +45026,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
44907
45026
|
*/
|
|
44908
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>>;
|
|
44909
45028
|
/**
|
|
44910
|
-
* 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.
|
|
44911
45030
|
* @summary Online order history of the venues, every order and total
|
|
44912
45031
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44913
45032
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44928,7 +45047,7 @@ export declare const HistoryV6ApiFp: (configuration?: Configuration) => {
|
|
|
44928
45047
|
*/
|
|
44929
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>>;
|
|
44930
45049
|
/**
|
|
44931
|
-
* 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.
|
|
44932
45051
|
* @summary POS order history, narrowed to the person working on the till
|
|
44933
45052
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44934
45053
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44976,7 +45095,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
44976
45095
|
*/
|
|
44977
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>;
|
|
44978
45097
|
/**
|
|
44979
|
-
* 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.
|
|
44980
45099
|
* @summary Online order history of the venues, every order and total
|
|
44981
45100
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
44982
45101
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -44997,7 +45116,7 @@ export declare const HistoryV6ApiFactory: (configuration?: Configuration, basePa
|
|
|
44997
45116
|
*/
|
|
44998
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>;
|
|
44999
45118
|
/**
|
|
45000
|
-
* 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.
|
|
45001
45120
|
* @summary POS order history, narrowed to the person working on the till
|
|
45002
45121
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45003
45122
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45047,7 +45166,7 @@ export interface HistoryV6ApiInterface {
|
|
|
45047
45166
|
*/
|
|
45048
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>;
|
|
45049
45168
|
/**
|
|
45050
|
-
* 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.
|
|
45051
45170
|
* @summary Online order history of the venues, every order and total
|
|
45052
45171
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45053
45172
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45069,7 +45188,7 @@ export interface HistoryV6ApiInterface {
|
|
|
45069
45188
|
*/
|
|
45070
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>;
|
|
45071
45190
|
/**
|
|
45072
|
-
* 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.
|
|
45073
45192
|
* @summary POS order history, narrowed to the person working on the till
|
|
45074
45193
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45075
45194
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45121,7 +45240,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
45121
45240
|
*/
|
|
45122
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, {}>>;
|
|
45123
45242
|
/**
|
|
45124
|
-
* 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.
|
|
45125
45244
|
* @summary Online order history of the venues, every order and total
|
|
45126
45245
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45127
45246
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45143,7 +45262,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
45143
45262
|
*/
|
|
45144
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, {}>>;
|
|
45145
45264
|
/**
|
|
45146
|
-
* 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.
|
|
45147
45266
|
* @summary POS order history, narrowed to the person working on the till
|
|
45148
45267
|
* @param {Array<number>} businessIds The venues asked about, by business id
|
|
45149
45268
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -45555,6 +45674,15 @@ export declare const KDSApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
45555
45674
|
* @throws {RequiredError}
|
|
45556
45675
|
*/
|
|
45557
45676
|
listKdsStations: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45677
|
+
/**
|
|
45678
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45679
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45680
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45681
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45682
|
+
* @param {*} [options] Override http request option.
|
|
45683
|
+
* @throws {RequiredError}
|
|
45684
|
+
*/
|
|
45685
|
+
setKdsChannelStations: (channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45558
45686
|
/**
|
|
45559
45687
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45560
45688
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45645,6 +45773,15 @@ export declare const KDSApiFp: (configuration?: Configuration) => {
|
|
|
45645
45773
|
* @throws {RequiredError}
|
|
45646
45774
|
*/
|
|
45647
45775
|
listKdsStations(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<KdsStationDto>>>;
|
|
45776
|
+
/**
|
|
45777
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45778
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45779
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45780
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45781
|
+
* @param {*} [options] Override http request option.
|
|
45782
|
+
* @throws {RequiredError}
|
|
45783
|
+
*/
|
|
45784
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<KdsStationDto>>>;
|
|
45648
45785
|
/**
|
|
45649
45786
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45650
45787
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45735,6 +45872,15 @@ export declare const KDSApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
45735
45872
|
* @throws {RequiredError}
|
|
45736
45873
|
*/
|
|
45737
45874
|
listKdsStations(businessId: number, options?: any): AxiosPromise<Array<KdsStationDto>>;
|
|
45875
|
+
/**
|
|
45876
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45877
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45878
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45879
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45880
|
+
* @param {*} [options] Override http request option.
|
|
45881
|
+
* @throws {RequiredError}
|
|
45882
|
+
*/
|
|
45883
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: any): AxiosPromise<Array<KdsStationDto>>;
|
|
45738
45884
|
/**
|
|
45739
45885
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45740
45886
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45834,6 +45980,16 @@ export interface KDSApiInterface {
|
|
|
45834
45980
|
* @memberof KDSApiInterface
|
|
45835
45981
|
*/
|
|
45836
45982
|
listKdsStations(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<KdsStationDto>>;
|
|
45983
|
+
/**
|
|
45984
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45985
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45986
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45987
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45988
|
+
* @param {*} [options] Override http request option.
|
|
45989
|
+
* @throws {RequiredError}
|
|
45990
|
+
* @memberof KDSApiInterface
|
|
45991
|
+
*/
|
|
45992
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig): AxiosPromise<Array<KdsStationDto>>;
|
|
45837
45993
|
/**
|
|
45838
45994
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45839
45995
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45935,6 +46091,16 @@ export declare class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
45935
46091
|
* @memberof KDSApi
|
|
45936
46092
|
*/
|
|
45937
46093
|
listKdsStations(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsStationDto[], any, {}>>;
|
|
46094
|
+
/**
|
|
46095
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46096
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
46097
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
46098
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
46099
|
+
* @param {*} [options] Override http request option.
|
|
46100
|
+
* @throws {RequiredError}
|
|
46101
|
+
* @memberof KDSApi
|
|
46102
|
+
*/
|
|
46103
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsStationDto[], any, {}>>;
|
|
45938
46104
|
/**
|
|
45939
46105
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45940
46106
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -52789,7 +52955,7 @@ export declare const ReportApiAxiosParamCreator: (configuration?: Configuration)
|
|
|
52789
52955
|
*/
|
|
52790
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>;
|
|
52791
52957
|
/**
|
|
52792
|
-
* 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.
|
|
52793
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
|
|
52794
52960
|
* @param {number} businessId The venue the file is of, by business id
|
|
52795
52961
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -52952,7 +53118,7 @@ export declare const ReportApiFp: (configuration?: Configuration) => {
|
|
|
52952
53118
|
*/
|
|
52953
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>>;
|
|
52954
53120
|
/**
|
|
52955
|
-
* 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.
|
|
52956
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
|
|
52957
53123
|
* @param {number} businessId The venue the file is of, by business id
|
|
52958
53124
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -53115,7 +53281,7 @@ export declare const ReportApiFactory: (configuration?: Configuration, basePath?
|
|
|
53115
53281
|
*/
|
|
53116
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>;
|
|
53117
53283
|
/**
|
|
53118
|
-
* 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.
|
|
53119
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
|
|
53120
53286
|
* @param {number} businessId The venue the file is of, by business id
|
|
53121
53287
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -53280,7 +53446,7 @@ export interface ReportApiInterface {
|
|
|
53280
53446
|
*/
|
|
53281
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>;
|
|
53282
53448
|
/**
|
|
53283
|
-
* 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.
|
|
53284
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
|
|
53285
53451
|
* @param {number} businessId The venue the file is of, by business id
|
|
53286
53452
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -53455,7 +53621,7 @@ export declare class ReportApi extends BaseAPI implements ReportApiInterface {
|
|
|
53455
53621
|
*/
|
|
53456
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, {}>>;
|
|
53457
53623
|
/**
|
|
53458
|
-
* 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.
|
|
53459
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
|
|
53460
53626
|
* @param {number} businessId The venue the file is of, by business id
|
|
53461
53627
|
* @param {TimeSpan} [timeSpan] The period asked for: DAY, WEEK, MONTH, YEAR, or CUSTOM between start and end
|
|
@@ -56030,7 +56196,7 @@ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiI
|
|
|
56030
56196
|
*/
|
|
56031
56197
|
export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
56032
56198
|
/**
|
|
56033
|
-
* 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.
|
|
56034
56200
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56035
56201
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56036
56202
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56039,7 +56205,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56039
56205
|
*/
|
|
56040
56206
|
addShiftAtVenue: (businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56041
56207
|
/**
|
|
56042
|
-
* 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.
|
|
56043
56209
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56044
56210
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56045
56211
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56084,7 +56250,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56084
56250
|
*/
|
|
56085
56251
|
lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56086
56252
|
/**
|
|
56087
|
-
* 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.
|
|
56088
56254
|
* @summary Remove a shift recorded by mistake
|
|
56089
56255
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56090
56256
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56093,7 +56259,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56093
56259
|
*/
|
|
56094
56260
|
removeShiftAtVenue: (businessId: number, shiftId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56095
56261
|
/**
|
|
56096
|
-
* 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).
|
|
56097
56263
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56098
56264
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56099
56265
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56143,7 +56309,7 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
56143
56309
|
*/
|
|
56144
56310
|
export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
56145
56311
|
/**
|
|
56146
|
-
* 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.
|
|
56147
56313
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56148
56314
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56149
56315
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56152,7 +56318,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56152
56318
|
*/
|
|
56153
56319
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>>;
|
|
56154
56320
|
/**
|
|
56155
|
-
* 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.
|
|
56156
56322
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56157
56323
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56158
56324
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56197,7 +56363,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56197
56363
|
*/
|
|
56198
56364
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56199
56365
|
/**
|
|
56200
|
-
* 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.
|
|
56201
56367
|
* @summary Remove a shift recorded by mistake
|
|
56202
56368
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56203
56369
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56206,7 +56372,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56206
56372
|
*/
|
|
56207
56373
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56208
56374
|
/**
|
|
56209
|
-
* 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).
|
|
56210
56376
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56211
56377
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56212
56378
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56256,7 +56422,7 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56256
56422
|
*/
|
|
56257
56423
|
export declare const ShiftTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
56258
56424
|
/**
|
|
56259
|
-
* 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.
|
|
56260
56426
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56261
56427
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56262
56428
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56265,7 +56431,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56265
56431
|
*/
|
|
56266
56432
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: any): AxiosPromise<StaffShiftDto>;
|
|
56267
56433
|
/**
|
|
56268
|
-
* 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.
|
|
56269
56435
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56270
56436
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56271
56437
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56310,7 +56476,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56310
56476
|
*/
|
|
56311
56477
|
lockTill(businessId: number, options?: any): AxiosPromise<void>;
|
|
56312
56478
|
/**
|
|
56313
|
-
* 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.
|
|
56314
56480
|
* @summary Remove a shift recorded by mistake
|
|
56315
56481
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56316
56482
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56319,7 +56485,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56319
56485
|
*/
|
|
56320
56486
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: any): AxiosPromise<void>;
|
|
56321
56487
|
/**
|
|
56322
|
-
* 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).
|
|
56323
56489
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56324
56490
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56325
56491
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56370,7 +56536,7 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56370
56536
|
*/
|
|
56371
56537
|
export interface ShiftTrackingApiInterface {
|
|
56372
56538
|
/**
|
|
56373
|
-
* 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.
|
|
56374
56540
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56375
56541
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56376
56542
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56380,7 +56546,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56380
56546
|
*/
|
|
56381
56547
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
56382
56548
|
/**
|
|
56383
|
-
* 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.
|
|
56384
56550
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56385
56551
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56386
56552
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56430,7 +56596,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56430
56596
|
*/
|
|
56431
56597
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56432
56598
|
/**
|
|
56433
|
-
* 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.
|
|
56434
56600
|
* @summary Remove a shift recorded by mistake
|
|
56435
56601
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56436
56602
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56440,7 +56606,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56440
56606
|
*/
|
|
56441
56607
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56442
56608
|
/**
|
|
56443
|
-
* 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).
|
|
56444
56610
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56445
56611
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56446
56612
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56496,7 +56662,7 @@ export interface ShiftTrackingApiInterface {
|
|
|
56496
56662
|
*/
|
|
56497
56663
|
export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterface {
|
|
56498
56664
|
/**
|
|
56499
|
-
* 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.
|
|
56500
56666
|
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56501
56667
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56502
56668
|
* @param {AddShiftDto} addShiftDto
|
|
@@ -56506,7 +56672,7 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56506
56672
|
*/
|
|
56507
56673
|
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffShiftDto, any, {}>>;
|
|
56508
56674
|
/**
|
|
56509
|
-
* 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.
|
|
56510
56676
|
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56511
56677
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56512
56678
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56556,7 +56722,7 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56556
56722
|
*/
|
|
56557
56723
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56558
56724
|
/**
|
|
56559
|
-
* 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.
|
|
56560
56726
|
* @summary Remove a shift recorded by mistake
|
|
56561
56727
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56562
56728
|
* @param {string} shiftId The shift\'s id
|
|
@@ -56566,7 +56732,7 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56566
56732
|
*/
|
|
56567
56733
|
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56568
56734
|
/**
|
|
56569
|
-
* 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).
|
|
56570
56736
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56571
56737
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56572
56738
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
@@ -56763,6 +56929,180 @@ export declare class StationsApi extends BaseAPI implements StationsApiInterface
|
|
|
56763
56929
|
*/
|
|
56764
56930
|
syncStation(syncStationDto: SyncStationDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StationSyncResponseDto, any, {}>>;
|
|
56765
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
|
+
}
|
|
56766
57106
|
/**
|
|
56767
57107
|
* TerminalApi - axios parameter creator
|
|
56768
57108
|
* @export
|
|
@@ -57758,6 +58098,14 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
|
|
|
57758
58098
|
* @throws {RequiredError}
|
|
57759
58099
|
*/
|
|
57760
58100
|
handleFoodoraEvent: (orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
58101
|
+
/**
|
|
58102
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58103
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58104
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58105
|
+
* @param {*} [options] Override http request option.
|
|
58106
|
+
* @throws {RequiredError}
|
|
58107
|
+
*/
|
|
58108
|
+
handleKioskAutoReject: (kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57761
58109
|
/**
|
|
57762
58110
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
57763
58111
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -57939,6 +58287,14 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
|
57939
58287
|
* @throws {RequiredError}
|
|
57940
58288
|
*/
|
|
57941
58289
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
58290
|
+
/**
|
|
58291
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58292
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58293
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58294
|
+
* @param {*} [options] Override http request option.
|
|
58295
|
+
* @throws {RequiredError}
|
|
58296
|
+
*/
|
|
58297
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
57942
58298
|
/**
|
|
57943
58299
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
57944
58300
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -58120,6 +58476,14 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
|
|
|
58120
58476
|
* @throws {RequiredError}
|
|
58121
58477
|
*/
|
|
58122
58478
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: any): AxiosPromise<void>;
|
|
58479
|
+
/**
|
|
58480
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58481
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58482
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58483
|
+
* @param {*} [options] Override http request option.
|
|
58484
|
+
* @throws {RequiredError}
|
|
58485
|
+
*/
|
|
58486
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: any): AxiosPromise<void>;
|
|
58123
58487
|
/**
|
|
58124
58488
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
58125
58489
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -58305,6 +58669,15 @@ export interface WebhookApiInterface {
|
|
|
58305
58669
|
* @memberof WebhookApiInterface
|
|
58306
58670
|
*/
|
|
58307
58671
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
58672
|
+
/**
|
|
58673
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58674
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58675
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58676
|
+
* @param {*} [options] Override http request option.
|
|
58677
|
+
* @throws {RequiredError}
|
|
58678
|
+
* @memberof WebhookApiInterface
|
|
58679
|
+
*/
|
|
58680
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
58308
58681
|
/**
|
|
58309
58682
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
58310
58683
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -58510,6 +58883,15 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
58510
58883
|
* @memberof WebhookApi
|
|
58511
58884
|
*/
|
|
58512
58885
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
58886
|
+
/**
|
|
58887
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58888
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58889
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58890
|
+
* @param {*} [options] Override http request option.
|
|
58891
|
+
* @throws {RequiredError}
|
|
58892
|
+
* @memberof WebhookApi
|
|
58893
|
+
*/
|
|
58894
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
58513
58895
|
/**
|
|
58514
58896
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
58515
58897
|
* @summary Handle Supabase employee sync webhook
|