@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/types.gen.d.ts
CHANGED
|
@@ -370,7 +370,7 @@ export type DirectUploadParameters = {
|
|
|
370
370
|
/**
|
|
371
371
|
* What the file is for, named as the endpoint that will attach it (for example `assets.vendors`). Required. It decides where the file is stored, and the signed ID this call returns is issued for that resource alone — it will not resolve at any other endpoint, so a vendor logo cannot be attached as an avatar, or an avatar as a logo.
|
|
372
372
|
*/
|
|
373
|
-
resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
|
|
373
|
+
resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
|
|
374
374
|
/**
|
|
375
375
|
* Metadata describing the file being registered, before its bytes are uploaded.
|
|
376
376
|
*/
|
|
@@ -875,7 +875,7 @@ export type ApprenticeshipOccupationParameters = {
|
|
|
875
875
|
*/
|
|
876
876
|
export type ApprenticeshipProgramEmployerParameters = {
|
|
877
877
|
/**
|
|
878
|
-
* ID of the company to authorize as an employer in this program;
|
|
878
|
+
* ID of the company to authorize as an employer in this program; it need not be related to the sponsor, since a group program names unaffiliated contractors. Naming a company here grants its admins and managers read access to this program, the right to enroll their own workers in it, the right to curate its trade-to-occupation scope decisions, and a passing apprenticeship-program compliance check; it grants no access to that company's own data. Cannot be changed once the employer has apprentices. Required.
|
|
879
879
|
*/
|
|
880
880
|
company_id: string;
|
|
881
881
|
/**
|
|
@@ -2729,6 +2729,10 @@ export type JobResponseObject = {
|
|
|
2729
2729
|
* Whether time entries on this job are capped at one feature allocation.
|
|
2730
2730
|
*/
|
|
2731
2731
|
max_one_feature_allocation: boolean;
|
|
2732
|
+
/**
|
|
2733
|
+
* How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists.
|
|
2734
|
+
*/
|
|
2735
|
+
production_tracking_kind: 'none' | 'feature' | 'quantity';
|
|
2732
2736
|
[key: string]: unknown;
|
|
2733
2737
|
};
|
|
2734
2738
|
/**
|
|
@@ -2889,6 +2893,10 @@ export type JobParameters = {
|
|
|
2889
2893
|
* Whether time entries on this job are capped at one feature allocation; null when unset.
|
|
2890
2894
|
*/
|
|
2891
2895
|
max_one_feature_allocation?: boolean | null;
|
|
2896
|
+
/**
|
|
2897
|
+
* How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists. Omit the field to leave the current value unchanged.
|
|
2898
|
+
*/
|
|
2899
|
+
production_tracking_kind?: 'none' | 'feature' | 'quantity';
|
|
2892
2900
|
/**
|
|
2893
2901
|
* Work types (trade or scope categories) to associate with the job; null when none.
|
|
2894
2902
|
*/
|
|
@@ -3096,7 +3104,7 @@ export type GroupParameters = {
|
|
|
3096
3104
|
name: string;
|
|
3097
3105
|
};
|
|
3098
3106
|
/**
|
|
3099
|
-
* A worker as your company sees them: the cross-company person merged with their employment record at your company (title, pay, benefits, and accruals), their roles at your company, and optional prevailing-wage compliance details. There is no delete — removing a worker terminates their employment at the company (see the user-company endpoints), which sets termination_date and drops them from the default list.
|
|
3107
|
+
* A worker as your company sees them: the cross-company person merged with their employment record at your company (title, pay, benefits, and accruals), their roles at your company, and optional prevailing-wage compliance details. Your company sees everyone it employs, everyone it has granted a role, and everyone it has invited, which is the same set the web app shows. A role holder or an invitee your company does not employ has no employment record to merge, so the employment fields (employment_id through employment_window, plus manager_user_id) are null for them, no employment custom fields are published for them, and employment_state reads none. There is no delete — removing a worker terminates their employment at the company (see the user-company endpoints), which sets termination_date and drops them from the default list.
|
|
3100
3108
|
*/
|
|
3101
3109
|
export type UserResponseObject = {
|
|
3102
3110
|
/**
|
|
@@ -3171,10 +3179,14 @@ export type UserResponseObject = {
|
|
|
3171
3179
|
* URL of the worker's LinkedIn profile. Null when unset.
|
|
3172
3180
|
*/
|
|
3173
3181
|
linkedin_url: string | null;
|
|
3182
|
+
/**
|
|
3183
|
+
* Where the worker stands with your company right now, read against the employment published here: active (an employment in effect now), scheduled (an employment that has not begun), terminated (an employment that has ended, with nothing current and nothing upcoming), or none (someone your company sees without employing — a role holder or an invitee, told apart by the roles array). It is computed at read time rather than stored, so a scheduled hire turns active on its start date with no write. The same four words are filter[state] values on the list endpoint, which also accepts all.
|
|
3184
|
+
*/
|
|
3185
|
+
employment_state: 'active' | 'scheduled' | 'terminated' | 'none';
|
|
3174
3186
|
/**
|
|
3175
3187
|
* Identity of the worker's employment at your company, stable across employment versions — a title change or a raise versions the employment without changing this id. It names the employment that this object's employment fields (type through employment_window, plus manager_user_id and any employment custom fields) describe: a worker rehired after an earlier stint holds a second employment with its own id, and exactly one of them is published here.
|
|
3176
3188
|
*/
|
|
3177
|
-
employment_id: string;
|
|
3189
|
+
employment_id: string | null;
|
|
3178
3190
|
type: UserCompanyType;
|
|
3179
3191
|
/**
|
|
3180
3192
|
* Job title at your company. Null when unset.
|
|
@@ -3183,11 +3195,11 @@ export type UserResponseObject = {
|
|
|
3183
3195
|
/**
|
|
3184
3196
|
* Whether the worker is eligible for overtime pay (a prerequisite for assigning an overtime package).
|
|
3185
3197
|
*/
|
|
3186
|
-
overtime_eligible: boolean;
|
|
3198
|
+
overtime_eligible: boolean | null;
|
|
3187
3199
|
/**
|
|
3188
3200
|
* Whether the worker is enrolled in Time and Attendance and participates in time tracking.
|
|
3189
3201
|
*/
|
|
3190
|
-
enrolled_in_t_and_a: boolean;
|
|
3202
|
+
enrolled_in_t_and_a: boolean | null;
|
|
3191
3203
|
/**
|
|
3192
3204
|
* The worker's identifier in your payroll system of record. Null when unset.
|
|
3193
3205
|
*/
|
|
@@ -3195,7 +3207,7 @@ export type UserResponseObject = {
|
|
|
3195
3207
|
/**
|
|
3196
3208
|
* How the worker is paid: hourly or salary.
|
|
3197
3209
|
*/
|
|
3198
|
-
compensation_type: string;
|
|
3210
|
+
compensation_type: string | null;
|
|
3199
3211
|
/**
|
|
3200
3212
|
* Base pay rate, formatted as a currency string in the company's currency. Null when unset.
|
|
3201
3213
|
*/
|
|
@@ -3248,7 +3260,7 @@ export type UserResponseObject = {
|
|
|
3248
3260
|
* When this version of the employment stopped applying (ISO 8601); null while it is still in effect. A value in the past means an ended version is being served because the worker has nothing current or scheduled.
|
|
3249
3261
|
*/
|
|
3250
3262
|
valid_to: string | null;
|
|
3251
|
-
};
|
|
3263
|
+
} | null;
|
|
3252
3264
|
/**
|
|
3253
3265
|
* Id of the worker's manager at your company (another user). Null when none.
|
|
3254
3266
|
*/
|
|
@@ -5337,6 +5349,54 @@ export type TimeCardsResponseObject = {
|
|
|
5337
5349
|
*/
|
|
5338
5350
|
data: Array<TimeCardResponseObject>;
|
|
5339
5351
|
};
|
|
5352
|
+
/**
|
|
5353
|
+
* One clock-in by a worker — open (`active`) from clock-in until clock-out, and retained afterwards as the record that the session happened. A worker holds at most one active session at a time.
|
|
5354
|
+
*/
|
|
5355
|
+
export type TimeSessionResponseObject = {
|
|
5356
|
+
/**
|
|
5357
|
+
* Unique identifier.
|
|
5358
|
+
*/
|
|
5359
|
+
id: string;
|
|
5360
|
+
/**
|
|
5361
|
+
* ID of the worker (user) who clocked in.
|
|
5362
|
+
*/
|
|
5363
|
+
user_id: string;
|
|
5364
|
+
/**
|
|
5365
|
+
* ID of the job the worker clocked in against; null when they clocked in without a job.
|
|
5366
|
+
*/
|
|
5367
|
+
job_id: string | null;
|
|
5368
|
+
/**
|
|
5369
|
+
* ID of the timecode the worker clocked in under; null when none was chosen.
|
|
5370
|
+
*/
|
|
5371
|
+
timekeeping_timecode_id: string | null;
|
|
5372
|
+
/**
|
|
5373
|
+
* Whether the worker is still clocked in on this session. `false` once they clock out; the session keeps its start_time as history.
|
|
5374
|
+
*/
|
|
5375
|
+
active: boolean;
|
|
5376
|
+
/**
|
|
5377
|
+
* When the worker clocked in (ISO 8601).
|
|
5378
|
+
*/
|
|
5379
|
+
start_time: string;
|
|
5380
|
+
/**
|
|
5381
|
+
* When the record was created (ISO 8601).
|
|
5382
|
+
*/
|
|
5383
|
+
created_at: string;
|
|
5384
|
+
/**
|
|
5385
|
+
* When the record was last updated (ISO 8601).
|
|
5386
|
+
*/
|
|
5387
|
+
updated_at: string;
|
|
5388
|
+
};
|
|
5389
|
+
/**
|
|
5390
|
+
* A page of time sessions, with pagination metadata and navigation links.
|
|
5391
|
+
*/
|
|
5392
|
+
export type TimeSessionsResponseObject = {
|
|
5393
|
+
meta: Meta;
|
|
5394
|
+
links: Links;
|
|
5395
|
+
/**
|
|
5396
|
+
* The page of time sessions.
|
|
5397
|
+
*/
|
|
5398
|
+
data: Array<TimeSessionResponseObject>;
|
|
5399
|
+
};
|
|
5340
5400
|
/**
|
|
5341
5401
|
* Request body for locking or unlocking a time card.
|
|
5342
5402
|
*/
|
|
@@ -6172,6 +6232,103 @@ export type ComplianceCheckResponseObject = {
|
|
|
6172
6232
|
* ID of the employment (user-company) this check applies to, stable across all of its versions; set only when type is "Compliances::UserCompanyCheck", else null.
|
|
6173
6233
|
*/
|
|
6174
6234
|
employment_id: string | null;
|
|
6235
|
+
/**
|
|
6236
|
+
* IDs of the people assigned to the check; empty when nobody is assigned.
|
|
6237
|
+
*/
|
|
6238
|
+
assignee_user_ids: Array<string>;
|
|
6239
|
+
/**
|
|
6240
|
+
* From the check's requirement.
|
|
6241
|
+
*/
|
|
6242
|
+
title: string;
|
|
6243
|
+
/**
|
|
6244
|
+
* From the check's requirement.
|
|
6245
|
+
*/
|
|
6246
|
+
description: string;
|
|
6247
|
+
/**
|
|
6248
|
+
* Category of the requirement: one of apprenticeship, certified_payroll, company, job, payroll, project, regional, tax_credit, timekeeping, or worker.
|
|
6249
|
+
*/
|
|
6250
|
+
category: 'apprenticeship' | 'certified_payroll' | 'company' | 'job' | 'payroll' | 'project' | 'regional' | 'tax_credit' | 'timekeeping' | 'worker';
|
|
6251
|
+
/**
|
|
6252
|
+
* Point in the compliance lifecycle when the requirement applies: one of onboarding, setup, maintenance, before_approval_deadline, after_pay_date, or close_out.
|
|
6253
|
+
*/
|
|
6254
|
+
phase: 'after_pay_date' | 'before_approval_deadline' | 'close_out' | 'maintenance' | 'onboarding' | 'setup';
|
|
6255
|
+
/**
|
|
6256
|
+
* Urgency of the requirement: one of critical, high, medium, or low; null when the requirement sets no priority.
|
|
6257
|
+
*/
|
|
6258
|
+
priority: 'critical' | 'high' | 'medium' | 'low' | null;
|
|
6259
|
+
/**
|
|
6260
|
+
* When the check was last evaluated (ISO 8601); null when never evaluated.
|
|
6261
|
+
*/
|
|
6262
|
+
checked_at: string | null;
|
|
6263
|
+
/**
|
|
6264
|
+
* When the check most recently passed (ISO 8601); null while not passed.
|
|
6265
|
+
*/
|
|
6266
|
+
passed_at: string | null;
|
|
6267
|
+
/**
|
|
6268
|
+
* When the check is due (ISO 8601); null when no due date is set.
|
|
6269
|
+
*/
|
|
6270
|
+
time_due: string | null;
|
|
6271
|
+
/**
|
|
6272
|
+
* When the record was created (ISO 8601).
|
|
6273
|
+
*/
|
|
6274
|
+
created_at: string;
|
|
6275
|
+
/**
|
|
6276
|
+
* When the record was last updated (ISO 8601).
|
|
6277
|
+
*/
|
|
6278
|
+
updated_at: string;
|
|
6279
|
+
};
|
|
6280
|
+
/**
|
|
6281
|
+
* A single compliance check, with the documents attached to it. Same fields as compliance_check_response_object plus `documents`.
|
|
6282
|
+
*/
|
|
6283
|
+
export type ComplianceCheckDetailResponseObject = {
|
|
6284
|
+
/**
|
|
6285
|
+
* Unique identifier.
|
|
6286
|
+
*/
|
|
6287
|
+
id: string;
|
|
6288
|
+
/**
|
|
6289
|
+
* The kind of entity this check is evaluated against; exactly one of the corresponding `*_id` fields is set.
|
|
6290
|
+
*/
|
|
6291
|
+
type: 'Compliances::CompanyCheck' | 'Compliances::JobCheck' | 'Compliances::ProjectCheck' | 'Compliances::TimeCardCheck' | 'Compliances::PayPeriodCheck' | 'Compliances::UserCheck' | 'Compliances::UserCompanyCheck';
|
|
6292
|
+
/**
|
|
6293
|
+
* Lifecycle status of the check: one of passed, failed, not_applicable, dismissed, or pending; only dismissed and pending are client-settable (see compliance_check_parameters).
|
|
6294
|
+
*/
|
|
6295
|
+
status: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending';
|
|
6296
|
+
/**
|
|
6297
|
+
* ID of the requirement this check evaluates.
|
|
6298
|
+
*/
|
|
6299
|
+
compliances_requirement_id: string;
|
|
6300
|
+
/**
|
|
6301
|
+
* ID of the company this check applies to; set only when type is "Compliances::CompanyCheck", else null.
|
|
6302
|
+
*/
|
|
6303
|
+
company_id: string | null;
|
|
6304
|
+
/**
|
|
6305
|
+
* ID of the job this check applies to; set only when type is "Compliances::JobCheck", else null.
|
|
6306
|
+
*/
|
|
6307
|
+
job_id: string | null;
|
|
6308
|
+
/**
|
|
6309
|
+
* ID of the project this check applies to; set only when type is "Compliances::ProjectCheck", else null.
|
|
6310
|
+
*/
|
|
6311
|
+
project_id: string | null;
|
|
6312
|
+
/**
|
|
6313
|
+
* ID of the time card this check applies to; set only when type is "Compliances::TimeCardCheck", else null.
|
|
6314
|
+
*/
|
|
6315
|
+
timekeeping_time_card_id: string | null;
|
|
6316
|
+
/**
|
|
6317
|
+
* ID of the pay period this check applies to; set only when type is "Compliances::PayPeriodCheck", else null.
|
|
6318
|
+
*/
|
|
6319
|
+
timekeeping_pay_period_id: string | null;
|
|
6320
|
+
/**
|
|
6321
|
+
* ID of the worker this check applies to; set only when type is "Compliances::UserCheck", else null.
|
|
6322
|
+
*/
|
|
6323
|
+
user_id: string | null;
|
|
6324
|
+
/**
|
|
6325
|
+
* ID of the employment (user-company) this check applies to, stable across all of its versions; set only when type is "Compliances::UserCompanyCheck", else null.
|
|
6326
|
+
*/
|
|
6327
|
+
employment_id: string | null;
|
|
6328
|
+
/**
|
|
6329
|
+
* IDs of the people assigned to the check; empty when nobody is assigned.
|
|
6330
|
+
*/
|
|
6331
|
+
assignee_user_ids: Array<string>;
|
|
6175
6332
|
/**
|
|
6176
6333
|
* From the check's requirement.
|
|
6177
6334
|
*/
|
|
@@ -6212,9 +6369,46 @@ export type ComplianceCheckResponseObject = {
|
|
|
6212
6369
|
* When the record was last updated (ISO 8601).
|
|
6213
6370
|
*/
|
|
6214
6371
|
updated_at: string;
|
|
6372
|
+
/**
|
|
6373
|
+
* Documents attached to the check; always empty when its requirement does not ask for one.
|
|
6374
|
+
*/
|
|
6375
|
+
documents: Array<ComplianceCheckDocumentObject>;
|
|
6376
|
+
};
|
|
6377
|
+
/**
|
|
6378
|
+
* A document attached to a compliance check.
|
|
6379
|
+
*/
|
|
6380
|
+
export type ComplianceCheckDocumentObject = {
|
|
6381
|
+
/**
|
|
6382
|
+
* ID of the document.
|
|
6383
|
+
*/
|
|
6384
|
+
id: string;
|
|
6385
|
+
/**
|
|
6386
|
+
* Name of the uploaded file.
|
|
6387
|
+
*/
|
|
6388
|
+
filename: string;
|
|
6389
|
+
/**
|
|
6390
|
+
* MIME type of the uploaded file; null when the upload did not declare one.
|
|
6391
|
+
*/
|
|
6392
|
+
content_type: string | null;
|
|
6393
|
+
/**
|
|
6394
|
+
* Size of the uploaded file in bytes.
|
|
6395
|
+
*/
|
|
6396
|
+
byte_size: number;
|
|
6397
|
+
/**
|
|
6398
|
+
* Time-limited download URL for the file.
|
|
6399
|
+
*/
|
|
6400
|
+
url: string;
|
|
6401
|
+
/**
|
|
6402
|
+
* ID of the person who uploaded the document.
|
|
6403
|
+
*/
|
|
6404
|
+
created_by_user_id: string;
|
|
6405
|
+
/**
|
|
6406
|
+
* When the document was uploaded (ISO 8601).
|
|
6407
|
+
*/
|
|
6408
|
+
created_at: string;
|
|
6215
6409
|
};
|
|
6216
6410
|
/**
|
|
6217
|
-
* Update a compliance check.
|
|
6411
|
+
* Update a compliance check. Every field is optional.
|
|
6218
6412
|
*/
|
|
6219
6413
|
export type ComplianceCheckParameters = {
|
|
6220
6414
|
/**
|
|
@@ -6225,6 +6419,70 @@ export type ComplianceCheckParameters = {
|
|
|
6225
6419
|
* When the check is due (ISO 8601); send null to clear it, or omit to leave it unchanged.
|
|
6226
6420
|
*/
|
|
6227
6421
|
time_due?: string | null;
|
|
6422
|
+
/**
|
|
6423
|
+
* Replaces the check's assignees: send every user id that should be assigned, or an empty array to clear them. Every id must belong to a person in your company. Omit to leave the assignees unchanged.
|
|
6424
|
+
*/
|
|
6425
|
+
assignee_user_ids?: Array<string>;
|
|
6426
|
+
/**
|
|
6427
|
+
* Adds a document to the check. Upload the file to /api/v1/direct_uploads naming the `compliance.checks` resource, then send the signed id it returns. Requires a user-scoped API key, because the document records who uploaded it; a company-scoped key is refused. The check re-evaluates unless this same request also sets `status`. Refused when the check's requirement does not ask for a document.
|
|
6428
|
+
*/
|
|
6429
|
+
file_signed_id?: string;
|
|
6430
|
+
};
|
|
6431
|
+
export type RichTextObject = {
|
|
6432
|
+
text: string;
|
|
6433
|
+
attachments: Array<{
|
|
6434
|
+
filename: string;
|
|
6435
|
+
content_type?: string | null;
|
|
6436
|
+
byte_size: number;
|
|
6437
|
+
url: string;
|
|
6438
|
+
}>;
|
|
6439
|
+
};
|
|
6440
|
+
export type TodoInboxEntryResponseObject = ({
|
|
6441
|
+
kind: 'todo';
|
|
6442
|
+
} & TodoInboxTodoResponseObject) | ({
|
|
6443
|
+
kind: 'compliance_check';
|
|
6444
|
+
} & TodoInboxComplianceCheckResponseObject);
|
|
6445
|
+
export type TodoInboxTodoResponseObject = {
|
|
6446
|
+
kind: 'todo';
|
|
6447
|
+
id: string;
|
|
6448
|
+
type: 'company' | 'job' | 'project';
|
|
6449
|
+
company_id: string | null;
|
|
6450
|
+
job_id: string | null;
|
|
6451
|
+
project_id: string | null;
|
|
6452
|
+
name: string;
|
|
6453
|
+
created_by_user_id: string;
|
|
6454
|
+
updated_by_user_id: string;
|
|
6455
|
+
completed: boolean;
|
|
6456
|
+
task_assignee_user_ids: Array<string>;
|
|
6457
|
+
description: RichTextObject;
|
|
6458
|
+
time_due: string | null;
|
|
6459
|
+
created_at: string;
|
|
6460
|
+
updated_at: string;
|
|
6461
|
+
};
|
|
6462
|
+
export type TodoInboxComplianceCheckResponseObject = {
|
|
6463
|
+
kind: 'compliance_check';
|
|
6464
|
+
id: string;
|
|
6465
|
+
type: 'Compliances::CompanyCheck' | 'Compliances::JobCheck' | 'Compliances::ProjectCheck' | 'Compliances::TimeCardCheck' | 'Compliances::PayPeriodCheck' | 'Compliances::UserCheck' | 'Compliances::UserCompanyCheck';
|
|
6466
|
+
status: 'passed' | 'failed' | 'not_applicable' | 'dismissed' | 'pending';
|
|
6467
|
+
compliances_requirement_id: string;
|
|
6468
|
+
company_id: string | null;
|
|
6469
|
+
job_id: string | null;
|
|
6470
|
+
project_id: string | null;
|
|
6471
|
+
timekeeping_time_card_id: string | null;
|
|
6472
|
+
timekeeping_pay_period_id: string | null;
|
|
6473
|
+
user_id: string | null;
|
|
6474
|
+
employment_id: string | null;
|
|
6475
|
+
assignee_user_ids: Array<string>;
|
|
6476
|
+
title: string;
|
|
6477
|
+
description: string;
|
|
6478
|
+
category: 'apprenticeship' | 'certified_payroll' | 'company' | 'job' | 'payroll' | 'project' | 'regional' | 'tax_credit' | 'timekeeping' | 'worker';
|
|
6479
|
+
phase: 'after_pay_date' | 'before_approval_deadline' | 'close_out' | 'maintenance' | 'onboarding' | 'setup';
|
|
6480
|
+
priority: 'critical' | 'high' | 'medium' | 'low' | null;
|
|
6481
|
+
checked_at: string | null;
|
|
6482
|
+
passed_at: string | null;
|
|
6483
|
+
time_due: string | null;
|
|
6484
|
+
created_at: string;
|
|
6485
|
+
updated_at: string;
|
|
6228
6486
|
};
|
|
6229
6487
|
/**
|
|
6230
6488
|
* One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
|
|
@@ -7007,18 +7265,9 @@ export type PositionParameters = {
|
|
|
7007
7265
|
*/
|
|
7008
7266
|
wage_adder_rate_cents?: number | null;
|
|
7009
7267
|
/**
|
|
7010
|
-
*
|
|
7268
|
+
* The complete desired set of job wage determination IDs. On PATCH, this replaces the current set; omit the field to leave assignments unchanged. Required federal and regional assignments cannot be removed from a PWA position.
|
|
7011
7269
|
*/
|
|
7012
|
-
|
|
7013
|
-
/**
|
|
7014
|
-
* Unique identifier.
|
|
7015
|
-
*/
|
|
7016
|
-
id?: number | null;
|
|
7017
|
-
/**
|
|
7018
|
-
* ID of the job wage determination to attach.
|
|
7019
|
-
*/
|
|
7020
|
-
job_wage_determination_id?: string | null;
|
|
7021
|
-
}>;
|
|
7270
|
+
job_wage_determination_ids?: Array<string>;
|
|
7022
7271
|
/**
|
|
7023
7272
|
* PWA classification detail to set; skill_level sets the apprenticeship or skill classification.
|
|
7024
7273
|
*/
|
|
@@ -7609,7 +7858,7 @@ export type PositionFunction = {
|
|
|
7609
7858
|
*/
|
|
7610
7859
|
export type UserRoleRequest = {
|
|
7611
7860
|
/**
|
|
7612
|
-
* ID of the user to grant the role to.
|
|
7861
|
+
* ID of the user to grant the role to. Must be someone your company can already see — a worker it employs, a holder of one of its roles, or someone it has invited.
|
|
7613
7862
|
*/
|
|
7614
7863
|
user_id?: string;
|
|
7615
7864
|
/**
|
|
@@ -7801,6 +8050,10 @@ export type LaborRateResponseObject = {
|
|
|
7801
8050
|
* Fringe benefit expressed as a monthly amount, in cents as a decimal string; null when fringe is expressed hourly or as a percentage instead.
|
|
7802
8051
|
*/
|
|
7803
8052
|
fringe_benefit_monthly_rate_cents: string | null;
|
|
8053
|
+
/**
|
|
8054
|
+
* IDs of the reference items this rate cites, in the order their letter tokens appear in the source fringe expression.
|
|
8055
|
+
*/
|
|
8056
|
+
reference_item_ids: Array<string>;
|
|
7804
8057
|
/**
|
|
7805
8058
|
* When the record was created (ISO 8601).
|
|
7806
8059
|
*/
|
|
@@ -7822,55 +8075,283 @@ export type LaborRatesResponseObject = {
|
|
|
7822
8075
|
data: Array<LaborRateResponseObject>;
|
|
7823
8076
|
};
|
|
7824
8077
|
/**
|
|
7825
|
-
* A
|
|
7826
|
-
*/
|
|
7827
|
-
export type JobWageDeterminationResponseObject = ({
|
|
7828
|
-
type: 'Pwa::JobWageDeterminations::Federal';
|
|
7829
|
-
} & FederalJobWageDeterminationResponseObject) | ({
|
|
7830
|
-
type: 'Pwa::JobWageDeterminations::Regional';
|
|
7831
|
-
} & RegionalJobWageDeterminationResponseObject);
|
|
7832
|
-
/**
|
|
7833
|
-
* A Federal (Davis-Bacon) wage determination on a job.
|
|
8078
|
+
* A DOL labor-classification schedule within one wage determination; its labor rates and reference items share this schedule boundary.
|
|
7834
8079
|
*/
|
|
7835
|
-
export type
|
|
8080
|
+
export type WageClassificationResponseObject = {
|
|
7836
8081
|
/**
|
|
7837
|
-
*
|
|
8082
|
+
* Unique identifier.
|
|
7838
8083
|
*/
|
|
7839
8084
|
id: string;
|
|
7840
8085
|
/**
|
|
7841
|
-
* ID of the
|
|
8086
|
+
* ID of the wage determination that owns this classification schedule.
|
|
7842
8087
|
*/
|
|
7843
|
-
|
|
8088
|
+
wage_determination_id: string;
|
|
7844
8089
|
/**
|
|
7845
|
-
*
|
|
8090
|
+
* DOL alphanumeric classification identifier, such as ELEC0145-004.
|
|
7846
8091
|
*/
|
|
7847
|
-
|
|
8092
|
+
identifier: string;
|
|
7848
8093
|
/**
|
|
7849
|
-
*
|
|
8094
|
+
* Date the underlying classification agreement originated.
|
|
7850
8095
|
*/
|
|
7851
|
-
|
|
8096
|
+
date: string;
|
|
7852
8097
|
/**
|
|
7853
|
-
*
|
|
8098
|
+
* Verbatim schedule-level footnote text; null when none was printed.
|
|
7854
8099
|
*/
|
|
7855
|
-
|
|
8100
|
+
footnote: string | null;
|
|
7856
8101
|
/**
|
|
7857
|
-
*
|
|
8102
|
+
* Verbatim schedule subheader; null when none was printed.
|
|
7858
8103
|
*/
|
|
7859
|
-
|
|
8104
|
+
subheader: string | null;
|
|
7860
8105
|
/**
|
|
7861
|
-
*
|
|
8106
|
+
* When the record was created (ISO 8601).
|
|
7862
8107
|
*/
|
|
7863
|
-
|
|
8108
|
+
created_at: string;
|
|
7864
8109
|
/**
|
|
7865
|
-
*
|
|
8110
|
+
* When the record was last updated (ISO 8601).
|
|
7866
8111
|
*/
|
|
7867
|
-
|
|
8112
|
+
updated_at: string;
|
|
8113
|
+
};
|
|
8114
|
+
/**
|
|
8115
|
+
* A page of a wage determination's classification schedules, with pagination metadata and navigation links.
|
|
8116
|
+
*/
|
|
8117
|
+
export type WageClassificationsResponseObject = {
|
|
8118
|
+
meta: Meta;
|
|
8119
|
+
links: Links;
|
|
7868
8120
|
/**
|
|
7869
|
-
* The
|
|
8121
|
+
* The page of wage classifications.
|
|
7870
8122
|
*/
|
|
7871
|
-
|
|
8123
|
+
data: Array<WageClassificationResponseObject>;
|
|
8124
|
+
};
|
|
8125
|
+
/**
|
|
8126
|
+
* A Davis-Bacon construction category assigned to one wage determination.
|
|
8127
|
+
*/
|
|
8128
|
+
export type ConstructionTypeResponseObject = {
|
|
7872
8129
|
/**
|
|
7873
|
-
*
|
|
8130
|
+
* Unique identifier.
|
|
8131
|
+
*/
|
|
8132
|
+
id: string;
|
|
8133
|
+
/**
|
|
8134
|
+
* ID of the wage determination carrying this construction category.
|
|
8135
|
+
*/
|
|
8136
|
+
wage_determination_id: string;
|
|
8137
|
+
/**
|
|
8138
|
+
* Davis-Bacon base construction category: BUILDING, HEAVY, HIGHWAY, or RESIDENTIAL.
|
|
8139
|
+
*/
|
|
8140
|
+
construction_type: 'BUILDING' | 'HEAVY' | 'HIGHWAY' | 'RESIDENTIAL';
|
|
8141
|
+
/**
|
|
8142
|
+
* When the record was created (ISO 8601).
|
|
8143
|
+
*/
|
|
8144
|
+
created_at: string;
|
|
8145
|
+
/**
|
|
8146
|
+
* When the record was last updated (ISO 8601).
|
|
8147
|
+
*/
|
|
8148
|
+
updated_at: string;
|
|
8149
|
+
};
|
|
8150
|
+
/**
|
|
8151
|
+
* A page of a wage determination's construction categories, with pagination metadata and navigation links.
|
|
8152
|
+
*/
|
|
8153
|
+
export type ConstructionTypesResponseObject = {
|
|
8154
|
+
meta: Meta;
|
|
8155
|
+
links: Links;
|
|
8156
|
+
/**
|
|
8157
|
+
* The page of construction types.
|
|
8158
|
+
*/
|
|
8159
|
+
data: Array<ConstructionTypeResponseObject>;
|
|
8160
|
+
};
|
|
8161
|
+
/**
|
|
8162
|
+
* A DOL project-type tag attached directly to one wage determination.
|
|
8163
|
+
*/
|
|
8164
|
+
export type ProjectTypeResponseObject = {
|
|
8165
|
+
/**
|
|
8166
|
+
* Unique identifier.
|
|
8167
|
+
*/
|
|
8168
|
+
id: string;
|
|
8169
|
+
/**
|
|
8170
|
+
* ID of the wage determination carrying this project-type tag.
|
|
8171
|
+
*/
|
|
8172
|
+
wage_determination_id: string;
|
|
8173
|
+
/**
|
|
8174
|
+
* DOL project categorization code used to narrow the work the determination covers.
|
|
8175
|
+
*/
|
|
8176
|
+
project_type: string;
|
|
8177
|
+
/**
|
|
8178
|
+
* Additional verbatim qualification printed beside the project type; null when absent.
|
|
8179
|
+
*/
|
|
8180
|
+
project_type_subtext: string | null;
|
|
8181
|
+
/**
|
|
8182
|
+
* When the record was created (ISO 8601).
|
|
8183
|
+
*/
|
|
8184
|
+
created_at: string;
|
|
8185
|
+
/**
|
|
8186
|
+
* When the record was last updated (ISO 8601).
|
|
8187
|
+
*/
|
|
8188
|
+
updated_at: string;
|
|
8189
|
+
};
|
|
8190
|
+
/**
|
|
8191
|
+
* A page of project-type tags attached directly to a wage determination, with pagination metadata and navigation links.
|
|
8192
|
+
*/
|
|
8193
|
+
export type ProjectTypesResponseObject = {
|
|
8194
|
+
meta: Meta;
|
|
8195
|
+
links: Links;
|
|
8196
|
+
/**
|
|
8197
|
+
* The page of project types.
|
|
8198
|
+
*/
|
|
8199
|
+
data: Array<ProjectTypeResponseObject>;
|
|
8200
|
+
};
|
|
8201
|
+
/**
|
|
8202
|
+
* A link between a wage determination and one geographic boundary where it applies. Includes stable boundary identity metadata but never geometry.
|
|
8203
|
+
*/
|
|
8204
|
+
export type WageDeterminationBoundaryResponseObject = {
|
|
8205
|
+
/**
|
|
8206
|
+
* Unique identifier.
|
|
8207
|
+
*/
|
|
8208
|
+
id: string;
|
|
8209
|
+
/**
|
|
8210
|
+
* ID of the wage determination whose applicability includes this boundary.
|
|
8211
|
+
*/
|
|
8212
|
+
wage_determination_id: string;
|
|
8213
|
+
/**
|
|
8214
|
+
* Stable ID of the linked geographic boundary.
|
|
8215
|
+
*/
|
|
8216
|
+
boundary_id: string;
|
|
8217
|
+
/**
|
|
8218
|
+
* Fully qualified boundary kind, such as Boundaries::Region or Boundaries::Subregion.
|
|
8219
|
+
*/
|
|
8220
|
+
boundary_type: string;
|
|
8221
|
+
/**
|
|
8222
|
+
* Government-published name of the linked boundary.
|
|
8223
|
+
*/
|
|
8224
|
+
name: string;
|
|
8225
|
+
/**
|
|
8226
|
+
* Administrative-unit identifier in the source system; null when unavailable and not necessarily globally unique.
|
|
8227
|
+
*/
|
|
8228
|
+
source_boundary_id: string | null;
|
|
8229
|
+
/**
|
|
8230
|
+
* Geographic identifier unique within the authoritative source; null when unavailable.
|
|
8231
|
+
*/
|
|
8232
|
+
source_geo_id: string | null;
|
|
8233
|
+
/**
|
|
8234
|
+
* Versioned or national stable geographic identifier from the authoritative source; null when unavailable.
|
|
8235
|
+
*/
|
|
8236
|
+
source_unique_id: string | null;
|
|
8237
|
+
/**
|
|
8238
|
+
* When the record was created (ISO 8601).
|
|
8239
|
+
*/
|
|
8240
|
+
created_at: string;
|
|
8241
|
+
/**
|
|
8242
|
+
* When the record was last updated (ISO 8601).
|
|
8243
|
+
*/
|
|
8244
|
+
updated_at: string;
|
|
8245
|
+
};
|
|
8246
|
+
/**
|
|
8247
|
+
* A page of a wage determination's geographic applicability links, with pagination metadata and navigation links.
|
|
8248
|
+
*/
|
|
8249
|
+
export type WageDeterminationBoundariesResponseObject = {
|
|
8250
|
+
meta: Meta;
|
|
8251
|
+
links: Links;
|
|
8252
|
+
/**
|
|
8253
|
+
* The page of boundary links.
|
|
8254
|
+
*/
|
|
8255
|
+
data: Array<WageDeterminationBoundaryResponseObject>;
|
|
8256
|
+
};
|
|
8257
|
+
/**
|
|
8258
|
+
* One ordered, lettered item of verbatim fringe-reference prose within a wage-classification schedule.
|
|
8259
|
+
*/
|
|
8260
|
+
export type ReferenceItemResponseObject = {
|
|
8261
|
+
/**
|
|
8262
|
+
* Unique identifier.
|
|
8263
|
+
*/
|
|
8264
|
+
id: string;
|
|
8265
|
+
/**
|
|
8266
|
+
* ID of the wage-classification schedule that owns this reference item.
|
|
8267
|
+
*/
|
|
8268
|
+
wage_classification_id: string;
|
|
8269
|
+
/**
|
|
8270
|
+
* Zero-based document order within the classification schedule.
|
|
8271
|
+
*/
|
|
8272
|
+
position: number;
|
|
8273
|
+
/**
|
|
8274
|
+
* Lowercase source token a labor rate cites, such as a or b.
|
|
8275
|
+
*/
|
|
8276
|
+
letter: string;
|
|
8277
|
+
/**
|
|
8278
|
+
* Source heading under which the item was printed: footnote, premium_pay, holidays, or zone_pay.
|
|
8279
|
+
*/
|
|
8280
|
+
container_type: 'footnote' | 'premium_pay' | 'holidays' | 'zone_pay';
|
|
8281
|
+
/**
|
|
8282
|
+
* Verbatim reference-item prose from the DOL source document.
|
|
8283
|
+
*/
|
|
8284
|
+
text: string;
|
|
8285
|
+
/**
|
|
8286
|
+
* When the record was created (ISO 8601).
|
|
8287
|
+
*/
|
|
8288
|
+
created_at: string;
|
|
8289
|
+
/**
|
|
8290
|
+
* When the record was last updated (ISO 8601).
|
|
8291
|
+
*/
|
|
8292
|
+
updated_at: string;
|
|
8293
|
+
};
|
|
8294
|
+
/**
|
|
8295
|
+
* A page of reference items flattened across every classification schedule in a wage determination, with pagination metadata and navigation links.
|
|
8296
|
+
*/
|
|
8297
|
+
export type ReferenceItemsResponseObject = {
|
|
8298
|
+
meta: Meta;
|
|
8299
|
+
links: Links;
|
|
8300
|
+
/**
|
|
8301
|
+
* The page of reference items.
|
|
8302
|
+
*/
|
|
8303
|
+
data: Array<ReferenceItemResponseObject>;
|
|
8304
|
+
};
|
|
8305
|
+
/**
|
|
8306
|
+
* A wage determination applied to a job — the prevailing-wage and fringe rates for one labor classification. The type discriminator selects the Federal or Regional representation.
|
|
8307
|
+
*/
|
|
8308
|
+
export type JobWageDeterminationResponseObject = ({
|
|
8309
|
+
type: 'Pwa::JobWageDeterminations::Federal';
|
|
8310
|
+
} & FederalJobWageDeterminationResponseObject) | ({
|
|
8311
|
+
type: 'Pwa::JobWageDeterminations::Regional';
|
|
8312
|
+
} & RegionalJobWageDeterminationResponseObject);
|
|
8313
|
+
/**
|
|
8314
|
+
* A Federal (Davis-Bacon) wage determination on a job.
|
|
8315
|
+
*/
|
|
8316
|
+
export type FederalJobWageDeterminationResponseObject = {
|
|
8317
|
+
/**
|
|
8318
|
+
* Identifier of the determination, stable across every one of its temporal versions — it addresses the determination itself, not the version you happen to be reading, and is what the member and history paths take.
|
|
8319
|
+
*/
|
|
8320
|
+
id: string;
|
|
8321
|
+
/**
|
|
8322
|
+
* ID of the job this wage determination applies to.
|
|
8323
|
+
*/
|
|
8324
|
+
job_id: string;
|
|
8325
|
+
/**
|
|
8326
|
+
* UUID of the craft grouping (trade) this determination pools into for apprenticeship-ratio tracking; obtain one from the job or project PWA trades endpoint before assigning it here.
|
|
8327
|
+
*/
|
|
8328
|
+
pwa_trade_id: string;
|
|
8329
|
+
/**
|
|
8330
|
+
* ID of the overtime package whose rules apply to this determination, or null when none is set. Not a versioned attribute: every version of the determination carries the same package, so this reads the same whatever point in time you ask for. The rules inside the package carry their own valid times.
|
|
8331
|
+
*/
|
|
8332
|
+
overtime_package_id: string | null;
|
|
8333
|
+
/**
|
|
8334
|
+
* Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
|
|
8335
|
+
*/
|
|
8336
|
+
type: 'Pwa::JobWageDeterminations::Federal';
|
|
8337
|
+
/**
|
|
8338
|
+
* Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
|
|
8339
|
+
*/
|
|
8340
|
+
labor_classification: string;
|
|
8341
|
+
/**
|
|
8342
|
+
* Base hourly wage rate, in cents as a decimal string (e.g. "5380.0" is $53.80).
|
|
8343
|
+
*/
|
|
8344
|
+
hourly_rate_cents: string;
|
|
8345
|
+
/**
|
|
8346
|
+
* Hourly fringe rate, in cents as a decimal string (e.g. "1200.0" is $12.00).
|
|
8347
|
+
*/
|
|
8348
|
+
fringe_rate_cents: string;
|
|
8349
|
+
/**
|
|
8350
|
+
* The DOL wage-classification code identifying this classification within its general decision (e.g. "LABO0324-014"); null when not recorded.
|
|
8351
|
+
*/
|
|
8352
|
+
class_code: string | null;
|
|
8353
|
+
/**
|
|
8354
|
+
* Broad DOL construction category — one of building, heavy, highway, or residential; null when not recorded.
|
|
7874
8355
|
*/
|
|
7875
8356
|
construction_category: 'building' | 'heavy' | 'highway' | 'residential' | null;
|
|
7876
8357
|
/**
|
|
@@ -8901,7 +9382,7 @@ export type AssetsVendorParameters = {
|
|
|
8901
9382
|
*/
|
|
8902
9383
|
name: string;
|
|
8903
9384
|
/**
|
|
8904
|
-
* A signed_id from POST /api/v1/direct_uploads for
|
|
9385
|
+
* A signed_id from POST /api/v1/direct_uploads registered for assets.vendors. The logo must be a readable PNG, JPEG, GIF, or HEIC image, at most 10 MiB, 20,000 pixels per side, and 50 megapixels total. An invalid logo rejects the entire create or update; the existing vendor and logo remain unchanged.
|
|
8905
9386
|
*/
|
|
8906
9387
|
logo_signed_id?: string;
|
|
8907
9388
|
};
|
|
@@ -13203,7 +13684,7 @@ export type CreateVendorErrors = {
|
|
|
13203
13684
|
*/
|
|
13204
13685
|
403: Problem;
|
|
13205
13686
|
/**
|
|
13206
|
-
* Unprocessable Content (
|
|
13687
|
+
* Unprocessable Content (invalid image)
|
|
13207
13688
|
*/
|
|
13208
13689
|
422: Problem;
|
|
13209
13690
|
};
|
|
@@ -13272,6 +13753,10 @@ export type UpdateVendorErrors = {
|
|
|
13272
13753
|
* Forbidden
|
|
13273
13754
|
*/
|
|
13274
13755
|
403: Problem;
|
|
13756
|
+
/**
|
|
13757
|
+
* Unprocessable Content (invalid logo replacement)
|
|
13758
|
+
*/
|
|
13759
|
+
422: Problem;
|
|
13275
13760
|
};
|
|
13276
13761
|
export type UpdateVendorError = UpdateVendorErrors[keyof UpdateVendorErrors];
|
|
13277
13762
|
export type UpdateVendorResponses = {
|
|
@@ -14153,6 +14638,10 @@ export type ListChecksData = {
|
|
|
14153
14638
|
'filter[job_id][null]'?: boolean;
|
|
14154
14639
|
'filter[project_id]'?: string;
|
|
14155
14640
|
'filter[compliances_requirement_id]'?: string;
|
|
14641
|
+
/**
|
|
14642
|
+
* Only checks the given person is assigned to.
|
|
14643
|
+
*/
|
|
14644
|
+
'filter[assignee_user_id]'?: string;
|
|
14156
14645
|
'filter[time_due][gte]'?: string;
|
|
14157
14646
|
'filter[time_due][lte]'?: string;
|
|
14158
14647
|
filter?: string;
|
|
@@ -14219,7 +14708,7 @@ export type GetCheckResponses = {
|
|
|
14219
14708
|
/**
|
|
14220
14709
|
* Success
|
|
14221
14710
|
*/
|
|
14222
|
-
200:
|
|
14711
|
+
200: ComplianceCheckDetailResponseObject;
|
|
14223
14712
|
};
|
|
14224
14713
|
export type GetCheckResponse = GetCheckResponses[keyof GetCheckResponses];
|
|
14225
14714
|
export type UpdateCheckData = {
|
|
@@ -14249,7 +14738,7 @@ export type UpdateCheckResponses = {
|
|
|
14249
14738
|
/**
|
|
14250
14739
|
* Success
|
|
14251
14740
|
*/
|
|
14252
|
-
200:
|
|
14741
|
+
200: ComplianceCheckDetailResponseObject;
|
|
14253
14742
|
};
|
|
14254
14743
|
export type UpdateCheckResponse = UpdateCheckResponses[keyof UpdateCheckResponses];
|
|
14255
14744
|
export type ListRequirementsData = {
|
|
@@ -15810,6 +16299,10 @@ export type ListJobsData = {
|
|
|
15810
16299
|
* Returns jobs whose status is any of the given values. Comma-separate to match multiple (e.g. `ready,completed`). Accepts each concrete status (pending_provider, pending_schedule, pending_workers, ready, disputed, completed, cancelled) plus the aggregates `pending` (any pending_* status) and `active` (ready or disputed).
|
|
15811
16300
|
*/
|
|
15812
16301
|
'filter[status]'?: string;
|
|
16302
|
+
/**
|
|
16303
|
+
* Returns jobs whose production_tracking_kind matches. One of `none`, `feature`, or `quantity`.
|
|
16304
|
+
*/
|
|
16305
|
+
'filter[production_tracking_kind]'?: 'none' | 'feature' | 'quantity';
|
|
15813
16306
|
/**
|
|
15814
16307
|
* This pagination cursor corresponds to the cursor value found in the response in
|
|
15815
16308
|
* `meta.page.next_cursor`.
|
|
@@ -19211,6 +19704,10 @@ export type UpdatePositionErrors = {
|
|
|
19211
19704
|
* Not Found
|
|
19212
19705
|
*/
|
|
19213
19706
|
404: Problem;
|
|
19707
|
+
/**
|
|
19708
|
+
* Unprocessable Content
|
|
19709
|
+
*/
|
|
19710
|
+
422: Problem;
|
|
19214
19711
|
};
|
|
19215
19712
|
export type UpdatePositionError = UpdatePositionErrors[keyof UpdatePositionErrors];
|
|
19216
19713
|
export type UpdatePositionResponses = {
|
|
@@ -21075,6 +21572,117 @@ export type GetTimeCardActualResponses = {
|
|
|
21075
21572
|
200: TimeCardActualsResponseObject;
|
|
21076
21573
|
};
|
|
21077
21574
|
export type GetTimeCardActualResponse = GetTimeCardActualResponses[keyof GetTimeCardActualResponses];
|
|
21575
|
+
export type ListTimeSessionsData = {
|
|
21576
|
+
body?: never;
|
|
21577
|
+
path?: never;
|
|
21578
|
+
query?: {
|
|
21579
|
+
/**
|
|
21580
|
+
* Returns only sessions for this worker.
|
|
21581
|
+
*/
|
|
21582
|
+
'filter[user_id]'?: string;
|
|
21583
|
+
/**
|
|
21584
|
+
* Returns only sessions clocked in against this job.
|
|
21585
|
+
*/
|
|
21586
|
+
'filter[job_id]'?: string;
|
|
21587
|
+
/**
|
|
21588
|
+
* `true` returns only sessions with no job, `false` only those with a job. Cannot be combined with `filter[job_id]`.
|
|
21589
|
+
*/
|
|
21590
|
+
'filter[job_id][null]'?: boolean;
|
|
21591
|
+
/**
|
|
21592
|
+
* `true` returns only open sessions — the workers clocked in right now; `false` only sessions that have ended.
|
|
21593
|
+
*/
|
|
21594
|
+
'filter[active]'?: boolean;
|
|
21595
|
+
'filter[start_time][gte]'?: string;
|
|
21596
|
+
'filter[start_time][lte]'?: string;
|
|
21597
|
+
'filter[created_at][gte]'?: string;
|
|
21598
|
+
'filter[created_at][lte]'?: string;
|
|
21599
|
+
'filter[updated_at][gte]'?: string;
|
|
21600
|
+
'filter[updated_at][lte]'?: string;
|
|
21601
|
+
filter?: string;
|
|
21602
|
+
'filter[unexpected]'?: string;
|
|
21603
|
+
/**
|
|
21604
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
21605
|
+
* `meta.page.next_cursor`.
|
|
21606
|
+
*/
|
|
21607
|
+
'page[cursor]'?: string;
|
|
21608
|
+
/**
|
|
21609
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
21610
|
+
*/
|
|
21611
|
+
'page[limit]'?: number;
|
|
21612
|
+
page?: string;
|
|
21613
|
+
};
|
|
21614
|
+
url: '/api/v1/timekeeping/time_sessions';
|
|
21615
|
+
};
|
|
21616
|
+
export type ListTimeSessionsErrors = {
|
|
21617
|
+
/**
|
|
21618
|
+
* Bad Request
|
|
21619
|
+
*/
|
|
21620
|
+
400: Problem;
|
|
21621
|
+
/**
|
|
21622
|
+
* Forbidden
|
|
21623
|
+
*/
|
|
21624
|
+
403: Problem;
|
|
21625
|
+
/**
|
|
21626
|
+
* Unprocessable Content
|
|
21627
|
+
*/
|
|
21628
|
+
422: Problem;
|
|
21629
|
+
};
|
|
21630
|
+
export type ListTimeSessionsError = ListTimeSessionsErrors[keyof ListTimeSessionsErrors];
|
|
21631
|
+
export type ListTimeSessionsResponses = {
|
|
21632
|
+
/**
|
|
21633
|
+
* Success
|
|
21634
|
+
*/
|
|
21635
|
+
200: TimeSessionsResponseObject;
|
|
21636
|
+
};
|
|
21637
|
+
export type ListTimeSessionsResponse = ListTimeSessionsResponses[keyof ListTimeSessionsResponses];
|
|
21638
|
+
export type GetTimeSessionData = {
|
|
21639
|
+
body?: never;
|
|
21640
|
+
path: {
|
|
21641
|
+
id: string;
|
|
21642
|
+
};
|
|
21643
|
+
query?: never;
|
|
21644
|
+
url: '/api/v1/timekeeping/time_sessions/{id}';
|
|
21645
|
+
};
|
|
21646
|
+
export type GetTimeSessionErrors = {
|
|
21647
|
+
/**
|
|
21648
|
+
* Forbidden
|
|
21649
|
+
*/
|
|
21650
|
+
403: Problem;
|
|
21651
|
+
/**
|
|
21652
|
+
* Not Found
|
|
21653
|
+
*/
|
|
21654
|
+
404: Problem;
|
|
21655
|
+
};
|
|
21656
|
+
export type GetTimeSessionError = GetTimeSessionErrors[keyof GetTimeSessionErrors];
|
|
21657
|
+
export type GetTimeSessionResponses = {
|
|
21658
|
+
/**
|
|
21659
|
+
* Success
|
|
21660
|
+
*/
|
|
21661
|
+
200: TimeSessionResponseObject;
|
|
21662
|
+
};
|
|
21663
|
+
export type GetTimeSessionResponse = GetTimeSessionResponses[keyof GetTimeSessionResponses];
|
|
21664
|
+
export type ListTodoInboxData = {
|
|
21665
|
+
body?: never;
|
|
21666
|
+
path?: never;
|
|
21667
|
+
query?: never;
|
|
21668
|
+
url: '/api/v1/todos';
|
|
21669
|
+
};
|
|
21670
|
+
export type ListTodoInboxErrors = {
|
|
21671
|
+
/**
|
|
21672
|
+
* Forbidden
|
|
21673
|
+
*/
|
|
21674
|
+
403: Problem;
|
|
21675
|
+
};
|
|
21676
|
+
export type ListTodoInboxError = ListTodoInboxErrors[keyof ListTodoInboxErrors];
|
|
21677
|
+
export type ListTodoInboxResponses = {
|
|
21678
|
+
/**
|
|
21679
|
+
* Success
|
|
21680
|
+
*/
|
|
21681
|
+
200: {
|
|
21682
|
+
data: Array<TodoInboxEntryResponseObject>;
|
|
21683
|
+
};
|
|
21684
|
+
};
|
|
21685
|
+
export type ListTodoInboxResponse = ListTodoInboxResponses[keyof ListTodoInboxResponses];
|
|
21078
21686
|
export type ListUserRolesData = {
|
|
21079
21687
|
body?: never;
|
|
21080
21688
|
path?: never;
|
|
@@ -21325,6 +21933,10 @@ export type CreateScheduledTerminationErrors = {
|
|
|
21325
21933
|
* Forbidden
|
|
21326
21934
|
*/
|
|
21327
21935
|
403: Problem;
|
|
21936
|
+
/**
|
|
21937
|
+
* Not Found
|
|
21938
|
+
*/
|
|
21939
|
+
404: Problem;
|
|
21328
21940
|
/**
|
|
21329
21941
|
* Unprocessable Content
|
|
21330
21942
|
*/
|
|
@@ -21466,9 +22078,9 @@ export type ListUsersData = {
|
|
|
21466
22078
|
path?: never;
|
|
21467
22079
|
query?: {
|
|
21468
22080
|
/**
|
|
21469
|
-
* Filter users by their
|
|
22081
|
+
* Filter users by their employment lifecycle in the company, the same vocabulary `employment_state` publishes on each user. Defaults to `active` (an employment in effect now); `scheduled` returns employments that have not begun; `terminated` returns employments that have ended, with nothing current and nothing upcoming; `none` returns people your company sees without employing, which is its role holders and its invitees; `all` returns everyone your company sees.
|
|
21470
22082
|
*/
|
|
21471
|
-
'filter[state]'?: 'active' | 'terminated' | 'all';
|
|
22083
|
+
'filter[state]'?: 'active' | 'scheduled' | 'terminated' | 'none' | 'all';
|
|
21472
22084
|
/**
|
|
21473
22085
|
* This pagination cursor corresponds to the cursor value found in the response in
|
|
21474
22086
|
* `meta.page.next_cursor`.
|
|
@@ -21601,6 +22213,113 @@ export type UpdateUserResponses = {
|
|
|
21601
22213
|
200: UserResponseObject;
|
|
21602
22214
|
};
|
|
21603
22215
|
export type UpdateUserResponse = UpdateUserResponses[keyof UpdateUserResponses];
|
|
22216
|
+
export type ListBoundariesData = {
|
|
22217
|
+
body?: never;
|
|
22218
|
+
path: {
|
|
22219
|
+
wage_determination_id: string;
|
|
22220
|
+
};
|
|
22221
|
+
query?: {
|
|
22222
|
+
'filter[id]'?: string;
|
|
22223
|
+
'filter[boundary_id]'?: string;
|
|
22224
|
+
'filter[name]'?: string;
|
|
22225
|
+
'filter[boundary_type]'?: string;
|
|
22226
|
+
'filter[source_boundary_id]'?: string;
|
|
22227
|
+
'filter[source_geo_id]'?: string;
|
|
22228
|
+
'filter[source_unique_id]'?: string;
|
|
22229
|
+
filter?: string;
|
|
22230
|
+
'filter[unexpected]'?: string;
|
|
22231
|
+
/**
|
|
22232
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
22233
|
+
* `meta.page.next_cursor`.
|
|
22234
|
+
*/
|
|
22235
|
+
'page[cursor]'?: string;
|
|
22236
|
+
/**
|
|
22237
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
22238
|
+
*/
|
|
22239
|
+
'page[limit]'?: number;
|
|
22240
|
+
page?: string;
|
|
22241
|
+
};
|
|
22242
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/boundaries';
|
|
22243
|
+
};
|
|
22244
|
+
export type ListBoundariesErrors = {
|
|
22245
|
+
/**
|
|
22246
|
+
* Bad Request
|
|
22247
|
+
*/
|
|
22248
|
+
400: Problem;
|
|
22249
|
+
/**
|
|
22250
|
+
* Forbidden
|
|
22251
|
+
*/
|
|
22252
|
+
403: Problem;
|
|
22253
|
+
/**
|
|
22254
|
+
* Not Found
|
|
22255
|
+
*/
|
|
22256
|
+
404: Problem;
|
|
22257
|
+
};
|
|
22258
|
+
export type ListBoundariesError = ListBoundariesErrors[keyof ListBoundariesErrors];
|
|
22259
|
+
export type ListBoundariesResponses = {
|
|
22260
|
+
/**
|
|
22261
|
+
* Success
|
|
22262
|
+
*/
|
|
22263
|
+
200: WageDeterminationBoundariesResponseObject;
|
|
22264
|
+
};
|
|
22265
|
+
export type ListBoundariesResponse = ListBoundariesResponses[keyof ListBoundariesResponses];
|
|
22266
|
+
export type ListConstructionTypesData = {
|
|
22267
|
+
body?: never;
|
|
22268
|
+
path: {
|
|
22269
|
+
wage_determination_id: string;
|
|
22270
|
+
};
|
|
22271
|
+
query?: {
|
|
22272
|
+
'filter[id]'?: string;
|
|
22273
|
+
/**
|
|
22274
|
+
* :
|
|
22275
|
+
* * `BUILDING`
|
|
22276
|
+
* * `HEAVY`
|
|
22277
|
+
* * `HIGHWAY`
|
|
22278
|
+
* * `RESIDENTIAL`
|
|
22279
|
+
*
|
|
22280
|
+
*/
|
|
22281
|
+
'filter[construction_type]'?: string;
|
|
22282
|
+
filter?: string;
|
|
22283
|
+
'filter[unexpected]'?: string;
|
|
22284
|
+
/**
|
|
22285
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
22286
|
+
* `meta.page.next_cursor`.
|
|
22287
|
+
*/
|
|
22288
|
+
'page[cursor]'?: string;
|
|
22289
|
+
/**
|
|
22290
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
22291
|
+
*/
|
|
22292
|
+
'page[limit]'?: number;
|
|
22293
|
+
page?: string;
|
|
22294
|
+
};
|
|
22295
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/construction_types';
|
|
22296
|
+
};
|
|
22297
|
+
export type ListConstructionTypesErrors = {
|
|
22298
|
+
/**
|
|
22299
|
+
* Bad Request
|
|
22300
|
+
*/
|
|
22301
|
+
400: Problem;
|
|
22302
|
+
/**
|
|
22303
|
+
* Forbidden
|
|
22304
|
+
*/
|
|
22305
|
+
403: Problem;
|
|
22306
|
+
/**
|
|
22307
|
+
* Not Found
|
|
22308
|
+
*/
|
|
22309
|
+
404: Problem;
|
|
22310
|
+
/**
|
|
22311
|
+
* Unsupported construction_type filter
|
|
22312
|
+
*/
|
|
22313
|
+
422: Problem;
|
|
22314
|
+
};
|
|
22315
|
+
export type ListConstructionTypesError = ListConstructionTypesErrors[keyof ListConstructionTypesErrors];
|
|
22316
|
+
export type ListConstructionTypesResponses = {
|
|
22317
|
+
/**
|
|
22318
|
+
* Success
|
|
22319
|
+
*/
|
|
22320
|
+
200: ConstructionTypesResponseObject;
|
|
22321
|
+
};
|
|
22322
|
+
export type ListConstructionTypesResponse = ListConstructionTypesResponses[keyof ListConstructionTypesResponses];
|
|
21604
22323
|
export type ListLaborRatesData = {
|
|
21605
22324
|
body?: never;
|
|
21606
22325
|
path: {
|
|
@@ -21648,6 +22367,162 @@ export type ListLaborRatesResponses = {
|
|
|
21648
22367
|
200: LaborRatesResponseObject;
|
|
21649
22368
|
};
|
|
21650
22369
|
export type ListLaborRatesResponse = ListLaborRatesResponses[keyof ListLaborRatesResponses];
|
|
22370
|
+
export type ListProjectTypesData = {
|
|
22371
|
+
body?: never;
|
|
22372
|
+
path: {
|
|
22373
|
+
wage_determination_id: string;
|
|
22374
|
+
};
|
|
22375
|
+
query?: {
|
|
22376
|
+
'filter[id]'?: string;
|
|
22377
|
+
'filter[project_type]'?: string;
|
|
22378
|
+
'filter[project_type_subtext]'?: string;
|
|
22379
|
+
filter?: string;
|
|
22380
|
+
'filter[unexpected]'?: string;
|
|
22381
|
+
/**
|
|
22382
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
22383
|
+
* `meta.page.next_cursor`.
|
|
22384
|
+
*/
|
|
22385
|
+
'page[cursor]'?: string;
|
|
22386
|
+
/**
|
|
22387
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
22388
|
+
*/
|
|
22389
|
+
'page[limit]'?: number;
|
|
22390
|
+
page?: string;
|
|
22391
|
+
};
|
|
22392
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/project_types';
|
|
22393
|
+
};
|
|
22394
|
+
export type ListProjectTypesErrors = {
|
|
22395
|
+
/**
|
|
22396
|
+
* Bad Request
|
|
22397
|
+
*/
|
|
22398
|
+
400: Problem;
|
|
22399
|
+
/**
|
|
22400
|
+
* Forbidden
|
|
22401
|
+
*/
|
|
22402
|
+
403: Problem;
|
|
22403
|
+
/**
|
|
22404
|
+
* Not Found
|
|
22405
|
+
*/
|
|
22406
|
+
404: Problem;
|
|
22407
|
+
};
|
|
22408
|
+
export type ListProjectTypesError = ListProjectTypesErrors[keyof ListProjectTypesErrors];
|
|
22409
|
+
export type ListProjectTypesResponses = {
|
|
22410
|
+
/**
|
|
22411
|
+
* Success
|
|
22412
|
+
*/
|
|
22413
|
+
200: ProjectTypesResponseObject;
|
|
22414
|
+
};
|
|
22415
|
+
export type ListProjectTypesResponse = ListProjectTypesResponses[keyof ListProjectTypesResponses];
|
|
22416
|
+
export type ListReferenceItemsData = {
|
|
22417
|
+
body?: never;
|
|
22418
|
+
path: {
|
|
22419
|
+
wage_determination_id: string;
|
|
22420
|
+
};
|
|
22421
|
+
query?: {
|
|
22422
|
+
'filter[id]'?: string;
|
|
22423
|
+
'filter[wage_classification_id]'?: string;
|
|
22424
|
+
'filter[position]'?: number;
|
|
22425
|
+
'filter[letter]'?: string;
|
|
22426
|
+
/**
|
|
22427
|
+
* :
|
|
22428
|
+
* * `footnote`
|
|
22429
|
+
* * `premium_pay`
|
|
22430
|
+
* * `holidays`
|
|
22431
|
+
* * `zone_pay`
|
|
22432
|
+
*
|
|
22433
|
+
*/
|
|
22434
|
+
'filter[container_type]'?: string;
|
|
22435
|
+
filter?: string;
|
|
22436
|
+
'filter[unexpected]'?: string;
|
|
22437
|
+
/**
|
|
22438
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
22439
|
+
* `meta.page.next_cursor`.
|
|
22440
|
+
*/
|
|
22441
|
+
'page[cursor]'?: string;
|
|
22442
|
+
/**
|
|
22443
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
22444
|
+
*/
|
|
22445
|
+
'page[limit]'?: number;
|
|
22446
|
+
page?: string;
|
|
22447
|
+
};
|
|
22448
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/reference_items';
|
|
22449
|
+
};
|
|
22450
|
+
export type ListReferenceItemsErrors = {
|
|
22451
|
+
/**
|
|
22452
|
+
* Bad Request
|
|
22453
|
+
*/
|
|
22454
|
+
400: Problem;
|
|
22455
|
+
/**
|
|
22456
|
+
* Forbidden
|
|
22457
|
+
*/
|
|
22458
|
+
403: Problem;
|
|
22459
|
+
/**
|
|
22460
|
+
* Not Found
|
|
22461
|
+
*/
|
|
22462
|
+
404: Problem;
|
|
22463
|
+
/**
|
|
22464
|
+
* Unsupported container_type filter
|
|
22465
|
+
*/
|
|
22466
|
+
422: Problem;
|
|
22467
|
+
};
|
|
22468
|
+
export type ListReferenceItemsError = ListReferenceItemsErrors[keyof ListReferenceItemsErrors];
|
|
22469
|
+
export type ListReferenceItemsResponses = {
|
|
22470
|
+
/**
|
|
22471
|
+
* Success
|
|
22472
|
+
*/
|
|
22473
|
+
200: ReferenceItemsResponseObject;
|
|
22474
|
+
};
|
|
22475
|
+
export type ListReferenceItemsResponse = ListReferenceItemsResponses[keyof ListReferenceItemsResponses];
|
|
22476
|
+
export type ListWageClassificationsData = {
|
|
22477
|
+
body?: never;
|
|
22478
|
+
path: {
|
|
22479
|
+
wage_determination_id: string;
|
|
22480
|
+
};
|
|
22481
|
+
query?: {
|
|
22482
|
+
'filter[id]'?: string;
|
|
22483
|
+
'filter[identifier]'?: string;
|
|
22484
|
+
'filter[date]'?: string;
|
|
22485
|
+
filter?: string;
|
|
22486
|
+
'filter[unexpected]'?: string;
|
|
22487
|
+
/**
|
|
22488
|
+
* This pagination cursor corresponds to the cursor value found in the response in
|
|
22489
|
+
* `meta.page.next_cursor`.
|
|
22490
|
+
*/
|
|
22491
|
+
'page[cursor]'?: string;
|
|
22492
|
+
/**
|
|
22493
|
+
* Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
|
|
22494
|
+
*/
|
|
22495
|
+
'page[limit]'?: number;
|
|
22496
|
+
page?: string;
|
|
22497
|
+
};
|
|
22498
|
+
url: '/api/v1/wage_determinations/{wage_determination_id}/wage_classifications';
|
|
22499
|
+
};
|
|
22500
|
+
export type ListWageClassificationsErrors = {
|
|
22501
|
+
/**
|
|
22502
|
+
* Bad Request
|
|
22503
|
+
*/
|
|
22504
|
+
400: Problem;
|
|
22505
|
+
/**
|
|
22506
|
+
* Forbidden
|
|
22507
|
+
*/
|
|
22508
|
+
403: Problem;
|
|
22509
|
+
/**
|
|
22510
|
+
* Not Found
|
|
22511
|
+
*/
|
|
22512
|
+
404: Problem;
|
|
22513
|
+
/**
|
|
22514
|
+
* Unprocessable Content
|
|
22515
|
+
*/
|
|
22516
|
+
422: Problem;
|
|
22517
|
+
};
|
|
22518
|
+
export type ListWageClassificationsError = ListWageClassificationsErrors[keyof ListWageClassificationsErrors];
|
|
22519
|
+
export type ListWageClassificationsResponses = {
|
|
22520
|
+
/**
|
|
22521
|
+
* Success
|
|
22522
|
+
*/
|
|
22523
|
+
200: WageClassificationsResponseObject;
|
|
22524
|
+
};
|
|
22525
|
+
export type ListWageClassificationsResponse = ListWageClassificationsResponses[keyof ListWageClassificationsResponses];
|
|
21651
22526
|
export type ListWageDeterminationsData = {
|
|
21652
22527
|
body?: never;
|
|
21653
22528
|
path?: never;
|