@dsptch-work/api-client 0.21.0 → 0.23.0

package/dist/gen/zod.gen.js

@@ -418,6 +418,9 @@ export const zDirectUploadParameters = z.object({
         'assets.products',
         'assets.vendors',
         'compliance.checks',
+        'internal.company_todos',
+        'internal.job_todos',
+        'internal.project_todos',
         'pay_periods.imports.aggregate_times',
         'pay_periods.imports.dsptch_cprs',
         'pay_periods.imports.time_entries',
@@ -604,9 +607,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()
 });
 /**
@@ -894,6 +910,99 @@ export const zPeopleEmploymentResponseObject = z.object({
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
+/**
+ * Create a distinct employment stint for an existing user in the credential company. Only user_id and hire_date are required; omitted optional fields use the defaults or null values described below. This does not create a user, invitation, role, group, or login identity.
+ */
+export const zPeopleEmploymentCreateParameters = z.object({
+    user_id: z.string(),
+    hire_date: z.iso.date(),
+    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(),
+    compensation_type: z.enum(['hourly', 'salary']).optional(),
+    hourly_rate_cents: z.string().nullish(),
+    overtime_eligible: z.boolean().nullish(),
+    overtime_package_id: z.string().nullish(),
+    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_amount_cents: z.string().nullish(),
+    employer_combined_health_amount_cents: z.string().nullish(),
+    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.
+ */
+export const zPeopleEmploymentScheduledChangeCreateParameters = z.object({
+    compensation_type: z.enum(['hourly', 'salary']).optional(),
+    hourly_rate_cents: z.string().nullish(),
+    overtime_eligible: z.boolean().nullish(),
+    overtime_package_id: z.string().nullish(),
+    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_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.
+ */
+export const zPeopleEmploymentScheduledChangeUpdateParameters = z.object({
+    compensation_type: z.enum(['hourly', 'salary']).optional(),
+    hourly_rate_cents: z.string().nullish(),
+    overtime_eligible: z.boolean().nullish(),
+    overtime_package_id: z.string().nullish(),
+    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_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()
+});
+/**
+ * Parameters for moving where an employment stint's valid-time timeline begins.
+ */
+export const zPeopleEmploymentGenesisParameters = z.object({
+    effective_date: z.iso.date().optional()
+});
+/**
+ * Parameters for scheduling when an employment stint stops being valid.
+ */
+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(),
@@ -2474,7 +2583,8 @@ export const zAggregateTimeImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2503,7 +2613,8 @@ export const zDsptchCprImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2532,7 +2643,8 @@ export const zPaystubImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -2561,7 +2673,8 @@ export const zTimeEntryImportResponseObject = z.object({
         'processing',
         'processed',
         'success',
-        'failed'
+        'failed',
+        'superseded'
     ]),
     processed_rows_count: z.int(),
     processing_errors: z.array(zImportProcessingError),
@@ -6521,6 +6634,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()
@@ -9185,6 +9306,39 @@ 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()
+});
+export const zUpdateGenesisPath = z.object({
+    employment_id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateGenesisResponse = zPeopleEmploymentResponseObject;
 export const zListEmploymentHistoryPath = z.object({
     employment_id: z.string()
 });
@@ -9221,6 +9375,61 @@ export const zListEmploymentsHistoryResponse = z.object({
     links: zLinks,
     data: z.array(zPeopleEmploymentHistoryVersionObject)
 });
+export const zCreateEmploymentScheduledChangeBody = zPeopleEmploymentScheduledChangeCreateParameters;
+export const zCreateEmploymentScheduledChangeHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCreateEmploymentScheduledChangePath = z.object({
+    employment_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateEmploymentScheduledChangeResponse = zPeopleEmploymentResponseObject;
+export const zDeleteEmploymentScheduledChangeHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zDeleteEmploymentScheduledChangePath = z.object({
+    employment_id: z.string(),
+    effective_date: z.iso.date()
+});
+/**
+ * No Content
+ */
+export const zDeleteEmploymentScheduledChangeResponse = z.void();
+export const zUpdateEmploymentScheduledChangeBody = zPeopleEmploymentScheduledChangeUpdateParameters;
+export const zUpdateEmploymentScheduledChangeHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zUpdateEmploymentScheduledChangePath = z.object({
+    employment_id: z.string(),
+    effective_date: z.iso.date()
+});
+/**
+ * Success
+ */
+export const zUpdateEmploymentScheduledChangeResponse = zPeopleEmploymentResponseObject;
+export const zDeleteScheduledTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zDeleteScheduledTerminationPath = z.object({
+    employment_id: z.string()
+});
+/**
+ * Success
+ */
+export const zDeleteScheduledTerminationResponse = zPeopleEmploymentResponseObject;
+export const zCreateEmploymentScheduledTerminationBody = zPeopleEmploymentScheduledTerminationParameters;
+export const zCreateEmploymentScheduledTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCreateEmploymentScheduledTerminationPath = z.object({
+    employment_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateEmploymentScheduledTerminationResponse = zPeopleEmploymentResponseObject;
 export const zListEmploymentsQuery = z.object({
     'filter[user_id]': z.string().optional(),
     filter: z.string().optional(),
@@ -9242,6 +9451,21 @@ export const zListEmploymentsResponse = z.object({
     links: zLinks,
     data: z.array(zPeopleEmploymentResponseObject)
 });
+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()
 });
@@ -9252,6 +9476,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.21.0",
+  "version": "0.23.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",