@dsptch-work/api-client 0.25.0 → 0.26.0

package/dist/gen/zod.gen.js

@@ -136,6 +136,12 @@ export const zProblem = z.object({
  *
  * The credential is valid, but this action on this record is refused by policy. The operation is not available to this principal.
  *
+ * ### forbidden_key
+ *
+ * **Field Not Writable By Key**
+ *
+ * The request body carries a field the operation accepts, but the user this user-scoped API key acts for may not write it, as their role could not in the DSPTCH app. Nothing was written. Remove the fields the detail names, or send the write with a key whose user may write them.
+ *
  * ### insufficient_api_key_scope
  *
  * **Insufficient API Key Scope**
@@ -364,6 +370,7 @@ export const zProblemTypeCatalog = z.enum([
     'unauthorized',
     'company_scoped_key_required',
     'forbidden',
+    'forbidden_key',
     'insufficient_api_key_scope',
     'user_scoped_key_required',
     'not_found',
@@ -715,7 +722,7 @@ export const zApprenticeshipProgramEmployerParameters = z.object({
     require_timecard_allocation: z.boolean().optional()
 });
 /**
- * Update an employer authorization in a program. Send only the fields to change; only the program's sponsor may manage this roster, and an API key may change only the row naming its own company.
+ * Update an employer authorization in a program. Send only the fields to change; only the program's sponsor may manage this roster, and a company-scoped key may change only the row naming its own company.
  */
 export const zApprenticeshipProgramEmployerUpdateParameters = z.object({
     company_id: z.string().optional(),
@@ -1004,10 +1011,6 @@ export const zPeopleEmploymentUpdateParameters = z.object({
     payroll_id: z.string().nullish(),
     enrolled_in_t_and_a: z.boolean().optional()
 });
-export const zPeopleEmploymentCustomFieldResponseObject = z.object({
-    custom_field_config_id: z.string(),
-    value: z.string().nullable()
-});
 /**
  * Update stored custom-field values for one employment family in a single batch. The batch must contain at least one row. Omitted configurations keep their values, and an explicit null is stored.
  */
@@ -1748,7 +1751,7 @@ export const zPwaCompanyUserDetailsResponseObject = z.object({
     ])).nullable()
 });
 /**
- * Create a worker's PWA compliance details at a company. The company is taken from the API key. user_id names the worker and is required; every other field is optional — send whichever your jurisdiction's certified-payroll export requires. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
+ * Create a worker's PWA compliance details at a company. The company is taken from the API key. user_id names the worker and is required; every other field is optional — send whichever your jurisdiction's certified-payroll export requires.
  */
 export const zPwaCompanyUserDetailsParameters = z.object({
     user_id: z.string(),
@@ -1841,7 +1844,7 @@ export const zPwaCompanyUserDetailsParameters = z.object({
     ])).nullish()
 });
 /**
- * Update a worker's PWA compliance details. The company is taken from the API key. Every field is optional — send only what changes, and omitted fields are left unchanged. user_id is absent by design — the company/user pair is fixed at creation, so sending the key is rejected with 400 unknown_key, as is any other key not listed here.
+ * Update a worker's PWA compliance details. The company is taken from the API key. Every field is optional — send only what changes, and omitted fields are left unchanged. The company/user pair is fixed at creation.
  */
 export const zPwaCompanyUserDetailsUpdateParameters = z.object({
     address1: z.string().nullish(),
@@ -2121,7 +2124,6 @@ export const zManagerTimeEntryApprovalParameters = z.object({
  * The time-entry body fields shared by the create and update bodies; each of those declares its own requiredness.
  */
 export const zTimeEntryParameters = z.object({
-    timekeeping_time_card_id: z.string().optional(),
     start_time: z.iso.datetime().optional(),
     end_time: z.iso.datetime().optional(),
     job_id: z.string().nullish(),
@@ -2132,9 +2134,10 @@ export const zTimeEntryParameters = z.object({
     feature_ids: z.array(z.string()).nullish()
 });
 /**
- * Request body for creating a time entry — the time_entry_parameters fields, of which timekeeping_time_card_id, start_time, and end_time are required, plus the explicit "no feature" acknowledgement.
+ * Request body for creating a time entry — the time_entry_parameters fields plus the time card and the explicit "no feature" acknowledgement. timekeeping_time_card_id, start_time, and end_time are required.
  */
 export const zTimeEntryCreateParameters = zTimeEntryParameters.and(z.object({
+    timekeeping_time_card_id: z.string(),
     feature_allocation_acknowledged: z.boolean().nullish()
 }));
 /**
@@ -2143,6 +2146,25 @@ export const zTimeEntryCreateParameters = zTimeEntryParameters.and(z.object({
 export const zTimeEntryUpdateParameters = zTimeEntryParameters.and(z.object({
     confirm_allocation_conflict: z.boolean().nullish()
 }));
+/**
+ * A form definition — a SurveyJS form template built and versioned in the web app's form builder. The same object the list door serializes. Read-only.
+ */
+export const zFormDefinitionObject = z.object({
+    id: z.string(),
+    name: z.string(),
+    description: z.string(),
+    company_id: z.string(),
+    modified_by_user_id: z.string().nullable(),
+    tags: z.array(z.string()).nullable(),
+    title_keys: z.array(z.string()).nullable(),
+    editable: z.boolean(),
+    always_visible: z.boolean(),
+    sensitive_form: z.boolean(),
+    allow_carry_forward: z.boolean(),
+    current_revision: z.int().nullable(),
+    json: z.record(z.string(), z.unknown()),
+    created_at: z.iso.datetime()
+});
 /**
  * A single form submission — a user's completed SurveyJS form with the resolved answers (the fuller show representation). Read-only; submissions are created in the app.
  */
@@ -2379,6 +2401,13 @@ export const zCompanyParameters = z.intersection(z.union([
     naics_code: z.string().nullish(),
     linkedin_url: z.string().nullish()
 }));
+/**
+ * A custom-field value stored on a record, addressed by the configuration it belongs to.
+ */
+export const zCustomFieldResponseObject = z.object({
+    custom_field_config_id: z.string(),
+    value: z.string().nullable()
+});
 /**
  * A custom field definition — a company-defined attribute attached to one kind of record (jobs, workers, apprentices, or the company itself). Deleting one is blocked while any record still holds a value for it.
  */
@@ -2446,10 +2475,9 @@ export const zTimeCardStartDay = z.union([
     z.literal(6)
 ]);
 /**
- * Fields shared by job creation and updates. Updates may omit any field to preserve its current value. The resulting job must still satisfy its schedule and PWA validation rules. Extra keys are accepted, including custom fields.
+ * Fields shared by job creation and updates. Updates may omit any field to preserve its current value. The resulting job must still satisfy its schedule and PWA validation rules.
  */
 export const zJobParameters = z.object({
-    template_id: z.string().nullish(),
     name: z.string().nullish(),
     description: z.string().optional(),
     requested_by_company_id: z.string().optional(),
@@ -2508,10 +2536,6 @@ export const zJobParameters = z.object({
         verified: z.boolean().nullish(),
         label: z.string().nullish()
     }).nullish(),
-    custom_fields_attributes: z.array(z.object({
-        custom_field_config_id: z.string(),
-        value: z.string().nullish()
-    })).nullish(),
     pwa_details: z.object({
         contractor_type: z.enum(['prime_contractor', 'sub_contractor']).nullish(),
         pay_full_cash_fringe_by_default: z.boolean().optional(),
@@ -2532,18 +2556,28 @@ export const zJobParameters = z.object({
     }).optional()
 });
 /**
- * Parameters for creating a job. `requested_by_company_id` and `created_by_user_id` are required. Sets the job's schedule, work types, address, and optional Prevailing Wage / Apprenticeship (PWA) compliance.
+ * Parameters for creating a job. `requested_by_company_id` and `created_by_user_id` are required. Sets the job's schedule, work types, address, custom-field values, and optional Prevailing Wage / Apprenticeship (PWA) compliance.
  */
-export const zJobCreateParameters = zJobParameters.and(z.record(z.string(), z.unknown()));
+export const zJobCreateParameters = zJobParameters.and(z.object({
+    template_id: z.string().nullish(),
+    custom_fields: z.array(z.object({
+        custom_field_config_id: z.string(),
+        value: z.string().nullable()
+    })).optional()
+}));
 /**
- * Parameters for updating an existing job. Every field is optional; omit a field to preserve its current value. The resulting job must still satisfy schedule and PWA validation rules. Accepts every shared job field plus a directly settable status.
+ * Parameters for updating an existing job. Every field is optional; omit a field to preserve its current value. The resulting job must still satisfy schedule and PWA validation rules. Accepts every shared job field plus a directly settable status and custom-field changes.
  */
 export const zJobUpdateParameters = zJobParameters.and(z.object({
     status: z.enum([
         'completed',
         'cancelled',
         'disputed'
-    ]).optional()
+    ]).optional(),
+    custom_fields: z.array(z.object({
+        custom_field_config_id: z.string(),
+        value: z.string().nullable()
+    })).optional()
 }));
 /**
  * One version of a worker's compensation at your company, effective from its start date until the next version begins.
@@ -2998,7 +3032,6 @@ export const zPayrollFringeBenefitPlanParameters = z.object({
  * Request body for updating a fringe-benefit plan. Send only the fields to change.
  */
 export const zPayrollFringeBenefitPlanUpdateParameters = z.object({
-    timekeeping_pay_period_config_id: z.string().optional(),
     name: z.string().optional(),
     plan_number: z.string().optional(),
     funded: z.boolean().optional(),
@@ -3143,7 +3176,7 @@ export const zPayrollRunResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Create a payroll run. company_id, run_type, and run_date are required; an on-cycle run additionally requires timekeeping_pay_period_id. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
+ * Create a payroll run. company_id, run_type, and run_date are required; an on-cycle run additionally requires timekeeping_pay_period_id.
  */
 export const zPayrollRunParameters = z.object({
     company_id: z.string(),
@@ -3161,7 +3194,7 @@ export const zPayrollRunParameters = z.object({
     external_id: z.string().nullish()
 });
 /**
- * Update a payroll run. Every field is optional — send only what changes. company_id is absent by design — the run's company is fixed at creation, so sending the key is rejected with 400 unknown_key, as is any other key not listed here.
+ * Update a payroll run. Every field is optional — send only what changes. The run's company is fixed at creation.
  */
 export const zPayrollRunUpdateParameters = z.object({
     timekeeping_pay_period_id: z.string().nullish(),
@@ -3261,7 +3294,6 @@ export const zProjectUpdateParameters = z.object({
     external_id: z.string().nullish(),
     name: z.string().optional(),
     description: z.string().nullish(),
-    created_by_user_id: z.string().nullish(),
     parent_id: z.string().nullish(),
     participating_company_ids: z.array(z.string()).optional(),
     start_date: z.iso.date().nullish(),
@@ -3290,6 +3322,27 @@ export const zProjectUpdateParameters = z.object({
     beginning_of_construction_date: z.iso.date().nullish(),
     placed_in_service_date: z.iso.date().nullish()
 });
+/**
+ * A project–site assignment: the join linking a project to a site, optionally scoping which of that site's features apply. Path `{id}` is this join's id, not the Site's. Not included on project GET.
+ */
+export const zProjectSiteResponseObject = z.object({
+    id: z.string(),
+    site_id: z.string(),
+    feature_ids: z.array(z.string())
+});
+/**
+ * Request body for attaching a site to a project. `site_id` is required; `feature_ids` is optional. The project is taken from the path and is not part of the body.
+ */
+export const zProjectSiteParameters = z.object({
+    site_id: z.string(),
+    feature_ids: z.array(z.string()).optional()
+});
+/**
+ * Request body for replacing which of the site's features apply to this project. Every field is optional; omit a field to preserve its current value. `site_id` is create-only and an update that names it is rejected.
+ */
+export const zProjectSiteUpdateParameters = z.object({
+    feature_ids: z.array(z.string()).optional()
+});
 export const zSiteCheckInResponseObject = z.object({
     id: z.string(),
     site_id: z.string(),
@@ -3806,8 +3859,8 @@ export const zPaystubResponseObject = z.object({
  * Request body for creating a paystub. payrolls_payroll_run_id and user_id are required; timekeeping_time_card_id is required for an on-cycle run and disallowed for an off-cycle run.
  */
 export const zPaystubParameters = z.object({
-    payrolls_payroll_run_id: z.string(),
     user_id: z.string(),
+    payrolls_payroll_run_id: z.string(),
     timekeeping_time_card_id: z.string().nullish(),
     external_id: z.string().nullish(),
     check_number: z.string().nullish()
@@ -3817,7 +3870,6 @@ export const zPaystubParameters = z.object({
  */
 export const zPaystubUpdateParameters = z.object({
     payrolls_payroll_run_id: z.string().optional(),
-    user_id: z.string().optional(),
     timekeeping_time_card_id: z.string().nullish(),
     external_id: z.string().nullish(),
     check_number: z.string().nullish()
@@ -3862,6 +3914,21 @@ export const zPriorPeriodAdjustmentParameters = z.object({
     notes: z.string().nullish(),
     pwa_compliance_eligible: z.boolean().optional()
 });
+/**
+ * Request body for updating a prior period adjustment. Send only the fields to change. The time card is the path parent; payrolls_paystub_line_item_id, created_by_user_id, time_card_id, and adjustment_type are rejected.
+ */
+export const zPriorPeriodAdjustmentUpdateParameters = z.object({
+    amount_cents: z.string().optional(),
+    rationale: z.enum([
+        'hours_correction',
+        'other',
+        'pwa_compliance',
+        'rate_correction'
+    ]).optional(),
+    job_id: z.string().nullish(),
+    notes: z.string().nullish(),
+    pwa_compliance_eligible: z.boolean().optional()
+});
 /**
  * What one PWA-tracked job on a time card still owes the worker, from the materialized prevailing-wage compliance view. Read-only.
  */
@@ -3998,6 +4065,27 @@ export const zPaystubLineItemUpdateParameters = z.object({
     contributor: z.enum(['employee', 'employer']).optional(),
     payrolls_external_map_id: z.string().optional()
 });
+/**
+ * A job-site join — the Site attached to a Job, plus the subset of that site's features the job is working on. `{id}` is the join row, not the Site.
+ */
+export const zJobSiteResponseObject = z.object({
+    id: z.string(),
+    site_id: z.string(),
+    feature_ids: z.array(z.string())
+});
+/**
+ * Request body for attaching a site to a job. `site_id` is required; `feature_ids` is optional and defaults to none.
+ */
+export const zJobSiteParameters = z.object({
+    site_id: z.string(),
+    feature_ids: z.array(z.string()).optional()
+});
+/**
+ * Request body for replacing the features on an existing job-site join. `site_id` cannot be changed; send a new join to attach a different site.
+ */
+export const zJobSiteUpdateParameters = z.object({
+    feature_ids: z.array(z.string()).optional()
+});
 /**
  * A company-owned collection of conditional wage and fringe adjustments, optionally scoped to a job.
  */
@@ -4072,8 +4160,8 @@ export const zProductionJobScopePriceResponseObject = z.object({
     job_id: z.string(),
     scope_kind: z.string(),
     unit_of_measure: z.string(),
-    unit_price: z.string(),
-    contracted_count: z.int().nullable(),
+    unit_price: z.string().optional(),
+    contracted_count: z.int().nullish(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
@@ -4182,7 +4270,7 @@ export const zFormAssignmentTaskResponseObject = z.array(z.object({
     }))
 }));
 /**
- * Request body for creating a certification — a named qualification a worker can hold. You can only manage your own company's certifications; global (platform) certifications are read-only. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
+ * Request body for creating a certification — a named qualification a worker can hold. You can only manage your own company's certifications; global (platform) certifications are read-only.
  */
 export const zCertificationParameters = z.object({
     company_id: z.string(),
@@ -4192,7 +4280,7 @@ export const zCertificationParameters = z.object({
     duration: z.string().nullish()
 });
 /**
- * Request body for updating a certification — a named qualification a worker can hold. Include only the fields to change. You can only manage your own company's certifications; global (platform) certifications are read-only. company_id is absent by design — the certification's company is fixed at creation, so sending the key is rejected with 400 unknown_key, as is any other key not listed here.
+ * Request body for updating a certification — a named qualification a worker can hold. Include only the fields to change. You can only manage your own company's certifications; global (platform) certifications are read-only. The certification's company is fixed at creation.
  */
 export const zCertificationUpdateParameters = z.object({
     name: z.string().optional(),
@@ -4215,7 +4303,7 @@ export const zCertificationPackageResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Request body for creating a certification package — a named set of certifications a company requires together. The package belongs to the company that owns the API key. Only the keys listed here are accepted — any other key is rejected with 400 unknown_key.
+ * Request body for creating a certification package — a named set of certifications a company requires together. The package belongs to the company that owns the API key.
  */
 export const zCertificationPackageParameters = z.object({
     name: z.string(),
@@ -4224,7 +4312,7 @@ export const zCertificationPackageParameters = z.object({
     performed_by_user_id: z.string()
 });
 /**
- * Request body for updating a certification package — a named set of certifications a company requires together. Include only the fields to change. Any key not listed here is rejected with 400 unknown_key.
+ * Request body for updating a certification package — a named set of certifications a company requires together. Include only the fields to change.
  */
 export const zCertificationPackageUpdateParameters = z.object({
     name: z.string().optional(),
@@ -4259,12 +4347,10 @@ export const zUserCertificationParameters = z.object({
     verified: z.boolean().optional(),
     expiration_date: z.iso.date().nullish(),
     credential_id: z.string().nullish(),
-    approved_by_user_id: z.string().nullish(),
-    archived_at: z.iso.datetime().nullish(),
-    approved_at: z.iso.datetime().nullish()
+    archived_at: z.iso.datetime().nullish()
 });
 /**
- * Request body for updating a certification held by a worker. Every field is optional; omit a field to preserve its current value. The resulting certification must still have a receipt date and verification state, and any expiry date must remain after its receipt date.
+ * Request body for updating a certification held by a worker. Every field is optional; omit a field to preserve its current value. The resulting certification must still have a receipt date and verification state, and any expiry date must remain after its receipt date. Changing anything but verified revokes an approval; approve through the approval endpoint.
  */
 export const zUserCertificationUpdateParameters = z.object({
     user_id: z.string().optional(),
@@ -4277,9 +4363,13 @@ export const zUserCertificationUpdateParameters = z.object({
     verified: z.boolean().optional(),
     expiration_date: z.iso.date().nullish(),
     credential_id: z.string().nullish(),
-    approved_by_user_id: z.string().nullish(),
-    archived_at: z.iso.datetime().nullish(),
-    approved_at: z.iso.datetime().nullish()
+    archived_at: z.iso.datetime().nullish()
+});
+/**
+ * Request body for approving a certification held by a worker. A user key approves in its own user's name and sends no body.
+ */
+export const zUserCertificationApprovalParameters = z.object({
+    approved_by_user_id: z.string().optional()
 });
 /**
  * A certification held by a worker — the record that a worker earned a certification, with its receipt date, optional expiry, and verification state.
@@ -4386,7 +4476,8 @@ export const zJobResponseObject = z.object({
         'none',
         'feature',
         'quantity'
-    ])
+    ]),
+    custom_fields: z.array(zCustomFieldResponseObject)
 });
 /**
  * A spot to be filled on a job — one worker's assignment and the unit against which they track time, carrying the schedule window, assigned worker, function, and the planned pay and fringe rates (including PWA prevailing-wage compliance rates). Always accessed nested under a job.
@@ -4452,7 +4543,7 @@ export const zUserRoleResponse = z.object({
  */
 export const zUserCompanyType = z.enum(['EMPLOYEE', 'CONTRACTOR']).nullable();
 /**
- * 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.
+ * 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 and custom_fields) are null 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.
  */
 export const zUserResponseObject = z.object({
     id: z.string(),
@@ -4486,10 +4577,10 @@ export const zUserResponseObject = z.object({
     enrolled_in_t_and_a: z.boolean().nullable(),
     payroll_id: z.string().nullable(),
     compensation_type: z.string().nullable(),
-    hourly_rate: z.string().nullable(),
-    training_annual_amount: z.string().nullable(),
-    employer_combined_health_amount: z.string().nullable(),
-    employer_combined_savings: z.string().nullable(),
+    hourly_rate: z.string().nullish(),
+    training_annual_amount: z.string().nullish(),
+    employer_combined_health_amount: z.string().nullish(),
+    employer_combined_savings: z.string().nullish(),
     worked_annual_minutes: z.int().nullable(),
     pto_annual_minutes: z.int().nullable(),
     holiday_annual_minutes: z.int().nullable(),
@@ -4501,6 +4592,7 @@ export const zUserResponseObject = z.object({
         valid_to: z.iso.datetime().nullable()
     }).nullable(),
     manager_user_id: z.string().nullable(),
+    custom_fields: z.array(zCustomFieldResponseObject).nullable(),
     roles: z.array(z.string()),
     company_user_pwa_info: z.object({
         id: z.string(),
@@ -4582,7 +4674,6 @@ export const zUserParameters = z.intersection(z.union([
         skip_invite: z.literal(true)
     })
 ]), z.object({
-    company_id: z.string().optional(),
     email: z.string().nullish(),
     personal_email: z.string().nullish(),
     phone_number: z.string().nullish(),
@@ -4607,6 +4698,7 @@ export const zUserParameters = z.intersection(z.union([
     manager_user_id: z.string().optional(),
     payroll_id: z.string().optional(),
     hourly_rate: z.string().optional(),
+    compensation_type: z.enum(['hourly', 'salary']).optional(),
     overtime_eligible: z.string().optional(),
     enrolled_in_t_and_a: z.string().optional(),
     training_annual_amount: z.string().optional(),
@@ -4618,6 +4710,10 @@ export const zUserParameters = z.intersection(z.union([
     training_annual_minutes: z.string().optional(),
     hire_date: z.string().optional(),
     group_ids: z.array(z.int()).optional(),
+    custom_fields: z.array(z.object({
+        custom_field_config_id: z.string(),
+        value: z.string().nullable()
+    })).optional(),
     company_user_pwa_info: z.object({
         address1: z.string().nullish(),
         address2: z.string().nullish(),
@@ -4687,7 +4783,7 @@ export const zUserParameters = z.intersection(z.union([
     }).nullish()
 }));
 /**
- * Request body for updating a worker's employment at your company. Corrects administrative fields (employment type, title, manager, payroll id, hire date, and time-and-attendance enrollment) across the whole employment history. For time-effective pay changes, use the scheduled-changes endpoints instead.
+ * Request body for updating a worker's employment at your company. Corrects administrative fields (employment type, title, manager, payroll id, hire date, and time-and-attendance enrollment) across the whole employment history, and changes the custom-field values it lists. For time-effective pay changes, use the scheduled-changes endpoints instead.
  */
 export const zUserCompanyParameters = z.object({
     type: zUserCompanyType.optional(),
@@ -4695,10 +4791,14 @@ export const zUserCompanyParameters = z.object({
     manager_user_id: z.string().nullish(),
     payroll_id: z.string().nullish(),
     hire_date: z.string().nullish(),
-    enrolled_in_t_and_a: z.boolean().optional()
+    enrolled_in_t_and_a: z.boolean().optional(),
+    custom_fields: z.array(z.object({
+        custom_field_config_id: z.string(),
+        value: z.string().nullable()
+    })).optional()
 });
 /**
- * Request body for adding a worker to your company, creating their employment record. hire_date is required and sets when employment begins; the remaining fields seed the initial title, pay, benefits, and accruals. Returns the worker with the new employment flattened onto it.
+ * Request body for adding a worker to your company, creating their employment record and its custom-field values. hire_date is required and sets when employment begins; the remaining fields seed the initial title, pay, benefits, and accruals. Returns the worker with the new employment flattened onto it.
  */
 export const zUserCompanyCreateParameters = z.object({
     hire_date: z.string(),
@@ -4716,7 +4816,11 @@ export const zUserCompanyCreateParameters = z.object({
     worked_annual_minutes: z.int().nullish(),
     pto_annual_minutes: z.int().nullish(),
     holiday_annual_minutes: z.int().nullish(),
-    training_annual_minutes: z.int().nullish()
+    training_annual_minutes: z.int().nullish(),
+    custom_fields: z.array(z.object({
+        custom_field_config_id: z.string(),
+        value: z.string().nullable()
+    })).optional()
 });
 /**
  * Keyset pagination cursors for the collection.
@@ -4760,22 +4864,7 @@ export const zTimeEntryIndexObject = z.object({
 export const zFormDefinitionResponseObject = z.object({
     meta: zMeta,
     links: zLinks,
-    data: z.array(z.object({
-        id: z.string(),
-        name: z.string(),
-        description: z.string(),
-        company_id: z.string(),
-        modified_by_user_id: z.string().nullable(),
-        tags: z.array(z.string()).nullable(),
-        title_keys: z.array(z.string()).nullable(),
-        editable: z.boolean(),
-        always_visible: z.boolean(),
-        sensitive_form: z.boolean(),
-        allow_carry_forward: z.boolean(),
-        current_revision: z.int().nullable(),
-        json: z.record(z.string(), z.unknown()),
-        created_at: z.iso.datetime()
-    }))
+    data: z.array(zFormDefinitionObject)
 });
 /**
  * A page of form submissions — the lighter list representation. A submission is a user's completed form; submissions are created in the app, so this API is read-only.
@@ -4885,6 +4974,14 @@ export const zPaystubLineItemsResponseObject = z.object({
     links: zLinks,
     data: z.array(zPaystubLineItemResponseObject)
 });
+/**
+ * A page of a job's site joins, with pagination metadata and navigation links.
+ */
+export const zJobSitesResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zJobSiteResponseObject)
+});
 /**
  * A page of a job's positions, with pagination metadata and navigation links.
  */
@@ -6040,7 +6137,7 @@ export const zAssetsItemParameters = z.object({
     performed_by_user_id: z.string()
 });
 /**
- * Update an asset item. All item fields are optional — send only what changes — but performed_by_user_id is required to record the updater and any placement. Omitted attributes retain their existing values.
+ * Update an asset item. All item fields are optional — send only what changes — but performed_by_user_id is required to record the updater. Omitted attributes retain their existing values.
  */
 export const zAssetsItemUpdateParameters = z.object({
     name: z.string().min(1).optional(),
@@ -6053,10 +6150,6 @@ export const zAssetsItemUpdateParameters = z.object({
     external_id: z.string().optional(),
     external_system_url: z.string().optional(),
     images_attributes: z.array(zAssetsAttachmentParameters).optional(),
-    assets_site_id: z.string().optional(),
-    user_id: z.string().optional(),
-    container_item_id: z.string().optional(),
-    assets_sub_location_id: z.string().optional(),
     performed_by_user_id: z.string()
 });
 /**
@@ -6137,7 +6230,7 @@ export const zAssetsItemFormAssignmentResponseObject = z.object({
     }))
 });
 /**
- * Create or update an item form assignment. form_definition_id and task_attributes are required, and task_attributes.created_by_user_id is required (a missing value returns 400). recurring gates the recurrence fields.
+ * Create an item form assignment. form_definition_id and task_attributes are required, and task_attributes.created_by_user_id is required (a missing value returns 400). recurring gates the recurrence fields. An assignee outside the credential company returns 422, and a creator outside it returns 403.
  */
 export const zAssetsItemFormAssignmentParameters = z.object({
     form_definition_id: z.string(),
@@ -6146,7 +6239,6 @@ export const zAssetsItemFormAssignmentParameters = z.object({
         name: z.string().nullish(),
         description: z.string().nullish(),
         created_by_user_id: z.string(),
-        updated_by_user_id: z.string().nullish(),
         time_due: z.iso.datetime().nullish(),
         tz_name: z.string().nullish(),
         frequency: z.enum([
@@ -6203,7 +6295,7 @@ export const zAssetsItemFormAssignmentParameters = z.object({
     })
 });
 /**
- * Update an item form assignment. All fields are optional — send only what changes. recurring gates the recurrence fields, and task_attributes.reminders_attributes replaces the existing reminder set when supplied.
+ * Update an item form assignment. All fields are optional — send only what changes. recurring gates the recurrence fields, and task_attributes.reminders_attributes replaces the existing reminder set when supplied. A newly added assignee outside the credential company returns 422. The creator is set at creation and cannot be sent.
  */
 export const zAssetsItemFormAssignmentUpdateParameters = z.object({
     form_definition_id: z.string().optional(),
@@ -6211,8 +6303,6 @@ export const zAssetsItemFormAssignmentUpdateParameters = z.object({
     task_attributes: z.object({
         name: z.string().nullish(),
         description: z.string().nullish(),
-        created_by_user_id: z.string().optional(),
-        updated_by_user_id: z.string().nullish(),
         time_due: z.iso.datetime().nullish(),
         tz_name: z.string().nullish(),
         frequency: z.enum([
@@ -6823,6 +6913,14 @@ export const zDeleteEmployerPath = z.object({
  * Success
  */
 export const zDeleteEmployerResponse = zApprenticeshipProgramEmployerResponseObject;
+export const zGetEmployerPath = z.object({
+    program_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetEmployerResponse = zApprenticeshipProgramEmployerResponseObject;
 export const zUpdateEmployerBody = zApprenticeshipProgramEmployerUpdateParameters;
 export const zUpdateEmployerPath = z.object({
     program_id: z.string(),
@@ -6908,6 +7006,22 @@ export const zCreatePeriodPath = z.object({
  * Created
  */
 export const zCreatePeriodResponse = zApprenticeshipWageSchedulePeriodResponseObject;
+export const zDeletePeriodPath = z.object({
+    wage_schedule_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeletePeriodResponse = z.void();
+export const zGetPeriodPath = z.object({
+    wage_schedule_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetPeriodResponse = zApprenticeshipWageSchedulePeriodResponseObject;
 export const zUpdatePeriodBody = zApprenticeshipWageSchedulePeriodUpdateParameters;
 export const zUpdatePeriodPath = z.object({
     wage_schedule_id: z.string(),
@@ -7897,6 +8011,21 @@ export const zUpdatePackagePath = z.object({
  * Success
  */
 export const zUpdatePackageResponse = zCertificationPackageResponseObject;
+export const zRevokeUserCertificationApprovalPath = z.object({
+    user_certification_id: z.string()
+});
+/**
+ * Success
+ */
+export const zRevokeUserCertificationApprovalResponse = zUserCertificationResponseObject;
+export const zApproveUserCertificationBody = zUserCertificationApprovalParameters;
+export const zApproveUserCertificationPath = z.object({
+    user_certification_id: z.string()
+});
+/**
+ * Success
+ */
+export const zApproveUserCertificationResponse = zUserCertificationResponseObject;
 export const zListUserCertificationsQuery = z.object({
     filter: z.string().optional(),
     'filter[unexpected]': z.string().optional(),
@@ -8185,6 +8314,13 @@ export const zListFormDefinitionsQuery = z.object({
  * Success
  */
 export const zListFormDefinitionsResponse = zFormDefinitionResponseObject;
+export const zGetFormDefinitionPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetFormDefinitionResponse = zFormDefinitionObject;
 export const zListFormSubmissionDeltasQuery = z.object({
     'filter[event]': z.enum([
         'create',
@@ -8418,6 +8554,53 @@ export const zGetRateRuleQuery = z.object({
  * Success
  */
 export const zGetRateRuleResponse = zRateRuleResponseObject;
+export const zListJobSitesPath = z.object({
+    job_id: z.string()
+});
+export const zListJobSitesQuery = z.object({
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListJobSitesResponse = zJobSitesResponseObject;
+export const zCreateJobSiteBody = zJobSiteParameters;
+export const zCreateJobSitePath = z.object({
+    job_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateJobSiteResponse = zJobSiteResponseObject;
+export const zDeleteJobSitePath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteJobSiteResponse = z.void();
+export const zGetJobSitePath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetJobSiteResponse = zJobSiteResponseObject;
+export const zUpdateJobSiteBody = zJobSiteUpdateParameters;
+export const zUpdateJobSitePath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateJobSiteResponse = zJobSiteResponseObject;
 export const zShiftJobWageDeterminationGenesisBody = zJobWageDeterminationGenesisParameters;
 export const zShiftJobWageDeterminationGenesisHeaders = z.object({
     'If-Match': z.string()
@@ -9429,7 +9612,7 @@ export const zListCustomFieldsPath = z.object({
  * Success
  */
 export const zListCustomFieldsResponse = z.object({
-    data: z.array(zPeopleEmploymentCustomFieldResponseObject)
+    data: z.array(zCustomFieldResponseObject)
 });
 export const zUpdateCustomFieldBody = zPeopleEmploymentCustomFieldsUpdateParameters;
 export const zUpdateCustomFieldHeaders = z.object({
@@ -9442,7 +9625,7 @@ export const zUpdateCustomFieldPath = z.object({
  * Success
  */
 export const zUpdateCustomFieldResponse = z.object({
-    data: z.array(zPeopleEmploymentCustomFieldResponseObject)
+    data: z.array(zCustomFieldResponseObject)
 });
 export const zUpdateGenesisBody = zPeopleEmploymentGenesisParameters;
 export const zUpdateGenesisHeaders = z.object({
@@ -9756,6 +9939,55 @@ export const zCreateProjectTradePath = z.object({
  * Created
  */
 export const zCreateProjectTradeResponse = zPwaTradeResponseObject;
+export const zListProjectSitesPath = z.object({
+    project_id: z.string()
+});
+export const zListProjectSitesQuery = z.object({
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListProjectSitesResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zProjectSiteResponseObject)
+});
+export const zCreateProjectSiteBody = zProjectSiteParameters;
+export const zCreateProjectSitePath = z.object({
+    project_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateProjectSiteResponse = zProjectSiteResponseObject;
+export const zDeleteProjectSitePath = z.object({
+    project_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteProjectSiteResponse = z.void();
+export const zGetProjectSitePath = z.object({
+    project_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetProjectSiteResponse = zProjectSiteResponseObject;
+export const zUpdateProjectSiteBody = zProjectSiteUpdateParameters;
+export const zUpdateProjectSitePath = z.object({
+    project_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateProjectSiteResponse = zProjectSiteResponseObject;
 export const zListProjectsQuery = z.object({
     'filter[federal_pwa_mode]': z.enum([
         'all',
@@ -9867,6 +10099,14 @@ export const zDeleteApprenticeshipOccupationPath = z.object({
  * Success
  */
 export const zDeleteApprenticeshipOccupationResponse = zPwaTradeApprenticeshipOccupationResponseObject;
+export const zGetApprenticeshipOccupationPath = z.object({
+    trade_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetApprenticeshipOccupationResponse = zPwaTradeApprenticeshipOccupationResponseObject;
 export const zUpdateApprenticeshipOccupationBody = zPwaTradeApprenticeshipOccupationUpdateParameters;
 export const zUpdateApprenticeshipOccupationPath = z.object({
     trade_id: z.string(),
@@ -10176,6 +10416,15 @@ export const zGetPriorPeriodAdjustmentPath = z.object({
  * Success
  */
 export const zGetPriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
+export const zUpdatePriorPeriodAdjustmentBody = zPriorPeriodAdjustmentUpdateParameters;
+export const zUpdatePriorPeriodAdjustmentPath = z.object({
+    time_card_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdatePriorPeriodAdjustmentResponse = zPriorPeriodAdjustmentResponseObject;
 export const zListPwaCompliancesPath = z.object({
     time_card_id: z.string()
 });
@@ -10760,6 +11009,7 @@ export const zListUsersQuery = z.object({
         'none',
         'all'
     ]).optional(),
+    'filter[name]': z.string().optional(),
     'page[cursor]': z.string().optional(),
     'page[limit]': z.int().gte(1).optional().default(20),
     page: z.string().optional(),