@dsptch-work/api-client 0.16.0 → 0.18.0

package/dist/gen/zod.gen.js

@@ -413,6 +413,7 @@ export const zDirectUploadParameters = z.object({
         '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',
@@ -1930,6 +1931,11 @@ export const zJobParameters = z.object({
     tracks_feature_allocations: z.boolean().nullish(),
     requires_feature_allocation: z.boolean().nullish(),
     max_one_feature_allocation: z.boolean().nullish(),
+    production_tracking_kind: z.enum([
+        'none',
+        'feature',
+        'quantity'
+    ]).optional(),
     job_work_types_attributes: z.array(z.object({
         primary: z.boolean().optional(),
         work_type_id: z.string().optional()
@@ -2302,6 +2308,19 @@ export const zManagerTimeCardApprovalParameters = z.object({
 export const zWorkerTimeCardApprovalParameters = z.object({
     status: z.enum(['pending', 'approved'])
 });
+/**
+ * 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.
+ */
+export const zTimeSessionResponseObject = z.object({
+    id: z.string(),
+    user_id: z.string(),
+    job_id: z.string().nullable(),
+    timekeeping_timecode_id: z.string().nullable(),
+    active: z.boolean(),
+    start_time: z.iso.datetime(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
 /**
  * Request body for locking or unlocking a time card.
  */
@@ -2842,6 +2861,7 @@ export const zComplianceCheckResponseObject = z.object({
     timekeeping_pay_period_id: z.string().nullable(),
     user_id: z.string().nullable(),
     employment_id: z.string().nullable(),
+    assignee_user_ids: z.array(z.string()),
     title: z.string(),
     description: z.string(),
     category: z.enum([
@@ -2877,12 +2897,187 @@ export const zComplianceCheckResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Update a compliance check. Both fields are optional.
+ * A document attached to a compliance check.
+ */
+export const zComplianceCheckDocumentObject = z.object({
+    id: z.string(),
+    filename: z.string(),
+    content_type: z.string().nullable(),
+    byte_size: z.int(),
+    url: z.string(),
+    created_by_user_id: z.string(),
+    created_at: z.iso.datetime()
+});
+/**
+ * A single compliance check, with the documents attached to it. Same fields as compliance_check_response_object plus `documents`.
+ */
+export const zComplianceCheckDetailResponseObject = z.object({
+    id: z.string(),
+    type: z.enum([
+        'Compliances::CompanyCheck',
+        'Compliances::JobCheck',
+        'Compliances::ProjectCheck',
+        'Compliances::TimeCardCheck',
+        'Compliances::PayPeriodCheck',
+        'Compliances::UserCheck',
+        'Compliances::UserCompanyCheck'
+    ]),
+    status: z.enum([
+        'passed',
+        'failed',
+        'not_applicable',
+        'dismissed',
+        'pending'
+    ]),
+    compliances_requirement_id: z.string(),
+    company_id: z.string().nullable(),
+    job_id: z.string().nullable(),
+    project_id: z.string().nullable(),
+    timekeeping_time_card_id: z.string().nullable(),
+    timekeeping_pay_period_id: z.string().nullable(),
+    user_id: z.string().nullable(),
+    employment_id: z.string().nullable(),
+    assignee_user_ids: z.array(z.string()),
+    title: z.string(),
+    description: z.string(),
+    category: z.enum([
+        'apprenticeship',
+        'certified_payroll',
+        'company',
+        'job',
+        'payroll',
+        'project',
+        'regional',
+        'tax_credit',
+        'timekeeping',
+        'worker'
+    ]),
+    phase: z.enum([
+        'after_pay_date',
+        'before_approval_deadline',
+        'close_out',
+        'maintenance',
+        'onboarding',
+        'setup'
+    ]),
+    priority: z.enum([
+        'critical',
+        'high',
+        'medium',
+        'low'
+    ]).nullable(),
+    checked_at: z.iso.datetime().nullable(),
+    passed_at: z.iso.datetime().nullable(),
+    time_due: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime(),
+    documents: z.array(zComplianceCheckDocumentObject)
+});
+/**
+ * Update a compliance check. Every field is optional.
  */
 export const zComplianceCheckParameters = z.object({
     status: z.enum(['dismissed', 'pending']).optional(),
-    time_due: z.iso.datetime().nullish()
+    time_due: z.iso.datetime().nullish(),
+    assignee_user_ids: z.array(z.string()).optional(),
+    file_signed_id: z.string().optional()
+});
+export const zRichTextObject = z.object({
+    text: z.string(),
+    attachments: z.array(z.object({
+        filename: z.string(),
+        content_type: z.string().nullish(),
+        byte_size: z.int(),
+        url: z.string()
+    }))
 });
+export const zTodoInboxTodoResponseObject = z.object({
+    kind: z.enum(['todo']),
+    id: z.string(),
+    type: z.enum([
+        'company',
+        'job',
+        'project'
+    ]),
+    company_id: z.string().nullable(),
+    job_id: z.string().nullable(),
+    project_id: z.string().nullable(),
+    name: z.string(),
+    created_by_user_id: z.string(),
+    updated_by_user_id: z.string(),
+    completed: z.boolean(),
+    task_assignee_user_ids: z.array(z.string()),
+    description: zRichTextObject,
+    time_due: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+export const zTodoInboxComplianceCheckResponseObject = z.object({
+    kind: z.enum(['compliance_check']),
+    id: z.string(),
+    type: z.enum([
+        'Compliances::CompanyCheck',
+        'Compliances::JobCheck',
+        'Compliances::ProjectCheck',
+        'Compliances::TimeCardCheck',
+        'Compliances::PayPeriodCheck',
+        'Compliances::UserCheck',
+        'Compliances::UserCompanyCheck'
+    ]),
+    status: z.enum([
+        'passed',
+        'failed',
+        'not_applicable',
+        'dismissed',
+        'pending'
+    ]),
+    compliances_requirement_id: z.string(),
+    company_id: z.string().nullable(),
+    job_id: z.string().nullable(),
+    project_id: z.string().nullable(),
+    timekeeping_time_card_id: z.string().nullable(),
+    timekeeping_pay_period_id: z.string().nullable(),
+    user_id: z.string().nullable(),
+    employment_id: z.string().nullable(),
+    assignee_user_ids: z.array(z.string()),
+    title: z.string(),
+    description: z.string(),
+    category: z.enum([
+        'apprenticeship',
+        'certified_payroll',
+        'company',
+        'job',
+        'payroll',
+        'project',
+        'regional',
+        'tax_credit',
+        'timekeeping',
+        'worker'
+    ]),
+    phase: z.enum([
+        'after_pay_date',
+        'before_approval_deadline',
+        'close_out',
+        'maintenance',
+        'onboarding',
+        'setup'
+    ]),
+    priority: z.enum([
+        'critical',
+        'high',
+        'medium',
+        'low'
+    ]).nullable(),
+    checked_at: z.iso.datetime().nullable(),
+    passed_at: z.iso.datetime().nullable(),
+    time_due: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+export const zTodoInboxEntryResponseObject = z.discriminatedUnion('kind', [
+    zTodoInboxTodoResponseObject.extend({ kind: z.literal('todo') }),
+    zTodoInboxComplianceCheckResponseObject.extend({ kind: z.literal('compliance_check') })
+]);
 /**
  * One compliance requirement from the catalog. Requirements ship with the application, so the catalog reads the same for every company.
  */
@@ -3149,10 +3344,7 @@ export const zPositionParameters = z.object({
     hourly_rate_cents: z.number().nullish(),
     pwa_wage_pay_rate_cents: z.number().nullish(),
     wage_adder_rate_cents: z.number().nullish(),
-    job_wage_determinations_positions_attributes: z.array(z.object({
-        id: z.int().nullish(),
-        job_wage_determination_id: z.string().nullish()
-    })).optional(),
+    job_wage_determination_ids: z.array(z.string()).optional(),
     pwa_details_attributes: z.object({
         skill_level: z.string().nullish()
     }).optional()
@@ -3447,7 +3639,12 @@ export const zJobResponseObject = z.object({
     timekeeping_timecode_ids: z.array(z.string()),
     tracks_feature_allocations: z.boolean(),
     requires_feature_allocation: z.boolean(),
-    max_one_feature_allocation: z.boolean()
+    max_one_feature_allocation: z.boolean(),
+    production_tracking_kind: z.enum([
+        'none',
+        'feature',
+        'quantity'
+    ])
 });
 /**
  * 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.
@@ -3512,7 +3709,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. 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) 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.
  */
 export const zUserResponseObject = z.object({
     id: z.string(),
@@ -3533,13 +3730,19 @@ export const zUserResponseObject = z.object({
     updated_at: z.iso.datetime(),
     winda_id: z.string().nullable(),
     linkedin_url: z.string().nullable(),
-    employment_id: z.string(),
+    employment_state: z.enum([
+        'active',
+        'scheduled',
+        'terminated',
+        'none'
+    ]),
+    employment_id: z.string().nullable(),
     type: zUserCompanyType,
     title: z.string().nullable(),
-    overtime_eligible: z.boolean(),
-    enrolled_in_t_and_a: z.boolean(),
+    overtime_eligible: z.boolean().nullable(),
+    enrolled_in_t_and_a: z.boolean().nullable(),
     payroll_id: z.string().nullable(),
-    compensation_type: z.string(),
+    compensation_type: z.string().nullable(),
     hourly_rate: z.string().nullable(),
     training_annual_amount: z.string().nullable(),
     employer_combined_health_amount: z.string().nullable(),
@@ -3553,7 +3756,7 @@ export const zUserResponseObject = z.object({
     employment_window: z.object({
         valid_from: z.iso.datetime().nullable(),
         valid_to: z.iso.datetime().nullable()
-    }),
+    }).nullable(),
     manager_user_id: z.string().nullable(),
     roles: z.array(z.string()),
     company_user_pwa_info: z.object({
@@ -3900,6 +4103,14 @@ export const zTimeCardsResponseObject = z.object({
     links: zLinks,
     data: z.array(zTimeCardResponseObject)
 });
+/**
+ * A page of time sessions, with pagination metadata and navigation links.
+ */
+export const zTimeSessionsResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zTimeSessionResponseObject)
+});
 /**
  * A page of payroll runs, with pagination metadata and navigation links.
  */
@@ -3991,6 +4202,7 @@ export const zLaborRateResponseObject = z.object({
     fringe_percentage_rate: z.string().nullable(),
     fringe_benefit_weekly_rate_cents: z.string().nullable(),
     fringe_benefit_monthly_rate_cents: z.string().nullable(),
+    reference_item_ids: z.array(z.string()),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
@@ -4002,6 +4214,118 @@ export const zLaborRatesResponseObject = z.object({
     links: zLinks,
     data: z.array(zLaborRateResponseObject)
 });
+/**
+ * A DOL labor-classification schedule within one wage determination; its labor rates and reference items share this schedule boundary.
+ */
+export const zWageClassificationResponseObject = z.object({
+    id: z.string(),
+    wage_determination_id: z.string(),
+    identifier: z.string(),
+    date: z.iso.date(),
+    footnote: z.string().nullable(),
+    subheader: z.string().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * A page of a wage determination's classification schedules, with pagination metadata and navigation links.
+ */
+export const zWageClassificationsResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zWageClassificationResponseObject)
+});
+/**
+ * A Davis-Bacon construction category assigned to one wage determination.
+ */
+export const zConstructionTypeResponseObject = z.object({
+    id: z.string(),
+    wage_determination_id: z.string(),
+    construction_type: z.enum([
+        'BUILDING',
+        'HEAVY',
+        'HIGHWAY',
+        'RESIDENTIAL'
+    ]),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * A page of a wage determination's construction categories, with pagination metadata and navigation links.
+ */
+export const zConstructionTypesResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zConstructionTypeResponseObject)
+});
+/**
+ * A DOL project-type tag attached directly to one wage determination.
+ */
+export const zProjectTypeResponseObject = z.object({
+    id: z.string(),
+    wage_determination_id: z.string(),
+    project_type: z.string(),
+    project_type_subtext: z.string().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * A page of project-type tags attached directly to a wage determination, with pagination metadata and navigation links.
+ */
+export const zProjectTypesResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zProjectTypeResponseObject)
+});
+/**
+ * A link between a wage determination and one geographic boundary where it applies. Includes stable boundary identity metadata but never geometry.
+ */
+export const zWageDeterminationBoundaryResponseObject = z.object({
+    id: z.string(),
+    wage_determination_id: z.string(),
+    boundary_id: z.string(),
+    boundary_type: z.string(),
+    name: z.string(),
+    source_boundary_id: z.string().nullable(),
+    source_geo_id: z.string().nullable(),
+    source_unique_id: z.string().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * A page of a wage determination's geographic applicability links, with pagination metadata and navigation links.
+ */
+export const zWageDeterminationBoundariesResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zWageDeterminationBoundaryResponseObject)
+});
+/**
+ * One ordered, lettered item of verbatim fringe-reference prose within a wage-classification schedule.
+ */
+export const zReferenceItemResponseObject = z.object({
+    id: z.string(),
+    wage_classification_id: z.string(),
+    position: z.int(),
+    letter: z.string(),
+    container_type: z.enum([
+        'footnote',
+        'premium_pay',
+        'holidays',
+        'zone_pay'
+    ]),
+    text: z.string(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * A page of reference items flattened across every classification schedule in a wage determination, with pagination metadata and navigation links.
+ */
+export const zReferenceItemsResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zReferenceItemResponseObject)
+});
 /**
  * A Federal (Davis-Bacon) wage determination on a job.
  */
@@ -6605,6 +6929,7 @@ export const zListChecksQuery = z.object({
     'filter[job_id][null]': z.boolean().optional(),
     'filter[project_id]': z.string().optional(),
     'filter[compliances_requirement_id]': z.string().optional(),
+    'filter[assignee_user_id]': z.string().optional(),
     'filter[time_due][gte]': z.iso.datetime().optional(),
     'filter[time_due][lte]': z.iso.datetime().optional(),
     filter: z.string().optional(),
@@ -6627,7 +6952,7 @@ export const zGetCheckPath = z.object({
 /**
  * Success
  */
-export const zGetCheckResponse = zComplianceCheckResponseObject;
+export const zGetCheckResponse = zComplianceCheckDetailResponseObject;
 export const zUpdateCheckBody = zComplianceCheckParameters;
 export const zUpdateCheckPath = z.object({
     id: z.string()
@@ -6635,7 +6960,7 @@ export const zUpdateCheckPath = z.object({
 /**
  * Success
  */
-export const zUpdateCheckResponse = zComplianceCheckResponseObject;
+export const zUpdateCheckResponse = zComplianceCheckDetailResponseObject;
 export const zListRequirementsQuery = z.object({
     'filter[search]': z.string().optional(),
     'filter[type]': z.string().optional(),
@@ -7102,6 +7427,11 @@ export const zListJobsQuery = z.object({
     'filter[updated_at][lte]': z.iso.datetime().optional(),
     'filter[project_id]': z.string().optional(),
     'filter[status]': z.string().optional(),
+    'filter[production_tracking_kind]': z.enum([
+        'none',
+        'feature',
+        'quantity'
+    ]).optional(),
     'page[cursor]': z.string().optional(),
     'page[limit]': z.int().gte(1).optional().default(20),
     page: z.string().optional(),
@@ -8715,6 +9045,40 @@ export const zGetTimeCardActualPath = z.object({
  * Success
  */
 export const zGetTimeCardActualResponse = zTimeCardActualsResponseObject;
+export const zListTimeSessionsQuery = z.object({
+    'filter[user_id]': z.string().optional(),
+    'filter[job_id]': z.string().optional(),
+    'filter[job_id][null]': z.boolean().optional(),
+    'filter[active]': z.boolean().optional(),
+    'filter[start_time][gte]': z.iso.datetime().optional(),
+    'filter[start_time][lte]': z.iso.datetime().optional(),
+    'filter[created_at][gte]': z.iso.datetime().optional(),
+    'filter[created_at][lte]': z.iso.datetime().optional(),
+    'filter[updated_at][gte]': z.iso.datetime().optional(),
+    'filter[updated_at][lte]': z.iso.datetime().optional(),
+    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 zListTimeSessionsResponse = zTimeSessionsResponseObject;
+export const zGetTimeSessionPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetTimeSessionResponse = zTimeSessionResponseObject;
+/**
+ * Success
+ */
+export const zListTodoInboxResponse = z.object({
+    data: z.array(zTodoInboxEntryResponseObject)
+});
 export const zListUserRolesQuery = z.object({
     'filter[user_id]': z.string().optional(),
     'filter[role]': z.string().optional(),
@@ -8829,7 +9193,9 @@ export const zUpdateCompanyResponse = zUserResponseObject;
 export const zListUsersQuery = z.object({
     'filter[state]': z.enum([
         'active',
+        'scheduled',
         'terminated',
+        'none',
         'all'
     ]).optional(),
     'page[cursor]': z.string().optional(),
@@ -8873,6 +9239,43 @@ export const zUpdateUserPath = z.object({
  * Success
  */
 export const zUpdateUserResponse = zUserResponseObject;
+export const zListBoundariesPath = z.object({
+    wage_determination_id: z.string()
+});
+export const zListBoundariesQuery = z.object({
+    'filter[id]': z.string().optional(),
+    'filter[boundary_id]': z.string().optional(),
+    'filter[name]': z.string().optional(),
+    'filter[boundary_type]': z.string().optional(),
+    'filter[source_boundary_id]': z.string().optional(),
+    'filter[source_geo_id]': z.string().optional(),
+    'filter[source_unique_id]': z.string().optional(),
+    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 zListBoundariesResponse = zWageDeterminationBoundariesResponseObject;
+export const zListConstructionTypesPath = z.object({
+    wage_determination_id: z.string()
+});
+export const zListConstructionTypesQuery = z.object({
+    'filter[id]': z.string().optional(),
+    'filter[construction_type]': z.string().optional(),
+    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 zListConstructionTypesResponse = zConstructionTypesResponseObject;
 export const zListLaborRatesPath = z.object({
     wage_determination_id: z.string()
 });
@@ -8888,6 +9291,59 @@ export const zListLaborRatesQuery = z.object({
  * Success
  */
 export const zListLaborRatesResponse = zLaborRatesResponseObject;
+export const zListProjectTypesPath = z.object({
+    wage_determination_id: z.string()
+});
+export const zListProjectTypesQuery = z.object({
+    'filter[id]': z.string().optional(),
+    'filter[project_type]': z.string().optional(),
+    'filter[project_type_subtext]': z.string().optional(),
+    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 zListProjectTypesResponse = zProjectTypesResponseObject;
+export const zListReferenceItemsPath = z.object({
+    wage_determination_id: z.string()
+});
+export const zListReferenceItemsQuery = z.object({
+    'filter[id]': z.string().optional(),
+    'filter[wage_classification_id]': z.string().optional(),
+    'filter[position]': z.int().optional(),
+    'filter[letter]': z.string().optional(),
+    'filter[container_type]': z.string().optional(),
+    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 zListReferenceItemsResponse = zReferenceItemsResponseObject;
+export const zListWageClassificationsPath = z.object({
+    wage_determination_id: z.string()
+});
+export const zListWageClassificationsQuery = z.object({
+    'filter[id]': z.string().optional(),
+    'filter[identifier]': z.string().optional(),
+    'filter[date]': z.iso.date().optional(),
+    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 zListWageClassificationsResponse = zWageClassificationsResponseObject;
 export const zListWageDeterminationsQuery = z.object({
     'filter[valid_from][gte]': z.iso.datetime().optional(),
     'filter[valid_from][lte]': z.iso.datetime().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.16.0",
+  "version": "0.18.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",