@dsptch-work/api-client 0.28.0 → 0.30.0

package/dist/gen/zod.gen.js

@@ -440,6 +440,7 @@ export const zDirectUploadParameters = z.object({
         'pay_periods.imports.dsptch_cprs',
         'pay_periods.imports.time_entries',
         'payrolls.payroll_runs.imports.paystubs',
+        'payrolls.payroll_runs.imports.wide_paystubs',
         'users'
     ]),
     blob: z.object({
@@ -2754,6 +2755,35 @@ export const zPaystubImportResponseObject = z.object({
 export const zPaystubImportParameters = z.object({
     file_signed_id: z.string()
 });
+/**
+ * One bulk upload of wide paystub amounts against a payroll run, and how it turned out.
+ */
+export const zWidePaystubImportResponseObject = z.object({
+    id: z.string(),
+    payrolls_payroll_run_id: z.string(),
+    status: z.enum([
+        'pending',
+        'processing',
+        'processed',
+        'success',
+        'failed',
+        'superseded',
+        'withdrawn'
+    ]),
+    processed_rows_count: z.int(),
+    processing_errors: z.array(zImportProcessingError),
+    completed_at: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * Submit a spreadsheet of wide paystub amounts for a payroll run. Each row is one employee: payroll_id names them, and every other column is a pay, deduction, or contribution amount. Extra pay-element columns are accepted; they are not unknown columns. The run's pay schedule must record the contributor on the external map (`requires_external_map_contributor`) and must not be connected to a payroll provider; where a provider is configured the paystubs come from that connection and a file is refused. payroll_id must be present as a header and carry a value on every row, or the file is refused naming what is missing. Header matching ignores case and treats spaces as underscores, and column order does not matter.
+ *
+ * Because acceptance is synchronous but the write happens in the background, only one wide paystub import at a time is accepted for a payroll run: while an earlier one is still `pending` or `processing`, a second answers 409 naming `import_in_progress`, and nothing is written. Poll the earlier import until it reports, then submit again.
+ */
+export const zWidePaystubImportParameters = z.object({
+    file_signed_id: z.string()
+});
 /**
  * One bulk upload of time entries against a pay period, and how it turned out.
  */
@@ -2962,6 +2992,37 @@ export const zTimeSessionResponseObject = z.object({
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
 });
+/**
+ * A worker request for non-working time (R&R, PTO, and the other absence types). Approval produces an Absence; this read surface does not nest that Absence or the request's comments.
+ */
+export const zTimeOffRequestResponseObject = z.object({
+    id: z.string(),
+    user_id: z.string(),
+    status: z.enum([
+        'pending',
+        'approved',
+        'denied',
+        'cancelled',
+        'expired'
+    ]),
+    absence_type: z.enum([
+        'rest_and_recovery',
+        'vacation',
+        'bereavement',
+        'ca_covid_19_sick',
+        'custom',
+        'jury_duty',
+        'unpaid',
+        'training',
+        'bench'
+    ]),
+    start_time: z.iso.datetime(),
+    end_time: z.iso.datetime(),
+    reviewed_at: z.iso.datetime().nullable(),
+    reviewer_user_id: z.string().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
 /**
  * Request body for locking or unlocking a time card.
  */
@@ -3293,7 +3354,7 @@ export const zProjectResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Request body for creating or updating a project. Only `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body. Omit relationship fields on PATCH to leave them unchanged.
+ * Request body for creating a project. `name` and `created_by_user_id` are required; the creator must be a member of the owning company. The owning company is inferred from the API key and is not part of the body. Undeclared body keys return 400 before any project or relationship is saved.
  */
 export const zProjectParameters = z.object({
     external_id: z.string().nullish(),
@@ -3329,7 +3390,7 @@ export const zProjectParameters = z.object({
     placed_in_service_date: z.iso.date().nullish()
 });
 /**
- * Request body for updating a project. Every field is optional; omit a field to preserve its current value. The resulting project must still satisfy conditional PWA, regional, and schedule validation rules. `created_by_user_id` is create-only and an update that names it is rejected.
+ * Request body for updating a project. Every field is optional; omit a field to preserve its current value. The resulting project must still satisfy conditional PWA, regional, and schedule validation rules. `created_by_user_id` is create-only; omit it on PATCH. Every update that includes it returns 400, even when unchanged. Undeclared body keys return 400 before any project or relationship changes.
  */
 export const zProjectUpdateParameters = z.object({
     external_id: z.string().nullish(),
@@ -4089,7 +4150,7 @@ export const zPaystubLineItemResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Request body for creating a paystub line item. All four fields are required.
+ * Request body for creating a paystub line item. All four fields are required. Undeclared body keys are rejected with 400; references outside the authenticated company return 404.
  */
 export const zPaystubLineItemParameters = z.object({
     payrolls_paystub_id: z.string(),
@@ -4098,7 +4159,7 @@ export const zPaystubLineItemParameters = z.object({
     payrolls_external_map_id: z.string()
 });
 /**
- * Request body for updating a paystub line item. Send only the fields to change.
+ * Request body for updating a paystub line item. Send only the fields to change. Undeclared body keys are rejected with 400; newly supplied references outside the authenticated company return 404.
  */
 export const zPaystubLineItemUpdateParameters = z.object({
     payrolls_paystub_id: z.string().optional(),
@@ -5205,7 +5266,7 @@ export const zUserParameters = z.intersection(z.union([
     dol_apprentice_no: z.string().optional(),
     winda_id: z.string().optional(),
     linkedin_url: z.string().optional(),
-    roles: z.array(z.string()).optional(),
+    roles: z.array(z.string()).nullish(),
     avatar_signed_id: z.string().optional(),
     created_by_user_id: z.string().optional(),
     last_sent_by_user_id: z.string().nullish(),
@@ -5227,7 +5288,7 @@ export const zUserParameters = z.intersection(z.union([
     holiday_annual_minutes: z.string().optional(),
     training_annual_minutes: z.string().optional(),
     hire_date: z.string().optional(),
-    group_ids: z.array(z.int()).optional(),
+    group_ids: z.array(z.uuid()).nullish(),
     custom_fields: z.array(z.object({
         custom_field_config_id: z.string(),
         value: z.string().nullable()
@@ -5468,6 +5529,14 @@ export const zTimeSessionsResponseObject = z.object({
     links: zLinks,
     data: z.array(zTimeSessionResponseObject)
 });
+/**
+ * A page of time-off requests, with pagination metadata and navigation links.
+ */
+export const zTimeOffRequestsResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zTimeOffRequestResponseObject)
+});
 /**
  * A page of payroll runs, with pagination metadata and navigation links.
  */
@@ -8902,6 +8971,7 @@ export const zListFormSubmissionDeltasQuery = z.object({
 export const zListFormSubmissionDeltasResponse = zFormSubmissionDeltasResponse;
 export const zListFormSubmissionsQuery = z.object({
     'filter[form_definition_id]': z.string().optional(),
+    'filter[user_id]': 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(),
@@ -9361,6 +9431,18 @@ export const zListJobsQuery = z.object({
     ]).optional(),
     'filter[name]': z.string().optional(),
     'filter[purchase_order_number]': z.string().optional(),
+    'filter[federal_pwa_mode]': z.array(z.enum([
+        'all',
+        'pw_only',
+        'ap_only',
+        'none'
+    ])).optional(),
+    'filter[regional_pwa_mode]': z.array(z.enum([
+        'all',
+        'pw_only',
+        'ap_only',
+        'none'
+    ])).optional(),
     'page[cursor]': z.string().optional(),
     'page[limit]': z.int().gte(1).optional().default(20),
     page: z.string().optional(),
@@ -10173,9 +10255,51 @@ export const zGetPaystubImportPath = z.object({
  * Success
  */
 export const zGetPaystubImportResponse = zPaystubImportResponseObject;
+export const zListWidePaystubImportsPath = z.object({
+    payroll_run_id: z.string()
+});
+export const zListWidePaystubImportsQuery = z.object({
+    'filter[status]': z.string().optional(),
+    'filter[completed_at][gte]': z.iso.datetime().optional(),
+    'filter[completed_at][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(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListWidePaystubImportsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zWidePaystubImportResponseObject)
+});
+export const zCreateWidePaystubImportBody = zWidePaystubImportParameters;
+export const zCreateWidePaystubImportPath = z.object({
+    payroll_run_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateWidePaystubImportResponse = zWidePaystubImportResponseObject;
+export const zGetWidePaystubImportPath = z.object({
+    payroll_run_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetWidePaystubImportResponse = zWidePaystubImportResponseObject;
 export const zListPayrollRunsQuery = z.object({
     'filter[run_type]': z.string().optional(),
     'filter[timekeeping_pay_period_id]': z.string().optional(),
+    'filter[user_id]': z.string().optional(),
     'filter[run_date][gte]': z.iso.date().optional(),
     'filter[run_date][lte]': z.iso.date().optional(),
     'filter[created_at][gte]': z.iso.datetime().optional(),
@@ -10938,6 +11062,9 @@ export const zListPositionsPath = z.object({
     job_id: z.string()
 });
 export const zListPositionsQuery = z.object({
+    'filter[fulfilled_by_user_id]': z.string().optional(),
+    'filter[fulfilled_by_user_id][null]': z.boolean().optional(),
+    'filter[position_function_id]': 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(),
@@ -11154,6 +11281,7 @@ export const zCreateWorkerTimeCardApprovalResponse = zTimeCardApprovalResponseOb
 export const zListTimeCardsQuery = z.object({
     'filter[timekeeping_pay_period_id]': z.string().optional(),
     'filter[user_id]': z.string().optional(),
+    'filter[job_id]': z.string().optional(),
     'filter[start_time][gte]': z.iso.datetime().optional(),
     'filter[start_time][lte]': z.iso.datetime().optional(),
     filter: z.string().optional(),
@@ -11560,6 +11688,30 @@ export const zGetTimeCardActualPath = z.object({
  * Success
  */
 export const zGetTimeCardActualResponse = zTimeCardActualsResponseObject;
+export const zListTimeOffRequestsQuery = z.object({
+    'filter[user_id]': z.string().optional(),
+    'filter[status]': z.enum([
+        'pending',
+        'approved',
+        'denied',
+        'cancelled',
+        'expired'
+    ]).optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListTimeOffRequestsResponse = zTimeOffRequestsResponseObject;
+export const zGetTimeOffRequestPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetTimeOffRequestResponse = zTimeOffRequestResponseObject;
 export const zListTimeSessionsQuery = z.object({
     'filter[user_id]': z.string().optional(),
     'filter[job_id]': z.string().optional(),
@@ -11714,6 +11866,8 @@ export const zListUsersQuery = z.object({
         'all'
     ]).optional(),
     'filter[name]': z.string().optional(),
+    'filter[manager_user_id]': z.string().optional(),
+    'filter[department_id]': z.string().optional(),
     'page[cursor]': z.string().optional(),
     'page[limit]': z.int().gte(1).optional().default(20),
     page: z.string().optional(),

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.28.0",
+  "version": "0.30.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",
@@ -57,7 +57,7 @@
     "@hey-api/openapi-ts": "^0.99.0",
     "publint": "^0.3.22",
     "typescript": "^6.0.3",
-    "vitest": "^4.1.11"
+    "vitest": "^5.0.2"
   },
   "scripts": {
     "generate": "openapi-ts",