@munchi_oy/core 2.0.4 → 2.0.5
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 +801 -0
- 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 +1269 -0
- package/package.json +15 -13
- package/src/version.ts +1 -1
package/dist/generated/api.d.ts
CHANGED
|
@@ -132,6 +132,68 @@ export declare const ActionsEnum: {
|
|
|
132
132
|
readonly CourseFire: "CourseFire";
|
|
133
133
|
};
|
|
134
134
|
export type ActionsEnum = typeof ActionsEnum[keyof typeof ActionsEnum];
|
|
135
|
+
/**
|
|
136
|
+
*
|
|
137
|
+
* @export
|
|
138
|
+
* @interface AddEmployeeDto
|
|
139
|
+
*/
|
|
140
|
+
export interface AddEmployeeDto {
|
|
141
|
+
/**
|
|
142
|
+
* The employee\'s phone, in international format. Null clears it.
|
|
143
|
+
* @type {object}
|
|
144
|
+
* @memberof AddEmployeeDto
|
|
145
|
+
*/
|
|
146
|
+
'phone'?: object | null;
|
|
147
|
+
/**
|
|
148
|
+
* A photo of the employee, shown on the till\'s PIN screen. Null clears it.
|
|
149
|
+
* @type {object}
|
|
150
|
+
* @memberof AddEmployeeDto
|
|
151
|
+
*/
|
|
152
|
+
'photoUrl'?: object | null;
|
|
153
|
+
/**
|
|
154
|
+
* The employee\'s name, as the till shows it
|
|
155
|
+
* @type {string}
|
|
156
|
+
* @memberof AddEmployeeDto
|
|
157
|
+
*/
|
|
158
|
+
'name': string;
|
|
159
|
+
/**
|
|
160
|
+
* The employee\'s 4-digit PIN, unique among every employee (active or inactive) and passcode of the merchant, because the till looks a PIN up across it. Never answered back.
|
|
161
|
+
* @type {string}
|
|
162
|
+
* @memberof AddEmployeeDto
|
|
163
|
+
*/
|
|
164
|
+
'pin': string;
|
|
165
|
+
/**
|
|
166
|
+
* The employee\'s e-mail, unique among the merchant\'s employees: the same person\'s dashboard login is invited with it (D145). Saved in lower case.
|
|
167
|
+
* @type {string}
|
|
168
|
+
* @memberof AddEmployeeDto
|
|
169
|
+
*/
|
|
170
|
+
'email': string;
|
|
171
|
+
/**
|
|
172
|
+
* The venues the employee works at, each with the employee\'s role there; at least one, each venue once. Every venue must be on the signed-in account and of the venue\'s merchant.
|
|
173
|
+
* @type {Array<EmployeeAssignmentDto>}
|
|
174
|
+
* @memberof AddEmployeeDto
|
|
175
|
+
*/
|
|
176
|
+
'assignments': Array<EmployeeAssignmentDto>;
|
|
177
|
+
}
|
|
178
|
+
/**
|
|
179
|
+
*
|
|
180
|
+
* @export
|
|
181
|
+
* @interface AddEmployeeRoleDto
|
|
182
|
+
*/
|
|
183
|
+
export interface AddEmployeeRoleDto {
|
|
184
|
+
/**
|
|
185
|
+
* The role\'s name, as the staff see it on the till; unique at the venue
|
|
186
|
+
* @type {string}
|
|
187
|
+
* @memberof AddEmployeeRoleDto
|
|
188
|
+
*/
|
|
189
|
+
'name': string;
|
|
190
|
+
/**
|
|
191
|
+
* The POS keys the role holds, from GET /api/v1/pos-permissions. A group\'s `::*` key holds every key of the group, those added later included. Keys a role does not list are not held.
|
|
192
|
+
* @type {Array<PosPermission>}
|
|
193
|
+
* @memberof AddEmployeeRoleDto
|
|
194
|
+
*/
|
|
195
|
+
'permissionKeys': Array<PosPermission>;
|
|
196
|
+
}
|
|
135
197
|
/**
|
|
136
198
|
*
|
|
137
199
|
* @export
|
|
@@ -2226,6 +2288,68 @@ export declare const CdsSessionRole: {
|
|
|
2226
2288
|
readonly Display: "display";
|
|
2227
2289
|
};
|
|
2228
2290
|
export type CdsSessionRole = typeof CdsSessionRole[keyof typeof CdsSessionRole];
|
|
2291
|
+
/**
|
|
2292
|
+
*
|
|
2293
|
+
* @export
|
|
2294
|
+
* @interface ChangeEmployeeDto
|
|
2295
|
+
*/
|
|
2296
|
+
export interface ChangeEmployeeDto {
|
|
2297
|
+
/**
|
|
2298
|
+
* The employee\'s phone, in international format. Null clears it.
|
|
2299
|
+
* @type {object}
|
|
2300
|
+
* @memberof ChangeEmployeeDto
|
|
2301
|
+
*/
|
|
2302
|
+
'phone'?: object | null;
|
|
2303
|
+
/**
|
|
2304
|
+
* A photo of the employee, shown on the till\'s PIN screen. Null clears it.
|
|
2305
|
+
* @type {object}
|
|
2306
|
+
* @memberof ChangeEmployeeDto
|
|
2307
|
+
*/
|
|
2308
|
+
'photoUrl'?: object | null;
|
|
2309
|
+
/**
|
|
2310
|
+
* The employee\'s new name. Absent: the name stays.
|
|
2311
|
+
* @type {string}
|
|
2312
|
+
* @memberof ChangeEmployeeDto
|
|
2313
|
+
*/
|
|
2314
|
+
'name'?: string;
|
|
2315
|
+
/**
|
|
2316
|
+
* A new PIN. The employee\'s 4-digit PIN, unique among every employee (active or inactive) and passcode of the merchant, because the till looks a PIN up across it. Never answered back. Absent: the PIN stays.
|
|
2317
|
+
* @type {string}
|
|
2318
|
+
* @memberof ChangeEmployeeDto
|
|
2319
|
+
*/
|
|
2320
|
+
'pin'?: string;
|
|
2321
|
+
/**
|
|
2322
|
+
* A new e-mail. The employee\'s e-mail, unique among the merchant\'s employees: the same person\'s dashboard login is invited with it (D145). Saved in lower case. Absent: the e-mail stays; it is never cleared.
|
|
2323
|
+
* @type {string}
|
|
2324
|
+
* @memberof ChangeEmployeeDto
|
|
2325
|
+
*/
|
|
2326
|
+
'email'?: string;
|
|
2327
|
+
/**
|
|
2328
|
+
*
|
|
2329
|
+
* @type {Status}
|
|
2330
|
+
* @memberof ChangeEmployeeDto
|
|
2331
|
+
*/
|
|
2332
|
+
'status'?: Status;
|
|
2333
|
+
}
|
|
2334
|
+
/**
|
|
2335
|
+
*
|
|
2336
|
+
* @export
|
|
2337
|
+
* @interface ChangeEmployeeRoleDto
|
|
2338
|
+
*/
|
|
2339
|
+
export interface ChangeEmployeeRoleDto {
|
|
2340
|
+
/**
|
|
2341
|
+
* The role\'s new name; unique at the venue. Absent: the name stays.
|
|
2342
|
+
* @type {string}
|
|
2343
|
+
* @memberof ChangeEmployeeRoleDto
|
|
2344
|
+
*/
|
|
2345
|
+
'name'?: string;
|
|
2346
|
+
/**
|
|
2347
|
+
* The POS keys the role holds, from GET /api/v1/pos-permissions. A group\'s `::*` key holds every key of the group, those added later included. Keys a role does not list are not held. Sent, they replace every key the role had. Absent: the keys stay.
|
|
2348
|
+
* @type {Array<PosPermission>}
|
|
2349
|
+
* @memberof ChangeEmployeeRoleDto
|
|
2350
|
+
*/
|
|
2351
|
+
'permissionKeys'?: Array<PosPermission>;
|
|
2352
|
+
}
|
|
2229
2353
|
/**
|
|
2230
2354
|
*
|
|
2231
2355
|
* @export
|
|
@@ -5818,6 +5942,25 @@ export interface DisplayInitResponseDto {
|
|
|
5818
5942
|
*/
|
|
5819
5943
|
'ablyTokenRequest': object;
|
|
5820
5944
|
}
|
|
5945
|
+
/**
|
|
5946
|
+
*
|
|
5947
|
+
* @export
|
|
5948
|
+
* @interface EmployeeAssignmentDto
|
|
5949
|
+
*/
|
|
5950
|
+
export interface EmployeeAssignmentDto {
|
|
5951
|
+
/**
|
|
5952
|
+
* A venue the employee works at: its orderingBusinessId
|
|
5953
|
+
* @type {number}
|
|
5954
|
+
* @memberof EmployeeAssignmentDto
|
|
5955
|
+
*/
|
|
5956
|
+
'businessId': number;
|
|
5957
|
+
/**
|
|
5958
|
+
* The employee\'s role at that venue: one of that venue\'s roles
|
|
5959
|
+
* @type {string}
|
|
5960
|
+
* @memberof EmployeeAssignmentDto
|
|
5961
|
+
*/
|
|
5962
|
+
'roleId': string;
|
|
5963
|
+
}
|
|
5821
5964
|
/**
|
|
5822
5965
|
*
|
|
5823
5966
|
* @export
|
|
@@ -5831,6 +5974,105 @@ export interface EmployeeEventProcessedDto {
|
|
|
5831
5974
|
*/
|
|
5832
5975
|
'message': string;
|
|
5833
5976
|
}
|
|
5977
|
+
/**
|
|
5978
|
+
*
|
|
5979
|
+
* @export
|
|
5980
|
+
* @interface EmployeePageResponseDto
|
|
5981
|
+
*/
|
|
5982
|
+
export interface EmployeePageResponseDto {
|
|
5983
|
+
/**
|
|
5984
|
+
* The page\'s employees, ordered by name
|
|
5985
|
+
* @type {Array<EmployeeResponseDto>}
|
|
5986
|
+
* @memberof EmployeePageResponseDto
|
|
5987
|
+
*/
|
|
5988
|
+
'employees': Array<EmployeeResponseDto>;
|
|
5989
|
+
/**
|
|
5990
|
+
* The cursor of the next page; null on the last page
|
|
5991
|
+
* @type {string}
|
|
5992
|
+
* @memberof EmployeePageResponseDto
|
|
5993
|
+
*/
|
|
5994
|
+
'nextCursor': string | null;
|
|
5995
|
+
}
|
|
5996
|
+
/**
|
|
5997
|
+
*
|
|
5998
|
+
* @export
|
|
5999
|
+
* @interface EmployeeResponseDto
|
|
6000
|
+
*/
|
|
6001
|
+
export interface EmployeeResponseDto {
|
|
6002
|
+
/**
|
|
6003
|
+
* The employee\'s id
|
|
6004
|
+
* @type {string}
|
|
6005
|
+
* @memberof EmployeeResponseDto
|
|
6006
|
+
*/
|
|
6007
|
+
'id': string;
|
|
6008
|
+
/**
|
|
6009
|
+
* The employee\'s name, as the till shows it
|
|
6010
|
+
* @type {string}
|
|
6011
|
+
* @memberof EmployeeResponseDto
|
|
6012
|
+
*/
|
|
6013
|
+
'name': string;
|
|
6014
|
+
/**
|
|
6015
|
+
*
|
|
6016
|
+
* @type {Status}
|
|
6017
|
+
* @memberof EmployeeResponseDto
|
|
6018
|
+
*/
|
|
6019
|
+
'status': Status;
|
|
6020
|
+
/**
|
|
6021
|
+
* The employee\'s e-mail, in lower case; null only for an employee added before e-mails were required (D145)
|
|
6022
|
+
* @type {string}
|
|
6023
|
+
* @memberof EmployeeResponseDto
|
|
6024
|
+
*/
|
|
6025
|
+
'email': string | null;
|
|
6026
|
+
/**
|
|
6027
|
+
* The employee\'s phone; null when none
|
|
6028
|
+
* @type {string}
|
|
6029
|
+
* @memberof EmployeeResponseDto
|
|
6030
|
+
*/
|
|
6031
|
+
'phone': string | null;
|
|
6032
|
+
/**
|
|
6033
|
+
* The employee\'s photo; null when none
|
|
6034
|
+
* @type {string}
|
|
6035
|
+
* @memberof EmployeeResponseDto
|
|
6036
|
+
*/
|
|
6037
|
+
'photoUrl': string | null;
|
|
6038
|
+
/**
|
|
6039
|
+
* Every venue of the merchant the employee works at, with their role there, ordered by venue. Empty for an employee added at this venue and not yet given a role.
|
|
6040
|
+
* @type {Array<EmployeeAssignmentDto>}
|
|
6041
|
+
* @memberof EmployeeResponseDto
|
|
6042
|
+
*/
|
|
6043
|
+
'assignments': Array<EmployeeAssignmentDto>;
|
|
6044
|
+
}
|
|
6045
|
+
/**
|
|
6046
|
+
*
|
|
6047
|
+
* @export
|
|
6048
|
+
* @interface EmployeeRoleResponseDto
|
|
6049
|
+
*/
|
|
6050
|
+
export interface EmployeeRoleResponseDto {
|
|
6051
|
+
/**
|
|
6052
|
+
* The role\'s id
|
|
6053
|
+
* @type {string}
|
|
6054
|
+
* @memberof EmployeeRoleResponseDto
|
|
6055
|
+
*/
|
|
6056
|
+
'id': string;
|
|
6057
|
+
/**
|
|
6058
|
+
* The role\'s name, as the staff see it on the till
|
|
6059
|
+
* @type {string}
|
|
6060
|
+
* @memberof EmployeeRoleResponseDto
|
|
6061
|
+
*/
|
|
6062
|
+
'name': string;
|
|
6063
|
+
/**
|
|
6064
|
+
* The POS keys the role holds. A key stored by an older back office that the POS no longer knows is left out.
|
|
6065
|
+
* @type {Array<PosPermission>}
|
|
6066
|
+
* @memberof EmployeeRoleResponseDto
|
|
6067
|
+
*/
|
|
6068
|
+
'permissionKeys': Array<PosPermission>;
|
|
6069
|
+
/**
|
|
6070
|
+
* How many employees hold the role at the venue; a role is removed only when none does
|
|
6071
|
+
* @type {number}
|
|
6072
|
+
* @memberof EmployeeRoleResponseDto
|
|
6073
|
+
*/
|
|
6074
|
+
'employeeCount': number;
|
|
6075
|
+
}
|
|
5834
6076
|
/**
|
|
5835
6077
|
*
|
|
5836
6078
|
* @export
|
|
@@ -24891,6 +25133,19 @@ export interface SendReportEmailDto {
|
|
|
24891
25133
|
*/
|
|
24892
25134
|
'language'?: ReportLanguage;
|
|
24893
25135
|
}
|
|
25136
|
+
/**
|
|
25137
|
+
*
|
|
25138
|
+
* @export
|
|
25139
|
+
* @interface SetEmployeeRoleDto
|
|
25140
|
+
*/
|
|
25141
|
+
export interface SetEmployeeRoleDto {
|
|
25142
|
+
/**
|
|
25143
|
+
* The employee\'s role at the venue: one of the venue\'s roles. Replaces the role they had there.
|
|
25144
|
+
* @type {string}
|
|
25145
|
+
* @memberof SetEmployeeRoleDto
|
|
25146
|
+
*/
|
|
25147
|
+
'roleId': string;
|
|
25148
|
+
}
|
|
24894
25149
|
/**
|
|
24895
25150
|
*
|
|
24896
25151
|
* @export
|
|
@@ -37055,6 +37310,552 @@ export declare class DisplayApi extends BaseAPI implements DisplayApiInterface {
|
|
|
37055
37310
|
*/
|
|
37056
37311
|
unpair(unpairDisplayBodyDto: UnpairDisplayBodyDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UnpairDisplayResponseDto, any, {}>>;
|
|
37057
37312
|
}
|
|
37313
|
+
/**
|
|
37314
|
+
* EmployeeRolesApi - axios parameter creator
|
|
37315
|
+
* @export
|
|
37316
|
+
*/
|
|
37317
|
+
export declare const EmployeeRolesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37318
|
+
/**
|
|
37319
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37320
|
+
* @summary Add an employee role at the venue
|
|
37321
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37322
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37323
|
+
* @param {*} [options] Override http request option.
|
|
37324
|
+
* @throws {RequiredError}
|
|
37325
|
+
*/
|
|
37326
|
+
addEmployeeRole: (businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37327
|
+
/**
|
|
37328
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37329
|
+
* @summary Add the starter employee roles at the venue
|
|
37330
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37331
|
+
* @param {*} [options] Override http request option.
|
|
37332
|
+
* @throws {RequiredError}
|
|
37333
|
+
*/
|
|
37334
|
+
addStarterEmployeeRoles: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37335
|
+
/**
|
|
37336
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37337
|
+
* @summary Change an employee role of the venue
|
|
37338
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37339
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37340
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37341
|
+
* @param {*} [options] Override http request option.
|
|
37342
|
+
* @throws {RequiredError}
|
|
37343
|
+
*/
|
|
37344
|
+
changeEmployeeRole: (businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37345
|
+
/**
|
|
37346
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37347
|
+
* @summary List the venue\'s employee roles
|
|
37348
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37349
|
+
* @param {*} [options] Override http request option.
|
|
37350
|
+
* @throws {RequiredError}
|
|
37351
|
+
*/
|
|
37352
|
+
listEmployeeRoles: (businessId: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37353
|
+
/**
|
|
37354
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37355
|
+
* @summary Remove an employee role of the venue
|
|
37356
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37357
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37358
|
+
* @param {*} [options] Override http request option.
|
|
37359
|
+
* @throws {RequiredError}
|
|
37360
|
+
*/
|
|
37361
|
+
removeEmployeeRole: (businessId: number, roleId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37362
|
+
};
|
|
37363
|
+
/**
|
|
37364
|
+
* EmployeeRolesApi - functional programming interface
|
|
37365
|
+
* @export
|
|
37366
|
+
*/
|
|
37367
|
+
export declare const EmployeeRolesApiFp: (configuration?: Configuration) => {
|
|
37368
|
+
/**
|
|
37369
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37370
|
+
* @summary Add an employee role at the venue
|
|
37371
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37372
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37373
|
+
* @param {*} [options] Override http request option.
|
|
37374
|
+
* @throws {RequiredError}
|
|
37375
|
+
*/
|
|
37376
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>>;
|
|
37377
|
+
/**
|
|
37378
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37379
|
+
* @summary Add the starter employee roles at the venue
|
|
37380
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37381
|
+
* @param {*} [options] Override http request option.
|
|
37382
|
+
* @throws {RequiredError}
|
|
37383
|
+
*/
|
|
37384
|
+
addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmployeeRoleResponseDto>>>;
|
|
37385
|
+
/**
|
|
37386
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37387
|
+
* @summary Change an employee role of the venue
|
|
37388
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37389
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37390
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37391
|
+
* @param {*} [options] Override http request option.
|
|
37392
|
+
* @throws {RequiredError}
|
|
37393
|
+
*/
|
|
37394
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeRoleResponseDto>>;
|
|
37395
|
+
/**
|
|
37396
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37397
|
+
* @summary List the venue\'s employee roles
|
|
37398
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37399
|
+
* @param {*} [options] Override http request option.
|
|
37400
|
+
* @throws {RequiredError}
|
|
37401
|
+
*/
|
|
37402
|
+
listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<Array<EmployeeRoleResponseDto>>>;
|
|
37403
|
+
/**
|
|
37404
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37405
|
+
* @summary Remove an employee role of the venue
|
|
37406
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37407
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37408
|
+
* @param {*} [options] Override http request option.
|
|
37409
|
+
* @throws {RequiredError}
|
|
37410
|
+
*/
|
|
37411
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
37412
|
+
};
|
|
37413
|
+
/**
|
|
37414
|
+
* EmployeeRolesApi - factory interface
|
|
37415
|
+
* @export
|
|
37416
|
+
*/
|
|
37417
|
+
export declare const EmployeeRolesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37418
|
+
/**
|
|
37419
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37420
|
+
* @summary Add an employee role at the venue
|
|
37421
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37422
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37423
|
+
* @param {*} [options] Override http request option.
|
|
37424
|
+
* @throws {RequiredError}
|
|
37425
|
+
*/
|
|
37426
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37427
|
+
/**
|
|
37428
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37429
|
+
* @summary Add the starter employee roles at the venue
|
|
37430
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37431
|
+
* @param {*} [options] Override http request option.
|
|
37432
|
+
* @throws {RequiredError}
|
|
37433
|
+
*/
|
|
37434
|
+
addStarterEmployeeRoles(businessId: number, options?: any): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37435
|
+
/**
|
|
37436
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37437
|
+
* @summary Change an employee role of the venue
|
|
37438
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37439
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37440
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37441
|
+
* @param {*} [options] Override http request option.
|
|
37442
|
+
* @throws {RequiredError}
|
|
37443
|
+
*/
|
|
37444
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: any): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37445
|
+
/**
|
|
37446
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37447
|
+
* @summary List the venue\'s employee roles
|
|
37448
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37449
|
+
* @param {*} [options] Override http request option.
|
|
37450
|
+
* @throws {RequiredError}
|
|
37451
|
+
*/
|
|
37452
|
+
listEmployeeRoles(businessId: number, options?: any): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37453
|
+
/**
|
|
37454
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37455
|
+
* @summary Remove an employee role of the venue
|
|
37456
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37457
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37458
|
+
* @param {*} [options] Override http request option.
|
|
37459
|
+
* @throws {RequiredError}
|
|
37460
|
+
*/
|
|
37461
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: any): AxiosPromise<void>;
|
|
37462
|
+
};
|
|
37463
|
+
/**
|
|
37464
|
+
* EmployeeRolesApi - interface
|
|
37465
|
+
* @export
|
|
37466
|
+
* @interface EmployeeRolesApi
|
|
37467
|
+
*/
|
|
37468
|
+
export interface EmployeeRolesApiInterface {
|
|
37469
|
+
/**
|
|
37470
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37471
|
+
* @summary Add an employee role at the venue
|
|
37472
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37473
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37474
|
+
* @param {*} [options] Override http request option.
|
|
37475
|
+
* @throws {RequiredError}
|
|
37476
|
+
* @memberof EmployeeRolesApiInterface
|
|
37477
|
+
*/
|
|
37478
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37479
|
+
/**
|
|
37480
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37481
|
+
* @summary Add the starter employee roles at the venue
|
|
37482
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37483
|
+
* @param {*} [options] Override http request option.
|
|
37484
|
+
* @throws {RequiredError}
|
|
37485
|
+
* @memberof EmployeeRolesApiInterface
|
|
37486
|
+
*/
|
|
37487
|
+
addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37488
|
+
/**
|
|
37489
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37490
|
+
* @summary Change an employee role of the venue
|
|
37491
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37492
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37493
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37494
|
+
* @param {*} [options] Override http request option.
|
|
37495
|
+
* @throws {RequiredError}
|
|
37496
|
+
* @memberof EmployeeRolesApiInterface
|
|
37497
|
+
*/
|
|
37498
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeRoleResponseDto>;
|
|
37499
|
+
/**
|
|
37500
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37501
|
+
* @summary List the venue\'s employee roles
|
|
37502
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37503
|
+
* @param {*} [options] Override http request option.
|
|
37504
|
+
* @throws {RequiredError}
|
|
37505
|
+
* @memberof EmployeeRolesApiInterface
|
|
37506
|
+
*/
|
|
37507
|
+
listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): AxiosPromise<Array<EmployeeRoleResponseDto>>;
|
|
37508
|
+
/**
|
|
37509
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37510
|
+
* @summary Remove an employee role of the venue
|
|
37511
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37512
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37513
|
+
* @param {*} [options] Override http request option.
|
|
37514
|
+
* @throws {RequiredError}
|
|
37515
|
+
* @memberof EmployeeRolesApiInterface
|
|
37516
|
+
*/
|
|
37517
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
37518
|
+
}
|
|
37519
|
+
/**
|
|
37520
|
+
* EmployeeRolesApi - object-oriented interface
|
|
37521
|
+
* @export
|
|
37522
|
+
* @class EmployeeRolesApi
|
|
37523
|
+
* @extends {BaseAPI}
|
|
37524
|
+
*/
|
|
37525
|
+
export declare class EmployeeRolesApi extends BaseAPI implements EmployeeRolesApiInterface {
|
|
37526
|
+
/**
|
|
37527
|
+
* A new role with the POS keys sent. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37528
|
+
* @summary Add an employee role at the venue
|
|
37529
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37530
|
+
* @param {AddEmployeeRoleDto} addEmployeeRoleDto
|
|
37531
|
+
* @param {*} [options] Override http request option.
|
|
37532
|
+
* @throws {RequiredError}
|
|
37533
|
+
* @memberof EmployeeRolesApi
|
|
37534
|
+
*/
|
|
37535
|
+
addEmployeeRole(businessId: number, addEmployeeRoleDto: AddEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto, any, {}>>;
|
|
37536
|
+
/**
|
|
37537
|
+
* Adds each starter role (Cashier, Waiter, Manager) whose name no role of the venue has, all together, so a venue never starts from an empty list. The restaurant changes them like any other role. Calling it again adds nothing new. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37538
|
+
* @summary Add the starter employee roles at the venue
|
|
37539
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37540
|
+
* @param {*} [options] Override http request option.
|
|
37541
|
+
* @throws {RequiredError}
|
|
37542
|
+
* @memberof EmployeeRolesApi
|
|
37543
|
+
*/
|
|
37544
|
+
addStarterEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto[], any, {}>>;
|
|
37545
|
+
/**
|
|
37546
|
+
* Renames the role, replaces its POS keys, or both; a field not sent stays. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37547
|
+
* @summary Change an employee role of the venue
|
|
37548
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37549
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37550
|
+
* @param {ChangeEmployeeRoleDto} changeEmployeeRoleDto
|
|
37551
|
+
* @param {*} [options] Override http request option.
|
|
37552
|
+
* @throws {RequiredError}
|
|
37553
|
+
* @memberof EmployeeRolesApi
|
|
37554
|
+
*/
|
|
37555
|
+
changeEmployeeRole(businessId: number, roleId: string, changeEmployeeRoleDto: ChangeEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto, any, {}>>;
|
|
37556
|
+
/**
|
|
37557
|
+
* What each role lets the person at the till do, for the back office (D144). Read from the database every time, ordered by name; a venue keeps at most 100 roles.
|
|
37558
|
+
* @summary List the venue\'s employee roles
|
|
37559
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37560
|
+
* @param {*} [options] Override http request option.
|
|
37561
|
+
* @throws {RequiredError}
|
|
37562
|
+
* @memberof EmployeeRolesApi
|
|
37563
|
+
*/
|
|
37564
|
+
listEmployeeRoles(businessId: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeRoleResponseDto[], any, {}>>;
|
|
37565
|
+
/**
|
|
37566
|
+
* Only a role no employee holds is removed (D144); give its employees another role first. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37567
|
+
* @summary Remove an employee role of the venue
|
|
37568
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37569
|
+
* @param {string} roleId The role\'s id, one of the venue\'s
|
|
37570
|
+
* @param {*} [options] Override http request option.
|
|
37571
|
+
* @throws {RequiredError}
|
|
37572
|
+
* @memberof EmployeeRolesApi
|
|
37573
|
+
*/
|
|
37574
|
+
removeEmployeeRole(businessId: number, roleId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
37575
|
+
}
|
|
37576
|
+
/**
|
|
37577
|
+
* EmployeesApi - axios parameter creator
|
|
37578
|
+
* @export
|
|
37579
|
+
*/
|
|
37580
|
+
export declare const EmployeesApiAxiosParamCreator: (configuration?: Configuration) => {
|
|
37581
|
+
/**
|
|
37582
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37583
|
+
* @summary Add an employee at the venue
|
|
37584
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37585
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37586
|
+
* @param {*} [options] Override http request option.
|
|
37587
|
+
* @throws {RequiredError}
|
|
37588
|
+
*/
|
|
37589
|
+
addEmployee: (businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37590
|
+
/**
|
|
37591
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37592
|
+
* @summary Change an employee
|
|
37593
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37594
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37595
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37596
|
+
* @param {*} [options] Override http request option.
|
|
37597
|
+
* @throws {RequiredError}
|
|
37598
|
+
*/
|
|
37599
|
+
changeEmployee: (businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37600
|
+
/**
|
|
37601
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37602
|
+
* @summary List the venue\'s employees
|
|
37603
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37604
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37605
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37606
|
+
* @param {*} [options] Override http request option.
|
|
37607
|
+
* @throws {RequiredError}
|
|
37608
|
+
*/
|
|
37609
|
+
listEmployees: (businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37610
|
+
/**
|
|
37611
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37612
|
+
* @summary Remove an employee from the venue
|
|
37613
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37614
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37615
|
+
* @param {*} [options] Override http request option.
|
|
37616
|
+
* @throws {RequiredError}
|
|
37617
|
+
*/
|
|
37618
|
+
removeEmployeeFromVenue: (businessId: number, employeeId: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37619
|
+
/**
|
|
37620
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37621
|
+
* @summary Set an employee\'s role at the venue
|
|
37622
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37623
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37624
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37625
|
+
* @param {*} [options] Override http request option.
|
|
37626
|
+
* @throws {RequiredError}
|
|
37627
|
+
*/
|
|
37628
|
+
setEmployeeRole: (businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig) => Promise<RequestArgs>;
|
|
37629
|
+
};
|
|
37630
|
+
/**
|
|
37631
|
+
* EmployeesApi - functional programming interface
|
|
37632
|
+
* @export
|
|
37633
|
+
*/
|
|
37634
|
+
export declare const EmployeesApiFp: (configuration?: Configuration) => {
|
|
37635
|
+
/**
|
|
37636
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37637
|
+
* @summary Add an employee at the venue
|
|
37638
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37639
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37640
|
+
* @param {*} [options] Override http request option.
|
|
37641
|
+
* @throws {RequiredError}
|
|
37642
|
+
*/
|
|
37643
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
37644
|
+
/**
|
|
37645
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37646
|
+
* @summary Change an employee
|
|
37647
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37648
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37649
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37650
|
+
* @param {*} [options] Override http request option.
|
|
37651
|
+
* @throws {RequiredError}
|
|
37652
|
+
*/
|
|
37653
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
37654
|
+
/**
|
|
37655
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37656
|
+
* @summary List the venue\'s employees
|
|
37657
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37658
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37659
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37660
|
+
* @param {*} [options] Override http request option.
|
|
37661
|
+
* @throws {RequiredError}
|
|
37662
|
+
*/
|
|
37663
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeePageResponseDto>>;
|
|
37664
|
+
/**
|
|
37665
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37666
|
+
* @summary Remove an employee from the venue
|
|
37667
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37668
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37669
|
+
* @param {*} [options] Override http request option.
|
|
37670
|
+
* @throws {RequiredError}
|
|
37671
|
+
*/
|
|
37672
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
|
|
37673
|
+
/**
|
|
37674
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37675
|
+
* @summary Set an employee\'s role at the venue
|
|
37676
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37677
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37678
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37679
|
+
* @param {*} [options] Override http request option.
|
|
37680
|
+
* @throws {RequiredError}
|
|
37681
|
+
*/
|
|
37682
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<EmployeeResponseDto>>;
|
|
37683
|
+
};
|
|
37684
|
+
/**
|
|
37685
|
+
* EmployeesApi - factory interface
|
|
37686
|
+
* @export
|
|
37687
|
+
*/
|
|
37688
|
+
export declare const EmployeesApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
|
|
37689
|
+
/**
|
|
37690
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37691
|
+
* @summary Add an employee at the venue
|
|
37692
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37693
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37694
|
+
* @param {*} [options] Override http request option.
|
|
37695
|
+
* @throws {RequiredError}
|
|
37696
|
+
*/
|
|
37697
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
37698
|
+
/**
|
|
37699
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37700
|
+
* @summary Change an employee
|
|
37701
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37702
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37703
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37704
|
+
* @param {*} [options] Override http request option.
|
|
37705
|
+
* @throws {RequiredError}
|
|
37706
|
+
*/
|
|
37707
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
37708
|
+
/**
|
|
37709
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37710
|
+
* @summary List the venue\'s employees
|
|
37711
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37712
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37713
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37714
|
+
* @param {*} [options] Override http request option.
|
|
37715
|
+
* @throws {RequiredError}
|
|
37716
|
+
*/
|
|
37717
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: any): AxiosPromise<EmployeePageResponseDto>;
|
|
37718
|
+
/**
|
|
37719
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37720
|
+
* @summary Remove an employee from the venue
|
|
37721
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37722
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37723
|
+
* @param {*} [options] Override http request option.
|
|
37724
|
+
* @throws {RequiredError}
|
|
37725
|
+
*/
|
|
37726
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: any): AxiosPromise<void>;
|
|
37727
|
+
/**
|
|
37728
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37729
|
+
* @summary Set an employee\'s role at the venue
|
|
37730
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37731
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37732
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37733
|
+
* @param {*} [options] Override http request option.
|
|
37734
|
+
* @throws {RequiredError}
|
|
37735
|
+
*/
|
|
37736
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: any): AxiosPromise<EmployeeResponseDto>;
|
|
37737
|
+
};
|
|
37738
|
+
/**
|
|
37739
|
+
* EmployeesApi - interface
|
|
37740
|
+
* @export
|
|
37741
|
+
* @interface EmployeesApi
|
|
37742
|
+
*/
|
|
37743
|
+
export interface EmployeesApiInterface {
|
|
37744
|
+
/**
|
|
37745
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37746
|
+
* @summary Add an employee at the venue
|
|
37747
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37748
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37749
|
+
* @param {*} [options] Override http request option.
|
|
37750
|
+
* @throws {RequiredError}
|
|
37751
|
+
* @memberof EmployeesApiInterface
|
|
37752
|
+
*/
|
|
37753
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
37754
|
+
/**
|
|
37755
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37756
|
+
* @summary Change an employee
|
|
37757
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37758
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37759
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37760
|
+
* @param {*} [options] Override http request option.
|
|
37761
|
+
* @throws {RequiredError}
|
|
37762
|
+
* @memberof EmployeesApiInterface
|
|
37763
|
+
*/
|
|
37764
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
37765
|
+
/**
|
|
37766
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37767
|
+
* @summary List the venue\'s employees
|
|
37768
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37769
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37770
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37771
|
+
* @param {*} [options] Override http request option.
|
|
37772
|
+
* @throws {RequiredError}
|
|
37773
|
+
* @memberof EmployeesApiInterface
|
|
37774
|
+
*/
|
|
37775
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): AxiosPromise<EmployeePageResponseDto>;
|
|
37776
|
+
/**
|
|
37777
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37778
|
+
* @summary Remove an employee from the venue
|
|
37779
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37780
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37781
|
+
* @param {*} [options] Override http request option.
|
|
37782
|
+
* @throws {RequiredError}
|
|
37783
|
+
* @memberof EmployeesApiInterface
|
|
37784
|
+
*/
|
|
37785
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): AxiosPromise<void>;
|
|
37786
|
+
/**
|
|
37787
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37788
|
+
* @summary Set an employee\'s role at the venue
|
|
37789
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37790
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37791
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37792
|
+
* @param {*} [options] Override http request option.
|
|
37793
|
+
* @throws {RequiredError}
|
|
37794
|
+
* @memberof EmployeesApiInterface
|
|
37795
|
+
*/
|
|
37796
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): AxiosPromise<EmployeeResponseDto>;
|
|
37797
|
+
}
|
|
37798
|
+
/**
|
|
37799
|
+
* EmployeesApi - object-oriented interface
|
|
37800
|
+
* @export
|
|
37801
|
+
* @class EmployeesApi
|
|
37802
|
+
* @extends {BaseAPI}
|
|
37803
|
+
*/
|
|
37804
|
+
export declare class EmployeesApi extends BaseAPI implements EmployeesApiInterface {
|
|
37805
|
+
/**
|
|
37806
|
+
* An employee of the venue\'s merchant, with their PIN and a role at each venue they work at; every venue must be on the signed-in account (D144 c). The PIN is stored as both servers store it and never answered back. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37807
|
+
* @summary Add an employee at the venue
|
|
37808
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37809
|
+
* @param {AddEmployeeDto} addEmployeeDto
|
|
37810
|
+
* @param {*} [options] Override http request option.
|
|
37811
|
+
* @throws {RequiredError}
|
|
37812
|
+
* @memberof EmployeesApi
|
|
37813
|
+
*/
|
|
37814
|
+
addEmployee(businessId: number, addEmployeeDto: AddEmployeeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
37815
|
+
/**
|
|
37816
|
+
* Changes the fields sent: name, PIN, status, contact. These reach every venue the employee is listed at, so each must be on the signed-in account (D144 c). INACTIVE takes them off every till and keeps their shifts and PIN. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37817
|
+
* @summary Change an employee
|
|
37818
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37819
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37820
|
+
* @param {ChangeEmployeeDto} changeEmployeeDto
|
|
37821
|
+
* @param {*} [options] Override http request option.
|
|
37822
|
+
* @throws {RequiredError}
|
|
37823
|
+
* @memberof EmployeesApi
|
|
37824
|
+
*/
|
|
37825
|
+
changeEmployee(businessId: number, employeeId: string, changeEmployeeDto: ChangeEmployeeDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
37826
|
+
/**
|
|
37827
|
+
* The employees who work at the venue, and those added there with no role yet, ordered by name, a page at a time (D144). No PIN is answered, in any form. Read from the database every time.
|
|
37828
|
+
* @summary List the venue\'s employees
|
|
37829
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37830
|
+
* @param {string} [cursor] The nextCursor of the page before; absent for the first page
|
|
37831
|
+
* @param {number} [limit] How many employees a page holds, 100 at most
|
|
37832
|
+
* @param {*} [options] Override http request option.
|
|
37833
|
+
* @throws {RequiredError}
|
|
37834
|
+
* @memberof EmployeesApi
|
|
37835
|
+
*/
|
|
37836
|
+
listEmployees(businessId: number, cursor?: string, limit?: number, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeePageResponseDto, any, {}>>;
|
|
37837
|
+
/**
|
|
37838
|
+
* The employee stops working at this venue only; they, their shifts and their other venues are kept. To take them off every till, make them INACTIVE. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37839
|
+
* @summary Remove an employee from the venue
|
|
37840
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37841
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37842
|
+
* @param {*} [options] Override http request option.
|
|
37843
|
+
* @throws {RequiredError}
|
|
37844
|
+
* @memberof EmployeesApi
|
|
37845
|
+
*/
|
|
37846
|
+
removeEmployeeFromVenue(businessId: number, employeeId: string, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any, {}>>;
|
|
37847
|
+
/**
|
|
37848
|
+
* The employee works at the venue with this role, replacing the role they had there. An employee of the merchant who does not work at the venue yet starts working there. Once saved, the POS session of every venue the change reaches is cleared and its tills are told over Ably to sync POS_SESSION.
|
|
37849
|
+
* @summary Set an employee\'s role at the venue
|
|
37850
|
+
* @param {number} businessId The venue\'s orderingBusinessId
|
|
37851
|
+
* @param {string} employeeId The employee\'s id, one of the venue\'s merchant
|
|
37852
|
+
* @param {SetEmployeeRoleDto} setEmployeeRoleDto
|
|
37853
|
+
* @param {*} [options] Override http request option.
|
|
37854
|
+
* @throws {RequiredError}
|
|
37855
|
+
* @memberof EmployeesApi
|
|
37856
|
+
*/
|
|
37857
|
+
setEmployeeRole(businessId: number, employeeId: string, setEmployeeRoleDto: SetEmployeeRoleDto, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<EmployeeResponseDto, any, {}>>;
|
|
37858
|
+
}
|
|
37058
37859
|
/**
|
|
37059
37860
|
* FloorPlanApi - axios parameter creator
|
|
37060
37861
|
* @export
|