@dsptch-work/api-client 0.32.0 → 0.33.0

package/dist/gen/zod.gen.js

@@ -176,6 +176,12 @@ export const zProblem = z.object({
  *
  * The resource's timeline already ends at a scheduled termination, and scheduling a second one would silently move it. Moving an end is two steps on purpose: cancel the standing termination, then schedule the one you want.
  *
+ * ### authorization_revoked
+ *
+ * **Authorization Revoked**
+ *
+ * The assessor grant is revoked. A revoked grant keeps its row as history and cannot be changed or revoked again. To make the user an assessor again, grant them anew.
+ *
  * ### import_in_progress
  *
  * **Import In Progress**
@@ -356,11 +362,17 @@ export const zProblem = z.object({
  *
  * ## 503
  *
+ * ### database_timeout
+ *
+ * **Database Timeout**
+ *
+ * A database statement behind the request ran past the server's time limit and was stopped before it finished. The request may be fine as sent — resend it after the `Retry-After` window, and if it keeps timing out, ask for less at once, such as a narrower filter or a smaller page.
+ *
  * ### write_contended
  *
  * **Write Contended**
  *
- * Another write to the same resource held it for longer than this request was willing to wait, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
+ * Another write to the same resource held it for longer than this request was willing to wait, or collided with it, so nothing was applied. The request itself is fine — resend it unchanged after the `Retry-After` window.
  *
  */
 export const zProblemTypeCatalog = z.enum([
@@ -388,6 +400,7 @@ export const zProblemTypeCatalog = z.enum([
     'not_found',
     'already_subscribed',
     'already_terminated',
+    'authorization_revoked',
     'import_in_progress',
     'pay_schedule_already_exists',
     'product_archived',
@@ -416,6 +429,7 @@ export const zProblemTypeCatalog = z.enum([
     'precondition_required',
     'too_many_requests',
     'internal_error',
+    'database_timeout',
     'write_contended'
 ]);
 export const zApiKeyScopeResponseObject = z.object({
@@ -478,6 +492,42 @@ export const zDirectUploadResponseObject = z.object({
         headers: z.record(z.string(), z.string())
     })
 });
+/**
+ * One assessor-registry grant for one standard. Department scope is informational. revoked_at is null while the grant is active.
+ */
+export const zCompetencyAssessorAuthorizationResponseObject = z.object({
+    id: z.string(),
+    user_id: z.string(),
+    competencies_standard_id: z.string(),
+    companies_department_id: z.string().nullable(),
+    kind: z.enum(['authorized_assessor', 'qualified_assessor']),
+    granted_by_user_id: z.string(),
+    granted_at: z.iso.datetime(),
+    revoked_at: z.iso.datetime().nullable(),
+    state: z.enum(['active', 'revoked']),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * Grant an assessor role for one standard. A user key grants as its user. A company key names the grantor. An active grant of the same kind for the same user and standard is unique.
+ */
+export const zCompetencyAssessorAuthorizationParameters = z.object({
+    user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/),
+    kind: z.enum(['authorized_assessor', 'qualified_assessor']),
+    competencies_standard_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/),
+    companies_department_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).nullish(),
+    granted_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional()
+});
+/**
+ * Update the department note on an active grant. Kind, user, standard, and grantor are fixed. A revoked grant answers 409 authorization_revoked.
+ */
+export const zCompetencyAssessorAuthorizationUpdateParameters = z.object({
+    companies_department_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).nullish()
+});
+/**
+ * Revoke an active grant. The body takes no fields; send an empty object or no body. Revocation sets revoked_at and keeps the row; revoking it again answers 409 authorization_revoked.
+ */
+export const zCompetencyAssessorAuthorizationRevocationParameters = z.record(z.string(), z.never());
 /**
  * A durable standing. The candidate passed the standard at level_sort_order. There is no level id, so the standing survives the next revision. This API does not create or update qualifications.
  */
@@ -1363,7 +1413,7 @@ export const zPerDiemResponseObject = z.object({
     currency: z.string(),
     taxable: z.boolean(),
     default: z.boolean().nullable(),
-    active: z.boolean().nullable(),
+    active: z.boolean(),
     work_type_ids: z.array(z.string()),
     timekeeping_timecode_ids: z.array(z.string()),
     created_at: z.iso.datetime(),
@@ -1378,8 +1428,8 @@ export const zPerDiemParameters = z.object({
     rate_cents: z.string(),
     currency: z.string(),
     taxable: z.boolean().optional(),
-    default: z.boolean().nullish(),
-    active: z.boolean().nullish(),
+    default: z.boolean().optional(),
+    active: z.boolean().optional(),
     work_type_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     timekeeping_timecode_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional()
 });
@@ -1392,8 +1442,8 @@ export const zPerDiemUpdateParameters = z.object({
     rate_cents: z.string().optional(),
     currency: z.string().optional(),
     taxable: z.boolean().optional(),
-    default: z.boolean().nullish(),
-    active: z.boolean().nullish(),
+    default: z.boolean().optional(),
+    active: z.boolean().optional(),
     work_type_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
     timekeeping_timecode_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional()
 });
@@ -2490,7 +2540,12 @@ export const zCustomFieldConfigsResponseObject = z.object({
     id: z.string(),
     name: z.string(),
     description: z.string().nullable(),
-    model_type: z.string(),
+    model_type: z.enum([
+        'apprenticeship_apprentice',
+        'company',
+        'job',
+        'user_company'
+    ]),
     visible: z.boolean(),
     company_id: z.string(),
     created_at: z.iso.datetime(),
@@ -2511,17 +2566,11 @@ export const zCustomFieldConfigParameters = z.object({
     visible: z.boolean().optional()
 });
 /**
- * Request body for updating a custom field definition. Every field is optional; omit a field to preserve its current value. The resulting definition's name must remain unique for its company and model type.
+ * Request body for updating a custom field definition. Every field is optional; omit a field to preserve its current value. `model_type` is fixed at creation, so sending it answers 400. The resulting definition's name must remain unique for its company and model type.
  */
 export const zCustomFieldConfigUpdateParameters = z.object({
     name: z.string().optional(),
     description: z.string().nullish(),
-    model_type: z.enum([
-        'apprenticeship_apprentice',
-        'company',
-        'job',
-        'user_company'
-    ]).optional(),
     visible: z.boolean().optional()
 });
 /**
@@ -2662,7 +2711,7 @@ export const zUserCompanyScheduledChange = z.object({
     id: z.string(),
     start_date: z.string(),
     hourly_rate: z.string().nullable(),
-    compensation_type: z.string(),
+    compensation_type: z.enum(['hourly', 'salary']),
     overtime_eligible: z.boolean(),
     training_annual_amount: z.string().nullable(),
     employer_combined_health_amount: z.string().nullable(),
@@ -3666,14 +3715,16 @@ export const zFeatureResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * A billing metric — the count of distinct prevailing-wage/apprenticeship (PWA) tracked workers on a project in a given month, aggregated for the billed company. One row per project per month.
+ * A billing metric — the count of distinct prevailing-wage/apprenticeship (PWA) tracked workers on one billable unit in a given month, aggregated for the billed company. A billable unit is a project (one row per project per month, counting workers once across every job in the project tree) or a job outside any project (one row per job per month). Exactly one of `project_id` and `job_id` is set.
  */
 export const zBillingPwaUserCountByProjectByMonthResponseObject = z.object({
     year_month: z.string(),
     year: z.int(),
     month: z.int(),
-    project_id: z.string(),
-    project_name: z.string(),
+    project_id: z.string().nullable(),
+    project_name: z.string().nullable(),
+    job_id: z.string().nullable(),
+    job_name: z.string().nullable(),
     user_count: z.int()
 });
 /**
@@ -4826,7 +4877,7 @@ export const zProductionCompletionUpdateParameters = z.object({
  * Fields shared by both completion payload kinds.
  */
 export const zProductionCompletionBaseParameters = z.object({
-    production_job_scope_price_id: z.string().optional(),
+    production_job_scope_price_id: z.string(),
     performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/),
     notes: z.string().nullish(),
     work_date: z.iso.date().optional(),
@@ -5232,7 +5283,7 @@ export const zUserResponseObject = z.object({
     overtime_eligible: z.boolean().nullable(),
     enrolled_in_t_and_a: z.boolean().nullable(),
     payroll_id: z.string().nullable(),
-    compensation_type: z.string().nullable(),
+    compensation_type: z.enum(['hourly', 'salary']).nullable(),
     hourly_rate: z.string().nullish(),
     training_annual_amount: z.string().nullish(),
     employer_combined_health_amount: z.string().nullish(),
@@ -6886,7 +6937,8 @@ export const zAssetsFormAssignmentTriggerResponseObject = z.object({
  * Create or update a form-assignment trigger rule. form_definition_id, triggered_by, assign_to, first_due_by, tz_name, and time_of_day_due are required; the day fields depend on first_due_by, and assigned_user_ids applies only to the custom assign_to mode.
  */
 export const zAssetsFormAssignmentTriggerParameters = z.object({
-    form_definition_id: z.string(),
+    form_definition_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/),
+    name: z.string().nullish(),
     triggered_by: z.enum(['assignment', 'unassignment']),
     assign_to: z.enum([
         'custom',
@@ -6898,9 +6950,6 @@ export const zAssetsFormAssignmentTriggerParameters = z.object({
         'day_of_week',
         'day_of_month'
     ]),
-    tz_name: z.string(),
-    time_of_day_due: z.string(),
-    name: z.string().nullish(),
     recurrence_frequency: z.enum([
         'DAILY',
         'WORKDAILY',
@@ -6910,16 +6959,19 @@ export const zAssetsFormAssignmentTriggerParameters = z.object({
         'MONTHLY',
         'QUARTERLY'
     ]).nullish(),
-    day_of_week_due: z.int().nullish(),
-    day_of_month_due: z.int().nullish(),
-    assigned_user_ids: z.array(z.string()).optional(),
-    assets_product_ids: z.array(z.string()).optional()
+    day_of_week_due: z.int().gte(0).lte(6).nullish(),
+    day_of_month_due: z.int().gte(1).lte(31).nullish(),
+    tz_name: z.string(),
+    time_of_day_due: z.string().regex(/^([01][0-9]|2[0-3]):[0-5][0-9]$/),
+    assigned_user_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
+    assets_product_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional()
 });
 /**
  * Update a form-assignment trigger rule. All fields are optional — send only what changes. When changing first_due_by, include the matching day field when required; assigned_user_ids applies only to the custom assign_to mode.
  */
 export const zAssetsFormAssignmentTriggerUpdateParameters = z.object({
-    form_definition_id: z.string().optional(),
+    form_definition_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/).optional(),
+    name: z.string().nullish(),
     triggered_by: z.enum(['assignment', 'unassignment']).optional(),
     assign_to: z.enum([
         'custom',
@@ -6931,9 +6983,6 @@ export const zAssetsFormAssignmentTriggerUpdateParameters = z.object({
         'day_of_week',
         'day_of_month'
     ]).optional(),
-    tz_name: z.string().optional(),
-    time_of_day_due: z.string().optional(),
-    name: z.string().nullish(),
     recurrence_frequency: z.enum([
         'DAILY',
         'WORKDAILY',
@@ -6943,10 +6992,12 @@ export const zAssetsFormAssignmentTriggerUpdateParameters = z.object({
         'MONTHLY',
         'QUARTERLY'
     ]).nullish(),
-    day_of_week_due: z.int().nullish(),
-    day_of_month_due: z.int().nullish(),
-    assigned_user_ids: z.array(z.string()).optional(),
-    assets_product_ids: z.array(z.string()).optional()
+    day_of_week_due: z.int().gte(0).lte(6).nullish(),
+    day_of_month_due: z.int().gte(1).lte(31).nullish(),
+    tz_name: z.string().optional(),
+    time_of_day_due: z.string().regex(/^([01][0-9]|2[0-3]):[0-5][0-9]$/).optional(),
+    assigned_user_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional(),
+    assets_product_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).optional()
 });
 /**
  * A file attached to an asset — an item or product image, or a service-event attachment. Uploaded through the direct-upload flow; the response carries a URL to download it.
@@ -7702,16 +7753,20 @@ export const zAssetsArchiveParameters = z.object({
  * Create the template's schedule on the product's serial items that don't have one yet. Items whose matching schedule has a different cadence are blocked and never seeded.
  */
 export const zAssetsServiceScheduleSeedParameters = z.object({
-    assets_item_ids: z.array(z.string()).min(1).optional(),
+    assets_item_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).min(1).optional(),
     performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)
 });
 /**
  * Rewrite blocked schedules — those sharing the template's name and kind with a different interval — to the template's cadence, which links them to it.
  */
 export const zAssetsServiceScheduleSyncParameters = z.object({
-    schedule_ids: z.array(z.string()).min(1).optional(),
+    schedule_ids: z.array(z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)).min(1).optional(),
     performed_by_user_id: z.string().regex(/[^\x09-\x0D\x20…   - ‧-‪  　]|[‧‪]/)
 });
+/**
+ * Revoke an active grant. The body takes no fields; send an empty object or no body. Revocation sets revoked_at and keeps the row; revoking it again answers 409 authorization_revoked.
+ */
+export const zCompetencyAssessorAuthorizationRevocationParametersWritable = z.record(z.string(), z.never());
 /**
  * A certification held by a worker — the record that a worker earned a certification, with its receipt date, optional expiry, and verification state.
  */
@@ -8966,6 +9021,7 @@ export const zGetAtlasSiteResponse = zSiteResponseObject;
 export const zListPwaUserCountsByProjectByMonthsQuery = z.object({
     'filter[year_month]': z.string().optional(),
     'filter[project_id]': z.string().optional(),
+    'filter[job_id]': z.string().optional(),
     filter: z.string().optional(),
     'filter[unexpected]': z.string().optional()
 });
@@ -9276,6 +9332,66 @@ export const zGetEvidenceItemPath = z.object({
  * Success
  */
 export const zGetEvidenceItemResponse = zCompetencyEvidenceItemResponseObject;
+export const zListAssessorAuthorizationsQuery = z.object({
+    'filter[user_id]': z.string().optional(),
+    'filter[companies_department_id]': z.string().optional(),
+    'filter[competencies_standard_id]': z.string().optional(),
+    'filter[kind]': z.array(z.enum(['authorized_assessor', 'qualified_assessor'])).optional(),
+    'filter[state]': z.enum([
+        'active',
+        'revoked',
+        'all'
+    ]).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(),
+    'filter[granted_at][gte]': z.iso.datetime().optional(),
+    'filter[granted_at][lte]': z.iso.datetime().optional(),
+    'filter[revoked_at][gte]': z.iso.datetime().optional(),
+    'filter[revoked_at][lte]': z.iso.datetime().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 zListAssessorAuthorizationsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zCompetencyAssessorAuthorizationResponseObject)
+});
+export const zCreateAssessorAuthorizationBody = zCompetencyAssessorAuthorizationParameters;
+/**
+ * Created
+ */
+export const zCreateAssessorAuthorizationResponse = zCompetencyAssessorAuthorizationResponseObject;
+export const zGetAssessorAuthorizationPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetAssessorAuthorizationResponse = zCompetencyAssessorAuthorizationResponseObject;
+export const zUpdateAssessorAuthorizationBody = zCompetencyAssessorAuthorizationUpdateParameters;
+export const zUpdateAssessorAuthorizationPath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateAssessorAuthorizationResponse = zCompetencyAssessorAuthorizationResponseObject;
+export const zRevokeAssessorAuthorizationBody = zCompetencyAssessorAuthorizationRevocationParametersWritable;
+export const zRevokeAssessorAuthorizationPath = z.object({
+    assessor_authorization_id: z.string()
+});
+/**
+ * Created
+ */
+export const zRevokeAssessorAuthorizationResponse = zCompetencyAssessorAuthorizationResponseObject;
 export const zListQualificationsQuery = z.object({
     'filter[candidate_user_id]': z.string().optional(),
     'filter[competencies_standard_id]': z.string().optional(),

package/package.json

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