@dsptch-work/api-client 0.16.0 → 0.18.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/CHANGELOG.md +85 -0
- package/dist/gen/index.d.ts +2 -2
- package/dist/gen/index.js +1 -1
- package/dist/gen/sdk.gen.d.ts +115 -1
- package/dist/gen/sdk.gen.js +162 -0
- package/dist/gen/types.gen.d.ts +930 -55
- package/dist/gen/zod.gen.d.ts +1163 -140
- package/dist/gen/zod.gen.js +471 -15
- package/package.json +1 -1
package/dist/gen/sdk.gen.js
CHANGED
|
@@ -6052,6 +6052,83 @@ export class TimeCardActuals {
|
|
|
6052
6052
|
});
|
|
6053
6053
|
}
|
|
6054
6054
|
}
|
|
6055
|
+
export class TimeSessions {
|
|
6056
|
+
/**
|
|
6057
|
+
* List time sessions
|
|
6058
|
+
*
|
|
6059
|
+
* List the company's time sessions — one per clock-in, open while the worker is
|
|
6060
|
+
* clocked in (`active: true`) and retained once they clock out (`active: false`).
|
|
6061
|
+
* A worker holds at most one active session, so `filter[active]=true` answers
|
|
6062
|
+
* who is clocked in right now. Results are ordered by start_time then id
|
|
6063
|
+
* (ascending) and cursor-paginated. Narrow with filter[user_id], filter[job_id]
|
|
6064
|
+
* (or filter[job_id][null]=true for sessions with no job), and filter[active];
|
|
6065
|
+
* the controller also accepts gte/lte time-range filters on start_time,
|
|
6066
|
+
* created_at, and updated_at.
|
|
6067
|
+
*
|
|
6068
|
+
*
|
|
6069
|
+
* **Required scope:**
|
|
6070
|
+
*
|
|
6071
|
+
* `timekeeping.time_sessions:read`
|
|
6072
|
+
*
|
|
6073
|
+
*/
|
|
6074
|
+
static listTimeSessions(options) {
|
|
6075
|
+
return (options?.client ?? client).get({
|
|
6076
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6077
|
+
url: '/api/v1/timekeeping/time_sessions',
|
|
6078
|
+
...options
|
|
6079
|
+
});
|
|
6080
|
+
}
|
|
6081
|
+
/**
|
|
6082
|
+
* Show time session
|
|
6083
|
+
*
|
|
6084
|
+
* Fetch one time session by id. `active` says whether the worker is still
|
|
6085
|
+
* clocked in on it.
|
|
6086
|
+
*
|
|
6087
|
+
*
|
|
6088
|
+
* **Required scope:**
|
|
6089
|
+
*
|
|
6090
|
+
* `timekeeping.time_sessions:read`
|
|
6091
|
+
*
|
|
6092
|
+
*/
|
|
6093
|
+
static getTimeSession(options) {
|
|
6094
|
+
return (options.client ?? client).get({
|
|
6095
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6096
|
+
url: '/api/v1/timekeeping/time_sessions/{id}',
|
|
6097
|
+
...options
|
|
6098
|
+
});
|
|
6099
|
+
}
|
|
6100
|
+
}
|
|
6101
|
+
export class Todos {
|
|
6102
|
+
/**
|
|
6103
|
+
* List Todos
|
|
6104
|
+
*
|
|
6105
|
+
* List your company's open work in one list: todos that are not yet completed, and failing
|
|
6106
|
+
* compliance checks on a requirement your company has highlighted. Entries come back
|
|
6107
|
+
* soonest-due first, with undated entries last.
|
|
6108
|
+
*
|
|
6109
|
+
* Read `kind` on an entry before anything else — a `todo` and a `compliance_check` are
|
|
6110
|
+
* different resources, with different fields and separate id spaces. Both also carry a
|
|
6111
|
+
* `type` field, scoped by `kind`: on a todo it's company, job, or project; on a compliance
|
|
6112
|
+
* check it's the check's class name, rendered exactly as it does at the Compliance Checks
|
|
6113
|
+
* endpoints, since it's the same resource. Write a check through those endpoints; this
|
|
6114
|
+
* list is read-only.
|
|
6115
|
+
*
|
|
6116
|
+
* The whole inbox is returned in one response; the list is not paginated.
|
|
6117
|
+
*
|
|
6118
|
+
*
|
|
6119
|
+
* **Required scope:**
|
|
6120
|
+
*
|
|
6121
|
+
* `todos:read`
|
|
6122
|
+
*
|
|
6123
|
+
*/
|
|
6124
|
+
static listTodoInbox(options) {
|
|
6125
|
+
return (options?.client ?? client).get({
|
|
6126
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6127
|
+
url: '/api/v1/todos',
|
|
6128
|
+
...options
|
|
6129
|
+
});
|
|
6130
|
+
}
|
|
6131
|
+
}
|
|
6055
6132
|
export class UserRoles {
|
|
6056
6133
|
/**
|
|
6057
6134
|
* List user roles
|
|
@@ -6104,6 +6181,40 @@ export class UserRoles {
|
|
|
6104
6181
|
}
|
|
6105
6182
|
}
|
|
6106
6183
|
export class WageDeterminations {
|
|
6184
|
+
/**
|
|
6185
|
+
* List boundary links
|
|
6186
|
+
*
|
|
6187
|
+
* Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
|
|
6188
|
+
*
|
|
6189
|
+
* **Required scope:**
|
|
6190
|
+
*
|
|
6191
|
+
* `wage_determinations.boundaries:read`
|
|
6192
|
+
*
|
|
6193
|
+
*/
|
|
6194
|
+
static listBoundaries(options) {
|
|
6195
|
+
return (options.client ?? client).get({
|
|
6196
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6197
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/boundaries',
|
|
6198
|
+
...options
|
|
6199
|
+
});
|
|
6200
|
+
}
|
|
6201
|
+
/**
|
|
6202
|
+
* List construction types
|
|
6203
|
+
*
|
|
6204
|
+
* Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
|
|
6205
|
+
*
|
|
6206
|
+
* **Required scope:**
|
|
6207
|
+
*
|
|
6208
|
+
* `wage_determinations.construction_types:read`
|
|
6209
|
+
*
|
|
6210
|
+
*/
|
|
6211
|
+
static listConstructionTypes(options) {
|
|
6212
|
+
return (options.client ?? client).get({
|
|
6213
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6214
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/construction_types',
|
|
6215
|
+
...options
|
|
6216
|
+
});
|
|
6217
|
+
}
|
|
6107
6218
|
/**
|
|
6108
6219
|
* List labor rates
|
|
6109
6220
|
*
|
|
@@ -6121,6 +6232,57 @@ export class WageDeterminations {
|
|
|
6121
6232
|
...options
|
|
6122
6233
|
});
|
|
6123
6234
|
}
|
|
6235
|
+
/**
|
|
6236
|
+
* List project types
|
|
6237
|
+
*
|
|
6238
|
+
* Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
|
|
6239
|
+
*
|
|
6240
|
+
* **Required scope:**
|
|
6241
|
+
*
|
|
6242
|
+
* `wage_determinations.project_types:read`
|
|
6243
|
+
*
|
|
6244
|
+
*/
|
|
6245
|
+
static listProjectTypes(options) {
|
|
6246
|
+
return (options.client ?? client).get({
|
|
6247
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6248
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/project_types',
|
|
6249
|
+
...options
|
|
6250
|
+
});
|
|
6251
|
+
}
|
|
6252
|
+
/**
|
|
6253
|
+
* List reference items
|
|
6254
|
+
*
|
|
6255
|
+
* Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
|
|
6256
|
+
*
|
|
6257
|
+
* **Required scope:**
|
|
6258
|
+
*
|
|
6259
|
+
* `wage_determinations.reference_items:read`
|
|
6260
|
+
*
|
|
6261
|
+
*/
|
|
6262
|
+
static listReferenceItems(options) {
|
|
6263
|
+
return (options.client ?? client).get({
|
|
6264
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6265
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/reference_items',
|
|
6266
|
+
...options
|
|
6267
|
+
});
|
|
6268
|
+
}
|
|
6269
|
+
/**
|
|
6270
|
+
* List wage classifications
|
|
6271
|
+
*
|
|
6272
|
+
* Company and user keys require the paid wage determinations entitlement on the acting company. Trusted application keys bypass this product gate.
|
|
6273
|
+
*
|
|
6274
|
+
* **Required scope:**
|
|
6275
|
+
*
|
|
6276
|
+
* `wage_determinations.wage_classifications:read`
|
|
6277
|
+
*
|
|
6278
|
+
*/
|
|
6279
|
+
static listWageClassifications(options) {
|
|
6280
|
+
return (options.client ?? client).get({
|
|
6281
|
+
security: [{ name: 'X-Api-Key', type: 'apiKey' }],
|
|
6282
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/wage_classifications',
|
|
6283
|
+
...options
|
|
6284
|
+
});
|
|
6285
|
+
}
|
|
6124
6286
|
/**
|
|
6125
6287
|
* List wage determinations
|
|
6126
6288
|
*
|