@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/generated/api.ts
CHANGED
|
@@ -216,6 +216,31 @@ export interface AddEmployeeRoleDto {
|
|
|
216
216
|
*/
|
|
217
217
|
'permissionKeys': Array<PosPermission>;
|
|
218
218
|
}
|
|
219
|
+
/**
|
|
220
|
+
*
|
|
221
|
+
* @export
|
|
222
|
+
* @interface AddShiftDto
|
|
223
|
+
*/
|
|
224
|
+
export interface AddShiftDto {
|
|
225
|
+
/**
|
|
226
|
+
* The staff member the shift is of, by employee id; they must work at the venue
|
|
227
|
+
* @type {string}
|
|
228
|
+
* @memberof AddShiftDto
|
|
229
|
+
*/
|
|
230
|
+
'employeeId': string;
|
|
231
|
+
/**
|
|
232
|
+
* When the staff member clocked in, an ISO 8601 instant
|
|
233
|
+
* @type {string}
|
|
234
|
+
* @memberof AddShiftDto
|
|
235
|
+
*/
|
|
236
|
+
'clockInTime': string;
|
|
237
|
+
/**
|
|
238
|
+
* When the staff member clocked out, an ISO 8601 instant at or after the clock-in. Absent or null: the shift is still open
|
|
239
|
+
* @type {string}
|
|
240
|
+
* @memberof AddShiftDto
|
|
241
|
+
*/
|
|
242
|
+
'clockOutTime'?: string | null;
|
|
243
|
+
}
|
|
219
244
|
/**
|
|
220
245
|
*
|
|
221
246
|
* @export
|
|
@@ -2846,6 +2871,25 @@ export interface ChangeResQOfferDto {
|
|
|
2846
2871
|
*/
|
|
2847
2872
|
'fetchEnd'?: string;
|
|
2848
2873
|
}
|
|
2874
|
+
/**
|
|
2875
|
+
*
|
|
2876
|
+
* @export
|
|
2877
|
+
* @interface ChangeShiftDto
|
|
2878
|
+
*/
|
|
2879
|
+
export interface ChangeShiftDto {
|
|
2880
|
+
/**
|
|
2881
|
+
* The new clock-in, an ISO 8601 instant; null is refused. Absent: unchanged
|
|
2882
|
+
* @type {string}
|
|
2883
|
+
* @memberof ChangeShiftDto
|
|
2884
|
+
*/
|
|
2885
|
+
'clockInTime'?: string;
|
|
2886
|
+
/**
|
|
2887
|
+
* The new clock-out, an ISO 8601 instant at or after the clock-in (a forgotten clock-out set). Absent: unchanged
|
|
2888
|
+
* @type {string}
|
|
2889
|
+
* @memberof ChangeShiftDto
|
|
2890
|
+
*/
|
|
2891
|
+
'clockOutTime'?: string;
|
|
2892
|
+
}
|
|
2849
2893
|
/**
|
|
2850
2894
|
*
|
|
2851
2895
|
* @export
|
|
@@ -30631,6 +30675,20 @@ export interface ShiftEmployeeDto {
|
|
|
30631
30675
|
}
|
|
30632
30676
|
|
|
30633
30677
|
|
|
30678
|
+
/**
|
|
30679
|
+
*
|
|
30680
|
+
* @export
|
|
30681
|
+
* @enum {string}
|
|
30682
|
+
*/
|
|
30683
|
+
|
|
30684
|
+
export const ShiftStatus = {
|
|
30685
|
+
Open: 'open',
|
|
30686
|
+
Closed: 'closed'
|
|
30687
|
+
} as const;
|
|
30688
|
+
|
|
30689
|
+
export type ShiftStatus = typeof ShiftStatus[keyof typeof ShiftStatus];
|
|
30690
|
+
|
|
30691
|
+
|
|
30634
30692
|
/**
|
|
30635
30693
|
*
|
|
30636
30694
|
* @export
|
|
@@ -31084,6 +31142,12 @@ export interface StaffHoursResponseDto {
|
|
|
31084
31142
|
* @interface StaffHoursShiftDto
|
|
31085
31143
|
*/
|
|
31086
31144
|
export interface StaffHoursShiftDto {
|
|
31145
|
+
/**
|
|
31146
|
+
* The shift\'s id
|
|
31147
|
+
* @type {string}
|
|
31148
|
+
* @memberof StaffHoursShiftDto
|
|
31149
|
+
*/
|
|
31150
|
+
'shiftId': string;
|
|
31087
31151
|
/**
|
|
31088
31152
|
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
31089
31153
|
* @type {string}
|
|
@@ -31102,7 +31166,66 @@ export interface StaffHoursShiftDto {
|
|
|
31102
31166
|
* @memberof StaffHoursShiftDto
|
|
31103
31167
|
*/
|
|
31104
31168
|
'minutes': number;
|
|
31169
|
+
/**
|
|
31170
|
+
*
|
|
31171
|
+
* @type {ShiftStatus}
|
|
31172
|
+
* @memberof StaffHoursShiftDto
|
|
31173
|
+
*/
|
|
31174
|
+
'status': ShiftStatus;
|
|
31105
31175
|
}
|
|
31176
|
+
|
|
31177
|
+
|
|
31178
|
+
/**
|
|
31179
|
+
*
|
|
31180
|
+
* @export
|
|
31181
|
+
* @interface StaffShiftDto
|
|
31182
|
+
*/
|
|
31183
|
+
export interface StaffShiftDto {
|
|
31184
|
+
/**
|
|
31185
|
+
* The shift\'s id
|
|
31186
|
+
* @type {string}
|
|
31187
|
+
* @memberof StaffShiftDto
|
|
31188
|
+
*/
|
|
31189
|
+
'shiftId': string;
|
|
31190
|
+
/**
|
|
31191
|
+
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
31192
|
+
* @type {string}
|
|
31193
|
+
* @memberof StaffShiftDto
|
|
31194
|
+
*/
|
|
31195
|
+
'clockInTime': string | null;
|
|
31196
|
+
/**
|
|
31197
|
+
* When the staff member clocked out; null while the shift is still open
|
|
31198
|
+
* @type {string}
|
|
31199
|
+
* @memberof StaffShiftDto
|
|
31200
|
+
*/
|
|
31201
|
+
'clockOutTime': string | null;
|
|
31202
|
+
/**
|
|
31203
|
+
* 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
|
|
31204
|
+
* @type {number}
|
|
31205
|
+
* @memberof StaffShiftDto
|
|
31206
|
+
*/
|
|
31207
|
+
'minutes': number;
|
|
31208
|
+
/**
|
|
31209
|
+
*
|
|
31210
|
+
* @type {ShiftStatus}
|
|
31211
|
+
* @memberof StaffShiftDto
|
|
31212
|
+
*/
|
|
31213
|
+
'status': ShiftStatus;
|
|
31214
|
+
/**
|
|
31215
|
+
* The staff member\'s id
|
|
31216
|
+
* @type {string}
|
|
31217
|
+
* @memberof StaffShiftDto
|
|
31218
|
+
*/
|
|
31219
|
+
'employeeId': string;
|
|
31220
|
+
/**
|
|
31221
|
+
* The staff member\'s name
|
|
31222
|
+
* @type {string}
|
|
31223
|
+
* @memberof StaffShiftDto
|
|
31224
|
+
*/
|
|
31225
|
+
'name': string;
|
|
31226
|
+
}
|
|
31227
|
+
|
|
31228
|
+
|
|
31106
31229
|
/**
|
|
31107
31230
|
*
|
|
31108
31231
|
* @export
|
|
@@ -50766,7 +50889,7 @@ export class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterface {
|
|
|
50766
50889
|
export const InvoiceCompaniesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
50767
50890
|
return {
|
|
50768
50891
|
/**
|
|
50769
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
50892
|
+
* 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.
|
|
50770
50893
|
* @summary Create a new invoice company
|
|
50771
50894
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
50772
50895
|
* @param {*} [options] Override http request option.
|
|
@@ -50806,7 +50929,7 @@ export const InvoiceCompaniesApiAxiosParamCreator = function (configuration?: Co
|
|
|
50806
50929
|
};
|
|
50807
50930
|
},
|
|
50808
50931
|
/**
|
|
50809
|
-
* Deletes one of the venue\'s companies, for
|
|
50932
|
+
* 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.
|
|
50810
50933
|
* @summary Delete an invoice company
|
|
50811
50934
|
* @param {string} id The company\'s id
|
|
50812
50935
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -50983,7 +51106,7 @@ export const InvoiceCompaniesApiAxiosParamCreator = function (configuration?: Co
|
|
|
50983
51106
|
};
|
|
50984
51107
|
},
|
|
50985
51108
|
/**
|
|
50986
|
-
* Changes the fields sent and keeps the others, for
|
|
51109
|
+
* 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.
|
|
50987
51110
|
* @summary Update an invoice company
|
|
50988
51111
|
* @param {string} id The company\'s id
|
|
50989
51112
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51044,7 +51167,7 @@ export const InvoiceCompaniesApiFp = function(configuration?: Configuration) {
|
|
|
51044
51167
|
const localVarAxiosParamCreator = InvoiceCompaniesApiAxiosParamCreator(configuration)
|
|
51045
51168
|
return {
|
|
51046
51169
|
/**
|
|
51047
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
51170
|
+
* 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.
|
|
51048
51171
|
* @summary Create a new invoice company
|
|
51049
51172
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
51050
51173
|
* @param {*} [options] Override http request option.
|
|
@@ -51055,7 +51178,7 @@ export const InvoiceCompaniesApiFp = function(configuration?: Configuration) {
|
|
|
51055
51178
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51056
51179
|
},
|
|
51057
51180
|
/**
|
|
51058
|
-
* Deletes one of the venue\'s companies, for
|
|
51181
|
+
* 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.
|
|
51059
51182
|
* @summary Delete an invoice company
|
|
51060
51183
|
* @param {string} id The company\'s id
|
|
51061
51184
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51102,7 +51225,7 @@ export const InvoiceCompaniesApiFp = function(configuration?: Configuration) {
|
|
|
51102
51225
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
51103
51226
|
},
|
|
51104
51227
|
/**
|
|
51105
|
-
* Changes the fields sent and keeps the others, for
|
|
51228
|
+
* 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.
|
|
51106
51229
|
* @summary Update an invoice company
|
|
51107
51230
|
* @param {string} id The company\'s id
|
|
51108
51231
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51125,7 +51248,7 @@ export const InvoiceCompaniesApiFactory = function (configuration?: Configuratio
|
|
|
51125
51248
|
const localVarFp = InvoiceCompaniesApiFp(configuration)
|
|
51126
51249
|
return {
|
|
51127
51250
|
/**
|
|
51128
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
51251
|
+
* 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.
|
|
51129
51252
|
* @summary Create a new invoice company
|
|
51130
51253
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
51131
51254
|
* @param {*} [options] Override http request option.
|
|
@@ -51135,7 +51258,7 @@ export const InvoiceCompaniesApiFactory = function (configuration?: Configuratio
|
|
|
51135
51258
|
return localVarFp.createInvoiceCompany(createInvoiceCompanyDto, options).then((request) => request(axios, basePath));
|
|
51136
51259
|
},
|
|
51137
51260
|
/**
|
|
51138
|
-
* Deletes one of the venue\'s companies, for
|
|
51261
|
+
* 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.
|
|
51139
51262
|
* @summary Delete an invoice company
|
|
51140
51263
|
* @param {string} id The company\'s id
|
|
51141
51264
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51178,7 +51301,7 @@ export const InvoiceCompaniesApiFactory = function (configuration?: Configuratio
|
|
|
51178
51301
|
return localVarFp.searchInvoiceCompanies(businessId, search, options).then((request) => request(axios, basePath));
|
|
51179
51302
|
},
|
|
51180
51303
|
/**
|
|
51181
|
-
* Changes the fields sent and keeps the others, for
|
|
51304
|
+
* 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.
|
|
51182
51305
|
* @summary Update an invoice company
|
|
51183
51306
|
* @param {string} id The company\'s id
|
|
51184
51307
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51199,7 +51322,7 @@ export const InvoiceCompaniesApiFactory = function (configuration?: Configuratio
|
|
|
51199
51322
|
*/
|
|
51200
51323
|
export interface InvoiceCompaniesApiInterface {
|
|
51201
51324
|
/**
|
|
51202
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
51325
|
+
* 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.
|
|
51203
51326
|
* @summary Create a new invoice company
|
|
51204
51327
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
51205
51328
|
* @param {*} [options] Override http request option.
|
|
@@ -51209,7 +51332,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
51209
51332
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): AxiosPromise<InvoiceCompanyResponseDto>;
|
|
51210
51333
|
|
|
51211
51334
|
/**
|
|
51212
|
-
* Deletes one of the venue\'s companies, for
|
|
51335
|
+
* 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.
|
|
51213
51336
|
* @summary Delete an invoice company
|
|
51214
51337
|
* @param {string} id The company\'s id
|
|
51215
51338
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51252,7 +51375,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
51252
51375
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
51253
51376
|
|
|
51254
51377
|
/**
|
|
51255
|
-
* Changes the fields sent and keeps the others, for
|
|
51378
|
+
* 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.
|
|
51256
51379
|
* @summary Update an invoice company
|
|
51257
51380
|
* @param {string} id The company\'s id
|
|
51258
51381
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51273,7 +51396,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
51273
51396
|
*/
|
|
51274
51397
|
export class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiInterface {
|
|
51275
51398
|
/**
|
|
51276
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
51399
|
+
* 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.
|
|
51277
51400
|
* @summary Create a new invoice company
|
|
51278
51401
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
51279
51402
|
* @param {*} [options] Override http request option.
|
|
@@ -51285,7 +51408,7 @@ export class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiI
|
|
|
51285
51408
|
}
|
|
51286
51409
|
|
|
51287
51410
|
/**
|
|
51288
|
-
* Deletes one of the venue\'s companies, for
|
|
51411
|
+
* 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.
|
|
51289
51412
|
* @summary Delete an invoice company
|
|
51290
51413
|
* @param {string} id The company\'s id
|
|
51291
51414
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -51336,7 +51459,7 @@ export class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiI
|
|
|
51336
51459
|
}
|
|
51337
51460
|
|
|
51338
51461
|
/**
|
|
51339
|
-
* Changes the fields sent and keeps the others, for
|
|
51462
|
+
* 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.
|
|
51340
51463
|
* @summary Update an invoice company
|
|
51341
51464
|
* @param {string} id The company\'s id
|
|
51342
51465
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -70858,6 +70981,98 @@ export class SavedReportsApi extends BaseAPI implements SavedReportsApiInterface
|
|
|
70858
70981
|
*/
|
|
70859
70982
|
export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
70860
70983
|
return {
|
|
70984
|
+
/**
|
|
70985
|
+
* 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.
|
|
70986
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
70987
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
70988
|
+
* @param {AddShiftDto} addShiftDto
|
|
70989
|
+
* @param {*} [options] Override http request option.
|
|
70990
|
+
* @throws {RequiredError}
|
|
70991
|
+
*/
|
|
70992
|
+
addShiftAtVenue: async (businessId: number, addShiftDto: AddShiftDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
70993
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
70994
|
+
assertParamExists('addShiftAtVenue', 'businessId', businessId)
|
|
70995
|
+
// verify required parameter 'addShiftDto' is not null or undefined
|
|
70996
|
+
assertParamExists('addShiftAtVenue', 'addShiftDto', addShiftDto)
|
|
70997
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts`
|
|
70998
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
70999
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71000
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71001
|
+
let baseOptions;
|
|
71002
|
+
if (configuration) {
|
|
71003
|
+
baseOptions = configuration.baseOptions;
|
|
71004
|
+
}
|
|
71005
|
+
|
|
71006
|
+
const localVarRequestOptions = { method: 'POST', ...baseOptions, ...options};
|
|
71007
|
+
const localVarHeaderParameter = {} as any;
|
|
71008
|
+
const localVarQueryParameter = {} as any;
|
|
71009
|
+
|
|
71010
|
+
// authentication JWT-auth required
|
|
71011
|
+
// http bearer authentication required
|
|
71012
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71013
|
+
|
|
71014
|
+
|
|
71015
|
+
|
|
71016
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71017
|
+
|
|
71018
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71019
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71020
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71021
|
+
localVarRequestOptions.data = serializeDataIfNeeded(addShiftDto, localVarRequestOptions, configuration)
|
|
71022
|
+
|
|
71023
|
+
return {
|
|
71024
|
+
url: toPathString(localVarUrlObj),
|
|
71025
|
+
options: localVarRequestOptions,
|
|
71026
|
+
};
|
|
71027
|
+
},
|
|
71028
|
+
/**
|
|
71029
|
+
* 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.
|
|
71030
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
71031
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71032
|
+
* @param {string} shiftId The shift\'s id
|
|
71033
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
71034
|
+
* @param {*} [options] Override http request option.
|
|
71035
|
+
* @throws {RequiredError}
|
|
71036
|
+
*/
|
|
71037
|
+
changeShiftAtVenue: async (businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71038
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71039
|
+
assertParamExists('changeShiftAtVenue', 'businessId', businessId)
|
|
71040
|
+
// verify required parameter 'shiftId' is not null or undefined
|
|
71041
|
+
assertParamExists('changeShiftAtVenue', 'shiftId', shiftId)
|
|
71042
|
+
// verify required parameter 'changeShiftDto' is not null or undefined
|
|
71043
|
+
assertParamExists('changeShiftAtVenue', 'changeShiftDto', changeShiftDto)
|
|
71044
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/{shiftId}`
|
|
71045
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71046
|
+
.replace(`{${"shiftId"}}`, encodeURIComponent(String(shiftId)));
|
|
71047
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71048
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71049
|
+
let baseOptions;
|
|
71050
|
+
if (configuration) {
|
|
71051
|
+
baseOptions = configuration.baseOptions;
|
|
71052
|
+
}
|
|
71053
|
+
|
|
71054
|
+
const localVarRequestOptions = { method: 'PATCH', ...baseOptions, ...options};
|
|
71055
|
+
const localVarHeaderParameter = {} as any;
|
|
71056
|
+
const localVarQueryParameter = {} as any;
|
|
71057
|
+
|
|
71058
|
+
// authentication JWT-auth required
|
|
71059
|
+
// http bearer authentication required
|
|
71060
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71061
|
+
|
|
71062
|
+
|
|
71063
|
+
|
|
71064
|
+
localVarHeaderParameter['Content-Type'] = 'application/json';
|
|
71065
|
+
|
|
71066
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71067
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71068
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71069
|
+
localVarRequestOptions.data = serializeDataIfNeeded(changeShiftDto, localVarRequestOptions, configuration)
|
|
71070
|
+
|
|
71071
|
+
return {
|
|
71072
|
+
url: toPathString(localVarUrlObj),
|
|
71073
|
+
options: localVarRequestOptions,
|
|
71074
|
+
};
|
|
71075
|
+
},
|
|
70861
71076
|
/**
|
|
70862
71077
|
* 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.
|
|
70863
71078
|
* @summary Clock the employee in at the venue
|
|
@@ -71018,15 +71233,59 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
71018
71233
|
};
|
|
71019
71234
|
},
|
|
71020
71235
|
/**
|
|
71021
|
-
* The
|
|
71236
|
+
* 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.
|
|
71237
|
+
* @summary Remove a shift recorded by mistake
|
|
71238
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71239
|
+
* @param {string} shiftId The shift\'s id
|
|
71240
|
+
* @param {*} [options] Override http request option.
|
|
71241
|
+
* @throws {RequiredError}
|
|
71242
|
+
*/
|
|
71243
|
+
removeShiftAtVenue: async (businessId: number, shiftId: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71244
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71245
|
+
assertParamExists('removeShiftAtVenue', 'businessId', businessId)
|
|
71246
|
+
// verify required parameter 'shiftId' is not null or undefined
|
|
71247
|
+
assertParamExists('removeShiftAtVenue', 'shiftId', shiftId)
|
|
71248
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/{shiftId}`
|
|
71249
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)))
|
|
71250
|
+
.replace(`{${"shiftId"}}`, encodeURIComponent(String(shiftId)));
|
|
71251
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71252
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71253
|
+
let baseOptions;
|
|
71254
|
+
if (configuration) {
|
|
71255
|
+
baseOptions = configuration.baseOptions;
|
|
71256
|
+
}
|
|
71257
|
+
|
|
71258
|
+
const localVarRequestOptions = { method: 'DELETE', ...baseOptions, ...options};
|
|
71259
|
+
const localVarHeaderParameter = {} as any;
|
|
71260
|
+
const localVarQueryParameter = {} as any;
|
|
71261
|
+
|
|
71262
|
+
// authentication JWT-auth required
|
|
71263
|
+
// http bearer authentication required
|
|
71264
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71265
|
+
|
|
71266
|
+
|
|
71267
|
+
|
|
71268
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71269
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71270
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71271
|
+
|
|
71272
|
+
return {
|
|
71273
|
+
url: toPathString(localVarUrlObj),
|
|
71274
|
+
options: localVarRequestOptions,
|
|
71275
|
+
};
|
|
71276
|
+
},
|
|
71277
|
+
/**
|
|
71278
|
+
* 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).
|
|
71022
71279
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71023
71280
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71024
71281
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71025
71282
|
* @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
|
|
71283
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71284
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71026
71285
|
* @param {*} [options] Override http request option.
|
|
71027
71286
|
* @throws {RequiredError}
|
|
71028
71287
|
*/
|
|
71029
|
-
staffHoursAtVenue: async (businessId: number, from: string, to: string, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71288
|
+
staffHoursAtVenue: async (businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71030
71289
|
// verify required parameter 'businessId' is not null or undefined
|
|
71031
71290
|
assertParamExists('staffHoursAtVenue', 'businessId', businessId)
|
|
71032
71291
|
// verify required parameter 'from' is not null or undefined
|
|
@@ -71058,6 +71317,86 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
71058
71317
|
localVarQueryParameter['to'] = to;
|
|
71059
71318
|
}
|
|
71060
71319
|
|
|
71320
|
+
if (employeeIds) {
|
|
71321
|
+
localVarQueryParameter['employeeIds'] = employeeIds;
|
|
71322
|
+
}
|
|
71323
|
+
|
|
71324
|
+
if (status !== undefined) {
|
|
71325
|
+
localVarQueryParameter['status'] = status;
|
|
71326
|
+
}
|
|
71327
|
+
|
|
71328
|
+
|
|
71329
|
+
|
|
71330
|
+
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
71331
|
+
let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
|
|
71332
|
+
localVarRequestOptions.headers = {...localVarHeaderParameter, ...headersFromBaseOptions, ...options.headers};
|
|
71333
|
+
|
|
71334
|
+
return {
|
|
71335
|
+
url: toPathString(localVarUrlObj),
|
|
71336
|
+
options: localVarRequestOptions,
|
|
71337
|
+
};
|
|
71338
|
+
},
|
|
71339
|
+
/**
|
|
71340
|
+
* 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.
|
|
71341
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
71342
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71343
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71344
|
+
* @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
|
|
71345
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71346
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71347
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
71348
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
71349
|
+
* @param {*} [options] Override http request option.
|
|
71350
|
+
* @throws {RequiredError}
|
|
71351
|
+
*/
|
|
71352
|
+
staffHoursFileAtVenue: async (businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options: AxiosRequestConfig = {}): Promise<RequestArgs> => {
|
|
71353
|
+
// verify required parameter 'businessId' is not null or undefined
|
|
71354
|
+
assertParamExists('staffHoursFileAtVenue', 'businessId', businessId)
|
|
71355
|
+
// verify required parameter 'from' is not null or undefined
|
|
71356
|
+
assertParamExists('staffHoursFileAtVenue', 'from', from)
|
|
71357
|
+
// verify required parameter 'to' is not null or undefined
|
|
71358
|
+
assertParamExists('staffHoursFileAtVenue', 'to', to)
|
|
71359
|
+
const localVarPath = `/api/v2/businesses/{businessId}/shifts/hours/file`
|
|
71360
|
+
.replace(`{${"businessId"}}`, encodeURIComponent(String(businessId)));
|
|
71361
|
+
// use dummy base URL string because the URL constructor only accepts absolute URLs.
|
|
71362
|
+
const localVarUrlObj = new URL(localVarPath, DUMMY_BASE_URL);
|
|
71363
|
+
let baseOptions;
|
|
71364
|
+
if (configuration) {
|
|
71365
|
+
baseOptions = configuration.baseOptions;
|
|
71366
|
+
}
|
|
71367
|
+
|
|
71368
|
+
const localVarRequestOptions = { method: 'GET', ...baseOptions, ...options};
|
|
71369
|
+
const localVarHeaderParameter = {} as any;
|
|
71370
|
+
const localVarQueryParameter = {} as any;
|
|
71371
|
+
|
|
71372
|
+
// authentication JWT-auth required
|
|
71373
|
+
// http bearer authentication required
|
|
71374
|
+
await setBearerAuthToObject(localVarHeaderParameter, configuration)
|
|
71375
|
+
|
|
71376
|
+
if (from !== undefined) {
|
|
71377
|
+
localVarQueryParameter['from'] = from;
|
|
71378
|
+
}
|
|
71379
|
+
|
|
71380
|
+
if (to !== undefined) {
|
|
71381
|
+
localVarQueryParameter['to'] = to;
|
|
71382
|
+
}
|
|
71383
|
+
|
|
71384
|
+
if (employeeIds) {
|
|
71385
|
+
localVarQueryParameter['employeeIds'] = employeeIds;
|
|
71386
|
+
}
|
|
71387
|
+
|
|
71388
|
+
if (status !== undefined) {
|
|
71389
|
+
localVarQueryParameter['status'] = status;
|
|
71390
|
+
}
|
|
71391
|
+
|
|
71392
|
+
if (language !== undefined) {
|
|
71393
|
+
localVarQueryParameter['language'] = language;
|
|
71394
|
+
}
|
|
71395
|
+
|
|
71396
|
+
if (format !== undefined) {
|
|
71397
|
+
localVarQueryParameter['format'] = format;
|
|
71398
|
+
}
|
|
71399
|
+
|
|
71061
71400
|
|
|
71062
71401
|
|
|
71063
71402
|
setSearchParams(localVarUrlObj, localVarQueryParameter);
|
|
@@ -71164,6 +71503,31 @@ export const ShiftTrackingApiAxiosParamCreator = function (configuration?: Confi
|
|
|
71164
71503
|
export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
71165
71504
|
const localVarAxiosParamCreator = ShiftTrackingApiAxiosParamCreator(configuration)
|
|
71166
71505
|
return {
|
|
71506
|
+
/**
|
|
71507
|
+
* 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.
|
|
71508
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
71509
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71510
|
+
* @param {AddShiftDto} addShiftDto
|
|
71511
|
+
* @param {*} [options] Override http request option.
|
|
71512
|
+
* @throws {RequiredError}
|
|
71513
|
+
*/
|
|
71514
|
+
async addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>> {
|
|
71515
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.addShiftAtVenue(businessId, addShiftDto, options);
|
|
71516
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71517
|
+
},
|
|
71518
|
+
/**
|
|
71519
|
+
* 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.
|
|
71520
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
71521
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71522
|
+
* @param {string} shiftId The shift\'s id
|
|
71523
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
71524
|
+
* @param {*} [options] Override http request option.
|
|
71525
|
+
* @throws {RequiredError}
|
|
71526
|
+
*/
|
|
71527
|
+
async changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>> {
|
|
71528
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.changeShiftAtVenue(businessId, shiftId, changeShiftDto, options);
|
|
71529
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71530
|
+
},
|
|
71167
71531
|
/**
|
|
71168
71532
|
* 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.
|
|
71169
71533
|
* @summary Clock the employee in at the venue
|
|
@@ -71212,16 +71576,47 @@ export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
|
71212
71576
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71213
71577
|
},
|
|
71214
71578
|
/**
|
|
71215
|
-
* The
|
|
71579
|
+
* 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.
|
|
71580
|
+
* @summary Remove a shift recorded by mistake
|
|
71581
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71582
|
+
* @param {string} shiftId The shift\'s id
|
|
71583
|
+
* @param {*} [options] Override http request option.
|
|
71584
|
+
* @throws {RequiredError}
|
|
71585
|
+
*/
|
|
71586
|
+
async removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>> {
|
|
71587
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.removeShiftAtVenue(businessId, shiftId, options);
|
|
71588
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71589
|
+
},
|
|
71590
|
+
/**
|
|
71591
|
+
* 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).
|
|
71216
71592
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71217
71593
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71218
71594
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71219
71595
|
* @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
|
|
71596
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71597
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71220
71598
|
* @param {*} [options] Override http request option.
|
|
71221
71599
|
* @throws {RequiredError}
|
|
71222
71600
|
*/
|
|
71223
|
-
async staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffHoursResponseDto>> {
|
|
71224
|
-
const localVarAxiosArgs = await localVarAxiosParamCreator.staffHoursAtVenue(businessId, from, to, options);
|
|
71601
|
+
async staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffHoursResponseDto>> {
|
|
71602
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffHoursAtVenue(businessId, from, to, employeeIds, status, options);
|
|
71603
|
+
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71604
|
+
},
|
|
71605
|
+
/**
|
|
71606
|
+
* 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.
|
|
71607
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
71608
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71609
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71610
|
+
* @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
|
|
71611
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71612
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71613
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
71614
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
71615
|
+
* @param {*} [options] Override http request option.
|
|
71616
|
+
* @throws {RequiredError}
|
|
71617
|
+
*/
|
|
71618
|
+
async 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>> {
|
|
71619
|
+
const localVarAxiosArgs = await localVarAxiosParamCreator.staffHoursFileAtVenue(businessId, from, to, employeeIds, status, language, format, options);
|
|
71225
71620
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
71226
71621
|
},
|
|
71227
71622
|
/**
|
|
@@ -71258,6 +71653,29 @@ export const ShiftTrackingApiFp = function(configuration?: Configuration) {
|
|
|
71258
71653
|
export const ShiftTrackingApiFactory = function (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) {
|
|
71259
71654
|
const localVarFp = ShiftTrackingApiFp(configuration)
|
|
71260
71655
|
return {
|
|
71656
|
+
/**
|
|
71657
|
+
* 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.
|
|
71658
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
71659
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71660
|
+
* @param {AddShiftDto} addShiftDto
|
|
71661
|
+
* @param {*} [options] Override http request option.
|
|
71662
|
+
* @throws {RequiredError}
|
|
71663
|
+
*/
|
|
71664
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: any): AxiosPromise<StaffShiftDto> {
|
|
71665
|
+
return localVarFp.addShiftAtVenue(businessId, addShiftDto, options).then((request) => request(axios, basePath));
|
|
71666
|
+
},
|
|
71667
|
+
/**
|
|
71668
|
+
* 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.
|
|
71669
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
71670
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71671
|
+
* @param {string} shiftId The shift\'s id
|
|
71672
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
71673
|
+
* @param {*} [options] Override http request option.
|
|
71674
|
+
* @throws {RequiredError}
|
|
71675
|
+
*/
|
|
71676
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: any): AxiosPromise<StaffShiftDto> {
|
|
71677
|
+
return localVarFp.changeShiftAtVenue(businessId, shiftId, changeShiftDto, options).then((request) => request(axios, basePath));
|
|
71678
|
+
},
|
|
71261
71679
|
/**
|
|
71262
71680
|
* 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.
|
|
71263
71681
|
* @summary Clock the employee in at the venue
|
|
@@ -71302,16 +71720,45 @@ export const ShiftTrackingApiFactory = function (configuration?: Configuration,
|
|
|
71302
71720
|
return localVarFp.lockTill(businessId, options).then((request) => request(axios, basePath));
|
|
71303
71721
|
},
|
|
71304
71722
|
/**
|
|
71305
|
-
* The
|
|
71723
|
+
* 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.
|
|
71724
|
+
* @summary Remove a shift recorded by mistake
|
|
71725
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71726
|
+
* @param {string} shiftId The shift\'s id
|
|
71727
|
+
* @param {*} [options] Override http request option.
|
|
71728
|
+
* @throws {RequiredError}
|
|
71729
|
+
*/
|
|
71730
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: any): AxiosPromise<void> {
|
|
71731
|
+
return localVarFp.removeShiftAtVenue(businessId, shiftId, options).then((request) => request(axios, basePath));
|
|
71732
|
+
},
|
|
71733
|
+
/**
|
|
71734
|
+
* 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).
|
|
71306
71735
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71307
71736
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71308
71737
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71309
71738
|
* @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
|
|
71739
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71740
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71310
71741
|
* @param {*} [options] Override http request option.
|
|
71311
71742
|
* @throws {RequiredError}
|
|
71312
71743
|
*/
|
|
71313
|
-
staffHoursAtVenue(businessId: number, from: string, to: string, options?: any): AxiosPromise<StaffHoursResponseDto> {
|
|
71314
|
-
return localVarFp.staffHoursAtVenue(businessId, from, to, options).then((request) => request(axios, basePath));
|
|
71744
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: any): AxiosPromise<StaffHoursResponseDto> {
|
|
71745
|
+
return localVarFp.staffHoursAtVenue(businessId, from, to, employeeIds, status, options).then((request) => request(axios, basePath));
|
|
71746
|
+
},
|
|
71747
|
+
/**
|
|
71748
|
+
* 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.
|
|
71749
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
71750
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71751
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71752
|
+
* @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
|
|
71753
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71754
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71755
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
71756
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
71757
|
+
* @param {*} [options] Override http request option.
|
|
71758
|
+
* @throws {RequiredError}
|
|
71759
|
+
*/
|
|
71760
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: any): AxiosPromise<File> {
|
|
71761
|
+
return localVarFp.staffHoursFileAtVenue(businessId, from, to, employeeIds, status, language, format, options).then((request) => request(axios, basePath));
|
|
71315
71762
|
},
|
|
71316
71763
|
/**
|
|
71317
71764
|
* 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>).
|
|
@@ -71344,6 +71791,29 @@ export const ShiftTrackingApiFactory = function (configuration?: Configuration,
|
|
|
71344
71791
|
* @interface ShiftTrackingApi
|
|
71345
71792
|
*/
|
|
71346
71793
|
export interface ShiftTrackingApiInterface {
|
|
71794
|
+
/**
|
|
71795
|
+
* 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.
|
|
71796
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
71797
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71798
|
+
* @param {AddShiftDto} addShiftDto
|
|
71799
|
+
* @param {*} [options] Override http request option.
|
|
71800
|
+
* @throws {RequiredError}
|
|
71801
|
+
* @memberof ShiftTrackingApiInterface
|
|
71802
|
+
*/
|
|
71803
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
71804
|
+
|
|
71805
|
+
/**
|
|
71806
|
+
* 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.
|
|
71807
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
71808
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71809
|
+
* @param {string} shiftId The shift\'s id
|
|
71810
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
71811
|
+
* @param {*} [options] Override http request option.
|
|
71812
|
+
* @throws {RequiredError}
|
|
71813
|
+
* @memberof ShiftTrackingApiInterface
|
|
71814
|
+
*/
|
|
71815
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
71816
|
+
|
|
71347
71817
|
/**
|
|
71348
71818
|
* 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.
|
|
71349
71819
|
* @summary Clock the employee in at the venue
|
|
@@ -71388,16 +71858,45 @@ export interface ShiftTrackingApiInterface {
|
|
|
71388
71858
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
71389
71859
|
|
|
71390
71860
|
/**
|
|
71391
|
-
* The
|
|
71861
|
+
* 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.
|
|
71862
|
+
* @summary Remove a shift recorded by mistake
|
|
71863
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71864
|
+
* @param {string} shiftId The shift\'s id
|
|
71865
|
+
* @param {*} [options] Override http request option.
|
|
71866
|
+
* @throws {RequiredError}
|
|
71867
|
+
* @memberof ShiftTrackingApiInterface
|
|
71868
|
+
*/
|
|
71869
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
71870
|
+
|
|
71871
|
+
/**
|
|
71872
|
+
* 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).
|
|
71392
71873
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71393
71874
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71394
71875
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71395
71876
|
* @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
|
|
71877
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71878
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71879
|
+
* @param {*} [options] Override http request option.
|
|
71880
|
+
* @throws {RequiredError}
|
|
71881
|
+
* @memberof ShiftTrackingApiInterface
|
|
71882
|
+
*/
|
|
71883
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): AxiosPromise<StaffHoursResponseDto>;
|
|
71884
|
+
|
|
71885
|
+
/**
|
|
71886
|
+
* 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.
|
|
71887
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
71888
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71889
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71890
|
+
* @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
|
|
71891
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
71892
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
71893
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
71894
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
71396
71895
|
* @param {*} [options] Override http request option.
|
|
71397
71896
|
* @throws {RequiredError}
|
|
71398
71897
|
* @memberof ShiftTrackingApiInterface
|
|
71399
71898
|
*/
|
|
71400
|
-
|
|
71899
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
71401
71900
|
|
|
71402
71901
|
/**
|
|
71403
71902
|
* 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>).
|
|
@@ -71430,6 +71929,33 @@ export interface ShiftTrackingApiInterface {
|
|
|
71430
71929
|
* @extends {BaseAPI}
|
|
71431
71930
|
*/
|
|
71432
71931
|
export class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterface {
|
|
71932
|
+
/**
|
|
71933
|
+
* 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.
|
|
71934
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
71935
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71936
|
+
* @param {AddShiftDto} addShiftDto
|
|
71937
|
+
* @param {*} [options] Override http request option.
|
|
71938
|
+
* @throws {RequiredError}
|
|
71939
|
+
* @memberof ShiftTrackingApi
|
|
71940
|
+
*/
|
|
71941
|
+
public addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig) {
|
|
71942
|
+
return ShiftTrackingApiFp(this.configuration).addShiftAtVenue(businessId, addShiftDto, options).then((request) => request(this.axios, this.basePath));
|
|
71943
|
+
}
|
|
71944
|
+
|
|
71945
|
+
/**
|
|
71946
|
+
* 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.
|
|
71947
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
71948
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71949
|
+
* @param {string} shiftId The shift\'s id
|
|
71950
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
71951
|
+
* @param {*} [options] Override http request option.
|
|
71952
|
+
* @throws {RequiredError}
|
|
71953
|
+
* @memberof ShiftTrackingApi
|
|
71954
|
+
*/
|
|
71955
|
+
public changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig) {
|
|
71956
|
+
return ShiftTrackingApiFp(this.configuration).changeShiftAtVenue(businessId, shiftId, changeShiftDto, options).then((request) => request(this.axios, this.basePath));
|
|
71957
|
+
}
|
|
71958
|
+
|
|
71433
71959
|
/**
|
|
71434
71960
|
* 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.
|
|
71435
71961
|
* @summary Clock the employee in at the venue
|
|
@@ -71482,17 +72008,50 @@ export class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterfa
|
|
|
71482
72008
|
}
|
|
71483
72009
|
|
|
71484
72010
|
/**
|
|
71485
|
-
* The
|
|
72011
|
+
* 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.
|
|
72012
|
+
* @summary Remove a shift recorded by mistake
|
|
72013
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
72014
|
+
* @param {string} shiftId The shift\'s id
|
|
72015
|
+
* @param {*} [options] Override http request option.
|
|
72016
|
+
* @throws {RequiredError}
|
|
72017
|
+
* @memberof ShiftTrackingApi
|
|
72018
|
+
*/
|
|
72019
|
+
public removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig) {
|
|
72020
|
+
return ShiftTrackingApiFp(this.configuration).removeShiftAtVenue(businessId, shiftId, options).then((request) => request(this.axios, this.basePath));
|
|
72021
|
+
}
|
|
72022
|
+
|
|
72023
|
+
/**
|
|
72024
|
+
* 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).
|
|
71486
72025
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
71487
72026
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
71488
72027
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
71489
72028
|
* @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
|
|
72029
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
72030
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
72031
|
+
* @param {*} [options] Override http request option.
|
|
72032
|
+
* @throws {RequiredError}
|
|
72033
|
+
* @memberof ShiftTrackingApi
|
|
72034
|
+
*/
|
|
72035
|
+
public staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig) {
|
|
72036
|
+
return ShiftTrackingApiFp(this.configuration).staffHoursAtVenue(businessId, from, to, employeeIds, status, options).then((request) => request(this.axios, this.basePath));
|
|
72037
|
+
}
|
|
72038
|
+
|
|
72039
|
+
/**
|
|
72040
|
+
* 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.
|
|
72041
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
72042
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
72043
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
72044
|
+
* @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
|
|
72045
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
72046
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
72047
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
72048
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
71490
72049
|
* @param {*} [options] Override http request option.
|
|
71491
72050
|
* @throws {RequiredError}
|
|
71492
72051
|
* @memberof ShiftTrackingApi
|
|
71493
72052
|
*/
|
|
71494
|
-
public
|
|
71495
|
-
return ShiftTrackingApiFp(this.configuration).
|
|
72053
|
+
public staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig) {
|
|
72054
|
+
return ShiftTrackingApiFp(this.configuration).staffHoursFileAtVenue(businessId, from, to, employeeIds, status, language, format, options).then((request) => request(this.axios, this.basePath));
|
|
71496
72055
|
}
|
|
71497
72056
|
|
|
71498
72057
|
/**
|