@munchi_oy/core 2.7.0 → 2.8.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 +318 -30
- package/dist/generated/api.d.ts.map +1 -1
- package/dist/index.js +1 -1
- package/dist/index.mjs +1 -1
- package/dist/src/version.d.ts +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +411 -31
- package/package.json +1 -1
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -24393,6 +24393,7 @@ export declare const ReadyMadeReport: {
|
|
|
24393
24393
|
readonly ProductSales: "productSales";
|
|
24394
24394
|
readonly CashSessions: "cashSessions";
|
|
24395
24395
|
readonly Staff: "staff";
|
|
24396
|
+
readonly Hours: "hours";
|
|
24396
24397
|
};
|
|
24397
24398
|
export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
|
|
24398
24399
|
/**
|
|
@@ -25489,6 +25490,81 @@ export interface RejectOrderDto {
|
|
|
25489
25490
|
*/
|
|
25490
25491
|
'reason': string;
|
|
25491
25492
|
}
|
|
25493
|
+
/**
|
|
25494
|
+
*
|
|
25495
|
+
* @export
|
|
25496
|
+
* @interface ReleaseLicenceHoldsDto
|
|
25497
|
+
*/
|
|
25498
|
+
export interface ReleaseLicenceHoldsDto {
|
|
25499
|
+
/**
|
|
25500
|
+
* true (the default): answers the holds a release would turn back on and changes nothing; false turns them on
|
|
25501
|
+
* @type {boolean}
|
|
25502
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
25503
|
+
*/
|
|
25504
|
+
'dryRun'?: boolean;
|
|
25505
|
+
/**
|
|
25506
|
+
* How many venues\' holds one call releases, by venue id; call again until holdsLeft is 0. Absent: 50
|
|
25507
|
+
* @type {number}
|
|
25508
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
25509
|
+
*/
|
|
25510
|
+
'batchSize'?: number;
|
|
25511
|
+
/**
|
|
25512
|
+
* Start after this venue id: the nextAfterVenueId of the previous call, to page through a dry run. Absent: from the first venue
|
|
25513
|
+
* @type {number}
|
|
25514
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
25515
|
+
*/
|
|
25516
|
+
'afterVenueId'?: number;
|
|
25517
|
+
}
|
|
25518
|
+
/**
|
|
25519
|
+
*
|
|
25520
|
+
* @export
|
|
25521
|
+
* @interface ReleasedLicenceHoldDto
|
|
25522
|
+
*/
|
|
25523
|
+
export interface ReleasedLicenceHoldDto {
|
|
25524
|
+
/**
|
|
25525
|
+
* The venue (orderingBusinessId)
|
|
25526
|
+
* @type {number}
|
|
25527
|
+
* @memberof ReleasedLicenceHoldDto
|
|
25528
|
+
*/
|
|
25529
|
+
'venueId': number;
|
|
25530
|
+
/**
|
|
25531
|
+
* The provider rows turned back on (or that would be, on a dry run): the rows the licence turned off that are still there and still off
|
|
25532
|
+
* @type {Array<string>}
|
|
25533
|
+
* @memberof ReleasedLicenceHoldDto
|
|
25534
|
+
*/
|
|
25535
|
+
'rowIds': Array<string>;
|
|
25536
|
+
}
|
|
25537
|
+
/**
|
|
25538
|
+
*
|
|
25539
|
+
* @export
|
|
25540
|
+
* @interface ReleasedLicenceHoldsDto
|
|
25541
|
+
*/
|
|
25542
|
+
export interface ReleasedLicenceHoldsDto {
|
|
25543
|
+
/**
|
|
25544
|
+
* Whether this was a dry run, which changed nothing
|
|
25545
|
+
* @type {boolean}
|
|
25546
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25547
|
+
*/
|
|
25548
|
+
'dryRun': boolean;
|
|
25549
|
+
/**
|
|
25550
|
+
* The venues of this batch and their rows
|
|
25551
|
+
* @type {Array<ReleasedLicenceHoldDto>}
|
|
25552
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25553
|
+
*/
|
|
25554
|
+
'venues': Array<ReleasedLicenceHoldDto>;
|
|
25555
|
+
/**
|
|
25556
|
+
* How many venues after this batch still have a hold keeping a row off: call again until 0
|
|
25557
|
+
* @type {number}
|
|
25558
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25559
|
+
*/
|
|
25560
|
+
'holdsLeft': number;
|
|
25561
|
+
/**
|
|
25562
|
+
* The afterVenueId of the next call, or null when no hold is left after this batch. A dry run changes nothing, so it pages with this
|
|
25563
|
+
* @type {number}
|
|
25564
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25565
|
+
*/
|
|
25566
|
+
'nextAfterVenueId': number | null;
|
|
25567
|
+
}
|
|
25492
25568
|
/**
|
|
25493
25569
|
*
|
|
25494
25570
|
* @export
|
|
@@ -29975,6 +30051,124 @@ export interface StaffActivityLogDto {
|
|
|
29975
30051
|
*/
|
|
29976
30052
|
'productName'?: string | null;
|
|
29977
30053
|
}
|
|
30054
|
+
/**
|
|
30055
|
+
*
|
|
30056
|
+
* @export
|
|
30057
|
+
* @interface StaffHoursDayDto
|
|
30058
|
+
*/
|
|
30059
|
+
export interface StaffHoursDayDto {
|
|
30060
|
+
/**
|
|
30061
|
+
* The day the shift began, YYYY-MM-DD, in the venue\'s time zone
|
|
30062
|
+
* @type {string}
|
|
30063
|
+
* @memberof StaffHoursDayDto
|
|
30064
|
+
*/
|
|
30065
|
+
'day': string;
|
|
30066
|
+
/**
|
|
30067
|
+
* The day\'s worked minutes, all its shifts added up
|
|
30068
|
+
* @type {number}
|
|
30069
|
+
* @memberof StaffHoursDayDto
|
|
30070
|
+
*/
|
|
30071
|
+
'minutes': number;
|
|
30072
|
+
/**
|
|
30073
|
+
* The day\'s shifts, oldest first
|
|
30074
|
+
* @type {Array<StaffHoursShiftDto>}
|
|
30075
|
+
* @memberof StaffHoursDayDto
|
|
30076
|
+
*/
|
|
30077
|
+
'shifts': Array<StaffHoursShiftDto>;
|
|
30078
|
+
}
|
|
30079
|
+
/**
|
|
30080
|
+
*
|
|
30081
|
+
* @export
|
|
30082
|
+
* @interface StaffHoursPersonDto
|
|
30083
|
+
*/
|
|
30084
|
+
export interface StaffHoursPersonDto {
|
|
30085
|
+
/**
|
|
30086
|
+
* The staff member\'s id
|
|
30087
|
+
* @type {string}
|
|
30088
|
+
* @memberof StaffHoursPersonDto
|
|
30089
|
+
*/
|
|
30090
|
+
'employeeId': string;
|
|
30091
|
+
/**
|
|
30092
|
+
* The staff member\'s name
|
|
30093
|
+
* @type {string}
|
|
30094
|
+
* @memberof StaffHoursPersonDto
|
|
30095
|
+
*/
|
|
30096
|
+
'name': string;
|
|
30097
|
+
/**
|
|
30098
|
+
* Worked minutes over the whole period
|
|
30099
|
+
* @type {number}
|
|
30100
|
+
* @memberof StaffHoursPersonDto
|
|
30101
|
+
*/
|
|
30102
|
+
'minutes': number;
|
|
30103
|
+
/**
|
|
30104
|
+
* Shifts in the period with no clock-out yet: still working, or a clock-out forgotten
|
|
30105
|
+
* @type {number}
|
|
30106
|
+
* @memberof StaffHoursPersonDto
|
|
30107
|
+
*/
|
|
30108
|
+
'openShifts': number;
|
|
30109
|
+
/**
|
|
30110
|
+
* Each day with a shift, oldest first
|
|
30111
|
+
* @type {Array<StaffHoursDayDto>}
|
|
30112
|
+
* @memberof StaffHoursPersonDto
|
|
30113
|
+
*/
|
|
30114
|
+
'days': Array<StaffHoursDayDto>;
|
|
30115
|
+
}
|
|
30116
|
+
/**
|
|
30117
|
+
*
|
|
30118
|
+
* @export
|
|
30119
|
+
* @interface StaffHoursResponseDto
|
|
30120
|
+
*/
|
|
30121
|
+
export interface StaffHoursResponseDto {
|
|
30122
|
+
/**
|
|
30123
|
+
* The venue\'s time zone the days are counted in
|
|
30124
|
+
* @type {string}
|
|
30125
|
+
* @memberof StaffHoursResponseDto
|
|
30126
|
+
*/
|
|
30127
|
+
'timeZone': string;
|
|
30128
|
+
/**
|
|
30129
|
+
* The first day, as asked
|
|
30130
|
+
* @type {string}
|
|
30131
|
+
* @memberof StaffHoursResponseDto
|
|
30132
|
+
*/
|
|
30133
|
+
'from': string;
|
|
30134
|
+
/**
|
|
30135
|
+
* The last day, as asked
|
|
30136
|
+
* @type {string}
|
|
30137
|
+
* @memberof StaffHoursResponseDto
|
|
30138
|
+
*/
|
|
30139
|
+
'to': string;
|
|
30140
|
+
/**
|
|
30141
|
+
* Every staff member with a shift in the period, by name
|
|
30142
|
+
* @type {Array<StaffHoursPersonDto>}
|
|
30143
|
+
* @memberof StaffHoursResponseDto
|
|
30144
|
+
*/
|
|
30145
|
+
'people': Array<StaffHoursPersonDto>;
|
|
30146
|
+
}
|
|
30147
|
+
/**
|
|
30148
|
+
*
|
|
30149
|
+
* @export
|
|
30150
|
+
* @interface StaffHoursShiftDto
|
|
30151
|
+
*/
|
|
30152
|
+
export interface StaffHoursShiftDto {
|
|
30153
|
+
/**
|
|
30154
|
+
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
30155
|
+
* @type {string}
|
|
30156
|
+
* @memberof StaffHoursShiftDto
|
|
30157
|
+
*/
|
|
30158
|
+
'clockInTime': string | null;
|
|
30159
|
+
/**
|
|
30160
|
+
* When the staff member clocked out; null while the shift is still open
|
|
30161
|
+
* @type {string}
|
|
30162
|
+
* @memberof StaffHoursShiftDto
|
|
30163
|
+
*/
|
|
30164
|
+
'clockOutTime': string | null;
|
|
30165
|
+
/**
|
|
30166
|
+
* Whole minutes between clock-in and clock-out; 0 for a shift missing either time or clocked out before it clocked in, so a forgotten clock-out or a broken record adds nothing
|
|
30167
|
+
* @type {number}
|
|
30168
|
+
* @memberof StaffHoursShiftDto
|
|
30169
|
+
*/
|
|
30170
|
+
'minutes': number;
|
|
30171
|
+
}
|
|
29978
30172
|
/**
|
|
29979
30173
|
*
|
|
29980
30174
|
* @export
|
|
@@ -47004,6 +47198,14 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
47004
47198
|
* @throws {RequiredError}
|
|
47005
47199
|
*/
|
|
47006
47200
|
disconnectDeliveryPlatform: (venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47201
|
+
/**
|
|
47202
|
+
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
47203
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47204
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47205
|
+
* @param {*} [options] Override http request option.
|
|
47206
|
+
* @throws {RequiredError}
|
|
47207
|
+
*/
|
|
47208
|
+
releaseLicenceHolds: (releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47007
47209
|
/**
|
|
47008
47210
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
47009
47211
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47045,6 +47247,14 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
47045
47247
|
* @throws {RequiredError}
|
|
47046
47248
|
*/
|
|
47047
47249
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisconnectedDeliveryPlatformDto>>;
|
|
47250
|
+
/**
|
|
47251
|
+
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
47252
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47253
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47254
|
+
* @param {*} [options] Override http request option.
|
|
47255
|
+
* @throws {RequiredError}
|
|
47256
|
+
*/
|
|
47257
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleasedLicenceHoldsDto>>;
|
|
47048
47258
|
/**
|
|
47049
47259
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
47050
47260
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47086,6 +47296,14 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
47086
47296
|
* @throws {RequiredError}
|
|
47087
47297
|
*/
|
|
47088
47298
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: any): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
47299
|
+
/**
|
|
47300
|
+
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
47301
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47302
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47303
|
+
* @param {*} [options] Override http request option.
|
|
47304
|
+
* @throws {RequiredError}
|
|
47305
|
+
*/
|
|
47306
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: any): AxiosPromise<ReleasedLicenceHoldsDto>;
|
|
47089
47307
|
/**
|
|
47090
47308
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
47091
47309
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47131,6 +47349,15 @@ export interface OpsApiInterface {
|
|
|
47131
47349
|
* @memberof OpsApiInterface
|
|
47132
47350
|
*/
|
|
47133
47351
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
47352
|
+
/**
|
|
47353
|
+
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
47354
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47355
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47356
|
+
* @param {*} [options] Override http request option.
|
|
47357
|
+
* @throws {RequiredError}
|
|
47358
|
+
* @memberof OpsApiInterface
|
|
47359
|
+
*/
|
|
47360
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): AxiosPromise<ReleasedLicenceHoldsDto>;
|
|
47134
47361
|
/**
|
|
47135
47362
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
47136
47363
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47178,6 +47405,15 @@ export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
47178
47405
|
* @memberof OpsApi
|
|
47179
47406
|
*/
|
|
47180
47407
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisconnectedDeliveryPlatformDto, any, {}>>;
|
|
47408
|
+
/**
|
|
47409
|
+
* Undoes what licences turned off. Per venue, by venue id: turns on the provider rows the licence turned off that are still there and still off, and empties the hold. A dry run unless dryRun is false; call again until holdsLeft is 0. The next unpaid event turns the rows off again.
|
|
47410
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47411
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47412
|
+
* @param {*} [options] Override http request option.
|
|
47413
|
+
* @throws {RequiredError}
|
|
47414
|
+
* @memberof OpsApi
|
|
47415
|
+
*/
|
|
47416
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleasedLicenceHoldsDto, any, {}>>;
|
|
47181
47417
|
/**
|
|
47182
47418
|
* Venues whose name holds the text, in any case, or whose venue id it is, by name. Answers who the venue is and where, never its contacts, owners or schedule.
|
|
47183
47419
|
* @summary Find venues by name or id, across every venue
|
|
@@ -53289,7 +53525,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53289
53525
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53290
53526
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53291
53527
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53292
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53528
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53293
53529
|
* @param {*} [options] Override http request option.
|
|
53294
53530
|
* @throws {RequiredError}
|
|
53295
53531
|
*/
|
|
@@ -53328,7 +53564,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53328
53564
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
53329
53565
|
* @summary List the past runs of a store\'s ready-made report
|
|
53330
53566
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53331
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53567
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53332
53568
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53333
53569
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53334
53570
|
* @param {*} [options] Override http request option.
|
|
@@ -53347,7 +53583,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53347
53583
|
*/
|
|
53348
53584
|
listStoreSavedReportRuns: (businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53349
53585
|
/**
|
|
53350
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53586
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53351
53587
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53352
53588
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53353
53589
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53357,17 +53593,17 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53357
53593
|
*/
|
|
53358
53594
|
setOrganisationSavedReportSchedule: (groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53359
53595
|
/**
|
|
53360
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53596
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53361
53597
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53362
53598
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53363
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53599
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53364
53600
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53365
53601
|
* @param {*} [options] Override http request option.
|
|
53366
53602
|
* @throws {RequiredError}
|
|
53367
53603
|
*/
|
|
53368
53604
|
setStoreReadyMadeReportSchedule: (businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53369
53605
|
/**
|
|
53370
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53606
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53371
53607
|
* @summary Set when a store\'s saved report is emailed
|
|
53372
53608
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53373
53609
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53413,7 +53649,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53413
53649
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53414
53650
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53415
53651
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53416
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53652
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53417
53653
|
* @param {*} [options] Override http request option.
|
|
53418
53654
|
* @throws {RequiredError}
|
|
53419
53655
|
*/
|
|
@@ -53452,7 +53688,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53452
53688
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
53453
53689
|
* @summary List the past runs of a store\'s ready-made report
|
|
53454
53690
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53455
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53691
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53456
53692
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53457
53693
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53458
53694
|
* @param {*} [options] Override http request option.
|
|
@@ -53471,7 +53707,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53471
53707
|
*/
|
|
53472
53708
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunListDto>>;
|
|
53473
53709
|
/**
|
|
53474
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53710
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53475
53711
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53476
53712
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53477
53713
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53481,17 +53717,17 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53481
53717
|
*/
|
|
53482
53718
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
|
|
53483
53719
|
/**
|
|
53484
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53720
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53485
53721
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53486
53722
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53487
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53723
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53488
53724
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53489
53725
|
* @param {*} [options] Override http request option.
|
|
53490
53726
|
* @throws {RequiredError}
|
|
53491
53727
|
*/
|
|
53492
53728
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
|
|
53493
53729
|
/**
|
|
53494
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53730
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53495
53731
|
* @summary Set when a store\'s saved report is emailed
|
|
53496
53732
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53497
53733
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53537,7 +53773,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53537
53773
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53538
53774
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53539
53775
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53540
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53776
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53541
53777
|
* @param {*} [options] Override http request option.
|
|
53542
53778
|
* @throws {RequiredError}
|
|
53543
53779
|
*/
|
|
@@ -53576,7 +53812,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53576
53812
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
53577
53813
|
* @summary List the past runs of a store\'s ready-made report
|
|
53578
53814
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53579
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53815
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53580
53816
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53581
53817
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53582
53818
|
* @param {*} [options] Override http request option.
|
|
@@ -53595,7 +53831,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53595
53831
|
*/
|
|
53596
53832
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: any): AxiosPromise<ReportRunListDto>;
|
|
53597
53833
|
/**
|
|
53598
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53834
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53599
53835
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53600
53836
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53601
53837
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53605,17 +53841,17 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53605
53841
|
*/
|
|
53606
53842
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
|
|
53607
53843
|
/**
|
|
53608
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53844
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53609
53845
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53610
53846
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53611
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53847
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53612
53848
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53613
53849
|
* @param {*} [options] Override http request option.
|
|
53614
53850
|
* @throws {RequiredError}
|
|
53615
53851
|
*/
|
|
53616
53852
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
|
|
53617
53853
|
/**
|
|
53618
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53854
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53619
53855
|
* @summary Set when a store\'s saved report is emailed
|
|
53620
53856
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53621
53857
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53665,7 +53901,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53665
53901
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53666
53902
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53667
53903
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53668
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53904
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53669
53905
|
* @param {*} [options] Override http request option.
|
|
53670
53906
|
* @throws {RequiredError}
|
|
53671
53907
|
* @memberof ReportSchedulesApiInterface
|
|
@@ -53708,7 +53944,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53708
53944
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
53709
53945
|
* @summary List the past runs of a store\'s ready-made report
|
|
53710
53946
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53711
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53947
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53712
53948
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53713
53949
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53714
53950
|
* @param {*} [options] Override http request option.
|
|
@@ -53729,7 +53965,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53729
53965
|
*/
|
|
53730
53966
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
|
|
53731
53967
|
/**
|
|
53732
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53968
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53733
53969
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53734
53970
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53735
53971
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53740,10 +53976,10 @@ export interface ReportSchedulesApiInterface {
|
|
|
53740
53976
|
*/
|
|
53741
53977
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
53742
53978
|
/**
|
|
53743
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53979
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53744
53980
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53745
53981
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53746
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
53982
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53747
53983
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53748
53984
|
* @param {*} [options] Override http request option.
|
|
53749
53985
|
* @throws {RequiredError}
|
|
@@ -53751,7 +53987,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53751
53987
|
*/
|
|
53752
53988
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
53753
53989
|
/**
|
|
53754
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
53990
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53755
53991
|
* @summary Set when a store\'s saved report is emailed
|
|
53756
53992
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53757
53993
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53803,7 +54039,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53803
54039
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53804
54040
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53805
54041
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53806
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
54042
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53807
54043
|
* @param {*} [options] Override http request option.
|
|
53808
54044
|
* @throws {RequiredError}
|
|
53809
54045
|
* @memberof ReportSchedulesApi
|
|
@@ -53846,7 +54082,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53846
54082
|
* Every time it was emailed, newest first, a page at a time: the days it covered, who it went to and the files it kept.
|
|
53847
54083
|
* @summary List the past runs of a store\'s ready-made report
|
|
53848
54084
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53849
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
54085
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53850
54086
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53851
54087
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53852
54088
|
* @param {*} [options] Override http request option.
|
|
@@ -53867,7 +54103,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53867
54103
|
*/
|
|
53868
54104
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunListDto, any, {}>>;
|
|
53869
54105
|
/**
|
|
53870
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
54106
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53871
54107
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53872
54108
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53873
54109
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53878,10 +54114,10 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53878
54114
|
*/
|
|
53879
54115
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
|
|
53880
54116
|
/**
|
|
53881
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
54117
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53882
54118
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53883
54119
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53884
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
54120
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53885
54121
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53886
54122
|
* @param {*} [options] Override http request option.
|
|
53887
54123
|
* @throws {RequiredError}
|
|
@@ -53889,7 +54125,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53889
54125
|
*/
|
|
53890
54126
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
|
|
53891
54127
|
/**
|
|
53892
|
-
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions and
|
|
54128
|
+
* Replaces its schedule. The first save, without expectedVersion, makes it; every later one sends the version it read (409 when stale). Each run is saved under the report\'s past runs (a ready-made report\'s with its files, as dashboard-one\'s Reports downloads them: the sales report\'s PDF and Excel for sales, salesVat, payments and productSales, the end-of-day PDF for zReport, none for cashSessions, staff and hours, whose email opens the report for its days) and emails each recipient, if any, a link to it in dashboard-one. Off keeps the schedule without sending. Managers only.
|
|
53893
54129
|
* @summary Set when a store\'s saved report is emailed
|
|
53894
54130
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53895
54131
|
* @param {string} reportId The saved report\'s id
|
|
@@ -55713,6 +55949,16 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
55713
55949
|
* @throws {RequiredError}
|
|
55714
55950
|
*/
|
|
55715
55951
|
lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55952
|
+
/**
|
|
55953
|
+
* 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. 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).
|
|
55954
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
55955
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55956
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
55957
|
+
* @param {string} to The last day, YYYY-MM-DD, inclusive, in the venue\'s time zone; from or at most 92 days after it, 93 days counting both
|
|
55958
|
+
* @param {*} [options] Override http request option.
|
|
55959
|
+
* @throws {RequiredError}
|
|
55960
|
+
*/
|
|
55961
|
+
staffHoursAtVenue: (businessId: number, from: string, to: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55716
55962
|
/**
|
|
55717
55963
|
* The till names the employee; no PIN is checked here (v2 unlock checks it on the server). With an open shift at the venue, the shift gets a new session and its old session is told to leave on Ably (session-kick on shift:<id>:<environment>).
|
|
55718
55964
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55772,6 +56018,16 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
55772
56018
|
* @throws {RequiredError}
|
|
55773
56019
|
*/
|
|
55774
56020
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56021
|
+
/**
|
|
56022
|
+
* 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. 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).
|
|
56023
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56024
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56025
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56026
|
+
* @param {string} to The last day, YYYY-MM-DD, inclusive, in the venue\'s time zone; from or at most 92 days after it, 93 days counting both
|
|
56027
|
+
* @param {*} [options] Override http request option.
|
|
56028
|
+
* @throws {RequiredError}
|
|
56029
|
+
*/
|
|
56030
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffHoursResponseDto>>;
|
|
55775
56031
|
/**
|
|
55776
56032
|
* The till names the employee; no PIN is checked here (v2 unlock checks it on the server). With an open shift at the venue, the shift gets a new session and its old session is told to leave on Ably (session-kick on shift:<id>:<environment>).
|
|
55777
56033
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55831,6 +56087,16 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
55831
56087
|
* @throws {RequiredError}
|
|
55832
56088
|
*/
|
|
55833
56089
|
lockTill(businessId: number, options?: any): AxiosPromise<void>;
|
|
56090
|
+
/**
|
|
56091
|
+
* 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. 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).
|
|
56092
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56093
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56094
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56095
|
+
* @param {string} to The last day, YYYY-MM-DD, inclusive, in the venue\'s time zone; from or at most 92 days after it, 93 days counting both
|
|
56096
|
+
* @param {*} [options] Override http request option.
|
|
56097
|
+
* @throws {RequiredError}
|
|
56098
|
+
*/
|
|
56099
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, options?: any): AxiosPromise<StaffHoursResponseDto>;
|
|
55834
56100
|
/**
|
|
55835
56101
|
* The till names the employee; no PIN is checked here (v2 unlock checks it on the server). With an open shift at the venue, the shift gets a new session and its old session is told to leave on Ably (session-kick on shift:<id>:<environment>).
|
|
55836
56102
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55895,6 +56161,17 @@ export interface ShiftTrackingApiInterface {
|
|
|
55895
56161
|
* @memberof ShiftTrackingApiInterface
|
|
55896
56162
|
*/
|
|
55897
56163
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56164
|
+
/**
|
|
56165
|
+
* 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. 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).
|
|
56166
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56167
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56168
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56169
|
+
* @param {string} to The last day, YYYY-MM-DD, inclusive, in the venue\'s time zone; from or at most 92 days after it, 93 days counting both
|
|
56170
|
+
* @param {*} [options] Override http request option.
|
|
56171
|
+
* @throws {RequiredError}
|
|
56172
|
+
* @memberof ShiftTrackingApiInterface
|
|
56173
|
+
*/
|
|
56174
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<StaffHoursResponseDto>;
|
|
55898
56175
|
/**
|
|
55899
56176
|
* The till names the employee; no PIN is checked here (v2 unlock checks it on the server). With an open shift at the venue, the shift gets a new session and its old session is told to leave on Ably (session-kick on shift:<id>:<environment>).
|
|
55900
56177
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55962,6 +56239,17 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
55962
56239
|
* @memberof ShiftTrackingApi
|
|
55963
56240
|
*/
|
|
55964
56241
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56242
|
+
/**
|
|
56243
|
+
* 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. 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).
|
|
56244
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56245
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56246
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56247
|
+
* @param {string} to The last day, YYYY-MM-DD, inclusive, in the venue\'s time zone; from or at most 92 days after it, 93 days counting both
|
|
56248
|
+
* @param {*} [options] Override http request option.
|
|
56249
|
+
* @throws {RequiredError}
|
|
56250
|
+
* @memberof ShiftTrackingApi
|
|
56251
|
+
*/
|
|
56252
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffHoursResponseDto, any, {}>>;
|
|
55965
56253
|
/**
|
|
55966
56254
|
* The till names the employee; no PIN is checked here (v2 unlock checks it on the server). With an open shift at the venue, the shift gets a new session and its old session is told to leave on Ably (session-kick on shift:<id>:<environment>).
|
|
55967
56255
|
* @summary Unlock the till for an employee (no PIN; old builds)
|