@dsptch-work/api-client 0.41.0 → 0.42.0

package/dist/gen/zod.gen.js

@@ -234,6 +234,12 @@ export const zProblem = z.object({
  *
  * The upload behind an image attachment's signed id is not an image content type. Upload an image file.
  *
+ * ### certified_payroll_format_unavailable
+ *
+ * **Certified Payroll Format Unavailable**
+ *
+ * The named job does not offer this certified payroll format. WH-347 is available only on a job that tracks federal prevailing wage. Use a job that offers the format.
+ *
  * ### company_not_employer
  *
  * **Company Not Program Employer**
@@ -288,6 +294,18 @@ export const zProblem = z.object({
  *
  * An attachment signed id names no upload this endpoint can read. A signed id is issued for one `resource` and verifies only there, so an id for a different resource is indistinguishable from one that is malformed, expired, or tampered with, and all of them answer alike. The message names the resource the upload needed; upload the file again to the direct-uploads endpoint naming it, and pass the signed id that call returns.
  *
+ * ### not_incomplete_permanent_copy
+ *
+ * **Not An Incomplete Permanent Copy**
+ *
+ * Ending a form assignment task is allowed only for the open incomplete permanent copy. Completed copies, non-permanent rows, and other uid-family members are refused. Re-read the assignment and end only that open copy.
+ *
+ * ### nothing_exportable
+ *
+ * **Nothing Exportable**
+ *
+ * The requested date range has no reportable pay periods to file for this job. Certified payroll starts at the first week with PWA work and includes only periods whose pay date has elapsed (or, in aggregate mode, periods that have ended). Widen or shift the range, or wait until a period is reportable.
+ *
  * ### nothing_to_cancel
  *
  * **Nothing To Cancel**
@@ -403,6 +421,7 @@ export const zProblemTypeCatalog = z.enum([
     'version_overlap',
     'precondition_failed',
     'attachment_not_image',
+    'certified_payroll_format_unavailable',
     'company_not_employer',
     'confirm_apprenticeship_conflict',
     'destroy_restricted',
@@ -412,6 +431,8 @@ export const zProblemTypeCatalog = z.enum([
     'invalid_iso8601_duration',
     'invalid_placement_move',
     'invalid_signed_id',
+    'not_incomplete_permanent_copy',
+    'nothing_exportable',
     'nothing_to_cancel',
     'pagination_failed',
     'subtype_foreign_keys',
@@ -2923,6 +2944,18 @@ export const zTimeEntryResponseObject = z.object({
     hourly_rate_cents: z.string().nullish(),
     currency: z.string().optional(),
     hourly_rate_src_type: z.string().nullish(),
+    one_five_x_adder_rate_cents: z.string().nullish(),
+    one_five_x_adder_rate_src_type: z.enum([
+        'position',
+        'prevailing_wage',
+        'custom'
+    ]).nullish(),
+    two_x_adder_rate_cents: z.string().nullish(),
+    two_x_adder_rate_src_type: z.enum([
+        'position',
+        'prevailing_wage',
+        'custom'
+    ]).nullish(),
     timekeeping_pay_period_id: z.string(),
     start_time: z.iso.datetime(),
     end_time: z.iso.datetime(),
@@ -2971,6 +3004,8 @@ export const zTimeEntryCreateParameters = z.object({
     state: z.string().nullish(),
     description: z.string().nullish(),
     hourly_rate_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
+    one_five_x_adder_rate_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
+    two_x_adder_rate_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
     feature_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     feature_allocation_acknowledged: z.boolean().optional()
 });
@@ -2985,6 +3020,8 @@ export const zTimeEntryUpdateParameters = z.object({
     state: z.string().nullish(),
     description: z.string().nullish(),
     hourly_rate_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
+    one_five_x_adder_rate_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
+    two_x_adder_rate_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
     feature_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     confirm_allocation_conflict: z.boolean().optional()
 });
@@ -5203,6 +5240,45 @@ export const zJobGoodFaithEffortExceptionUpdateParameters = z.object({
     no_availability_proof_signed_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
     performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional()
 });
+/**
+ * A job-scoped WH-347 certified-payroll export. The generation handle is polled through this same document; `file` is null until a ZIP is attached. Signing fields are not published.
+ */
+export const zJobWh347ExportResponseObject = z.object({
+    id: z.string(),
+    job_id: z.string(),
+    start_date: z.iso.date(),
+    end_date: z.iso.date(),
+    status: z.enum([
+        'pending',
+        'processing',
+        'signing',
+        'signed',
+        'certifying',
+        'success',
+        'failed'
+    ]),
+    file: z.object({
+        filename: z.string(),
+        content_type: z.string().nullable(),
+        byte_size: z.int(),
+        url: z.string()
+    }).nullable(),
+    invalidated_at: z.iso.datetime().nullable(),
+    invalidation_reason: z.enum([
+        'source_data_changed',
+        'source_records_deleted',
+        'ratio_status_changed'
+    ]).nullable(),
+    version: z.enum(['v1', 'v2']),
+    created_at: z.iso.datetime()
+});
+/**
+ * Start a job-scoped WH-347 certified-payroll export over a calendar window. Creation requires a user-scoped API key, because the generation handle attributes the export to a person. The response is the pending export; poll the member GET for status and the file URL. Version, filename, and signing are server-owned. A job that does not offer WH-347 answers 422 certified_payroll_format_unavailable. A window with no reportable pay periods answers 422 nothing_exportable.
+ */
+export const zJobWh347ExportCreateParameters = z.object({
+    start_date: z.iso.date(),
+    end_date: z.iso.date()
+});
 /**
  * A form-completion task attached to a job — a SurveyJS form assigned to users with a due time, optional recurrence, and reminders. Path `{id}` is the `Tasks::JobFormAssignmentTask` id, not the web show `Task#uid`.
  */
@@ -5767,20 +5843,20 @@ export const zPositionParameters = z.object({
     }).optional()
 });
 /**
- * Parameters for creating a per-unit scope price on a job. `scope_kind` and `unit_price_cents` are required; omitting either answers 400, and a null or wrong-typed value answers 422.
+ * Parameters for creating a per-unit scope price on a job. `scope_kind` is required; omission answers 400. Omit `unit_price_cents` or send null to create with an unknown price. Supplied nonnull prices must be nonnegative decimal strings.
  */
 export const zProductionJobScopePriceParameters = z.object({
     scope_kind: z.string(),
-    unit_price_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/),
+    unit_price_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
     contracted_count: z.int().nullish(),
     unit_of_measure: z.string().optional()
 });
 /**
- * Parameters for updating a per-unit scope price on a job. Every field is optional; omit a field to preserve its current value, or send null for `contracted_count` to clear it. A null or wrong-typed value for any other field answers 422. The resulting price must retain a scope kind and non-negative unit price.
+ * Parameters for updating a per-unit scope price on a job. Every field is optional; omit a field to preserve its current value. Send null for `unit_price_cents` to clear the known price, or for `contracted_count` to clear the target. A null value for any other field, or a wrong-typed value, answers 422. The resulting price must retain a scope kind; supplied nonnull prices must be nonnegative decimal strings.
  */
 export const zProductionJobScopePriceUpdateParameters = z.object({
     scope_kind: z.string().optional(),
-    unit_price_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).optional(),
+    unit_price_cents: z.string().regex(/^[0-9]+(\.[0-9]+)?$/).nullish(),
     contracted_count: z.int().nullish(),
     unit_of_measure: z.string().optional()
 });
@@ -5792,7 +5868,7 @@ export const zProductionJobScopePriceResponseObject = z.object({
     job_id: z.string(),
     scope_kind: z.string(),
     unit_of_measure: z.string(),
-    unit_price_cents: z.string().optional(),
+    unit_price_cents: z.string().nullish(),
     contracted_count: z.int().nullish(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
@@ -6460,6 +6536,14 @@ export const zJobGoodFaithEffortExceptionsResponseObject = z.object({
     links: zLinks,
     data: z.array(zJobGoodFaithEffortExceptionResponseObject)
 });
+/**
+ * A page of a job's WH-347 certified-payroll exports, with pagination metadata and navigation links.
+ */
+export const zJobWh347ExportsResponseObject = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zJobWh347ExportResponseObject)
+});
 /**
  * A page of a job's PWA cure payments, with pagination metadata and navigation links.
  */
@@ -6710,21 +6794,14 @@ export const zFederalJobWageDeterminationHistoryCorrectionObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * State-specific rate fields recorded on a Regional determination, as decimal-string money in
- * cents (e.g. "538.0"). Which keys appear is set by the job's region, so this object is always
- * a region-determined subset of these keys — never a fixed shape:
- *
- * - Categorized-fringe regions (currently IL) carry `combined_health_fringe_rate_cents`,
- * `combined_savings_fringe_rate_cents`, `combined_holiday_pto_fringe_rate_cents`,
- * `training_fringe_rate_cents`, and `other_fringe_rate_cents`.
- * - Overtime-adder regions (currently IL and NY) carry `one_five_x_adder_rate_cents`,
- * `two_x_adder_rate_cents`, `one_five_x_fringe_adder_rate_cents`, and
- * `two_x_fringe_adder_rate_cents`.
- * - A region with neither returns an empty object.
+ * State-specific categorized fringe rates recorded on a Regional determination, as decimal-string
+ * money in cents (e.g. "538.0"). Categorized-fringe regions (currently IL) carry
+ * `combined_health_fringe_rate_cents`, `combined_savings_fringe_rate_cents`,
+ * `combined_holiday_pto_fringe_rate_cents`, `training_fringe_rate_cents`, and
+ * `other_fringe_rate_cents`. These values are non-null when present. Other regions return an empty object.
  *
- * Categorized-fringe values are non-null when present; legacy overtime-adder values may be null.
- * The overtime-adder fields are read-only. Configure new overtime premiums through the
- * determination's rate rules.
+ * Overtime wage and fringe premiums belong to the determination's rate-rule package. They are not
+ * returned as scalar regional rate fields.
  *
  */
 export const zRegionalWageDeterminationFieldsResponse = z.record(z.string(), z.string().nullable());
@@ -9344,6 +9421,14 @@ export const zCreateItemFormAssignmentTaskPath = z.object({
  * Created (recurring, with assignees and reminders)
  */
 export const zCreateItemFormAssignmentTaskResponse = zAssetsItemFormAssignmentResponseObject;
+export const zDeleteFormAssignmentTaskPath = z.object({
+    item_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteFormAssignmentTaskResponse = z.void();
 export const zGetFormAssignmentTaskPath = z.object({
     item_id: z.string(),
     id: z.string()
@@ -9416,6 +9501,10 @@ export const zListVersionsPath = z.object({
     item_id: z.string(),
     document_id: z.string()
 });
+export const zListVersionsQuery = z.object({
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional()
+});
 /**
  * Success
  */
@@ -9815,16 +9904,23 @@ export const zGetAtlasSitePath = z.object({
  */
 export const zGetAtlasSiteResponse = zSiteResponseObject;
 export const zListPwaUserCountsByProjectByMonthsQuery = z.object({
-    'filter[year_month]': z.string().optional(),
+    'filter[year_month]': z.string().regex(/^\d{4}-(0[1-9]|1[0-2])$/).optional(),
     'filter[project_id]': z.string().optional(),
     'filter[job_id]': z.string().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 zListPwaUserCountsByProjectByMonthsResponse = z.array(zBillingPwaUserCountByProjectByMonthResponseObject);
+export const zListPwaUserCountsByProjectByMonthsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zBillingPwaUserCountByProjectByMonthResponseObject)
+});
 export const zListPackagesQuery = z.object({
     'filter[name]': z.string().optional(),
     'filter[created_at][gte]': z.iso.datetime().optional(),
@@ -9944,7 +10040,7 @@ export const zListCertificationsQuery = z.object({
 export const zListCertificationsResponse = zCertificationsResponseObject;
 export const zCreateCertificationBody = zCertificationParameters;
 /**
- * Success
+ * Created
  */
 export const zCreateCertificationResponse = zCertificationResponseObject;
 export const zDeleteCertificationPath = z.object({
@@ -10937,6 +11033,14 @@ export const zCreateJobFormAssignmentTaskPath = z.object({
  * Created (recurring, with assignees and reminders)
  */
 export const zCreateJobFormAssignmentTaskResponse = zJobFormAssignmentResponseObject;
+export const zDeleteJobFormAssignmentTaskPath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteJobFormAssignmentTaskResponse = z.void();
 export const zGetJobFormAssignmentTaskPath = z.object({
     job_id: z.string(),
     id: z.string()
@@ -11057,6 +11161,37 @@ export const zUpdateGoodFaithEffortExceptionPath = z.object({
  * Success
  */
 export const zUpdateGoodFaithEffortExceptionResponse = zJobGoodFaithEffortExceptionResponseObject;
+export const zListWh347ExportsPath = z.object({
+    job_id: z.string()
+});
+export const zListWh347ExportsQuery = z.object({
+    'filter[status]': z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListWh347ExportsResponse = zJobWh347ExportsResponseObject;
+export const zCreateWh347ExportBody = zJobWh347ExportCreateParameters;
+export const zCreateWh347ExportPath = z.object({
+    job_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateWh347ExportResponse = zJobWh347ExportResponseObject;
+export const zGetWh347ExportPath = z.object({
+    job_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetWh347ExportResponse = zJobWh347ExportResponseObject;
 export const zListCurePaymentsPath = z.object({
     job_id: z.string()
 });
@@ -11597,6 +11732,15 @@ export const zCreateFeatureFormAssignmentTaskPath = z.object({
  * Created
  */
 export const zCreateFeatureFormAssignmentTaskResponse = zFeatureFormAssignmentResponseObject;
+export const zDeleteFeatureFormAssignmentTaskPath = z.object({
+    site_id: z.string(),
+    feature_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteFeatureFormAssignmentTaskResponse = z.void();
 export const zGetFeatureFormAssignmentTaskPath = z.object({
     site_id: z.string(),
     feature_id: z.string(),
@@ -11640,6 +11784,14 @@ export const zCreateSiteFormAssignmentTaskPath = z.object({
  * Created
  */
 export const zCreateSiteFormAssignmentTaskResponse = zSiteFormAssignmentResponseObject;
+export const zDeleteSiteFormAssignmentTaskPath = z.object({
+    site_id: z.string(),
+    id: z.string()
+});
+/**
+ * No Content
+ */
+export const zDeleteSiteFormAssignmentTaskResponse = z.void();
 export const zGetSiteFormAssignmentTaskPath = z.object({
     site_id: z.string(),
     id: z.string()
@@ -12815,7 +12967,9 @@ export const zListProjectDocumentVersionsPath = z.object({
 export const zListProjectDocumentVersionsQuery = z.object({
     'page[cursor]': z.string().optional(),
     'page[limit]': z.int().gte(1).optional().default(20),
-    page: z.string().optional()
+    page: z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional()
 });
 /**
  * Success
@@ -12993,7 +13147,9 @@ export const zListProjectWageDeterminationRateRulesQuery = z.object({
     as_of: z.string().optional(),
     'as_of[bogus_axis]': z.string().optional(),
     'as_of[valid][gte]': z.string().optional(),
-    'as_of[transaction]': z.string().optional()
+    'as_of[transaction]': z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional()
 });
 /**
  * Success
@@ -13055,7 +13211,9 @@ export const zListProjectSitesPath = z.object({
 export const zListProjectSitesQuery = z.object({
     'page[cursor]': z.string().optional(),
     'page[limit]': z.int().gte(1).optional().default(20),
-    page: z.string().optional()
+    page: z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional()
 });
 /**
  * Success
@@ -13229,7 +13387,9 @@ export const zListProjectWageDeterminationsQuery = z.object({
     as_of: z.string().optional(),
     'as_of[bogus_axis]': z.string().optional(),
     'as_of[valid][gte]': z.string().optional(),
-    'as_of[transaction]': z.string().optional()
+    'as_of[transaction]': z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional()
 });
 /**
  * Success
@@ -14307,7 +14467,7 @@ export const zListUserRolesResponse = z.object({
 });
 export const zAddUserRolesBody = zUserRoleRequest;
 /**
- * Success
+ * Created
  */
 export const zAddUserRolesResponse = zUserRoleResponse;
 export const zDeleteUserRolePath = z.object({

package/package.json

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