@munchi_oy/core 2.7.0 → 2.9.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 +676 -45
- 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 +985 -46
- package/package.json +15 -13
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -194,6 +194,31 @@ export interface AddEmployeeRoleDto {
|
|
|
194
194
|
*/
|
|
195
195
|
'permissionKeys': Array<PosPermission>;
|
|
196
196
|
}
|
|
197
|
+
/**
|
|
198
|
+
*
|
|
199
|
+
* @export
|
|
200
|
+
* @interface AddShiftDto
|
|
201
|
+
*/
|
|
202
|
+
export interface AddShiftDto {
|
|
203
|
+
/**
|
|
204
|
+
* The staff member the shift is of, by employee id; they must work at the venue
|
|
205
|
+
* @type {string}
|
|
206
|
+
* @memberof AddShiftDto
|
|
207
|
+
*/
|
|
208
|
+
'employeeId': string;
|
|
209
|
+
/**
|
|
210
|
+
* When the staff member clocked in, an ISO 8601 instant
|
|
211
|
+
* @type {string}
|
|
212
|
+
* @memberof AddShiftDto
|
|
213
|
+
*/
|
|
214
|
+
'clockInTime': string;
|
|
215
|
+
/**
|
|
216
|
+
* When the staff member clocked out, an ISO 8601 instant at or after the clock-in. Absent or null: the shift is still open
|
|
217
|
+
* @type {string}
|
|
218
|
+
* @memberof AddShiftDto
|
|
219
|
+
*/
|
|
220
|
+
'clockOutTime'?: string | null;
|
|
221
|
+
}
|
|
197
222
|
/**
|
|
198
223
|
*
|
|
199
224
|
* @export
|
|
@@ -2745,6 +2770,25 @@ export interface ChangeResQOfferDto {
|
|
|
2745
2770
|
*/
|
|
2746
2771
|
'fetchEnd'?: string;
|
|
2747
2772
|
}
|
|
2773
|
+
/**
|
|
2774
|
+
*
|
|
2775
|
+
* @export
|
|
2776
|
+
* @interface ChangeShiftDto
|
|
2777
|
+
*/
|
|
2778
|
+
export interface ChangeShiftDto {
|
|
2779
|
+
/**
|
|
2780
|
+
* The new clock-in, an ISO 8601 instant; null is refused. Absent: unchanged
|
|
2781
|
+
* @type {string}
|
|
2782
|
+
* @memberof ChangeShiftDto
|
|
2783
|
+
*/
|
|
2784
|
+
'clockInTime'?: string;
|
|
2785
|
+
/**
|
|
2786
|
+
* The new clock-out, an ISO 8601 instant at or after the clock-in (a forgotten clock-out set). Absent: unchanged
|
|
2787
|
+
* @type {string}
|
|
2788
|
+
* @memberof ChangeShiftDto
|
|
2789
|
+
*/
|
|
2790
|
+
'clockOutTime'?: string;
|
|
2791
|
+
}
|
|
2748
2792
|
/**
|
|
2749
2793
|
*
|
|
2750
2794
|
* @export
|
|
@@ -24393,6 +24437,7 @@ export declare const ReadyMadeReport: {
|
|
|
24393
24437
|
readonly ProductSales: "productSales";
|
|
24394
24438
|
readonly CashSessions: "cashSessions";
|
|
24395
24439
|
readonly Staff: "staff";
|
|
24440
|
+
readonly Hours: "hours";
|
|
24396
24441
|
};
|
|
24397
24442
|
export type ReadyMadeReport = typeof ReadyMadeReport[keyof typeof ReadyMadeReport];
|
|
24398
24443
|
/**
|
|
@@ -25489,6 +25534,81 @@ export interface RejectOrderDto {
|
|
|
25489
25534
|
*/
|
|
25490
25535
|
'reason': string;
|
|
25491
25536
|
}
|
|
25537
|
+
/**
|
|
25538
|
+
*
|
|
25539
|
+
* @export
|
|
25540
|
+
* @interface ReleaseLicenceHoldsDto
|
|
25541
|
+
*/
|
|
25542
|
+
export interface ReleaseLicenceHoldsDto {
|
|
25543
|
+
/**
|
|
25544
|
+
* true (the default): answers the holds a release would turn back on and changes nothing; false turns them on
|
|
25545
|
+
* @type {boolean}
|
|
25546
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
25547
|
+
*/
|
|
25548
|
+
'dryRun'?: boolean;
|
|
25549
|
+
/**
|
|
25550
|
+
* How many venues\' holds one call releases, by venue id; call again until holdsLeft is 0. Absent: 50
|
|
25551
|
+
* @type {number}
|
|
25552
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
25553
|
+
*/
|
|
25554
|
+
'batchSize'?: number;
|
|
25555
|
+
/**
|
|
25556
|
+
* Start after this venue id: the nextAfterVenueId of the previous call, to page through a dry run. Absent: from the first venue
|
|
25557
|
+
* @type {number}
|
|
25558
|
+
* @memberof ReleaseLicenceHoldsDto
|
|
25559
|
+
*/
|
|
25560
|
+
'afterVenueId'?: number;
|
|
25561
|
+
}
|
|
25562
|
+
/**
|
|
25563
|
+
*
|
|
25564
|
+
* @export
|
|
25565
|
+
* @interface ReleasedLicenceHoldDto
|
|
25566
|
+
*/
|
|
25567
|
+
export interface ReleasedLicenceHoldDto {
|
|
25568
|
+
/**
|
|
25569
|
+
* The venue (orderingBusinessId)
|
|
25570
|
+
* @type {number}
|
|
25571
|
+
* @memberof ReleasedLicenceHoldDto
|
|
25572
|
+
*/
|
|
25573
|
+
'venueId': number;
|
|
25574
|
+
/**
|
|
25575
|
+
* 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
|
|
25576
|
+
* @type {Array<string>}
|
|
25577
|
+
* @memberof ReleasedLicenceHoldDto
|
|
25578
|
+
*/
|
|
25579
|
+
'rowIds': Array<string>;
|
|
25580
|
+
}
|
|
25581
|
+
/**
|
|
25582
|
+
*
|
|
25583
|
+
* @export
|
|
25584
|
+
* @interface ReleasedLicenceHoldsDto
|
|
25585
|
+
*/
|
|
25586
|
+
export interface ReleasedLicenceHoldsDto {
|
|
25587
|
+
/**
|
|
25588
|
+
* Whether this was a dry run, which changed nothing
|
|
25589
|
+
* @type {boolean}
|
|
25590
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25591
|
+
*/
|
|
25592
|
+
'dryRun': boolean;
|
|
25593
|
+
/**
|
|
25594
|
+
* The venues of this batch and their rows
|
|
25595
|
+
* @type {Array<ReleasedLicenceHoldDto>}
|
|
25596
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25597
|
+
*/
|
|
25598
|
+
'venues': Array<ReleasedLicenceHoldDto>;
|
|
25599
|
+
/**
|
|
25600
|
+
* How many venues after this batch still have a hold keeping a row off: call again until 0
|
|
25601
|
+
* @type {number}
|
|
25602
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25603
|
+
*/
|
|
25604
|
+
'holdsLeft': number;
|
|
25605
|
+
/**
|
|
25606
|
+
* 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
|
|
25607
|
+
* @type {number}
|
|
25608
|
+
* @memberof ReleasedLicenceHoldsDto
|
|
25609
|
+
*/
|
|
25610
|
+
'nextAfterVenueId': number | null;
|
|
25611
|
+
}
|
|
25492
25612
|
/**
|
|
25493
25613
|
*
|
|
25494
25614
|
* @export
|
|
@@ -29649,6 +29769,16 @@ export interface ShiftEmployeeDto {
|
|
|
29649
29769
|
*/
|
|
29650
29770
|
'photoUrl': string | null;
|
|
29651
29771
|
}
|
|
29772
|
+
/**
|
|
29773
|
+
*
|
|
29774
|
+
* @export
|
|
29775
|
+
* @enum {string}
|
|
29776
|
+
*/
|
|
29777
|
+
export declare const ShiftStatus: {
|
|
29778
|
+
readonly Open: "open";
|
|
29779
|
+
readonly Closed: "closed";
|
|
29780
|
+
};
|
|
29781
|
+
export type ShiftStatus = typeof ShiftStatus[keyof typeof ShiftStatus];
|
|
29652
29782
|
/**
|
|
29653
29783
|
*
|
|
29654
29784
|
* @export
|
|
@@ -29975,6 +30105,185 @@ export interface StaffActivityLogDto {
|
|
|
29975
30105
|
*/
|
|
29976
30106
|
'productName'?: string | null;
|
|
29977
30107
|
}
|
|
30108
|
+
/**
|
|
30109
|
+
*
|
|
30110
|
+
* @export
|
|
30111
|
+
* @interface StaffHoursDayDto
|
|
30112
|
+
*/
|
|
30113
|
+
export interface StaffHoursDayDto {
|
|
30114
|
+
/**
|
|
30115
|
+
* The day the shift began, YYYY-MM-DD, in the venue\'s time zone
|
|
30116
|
+
* @type {string}
|
|
30117
|
+
* @memberof StaffHoursDayDto
|
|
30118
|
+
*/
|
|
30119
|
+
'day': string;
|
|
30120
|
+
/**
|
|
30121
|
+
* The day\'s worked minutes, all its shifts added up
|
|
30122
|
+
* @type {number}
|
|
30123
|
+
* @memberof StaffHoursDayDto
|
|
30124
|
+
*/
|
|
30125
|
+
'minutes': number;
|
|
30126
|
+
/**
|
|
30127
|
+
* The day\'s shifts, oldest first
|
|
30128
|
+
* @type {Array<StaffHoursShiftDto>}
|
|
30129
|
+
* @memberof StaffHoursDayDto
|
|
30130
|
+
*/
|
|
30131
|
+
'shifts': Array<StaffHoursShiftDto>;
|
|
30132
|
+
}
|
|
30133
|
+
/**
|
|
30134
|
+
*
|
|
30135
|
+
* @export
|
|
30136
|
+
* @interface StaffHoursPersonDto
|
|
30137
|
+
*/
|
|
30138
|
+
export interface StaffHoursPersonDto {
|
|
30139
|
+
/**
|
|
30140
|
+
* The staff member\'s id
|
|
30141
|
+
* @type {string}
|
|
30142
|
+
* @memberof StaffHoursPersonDto
|
|
30143
|
+
*/
|
|
30144
|
+
'employeeId': string;
|
|
30145
|
+
/**
|
|
30146
|
+
* The staff member\'s name
|
|
30147
|
+
* @type {string}
|
|
30148
|
+
* @memberof StaffHoursPersonDto
|
|
30149
|
+
*/
|
|
30150
|
+
'name': string;
|
|
30151
|
+
/**
|
|
30152
|
+
* Worked minutes over the whole period
|
|
30153
|
+
* @type {number}
|
|
30154
|
+
* @memberof StaffHoursPersonDto
|
|
30155
|
+
*/
|
|
30156
|
+
'minutes': number;
|
|
30157
|
+
/**
|
|
30158
|
+
* Shifts in the period with no clock-out yet: still working, or a clock-out forgotten
|
|
30159
|
+
* @type {number}
|
|
30160
|
+
* @memberof StaffHoursPersonDto
|
|
30161
|
+
*/
|
|
30162
|
+
'openShifts': number;
|
|
30163
|
+
/**
|
|
30164
|
+
* Each day with a shift, oldest first
|
|
30165
|
+
* @type {Array<StaffHoursDayDto>}
|
|
30166
|
+
* @memberof StaffHoursPersonDto
|
|
30167
|
+
*/
|
|
30168
|
+
'days': Array<StaffHoursDayDto>;
|
|
30169
|
+
}
|
|
30170
|
+
/**
|
|
30171
|
+
*
|
|
30172
|
+
* @export
|
|
30173
|
+
* @interface StaffHoursResponseDto
|
|
30174
|
+
*/
|
|
30175
|
+
export interface StaffHoursResponseDto {
|
|
30176
|
+
/**
|
|
30177
|
+
* The venue\'s time zone the days are counted in
|
|
30178
|
+
* @type {string}
|
|
30179
|
+
* @memberof StaffHoursResponseDto
|
|
30180
|
+
*/
|
|
30181
|
+
'timeZone': string;
|
|
30182
|
+
/**
|
|
30183
|
+
* The first day, as asked
|
|
30184
|
+
* @type {string}
|
|
30185
|
+
* @memberof StaffHoursResponseDto
|
|
30186
|
+
*/
|
|
30187
|
+
'from': string;
|
|
30188
|
+
/**
|
|
30189
|
+
* The last day, as asked
|
|
30190
|
+
* @type {string}
|
|
30191
|
+
* @memberof StaffHoursResponseDto
|
|
30192
|
+
*/
|
|
30193
|
+
'to': string;
|
|
30194
|
+
/**
|
|
30195
|
+
* Every staff member with a shift in the period, by name
|
|
30196
|
+
* @type {Array<StaffHoursPersonDto>}
|
|
30197
|
+
* @memberof StaffHoursResponseDto
|
|
30198
|
+
*/
|
|
30199
|
+
'people': Array<StaffHoursPersonDto>;
|
|
30200
|
+
}
|
|
30201
|
+
/**
|
|
30202
|
+
*
|
|
30203
|
+
* @export
|
|
30204
|
+
* @interface StaffHoursShiftDto
|
|
30205
|
+
*/
|
|
30206
|
+
export interface StaffHoursShiftDto {
|
|
30207
|
+
/**
|
|
30208
|
+
* The shift\'s id
|
|
30209
|
+
* @type {string}
|
|
30210
|
+
* @memberof StaffHoursShiftDto
|
|
30211
|
+
*/
|
|
30212
|
+
'shiftId': string;
|
|
30213
|
+
/**
|
|
30214
|
+
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
30215
|
+
* @type {string}
|
|
30216
|
+
* @memberof StaffHoursShiftDto
|
|
30217
|
+
*/
|
|
30218
|
+
'clockInTime': string | null;
|
|
30219
|
+
/**
|
|
30220
|
+
* When the staff member clocked out; null while the shift is still open
|
|
30221
|
+
* @type {string}
|
|
30222
|
+
* @memberof StaffHoursShiftDto
|
|
30223
|
+
*/
|
|
30224
|
+
'clockOutTime': string | null;
|
|
30225
|
+
/**
|
|
30226
|
+
* 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
|
|
30227
|
+
* @type {number}
|
|
30228
|
+
* @memberof StaffHoursShiftDto
|
|
30229
|
+
*/
|
|
30230
|
+
'minutes': number;
|
|
30231
|
+
/**
|
|
30232
|
+
*
|
|
30233
|
+
* @type {ShiftStatus}
|
|
30234
|
+
* @memberof StaffHoursShiftDto
|
|
30235
|
+
*/
|
|
30236
|
+
'status': ShiftStatus;
|
|
30237
|
+
}
|
|
30238
|
+
/**
|
|
30239
|
+
*
|
|
30240
|
+
* @export
|
|
30241
|
+
* @interface StaffShiftDto
|
|
30242
|
+
*/
|
|
30243
|
+
export interface StaffShiftDto {
|
|
30244
|
+
/**
|
|
30245
|
+
* The shift\'s id
|
|
30246
|
+
* @type {string}
|
|
30247
|
+
* @memberof StaffShiftDto
|
|
30248
|
+
*/
|
|
30249
|
+
'shiftId': string;
|
|
30250
|
+
/**
|
|
30251
|
+
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
30252
|
+
* @type {string}
|
|
30253
|
+
* @memberof StaffShiftDto
|
|
30254
|
+
*/
|
|
30255
|
+
'clockInTime': string | null;
|
|
30256
|
+
/**
|
|
30257
|
+
* When the staff member clocked out; null while the shift is still open
|
|
30258
|
+
* @type {string}
|
|
30259
|
+
* @memberof StaffShiftDto
|
|
30260
|
+
*/
|
|
30261
|
+
'clockOutTime': string | null;
|
|
30262
|
+
/**
|
|
30263
|
+
* 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
|
|
30264
|
+
* @type {number}
|
|
30265
|
+
* @memberof StaffShiftDto
|
|
30266
|
+
*/
|
|
30267
|
+
'minutes': number;
|
|
30268
|
+
/**
|
|
30269
|
+
*
|
|
30270
|
+
* @type {ShiftStatus}
|
|
30271
|
+
* @memberof StaffShiftDto
|
|
30272
|
+
*/
|
|
30273
|
+
'status': ShiftStatus;
|
|
30274
|
+
/**
|
|
30275
|
+
* The staff member\'s id
|
|
30276
|
+
* @type {string}
|
|
30277
|
+
* @memberof StaffShiftDto
|
|
30278
|
+
*/
|
|
30279
|
+
'employeeId': string;
|
|
30280
|
+
/**
|
|
30281
|
+
* The staff member\'s name
|
|
30282
|
+
* @type {string}
|
|
30283
|
+
* @memberof StaffShiftDto
|
|
30284
|
+
*/
|
|
30285
|
+
'name': string;
|
|
30286
|
+
}
|
|
29978
30287
|
/**
|
|
29979
30288
|
*
|
|
29980
30289
|
* @export
|
|
@@ -44862,7 +45171,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
44862
45171
|
*/
|
|
44863
45172
|
export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
44864
45173
|
/**
|
|
44865
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45174
|
+
* Saves a company the venue invoices, for the dashboard\'s Settings › Payments on a person\'s sign-in, and for munchi-dashboard-server and the MCP on a key. The venue is the body\'s businessId; a body field the DTO does not declare is ignored. Once saved, the venue\'s kept company list and its config are invalidated.
|
|
44866
45175
|
* @summary Create a new invoice company
|
|
44867
45176
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
44868
45177
|
* @param {*} [options] Override http request option.
|
|
@@ -44870,7 +45179,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
44870
45179
|
*/
|
|
44871
45180
|
createInvoiceCompany: (createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44872
45181
|
/**
|
|
44873
|
-
* Deletes one of the venue\'s companies, for
|
|
45182
|
+
* Deletes one of the venue\'s companies, for the same callers as POST. Orders that already carry the company keep their copy of it. Once deleted, the venue\'s kept company list and its config are invalidated.
|
|
44874
45183
|
* @summary Delete an invoice company
|
|
44875
45184
|
* @param {string} id The company\'s id
|
|
44876
45185
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -44905,7 +45214,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
44905
45214
|
*/
|
|
44906
45215
|
searchInvoiceCompanies: (businessId: number, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
44907
45216
|
/**
|
|
44908
|
-
* Changes the fields sent and keeps the others, for
|
|
45217
|
+
* Changes the fields sent and keeps the others, for the same callers as POST; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
44909
45218
|
* @summary Update an invoice company
|
|
44910
45219
|
* @param {string} id The company\'s id
|
|
44911
45220
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -44921,7 +45230,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
44921
45230
|
*/
|
|
44922
45231
|
export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
44923
45232
|
/**
|
|
44924
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45233
|
+
* Saves a company the venue invoices, for the dashboard\'s Settings › Payments on a person\'s sign-in, and for munchi-dashboard-server and the MCP on a key. The venue is the body\'s businessId; a body field the DTO does not declare is ignored. Once saved, the venue\'s kept company list and its config are invalidated.
|
|
44925
45234
|
* @summary Create a new invoice company
|
|
44926
45235
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
44927
45236
|
* @param {*} [options] Override http request option.
|
|
@@ -44929,7 +45238,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
44929
45238
|
*/
|
|
44930
45239
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceCompanyResponseDto>>;
|
|
44931
45240
|
/**
|
|
44932
|
-
* Deletes one of the venue\'s companies, for
|
|
45241
|
+
* Deletes one of the venue\'s companies, for the same callers as POST. Orders that already carry the company keep their copy of it. Once deleted, the venue\'s kept company list and its config are invalidated.
|
|
44933
45242
|
* @summary Delete an invoice company
|
|
44934
45243
|
* @param {string} id The company\'s id
|
|
44935
45244
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -44964,7 +45273,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
44964
45273
|
*/
|
|
44965
45274
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceCompanyResponseDto>>>;
|
|
44966
45275
|
/**
|
|
44967
|
-
* Changes the fields sent and keeps the others, for
|
|
45276
|
+
* Changes the fields sent and keeps the others, for the same callers as POST; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
44968
45277
|
* @summary Update an invoice company
|
|
44969
45278
|
* @param {string} id The company\'s id
|
|
44970
45279
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -44980,7 +45289,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
44980
45289
|
*/
|
|
44981
45290
|
export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
44982
45291
|
/**
|
|
44983
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45292
|
+
* Saves a company the venue invoices, for the dashboard\'s Settings › Payments on a person\'s sign-in, and for munchi-dashboard-server and the MCP on a key. The venue is the body\'s businessId; a body field the DTO does not declare is ignored. Once saved, the venue\'s kept company list and its config are invalidated.
|
|
44984
45293
|
* @summary Create a new invoice company
|
|
44985
45294
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
44986
45295
|
* @param {*} [options] Override http request option.
|
|
@@ -44988,7 +45297,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
44988
45297
|
*/
|
|
44989
45298
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: any): AxiosPromise<InvoiceCompanyResponseDto>;
|
|
44990
45299
|
/**
|
|
44991
|
-
* Deletes one of the venue\'s companies, for
|
|
45300
|
+
* Deletes one of the venue\'s companies, for the same callers as POST. Orders that already carry the company keep their copy of it. Once deleted, the venue\'s kept company list and its config are invalidated.
|
|
44992
45301
|
* @summary Delete an invoice company
|
|
44993
45302
|
* @param {string} id The company\'s id
|
|
44994
45303
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45023,7 +45332,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45023
45332
|
*/
|
|
45024
45333
|
searchInvoiceCompanies(businessId: number, search?: string, options?: any): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
45025
45334
|
/**
|
|
45026
|
-
* Changes the fields sent and keeps the others, for
|
|
45335
|
+
* Changes the fields sent and keeps the others, for the same callers as POST; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
45027
45336
|
* @summary Update an invoice company
|
|
45028
45337
|
* @param {string} id The company\'s id
|
|
45029
45338
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45040,7 +45349,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45040
45349
|
*/
|
|
45041
45350
|
export interface InvoiceCompaniesApiInterface {
|
|
45042
45351
|
/**
|
|
45043
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45352
|
+
* Saves a company the venue invoices, for the dashboard\'s Settings › Payments on a person\'s sign-in, and for munchi-dashboard-server and the MCP on a key. The venue is the body\'s businessId; a body field the DTO does not declare is ignored. Once saved, the venue\'s kept company list and its config are invalidated.
|
|
45044
45353
|
* @summary Create a new invoice company
|
|
45045
45354
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45046
45355
|
* @param {*} [options] Override http request option.
|
|
@@ -45049,7 +45358,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45049
45358
|
*/
|
|
45050
45359
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): AxiosPromise<InvoiceCompanyResponseDto>;
|
|
45051
45360
|
/**
|
|
45052
|
-
* Deletes one of the venue\'s companies, for
|
|
45361
|
+
* Deletes one of the venue\'s companies, for the same callers as POST. Orders that already carry the company keep their copy of it. Once deleted, the venue\'s kept company list and its config are invalidated.
|
|
45053
45362
|
* @summary Delete an invoice company
|
|
45054
45363
|
* @param {string} id The company\'s id
|
|
45055
45364
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45088,7 +45397,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45088
45397
|
*/
|
|
45089
45398
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
45090
45399
|
/**
|
|
45091
|
-
* Changes the fields sent and keeps the others, for
|
|
45400
|
+
* Changes the fields sent and keeps the others, for the same callers as POST; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
45092
45401
|
* @summary Update an invoice company
|
|
45093
45402
|
* @param {string} id The company\'s id
|
|
45094
45403
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45107,7 +45416,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45107
45416
|
*/
|
|
45108
45417
|
export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiInterface {
|
|
45109
45418
|
/**
|
|
45110
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45419
|
+
* Saves a company the venue invoices, for the dashboard\'s Settings › Payments on a person\'s sign-in, and for munchi-dashboard-server and the MCP on a key. The venue is the body\'s businessId; a body field the DTO does not declare is ignored. Once saved, the venue\'s kept company list and its config are invalidated.
|
|
45111
45420
|
* @summary Create a new invoice company
|
|
45112
45421
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45113
45422
|
* @param {*} [options] Override http request option.
|
|
@@ -45116,7 +45425,7 @@ export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompa
|
|
|
45116
45425
|
*/
|
|
45117
45426
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceCompanyResponseDto, any, {}>>;
|
|
45118
45427
|
/**
|
|
45119
|
-
* Deletes one of the venue\'s companies, for
|
|
45428
|
+
* Deletes one of the venue\'s companies, for the same callers as POST. Orders that already carry the company keep their copy of it. Once deleted, the venue\'s kept company list and its config are invalidated.
|
|
45120
45429
|
* @summary Delete an invoice company
|
|
45121
45430
|
* @param {string} id The company\'s id
|
|
45122
45431
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45155,7 +45464,7 @@ export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompa
|
|
|
45155
45464
|
*/
|
|
45156
45465
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceCompanyResponseDto[], any, {}>>;
|
|
45157
45466
|
/**
|
|
45158
|
-
* Changes the fields sent and keeps the others, for
|
|
45467
|
+
* Changes the fields sent and keeps the others, for the same callers as POST; a body field the DTO does not declare is ignored, and an address, phone, countryCode or bic sent as null is cleared. Once changed, the venue\'s kept company list and its config are invalidated, and the company is answered as the change wrote it. A body with no field changes nothing and answers the company as it is.
|
|
45159
45468
|
* @summary Update an invoice company
|
|
45160
45469
|
* @param {string} id The company\'s id
|
|
45161
45470
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -47004,6 +47313,14 @@ export declare const OpsApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
47004
47313
|
* @throws {RequiredError}
|
|
47005
47314
|
*/
|
|
47006
47315
|
disconnectDeliveryPlatform: (venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47316
|
+
/**
|
|
47317
|
+
* 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.
|
|
47318
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47319
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47320
|
+
* @param {*} [options] Override http request option.
|
|
47321
|
+
* @throws {RequiredError}
|
|
47322
|
+
*/
|
|
47323
|
+
releaseLicenceHolds: (releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
47007
47324
|
/**
|
|
47008
47325
|
* 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
47326
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47045,6 +47362,14 @@ export declare const OpsApiFp: (configuration?: Configuration) => {
|
|
|
47045
47362
|
* @throws {RequiredError}
|
|
47046
47363
|
*/
|
|
47047
47364
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<DisconnectedDeliveryPlatformDto>>;
|
|
47365
|
+
/**
|
|
47366
|
+
* 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.
|
|
47367
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47368
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47369
|
+
* @param {*} [options] Override http request option.
|
|
47370
|
+
* @throws {RequiredError}
|
|
47371
|
+
*/
|
|
47372
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReleasedLicenceHoldsDto>>;
|
|
47048
47373
|
/**
|
|
47049
47374
|
* 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
47375
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47086,6 +47411,14 @@ export declare const OpsApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
47086
47411
|
* @throws {RequiredError}
|
|
47087
47412
|
*/
|
|
47088
47413
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: any): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
47414
|
+
/**
|
|
47415
|
+
* 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.
|
|
47416
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47417
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47418
|
+
* @param {*} [options] Override http request option.
|
|
47419
|
+
* @throws {RequiredError}
|
|
47420
|
+
*/
|
|
47421
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: any): AxiosPromise<ReleasedLicenceHoldsDto>;
|
|
47089
47422
|
/**
|
|
47090
47423
|
* 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
47424
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47131,6 +47464,15 @@ export interface OpsApiInterface {
|
|
|
47131
47464
|
* @memberof OpsApiInterface
|
|
47132
47465
|
*/
|
|
47133
47466
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): AxiosPromise<DisconnectedDeliveryPlatformDto>;
|
|
47467
|
+
/**
|
|
47468
|
+
* 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.
|
|
47469
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47470
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47471
|
+
* @param {*} [options] Override http request option.
|
|
47472
|
+
* @throws {RequiredError}
|
|
47473
|
+
* @memberof OpsApiInterface
|
|
47474
|
+
*/
|
|
47475
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): AxiosPromise<ReleasedLicenceHoldsDto>;
|
|
47134
47476
|
/**
|
|
47135
47477
|
* 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
47478
|
* @summary Find venues by name or id, across every venue
|
|
@@ -47178,6 +47520,15 @@ export declare class OpsApi extends BaseAPI implements OpsApiInterface {
|
|
|
47178
47520
|
* @memberof OpsApi
|
|
47179
47521
|
*/
|
|
47180
47522
|
disconnectDeliveryPlatform(venueId: number, channel: DeliveryPlatformOpsConnect, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<DisconnectedDeliveryPlatformDto, any, {}>>;
|
|
47523
|
+
/**
|
|
47524
|
+
* 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.
|
|
47525
|
+
* @summary Turn back on the kiosk and online store rows licence enforcement turned off
|
|
47526
|
+
* @param {ReleaseLicenceHoldsDto} releaseLicenceHoldsDto
|
|
47527
|
+
* @param {*} [options] Override http request option.
|
|
47528
|
+
* @throws {RequiredError}
|
|
47529
|
+
* @memberof OpsApi
|
|
47530
|
+
*/
|
|
47531
|
+
releaseLicenceHolds(releaseLicenceHoldsDto: ReleaseLicenceHoldsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReleasedLicenceHoldsDto, any, {}>>;
|
|
47181
47532
|
/**
|
|
47182
47533
|
* 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
47534
|
* @summary Find venues by name or id, across every venue
|
|
@@ -53289,7 +53640,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53289
53640
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53290
53641
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53291
53642
|
* @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
|
|
53643
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53293
53644
|
* @param {*} [options] Override http request option.
|
|
53294
53645
|
* @throws {RequiredError}
|
|
53295
53646
|
*/
|
|
@@ -53328,7 +53679,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53328
53679
|
* 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
53680
|
* @summary List the past runs of a store\'s ready-made report
|
|
53330
53681
|
* @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
|
|
53682
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53332
53683
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53333
53684
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53334
53685
|
* @param {*} [options] Override http request option.
|
|
@@ -53347,7 +53698,7 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53347
53698
|
*/
|
|
53348
53699
|
listStoreSavedReportRuns: (businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53349
53700
|
/**
|
|
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
|
|
53701
|
+
* 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
53702
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53352
53703
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53353
53704
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53357,17 +53708,17 @@ export declare const ReportSchedulesApiAxiosParamCreator: (configuration?: Confi
|
|
|
53357
53708
|
*/
|
|
53358
53709
|
setOrganisationSavedReportSchedule: (groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53359
53710
|
/**
|
|
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
|
|
53711
|
+
* 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
53712
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53362
53713
|
* @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
|
|
53714
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53364
53715
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53365
53716
|
* @param {*} [options] Override http request option.
|
|
53366
53717
|
* @throws {RequiredError}
|
|
53367
53718
|
*/
|
|
53368
53719
|
setStoreReadyMadeReportSchedule: (businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
53369
53720
|
/**
|
|
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
|
|
53721
|
+
* 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
53722
|
* @summary Set when a store\'s saved report is emailed
|
|
53372
53723
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53373
53724
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53413,7 +53764,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53413
53764
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53414
53765
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53415
53766
|
* @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
|
|
53767
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53417
53768
|
* @param {*} [options] Override http request option.
|
|
53418
53769
|
* @throws {RequiredError}
|
|
53419
53770
|
*/
|
|
@@ -53452,7 +53803,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53452
53803
|
* 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
53804
|
* @summary List the past runs of a store\'s ready-made report
|
|
53454
53805
|
* @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
|
|
53806
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53456
53807
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53457
53808
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53458
53809
|
* @param {*} [options] Override http request option.
|
|
@@ -53471,7 +53822,7 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53471
53822
|
*/
|
|
53472
53823
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportRunListDto>>;
|
|
53473
53824
|
/**
|
|
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
|
|
53825
|
+
* 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
53826
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53476
53827
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53477
53828
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53481,17 +53832,17 @@ export declare const ReportSchedulesApiFp: (configuration?: Configuration) => {
|
|
|
53481
53832
|
*/
|
|
53482
53833
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
|
|
53483
53834
|
/**
|
|
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
|
|
53835
|
+
* 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
53836
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53486
53837
|
* @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
|
|
53838
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53488
53839
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53489
53840
|
* @param {*} [options] Override http request option.
|
|
53490
53841
|
* @throws {RequiredError}
|
|
53491
53842
|
*/
|
|
53492
53843
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<ReportScheduleDto>>;
|
|
53493
53844
|
/**
|
|
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
|
|
53845
|
+
* 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
53846
|
* @summary Set when a store\'s saved report is emailed
|
|
53496
53847
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53497
53848
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53537,7 +53888,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53537
53888
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53538
53889
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53539
53890
|
* @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
|
|
53891
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53541
53892
|
* @param {*} [options] Override http request option.
|
|
53542
53893
|
* @throws {RequiredError}
|
|
53543
53894
|
*/
|
|
@@ -53576,7 +53927,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53576
53927
|
* 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
53928
|
* @summary List the past runs of a store\'s ready-made report
|
|
53578
53929
|
* @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
|
|
53930
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53580
53931
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53581
53932
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53582
53933
|
* @param {*} [options] Override http request option.
|
|
@@ -53595,7 +53946,7 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53595
53946
|
*/
|
|
53596
53947
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: any): AxiosPromise<ReportRunListDto>;
|
|
53597
53948
|
/**
|
|
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
|
|
53949
|
+
* 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
53950
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53600
53951
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53601
53952
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53605,17 +53956,17 @@ export declare const ReportSchedulesApiFactory: (configuration?: Configuration,
|
|
|
53605
53956
|
*/
|
|
53606
53957
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
|
|
53607
53958
|
/**
|
|
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
|
|
53959
|
+
* 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
53960
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53610
53961
|
* @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
|
|
53962
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53612
53963
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53613
53964
|
* @param {*} [options] Override http request option.
|
|
53614
53965
|
* @throws {RequiredError}
|
|
53615
53966
|
*/
|
|
53616
53967
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: any): AxiosPromise<ReportScheduleDto>;
|
|
53617
53968
|
/**
|
|
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
|
|
53969
|
+
* 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
53970
|
* @summary Set when a store\'s saved report is emailed
|
|
53620
53971
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53621
53972
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53665,7 +54016,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53665
54016
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53666
54017
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53667
54018
|
* @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
|
|
54019
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53669
54020
|
* @param {*} [options] Override http request option.
|
|
53670
54021
|
* @throws {RequiredError}
|
|
53671
54022
|
* @memberof ReportSchedulesApiInterface
|
|
@@ -53708,7 +54059,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53708
54059
|
* 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
54060
|
* @summary List the past runs of a store\'s ready-made report
|
|
53710
54061
|
* @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
|
|
54062
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53712
54063
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53713
54064
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53714
54065
|
* @param {*} [options] Override http request option.
|
|
@@ -53729,7 +54080,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53729
54080
|
*/
|
|
53730
54081
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): AxiosPromise<ReportRunListDto>;
|
|
53731
54082
|
/**
|
|
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
|
|
54083
|
+
* 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
54084
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53734
54085
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53735
54086
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53740,10 +54091,10 @@ export interface ReportSchedulesApiInterface {
|
|
|
53740
54091
|
*/
|
|
53741
54092
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
53742
54093
|
/**
|
|
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
|
|
54094
|
+
* 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
54095
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53745
54096
|
* @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
|
|
54097
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53747
54098
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53748
54099
|
* @param {*} [options] Override http request option.
|
|
53749
54100
|
* @throws {RequiredError}
|
|
@@ -53751,7 +54102,7 @@ export interface ReportSchedulesApiInterface {
|
|
|
53751
54102
|
*/
|
|
53752
54103
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): AxiosPromise<ReportScheduleDto>;
|
|
53753
54104
|
/**
|
|
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
|
|
54105
|
+
* 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
54106
|
* @summary Set when a store\'s saved report is emailed
|
|
53756
54107
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53757
54108
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53803,7 +54154,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53803
54154
|
* Its schedule: cadence, time and zone, recipients and when it next sends. 404 when none is saved. Managers only.
|
|
53804
54155
|
* @summary Read when a store\'s ready-made report is emailed
|
|
53805
54156
|
* @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
|
|
54157
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53807
54158
|
* @param {*} [options] Override http request option.
|
|
53808
54159
|
* @throws {RequiredError}
|
|
53809
54160
|
* @memberof ReportSchedulesApi
|
|
@@ -53846,7 +54197,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53846
54197
|
* 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
54198
|
* @summary List the past runs of a store\'s ready-made report
|
|
53848
54199
|
* @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
|
|
54200
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53850
54201
|
* @param {number} [limit] At most this many runs, 1 to 100. Absent: 30
|
|
53851
54202
|
* @param {string} [after] The id of the last run of the page before; the list goes on after it
|
|
53852
54203
|
* @param {*} [options] Override http request option.
|
|
@@ -53867,7 +54218,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53867
54218
|
*/
|
|
53868
54219
|
listStoreSavedReportRuns(businessId: number, reportId: string, limit?: number, after?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportRunListDto, any, {}>>;
|
|
53869
54220
|
/**
|
|
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
|
|
54221
|
+
* 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
54222
|
* @summary Set when an organisation\'s saved report is emailed
|
|
53872
54223
|
* @param {string} groupId The organisation\'s id: its group\'s accountId in the licence server
|
|
53873
54224
|
* @param {string} reportId The saved report\'s id
|
|
@@ -53878,10 +54229,10 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53878
54229
|
*/
|
|
53879
54230
|
setOrganisationSavedReportSchedule(groupId: string, reportId: string, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
|
|
53880
54231
|
/**
|
|
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
|
|
54232
|
+
* 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
54233
|
* @summary Set when a store\'s ready-made report is emailed
|
|
53883
54234
|
* @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
|
|
54235
|
+
* @param {ReadyMadeReport} readyMadeReport The ready-made report: sales, or one of dashboard-one\'s Reports: zReport, salesVat, payments, productSales, cashSessions, staff, hours
|
|
53885
54236
|
* @param {SetReportScheduleDto} setReportScheduleDto
|
|
53886
54237
|
* @param {*} [options] Override http request option.
|
|
53887
54238
|
* @throws {RequiredError}
|
|
@@ -53889,7 +54240,7 @@ export declare class ReportSchedulesApi extends BaseAPI implements ReportSchedul
|
|
|
53889
54240
|
*/
|
|
53890
54241
|
setStoreReadyMadeReportSchedule(businessId: number, readyMadeReport: ReadyMadeReport, setReportScheduleDto: SetReportScheduleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<ReportScheduleDto, any, {}>>;
|
|
53891
54242
|
/**
|
|
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
|
|
54243
|
+
* 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
54244
|
* @summary Set when a store\'s saved report is emailed
|
|
53894
54245
|
* @param {number} businessId The store\'s orderingBusinessId
|
|
53895
54246
|
* @param {string} reportId The saved report\'s id
|
|
@@ -55678,6 +56029,25 @@ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiI
|
|
|
55678
56029
|
* @export
|
|
55679
56030
|
*/
|
|
55680
56031
|
export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
56032
|
+
/**
|
|
56033
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56034
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56035
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56036
|
+
* @param {AddShiftDto} addShiftDto
|
|
56037
|
+
* @param {*} [options] Override http request option.
|
|
56038
|
+
* @throws {RequiredError}
|
|
56039
|
+
*/
|
|
56040
|
+
addShiftAtVenue: (businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56041
|
+
/**
|
|
56042
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56043
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56044
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56045
|
+
* @param {string} shiftId The shift\'s id
|
|
56046
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56047
|
+
* @param {*} [options] Override http request option.
|
|
56048
|
+
* @throws {RequiredError}
|
|
56049
|
+
*/
|
|
56050
|
+
changeShiftAtVenue: (businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55681
56051
|
/**
|
|
55682
56052
|
* Opens a shift clocked in now, with a new session, unless the employee already has one open at the venue: that one is answered as it is.
|
|
55683
56053
|
* @summary Clock the employee in at the venue
|
|
@@ -55713,6 +56083,41 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
55713
56083
|
* @throws {RequiredError}
|
|
55714
56084
|
*/
|
|
55715
56085
|
lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56086
|
+
/**
|
|
56087
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56088
|
+
* @summary Remove a shift recorded by mistake
|
|
56089
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56090
|
+
* @param {string} shiftId The shift\'s id
|
|
56091
|
+
* @param {*} [options] Override http request option.
|
|
56092
|
+
* @throws {RequiredError}
|
|
56093
|
+
*/
|
|
56094
|
+
removeShiftAtVenue: (businessId: number, shiftId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56095
|
+
/**
|
|
56096
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56097
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56098
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56099
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56100
|
+
* @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
|
|
56101
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56102
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56103
|
+
* @param {*} [options] Override http request option.
|
|
56104
|
+
* @throws {RequiredError}
|
|
56105
|
+
*/
|
|
56106
|
+
staffHoursAtVenue: (businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56107
|
+
/**
|
|
56108
|
+
* The same report GET hours answers for the days and filters asked, printed by utility-service in English or Finnish: a summary (total hours, people, open shifts), each staff member\'s hours, days worked and open shifts, each day each person worked with its ISO week, and each shift with its clock-in and clock-out in the venue\'s time zone, its hours and its status. The filters asked are printed under the period. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named hours-report-<businessId>-<from>-<to>.pdf or .xlsx. At most 93 days counting both ends. Access as GET hours.
|
|
56109
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56110
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56111
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56112
|
+
* @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
|
|
56113
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56114
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56115
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56116
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56117
|
+
* @param {*} [options] Override http request option.
|
|
56118
|
+
* @throws {RequiredError}
|
|
56119
|
+
*/
|
|
56120
|
+
staffHoursFileAtVenue: (businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55716
56121
|
/**
|
|
55717
56122
|
* 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
56123
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55737,6 +56142,25 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
55737
56142
|
* @export
|
|
55738
56143
|
*/
|
|
55739
56144
|
export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
56145
|
+
/**
|
|
56146
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56147
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56148
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56149
|
+
* @param {AddShiftDto} addShiftDto
|
|
56150
|
+
* @param {*} [options] Override http request option.
|
|
56151
|
+
* @throws {RequiredError}
|
|
56152
|
+
*/
|
|
56153
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>>;
|
|
56154
|
+
/**
|
|
56155
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56156
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56157
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56158
|
+
* @param {string} shiftId The shift\'s id
|
|
56159
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56160
|
+
* @param {*} [options] Override http request option.
|
|
56161
|
+
* @throws {RequiredError}
|
|
56162
|
+
*/
|
|
56163
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>>;
|
|
55740
56164
|
/**
|
|
55741
56165
|
* Opens a shift clocked in now, with a new session, unless the employee already has one open at the venue: that one is answered as it is.
|
|
55742
56166
|
* @summary Clock the employee in at the venue
|
|
@@ -55772,6 +56196,41 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
55772
56196
|
* @throws {RequiredError}
|
|
55773
56197
|
*/
|
|
55774
56198
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56199
|
+
/**
|
|
56200
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56201
|
+
* @summary Remove a shift recorded by mistake
|
|
56202
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56203
|
+
* @param {string} shiftId The shift\'s id
|
|
56204
|
+
* @param {*} [options] Override http request option.
|
|
56205
|
+
* @throws {RequiredError}
|
|
56206
|
+
*/
|
|
56207
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56208
|
+
/**
|
|
56209
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56210
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56211
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56212
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56213
|
+
* @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
|
|
56214
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56215
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56216
|
+
* @param {*} [options] Override http request option.
|
|
56217
|
+
* @throws {RequiredError}
|
|
56218
|
+
*/
|
|
56219
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffHoursResponseDto>>;
|
|
56220
|
+
/**
|
|
56221
|
+
* The same report GET hours answers for the days and filters asked, printed by utility-service in English or Finnish: a summary (total hours, people, open shifts), each staff member\'s hours, days worked and open shifts, each day each person worked with its ISO week, and each shift with its clock-in and clock-out in the venue\'s time zone, its hours and its status. The filters asked are printed under the period. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named hours-report-<businessId>-<from>-<to>.pdf or .xlsx. At most 93 days counting both ends. Access as GET hours.
|
|
56222
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56223
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56224
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56225
|
+
* @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
|
|
56226
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56227
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56228
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56229
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56230
|
+
* @param {*} [options] Override http request option.
|
|
56231
|
+
* @throws {RequiredError}
|
|
56232
|
+
*/
|
|
56233
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<File>>;
|
|
55775
56234
|
/**
|
|
55776
56235
|
* 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
56236
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55796,6 +56255,25 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
55796
56255
|
* @export
|
|
55797
56256
|
*/
|
|
55798
56257
|
export declare const ShiftTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
56258
|
+
/**
|
|
56259
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56260
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56261
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56262
|
+
* @param {AddShiftDto} addShiftDto
|
|
56263
|
+
* @param {*} [options] Override http request option.
|
|
56264
|
+
* @throws {RequiredError}
|
|
56265
|
+
*/
|
|
56266
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: any): AxiosPromise<StaffShiftDto>;
|
|
56267
|
+
/**
|
|
56268
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56269
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56270
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56271
|
+
* @param {string} shiftId The shift\'s id
|
|
56272
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56273
|
+
* @param {*} [options] Override http request option.
|
|
56274
|
+
* @throws {RequiredError}
|
|
56275
|
+
*/
|
|
56276
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: any): AxiosPromise<StaffShiftDto>;
|
|
55799
56277
|
/**
|
|
55800
56278
|
* Opens a shift clocked in now, with a new session, unless the employee already has one open at the venue: that one is answered as it is.
|
|
55801
56279
|
* @summary Clock the employee in at the venue
|
|
@@ -55831,6 +56309,41 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
55831
56309
|
* @throws {RequiredError}
|
|
55832
56310
|
*/
|
|
55833
56311
|
lockTill(businessId: number, options?: any): AxiosPromise<void>;
|
|
56312
|
+
/**
|
|
56313
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56314
|
+
* @summary Remove a shift recorded by mistake
|
|
56315
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56316
|
+
* @param {string} shiftId The shift\'s id
|
|
56317
|
+
* @param {*} [options] Override http request option.
|
|
56318
|
+
* @throws {RequiredError}
|
|
56319
|
+
*/
|
|
56320
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: any): AxiosPromise<void>;
|
|
56321
|
+
/**
|
|
56322
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56323
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56324
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56325
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56326
|
+
* @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
|
|
56327
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56328
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56329
|
+
* @param {*} [options] Override http request option.
|
|
56330
|
+
* @throws {RequiredError}
|
|
56331
|
+
*/
|
|
56332
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: any): AxiosPromise<StaffHoursResponseDto>;
|
|
56333
|
+
/**
|
|
56334
|
+
* The same report GET hours answers for the days and filters asked, printed by utility-service in English or Finnish: a summary (total hours, people, open shifts), each staff member\'s hours, days worked and open shifts, each day each person worked with its ISO week, and each shift with its clock-in and clock-out in the venue\'s time zone, its hours and its status. The filters asked are printed under the period. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named hours-report-<businessId>-<from>-<to>.pdf or .xlsx. At most 93 days counting both ends. Access as GET hours.
|
|
56335
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56336
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56337
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56338
|
+
* @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
|
|
56339
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56340
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56341
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56342
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56343
|
+
* @param {*} [options] Override http request option.
|
|
56344
|
+
* @throws {RequiredError}
|
|
56345
|
+
*/
|
|
56346
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: any): AxiosPromise<File>;
|
|
55834
56347
|
/**
|
|
55835
56348
|
* 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
56349
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55856,6 +56369,27 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
55856
56369
|
* @interface ShiftTrackingApi
|
|
55857
56370
|
*/
|
|
55858
56371
|
export interface ShiftTrackingApiInterface {
|
|
56372
|
+
/**
|
|
56373
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56374
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56375
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56376
|
+
* @param {AddShiftDto} addShiftDto
|
|
56377
|
+
* @param {*} [options] Override http request option.
|
|
56378
|
+
* @throws {RequiredError}
|
|
56379
|
+
* @memberof ShiftTrackingApiInterface
|
|
56380
|
+
*/
|
|
56381
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
56382
|
+
/**
|
|
56383
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56384
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56385
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56386
|
+
* @param {string} shiftId The shift\'s id
|
|
56387
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56388
|
+
* @param {*} [options] Override http request option.
|
|
56389
|
+
* @throws {RequiredError}
|
|
56390
|
+
* @memberof ShiftTrackingApiInterface
|
|
56391
|
+
*/
|
|
56392
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
55859
56393
|
/**
|
|
55860
56394
|
* Opens a shift clocked in now, with a new session, unless the employee already has one open at the venue: that one is answered as it is.
|
|
55861
56395
|
* @summary Clock the employee in at the venue
|
|
@@ -55895,6 +56429,44 @@ export interface ShiftTrackingApiInterface {
|
|
|
55895
56429
|
* @memberof ShiftTrackingApiInterface
|
|
55896
56430
|
*/
|
|
55897
56431
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56432
|
+
/**
|
|
56433
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56434
|
+
* @summary Remove a shift recorded by mistake
|
|
56435
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56436
|
+
* @param {string} shiftId The shift\'s id
|
|
56437
|
+
* @param {*} [options] Override http request option.
|
|
56438
|
+
* @throws {RequiredError}
|
|
56439
|
+
* @memberof ShiftTrackingApiInterface
|
|
56440
|
+
*/
|
|
56441
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56442
|
+
/**
|
|
56443
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56444
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56445
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56446
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56447
|
+
* @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
|
|
56448
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56449
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56450
|
+
* @param {*} [options] Override http request option.
|
|
56451
|
+
* @throws {RequiredError}
|
|
56452
|
+
* @memberof ShiftTrackingApiInterface
|
|
56453
|
+
*/
|
|
56454
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): AxiosPromise<StaffHoursResponseDto>;
|
|
56455
|
+
/**
|
|
56456
|
+
* The same report GET hours answers for the days and filters asked, printed by utility-service in English or Finnish: a summary (total hours, people, open shifts), each staff member\'s hours, days worked and open shifts, each day each person worked with its ISO week, and each shift with its clock-in and clock-out in the venue\'s time zone, its hours and its status. The filters asked are printed under the period. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named hours-report-<businessId>-<from>-<to>.pdf or .xlsx. At most 93 days counting both ends. Access as GET hours.
|
|
56457
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56458
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56459
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56460
|
+
* @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
|
|
56461
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56462
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56463
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56464
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56465
|
+
* @param {*} [options] Override http request option.
|
|
56466
|
+
* @throws {RequiredError}
|
|
56467
|
+
* @memberof ShiftTrackingApiInterface
|
|
56468
|
+
*/
|
|
56469
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
55898
56470
|
/**
|
|
55899
56471
|
* 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
56472
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55923,6 +56495,27 @@ export interface ShiftTrackingApiInterface {
|
|
|
55923
56495
|
* @extends {BaseAPI}
|
|
55924
56496
|
*/
|
|
55925
56497
|
export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterface {
|
|
56498
|
+
/**
|
|
56499
|
+
* A shift added in the back office: its clock-in, and its clock-out unless the staff member is still working. It counts in the hours report like a shift clocked on the till. It is refused while it would be the staff member\'s second open shift at the venue (SHIFT_ALREADY_OPEN), or overlap another of their shifts there (SHIFTS_OVERLAP); an open shift runs on with no end, and shifts that only touch do not overlap. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56500
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56501
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56502
|
+
* @param {AddShiftDto} addShiftDto
|
|
56503
|
+
* @param {*} [options] Override http request option.
|
|
56504
|
+
* @throws {RequiredError}
|
|
56505
|
+
* @memberof ShiftTrackingApi
|
|
56506
|
+
*/
|
|
56507
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffShiftDto, any, {}>>;
|
|
56508
|
+
/**
|
|
56509
|
+
* Sets the times sent and keeps the others; a clock-out is never taken away, so a shift closed here stays closed, and it forgets the till session it was clocked in on, as a clock-out on the till does. The change is saved only while the shift is as it was read, so a clock-out the till writes at the same moment is never overwritten unseen, and never so that the shift overlaps another of the staff member\'s shifts at the venue (SHIFTS_OVERLAP). Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56510
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56511
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56512
|
+
* @param {string} shiftId The shift\'s id
|
|
56513
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56514
|
+
* @param {*} [options] Override http request option.
|
|
56515
|
+
* @throws {RequiredError}
|
|
56516
|
+
* @memberof ShiftTrackingApi
|
|
56517
|
+
*/
|
|
56518
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffShiftDto, any, {}>>;
|
|
55926
56519
|
/**
|
|
55927
56520
|
* Opens a shift clocked in now, with a new session, unless the employee already has one open at the venue: that one is answered as it is.
|
|
55928
56521
|
* @summary Clock the employee in at the venue
|
|
@@ -55962,6 +56555,44 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
55962
56555
|
* @memberof ShiftTrackingApi
|
|
55963
56556
|
*/
|
|
55964
56557
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56558
|
+
/**
|
|
56559
|
+
* The shift no longer counts in the hours report. A shift still open is not removed (SHIFT_STILL_OPEN): its clock-out is set first, so the till\'s next clock-out is not recorded as a shift with no clock-in. Access: the staff write (org:staff:write) at the venue, refused without it; a till\'s own ticket is always refused, so the person on the till never changes their own hours.
|
|
56560
|
+
* @summary Remove a shift recorded by mistake
|
|
56561
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56562
|
+
* @param {string} shiftId The shift\'s id
|
|
56563
|
+
* @param {*} [options] Override http request option.
|
|
56564
|
+
* @throws {RequiredError}
|
|
56565
|
+
* @memberof ShiftTrackingApi
|
|
56566
|
+
*/
|
|
56567
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56568
|
+
/**
|
|
56569
|
+
* The shifts staff clocked on the POS (clock-in on unlock, clock-out on lock), for the days from to to in the venue\'s time zone: per staff member and per day the shift began, with each shift\'s times and worked minutes, and totals. A shift still open, with only a clock-out, or clocked out before it clocked in, counts 0 minutes; openShifts counts the open ones, so a forgotten clock-out shows. Each day\'s shifts are oldest first, each with its id and status (open or closed). employeeIds keeps only those staff members\' shifts, and status only the open or the closed ones; every total counts the shifts kept. At most 93 days counting both ends (to at most 92 days after from). Only reads. Access: a person signed in for Ari is refused without the reports read (org:reports:read) at the venue today; for every other caller that permission, and on a till ticket the Page::Reports key of the person on the till, are only logged (Access would refuse) until the shifts module refuses all (R30).
|
|
56570
|
+
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56571
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56572
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56573
|
+
* @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
|
|
56574
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56575
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56576
|
+
* @param {*} [options] Override http request option.
|
|
56577
|
+
* @throws {RequiredError}
|
|
56578
|
+
* @memberof ShiftTrackingApi
|
|
56579
|
+
*/
|
|
56580
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffHoursResponseDto, any, {}>>;
|
|
56581
|
+
/**
|
|
56582
|
+
* The same report GET hours answers for the days and filters asked, printed by utility-service in English or Finnish: a summary (total hours, people, open shifts), each staff member\'s hours, days worked and open shifts, each day each person worked with its ISO week, and each shift with its clock-in and clock-out in the venue\'s time zone, its hours and its status. The filters asked are printed under the period. Answers application/pdf (format pdf, the default) or application/vnd.openxmlformats-officedocument.spreadsheetml.sheet (format xlsx) with Content-Disposition attachment, named hours-report-<businessId>-<from>-<to>.pdf or .xlsx. At most 93 days counting both ends. Access as GET hours.
|
|
56583
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56584
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56585
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56586
|
+
* @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
|
|
56587
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56588
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56589
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56590
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56591
|
+
* @param {*} [options] Override http request option.
|
|
56592
|
+
* @throws {RequiredError}
|
|
56593
|
+
* @memberof ShiftTrackingApi
|
|
56594
|
+
*/
|
|
56595
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<File, any, {}>>;
|
|
55965
56596
|
/**
|
|
55966
56597
|
* 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
56598
|
* @summary Unlock the till for an employee (no PIN; old builds)
|