@dsptch-work/api-client 0.27.0 → 0.28.0

package/CHANGELOG.md

@@ -5,6 +5,18 @@ All notable changes to `@dsptch-work/api-client` are documented here. The format
 [Semantic Versioning](https://semver.org) — currently `0.x`, so breaking changes may land in a
 minor bump until `1.0.0`. See [RELEASING.md](./RELEASING.md) for the release and versioning process.
 
+## [0.28.0] - 2026-10-01
+
+### Added
+
+- `WageDeterminationResponseObject.uid` (required, UUID), returned by `WageDeterminations.listWageDeterminations()` and `getWageDetermination()`. Every modification of one annual general decision shares the same `uid`; `id` still identifies one revision. Code that builds wage-determination response literals must supply `uid`.
+- `FormDefinitionObject.assignment_only` (required boolean), returned by `Forms.listFormDefinitions()` and `getFormDefinition()`. Code that builds form-definition response literals must supply `assignment_only`.
+- `PerDiems.listPerDiems()` and `ApprenticeshipApprentices.listApprentices()` query accept optional `filter[name]` (fuzzy name match; for apprentices, the worker's name). Existing filters still assign.
+- `ProductionCompletions.listCompletions()` query accepts optional `filter[site_id]`, `filter[crew_user_id]`, `filter[crew_department_id]`, and `filter[crew_group_id]`.
+- Zod: `zWageDeterminationResponseObject` requires `uid` (`z.uuid()`) and `zFormDefinitionObject` requires `assignment_only`, so payloads without those keys no longer parse.
+
+See the [API changelog](https://dsptch.app/support/docs/developers/api-changelog) for scopes, status codes, and field rules.
+
 ## [0.27.0] - 2026-09-30
 
 ### Added

package/dist/gen/types.gen.d.ts

@@ -5139,6 +5139,10 @@ export type FormDefinitionObject = {
      * Whether the form is always shown to users.
      */
     always_visible: boolean;
+    /**
+     * Whether the form is hidden from free-submit catalogs and available only through assignments and tasks.
+     */
+    assignment_only: boolean;
     /**
      * Whether the form collects sensitive data.
      */
@@ -10295,6 +10299,10 @@ export type WageDeterminationResponseObject = {
      * Identifier of this determination record — permanent, because the record is an immutable DOL publication; a DOL revision arrives as a new record linked through superseded_by_wage_determination_id, not a rewrite of this one.
      */
     id: string;
+    /**
+     * Stable UUID identifying the annual general decision family, shared by every modification. A successor-year general decision has its own UID. Use id to retrieve a specific published revision.
+     */
+    uid: string;
     /**
      * DOL general decision number identifying this determination (e.g. "CA20240001"); combine with modification_number for the full versioned identifier (e.g. "CA20240001/1").
      */
@@ -13668,6 +13676,10 @@ export type ListApprenticesData = {
          *
          */
         'filter[status]'?: string;
+        /**
+         * Fuzzy-matches the enrolled worker name (trigram word-similarity). Matches the user name only — not the program, occupation, or wage-schedule name.
+         */
+        'filter[name]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;
@@ -24163,6 +24175,10 @@ export type ListPerDiemsData = {
          * Filter by taxable status
          */
         'filter[taxable]'?: boolean;
+        /**
+         * Fuzzy-matches the per diem name (trigram word-similarity). Matches the name column only.
+         */
+        'filter[name]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;
@@ -24504,6 +24520,22 @@ export type ListCompletionsData = {
         'filter[scope_kind]'?: string;
         'filter[feature_id]'?: string;
         'filter[created_by_user_id]'?: string;
+        /**
+         * Feature completions on this site, or quantity completions on a job that has exactly this one site.
+         */
+        'filter[site_id]'?: string;
+        /**
+         * Completions whose crew includes this worker. Distinct from created_by_user_id (the filer).
+         */
+        'filter[crew_user_id]'?: string;
+        /**
+         * Completions whose crew includes a current member of this department.
+         */
+        'filter[crew_department_id]'?: string;
+        /**
+         * Completions whose crew includes a member of this group.
+         */
+        'filter[crew_group_id]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;

package/dist/gen/zod.gen.d.ts

@@ -2394,6 +2394,7 @@ export declare const zFormDefinitionObject: z.ZodObject<{
     title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
     editable: z.ZodBoolean;
     always_visible: z.ZodBoolean;
+    assignment_only: z.ZodBoolean;
     sensitive_form: z.ZodBoolean;
     allow_carry_forward: z.ZodBoolean;
     current_revision: z.ZodNullable<z.ZodInt>;
@@ -6109,6 +6110,7 @@ export declare const zFormDefinitionResponseObject: z.ZodObject<{
         title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
         editable: z.ZodBoolean;
         always_visible: z.ZodBoolean;
+        assignment_only: z.ZodBoolean;
         sensitive_form: z.ZodBoolean;
         allow_carry_forward: z.ZodBoolean;
         current_revision: z.ZodNullable<z.ZodInt>;
@@ -6648,6 +6650,7 @@ export declare const zDateTimeFilter: z.ZodNullable<z.ZodObject<{
  */
 export declare const zWageDeterminationResponseObject: z.ZodObject<{
     id: z.ZodString;
+    uid: z.ZodUUID;
     general_decision_number: z.ZodString;
     modification_number: z.ZodInt;
     superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;
@@ -6675,6 +6678,7 @@ export declare const zWageDeterminationsResponseObject: z.ZodObject<{
     }, z.core.$strip>;
     data: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
+        uid: z.ZodUUID;
         general_decision_number: z.ZodString;
         modification_number: z.ZodInt;
         superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;
@@ -9659,6 +9663,7 @@ export declare const zListApprenticesPath: z.ZodObject<{
 export declare const zListApprenticesQuery: z.ZodObject<{
     'filter[user_id]': z.ZodOptional<z.ZodString>;
     'filter[status]': z.ZodOptional<z.ZodString>;
+    'filter[name]': z.ZodOptional<z.ZodString>;
     'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
     'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
     'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
@@ -15812,6 +15817,7 @@ export declare const zListFormDefinitionsResponse: z.ZodObject<{
         title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
         editable: z.ZodBoolean;
         always_visible: z.ZodBoolean;
+        assignment_only: z.ZodBoolean;
         sensitive_form: z.ZodBoolean;
         allow_carry_forward: z.ZodBoolean;
         current_revision: z.ZodNullable<z.ZodInt>;
@@ -15835,6 +15841,7 @@ export declare const zGetFormDefinitionResponse: z.ZodObject<{
     title_keys: z.ZodNullable<z.ZodArray<z.ZodString>>;
     editable: z.ZodBoolean;
     always_visible: z.ZodBoolean;
+    assignment_only: z.ZodBoolean;
     sensitive_form: z.ZodBoolean;
     allow_carry_forward: z.ZodBoolean;
     current_revision: z.ZodNullable<z.ZodInt>;
@@ -22802,6 +22809,7 @@ export declare const zUpdateEmploymentResponse: z.ZodObject<{
 export declare const zListPerDiemsQuery: z.ZodObject<{
     'filter[default]': z.ZodOptional<z.ZodBoolean>;
     'filter[taxable]': z.ZodOptional<z.ZodBoolean>;
+    'filter[name]': z.ZodOptional<z.ZodString>;
     'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
     'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
     'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
@@ -23041,6 +23049,10 @@ export declare const zListCompletionsQuery: z.ZodObject<{
     'filter[scope_kind]': z.ZodOptional<z.ZodString>;
     'filter[feature_id]': z.ZodOptional<z.ZodString>;
     'filter[created_by_user_id]': z.ZodOptional<z.ZodString>;
+    'filter[site_id]': z.ZodOptional<z.ZodString>;
+    'filter[crew_user_id]': z.ZodOptional<z.ZodString>;
+    'filter[crew_department_id]': z.ZodOptional<z.ZodString>;
+    'filter[crew_group_id]': z.ZodOptional<z.ZodString>;
     'filter[created_at][gte]': z.ZodOptional<z.ZodISODateTime>;
     'filter[created_at][lte]': z.ZodOptional<z.ZodISODateTime>;
     'filter[updated_at][gte]': z.ZodOptional<z.ZodISODateTime>;
@@ -29105,6 +29117,7 @@ export declare const zListWageDeterminationsResponse: z.ZodObject<{
     }, z.core.$strip>;
     data: z.ZodArray<z.ZodObject<{
         id: z.ZodString;
+        uid: z.ZodUUID;
         general_decision_number: z.ZodString;
         modification_number: z.ZodInt;
         superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;
@@ -29124,6 +29137,7 @@ export declare const zGetWageDeterminationPath: z.ZodObject<{
  */
 export declare const zGetWageDeterminationResponse: z.ZodObject<{
     id: z.ZodString;
+    uid: z.ZodUUID;
     general_decision_number: z.ZodString;
     modification_number: z.ZodInt;
     superseded_by_wage_determination_id: z.ZodNullable<z.ZodString>;

package/dist/gen/zod.gen.js

@@ -2198,6 +2198,7 @@ export const zFormDefinitionObject = z.object({
     title_keys: z.array(z.string()).nullable(),
     editable: z.boolean(),
     always_visible: z.boolean(),
+    assignment_only: z.boolean(),
     sensitive_form: z.boolean(),
     allow_carry_forward: z.boolean(),
     current_revision: z.int().nullable(),
@@ -5535,6 +5536,7 @@ export const zDateTimeFilter = z.object({
  */
 export const zWageDeterminationResponseObject = z.object({
     id: z.string(),
+    uid: z.uuid(),
     general_decision_number: z.string(),
     modification_number: z.int(),
     superseded_by_wage_determination_id: z.string().nullable(),
@@ -7347,6 +7349,7 @@ export const zListApprenticesPath = z.object({
 export const zListApprenticesQuery = z.object({
     'filter[user_id]': z.string().optional(),
     'filter[status]': 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(),
@@ -10480,6 +10483,7 @@ export const zUpdateEmploymentResponse = zPeopleEmploymentResponseObject;
 export const zListPerDiemsQuery = z.object({
     'filter[default]': z.boolean().optional(),
     'filter[taxable]': z.boolean().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(),
@@ -10575,6 +10579,10 @@ export const zListCompletionsQuery = z.object({
     'filter[scope_kind]': z.string().optional(),
     'filter[feature_id]': z.string().optional(),
     'filter[created_by_user_id]': z.string().optional(),
+    'filter[site_id]': z.string().optional(),
+    'filter[crew_user_id]': z.string().optional(),
+    'filter[crew_department_id]': z.string().optional(),
+    'filter[crew_group_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(),

package/package.json

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