@dsptch-work/api-client 0.22.0 → 0.24.0

package/dist/gen/zod.gen.js

@@ -538,11 +538,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 +556,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()
 });
@@ -607,9 +610,22 @@ export const zApprenticeshipAllocationResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Correct the effective timestamp of an existing standalone allocation. Time-card-linked allocations cannot be date-corrected. A changed timestamp rebuilds progression and requests historical wage repricing in the background, including locked time cards.
+ * Record hours toward an apprentice's wage progression. Creation requires a user-scoped API key, since the row attributes the hours to the person who recorded them. Omit timekeeping_time_card_id for a standalone allocation entered outside the time card system, or supply it to link the allocation to one of the apprentice's own time cards; the effective timestamp then derives from the card's pay period and cannot be overridden. Recording the allocation rebuilds progression and requests wage repricing in the background.
+ */
+export const zApprenticeshipAllocationCreateParameters = z.object({
+    apprenticeship_work_process_category_id: z.string().optional(),
+    timekeeping_time_card_id: z.string().optional(),
+    minutes: z.int(),
+    description: z.string().optional(),
+    allocated_at: z.iso.datetime().optional()
+});
+/**
+ * Correct an existing allocation's hours, work process category, description, or (for a standalone allocation) effective timestamp. The time card an allocation is linked to cannot be changed after creation. Any change that shifts progression rebuilds it and requests historical wage repricing in the background, including locked time cards.
  */
 export const zApprenticeshipAllocationUpdateParameters = z.object({
+    apprenticeship_work_process_category_id: z.string().nullish(),
+    minutes: z.int().optional(),
+    description: z.string().nullish(),
     allocated_at: z.iso.datetime().optional()
 });
 /**
@@ -705,7 +721,7 @@ export const zApprenticeshipProgramEmployerUpdateParameters = z.object({
     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(),
@@ -714,10 +730,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(),
@@ -726,7 +744,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.
@@ -759,6 +779,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(),
@@ -769,6 +790,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()
 });
@@ -803,6 +826,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(),
@@ -829,6 +853,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()
 });
@@ -921,7 +947,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(),
@@ -935,10 +961,11 @@ export const zPeopleEmploymentScheduledChangeCreateParameters = z.object({
     training_annual_amount_cents: z.string().nullish(),
     employer_combined_health_amount_cents: z.string().nullish(),
     employer_combined_savings_cents: z.string().nullish(),
+    companies_department_id: z.string().nullish(),
     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(),
@@ -951,7 +978,8 @@ export const zPeopleEmploymentScheduledChangeUpdateParameters = z.object({
     training_annual_minutes: z.int().nullish(),
     training_annual_amount_cents: z.string().nullish(),
     employer_combined_health_amount_cents: z.string().nullish(),
-    employer_combined_savings_cents: z.string().nullish()
+    employer_combined_savings_cents: z.string().nullish(),
+    companies_department_id: z.string().nullish()
 });
 /**
  * Parameters for moving where an employment stint's valid-time timeline begins.
@@ -965,6 +993,29 @@ export const zPeopleEmploymentGenesisParameters = z.object({
 export const zPeopleEmploymentScheduledTerminationParameters = z.object({
     effective_date: z.iso.date()
 });
+/**
+ * Request body for correcting an employment stint's operational details from its first recorded boundary forward. Send only the fields to change. A submitted value that already applies at the first boundary is a no-op, even when a later version differs.
+ */
+export const zPeopleEmploymentUpdateParameters = z.object({
+    type: z.enum(['EMPLOYEE', 'CONTRACTOR']).optional(),
+    title: z.string().nullish(),
+    manager_user_id: z.string().nullish(),
+    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.
+ */
+export const zPeopleEmploymentCustomFieldsUpdateParameters = z.object({
+    custom_fields: z.array(z.object({
+        custom_field_config_id: z.string(),
+        value: z.string().nullable()
+    })).min(1)
+});
 export const zPeopleEmploymentHistoryCorrectionObject = z.object({
     people_employment_id: z.string(),
     user_id: z.string(),
@@ -2545,7 +2596,9 @@ export const zAggregateTimeImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2574,7 +2627,9 @@ export const zDsptchCprImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2603,7 +2658,9 @@ export const zPaystubImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2632,7 +2689,9 @@ export const zTimeEntryImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded',
+        'withdrawn'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -4115,7 +4174,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(),
@@ -4125,10 +4184,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(),
@@ -4149,7 +4207,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(),
@@ -4158,7 +4216,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(),
@@ -6592,6 +6650,14 @@ export const zListAllocationsResponse = z.object({
     links: zLinks,
     data: z.array(zApprenticeshipAllocationResponseObject)
 });
+export const zCreateAllocationBody = zApprenticeshipAllocationCreateParameters;
+export const zCreateAllocationPath = z.object({
+    apprentice_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateAllocationResponse = zApprenticeshipAllocationResponseObject;
 export const zGetAllocationPath = z.object({
     apprentice_id: z.string(),
     id: z.string()
@@ -7865,6 +7931,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()
@@ -8420,6 +8500,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(),
@@ -9256,6 +9338,28 @@ export const zUpdatePaystubPath = z.object({
  * Success
  */
 export const zUpdatePaystubResponse = zPaystubResponseObject;
+export const zListCustomFieldsPath = z.object({
+    employment_id: z.string()
+});
+/**
+ * Success
+ */
+export const zListCustomFieldsResponse = z.object({
+    data: z.array(zPeopleEmploymentCustomFieldResponseObject)
+});
+export const zUpdateCustomFieldBody = zPeopleEmploymentCustomFieldsUpdateParameters;
+export const zUpdateCustomFieldHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zUpdateCustomFieldPath = z.object({
+    employment_id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateCustomFieldResponse = z.object({
+    data: z.array(zPeopleEmploymentCustomFieldResponseObject)
+});
 export const zUpdateGenesisBody = zPeopleEmploymentGenesisParameters;
 export const zUpdateGenesisHeaders = z.object({
     'If-Match': z.string()
@@ -9384,6 +9488,16 @@ export const zCreateEmploymentBody = zPeopleEmploymentCreateParameters;
  * Created
  */
 export const zCreateEmploymentResponse = zPeopleEmploymentResponseObject;
+export const zDeleteEmploymentHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zDeleteEmploymentPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zDeleteEmploymentResponse = zPeopleEmploymentResponseObject;
 export const zGetEmploymentPath = z.object({
     id: z.string()
 });
@@ -9394,6 +9508,17 @@ export const zGetEmploymentQuery = z.object({
  * Success
  */
 export const zGetEmploymentResponse = zPeopleEmploymentResponseObject;
+export const zUpdateEmploymentBody = zPeopleEmploymentUpdateParameters;
+export const zUpdateEmploymentHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zUpdateEmploymentPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateEmploymentResponse = zPeopleEmploymentResponseObject;
 export const zListPerDiemsQuery = z.object({
     'filter[default]': z.boolean().optional(),
     'filter[taxable]': z.boolean().optional(),

package/package.json

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