@dsptch-work/api-client 0.17.0 → 0.18.0

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

@@ -2729,6 +2729,10 @@ export type JobResponseObject = {
      * Whether time entries on this job are capped at one feature allocation.
      */
     max_one_feature_allocation: boolean;
+    /**
+     * How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists.
+     */
+    production_tracking_kind: 'none' | 'feature' | 'quantity';
     [key: string]: unknown;
 };
 /**
@@ -2889,6 +2893,10 @@ export type JobParameters = {
      * Whether time entries on this job are capped at one feature allocation; null when unset.
      */
     max_one_feature_allocation?: boolean | null;
+    /**
+     * How this job records production completions: one of none (opts out), feature (per site feature, e.g. a turbine), or quantity (a unit count, e.g. modules). Locked once any completion exists. Omit the field to leave the current value unchanged.
+     */
+    production_tracking_kind?: 'none' | 'feature' | 'quantity';
     /**
      * Work types (trade or scope categories) to associate with the job; null when none.
      */
@@ -5341,6 +5349,54 @@ export type TimeCardsResponseObject = {
      */
     data: Array<TimeCardResponseObject>;
 };
+/**
+ * One clock-in by a worker — open (`active`) from clock-in until clock-out, and retained afterwards as the record that the session happened. A worker holds at most one active session at a time.
+ */
+export type TimeSessionResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the worker (user) who clocked in.
+     */
+    user_id: string;
+    /**
+     * ID of the job the worker clocked in against; null when they clocked in without a job.
+     */
+    job_id: string | null;
+    /**
+     * ID of the timecode the worker clocked in under; null when none was chosen.
+     */
+    timekeeping_timecode_id: string | null;
+    /**
+     * Whether the worker is still clocked in on this session. `false` once they clock out; the session keeps its start_time as history.
+     */
+    active: boolean;
+    /**
+     * When the worker clocked in (ISO 8601).
+     */
+    start_time: string;
+    /**
+     * 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 sessions, with pagination metadata and navigation links.
+ */
+export type TimeSessionsResponseObject = {
+    meta: Meta;
+    links: Links;
+    /**
+     * The page of time sessions.
+     */
+    data: Array<TimeSessionResponseObject>;
+};
 /**
  * Request body for locking or unlocking a time card.
  */
