@dsptch-work/api-client 0.11.0 → 0.13.0

package/dist/gen/sdk.gen.js

@@ -779,6 +779,44 @@ export class AssetsItems {
             }
         });
     }
+    /**
+     * Unarchive an Item
+     *
+     * **Required scope:**
+     *
+     * `assets.items.archives:delete`
+     *
+     */
+    static unarchiveItem(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/items/{item_id}/archive',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Archive an Item
+     *
+     * **Required scope:**
+     *
+     * `assets.items.archives:create`
+     *
+     */
+    static archiveItem(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/items/{item_id}/archive',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List service schedules
      *
@@ -1196,6 +1234,44 @@ export class AssetsProducts {
             }
         });
     }
+    /**
+     * Unarchive a Product
+     *
+     * **Required scope:**
+     *
+     * `assets.products.archives:delete`
+     *
+     */
+    static unarchiveProduct(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/archive',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Archive a Product
+     *
+     * **Required scope:**
+     *
+     * `assets.products.archives:create`
+     *
+     */
+    static archiveProduct(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/archive',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * Adjust inventory on-hand count
      *
@@ -1441,6 +1517,91 @@ export class AssetsSites {
         });
     }
 }
+export class AssetsSubLocations {
+    /**
+     * List Sub Locations
+     *
+     * **Required scope:**
+     *
+     * `assets.sub_locations:read`
+     *
+     */
+    static listSubLocations(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/sub_locations',
+            ...options
+        });
+    }
+    /**
+     * Create Sub Location
+     *
+     * **Required scope:**
+     *
+     * `assets.sub_locations:create`
+     *
+     */
+    static createSubLocation(options) {
+        return (options?.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/sub_locations',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options?.headers
+            }
+        });
+    }
+    /**
+     * Delete Sub Location
+     *
+     * **Required scope:**
+     *
+     * `assets.sub_locations:delete`
+     *
+     */
+    static deleteSubLocation(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/sub_locations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Get Sub Location
+     *
+     * **Required scope:**
+     *
+     * `assets.sub_locations:read`
+     *
+     */
+    static getSubLocation(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/sub_locations/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update Sub Location
+     *
+     * **Required scope:**
+     *
+     * `assets.sub_locations:update`
+     *
+     */
+    static updateSubLocation(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/sub_locations/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
 export class AssetsTransfers {
     /**
      * List transfers
@@ -2078,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
@@ -2657,6 +2844,41 @@ export class JobWageDeterminationRateRules {
     }
 }
 export class JobWageDeterminations {
+    /**
+     * Shift job wage determination genesis
+     *
+     * Move when a determination'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 determination existed rather than what it said —
+     * no version's attributes are rewritten. Moving the other end of the timeline
+     * is `scheduled_termination`, and changing a version's values is the
+     * determination update.
+     *
+     * A shift to or past a scheduled termination is refused with `422`, since it
+     * would leave no coverage at all.
+     *
+     * Conditional: send the determination's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations.genesis:update`
+     *
+     */
+    static shiftJobWageDeterminationGenesis(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/genesis',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List job wage determination version history
      *
@@ -2686,6 +2908,100 @@ export class JobWageDeterminations {
             ...options
         });
     }
+    /**
+     * Cancel scheduled changes on job wage determination
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations.scheduled_changes:delete`
+     *
+     */
+    static cancelJobWageDeterminationScheduledChanges(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * List scheduled changes for job wage determination
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations.scheduled_changes:read`
+     *
+     */
+    static listJobWageDeterminationScheduledChanges(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * Schedule effective-dated change on job wage determination
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations.scheduled_changes:create`
+     *
+     */
+    static scheduleJobWageDeterminationChange(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_changes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel scheduled termination on job wage determination
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations.scheduled_terminations:delete`
+     *
+     */
+    static cancelJobWageDeterminationScheduledTermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_termination',
+            ...options
+        });
+    }
+    /**
+     * Schedule termination on job wage determination
+     *
+     * End a determination's valid coverage at `effective_date`: segments beyond
+     * it are dropped and one spanning it is truncated, so the determination stops
+     * being valid from that point on. Earlier versions are untouched and stay
+     * readable through `as_of[valid]` and `/history`.
+     *
+     * Moving an end is cancel-then-schedule: cancel the standing termination,
+     * then schedule the one you want.
+     *
+     * Conditional: send the determination's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations.scheduled_terminations:create`
+     *
+     */
+    static scheduleJobWageDeterminationTermination(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/scheduled_termination',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
     /**
      * List job wage determinations
      *
@@ -2750,6 +3066,37 @@ export class JobWageDeterminations {
             ...options
         });
     }
+    /**
+     * Update job wage determination
+     *
+     * Edit a determination's values from `effective_from` forward: every version
+     * starting at or after that instant 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.
+     *
+     * This rewrites what the determination said, not when it existed — moving
+     * either end of the timeline is `genesis` or `scheduled_termination`.
+     *
+     * Conditional: send the determination's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations:update`
+     *
+     */
+    static updateJobWageDetermination(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class Jobs {
     /**
@@ -2893,6 +3240,12 @@ export class OversiteSiteCheckIns {
     /**
      * List Site Check-ins
      *
+     * Returns only the check-ins visible to the API key's company: those made by its
+     * currently-employed members, plus all of the site's check-ins when the company
+     * holds a claim on it with check-in features enabled. Other check-ins are
+     * omitted, so a visible site can return an empty list.
+     *
+     *
      * **Required scope:**
      *
      * `oversite.sites.check_ins:read`
@@ -2908,6 +3261,12 @@ export class OversiteSiteCheckIns {
     /**
      * Show Site Check-in
      *
+     * A check-in is visible to the API key's company when its author is a
+     * currently-employed member, or when the company holds a claim on the site
+     * with check-in features enabled; requesting one outside that visibility
+     * returns `404`.
+     *
+     *
      * **Required scope:**
      *
      * `oversite.sites.check_ins:read`
@@ -4035,6 +4394,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
@@ -4208,6 +4584,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
      *
@@ -4224,6 +4640,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