@munchi_oy/core 2.8.0 → 2.10.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 +501 -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/src/version.d.ts.map +1 -1
- package/dist/tsconfig.build.tsbuildinfo +1 -1
- package/generated/api.ts +801 -28
- package/package.json +1 -1
- 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
|
|
@@ -11085,6 +11129,31 @@ export interface KdsStationDto {
|
|
|
11085
11129
|
* @memberof KdsStationDto
|
|
11086
11130
|
*/
|
|
11087
11131
|
'categoryIds': Array<string>;
|
|
11132
|
+
/**
|
|
11133
|
+
* The ordering channels whose whole orders this station takes, whatever its categories list; an empty list when it takes none
|
|
11134
|
+
* @type {Array<ProviderEnum>}
|
|
11135
|
+
* @memberof KdsStationDto
|
|
11136
|
+
*/
|
|
11137
|
+
'channels': Array<ProviderEnum>;
|
|
11138
|
+
}
|
|
11139
|
+
/**
|
|
11140
|
+
*
|
|
11141
|
+
* @export
|
|
11142
|
+
* @interface KioskAutoRejectDto
|
|
11143
|
+
*/
|
|
11144
|
+
export interface KioskAutoRejectDto {
|
|
11145
|
+
/**
|
|
11146
|
+
* The kiosk order\'s id
|
|
11147
|
+
* @type {string}
|
|
11148
|
+
* @memberof KioskAutoRejectDto
|
|
11149
|
+
*/
|
|
11150
|
+
'orderId': string;
|
|
11151
|
+
/**
|
|
11152
|
+
* The venue whose order this is, by its venue id
|
|
11153
|
+
* @type {number}
|
|
11154
|
+
* @memberof KioskAutoRejectDto
|
|
11155
|
+
*/
|
|
11156
|
+
'orderingBusinessId': number;
|
|
11088
11157
|
}
|
|
11089
11158
|
/**
|
|
11090
11159
|
*
|
|
@@ -29632,6 +29701,25 @@ export interface SetEmployeeRoleDto {
|
|
|
29632
29701
|
*/
|
|
29633
29702
|
'roleId': string;
|
|
29634
29703
|
}
|
|
29704
|
+
/**
|
|
29705
|
+
*
|
|
29706
|
+
* @export
|
|
29707
|
+
* @interface SetKdsChannelStationsDto
|
|
29708
|
+
*/
|
|
29709
|
+
export interface SetKdsChannelStationsDto {
|
|
29710
|
+
/**
|
|
29711
|
+
* The Munchi venue id (orderingBusinessId) the stations belong to
|
|
29712
|
+
* @type {number}
|
|
29713
|
+
* @memberof SetKdsChannelStationsDto
|
|
29714
|
+
*/
|
|
29715
|
+
'businessId': number;
|
|
29716
|
+
/**
|
|
29717
|
+
* The complete set of stations taking the channel\'s whole orders, by their ids in kds-service: it replaces the set the channel had. An empty list clears it
|
|
29718
|
+
* @type {Array<string>}
|
|
29719
|
+
* @memberof SetKdsChannelStationsDto
|
|
29720
|
+
*/
|
|
29721
|
+
'stationIds': Array<string>;
|
|
29722
|
+
}
|
|
29635
29723
|
/**
|
|
29636
29724
|
*
|
|
29637
29725
|
* @export
|
|
@@ -29725,6 +29813,16 @@ export interface ShiftEmployeeDto {
|
|
|
29725
29813
|
*/
|
|
29726
29814
|
'photoUrl': string | null;
|
|
29727
29815
|
}
|
|
29816
|
+
/**
|
|
29817
|
+
*
|
|
29818
|
+
* @export
|
|
29819
|
+
* @enum {string}
|
|
29820
|
+
*/
|
|
29821
|
+
export declare const ShiftStatus: {
|
|
29822
|
+
readonly Open: "open";
|
|
29823
|
+
readonly Closed: "closed";
|
|
29824
|
+
};
|
|
29825
|
+
export type ShiftStatus = typeof ShiftStatus[keyof typeof ShiftStatus];
|
|
29728
29826
|
/**
|
|
29729
29827
|
*
|
|
29730
29828
|
* @export
|
|
@@ -30150,6 +30248,12 @@ export interface StaffHoursResponseDto {
|
|
|
30150
30248
|
* @interface StaffHoursShiftDto
|
|
30151
30249
|
*/
|
|
30152
30250
|
export interface StaffHoursShiftDto {
|
|
30251
|
+
/**
|
|
30252
|
+
* The shift\'s id
|
|
30253
|
+
* @type {string}
|
|
30254
|
+
* @memberof StaffHoursShiftDto
|
|
30255
|
+
*/
|
|
30256
|
+
'shiftId': string;
|
|
30153
30257
|
/**
|
|
30154
30258
|
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
30155
30259
|
* @type {string}
|
|
@@ -30168,6 +30272,61 @@ export interface StaffHoursShiftDto {
|
|
|
30168
30272
|
* @memberof StaffHoursShiftDto
|
|
30169
30273
|
*/
|
|
30170
30274
|
'minutes': number;
|
|
30275
|
+
/**
|
|
30276
|
+
*
|
|
30277
|
+
* @type {ShiftStatus}
|
|
30278
|
+
* @memberof StaffHoursShiftDto
|
|
30279
|
+
*/
|
|
30280
|
+
'status': ShiftStatus;
|
|
30281
|
+
}
|
|
30282
|
+
/**
|
|
30283
|
+
*
|
|
30284
|
+
* @export
|
|
30285
|
+
* @interface StaffShiftDto
|
|
30286
|
+
*/
|
|
30287
|
+
export interface StaffShiftDto {
|
|
30288
|
+
/**
|
|
30289
|
+
* The shift\'s id
|
|
30290
|
+
* @type {string}
|
|
30291
|
+
* @memberof StaffShiftDto
|
|
30292
|
+
*/
|
|
30293
|
+
'shiftId': string;
|
|
30294
|
+
/**
|
|
30295
|
+
* When the staff member clocked in; null for a shift recorded with only a clock-out
|
|
30296
|
+
* @type {string}
|
|
30297
|
+
* @memberof StaffShiftDto
|
|
30298
|
+
*/
|
|
30299
|
+
'clockInTime': string | null;
|
|
30300
|
+
/**
|
|
30301
|
+
* When the staff member clocked out; null while the shift is still open
|
|
30302
|
+
* @type {string}
|
|
30303
|
+
* @memberof StaffShiftDto
|
|
30304
|
+
*/
|
|
30305
|
+
'clockOutTime': string | null;
|
|
30306
|
+
/**
|
|
30307
|
+
* 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
|
|
30308
|
+
* @type {number}
|
|
30309
|
+
* @memberof StaffShiftDto
|
|
30310
|
+
*/
|
|
30311
|
+
'minutes': number;
|
|
30312
|
+
/**
|
|
30313
|
+
*
|
|
30314
|
+
* @type {ShiftStatus}
|
|
30315
|
+
* @memberof StaffShiftDto
|
|
30316
|
+
*/
|
|
30317
|
+
'status': ShiftStatus;
|
|
30318
|
+
/**
|
|
30319
|
+
* The staff member\'s id
|
|
30320
|
+
* @type {string}
|
|
30321
|
+
* @memberof StaffShiftDto
|
|
30322
|
+
*/
|
|
30323
|
+
'employeeId': string;
|
|
30324
|
+
/**
|
|
30325
|
+
* The staff member\'s name
|
|
30326
|
+
* @type {string}
|
|
30327
|
+
* @memberof StaffShiftDto
|
|
30328
|
+
*/
|
|
30329
|
+
'name': string;
|
|
30171
30330
|
}
|
|
30172
30331
|
/**
|
|
30173
30332
|
*
|
|
@@ -45056,7 +45215,7 @@ export declare class HistoryV6Api extends BaseAPI implements HistoryV6ApiInterfa
|
|
|
45056
45215
|
*/
|
|
45057
45216
|
export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
45058
45217
|
/**
|
|
45059
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45218
|
+
* 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
45219
|
* @summary Create a new invoice company
|
|
45061
45220
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45062
45221
|
* @param {*} [options] Override http request option.
|
|
@@ -45064,7 +45223,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
45064
45223
|
*/
|
|
45065
45224
|
createInvoiceCompany: (createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45066
45225
|
/**
|
|
45067
|
-
* Deletes one of the venue\'s companies, for
|
|
45226
|
+
* 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
45227
|
* @summary Delete an invoice company
|
|
45069
45228
|
* @param {string} id The company\'s id
|
|
45070
45229
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45099,7 +45258,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
45099
45258
|
*/
|
|
45100
45259
|
searchInvoiceCompanies: (businessId: number, search?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45101
45260
|
/**
|
|
45102
|
-
* Changes the fields sent and keeps the others, for
|
|
45261
|
+
* 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
45262
|
* @summary Update an invoice company
|
|
45104
45263
|
* @param {string} id The company\'s id
|
|
45105
45264
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45115,7 +45274,7 @@ export declare const InvoiceCompaniesApiAxiosParamCreator: (configuration?: Conf
|
|
|
45115
45274
|
*/
|
|
45116
45275
|
export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
45117
45276
|
/**
|
|
45118
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45277
|
+
* 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
45278
|
* @summary Create a new invoice company
|
|
45120
45279
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45121
45280
|
* @param {*} [options] Override http request option.
|
|
@@ -45123,7 +45282,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
45123
45282
|
*/
|
|
45124
45283
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<InvoiceCompanyResponseDto>>;
|
|
45125
45284
|
/**
|
|
45126
|
-
* Deletes one of the venue\'s companies, for
|
|
45285
|
+
* 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
45286
|
* @summary Delete an invoice company
|
|
45128
45287
|
* @param {string} id The company\'s id
|
|
45129
45288
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45158,7 +45317,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
45158
45317
|
*/
|
|
45159
45318
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<InvoiceCompanyResponseDto>>>;
|
|
45160
45319
|
/**
|
|
45161
|
-
* Changes the fields sent and keeps the others, for
|
|
45320
|
+
* 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
45321
|
* @summary Update an invoice company
|
|
45163
45322
|
* @param {string} id The company\'s id
|
|
45164
45323
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45174,7 +45333,7 @@ export declare const InvoiceCompaniesApiFp: (configuration?: Configuration) => {
|
|
|
45174
45333
|
*/
|
|
45175
45334
|
export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
45176
45335
|
/**
|
|
45177
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45336
|
+
* 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
45337
|
* @summary Create a new invoice company
|
|
45179
45338
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45180
45339
|
* @param {*} [options] Override http request option.
|
|
@@ -45182,7 +45341,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45182
45341
|
*/
|
|
45183
45342
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: any): AxiosPromise<InvoiceCompanyResponseDto>;
|
|
45184
45343
|
/**
|
|
45185
|
-
* Deletes one of the venue\'s companies, for
|
|
45344
|
+
* 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
45345
|
* @summary Delete an invoice company
|
|
45187
45346
|
* @param {string} id The company\'s id
|
|
45188
45347
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45217,7 +45376,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45217
45376
|
*/
|
|
45218
45377
|
searchInvoiceCompanies(businessId: number, search?: string, options?: any): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
45219
45378
|
/**
|
|
45220
|
-
* Changes the fields sent and keeps the others, for
|
|
45379
|
+
* 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
45380
|
* @summary Update an invoice company
|
|
45222
45381
|
* @param {string} id The company\'s id
|
|
45223
45382
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45234,7 +45393,7 @@ export declare const InvoiceCompaniesApiFactory: (configuration?: Configuration,
|
|
|
45234
45393
|
*/
|
|
45235
45394
|
export interface InvoiceCompaniesApiInterface {
|
|
45236
45395
|
/**
|
|
45237
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45396
|
+
* 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
45397
|
* @summary Create a new invoice company
|
|
45239
45398
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45240
45399
|
* @param {*} [options] Override http request option.
|
|
@@ -45243,7 +45402,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45243
45402
|
*/
|
|
45244
45403
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): AxiosPromise<InvoiceCompanyResponseDto>;
|
|
45245
45404
|
/**
|
|
45246
|
-
* Deletes one of the venue\'s companies, for
|
|
45405
|
+
* 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
45406
|
* @summary Delete an invoice company
|
|
45248
45407
|
* @param {string} id The company\'s id
|
|
45249
45408
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45282,7 +45441,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45282
45441
|
*/
|
|
45283
45442
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): AxiosPromise<Array<InvoiceCompanyResponseDto>>;
|
|
45284
45443
|
/**
|
|
45285
|
-
* Changes the fields sent and keeps the others, for
|
|
45444
|
+
* 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
45445
|
* @summary Update an invoice company
|
|
45287
45446
|
* @param {string} id The company\'s id
|
|
45288
45447
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45301,7 +45460,7 @@ export interface InvoiceCompaniesApiInterface {
|
|
|
45301
45460
|
*/
|
|
45302
45461
|
export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompaniesApiInterface {
|
|
45303
45462
|
/**
|
|
45304
|
-
* Saves a company the venue invoices, for munchi-dashboard-server
|
|
45463
|
+
* 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
45464
|
* @summary Create a new invoice company
|
|
45306
45465
|
* @param {CreateInvoiceCompanyDto} createInvoiceCompanyDto
|
|
45307
45466
|
* @param {*} [options] Override http request option.
|
|
@@ -45310,7 +45469,7 @@ export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompa
|
|
|
45310
45469
|
*/
|
|
45311
45470
|
createInvoiceCompany(createInvoiceCompanyDto: CreateInvoiceCompanyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceCompanyResponseDto, any, {}>>;
|
|
45312
45471
|
/**
|
|
45313
|
-
* Deletes one of the venue\'s companies, for
|
|
45472
|
+
* 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
45473
|
* @summary Delete an invoice company
|
|
45315
45474
|
* @param {string} id The company\'s id
|
|
45316
45475
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45349,7 +45508,7 @@ export declare class InvoiceCompaniesApi extends BaseAPI implements InvoiceCompa
|
|
|
45349
45508
|
*/
|
|
45350
45509
|
searchInvoiceCompanies(businessId: number, search?: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<InvoiceCompanyResponseDto[], any, {}>>;
|
|
45351
45510
|
/**
|
|
45352
|
-
* Changes the fields sent and keeps the others, for
|
|
45511
|
+
* 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
45512
|
* @summary Update an invoice company
|
|
45354
45513
|
* @param {string} id The company\'s id
|
|
45355
45514
|
* @param {number} businessId The venue the companies belong to: its orderingBusinessId
|
|
@@ -45440,6 +45599,15 @@ export declare const KDSApiAxiosParamCreator: (configuration?: Configuration) =>
|
|
|
45440
45599
|
* @throws {RequiredError}
|
|
45441
45600
|
*/
|
|
45442
45601
|
listKdsStations: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45602
|
+
/**
|
|
45603
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45604
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45605
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45606
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45607
|
+
* @param {*} [options] Override http request option.
|
|
45608
|
+
* @throws {RequiredError}
|
|
45609
|
+
*/
|
|
45610
|
+
setKdsChannelStations: (channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
45443
45611
|
/**
|
|
45444
45612
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45445
45613
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45530,6 +45698,15 @@ export declare const KDSApiFp: (configuration?: Configuration) => {
|
|
|
45530
45698
|
* @throws {RequiredError}
|
|
45531
45699
|
*/
|
|
45532
45700
|
listKdsStations(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<KdsStationDto>>>;
|
|
45701
|
+
/**
|
|
45702
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45703
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45704
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45705
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45706
|
+
* @param {*} [options] Override http request option.
|
|
45707
|
+
* @throws {RequiredError}
|
|
45708
|
+
*/
|
|
45709
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<KdsStationDto>>>;
|
|
45533
45710
|
/**
|
|
45534
45711
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45535
45712
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45620,6 +45797,15 @@ export declare const KDSApiFactory: (configuration?: Configuration, basePath?: s
|
|
|
45620
45797
|
* @throws {RequiredError}
|
|
45621
45798
|
*/
|
|
45622
45799
|
listKdsStations(businessId: number, options?: any): AxiosPromise<Array<KdsStationDto>>;
|
|
45800
|
+
/**
|
|
45801
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45802
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45803
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45804
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45805
|
+
* @param {*} [options] Override http request option.
|
|
45806
|
+
* @throws {RequiredError}
|
|
45807
|
+
*/
|
|
45808
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: any): AxiosPromise<Array<KdsStationDto>>;
|
|
45623
45809
|
/**
|
|
45624
45810
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45625
45811
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45719,6 +45905,16 @@ export interface KDSApiInterface {
|
|
|
45719
45905
|
* @memberof KDSApiInterface
|
|
45720
45906
|
*/
|
|
45721
45907
|
listKdsStations(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<KdsStationDto>>;
|
|
45908
|
+
/**
|
|
45909
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45910
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
45911
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
45912
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
45913
|
+
* @param {*} [options] Override http request option.
|
|
45914
|
+
* @throws {RequiredError}
|
|
45915
|
+
* @memberof KDSApiInterface
|
|
45916
|
+
*/
|
|
45917
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig): AxiosPromise<Array<KdsStationDto>>;
|
|
45722
45918
|
/**
|
|
45723
45919
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45724
45920
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -45820,6 +46016,16 @@ export declare class KDSApi extends BaseAPI implements KDSApiInterface {
|
|
|
45820
46016
|
* @memberof KDSApi
|
|
45821
46017
|
*/
|
|
45822
46018
|
listKdsStations(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsStationDto[], any, {}>>;
|
|
46019
|
+
/**
|
|
46020
|
+
* The stations named become exactly the set taking the channel\'s whole orders; an empty list clears it. Each must be one of the venue\'s active stations, never its NO_STATION profile. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
46021
|
+
* @summary Replace the stations taking a channel\'s whole orders
|
|
46022
|
+
* @param {ProviderEnum} channel The ordering channel whose whole orders go to the stations named
|
|
46023
|
+
* @param {SetKdsChannelStationsDto} setKdsChannelStationsDto The venue, and the complete set of stations taking the channel\'s whole orders
|
|
46024
|
+
* @param {*} [options] Override http request option.
|
|
46025
|
+
* @throws {RequiredError}
|
|
46026
|
+
* @memberof KDSApi
|
|
46027
|
+
*/
|
|
46028
|
+
setKdsChannelStations(channel: ProviderEnum, setKdsChannelStationsDto: SetKdsChannelStationsDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<KdsStationDto[], any, {}>>;
|
|
45823
46029
|
/**
|
|
45824
46030
|
* The station\'s categories become exactly the list sent, in one kds-service transaction; its name changes only when one is sent. The station must be one of the venue\'s active stations. It admits a signed-in ticket, whose venue must be on its account, or a Clerk API key; never the shared service key.
|
|
45825
46031
|
* @summary Rename a kitchen station and replace its categories
|
|
@@ -55914,6 +56120,25 @@ export declare class SavedReportsApi extends BaseAPI implements SavedReportsApiI
|
|
|
55914
56120
|
* @export
|
|
55915
56121
|
*/
|
|
55916
56122
|
export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
56123
|
+
/**
|
|
56124
|
+
* 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.
|
|
56125
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56126
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56127
|
+
* @param {AddShiftDto} addShiftDto
|
|
56128
|
+
* @param {*} [options] Override http request option.
|
|
56129
|
+
* @throws {RequiredError}
|
|
56130
|
+
*/
|
|
56131
|
+
addShiftAtVenue: (businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56132
|
+
/**
|
|
56133
|
+
* 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.
|
|
56134
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56135
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56136
|
+
* @param {string} shiftId The shift\'s id
|
|
56137
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56138
|
+
* @param {*} [options] Override http request option.
|
|
56139
|
+
* @throws {RequiredError}
|
|
56140
|
+
*/
|
|
56141
|
+
changeShiftAtVenue: (businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55917
56142
|
/**
|
|
55918
56143
|
* 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
56144
|
* @summary Clock the employee in at the venue
|
|
@@ -55950,15 +56175,40 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
55950
56175
|
*/
|
|
55951
56176
|
lockTill: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55952
56177
|
/**
|
|
55953
|
-
* The
|
|
56178
|
+
* 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.
|
|
56179
|
+
* @summary Remove a shift recorded by mistake
|
|
56180
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56181
|
+
* @param {string} shiftId The shift\'s id
|
|
56182
|
+
* @param {*} [options] Override http request option.
|
|
56183
|
+
* @throws {RequiredError}
|
|
56184
|
+
*/
|
|
56185
|
+
removeShiftAtVenue: (businessId: number, shiftId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56186
|
+
/**
|
|
56187
|
+
* 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
56188
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
55955
56189
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
55956
56190
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
55957
56191
|
* @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
|
|
56192
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56193
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56194
|
+
* @param {*} [options] Override http request option.
|
|
56195
|
+
* @throws {RequiredError}
|
|
56196
|
+
*/
|
|
56197
|
+
staffHoursAtVenue: (businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
56198
|
+
/**
|
|
56199
|
+
* 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.
|
|
56200
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56201
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56202
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56203
|
+
* @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
|
|
56204
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56205
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56206
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56207
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
55958
56208
|
* @param {*} [options] Override http request option.
|
|
55959
56209
|
* @throws {RequiredError}
|
|
55960
56210
|
*/
|
|
55961
|
-
|
|
56211
|
+
staffHoursFileAtVenue: (businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
55962
56212
|
/**
|
|
55963
56213
|
* 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
56214
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -55983,6 +56233,25 @@ export declare const ShiftTrackingApiAxiosParamCreator: (configuration?: Configu
|
|
|
55983
56233
|
* @export
|
|
55984
56234
|
*/
|
|
55985
56235
|
export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
56236
|
+
/**
|
|
56237
|
+
* 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.
|
|
56238
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56239
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56240
|
+
* @param {AddShiftDto} addShiftDto
|
|
56241
|
+
* @param {*} [options] Override http request option.
|
|
56242
|
+
* @throws {RequiredError}
|
|
56243
|
+
*/
|
|
56244
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>>;
|
|
56245
|
+
/**
|
|
56246
|
+
* 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.
|
|
56247
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56248
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56249
|
+
* @param {string} shiftId The shift\'s id
|
|
56250
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56251
|
+
* @param {*} [options] Override http request option.
|
|
56252
|
+
* @throws {RequiredError}
|
|
56253
|
+
*/
|
|
56254
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffShiftDto>>;
|
|
55986
56255
|
/**
|
|
55987
56256
|
* 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
56257
|
* @summary Clock the employee in at the venue
|
|
@@ -56019,15 +56288,40 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56019
56288
|
*/
|
|
56020
56289
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56021
56290
|
/**
|
|
56022
|
-
* The
|
|
56291
|
+
* 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.
|
|
56292
|
+
* @summary Remove a shift recorded by mistake
|
|
56293
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56294
|
+
* @param {string} shiftId The shift\'s id
|
|
56295
|
+
* @param {*} [options] Override http request option.
|
|
56296
|
+
* @throws {RequiredError}
|
|
56297
|
+
*/
|
|
56298
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
56299
|
+
/**
|
|
56300
|
+
* 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
56301
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56024
56302
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56025
56303
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56026
56304
|
* @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
|
|
56305
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56306
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56027
56307
|
* @param {*} [options] Override http request option.
|
|
56028
56308
|
* @throws {RequiredError}
|
|
56029
56309
|
*/
|
|
56030
|
-
staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffHoursResponseDto>>;
|
|
56310
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<StaffHoursResponseDto>>;
|
|
56311
|
+
/**
|
|
56312
|
+
* 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.
|
|
56313
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56314
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56315
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56316
|
+
* @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
|
|
56317
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56318
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56319
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56320
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56321
|
+
* @param {*} [options] Override http request option.
|
|
56322
|
+
* @throws {RequiredError}
|
|
56323
|
+
*/
|
|
56324
|
+
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
56325
|
/**
|
|
56032
56326
|
* 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
56327
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -56052,6 +56346,25 @@ export declare const ShiftTrackingApiFp: (configuration?: Configuration) => {
|
|
|
56052
56346
|
* @export
|
|
56053
56347
|
*/
|
|
56054
56348
|
export declare const ShiftTrackingApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
56349
|
+
/**
|
|
56350
|
+
* 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.
|
|
56351
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56352
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56353
|
+
* @param {AddShiftDto} addShiftDto
|
|
56354
|
+
* @param {*} [options] Override http request option.
|
|
56355
|
+
* @throws {RequiredError}
|
|
56356
|
+
*/
|
|
56357
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: any): AxiosPromise<StaffShiftDto>;
|
|
56358
|
+
/**
|
|
56359
|
+
* 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.
|
|
56360
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56361
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56362
|
+
* @param {string} shiftId The shift\'s id
|
|
56363
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56364
|
+
* @param {*} [options] Override http request option.
|
|
56365
|
+
* @throws {RequiredError}
|
|
56366
|
+
*/
|
|
56367
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: any): AxiosPromise<StaffShiftDto>;
|
|
56055
56368
|
/**
|
|
56056
56369
|
* 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
56370
|
* @summary Clock the employee in at the venue
|
|
@@ -56088,15 +56401,40 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56088
56401
|
*/
|
|
56089
56402
|
lockTill(businessId: number, options?: any): AxiosPromise<void>;
|
|
56090
56403
|
/**
|
|
56091
|
-
* The
|
|
56404
|
+
* 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.
|
|
56405
|
+
* @summary Remove a shift recorded by mistake
|
|
56406
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56407
|
+
* @param {string} shiftId The shift\'s id
|
|
56408
|
+
* @param {*} [options] Override http request option.
|
|
56409
|
+
* @throws {RequiredError}
|
|
56410
|
+
*/
|
|
56411
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: any): AxiosPromise<void>;
|
|
56412
|
+
/**
|
|
56413
|
+
* 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
56414
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56093
56415
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56094
56416
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56095
56417
|
* @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
|
|
56418
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56419
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56420
|
+
* @param {*} [options] Override http request option.
|
|
56421
|
+
* @throws {RequiredError}
|
|
56422
|
+
*/
|
|
56423
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: any): AxiosPromise<StaffHoursResponseDto>;
|
|
56424
|
+
/**
|
|
56425
|
+
* 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.
|
|
56426
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56427
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56428
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56429
|
+
* @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
|
|
56430
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56431
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56432
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56433
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56096
56434
|
* @param {*} [options] Override http request option.
|
|
56097
56435
|
* @throws {RequiredError}
|
|
56098
56436
|
*/
|
|
56099
|
-
|
|
56437
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: any): AxiosPromise<File>;
|
|
56100
56438
|
/**
|
|
56101
56439
|
* 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
56440
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -56122,6 +56460,27 @@ export declare const ShiftTrackingApiFactory: (configuration?: Configuration, ba
|
|
|
56122
56460
|
* @interface ShiftTrackingApi
|
|
56123
56461
|
*/
|
|
56124
56462
|
export interface ShiftTrackingApiInterface {
|
|
56463
|
+
/**
|
|
56464
|
+
* 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.
|
|
56465
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56466
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56467
|
+
* @param {AddShiftDto} addShiftDto
|
|
56468
|
+
* @param {*} [options] Override http request option.
|
|
56469
|
+
* @throws {RequiredError}
|
|
56470
|
+
* @memberof ShiftTrackingApiInterface
|
|
56471
|
+
*/
|
|
56472
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
56473
|
+
/**
|
|
56474
|
+
* 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.
|
|
56475
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56476
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56477
|
+
* @param {string} shiftId The shift\'s id
|
|
56478
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56479
|
+
* @param {*} [options] Override http request option.
|
|
56480
|
+
* @throws {RequiredError}
|
|
56481
|
+
* @memberof ShiftTrackingApiInterface
|
|
56482
|
+
*/
|
|
56483
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): AxiosPromise<StaffShiftDto>;
|
|
56125
56484
|
/**
|
|
56126
56485
|
* 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
56486
|
* @summary Clock the employee in at the venue
|
|
@@ -56162,16 +56521,43 @@ export interface ShiftTrackingApiInterface {
|
|
|
56162
56521
|
*/
|
|
56163
56522
|
lockTill(businessId: number, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56164
56523
|
/**
|
|
56165
|
-
* The
|
|
56524
|
+
* 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.
|
|
56525
|
+
* @summary Remove a shift recorded by mistake
|
|
56526
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56527
|
+
* @param {string} shiftId The shift\'s id
|
|
56528
|
+
* @param {*} [options] Override http request option.
|
|
56529
|
+
* @throws {RequiredError}
|
|
56530
|
+
* @memberof ShiftTrackingApiInterface
|
|
56531
|
+
*/
|
|
56532
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
56533
|
+
/**
|
|
56534
|
+
* 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
56535
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56167
56536
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56168
56537
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56169
56538
|
* @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
|
|
56539
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56540
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56541
|
+
* @param {*} [options] Override http request option.
|
|
56542
|
+
* @throws {RequiredError}
|
|
56543
|
+
* @memberof ShiftTrackingApiInterface
|
|
56544
|
+
*/
|
|
56545
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): AxiosPromise<StaffHoursResponseDto>;
|
|
56546
|
+
/**
|
|
56547
|
+
* 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.
|
|
56548
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56549
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56550
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56551
|
+
* @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
|
|
56552
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56553
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56554
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56555
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56170
56556
|
* @param {*} [options] Override http request option.
|
|
56171
56557
|
* @throws {RequiredError}
|
|
56172
56558
|
* @memberof ShiftTrackingApiInterface
|
|
56173
56559
|
*/
|
|
56174
|
-
|
|
56560
|
+
staffHoursFileAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, language?: ReportLanguage, format?: FileFormat, options?: AxiosRequestConfig): AxiosPromise<File>;
|
|
56175
56561
|
/**
|
|
56176
56562
|
* 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
56563
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -56200,6 +56586,27 @@ export interface ShiftTrackingApiInterface {
|
|
|
56200
56586
|
* @extends {BaseAPI}
|
|
56201
56587
|
*/
|
|
56202
56588
|
export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingApiInterface {
|
|
56589
|
+
/**
|
|
56590
|
+
* 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.
|
|
56591
|
+
* @summary Record a shift the till missed, for a staff member who works at the venue
|
|
56592
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56593
|
+
* @param {AddShiftDto} addShiftDto
|
|
56594
|
+
* @param {*} [options] Override http request option.
|
|
56595
|
+
* @throws {RequiredError}
|
|
56596
|
+
* @memberof ShiftTrackingApi
|
|
56597
|
+
*/
|
|
56598
|
+
addShiftAtVenue(businessId: number, addShiftDto: AddShiftDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffShiftDto, any, {}>>;
|
|
56599
|
+
/**
|
|
56600
|
+
* 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.
|
|
56601
|
+
* @summary Correct a shift\'s clock-in or clock-out, a forgotten clock-out among them
|
|
56602
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56603
|
+
* @param {string} shiftId The shift\'s id
|
|
56604
|
+
* @param {ChangeShiftDto} changeShiftDto
|
|
56605
|
+
* @param {*} [options] Override http request option.
|
|
56606
|
+
* @throws {RequiredError}
|
|
56607
|
+
* @memberof ShiftTrackingApi
|
|
56608
|
+
*/
|
|
56609
|
+
changeShiftAtVenue(businessId: number, shiftId: string, changeShiftDto: ChangeShiftDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffShiftDto, any, {}>>;
|
|
56203
56610
|
/**
|
|
56204
56611
|
* 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
56612
|
* @summary Clock the employee in at the venue
|
|
@@ -56240,16 +56647,43 @@ export declare class ShiftTrackingApi extends BaseAPI implements ShiftTrackingAp
|
|
|
56240
56647
|
*/
|
|
56241
56648
|
lockTill(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56242
56649
|
/**
|
|
56243
|
-
* The
|
|
56650
|
+
* 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.
|
|
56651
|
+
* @summary Remove a shift recorded by mistake
|
|
56652
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56653
|
+
* @param {string} shiftId The shift\'s id
|
|
56654
|
+
* @param {*} [options] Override http request option.
|
|
56655
|
+
* @throws {RequiredError}
|
|
56656
|
+
* @memberof ShiftTrackingApi
|
|
56657
|
+
*/
|
|
56658
|
+
removeShiftAtVenue(businessId: number, shiftId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
56659
|
+
/**
|
|
56660
|
+
* 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
56661
|
* @summary Each staff member\'s clocked hours at the venue over a period
|
|
56245
56662
|
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56246
56663
|
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56247
56664
|
* @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
|
|
56665
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56666
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56248
56667
|
* @param {*} [options] Override http request option.
|
|
56249
56668
|
* @throws {RequiredError}
|
|
56250
56669
|
* @memberof ShiftTrackingApi
|
|
56251
56670
|
*/
|
|
56252
|
-
staffHoursAtVenue(businessId: number, from: string, to: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffHoursResponseDto, any, {}>>;
|
|
56671
|
+
staffHoursAtVenue(businessId: number, from: string, to: string, employeeIds?: Array<string>, status?: ShiftStatus, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<StaffHoursResponseDto, any, {}>>;
|
|
56672
|
+
/**
|
|
56673
|
+
* 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.
|
|
56674
|
+
* @summary The staff hours report of the venue as a PDF or Excel (xlsx) file to download
|
|
56675
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
56676
|
+
* @param {string} from The first day, YYYY-MM-DD, in the venue\'s time zone
|
|
56677
|
+
* @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
|
|
56678
|
+
* @param {Array<string>} [employeeIds] Only these staff members\' shifts, by employee id. Absent or empty: every staff member\'s
|
|
56679
|
+
* @param {ShiftStatus} [status] Only open shifts (clocked in, not clocked out yet) or only closed ones (clocked out). Absent: both
|
|
56680
|
+
* @param {ReportLanguage} [language] The language the file is printed in. Absent: English
|
|
56681
|
+
* @param {FileFormat} [format] The file\'s format: pdf, or xlsx for an Excel workbook of the same report. Absent: pdf
|
|
56682
|
+
* @param {*} [options] Override http request option.
|
|
56683
|
+
* @throws {RequiredError}
|
|
56684
|
+
* @memberof ShiftTrackingApi
|
|
56685
|
+
*/
|
|
56686
|
+
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
56687
|
/**
|
|
56254
56688
|
* 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
56689
|
* @summary Unlock the till for an employee (no PIN; old builds)
|
|
@@ -57415,6 +57849,14 @@ export declare const WebhookApiAxiosParamCreator: (configuration?: Configuration
|
|
|
57415
57849
|
* @throws {RequiredError}
|
|
57416
57850
|
*/
|
|
57417
57851
|
handleFoodoraEvent: (orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57852
|
+
/**
|
|
57853
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
57854
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
57855
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
57856
|
+
* @param {*} [options] Override http request option.
|
|
57857
|
+
* @throws {RequiredError}
|
|
57858
|
+
*/
|
|
57859
|
+
handleKioskAutoReject: (kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
57418
57860
|
/**
|
|
57419
57861
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
57420
57862
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -57596,6 +58038,14 @@ export declare const WebhookApiFp: (configuration?: Configuration) => {
|
|
|
57596
58038
|
* @throws {RequiredError}
|
|
57597
58039
|
*/
|
|
57598
58040
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
58041
|
+
/**
|
|
58042
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58043
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58044
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58045
|
+
* @param {*} [options] Override http request option.
|
|
58046
|
+
* @throws {RequiredError}
|
|
58047
|
+
*/
|
|
58048
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
57599
58049
|
/**
|
|
57600
58050
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
57601
58051
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -57777,6 +58227,14 @@ export declare const WebhookApiFactory: (configuration?: Configuration, basePath
|
|
|
57777
58227
|
* @throws {RequiredError}
|
|
57778
58228
|
*/
|
|
57779
58229
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: any): AxiosPromise<void>;
|
|
58230
|
+
/**
|
|
58231
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58232
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58233
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58234
|
+
* @param {*} [options] Override http request option.
|
|
58235
|
+
* @throws {RequiredError}
|
|
58236
|
+
*/
|
|
58237
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: any): AxiosPromise<void>;
|
|
57780
58238
|
/**
|
|
57781
58239
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
57782
58240
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -57962,6 +58420,15 @@ export interface WebhookApiInterface {
|
|
|
57962
58420
|
* @memberof WebhookApiInterface
|
|
57963
58421
|
*/
|
|
57964
58422
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
58423
|
+
/**
|
|
58424
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58425
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58426
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58427
|
+
* @param {*} [options] Override http request option.
|
|
58428
|
+
* @throws {RequiredError}
|
|
58429
|
+
* @memberof WebhookApiInterface
|
|
58430
|
+
*/
|
|
58431
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
57965
58432
|
/**
|
|
57966
58433
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
57967
58434
|
* @summary Handle Supabase employee sync webhook
|
|
@@ -58167,6 +58634,15 @@ export declare class WebhookApi extends BaseAPI implements WebhookApiInterface {
|
|
|
58167
58634
|
* @memberof WebhookApi
|
|
58168
58635
|
*/
|
|
58169
58636
|
handleFoodoraEvent(orderUpdateDto: OrderUpdateDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
58637
|
+
/**
|
|
58638
|
+
* The Cloud Task queued when a paid kiosk order starts waiting, ten minutes later, at a venue whose kiosk has auto-reject on. An order no longer waiting stays as it is; kiosk-v2-order-handler refunds a rejected one.
|
|
58639
|
+
* @summary Reject a kiosk order nobody accepted in time (triggered by scheduler)
|
|
58640
|
+
* @param {KioskAutoRejectDto} kioskAutoRejectDto
|
|
58641
|
+
* @param {*} [options] Override http request option.
|
|
58642
|
+
* @throws {RequiredError}
|
|
58643
|
+
* @memberof WebhookApi
|
|
58644
|
+
*/
|
|
58645
|
+
handleKioskAutoReject(kioskAutoRejectDto: KioskAutoRejectDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
58170
58646
|
/**
|
|
58171
58647
|
* Saves the changed employee row to BigQuery\'s employees table; a delete saves the row\'s ids with no data. Posted by a Supabase database webhook (pg_net), which sends no credential today. It declares a service key beside the reports area, so the access listener reports every call it would refuse until the hook carries one.
|
|
58172
58648
|
* @summary Handle Supabase employee sync webhook
|