@dsptch-work/api-client 0.29.0 → 0.30.0

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

@@ -3983,7 +3983,7 @@ export type JobParameters = {
      */
     requested_by_company_id?: string;
     /**
-     * IDs of the users who manage the job; null when the job has no managers.
+     * Complete desired set of manager user ID strings. Omit or send null to preserve the set; send an empty array to clear it. Other non-array values or non-string members return 422 before any job or relationship is saved.
      */
     manager_user_ids?: Array<string> | null;
     /**
@@ -4036,7 +4036,7 @@ export type JobParameters = {
      */
     allow_customer_access?: boolean;
     /**
-     * IDs of the timecodes to associate with the job; null when none.
+     * Complete desired set of timecode ID strings. Omit or send null to preserve the set; send an empty array to clear it. Other non-array values or non-string members return 422 before any job or relationship is saved.
      */
     timekeeping_timecode_ids?: Array<string> | null;
     /**
@@ -4683,7 +4683,7 @@ export type UserParameters = ({
     /**
      * Roles to grant the worker at your company, as an array of role strings such as TECHNICIAN, FIELD_LEAD, MANAGER, SAFETY_MANAGER, and ADMIN.
      */
-    roles?: Array<string>;
+    roles?: Array<string> | null;
     /**
      * Signed ID of a direct-upload blob to attach as the profile picture. Obtain it by first uploading the image to POST /api/v1/direct_uploads.
      */
@@ -4768,7 +4768,7 @@ export type UserParameters = ({
     /**
      * Ids of the groups to add the worker to at your company.
      */
-    group_ids?: Array<number>;
+    group_ids?: Array<string> | null;
     /**
      * Values for the employment's custom fields, as a list of configurations and their values. Each configuration may appear only once. Every visible configuration gets a stored value; one left out of the list, or an omitted or empty list, stores null.
      */
@@ -5733,7 +5733,7 @@ export type UserGroupResponse = {
  */
 export type UserGroupParameters = {
     /**
-     * IDs of the users to add to the group; users already in the group are ignored, and the full membership list is returned.
+     * Required nonempty array of user ID strings to add to the group. Users already in the group are ignored, and the full membership list is returned.
      */
     user_ids: Array<string>;
 };
@@ -6743,6 +6743,62 @@ export type TimeSessionsResponseObject = {
      */
     data: Array<TimeSessionResponseObject>;
 };
+/**
+ * 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 type TimeOffRequestResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the worker (user) the request is for.
+     */
+    user_id: string;
+    /**
+     * Lifecycle status of the request.
+     */
+    status: 'pending' | 'approved' | 'denied' | 'cancelled' | 'expired';
+    /**
+     * Kind of non-working time.
+     */
+    absence_type: 'rest_and_recovery' | 'vacation' | 'bereavement' | 'ca_covid_19_sick' | 'custom' | 'jury_duty' | 'unpaid' | 'training' | 'bench';
+    /**
+     * When the requested absence starts (ISO 8601).
+     */
+    start_time: string;
+    /**
+     * When the requested absence ends (ISO 8601).
+     */
+    end_time: string;
+    /**
+     * When the request was reviewed (ISO 8601); null while it is still pending.
+     */
+    reviewed_at: string | null;
+    /**
+     * ID of the user who reviewed the request; null while it is still pending.
+     */
+    reviewer_user_id: string | null;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
+/**
+ * A page of time-off requests, with pagination metadata and navigation links.
+ */
+export type TimeOffRequestsResponseObject = {
+    meta: Meta;
+    links: Links;
+    /**
+     * The page of time-off requests.
+     */
+    data: Array<TimeOffRequestResponseObject>;
+};
 /**
  * Request body for locking or unlocking a time card.
  */
@@ -7323,7 +7379,7 @@ export type ProjectResponseObject = {
     updated_at: string;
 };
 /**
- * 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 type ProjectParameters = {
     /**
@@ -7339,7 +7395,7 @@ export type ProjectParameters = {
      */
     description?: string | null;
     /**
-     * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
+     * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter. Send it only on create; every update that includes it returns 400, even when unchanged.
      */
     created_by_user_id: string;
     /**
@@ -7347,7 +7403,7 @@ export type ProjectParameters = {
      */
     parent_id?: string | null;
     /**
-     * Complete desired set of participating company IDs. Send an empty array to clear the set. Remove a participant's jobs before removing it from this set.
+     * Complete desired set of participating company ID strings. Omit to preserve the set; send an empty array to clear it. Null, non-array values, or non-string members return 422 before any project or relationship is saved. Remove a participant's jobs before removing it from this set.
      */
     participating_company_ids?: Array<string>;
     /**
@@ -7412,7 +7468,7 @@ export type ProjectParameters = {
     placed_in_service_date?: string | null;
 };
 /**
- * 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 type ProjectUpdateParameters = {
     /**
@@ -7432,7 +7488,7 @@ export type ProjectUpdateParameters = {
      */
     parent_id?: string | null;
     /**
-     * Complete desired set of participating company IDs. Send an empty array to clear the set. Remove a participant's jobs before removing it from this set.
+     * Complete desired set of participating company ID strings. Omit to preserve the set; send an empty array to clear it. Null, non-array values, or non-string members return 422 before any project or relationship is saved. Remove a participant's jobs before removing it from this set.
      */
     participating_company_ids?: Array<string>;
     /**
@@ -9525,7 +9581,7 @@ export type PositionParameters = {
      */
     wage_adder_rate_cents?: number | null;
     /**
-     * The complete desired set of job wage determination IDs. On PATCH, this replaces the current set; omit the field to leave assignments unchanged. Required federal and regional assignments cannot be removed from a PWA position.
+     * The complete desired set of job wage determination IDs. On PATCH, this replaces the current set; omit the field to leave assignments unchanged. Required federal and regional assignments cannot be removed from a PWA position. Must be an array of ID strings; malformed submitted lists are rejected before any changes are written.
      */
     job_wage_determination_ids?: Array<string>;
     /**
@@ -9986,7 +10042,7 @@ export type CertificationPackageParameters = {
      */
     description?: string | null;
     /**
-     * Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership. An id that is neither a global certification nor one of your company's own answers 404, and nothing is written.
+     * Array of certification ID strings; global and your company's own may be mixed. Providing this replaces the entire membership; an empty array clears it. Omit to create an empty package or preserve existing membership on update. Null is not accepted. An id that is neither a global certification nor one of your company's own answers 404, and nothing is written.
      */
     certification_ids?: Array<string>;
     /**
@@ -10007,7 +10063,7 @@ export type CertificationPackageUpdateParameters = {
      */
     description?: string | null;
     /**
-     * Ids of the certifications in the package; global and your company's own may be mixed. Providing this replaces the entire membership. An id that is neither a global certification nor one of your company's own answers 404, and nothing is written.
+     * Array of certification ID strings; global and your company's own may be mixed. Providing this replaces the entire membership; an empty array clears it. Omit to create an empty package or preserve existing membership on update. Null is not accepted. An id that is neither a global certification nor one of your company's own answers 404, and nothing is written.
      */
     certification_ids?: Array<string>;
     /**
@@ -14199,6 +14255,10 @@ export type CreateProgramData = {
     url: '/api/v1/apprenticeship/programs';
 };
 export type CreateProgramErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -14281,6 +14341,10 @@ export type UpdateProgramData = {
     url: '/api/v1/apprenticeship/programs/{id}';
 };
 export type UpdateProgramErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -14716,6 +14780,10 @@ export type CreateAttributeData = {
     url: '/api/v1/assets/attributes';
 };
 export type CreateAttributeErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -14798,6 +14866,10 @@ export type UpdateAttributeData = {
     url: '/api/v1/assets/attributes/{id}';
 };
 export type UpdateAttributeErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -14875,6 +14947,10 @@ export type CreateCategoryData = {
     url: '/api/v1/assets/categories';
 };
 export type CreateCategoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -14957,6 +15033,10 @@ export type UpdateCategoryData = {
     url: '/api/v1/assets/categories/{id}';
 };
 export type UpdateCategoryErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -15147,10 +15227,18 @@ export type CreateFormAssignmentTriggerData = {
     url: '/api/v1/assets/form_assignment_triggers';
 };
 export type CreateFormAssignmentTriggerErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Reference not found
+     */
+    404: Problem;
     /**
      * Unprocessable Content (invalid enum)
      */
@@ -15221,10 +15309,22 @@ export type UpdateFormAssignmentTriggerData = {
     url: '/api/v1/assets/form_assignment_triggers/{id}';
 };
 export type UpdateFormAssignmentTriggerErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Reference not found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content (malformed ID lists)
+     */
+    422: Problem;
 };
 export type UpdateFormAssignmentTriggerError = UpdateFormAssignmentTriggerErrors[keyof UpdateFormAssignmentTriggerErrors];
 export type UpdateFormAssignmentTriggerResponses = {
@@ -16566,7 +16666,7 @@ export type UpdateServiceScheduleTemplateResponse = UpdateServiceScheduleTemplat
 export type SeedServiceScheduleTemplateData = {
     body: {
         /**
-         * Serial item ids to seed; omit to seed every cleanly-seedable item
+         * Serial item ids to seed; omit or send [] to seed every cleanly-seedable item
          */
         assets_item_ids?: Array<string>;
         /**
@@ -16582,10 +16682,18 @@ export type SeedServiceScheduleTemplateData = {
     url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{service_schedule_template_id}/seeds';
 };
 export type SeedServiceScheduleTemplateErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Unprocessable Content (malformed assets_item_ids)
+     */
+    422: Problem;
 };
 export type SeedServiceScheduleTemplateError = SeedServiceScheduleTemplateErrors[keyof SeedServiceScheduleTemplateErrors];
 export type SeedServiceScheduleTemplateResponses = {
@@ -16601,7 +16709,7 @@ export type SeedServiceScheduleTemplateResponse = SeedServiceScheduleTemplateRes
 export type SyncServiceScheduleTemplateData = {
     body: {
         /**
-         * Blocked schedule ids to sync; omit to sync every blocked schedule
+         * Blocked schedule ids to sync; omit or send [] to sync every blocked schedule
          */
         schedule_ids?: Array<string>;
         /**
@@ -16617,10 +16725,18 @@ export type SyncServiceScheduleTemplateData = {
     url: '/api/v1/assets/products/{product_id}/service_schedule_templates/{service_schedule_template_id}/syncs';
 };
 export type SyncServiceScheduleTemplateErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Unprocessable Content (malformed schedule_ids)
+     */
+    422: Problem;
 };
 export type SyncServiceScheduleTemplateError = SyncServiceScheduleTemplateErrors[keyof SyncServiceScheduleTemplateErrors];
 export type SyncServiceScheduleTemplateResponses = {
@@ -16689,6 +16805,10 @@ export type CreateSiteData = {
     url: '/api/v1/assets/sites';
 };
 export type CreateSiteErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -16763,6 +16883,10 @@ export type UpdateSiteData = {
     url: '/api/v1/assets/sites/{id}';
 };
 export type UpdateSiteErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -17110,6 +17234,10 @@ export type CreateVendorData = {
     url: '/api/v1/assets/vendors';
 };
 export type CreateVendorErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -17140,6 +17268,10 @@ export type DeleteVendorErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
 };
 export type DeleteVendorError = DeleteVendorErrors[keyof DeleteVendorErrors];
 export type DeleteVendorResponses = {
@@ -17162,6 +17294,10 @@ export type GetVendorErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
 };
 export type GetVendorError = GetVendorErrors[keyof GetVendorErrors];
 export type GetVendorResponses = {
@@ -17180,10 +17316,18 @@ export type UpdateVendorData = {
     url: '/api/v1/assets/vendors/{id}';
 };
 export type UpdateVendorErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content (invalid logo replacement)
      */
@@ -17988,6 +18132,10 @@ export type CreateDepartmentData = {
     url: '/api/v1/companies/departments';
 };
 export type CreateDepartmentErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -18070,10 +18218,18 @@ export type UpdateDepartmentData = {
     url: '/api/v1/companies/departments/{id}';
 };
 export type UpdateDepartmentErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -18832,6 +18988,10 @@ export type AddUsersToGroupErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Unprocessable Content (malformed user_ids)
+     */
+    422: Problem;
 };
 export type AddUsersToGroupError = AddUsersToGroupErrors[keyof AddUsersToGroupErrors];
 export type AddUsersToGroupResponses = {
@@ -19229,6 +19389,10 @@ export type CreateJobScopePriceData = {
     url: '/api/v1/jobs/{job_id}/production/job_scope_prices';
 };
 export type CreateJobScopePriceErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -19318,6 +19482,10 @@ export type UpdateJobScopePriceData = {
     url: '/api/v1/jobs/{job_id}/production/job_scope_prices/{id}';
 };
 export type UpdateJobScopePriceErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -20243,6 +20411,14 @@ export type ListJobsData = {
          * Returns jobs whose purchase order number contains this substring (case-insensitive).
          */
         'filter[purchase_order_number]'?: string;
+        /**
+         * Returns jobs whose federal_pwa_mode is any of the given values. Comma-separate to match multiple (e.g. `all,pw_only`).
+         */
+        'filter[federal_pwa_mode]'?: Array<'all' | 'pw_only' | 'ap_only' | 'none'>;
+        /**
+         * Returns jobs whose regional_pwa_mode is any of the given values. Comma-separate to match multiple (e.g. `all,pw_only`).
+         */
+        'filter[regional_pwa_mode]'?: Array<'all' | 'pw_only' | 'ap_only' | 'none'>;
         /**
          * This pagination cursor corresponds to the cursor value found in the response in
          * `meta.page.next_cursor`.
@@ -20302,6 +20478,10 @@ export type CreateJobErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Template not found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -20627,6 +20807,10 @@ export type UpdateFeatureFormAssignmentTaskErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Unprocessable Content (malformed assignee IDs)
+     */
+    422: Problem;
 };
 export type UpdateFeatureFormAssignmentTaskError = UpdateFeatureFormAssignmentTaskErrors[keyof UpdateFeatureFormAssignmentTaskErrors];
 export type UpdateFeatureFormAssignmentTaskResponses = {
@@ -20764,6 +20948,10 @@ export type UpdateSiteFormAssignmentTaskErrors = {
      * Not Found
      */
     404: Problem;
+    /**
+     * Unprocessable Content (malformed assignee IDs)
+     */
+    422: Problem;
 };
 export type UpdateSiteFormAssignmentTaskError = UpdateSiteFormAssignmentTaskErrors[keyof UpdateSiteFormAssignmentTaskErrors];
 export type UpdateSiteFormAssignmentTaskResponses = {
@@ -23149,6 +23337,10 @@ export type ListPayrollRunsData = {
          */
         'filter[run_type]'?: string;
         'filter[timekeeping_pay_period_id]'?: string;
+        /**
+         * Returns only runs that have at least one paystub for this worker.
+         */
+        'filter[user_id]'?: string;
         'filter[run_date][gte]'?: string;
         'filter[run_date][lte]'?: string;
         'filter[created_at][gte]'?: string;
@@ -25169,6 +25361,10 @@ export type CreateProjectData = {
     url: '/api/v1/projects';
 };
 export type CreateProjectErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -25231,6 +25427,10 @@ export type UpdateProjectData = {
     url: '/api/v1/projects/{id}';
 };
 export type UpdateProjectErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -26140,6 +26340,10 @@ export type CreateTimeCardPerDiemData = {
     url: '/api/v1/time_cards/{time_card_id}/per_diems';
 };
 export type CreateTimeCardPerDiemErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -26198,6 +26402,10 @@ export type UpdateTimeCardPerDiemData = {
     url: '/api/v1/time_cards/{time_card_id}/per_diems/{id}';
 };
 export type UpdateTimeCardPerDiemErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -26485,6 +26693,10 @@ export type ListTimeCardsData = {
     query?: {
         'filter[timekeeping_pay_period_id]'?: string;
         'filter[user_id]'?: string;
+        /**
+         * Returns cards with a time entry on this job or a position on this job overlapping the card's pay period. A job with no matching cards returns an empty list.
+         */
+        'filter[job_id]'?: string;
         'filter[start_time][gte]'?: string;
         'filter[start_time][lte]'?: string;
         filter?: string;
@@ -27417,6 +27629,10 @@ export type CreateAttestationConfigData = {
     url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs';
 };
 export type CreateAttestationConfigErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -27887,6 +28103,75 @@ export type GetTimeCardActualResponses = {
     200: TimeCardActualsResponseObject;
 };
 export type GetTimeCardActualResponse = GetTimeCardActualResponses[keyof GetTimeCardActualResponses];
+export type ListTimeOffRequestsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Returns only requests for this worker.
+         */
+        'filter[user_id]'?: string;
+        /**
+         * Returns only requests in this status.
+         */
+        'filter[status]'?: 'pending' | 'approved' | 'denied' | 'cancelled' | 'expired';
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/timekeeping/time_off_requests';
+};
+export type ListTimeOffRequestsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+};
+export type ListTimeOffRequestsError = ListTimeOffRequestsErrors[keyof ListTimeOffRequestsErrors];
+export type ListTimeOffRequestsResponses = {
+    /**
+     * Success
+     */
+    200: TimeOffRequestsResponseObject;
+};
+export type ListTimeOffRequestsResponse = ListTimeOffRequestsResponses[keyof ListTimeOffRequestsResponses];
+export type GetTimeOffRequestData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/timekeeping/time_off_requests/{id}';
+};
+export type GetTimeOffRequestErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetTimeOffRequestError = GetTimeOffRequestErrors[keyof GetTimeOffRequestErrors];
+export type GetTimeOffRequestResponses = {
+    /**
+     * Success
+     */
+    200: TimeOffRequestResponseObject;
+};
+export type GetTimeOffRequestResponse = GetTimeOffRequestResponses[keyof GetTimeOffRequestResponses];
 export type ListTimeSessionsData = {
     body?: never;
     path?: never;
@@ -28408,6 +28693,14 @@ export type ListUsersData = {
          * Fuzzy-matches the person name (trigram word-similarity). Matches the name column only — not email or phone.
          */
         'filter[name]'?: string;
+        /**
+         * Return people whose currently valid employment at the credential company has this manager. A manager with no reports at this company returns an empty list.
+         */
+        'filter[manager_user_id]'?: string;
+        /**
+         * Return people whose currently valid employment at the credential company is in this department. A department with no members returns an empty list.
+         */
+        'filter[department_id]'?: string;
         /**
          * This pagination cursor corresponds to the cursor value found in the response in
          * `meta.page.next_cursor`.