@dsptch-work/api-client 0.16.0 → 0.17.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',
@@ -2842,6 +2843,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 +2879,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 +3326,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()
@@ -3512,7 +3686,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 +3707,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 +3733,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({
@@ -6605,6 +6785,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 +6808,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 +6816,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(),
@@ -8715,6 +8896,12 @@ export const zGetTimeCardActualPath = z.object({
  * Success
  */
 export const zGetTimeCardActualResponse = zTimeCardActualsResponseObject;
+/**
+ * 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 +9016,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(),

package/package.json

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