@dsptch-work/api-client 0.12.0 → 0.14.0

package/dist/gen/sdk.gen.js

@@ -2239,6 +2239,32 @@ export class ComplianceChecks {
         });
     }
 }
+export class ComplianceRequirements {
+    /**
+     * List Compliance Requirements
+     *
+     * List the compliance requirement catalog: everything a company can be checked against, and
+     * what each requirement asks for. Requirements ship with the application, so the catalog reads
+     * the same for every company.
+     *
+     * To find one requirement by name, use `filter[search]`, which matches the title. Address a
+     * requirement you already know by its `type` rather than its `id` — `type` is the same value in
+     * every environment.
+     *
+     *
+     * **Required scope:**
+     *
+     * `compliance.requirements:read`
+     *
+     */
+    static listRequirements(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/compliance/requirements',
+            ...options
+        });
+    }
+}
 export class CustomFieldConfigurations {
     /**
      * List custom field configurations
@@ -2720,6 +2746,27 @@ export class PwaTrades {
             ...options
         });
     }
+    /**
+     * Delete Trade
+     *
+     * Deletes an empty craft. A trade still grouping wage determinations, or still
+     * carrying apprentice-scope decisions, is refused with a `422` — deleting it would
+     * orphan what points at it. Merge it into another craft instead, which moves the
+     * determinations first.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.trades:delete`
+     *
+     */
+    static deleteTrade(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/trades/{id}',
+            ...options
+        });
+    }
     /**
      * Show trade
      *
@@ -2735,6 +2782,33 @@ export class PwaTrades {
             ...options
         });
     }
+    /**
+     * Rename Trade
+     *
+     * Renames the craft. The name is a display label the compliance engines ignore —
+     * they group by trade — so a rename regroups nothing and re-prices nothing. The
+     * craft's match key is fixed at creation and is not renamed with it.
+     *
+     * To move determinations between crafts, re-point each one's `pwa_trade_id`
+     * rather than renaming the craft they share.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.trades:update`
+     *
+     */
+    static updateTrade(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/trades/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class JobWageDeterminationRateRules {
     /**
@@ -3052,6 +3126,11 @@ export class JobWageDeterminations {
      * This rewrites what the determination said, not when it existed — moving
      * either end of the timeline is `genesis` or `scheduled_termination`.
      *
+     * `pwa_trade_id` is the exception: a trade regroups the whole determination
+     * at once, so it moves every version rather than applying from
+     * `effective_from`. A determination synced from a project follows its
+     * project wage determination's trade and cannot be re-pointed here.
+     *
      * Conditional: send the determination's `ETag` as `If-Match`.
      *
      *
@@ -3210,6 +3289,30 @@ export class Jobs {
         });
     }
 }
+export class OpenApi {
+    /**
+     * Show OpenAPI spec
+     *
+     * **No scope required:**
+     *
+     * Every authenticated API key may call this endpoint. It returns the machine-readable OpenAPI
+     * document that describes this API.
+     *
+     * **Stability:**
+     *
+     * The document is static between contract changes: it changes only when the API surface
+     * does — an endpoint, field, or schema added or altered — on no fixed schedule. Fetch it
+     * when your integration starts, or when you regenerate a client, rather than on a poll.
+     *
+     */
+    static getOpenapiDocument(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/openapi',
+            ...options
+        });
+    }
+}
 export class OversiteSiteCheckIns {
     /**
      * List Site Check-ins
@@ -3254,6 +3357,319 @@ export class OversiteSiteCheckIns {
         });
     }
 }
+export class OvertimeRules {
+    /**
+     * Shift overtime rule genesis
+     *
+     * Move when a rule's timeline begins. Shifting it earlier extends the first
+     * version back; shifting it later drops the coverage before it, and what that
+     * removes stops being readable through `as_of[valid]` and `/history`.
+     *
+     * This changes *when* the rule existed rather than what it said — no version's
+     * values are rewritten. Moving the other end of the timeline is
+     * `scheduled_termination`, and changing a version's values is the rule update.
+     *
+     * A shift to or past a scheduled termination is refused with `422`, since it
+     * would leave no coverage at all.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules.genesis:update`
+     *
+     */
+    static shiftOvertimeRuleGenesis(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{overtime_rule_id}/genesis',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List overtime rule version history
+     *
+     * A rule's whole valid-time sequence, newest window first and cursor-paginated.
+     * Each entry is a full overtime rule carrying its own `valid_from` / `valid_to`
+     * window and a `version_status` of `scheduled`, `current` or `historical`. An
+     * entry carries the family key as `overtime_rule_id` and no `id` of its own —
+     * every version shares the family key, so versions are told apart by their window
+     * coordinates.
+     *
+     * Each version's `corrections` — prior transaction-time recordings of that same
+     * window — is always empty here: this resource has no transaction axis, so a
+     * retroactive edit rewrites a version in place instead of layering a superseded
+     * recording under it. The field is still returned so the timeline answers one
+     * shape across every temporal resource. `as_of[valid]` is rejected, since pinning
+     * a point on the valid axis would collapse the sequence this endpoint returns, and
+     * with no transaction axis there is no `as_of[transaction]` to read against.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules.history:read`
+     *
+     */
+    static listOvertimeRuleHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{overtime_rule_id}/history',
+            ...options
+        });
+    }
+    /**
+     * Cancel scheduled changes to an overtime rule
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules.scheduled_changes:delete`
+     *
+     */
+    static cancelOvertimeRuleScheduledChanges(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{overtime_rule_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * List scheduled changes for an overtime rule
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules.scheduled_changes:read`
+     *
+     */
+    static listOvertimeRuleScheduledChanges(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{overtime_rule_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * Schedule a change to an overtime rule
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules.scheduled_changes:create`
+     *
+     */
+    static scheduleOvertimeRuleChange(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{overtime_rule_id}/scheduled_changes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel a scheduled termination for an overtime rule
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules.scheduled_terminations:delete`
+     *
+     */
+    static cancelOvertimeRuleScheduledTermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{overtime_rule_id}/scheduled_termination',
+            ...options
+        });
+    }
+    /**
+     * Schedule a termination for an overtime rule
+     *
+     * Close the rule's timeline at `effective_date`: it stays readable up to that date
+     * and stops applying from it. Removing the rule from every window it ever covered
+     * is the rule delete instead.
+     *
+     * A termination at or before the rule's genesis is refused with `422`, since it
+     * would leave no coverage at all.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules.scheduled_terminations:create`
+     *
+     */
+    static scheduleOvertimeRuleTermination(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{overtime_rule_id}/scheduled_termination',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List overtime rules
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules:read`
+     *
+     */
+    static listOvertimeRules(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules',
+            ...options
+        });
+    }
+    /**
+     * Create overtime rule
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules:create`
+     *
+     */
+    static createOvertimeRule(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete overtime rule
+     *
+     * Remove the rule outright: every version of the family goes, and nothing is
+     * readable through `as_of[valid]` or `/history` afterwards. Closing a rule
+     * going forward while keeping its past is `scheduled_termination` instead.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules:delete`
+     *
+     */
+    static deleteOvertimeRule(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show overtime rule
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules:read`
+     *
+     */
+    static getOvertimeRule(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update overtime rule
+     *
+     * Edit a rule's values from `effective_from` forward: every version starting at
+     * or after that date takes the new values, and earlier versions are untouched.
+     * Where an edit starts inside a version and changes its values, a boundary is
+     * created at `effective_from` so the change applies only from there. Omitted,
+     * the edit starts where the version in effect now starts, correcting it in
+     * place; a future date schedules the change ahead of that version.
+     *
+     * This rewrites what the rule said, not when it existed — moving either end of
+     * the timeline is `genesis` or `scheduled_termination`.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `overtime_packages.overtime_rules:update`
+     *
+     */
+    static updateOvertimeRule(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/overtime_packages/{overtime_package_id}/overtime_rules/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
+export class TimeEntryImports {
+    /**
+     * List Time Entry Imports
+     *
+     * **Required scope:**
+     *
+     * `pay_periods.imports.time_entries:read`
+     *
+     */
+    static listTimeEntryImports(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries',
+            ...options
+        });
+    }
+    /**
+     * Create Time Entry Import
+     *
+     * **Required scope:**
+     *
+     * `pay_periods.imports.time_entries:create`
+     *
+     */
+    static createTimeEntryImport(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get Time Entry Import
+     *
+     * **Required scope:**
+     *
+     * `pay_periods.imports.time_entries:read`
+     *
+     */
+    static getTimeEntryImport(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay_periods/{pay_period_id}/imports/time_entries/{id}',
+            ...options
+        });
+    }
+}
 export class PayPeriods {
     /**
      * List pay periods
@@ -4064,7 +4480,7 @@ export class Projects {
      * returns 422. Switching `federal_pwa_mode` to `none` forces `asset_owner` false
      * and drops the federal-PWA-only params (previously persisted values are left
      * untouched); `budget_currency` defaults to USD when blank. A project owned by
-     * another company returns 403; an unknown id returns 404.
+     * another company, or an unknown id, returns 404.
      *
      *
      * **Required scope:**
@@ -4347,6 +4763,99 @@ export class Users {
         });
     }
 }
+export class PwaTradeApprenticeScope {
+    /**
+     * List apprentice scope decisions
+     *
+     * The reviewed (occupation, craft) pairs on this trade. A pair with no row here is
+     * undecided, which denies apprentice treatment just as `out_of_scope` does — the two
+     * differ only in whether the pair still prompts a curator for review.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.trades.apprenticeship_occupations:read`
+     *
+     */
+    static listApprenticeshipOccupations(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/trades/{trade_id}/apprenticeship_occupations',
+            ...options
+        });
+    }
+    /**
+     * Record an apprentice scope decision
+     *
+     * Records a reviewed verdict for an (occupation, craft) pair. Writes are the
+     * occupation's employer companies' to make — a credential may read the decisions on any
+     * trade it can see, but may only write those whose occupation belongs to a program it
+     * is enrolled in as an employer.
+     *
+     * The decision re-prices every hour the occupation's apprentices charged to this craft,
+     * so it takes effect on recorded work, not only on work going forward.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.trades.apprenticeship_occupations:create`
+     *
+     */
+    static createApprenticeshipOccupation(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/trades/{trade_id}/apprenticeship_occupations',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Remove an apprentice scope decision
+     *
+     * Returns the pair to undecided, which re-opens it for review. Apprentice treatment is
+     * denied either way, so this is a request to decide again rather than a way to grant it.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.trades.apprenticeship_occupations:delete`
+     *
+     */
+    static deleteApprenticeshipOccupation(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/trades/{trade_id}/apprenticeship_occupations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Flip an apprentice scope decision
+     *
+     * Changes the verdict on a reviewed pair. The occupation is create-only — a decision is
+     * replaced rather than re-pointed, so re-pointing one would move the verdict to a
+     * different pair with no recompute for either.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pwa.trades.apprenticeship_occupations:update`
+     *
+     */
+    static updateApprenticeshipOccupation(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pwa/trades/{trade_id}/apprenticeship_occupations/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class Tasks {
     /**
      * Create form assignment task
@@ -4368,6 +4877,23 @@ export class Tasks {
         });
     }
 }
+export class AdjustableLineItems {
+    /**
+     * List adjustable line items
+     *
+     * **Required scope:**
+     *
+     * `time_cards.adjustable_line_items:read`
+     *
+     */
+    static listAdjustableLineItems(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/time_cards/{time_card_id}/adjustable_line_items',
+            ...options
+        });
+    }
+}
 export class TimeCards {
     /**
      * Lock or unlock time card
@@ -4541,6 +5067,46 @@ export class PriorPeriodAdjustments {
             ...options
         });
     }
+    /**
+     * Create Prior Period Adjustment
+     *
+     * **Required scope:**
+     *
+     * `time_cards.prior_period_adjustments:create`
+     *
+     */
+    static createPriorPeriodAdjustment(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/time_cards/{time_card_id}/prior_period_adjustments',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete prior period adjustment
+     *
+     * Permanently remove an adjustment, for undoing one recorded in error. The removed
+     * adjustment is returned. Its allocation is freed back to the funding line item and
+     * the time card's actuals rebuild, so the job's balance due rises by this amount.
+     * Adjustments cannot be edited — delete and re-create to change one.
+     *
+     *
+     * **Required scope:**
+     *
+     * `time_cards.prior_period_adjustments:delete`
+     *
+     */
+    static deletePriorPeriodAdjustment(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/time_cards/{time_card_id}/prior_period_adjustments/{id}',
+            ...options
+        });
+    }
     /**
      * Show prior period adjustment
      *
@@ -4557,6 +5123,23 @@ export class PriorPeriodAdjustments {
         });
     }
 }
+export class TimeCardPwaCompliance {
+    /**
+     * List time card PWA compliance
+     *
+     * **Required scope:**
+     *
+     * `time_cards.pwa_compliances:read`
+     *
+     */
+    static listPwaCompliances(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/time_cards/{time_card_id}/pwa_compliances',
+            ...options
+        });
+    }
+}
 export class TimeEntries {
     /**
      * List time entry versions