@@ -7994,6 +8050,10 @@ export type LaborRateResponseObject = {
      * Fringe benefit expressed as a monthly amount, in cents as a decimal string; null when fringe is expressed hourly or as a percentage instead.
      */
     fringe_benefit_monthly_rate_cents: string | null;
+    /**
+     * IDs of the reference items this rate cites, in the order their letter tokens appear in the source fringe expression.
+     */
+    reference_item_ids: Array<string>;
     /**
      * When the record was created (ISO 8601).
      */
@@ -8014,6 +8074,234 @@ export type LaborRatesResponseObject = {
      */
     data: Array<LaborRateResponseObject>;
 };
+/**
+ * A DOL labor-classification schedule within one wage determination; its labor rates and reference items share this schedule boundary.
+ */
+export type WageClassificationResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the wage determination that owns this classification schedule.
+     */
+    wage_determination_id: string;
+    /**
+     * DOL alphanumeric classification identifier, such as ELEC0145-004.
+     */
+    identifier: string;
+    /**
+     * Date the underlying classification agreement originated.
+     */
+    date: string;
+    /**
+     * Verbatim schedule-level footnote text; null when none was printed.
+     */
+    footnote: string | null;
+    /**
+     * Verbatim schedule subheader; null when none was printed.
+     */
+    subheader: 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 a wage determination's classification schedules, with pagination metadata and navigation links.
+ */
+export type WageClassificationsResponseObject = {
+    meta: Meta;
+    links: Links;
+    /**
+     * The page of wage classifications.
+     */
+    data: Array<WageClassificationResponseObject>;
+};
+/**
+ * A Davis-Bacon construction category assigned to one wage determination.
+ */
+export type ConstructionTypeResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the wage determination carrying this construction category.
+     */
+    wage_determination_id: string;
+    /**
+     * Davis-Bacon base construction category: BUILDING, HEAVY, HIGHWAY, or RESIDENTIAL.
+     */
+    construction_type: 'BUILDING' | 'HEAVY' | 'HIGHWAY' | 'RESIDENTIAL';
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
+/**
+ * A page of a wage determination's construction categories, with pagination metadata and navigation links.
+ */
+export type ConstructionTypesResponseObject = {
+    meta: Meta;
+    links: Links;
+    /**
+     * The page of construction types.
+     */
+    data: Array<ConstructionTypeResponseObject>;
+};
+/**
+ * A DOL project-type tag attached directly to one wage determination.
+ */
+export type ProjectTypeResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the wage determination carrying this project-type tag.
+     */
+    wage_determination_id: string;
+    /**
+     * DOL project categorization code used to narrow the work the determination covers.
+     */
+    project_type: string;
+    /**
+     * Additional verbatim qualification printed beside the project type; null when absent.
+     */
+    project_type_subtext: 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 project-type tags attached directly to a wage determination, with pagination metadata and navigation links.
+ */
+export type ProjectTypesResponseObject = {
+    meta: Meta;
+    links: Links;
+    /**
+     * The page of project types.
+     */
+    data: Array<ProjectTypeResponseObject>;
+};
+/**
+ * A link between a wage determination and one geographic boundary where it applies. Includes stable boundary identity metadata but never geometry.
+ */
+export type WageDeterminationBoundaryResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the wage determination whose applicability includes this boundary.
+     */
+    wage_determination_id: string;
+    /**
+     * Stable ID of the linked geographic boundary.
+     */
+    boundary_id: string;
+    /**
+     * Fully qualified boundary kind, such as Boundaries::Region or Boundaries::Subregion.
+     */
+    boundary_type: string;
+    /**
+     * Government-published name of the linked boundary.
+     */
+    name: string;
+    /**
+     * Administrative-unit identifier in the source system; null when unavailable and not necessarily globally unique.
+     */
+    source_boundary_id: string | null;
+    /**
+     * Geographic identifier unique within the authoritative source; null when unavailable.
+     */
+    source_geo_id: string | null;
+    /**
+     * Versioned or national stable geographic identifier from the authoritative source; null when unavailable.
+     */
+    source_unique_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 a wage determination's geographic applicability links, with pagination metadata and navigation links.
+ */
+export type WageDeterminationBoundariesResponseObject = {
+    meta: Meta;
+    links: Links;
+    /**
+     * The page of boundary links.
+     */
+    data: Array<WageDeterminationBoundaryResponseObject>;
+};
+/**
+ * One ordered, lettered item of verbatim fringe-reference prose within a wage-classification schedule.
+ */
+export type ReferenceItemResponseObject = {
+    /**
+     * Unique identifier.
+     */
+    id: string;
+    /**
+     * ID of the wage-classification schedule that owns this reference item.
+     */
+    wage_classification_id: string;
+    /**
+     * Zero-based document order within the classification schedule.
+     */
+    position: number;
+    /**
+     * Lowercase source token a labor rate cites, such as a or b.
+     */
+    letter: string;
+    /**
+     * Source heading under which the item was printed: footnote, premium_pay, holidays, or zone_pay.
+     */
+    container_type: 'footnote' | 'premium_pay' | 'holidays' | 'zone_pay';
+    /**
+     * Verbatim reference-item prose from the DOL source document.
+     */
+    text: string;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
+/**
+ * A page of reference items flattened across every classification schedule in a wage determination, with pagination metadata and navigation links.
+ */
+export type ReferenceItemsResponseObject = {
+    meta: Meta;
+    links: Links;
+    /**
+     * The page of reference items.
+     */
+    data: Array<ReferenceItemResponseObject>;
+};
 /**
  * A wage determination applied to a job — the prevailing-wage and fringe rates for one labor classification. The type discriminator selects the Federal or Regional representation.
  */
@@ -9094,7 +9382,7 @@ export type AssetsVendorParameters = {
      */
     name: string;
     /**
-     * A signed_id from POST /api/v1/direct_uploads for a logo image to attach to the vendor.
+     * A signed_id from POST /api/v1/direct_uploads registered for assets.vendors. The logo must be a readable PNG, JPEG, GIF, or HEIC image, at most 10 MiB, 20,000 pixels per side, and 50 megapixels total. An invalid logo rejects the entire create or update; the existing vendor and logo remain unchanged.
      */
     logo_signed_id?: string;
 };
@@ -13396,7 +13684,7 @@ export type CreateVendorErrors = {
      */
     403: Problem;
     /**
-     * Unprocessable Content (non-image logo)
+     * Unprocessable Content (invalid image)
      */
     422: Problem;
 };
@@ -13465,6 +13753,10 @@ export type UpdateVendorErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Unprocessable Content (invalid logo replacement)
+     */
+    422: Problem;
 };
 export type UpdateVendorError = UpdateVendorErrors[keyof UpdateVendorErrors];
 export type UpdateVendorResponses = {
@@ -16007,6 +16299,10 @@ export type ListJobsData = {
          * Returns jobs whose status is any of the given values. Comma-separate to match multiple (e.g. `ready,completed`). Accepts each concrete status (pending_provider, pending_schedule, pending_workers, ready, disputed, completed, cancelled) plus the aggregates `pending` (any pending_* status) and `active` (ready or disputed).
          */
         'filter[status]'?: string;
+        /**
+         * Returns jobs whose production_tracking_kind matches. One of `none`, `feature`, or `quantity`.
+         */
+        'filter[production_tracking_kind]'?: 'none' | 'feature' | 'quantity';
         /**
          * This pagination cursor corresponds to the cursor value found in the response in
          * `meta.page.next_cursor`.
@@ -21276,6 +21572,95 @@ export type GetTimeCardActualResponses = {
     200: TimeCardActualsResponseObject;
 };
 export type GetTimeCardActualResponse = GetTimeCardActualResponses[keyof GetTimeCardActualResponses];
+export type ListTimeSessionsData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Returns only sessions for this worker.
+         */
+        'filter[user_id]'?: string;
+        /**
+         * Returns only sessions clocked in against this job.
+         */
+        'filter[job_id]'?: string;
+        /**
+         * `true` returns only sessions with no job, `false` only those with a job. Cannot be combined with `filter[job_id]`.
+         */
+        'filter[job_id][null]'?: boolean;
+        /**
+         * `true` returns only open sessions — the workers clocked in right now; `false` only sessions that have ended.
+         */
+        'filter[active]'?: boolean;
+        'filter[start_time][gte]'?: string;
+        'filter[start_time][lte]'?: string;
+        'filter[created_at][gte]'?: string;
+        'filter[created_at][lte]'?: string;
+        'filter[updated_at][gte]'?: string;
+        'filter[updated_at][lte]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * 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_sessions';
+};
+export type ListTimeSessionsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListTimeSessionsError = ListTimeSessionsErrors[keyof ListTimeSessionsErrors];
+export type ListTimeSessionsResponses = {
+    /**
+     * Success
+     */
+    200: TimeSessionsResponseObject;
+};
+export type ListTimeSessionsResponse = ListTimeSessionsResponses[keyof ListTimeSessionsResponses];
+export type GetTimeSessionData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/timekeeping/time_sessions/{id}';
+};
+export type GetTimeSessionErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetTimeSessionError = GetTimeSessionErrors[keyof GetTimeSessionErrors];
+export type GetTimeSessionResponses = {
+    /**
+     * Success
+     */
+    200: TimeSessionResponseObject;
+};
+export type GetTimeSessionResponse = GetTimeSessionResponses[keyof GetTimeSessionResponses];
 export type ListTodoInboxData = {
     body?: never;
     path?: never;
@@ -21548,6 +21933,10 @@ export type CreateScheduledTerminationErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -21824,6 +22213,113 @@ export type UpdateUserResponses = {
     200: UserResponseObject;
 };
 export type UpdateUserResponse = UpdateUserResponses[keyof UpdateUserResponses];
+export type ListBoundariesData = {
+    body?: never;
+    path: {
+        wage_determination_id: string;
+    };
+    query?: {
+        'filter[id]'?: string;
+        'filter[boundary_id]'?: string;
+        'filter[name]'?: string;
+        'filter[boundary_type]'?: string;
+        'filter[source_boundary_id]'?: string;
+        'filter[source_geo_id]'?: string;
+        'filter[source_unique_id]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * 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/wage_determinations/{wage_determination_id}/boundaries';
+};
+export type ListBoundariesErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListBoundariesError = ListBoundariesErrors[keyof ListBoundariesErrors];
+export type ListBoundariesResponses = {
+    /**
+     * Success
+     */
+    200: WageDeterminationBoundariesResponseObject;
+};
+export type ListBoundariesResponse = ListBoundariesResponses[keyof ListBoundariesResponses];
+export type ListConstructionTypesData = {
+    body?: never;
+    path: {
+        wage_determination_id: string;
+    };
+    query?: {
+        'filter[id]'?: string;
+        /**
+         * :
+         * * `BUILDING`
+         * * `HEAVY`
+         * * `HIGHWAY`
+         * * `RESIDENTIAL`
+         *
+         */
+        'filter[construction_type]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * 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/wage_determinations/{wage_determination_id}/construction_types';
+};
+export type ListConstructionTypesErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unsupported construction_type filter
+     */
+    422: Problem;
+};
+export type ListConstructionTypesError = ListConstructionTypesErrors[keyof ListConstructionTypesErrors];
+export type ListConstructionTypesResponses = {
+    /**
+     * Success
+     */
+    200: ConstructionTypesResponseObject;
+};
+export type ListConstructionTypesResponse = ListConstructionTypesResponses[keyof ListConstructionTypesResponses];
 export type ListLaborRatesData = {
     body?: never;
     path: {
@@ -21871,6 +22367,162 @@ export type ListLaborRatesResponses = {
     200: LaborRatesResponseObject;
 };
 export type ListLaborRatesResponse = ListLaborRatesResponses[keyof ListLaborRatesResponses];
+export type ListProjectTypesData = {
+    body?: never;
+    path: {
+        wage_determination_id: string;
+    };
+    query?: {
+        'filter[id]'?: string;
+        'filter[project_type]'?: string;
+        'filter[project_type_subtext]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * 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/wage_determinations/{wage_determination_id}/project_types';
+};
+export type ListProjectTypesErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListProjectTypesError = ListProjectTypesErrors[keyof ListProjectTypesErrors];
+export type ListProjectTypesResponses = {
+    /**
+     * Success
+     */
+    200: ProjectTypesResponseObject;
+};
+export type ListProjectTypesResponse = ListProjectTypesResponses[keyof ListProjectTypesResponses];
+export type ListReferenceItemsData = {
+    body?: never;
+    path: {
+        wage_determination_id: string;
+    };
+    query?: {
+        'filter[id]'?: string;
+        'filter[wage_classification_id]'?: string;
+        'filter[position]'?: number;
+        'filter[letter]'?: string;
+        /**
+         * :
+         * * `footnote`
+         * * `premium_pay`
+         * * `holidays`
+         * * `zone_pay`
+         *
+         */
+        'filter[container_type]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * 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/wage_determinations/{wage_determination_id}/reference_items';
+};
+export type ListReferenceItemsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unsupported container_type filter
+     */
+    422: Problem;
+};
+export type ListReferenceItemsError = ListReferenceItemsErrors[keyof ListReferenceItemsErrors];
+export type ListReferenceItemsResponses = {
+    /**
+     * Success
+     */
+    200: ReferenceItemsResponseObject;
+};
+export type ListReferenceItemsResponse = ListReferenceItemsResponses[keyof ListReferenceItemsResponses];
+export type ListWageClassificationsData = {
+    body?: never;
+    path: {
+        wage_determination_id: string;
+    };
+    query?: {
+        'filter[id]'?: string;
+        'filter[identifier]'?: string;
+        'filter[date]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * 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/wage_determinations/{wage_determination_id}/wage_classifications';
+};
+export type ListWageClassificationsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListWageClassificationsError = ListWageClassificationsErrors[keyof ListWageClassificationsErrors];
+export type ListWageClassificationsResponses = {
+    /**
+     * Success
+     */
+    200: WageClassificationsResponseObject;
+};
+export type ListWageClassificationsResponse = ListWageClassificationsResponses[keyof ListWageClassificationsResponses];
 export type ListWageDeterminationsData = {
     body?: never;
     path?: never;