@munchi_oy/core 2.8.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 +368 -25
- 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 +587 -28
- 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
|
|
@@ -29725,6 +29769,16 @@ export interface ShiftEmployeeDto {
|
|
|
29725
29769
|
*/
|
|
29726
29770
|
'photoUrl': string | null;
|
|
29727
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];
|
|
29728
29782
|
/**
|
|
29729
29783
|
*
|
|
29730
29784
|
* @export
|
|
@@ -30150,6 +30204,12 @@ export interface StaffHoursResponseDto {
|
|
|
30150
30204
|
* @interface StaffHoursShiftDto
|
|
30151
30205
|
*/
|
|
30152
30206
|
export interface StaffHoursShiftDto {
|
|
30207
|
+
/**
|
|
30208
|
+
* The shift\'s id
|
|
30209
|
+
* @type {string}
|
|
30210
|
+
* @memberof StaffHoursShiftDto
|
|
30211
|
+
*/
|
|
30212
|
+
'shiftId': string;
|
|
30153
30213
|
/**
|
|
30154
30214
|
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
30155
30215
|
* @type {string}
|
|
@@ -30168,6 +30228,61 @@ export interface StaffHoursShiftDto {
|
|
|
30168
30228
|
* @memberof StaffHoursShiftDto
|
|
30169
30229
|
*/
|
|
30170
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;
|
|
30171
30286
|
}
|
|
30172
30287
|
/**
|
|
30173
30288
|
*
|
|
@@ -45056,7 +45171,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
45056
45171
|
*/
|
|
45057
45172
|
export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
45058
45173
|
/**
|
|
45059
|
-
* 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.
|
|
45060
45175
|
* @summary Create a new invoice company
|
|
45061
45176
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45062
45177
|
* @param {*} [options] Override http request option.
|
|
@@ -45064,7 +45179,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
45064
45179
|
*/
|
|
45065
45180
|
createInvoiceCompany: (createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45066
45181
|
/**
|
|
45067
|
-
* 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.
|
|
45068
45183
|
* @summary Delete an invoice company
|
|
45069
45184
|
* @param {string} id The company\'s id
|
|
45070
45185
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45099,7 +45214,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
45099
45214
|
*/
|
|
45100
45215
|
searchInvoiceCompanies: (businessId: number, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45101
45216
|
/**
|
|
45102
|
-
* 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.
|
|
45103
45218
|
* @summary Update an invoice company
|
|
45104
45219
|
* @param {string} id The company\'s id
|
|
45105
45220
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45115,7 +45230,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
45115
45230
|
*/
|
|
45116
45231
|
export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
45117
45232
|
/**
|
|
45118
|
-
* 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.
|
|
45119
45234
|
* @summary Create a new invoice company
|
|
45120
45235
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45121
45236
|
* @param {*} [options] Override http request option.
|
|
@@ -45123,7 +45238,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
45123
45238
|
*/
|
|
45124
45239
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceCompanyResponseDto>>;
|
|
45125
45240
|
/**
|
|
45126
|
-
* 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.
|
|
45127
45242
|
* @summary Delete an invoice company
|
|
45128
45243
|
* @param {string} id The company\'s id
|
|
45129
45244
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45158,7 +45273,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
45158
45273
|
*/
|
|
45159
45274
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceCompanyResponseDto>>>;
|
|
45160
45275
|
/**
|
|
45161
|
-
* 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.
|
|
45162
45277
|
* @summary Update an invoice company
|
|
45163
45278
|
* @param {string} id The company\'s id
|
|
45164
45279
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45174,7 +45289,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
45174
45289
|
*/
|
|
45175
45290
|
export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
45176
45291
|
/**
|
|
45177
|
-
* 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.
|
|
45178
45293
|
* @summary Create a new invoice company
|
|
45179
45294
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45180
45295
|
* @param {*} [options] Override http request option.
|
|
@@ -45182,7 +45297,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45182
45297
|
*/
|
|
45183
45298
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: any): AxiosPromise<InvoiceCompanyResponseDto>;
|
|
45184
45299
|
/**
|
|
45185
|
-
* 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.
|
|
45186
45301
|
* @summary Delete an invoice company
|
|
45187
45302
|
* @param {string} id The company\'s id
|
|
45188
45303
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45217,7 +45332,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45217
45332
|
*/
|
|
45218
45333
|
searchInvoiceCompanies(businessId: number, search?: string, options?: any): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
45219
45334
|
/**
|
|
45220
|
-
* 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.
|
|
45221
45336
|
* @summary Update an invoice company
|
|
45222
45337
|
* @param {string} id The company\'s id
|
|
45223
45338
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45234,7 +45349,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45234
45349
|
*/
|
|
45235
45350
|
export interface InvoiceCompaniesApiInterface {
|
|
45236
45351
|
/**
|
|
45237
|
-
* 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.
|
|
45238
45353
|
* @summary Create a new invoice company
|
|
45239
45354
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45240
45355
|
* @param {*} [options] Override http request option.
|
|
@@ -45243,7 +45358,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45243
45358
|
*/
|
|
45244
45359
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): AxiosPromise<InvoiceCompanyResponseDto>;
|
|
45245
45360
|
/**
|
|
45246
|
-
* 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.
|
|
45247
45362
|
* @summary Delete an invoice company
|
|
45248
45363
|
* @param {string} id The company\'s id
|
|
45249
45364
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45282,7 +45397,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45282
45397
|
*/
|
|
45283
45398
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
45284
45399
|
/**
|
|
45285
|
-
* 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.
|
|
45286
45401
|
* @summary Update an invoice company
|
|
45287
45402
|
* @param {string} id The company\'s id
|
|
45288
45403
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45301,7 +45416,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45301
45416
|
*/
|
|
45302
45417
|
export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiInterface {
|
|
45303
45418
|
/**
|
|
45304
|
-
* 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.
|
|
45305
45420
|
* @summary Create a new invoice company
|
|
45306
45421
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45307
45422
|
* @param {*} [options] Override http request option.
|
|
@@ -45310,7 +45425,7 @@ export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompa
|
|
|
45310
45425
|
*/
|
|
45311
45426
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceCompanyResponseDto, any, {}>>;
|
|
45312
45427
|
/**
|
|
45313
|
-
* 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.
|
|
45314
45429
|
* @summary Delete an invoice company
|
|
45315
45430
|
* @param {string} id The company\'s id
|
|
45316
45431
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45349,7 +45464,7 @@ export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompa
|
|
|
45349
45464
|
*/
|
|
45350
45465
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceCompanyResponseDto[], any, {}>>;
|
|
45351
45466
|
/**
|
|
45352
|
-
* 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.
|
|
45353
45468
|
* @summary Update an invoice company
|
|
45354
45469
|
* @param {string} id The company\'s id
|
|
45355
45470
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -55914,6 +56029,25 @@ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiI
|
|
|
55914
56029
|
* @export
|
|
55915
56030
|
*/
|
|
55916
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>;
|
|
55917
56051
|
/**
|
|
55918
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.
|
|
55919
56053
|
* @summary Clock the employee in at the venue
|
|
@@ -55950,15 +56084,40 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
55950
56084
|
*/
|
|
55951
56085
|
lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55952
56086
|
/**
|
|
55953
|
-
* The
|
|
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).
|
|
55954
56097
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
55955
56098
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55956
56099
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
55957
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
|
|
55958
56117
|
* @param {*} [options] Override http request option.
|
|
55959
56118
|
* @throws {RequiredError}
|
|
55960
56119
|
*/
|
|
55961
|
-
|
|
56120
|
+
staffHoursFileAtVenue: (businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55962
56121
|
/**
|
|
55963
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>).
|
|
55964
56123
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55983,6 +56142,25 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
55983
56142
|
* @export
|
|
55984
56143
|
*/
|
|
55985
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>>;
|
|
55986
56164
|
/**
|
|
55987
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.
|
|
55988
56166
|
* @summary Clock the employee in at the venue
|
|
@@ -56019,15 +56197,40 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56019
56197
|
*/
|
|
56020
56198
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56021
56199
|
/**
|
|
56022
|
-
* The
|
|
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).
|
|
56023
56210
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56024
56211
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56025
56212
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56026
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
|
|
56027
56230
|
* @param {*} [options] Override http request option.
|
|
56028
56231
|
* @throws {RequiredError}
|
|
56029
56232
|
*/
|
|
56030
|
-
|
|
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>>;
|
|
56031
56234
|
/**
|
|
56032
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>).
|
|
56033
56236
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -56052,6 +56255,25 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56052
56255
|
* @export
|
|
56053
56256
|
*/
|
|
56054
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>;
|
|
56055
56277
|
/**
|
|
56056
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.
|
|
56057
56279
|
* @summary Clock the employee in at the venue
|
|
@@ -56088,15 +56310,40 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56088
56310
|
*/
|
|
56089
56311
|
lockTill(businessId: number, options?: any): AxiosPromise<void>;
|
|
56090
56312
|
/**
|
|
56091
|
-
* The
|
|
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).
|
|
56092
56323
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56093
56324
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56094
56325
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56095
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
|
|
56096
56329
|
* @param {*} [options] Override http request option.
|
|
56097
56330
|
* @throws {RequiredError}
|
|
56098
56331
|
*/
|
|
56099
|
-
staffHoursAtVenue(businessId: number, from: string, to: string, options?: any): AxiosPromise<StaffHoursResponseDto>;
|
|
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>;
|
|
56100
56347
|
/**
|
|
56101
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>).
|
|
56102
56349
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -56122,6 +56369,27 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56122
56369
|
* @interface ShiftTrackingApi
|
|
56123
56370
|
*/
|
|
56124
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>;
|
|
56125
56393
|
/**
|
|
56126
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.
|
|
56127
56395
|
* @summary Clock the employee in at the venue
|
|
@@ -56162,16 +56430,43 @@ export interface ShiftTrackingApiInterface {
|
|
|
56162
56430
|
*/
|
|
56163
56431
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56164
56432
|
/**
|
|
56165
|
-
* The
|
|
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).
|
|
56166
56444
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56167
56445
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56168
56446
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56169
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
|
|
56170
56465
|
* @param {*} [options] Override http request option.
|
|
56171
56466
|
* @throws {RequiredError}
|
|
56172
56467
|
* @memberof ShiftTrackingApiInterface
|
|
56173
56468
|
*/
|
|
56174
|
-
|
|
56469
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
56175
56470
|
/**
|
|
56176
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>).
|
|
56177
56472
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -56200,6 +56495,27 @@ export interface ShiftTrackingApiInterface {
|
|
|
56200
56495
|
* @extends {BaseAPI}
|
|
56201
56496
|
*/
|
|
56202
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, {}>>;
|
|
56203
56519
|
/**
|
|
56204
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.
|
|
56205
56521
|
* @summary Clock the employee in at the venue
|
|
@@ -56240,16 +56556,43 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56240
56556
|
*/
|
|
56241
56557
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56242
56558
|
/**
|
|
56243
|
-
* The
|
|
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).
|
|
56244
56570
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56245
56571
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56246
56572
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56247
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
|
|
56248
56591
|
* @param {*} [options] Override http request option.
|
|
56249
56592
|
* @throws {RequiredError}
|
|
56250
56593
|
* @memberof ShiftTrackingApi
|
|
56251
56594
|
*/
|
|
56252
|
-
|
|
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, {}>>;
|
|
56253
56596
|
/**
|
|
56254
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>).
|
|
56255
56598
|
* @summary Unlock the till for an employee (no PIN; old builds)
|