@dsptch-work/api-client 0.23.0 → 0.25.0

package/dist/gen/zod.gen.js

@@ -418,6 +418,7 @@ export const zDirectUploadParameters = z.object({
         'assets.products',
         'assets.vendors',
         'compliance.checks',
+        'internal.companies',
         'internal.company_todos',
         'internal.job_todos',
         'internal.project_todos',
@@ -538,11 +539,12 @@ export const zApprenticeshipWageScheduleResponseObject = z.object({
     end_wage_currency: z.string(),
     journeyworker_wage_cents: z.string(),
     journeyworker_wage_currency: z.string(),
+    journeyworker_fringe_cents: z.string().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
 /**
- * One step in a wage schedule's progression — the apprentice's pay, as a percentage of the journeyworker wage, for a band of accumulated hours or a number of competencies.
+ * One step in a wage schedule's progression — the apprentice's pay, as a percentage of the journeyworker wage, for a band of accumulated hours or a number of competencies. A period may also list its apprentices' fringe, as a percentage of the charged wage determination's fringe or as a fixed hourly amount, and an in-ratio apprentice is obligated at that fringe. The listing is ignored — fringe is priced as if nothing were listed — when the apprentice is out of ratio, on a regional Illinois wage determination, or on an apprentice-basis wage determination, which carries its own apprentice fringe.
  */
 export const zApprenticeshipWageSchedulePeriodResponseObject = z.object({
     id: z.string(),
@@ -555,6 +557,8 @@ export const zApprenticeshipWageSchedulePeriodResponseObject = z.object({
     wage_percent: z.string(),
     wage_cents: z.string(),
     wage_currency: z.string(),
+    fringe_percent: z.string().nullable(),
+    fringe_cents: z.string().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
@@ -711,14 +715,14 @@ 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.
+ * 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.
  */
 export const zApprenticeshipProgramEmployerUpdateParameters = z.object({
     company_id: z.string().optional(),
     require_timecard_allocation: z.boolean().optional()
 });
 /**
- * Create a period on a wage schedule; the wage schedule is taken from the URL path. wage_cents is sent as integer cents.
+ * Create a period on a wage schedule; the wage schedule is taken from the URL path. wage_cents and fringe_cents are sent as integer cents.
  */
 export const zApprenticeshipWageSchedulePeriodParameters = z.object({
     period_number: z.int(),
@@ -727,10 +731,12 @@ export const zApprenticeshipWageSchedulePeriodParameters = z.object({
     num_competencies: z.int().nullish(),
     description: z.string().nullish(),
     wage_percent: z.number(),
-    wage_cents: z.int()
+    wage_cents: z.int(),
+    fringe_percent: z.number().nullish(),
+    fringe_cents: z.int().nullish()
 });
 /**
- * Update a period on a wage schedule. Send only the fields to change; the wage schedule is taken from the URL path and wage_cents is sent as integer cents.
+ * Update a period on a wage schedule. Send only the fields to change; the wage schedule is taken from the URL path, and wage_cents and fringe_cents are sent as integer cents.
  */
 export const zApprenticeshipWageSchedulePeriodUpdateParameters = z.object({
     period_number: z.int().optional(),
@@ -739,7 +745,9 @@ export const zApprenticeshipWageSchedulePeriodUpdateParameters = z.object({
     num_competencies: z.int().nullish(),
     description: z.string().nullish(),
     wage_percent: z.number().optional(),
-    wage_cents: z.int().optional()
+    wage_cents: z.int().optional(),
+    fringe_percent: z.number().nullish(),
+    fringe_cents: z.int().nullish()
 });
 /**
  * Create a wage schedule for an occupation; the occupation is taken from the URL path. Money is sent as integer cents; periods may be created inline via periods_attributes.
@@ -772,6 +780,7 @@ export const zApprenticeshipWageScheduleParameters = z.object({
         'year'
     ]),
     journeyworker_wage_cents: z.int().optional(),
+    journeyworker_fringe_cents: z.int().nullish(),
     end_wage_cents: z.int().optional(),
     periods_attributes: z.array(z.object({
         id: z.string().optional(),
@@ -782,6 +791,8 @@ export const zApprenticeshipWageScheduleParameters = z.object({
         description: z.string().nullish(),
         wage_percent: z.number(),
         wage_cents: z.int(),
+        fringe_percent: z.number().nullish(),
+        fringe_cents: z.int().nullish(),
         _destroy: z.boolean().optional()
     })).optional()
 });
@@ -816,6 +827,7 @@ export const zApprenticeshipWageScheduleUpdateParameters = z.object({
         'year'
     ]).optional(),
     journeyworker_wage_cents: z.int().optional(),
+    journeyworker_fringe_cents: z.int().nullish(),
     end_wage_cents: z.int().optional(),
     periods_attributes: z.array(z.intersection(z.union([
         z.unknown(),
@@ -842,6 +854,8 @@ export const zApprenticeshipWageScheduleUpdateParameters = z.object({
         description: z.string().nullish(),
         wage_percent: z.number().optional(),
         wage_cents: z.int().optional(),
+        fringe_percent: z.number().nullish(),
+        fringe_cents: z.int().nullish(),
         _destroy: z.boolean().optional()
     }))).optional()
 });
@@ -934,7 +948,7 @@ export const zPeopleEmploymentCreateParameters = z.object({
     employer_combined_savings_cents: z.string().nullish()
 });
 /**
- * Request body for creating one strictly future employment boundary. effective_date is required and is interpreted at midnight in the credential company's time zone. Send at least one value to change; omitted values carry forward from the version immediately before the new boundary.
+ * Request body for creating one employment boundary. effective_date is required and is interpreted at midnight in the credential company's time zone. Today and past dates must fall inside the family's latest version, before its termination; future dates retain scheduling behavior. Send at least one value to change; omitted values carry forward from the version immediately before the new boundary.
  */
 export const zPeopleEmploymentScheduledChangeCreateParameters = z.object({
     compensation_type: z.enum(['hourly', 'salary']).optional(),
@@ -952,7 +966,7 @@ export const zPeopleEmploymentScheduledChangeCreateParameters = z.object({
     effective_date: z.iso.date()
 });
 /**
- * Request body for changing values at one exact strictly future employment boundary. Send only the fields to change; omitted values remain as recorded at that boundary. The boundary date cannot move.
+ * Request body for changing values at one exact employment boundary. Today and past dates must name the latest version's start; future exact boundaries remain editable. Send only the fields to change; omitted values remain as recorded at that boundary. The boundary date cannot move.
  */
 export const zPeopleEmploymentScheduledChangeUpdateParameters = z.object({
     compensation_type: z.enum(['hourly', 'salary']).optional(),
@@ -2584,7 +2598,8 @@ export const zAggregateTimeImportResponseObject = z.object({
         'processed',
         'success',
         'failed',
-        'superseded'
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2614,7 +2629,8 @@ export const zDsptchCprImportResponseObject = z.object({
         'processed',
         'success',
         'failed',
-        'superseded'
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2644,7 +2660,8 @@ export const zPaystubImportResponseObject = z.object({
         'processed',
         'success',
         'failed',
-        'superseded'
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2674,7 +2691,8 @@ export const zTimeEntryImportResponseObject = z.object({
         'processed',
         'success',
         'failed',
-        'superseded'
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -4000,6 +4018,13 @@ export const zPayRatesRulePackageParameters = z.object({
     name: z.string().min(1),
     description: z.string().nullish()
 });
+/**
+ * Request body for updating a pay-rate rule package. Send only the fields to change. `default`, `selectable`, and `scoped_to_job_id` are not writable on this operation.
+ */
+export const zPayRatesRulePackageUpdateParameters = z.object({
+    name: z.string().min(1).optional(),
+    description: z.string().nullish()
+});
 /**
  * Request body for creating or updating a position on a job. The job is taken from the URL path.
  */
@@ -4157,7 +4182,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.
+ * 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.
  */
 export const zCertificationParameters = z.object({
     company_id: z.string(),
@@ -4167,10 +4192,9 @@ 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.
+ * 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.
  */
 export const zCertificationUpdateParameters = z.object({
-    company_id: z.string().optional(),
     name: z.string().optional(),
     description: z.string().nullish(),
     verified: z.boolean().optional(),
@@ -4191,7 +4215,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.
+ * 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.
  */
 export const zCertificationPackageParameters = z.object({
     name: z.string(),
@@ -4200,7 +4224,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.
+ * 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.
  */
 export const zCertificationPackageUpdateParameters = z.object({
     name: z.string().optional(),
@@ -4547,14 +4571,21 @@ export const zUserResponseObject = z.object({
         ])).nullable()
     }).nullable()
 });
-/**
- * Request body for onboarding a worker into your company. In one call it creates the person (if new), their employment record, roles, group memberships, an optional invite, and optional compliance details. company_id, email, first_name, and last_name are required.
- */
-export const zUserParameters = z.object({
-    company_id: z.string(),
-    email: z.string(),
-    personal_email: z.string().optional(),
-    phone_number: z.string().optional(),
+export const zUserParameters = z.intersection(z.union([
+    z.object({
+        email: z.string().min(1)
+    }),
+    z.object({
+        phone_number: z.string().min(1)
+    }),
+    z.object({
+        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(),
     first_name: z.string(),
     last_name: z.string(),
     preferred_first_name: z.string().nullish(),
@@ -4654,7 +4685,7 @@ export const zUserParameters = z.object({
             'portuguese_or_brazilian'
         ])).nullish()
     }).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.
  */
@@ -6642,6 +6673,14 @@ export const zCreateAllocationPath = z.object({
  * Created
  */
 export const zCreateAllocationResponse = zApprenticeshipAllocationResponseObject;
+export const zDeleteAllocationPath = z.object({
+    apprentice_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteAllocationResponse = z.void();
 export const zGetAllocationPath = z.object({
     apprentice_id: z.string(),
     id: z.string()
@@ -6721,6 +6760,22 @@ export const zCreateOccupationPath = z.object({
  * Created
  */
 export const zCreateOccupationResponse = zApprenticeshipOccupationResponseObject;
+export const zDeleteOccupationPath = z.object({
+    program_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteOccupationResponse = z.void();
+export const zGetOccupationPath = z.object({
+    program_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetOccupationResponse = zApprenticeshipOccupationResponseObject;
 export const zUpdateOccupationBody = zApprenticeshipOccupationUpdateParameters;
 export const zUpdateOccupationPath = z.object({
     program_id: z.string(),
@@ -6801,6 +6856,20 @@ export const zCreateProgramBody = zApprenticeshipProgramParameters;
  * Created
  */
 export const zCreateProgramResponse = zApprenticeshipProgramResponseObject;
+export const zDeleteProgramPath = z.object({
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteProgramResponse = z.void();
+export const zGetProgramPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetProgramResponse = zApprenticeshipProgramResponseObject;
 export const zUpdateProgramBody = zApprenticeshipProgramUpdateParameters;
 export const zUpdateProgramPath = z.object({
     id: z.string()
@@ -6878,6 +6947,22 @@ export const zCreateWageSchedulePath = z.object({
  * Created
  */
 export const zCreateWageScheduleResponse = zApprenticeshipWageScheduleResponseObject;
+export const zDeleteWageSchedulePath = z.object({
+    occupation_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteWageScheduleResponse = z.void();
+export const zGetWageSchedulePath = z.object({
+    occupation_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetWageScheduleResponse = zApprenticeshipWageScheduleResponseObject;
 export const zUpdateWageScheduleBody = zApprenticeshipWageScheduleUpdateParameters;
 export const zUpdateWageSchedulePath = z.object({
     occupation_id: z.string(),
@@ -7915,6 +8000,20 @@ export const zCreateDepartmentBody = zDepartmentParameters;
  * Created
  */
 export const zCreateDepartmentResponse = zDepartmentResponseObject;
+export const zDeleteDepartmentPath = z.object({
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteDepartmentResponse = z.void();
+export const zGetDepartmentPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetDepartmentResponse = zDepartmentResponseObject;
 export const zUpdateDepartmentBody = zDepartmentUpdateParameters;
 export const zUpdateDepartmentPath = z.object({
     id: z.string()
@@ -8470,6 +8569,8 @@ export const zListJobsQuery = z.object({
         'feature',
         'quantity'
     ]).optional(),
+    'filter[name]': z.string().optional(),
+    'filter[purchase_order_number]': z.string().optional(),
     'page[cursor]': z.string().optional(),
     'page[limit]': z.int().gte(1).optional().default(20),
     page: z.string().optional(),
@@ -8888,6 +8989,13 @@ export const zCreatePayRateRulePackageBody = zPayRatesRulePackageParameters;
  * Created
  */
 export const zCreatePayRateRulePackageResponse = zPayRatesRulePackageResponseObject;
+export const zDeletePayRateRulePackagePath = z.object({
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeletePayRateRulePackageResponse = z.void();
 export const zGetPayRateRulePackagePath = z.object({
     id: z.string()
 });
@@ -8895,6 +9003,14 @@ export const zGetPayRateRulePackagePath = z.object({
  * Success
  */
 export const zGetPayRateRulePackageResponse = zPayRatesRulePackageResponseObject;
+export const zUpdatePayRateRulePackageBody = zPayRatesRulePackageUpdateParameters;
+export const zUpdatePayRateRulePackagePath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdatePayRateRulePackageResponse = zPayRatesRulePackageResponseObject;
 export const zListAggregateTimeImportsPath = z.object({
     pay_period_id: z.string()
 });
@@ -9654,6 +9770,7 @@ export const zListProjectsQuery = z.object({
         'none'
     ]).optional(),
     'filter[external_id]': z.string().optional(),
+    'filter[name]': z.string().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(),
@@ -9697,6 +9814,13 @@ export const zCreateCompanyUserDetailBody = zPwaCompanyUserDetailsParameters;
  * Created
  */
 export const zCreateCompanyUserDetailResponse = zPwaCompanyUserDetailsResponseObject;
+export const zDeleteCompanyUserDetailPath = z.object({
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteCompanyUserDetailResponse = z.void();
 export const zUpdateCompanyUserDetailBody = zPwaCompanyUserDetailsUpdateParameters;
 export const zUpdateCompanyUserDetailPath = z.object({
     id: z.string()
@@ -9897,6 +10021,22 @@ export const zCreatePositionPath = z.object({
  * Created
  */
 export const zCreatePositionResponse = zPositionResponseObject;
+export const zDeletePositionPath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeletePositionResponse = z.void();
+export const zGetPositionPath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetPositionResponse = zPositionResponseObject;
 export const zUpdatePositionBody = zPositionParameters;
 export const zUpdatePositionPath = z.object({
     job_id: z.string(),
@@ -10138,6 +10278,13 @@ export const zDeleteTimeEntryPath = z.object({
  * Success
  */
 export const zDeleteTimeEntryResponse = zTimeEntryResponseObject;
+export const zGetTimeEntryPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetTimeEntryResponse = zTimeEntryResponseObject;
 export const zUpdateTimeEntryBody = zTimeEntryUpdateParameters;
 export const zUpdateTimeEntryPath = z.object({
     id: z.string()

package/package.json

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