@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/generated/api.ts
CHANGED
|
@@ -25140,7 +25140,8 @@ export const ReadyMadeReport = {
|
|
|
25140
25140
|
Payments: 'payments',
|
|
25141
25141
|
ProductSales: 'productSales',
|
|
25142
25142
|
CashSessions: 'cashSessions',
|
|
25143
|
-
Staff: 'staff'
|
|
25143
|
+
Staff: 'staff',
|
|
25144
|
+
Hours: 'hours'
|
|
25144
25145
|
} as const;
|
|
25145
25146
|
|
|
25146
25147
|
export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
|
|
@@ -26286,6 +26287,81 @@ export interface RejectOrderDto {
|
|
|
26286
26287
|
}
|
|
26287
26288
|
|
|
26288
26289
|
|
|
26290
|
+
/**
|
|
26291
|
+
*
|
|
26292
|
+
* @export
|
|
26293
|
+
* @interface ReleaseLicenceHoldsDto
|
|
26294
|
+
*/
|
|
26295
|
+
export interface ReleaseLicenceHoldsDto {
|
|
26296
|
+
/**
|
|
26297
|
+
* true (the default): answers the holds a release would turn back on and changes nothing; false turns them on
|
|
26298
|
+
* @type {boolean}
|
|
26299
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
26300
|
+
*/
|
|
26301
|
+
'dryRun'?: boolean;
|
|
26302
|
+
/**
|
|
26303
|
+
* How many venues\' holds one call releases, by venue id; call again until holdsLeft is 0. Absent: 50
|
|
26304
|
+
* @type {number}
|
|
26305
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
26306
|
+
*/
|
|
26307
|
+
'batchSize'?: number;
|
|
26308
|
+
/**
|
|
26309
|
+
* Start after this venue id: the nextAfterVenueId of the previous call, to page through a dry run. Absent: from the first venue
|
|
26310
|
+
* @type {number}
|
|
26311
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
26312
|
+
*/
|
|
26313
|
+
'afterVenueId'?: number;
|
|
26314
|
+
}
|
|
26315
|
+
/**
|
|
26316
|
+
*
|
|
26317
|
+
* @export
|
|
26318
|
+
* @interface ReleasedLicenceHoldDto
|
|
26319
|
+
*/
|
|
26320
|
+
export interface ReleasedLicenceHoldDto {
|
|
26321
|
+
/**
|
|
26322
|
+
* The venue (orderingBusinessId)
|
|
26323
|
+
* @type {number}
|
|
26324
|
+
* @memberof ReleasedLicenceHoldDto
|
|
26325
|
+
*/
|
|
26326
|
+
'venueId': number;
|
|
26327
|
+
/**
|
|
26328
|
+
* 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
|
|
26329
|
+
* @type {Array<string>}
|
|
26330
|
+
* @memberof ReleasedLicenceHoldDto
|
|
26331
|
+
*/
|
|
26332
|
+
'rowIds': Array<string>;
|
|
26333
|
+
}
|
|
26334
|
+
/**
|
|
26335
|
+
*
|
|
26336
|
+
* @export
|
|
26337
|
+
* @interface ReleasedLicenceHoldsDto
|
|
26338
|
+
*/
|
|
26339
|
+
export interface ReleasedLicenceHoldsDto {
|
|
26340
|
+
/**
|
|
26341
|
+
* Whether this was a dry run, which changed nothing
|
|
26342
|
+
* @type {boolean}
|
|
26343
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
26344
|
+
*/
|
|
26345
|
+
'dryRun': boolean;
|
|
26346
|
+
/**
|
|
26347
|
+
* The venues of this batch and their rows
|
|
26348
|
+
* @type {Array<ReleasedLicenceHoldDto>}
|
|
26349
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
26350
|
+
*/
|
|
26351
|
+
'venues': Array<ReleasedLicenceHoldDto>;
|
|
26352
|
+
/**
|
|
26353
|
+
* How many venues after this batch still have a hold keeping a row off: call again until 0
|
|
26354
|
+
* @type {number}
|
|
26355
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
26356
|
+
*/
|
|
26357
|
+
'holdsLeft': number;
|
|
26358
|
+
/**
|
|
26359
|
+
* 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
|
|
26360
|
+
* @type {number}
|
|
26361
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
26362
|
+
*/
|
|
26363
|
+
'nextAfterVenueId': number | null;
|
|
26364
|
+
}
|
|
26289
26365
|
/**
|
|
26290
26366
|
*
|
|
26291
26367
|
* @export
|
|
@@ -30909,6 +30985,124 @@ export interface StaffActivityLogDto {
|
|
|
30909
30985
|
}
|
|
30910
30986
|
|
|
30911
30987
|
|
|
30988
|
+
/**
|
|
30989
|
+
*
|
|
30990
|
+
* @export
|
|
30991
|
+
* @interface StaffHoursDayDto
|
|
30992
|
+
*/
|
|
30993
|
+
export interface StaffHoursDayDto {
|
|
30994
|
+
/**
|
|
30995
|
+
* The day the shift began, YYYY-MM-DD, in the venue\'s time zone
|
|
30996
|
+
* @type {string}
|
|
30997
|
+
* @memberof StaffHoursDayDto
|
|
30998
|
+
*/
|
|
30999
|
+
'day': string;
|
|
31000
|
+
/**
|
|
31001
|
+
* The day\'s worked minutes, all its shifts added up
|
|
31002
|
+
* @type {number}
|
|
31003
|
+
* @memberof StaffHoursDayDto
|
|
31004
|
+
*/
|
|
31005
|
+
'minutes': number;
|
|
31006
|
+
/**
|
|
31007
|
+
* The day\'s shifts, oldest first
|
|
31008
|
+
* @type {Array<StaffHoursShiftDto>}
|
|
31009
|
+
* @memberof StaffHoursDayDto
|
|
31010
|
+
*/
|
|
31011
|
+
'shifts': Array<StaffHoursShiftDto>;
|
|
31012
|
+
}
|
|
31013
|
+
/**
|
|
31014
|
+
*
|
|
31015
|
+
* @export
|
|
31016
|
+
* @interface StaffHoursPersonDto
|
|
31017
|
+
*/
|
|
31018
|
+
export interface StaffHoursPersonDto {
|
|
31019
|
+
/**
|
|
31020
|
+
* The staff member\'s id
|
|
31021
|
+
* @type {string}
|
|
31022
|
+
* @memberof StaffHoursPersonDto
|
|
31023
|
+
*/
|
|
31024
|
+
'employeeId': string;
|
|
31025
|
+
/**
|
|
31026
|
+
* The staff member\'s name
|
|
31027
|
+
* @type {string}
|
|
31028
|
+
* @memberof StaffHoursPersonDto
|
|
31029
|
+
*/
|
|
31030
|
+
'name': string;
|
|
31031
|
+
/**
|
|
31032
|
+
* Worked minutes over the whole period
|
|
31033
|
+
* @type {number}
|
|
31034
|
+
* @memberof StaffHoursPersonDto
|
|
31035
|
+
*/
|
|
31036
|
+
'minutes': number;
|
|
31037
|
+
/**
|
|
31038
|
+
* Shifts in the period with no clock-out yet: still working, or a clock-out forgotten
|
|
31039
|
+
* @type {number}
|
|
31040
|
+
* @memberof StaffHoursPersonDto
|
|
31041
|
+
*/
|
|
31042
|
+
'openShifts': number;
|
|
31043
|
+
/**
|
|
31044
|
+
* Each day with a shift, oldest first
|
|
31045
|
+
* @type {Array<StaffHoursDayDto>}
|
|
31046
|
+
* @memberof StaffHoursPersonDto
|
|
31047
|
+
*/
|
|
31048
|
+
'days': Array<StaffHoursDayDto>;
|
|
31049
|
+
}
|
|
31050
|
+
/**
|
|
31051
|
+
*
|
|
31052
|
+
* @export
|
|
31053
|
+
* @interface StaffHoursResponseDto
|
|
31054
|
+
*/
|
|
31055
|
+
export interface StaffHoursResponseDto {
|
|
31056
|
+
/**
|
|
31057
|
+
* The venue\'s time zone the days are counted in
|
|
31058
|
+
* @type {string}
|
|
31059
|
+
* @memberof StaffHoursResponseDto
|
|
31060
|
+
*/
|
|
31061
|
+
'timeZone': string;
|
|
31062
|
+
/**
|
|
31063
|
+
* The first day, as asked
|
|
31064
|
+
* @type {string}
|
|
31065
|
+
* @memberof StaffHoursResponseDto
|
|
31066
|
+
*/
|
|
31067
|
+
'from': string;
|
|
31068
|
+
/**
|
|
31069
|
+
* The last day, as asked
|
|
31070
|
+
* @type {string}
|
|
31071
|
+
* @memberof StaffHoursResponseDto
|
|
31072
|
+
*/
|
|
31073
|
+
'to': string;
|
|
31074
|
+
/**
|
|
31075
|
+
* Every staff member with a shift in the period, by name
|
|
31076
|
+
* @type {Array<StaffHoursPersonDto>}
|
|
31077
|
+
* @memberof StaffHoursResponseDto
|
|
31078
|
+
*/
|
|
31079
|
+
'people': Array<StaffHoursPersonDto>;
|
|
31080
|
+
}
|
|
31081
|
+
/**
|
|
31082
|
+
*
|
|
31083
|
+
* @export
|
|
31084
|
+
* @interface StaffHoursShiftDto
|
|
31085
|
+
*/
|
|
31086
|
+
export interface StaffHoursShiftDto {
|
|
31087
|
+
/**
|
|
31088
|
+
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
31089
|
+
* @type {string}
|
|
31090
|
+
* @memberof StaffHoursShiftDto
|
|
31091
|
+
*/
|
|
31092
|
+
'clockInTime': string | null;
|
|
31093
|
+
/**
|
|
31094
|
+
* When the staff member clocked out; null while the shift is still open
|
|
31095
|
+
* @type {string}
|
|
31096
|
+
* @memberof StaffHoursShiftDto
|
|
31097
|
+
*/
|
|
31098
|
+
'clockOutTime': string | null;
|
|
31099
|
+
/**
|
|
31100
|
+
* 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
|
|
31101
|
+
* @type {number}
|
|
31102
|
+
* @memberof StaffHoursShiftDto
|
|
31103
|
+
*/
|
|
31104
|
+
'minutes': number;
|
|
31105
|
+
}
|
|
30912
31106
|
/**
|
|
30913
31107
|
*
|
|
30914
31108
|
* @export
|
|
@@ -54679,6 +54873,46 @@ export const OpsApiAxiosParamCreator = function (configuration?: Configuration)
|
|
|
54679
54873
|
options: localVarRequestOptions,
|
|
54680
54874
|
};
|
|
54681
54875
|
},
|
|
54876
|
+
/**
|
|
54877
|
+
* 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.
|
|
54878
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
54879
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
54880
|
+
* @param {*} [options] Override http request option.
|
|
54881
|
+
* @throws {RequiredError}
|
|
54882
|
+
*/
|
|
54883
|
+
releaseLicenceHolds: async (releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
54884
|
+
// verify required parameter 'releaseLicenceHoldsDto' is not null or undefined
|
|
54885
|
+
assertParamExists('releaseLicenceHolds', 'releaseLicenceHoldsDto', releaseLicenceHoldsDto)
|
|
54886
|
+
const localVarPath = `/api/v1/ops/licence-access/holds/release`;
|
|
54887
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
54888
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
54889
|
+
let baseOptions;
|
|
54890
|
+
if (configuration) {
|
|
54891
|
+
baseOptions = configuration.baseOptions;
|
|
54892
|
+
}
|
|
54893
|
+
|
|
54894
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
54895
|
+
const localVarHeaderParameter = {} as any;
|
|
54896
|
+
const localVarQueryParameter = {} as any;
|
|
54897
|
+
|
|
54898
|
+
// authentication JWT-auth required
|
|
54899
|
+
// http bearer authentication required
|
|
54900
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
54901
|
+
|
|
54902
|
+
|
|
54903
|
+
|
|
54904
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
54905
|
+
|
|
54906
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
54907
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
54908
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
54909
|
+
localVarRequestOptions.data = serializeDataIfNeeded(releaseLicenceHoldsDto, localVarRequestOptions, configuration)
|
|
54910
|
+
|
|
54911
|
+
return {
|
|
54912
|
+
url: toPathString(localVarUrlObj),
|
|
54913
|
+
options: localVarRequestOptions,
|
|
54914
|
+
};
|
|
54915
|
+
},
|
|
54682
54916
|
/**
|
|
54683
54917
|
* 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.
|
|
54684
54918
|
* @summary Find venues by name or id, across every venue
|
|
@@ -54770,6 +55004,17 @@ export const OpsApiFp = function(configuration?: Configuration) {
|
|
|
54770
55004
|
const localVarAxiosArgs = await localVarAxiosParamCreator.disconnectDeliveryPlatform(venueId, channel, options);
|
|
54771
55005
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
54772
55006
|
},
|
|
55007
|
+
/**
|
|
55008
|
+
* 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.
|
|
55009
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
55010
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
55011
|
+
* @param {*} [options] Override http request option.
|
|
55012
|
+
* @throws {RequiredError}
|
|
55013
|
+
*/
|
|
55014
|
+
async releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleasedLicenceHoldsDto>> {
|
|
55015
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.releaseLicenceHolds(releaseLicenceHoldsDto, options);
|
|
55016
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
55017
|
+
},
|
|
54773
55018
|
/**
|
|
54774
55019
|
* 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.
|
|
54775
55020
|
* @summary Find venues by name or id, across every venue
|
|
@@ -54824,6 +55069,16 @@ export const OpsApiFactory = function (configuration?: Configuration, basePath?:
|
|
|
54824
55069
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: any): AxiosPromise<DisconnectedDeliveryPlatformDto> {
|
|
54825
55070
|
return localVarFp.disconnectDeliveryPlatform(venueId, channel, options).then((request) => request(axios, basePath));
|
|
54826
55071
|
},
|
|
55072
|
+
/**
|
|
55073
|
+
* 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.
|
|
55074
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
55075
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
55076
|
+
* @param {*} [options] Override http request option.
|
|
55077
|
+
* @throws {RequiredError}
|
|
55078
|
+
*/
|
|
55079
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: any): AxiosPromise<ReleasedLicenceHoldsDto> {
|
|
55080
|
+
return localVarFp.releaseLicenceHolds(releaseLicenceHoldsDto, options).then((request) => request(axios, basePath));
|
|
55081
|
+
},
|
|
54827
55082
|
/**
|
|
54828
55083
|
* 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.
|
|
54829
55084
|
* @summary Find venues by name or id, across every venue
|
|
@@ -54876,6 +55131,16 @@ export interface OpsApiInterface {
|
|
|
54876
55131
|
*/
|
|
54877
55132
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
54878
55133
|
|
|
55134
|
+
/**
|
|
55135
|
+
* 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.
|
|
55136
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
55137
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
55138
|
+
* @param {*} [options] Override http request option.
|
|
55139
|
+
* @throws {RequiredError}
|
|
55140
|
+
* @memberof OpsApiInterface
|
|
55141
|
+
*/
|
|
55142
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): AxiosPromise<ReleasedLicenceHoldsDto>;
|
|
55143
|
+
|
|
54879
55144
|
/**
|
|
54880
55145
|
* 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.
|
|
54881
55146
|
* @summary Find venues by name or id, across every venue
|
|
@@ -54934,6 +55199,18 @@ export class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
54934
55199
|
return OpsApiFp(this.configuration).disconnectDeliveryPlatform(venueId, channel, options).then((request) => request(this.axios, this.basePath));
|
|
54935
55200
|
}
|
|
54936
55201
|
|
|
55202
|
+
/**
|
|
55203
|
+
* 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.
|
|
55204
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
55205
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
55206
|
+
* @param {*} [options] Override http request option.
|
|
55207
|
+
* @throws {RequiredError}
|
|
55208
|
+
* @memberof OpsApi
|
|
55209
|
+
*/
|
|
55210
|
+
public releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig) {
|
|
55211
|
+
return OpsApiFp(this.configuration).releaseLicenceHolds(releaseLicenceHoldsDto, options).then((request) => request(this.axios, this.basePath));
|
|
55212
|
+
}
|
|
55213
|
+
|
|
54937
55214
|
/**
|
|
54938
55215
|
* 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.
|
|
54939
55216
|
* @summary Find venues by name or id, across every venue
|
|
@@ -66156,7 +66433,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
66156
66433
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
66157
66434
|
* @summary Read when a store\'s ready-made report is emailed
|
|
66158
66435
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66159
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
66436
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66160
66437
|
* @param {*} [options] Override http request option.
|
|
66161
66438
|
* @throws {RequiredError}
|
|
66162
66439
|
*/
|
|
@@ -66341,7 +66618,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
66341
66618
|
* 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.
|
|
66342
66619
|
* @summary List the past runs of a store\'s ready-made report
|
|
66343
66620
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66344
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
66621
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66345
66622
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
66346
66623
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
66347
66624
|
* @param {*} [options] Override http request option.
|
|
@@ -66442,7 +66719,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
66442
66719
|
};
|
|
66443
66720
|
},
|
|
66444
66721
|
/**
|
|
66445
|
-
* 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
|
|
66722
|
+
* 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.
|
|
66446
66723
|
* @summary Set when an organisation\'s saved report is emailed
|
|
66447
66724
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
66448
66725
|
* @param {string} reportId The saved report\'s id
|
|
@@ -66490,10 +66767,10 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
66490
66767
|
};
|
|
66491
66768
|
},
|
|
66492
66769
|
/**
|
|
66493
|
-
* 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
|
|
66770
|
+
* 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.
|
|
66494
66771
|
* @summary Set when a store\'s ready-made report is emailed
|
|
66495
66772
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66496
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
66773
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66497
66774
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
66498
66775
|
* @param {*} [options] Override http request option.
|
|
66499
66776
|
* @throws {RequiredError}
|
|
@@ -66538,7 +66815,7 @@ export const ReportSchedulesApiAxiosParamCreator = function (configuration?: Con
|
|
|
66538
66815
|
};
|
|
66539
66816
|
},
|
|
66540
66817
|
/**
|
|
66541
|
-
* 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
|
|
66818
|
+
* 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.
|
|
66542
66819
|
* @summary Set when a store\'s saved report is emailed
|
|
66543
66820
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66544
66821
|
* @param {string} reportId The saved report\'s id
|
|
@@ -66635,7 +66912,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
66635
66912
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
66636
66913
|
* @summary Read when a store\'s ready-made report is emailed
|
|
66637
66914
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66638
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
66915
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66639
66916
|
* @param {*} [options] Override http request option.
|
|
66640
66917
|
* @throws {RequiredError}
|
|
66641
66918
|
*/
|
|
@@ -66686,7 +66963,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
66686
66963
|
* 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.
|
|
66687
66964
|
* @summary List the past runs of a store\'s ready-made report
|
|
66688
66965
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66689
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
66966
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66690
66967
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
66691
66968
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
66692
66969
|
* @param {*} [options] Override http request option.
|
|
@@ -66711,7 +66988,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
66711
66988
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
66712
66989
|
},
|
|
66713
66990
|
/**
|
|
66714
|
-
* 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
|
|
66991
|
+
* 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.
|
|
66715
66992
|
* @summary Set when an organisation\'s saved report is emailed
|
|
66716
66993
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
66717
66994
|
* @param {string} reportId The saved report\'s id
|
|
@@ -66724,10 +67001,10 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
66724
67001
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
66725
67002
|
},
|
|
66726
67003
|
/**
|
|
66727
|
-
* 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
|
|
67004
|
+
* 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.
|
|
66728
67005
|
* @summary Set when a store\'s ready-made report is emailed
|
|
66729
67006
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66730
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67007
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66731
67008
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
66732
67009
|
* @param {*} [options] Override http request option.
|
|
66733
67010
|
* @throws {RequiredError}
|
|
@@ -66737,7 +67014,7 @@ export const ReportSchedulesApiFp = function(configuration?: Configuration) {
|
|
|
66737
67014
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
66738
67015
|
},
|
|
66739
67016
|
/**
|
|
66740
|
-
* 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
|
|
67017
|
+
* 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.
|
|
66741
67018
|
* @summary Set when a store\'s saved report is emailed
|
|
66742
67019
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66743
67020
|
* @param {string} reportId The saved report\'s id
|
|
@@ -66796,7 +67073,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
66796
67073
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
66797
67074
|
* @summary Read when a store\'s ready-made report is emailed
|
|
66798
67075
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66799
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67076
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66800
67077
|
* @param {*} [options] Override http request option.
|
|
66801
67078
|
* @throws {RequiredError}
|
|
66802
67079
|
*/
|
|
@@ -66843,7 +67120,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
66843
67120
|
* 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.
|
|
66844
67121
|
* @summary List the past runs of a store\'s ready-made report
|
|
66845
67122
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66846
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67123
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66847
67124
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
66848
67125
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
66849
67126
|
* @param {*} [options] Override http request option.
|
|
@@ -66866,7 +67143,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
66866
67143
|
return localVarFp.listStoreSavedReportRuns(businessId, reportId, limit, after, options).then((request) => request(axios, basePath));
|
|
66867
67144
|
},
|
|
66868
67145
|
/**
|
|
66869
|
-
* 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
|
|
67146
|
+
* 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.
|
|
66870
67147
|
* @summary Set when an organisation\'s saved report is emailed
|
|
66871
67148
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
66872
67149
|
* @param {string} reportId The saved report\'s id
|
|
@@ -66878,10 +67155,10 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
66878
67155
|
return localVarFp.setOrganisationSavedReportSchedule(groupId, reportId, setReportScheduleDto, options).then((request) => request(axios, basePath));
|
|
66879
67156
|
},
|
|
66880
67157
|
/**
|
|
66881
|
-
* 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
|
|
67158
|
+
* 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.
|
|
66882
67159
|
* @summary Set when a store\'s ready-made report is emailed
|
|
66883
67160
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66884
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67161
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66885
67162
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
66886
67163
|
* @param {*} [options] Override http request option.
|
|
66887
67164
|
* @throws {RequiredError}
|
|
@@ -66890,7 +67167,7 @@ export const ReportSchedulesApiFactory = function (configuration?: Configuration
|
|
|
66890
67167
|
return localVarFp.setStoreReadyMadeReportSchedule(businessId, readyMadeReport, setReportScheduleDto, options).then((request) => request(axios, basePath));
|
|
66891
67168
|
},
|
|
66892
67169
|
/**
|
|
66893
|
-
* 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
|
|
67170
|
+
* 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.
|
|
66894
67171
|
* @summary Set when a store\'s saved report is emailed
|
|
66895
67172
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66896
67173
|
* @param {string} reportId The saved report\'s id
|
|
@@ -66947,7 +67224,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
66947
67224
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
66948
67225
|
* @summary Read when a store\'s ready-made report is emailed
|
|
66949
67226
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66950
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67227
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66951
67228
|
* @param {*} [options] Override http request option.
|
|
66952
67229
|
* @throws {RequiredError}
|
|
66953
67230
|
* @memberof ReportSchedulesApiInterface
|
|
@@ -66994,7 +67271,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
66994
67271
|
* 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.
|
|
66995
67272
|
* @summary List the past runs of a store\'s ready-made report
|
|
66996
67273
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
66997
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67274
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
66998
67275
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
66999
67276
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
67000
67277
|
* @param {*} [options] Override http request option.
|
|
@@ -67017,7 +67294,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
67017
67294
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
|
|
67018
67295
|
|
|
67019
67296
|
/**
|
|
67020
|
-
* 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
|
|
67297
|
+
* 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.
|
|
67021
67298
|
* @summary Set when an organisation\'s saved report is emailed
|
|
67022
67299
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
67023
67300
|
* @param {string} reportId The saved report\'s id
|
|
@@ -67029,10 +67306,10 @@ export interface ReportSchedulesApiInterface {
|
|
|
67029
67306
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
67030
67307
|
|
|
67031
67308
|
/**
|
|
67032
|
-
* 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
|
|
67309
|
+
* 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.
|
|
67033
67310
|
* @summary Set when a store\'s ready-made report is emailed
|
|
67034
67311
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
67035
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67312
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
67036
67313
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
67037
67314
|
* @param {*} [options] Override http request option.
|
|
67038
67315
|
* @throws {RequiredError}
|
|
@@ -67041,7 +67318,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
67041
67318
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
67042
67319
|
|
|
67043
67320
|
/**
|
|
67044
|
-
* 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
|
|
67321
|
+
* 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.
|
|
67045
67322
|
* @summary Set when a store\'s saved report is emailed
|
|
67046
67323
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
67047
67324
|
* @param {string} reportId The saved report\'s id
|
|
@@ -67104,7 +67381,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
67104
67381
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
67105
67382
|
* @summary Read when a store\'s ready-made report is emailed
|
|
67106
67383
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
67107
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67384
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
67108
67385
|
* @param {*} [options] Override http request option.
|
|
67109
67386
|
* @throws {RequiredError}
|
|
67110
67387
|
* @memberof ReportSchedulesApi
|
|
@@ -67159,7 +67436,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
67159
67436
|
* 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.
|
|
67160
67437
|
* @summary List the past runs of a store\'s ready-made report
|
|
67161
67438
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
67162
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67439
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
67163
67440
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
67164
67441
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
67165
67442
|
* @param {*} [options] Override http request option.
|
|
@@ -67186,7 +67463,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
67186
67463
|
}
|
|
67187
67464
|
|
|
67188
67465
|
/**
|
|
67189
|
-
* 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
|
|
67466
|
+
* 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.
|
|
67190
67467
|
* @summary Set when an organisation\'s saved report is emailed
|
|
67191
67468
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
67192
67469
|
* @param {string} reportId The saved report\'s id
|
|
@@ -67200,10 +67477,10 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
67200
67477
|
}
|
|
67201
67478
|
|
|
67202
67479
|
/**
|
|
67203
|
-
* 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
|
|
67480
|
+
* 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.
|
|
67204
67481
|
* @summary Set when a store\'s ready-made report is emailed
|
|
67205
67482
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
67206
|
-
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff
|
|
67483
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
67207
67484
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
67208
67485
|
* @param {*} [options] Override http request option.
|
|
67209
67486
|
* @throws {RequiredError}
|
|
@@ -67214,7 +67491,7 @@ export class ReportSchedulesApi extends BaseAPI implements ReportSchedulesApiInt
|
|
|
67214
67491
|
}
|
|
67215
67492
|
|
|
67216
67493
|
/**
|
|
67217
|
-
* 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
|
|
67494
|
+
* 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.
|
|
67218
67495
|
* @summary Set when a store\'s saved report is emailed
|
|
67219
67496
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
67220
67497
|
* @param {string} reportId The saved report\'s id
|
|
@@ -70731,6 +71008,58 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
70731
71008
|
|
|
70732
71009
|
|
|
70733
71010
|
|
|
71011
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71012
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71013
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71014
|
+
|
|
71015
|
+
return {
|
|
71016
|
+
url: toPathString(localVarUrlObj),
|
|
71017
|
+
options: localVarRequestOptions,
|
|
71018
|
+
};
|
|
71019
|
+
},
|
|
71020
|
+
/**
|
|
71021
|
+
* 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).
|
|
71022
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71023
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71024
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71025
|
+
* @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
|
|
71026
|
+
* @param {*} [options] Override http request option.
|
|
71027
|
+
* @throws {RequiredError}
|
|
71028
|
+
*/
|
|
71029
|
+
staffHoursAtVenue: async (businessId: number, from: string, to: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71030
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71031
|
+
assertParamExists('staffHoursAtVenue', 'businessId', businessId)
|
|
71032
|
+
// verify required parameter 'from' is not null or undefined
|
|
71033
|
+
assertParamExists('staffHoursAtVenue', 'from', from)
|
|
71034
|
+
// verify required parameter 'to' is not null or undefined
|
|
71035
|
+
assertParamExists('staffHoursAtVenue', 'to', to)
|
|
71036
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/hours`
|
|
71037
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71038
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71039
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71040
|
+
let baseOptions;
|
|
71041
|
+
if (configuration) {
|
|
71042
|
+
baseOptions = configuration.baseOptions;
|
|
71043
|
+
}
|
|
71044
|
+
|
|
71045
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
71046
|
+
const localVarHeaderParameter = {} as any;
|
|
71047
|
+
const localVarQueryParameter = {} as any;
|
|
71048
|
+
|
|
71049
|
+
// authentication JWT-auth required
|
|
71050
|
+
// http bearer authentication required
|
|
71051
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71052
|
+
|
|
71053
|
+
if (from !== undefined) {
|
|
71054
|
+
localVarQueryParameter['from'] = from;
|
|
71055
|
+
}
|
|
71056
|
+
|
|
71057
|
+
if (to !== undefined) {
|
|
71058
|
+
localVarQueryParameter['to'] = to;
|
|
71059
|
+
}
|
|
71060
|
+
|
|
71061
|
+
|
|
71062
|
+
|
|
70734
71063
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
70735
71064
|
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
70736
71065
|
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
@@ -70882,6 +71211,19 @@ export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
|
70882
71211
|
const localVarAxiosArgs = await localVarAxiosParamCreator.lockTill(businessId, options);
|
|
70883
71212
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
70884
71213
|
},
|
|
71214
|
+
/**
|
|
71215
|
+
* 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).
|
|
71216
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71217
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71218
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71219
|
+
* @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
|
|
71220
|
+
* @param {*} [options] Override http request option.
|
|
71221
|
+
* @throws {RequiredError}
|
|
71222
|
+
*/
|
|
71223
|
+
async staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffHoursResponseDto>> {
|
|
71224
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffHoursAtVenue(businessId, from, to, options);
|
|
71225
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71226
|
+
},
|
|
70885
71227
|
/**
|
|
70886
71228
|
* 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>).
|
|
70887
71229
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -70959,6 +71301,18 @@ export const ShiftTrackingApiFactory = function (configuration?: Configuration,
|
|
|
70959
71301
|
lockTill(businessId: number, options?: any): AxiosPromise<void> {
|
|
70960
71302
|
return localVarFp.lockTill(businessId, options).then((request) => request(axios, basePath));
|
|
70961
71303
|
},
|
|
71304
|
+
/**
|
|
71305
|
+
* 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).
|
|
71306
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71307
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71308
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71309
|
+
* @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
|
|
71310
|
+
* @param {*} [options] Override http request option.
|
|
71311
|
+
* @throws {RequiredError}
|
|
71312
|
+
*/
|
|
71313
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, options?: any): AxiosPromise<StaffHoursResponseDto> {
|
|
71314
|
+
return localVarFp.staffHoursAtVenue(businessId, from, to, options).then((request) => request(axios, basePath));
|
|
71315
|
+
},
|
|
70962
71316
|
/**
|
|
70963
71317
|
* 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>).
|
|
70964
71318
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -71033,6 +71387,18 @@ export interface ShiftTrackingApiInterface {
|
|
|
71033
71387
|
*/
|
|
71034
71388
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
71035
71389
|
|
|
71390
|
+
/**
|
|
71391
|
+
* 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).
|
|
71392
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71393
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71394
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71395
|
+
* @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
|
|
71396
|
+
* @param {*} [options] Override http request option.
|
|
71397
|
+
* @throws {RequiredError}
|
|
71398
|
+
* @memberof ShiftTrackingApiInterface
|
|
71399
|
+
*/
|
|
71400
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): AxiosPromise<StaffHoursResponseDto>;
|
|
71401
|
+
|
|
71036
71402
|
/**
|
|
71037
71403
|
* 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>).
|
|
71038
71404
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -71115,6 +71481,20 @@ export class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterfa
|
|
|
71115
71481
|
return ShiftTrackingApiFp(this.configuration).lockTill(businessId, options).then((request) => request(this.axios, this.basePath));
|
|
71116
71482
|
}
|
|
71117
71483
|
|
|
71484
|
+
/**
|
|
71485
|
+
* 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).
|
|
71486
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71487
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71488
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71489
|
+
* @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
|
|
71490
|
+
* @param {*} [options] Override http request option.
|
|
71491
|
+
* @throws {RequiredError}
|
|
71492
|
+
* @memberof ShiftTrackingApi
|
|
71493
|
+
*/
|
|
71494
|
+
public staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig) {
|
|
71495
|
+
return ShiftTrackingApiFp(this.configuration).staffHoursAtVenue(businessId, from, to, options).then((request) => request(this.axios, this.basePath));
|
|
71496
|
+
}
|
|
71497
|
+
|
|
71118
71498
|
/**
|
|
71119
71499
|
* 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>).
|
|
71120
71500
|
* @summary Unlock the till for an employee (no PIN; old builds)
|