@dsptch-work/api-client 0.1.0 → 0.3.0

package/dist/gen/sdk.gen.js

@@ -1,5 +1,23 @@
 // This file is auto-generated by @hey-api/openapi-ts
 import { client } from './client.gen.js';
+export class ApiKeyScopes {
+    /**
+     * List key scopes
+     *
+     * **No scope required:**
+     *
+     * Every authenticated API key may call this endpoint. It returns the key's persisted scopes;
+     * the endpoint's baseline capability is not included.
+     *
+     */
+    static listApiKeyScopes(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/api_key/scopes',
+            ...options
+        });
+    }
+}
 export class ApprenticeshipApprentices {
     /**
      * List apprenticeship apprentices
@@ -1597,6 +1615,8 @@ export class AtlasFeatures {
     /**
      * List features
      *
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
+     *
      * **Required scope:**
      *
      * `atlas.features:read`
@@ -1612,6 +1632,8 @@ export class AtlasFeatures {
     /**
      * Show feature
      *
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
+     *
      * **Required scope:**
      *
      * `atlas.features:read`
@@ -1629,6 +1651,8 @@ export class AtlasSites {
     /**
      * List sites
      *
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
+     *
      * **Required scope:**
      *
      * `atlas.sites:read`
@@ -1644,6 +1668,8 @@ export class AtlasSites {
     /**
      * Show site
      *
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
+     *
      * **Required scope:**
      *
      * `atlas.sites:read`
@@ -2015,6 +2041,25 @@ export class Companies {
             ...options
         });
     }
+    /**
+     * Update Company
+     *
+     * **Required scope:**
+     *
+     * `companies:update`
+     *
+     */
+    static updateCompanyProfile(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/companies/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class ComplianceChecks {
     /**
@@ -2510,6 +2555,33 @@ export class PwaTrades {
     }
 }
 export class JobWageDeterminationRateRules {
+    /**
+     * List rate rule version history
+     *
+     * A rule's whole valid-time sequence, newest window first and cursor-paginated.
+     * Each entry is a full rate rule carrying its own `valid_from` / `valid_to`
+     * window and a `version_status` of `scheduled`, `current` or `historical`.
+     *
+     * `corrections` is always empty here: a rule keeps no audit layer, so what a
+     * version replaced was not recorded. The field is still returned, because 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 a rule records no transaction axis to read
+     * `as_of[transaction]` against.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.pwa.wage_determinations.rate_rules.history:read`
+     *
+     */
+    static listRateRuleHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules/{rate_rule_uid}/history',
+            ...options
+        });
+    }
     /**
      * List rate rules
      *
@@ -2521,7 +2593,7 @@ export class JobWageDeterminationRateRules {
     static listRateRules(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules',
             ...options
         });
     }
@@ -2536,7 +2608,7 @@ export class JobWageDeterminationRateRules {
     static createRateRule(options) {
         return (options.client ?? client).post({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
@@ -2555,12 +2627,38 @@ export class JobWageDeterminationRateRules {
     static getRateRule(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/rate_rules/{uid}',
             ...options
         });
     }
 }
 export class JobWageDeterminations {
+    /**
+     * List job wage determination version history
+     *
+     * A determination's whole valid-time sequence, newest window first and
+     * cursor-paginated. Each entry is a full determination carrying its own
+     * `valid_from` / `valid_to` window, a `version_status` of `scheduled`,
+     * `current` or `historical`, and the `corrections` that version replaced —
+     * each itself a full determination as previously recorded, so a client
+     * that wants a field-level diff compares two of them. `as_of[valid]` is
+     * rejected, since pinning a point on the valid axis would collapse the
+     * sequence this endpoint returns, and a determination records no
+     * transaction axis to read `as_of[transaction]` against.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs.wage_determinations.history:read`
+     *
+     */
+    static listJobWageDeterminationHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_uid}/history',
+            ...options
+        });
+    }
     /**
      * List job wage determinations
      *
@@ -2606,7 +2704,7 @@ export class JobWageDeterminations {
     static deleteWageDetermination(options) {
         return (options.client ?? client).delete({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/wage_determinations/{id}',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{uid}',
             ...options
         });
     }
@@ -2621,7 +2719,7 @@ export class JobWageDeterminations {
     static getJobWageDetermination(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/jobs/{job_id}/wage_determinations/{id}',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{uid}',
             ...options
         });
     }
@@ -2764,6 +2862,38 @@ export class Jobs {
         });
     }
 }
+export class OversiteSiteCheckIns {
+    /**
+     * List Site Check-ins
+     *
+     * **Required scope:**
+     *
+     * `oversite.sites.check_ins:read`
+     *
+     */
+    static listSiteCheckIns(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/oversite/sites/{site_id}/check_ins',
+            ...options
+        });
+    }
+    /**
+     * Show Site Check-in
+     *
+     * **Required scope:**
+     *
+     * `oversite.sites.check_ins:read`
+     *
+     */
+    static getSiteCheckIn(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/oversite/sites/{site_id}/check_ins/{id}',
+            ...options
+        });
+    }
+}
 export class PayPeriods {
     /**
      * List pay periods
@@ -2814,6 +2944,35 @@ export class CompensationElements {
     }
 }
 export class ExternalMaps {
+    /**
+     * List external map version history
+     *
+     * An external map's whole valid-time sequence, newest window first and
+     * cursor-paginated. Each entry is a full external map carrying its own
+     * `valid_from` / `valid_to` window, a `version_status` of `scheduled`,
+     * `current` or `historical`, and the `corrections` that window replaced —
+     * each itself a full external map as previously recorded, so a client
+     * that wants a field-level diff compares two of them. Pass
+     * `as_of[transaction]` to read the timeline as it was recorded at a past
+     * moment — nested corrections stop at the same point and each
+     * version reports the `transaction_to` it had then, while
+     * `version_status` stays relative to now; `as_of[valid]` is rejected,
+     * since pinning a point on the valid axis would collapse the sequence
+     * this endpoint returns.
+     *
+     *
+     * **Required scope:**
+     *
+     * `payrolls.external_maps.history:read`
+     *
+     */
+    static listExternalMapHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/payrolls/external_maps/{external_map_id}/history',
+            ...options
+        });
+    }
     /**
      * List external maps
      *
@@ -3234,7 +3393,7 @@ export class PerDiems {
      *
      * Permanently remove a per diem, for undoing one created in error. The removed
      * rate is returned. A per diem already applied to a time card cannot be removed
-     * (`422`); deactivate it instead with `PATCH is_active: false`, which retires it
+     * (`422`); deactivate it instead with `PATCH active: false`, which retires it
      * while time-card history keeps its reference.
      *
      *
@@ -4180,6 +4339,35 @@ export class TimeEntries {
     }
 }
 export class Timecodes {
+    /**
+     * List timecode version history
+     *
+     * A timecode's whole valid-time sequence, newest window first and
+     * cursor-paginated. Each entry is a full timecode carrying its own
+     * `valid_from` / `valid_to` window, a `version_status` of `scheduled`,
+     * `current` or `historical`, and the `corrections` that window replaced —
+     * each itself a full timecode as previously recorded, so a client that
+     * wants a field-level diff compares two of them. Pass
+     * `as_of[transaction]` to read the timeline as it was recorded at a past
+     * moment — nested corrections stop at the same point and each
+     * version reports the `transaction_to` it had then, while
+     * `version_status` stays relative to now; `as_of[valid]` is rejected,
+     * since pinning a point on the valid axis would collapse the sequence
+     * this endpoint returns.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timecodes.history:read`
+     *
+     */
+    static listTimecodeHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timecodes/{timecode_id}/history',
+            ...options
+        });
+    }
     /**
      * Cancel all scheduled changes
      *
@@ -4320,7 +4508,11 @@ export class Timecodes {
     /**
      * Show timecode
      *
-     * Fetch a single timecode by id.
+     * Fetch a single timecode by id. Pass `as_of[valid]` /
+     * `as_of[transaction]` to read the version at a point on the
+     * bitemporal plane; both default to now, so an unqualified request
+     * returns the currently-effective version.
+     *
      *
      * **Required scope:**
      *
@@ -4462,6 +4654,64 @@ export class AttestationConfigs {
         });
     }
 }
+export class PaySchedules {
+    /**
+     * List pay schedule version history
+     *
+     * A pay schedule's whole valid-time sequence, newest window first and
+     * cursor-paginated. Each entry is a full pay schedule carrying its own
+     * `valid_from` / `valid_to` window, a `version_status` of `scheduled`,
+     * `current` or `historical`, and the `corrections` that version replaced —
+     * each itself a full pay schedule as previously recorded, so a client that
+     * wants a field-level diff compares two of them. `as_of[valid]` is
+     * rejected, since pinning a point on the valid axis would collapse the
+     * sequence this endpoint returns, and a pay schedule records no
+     * transaction axis to read `as_of[transaction]` against.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.pay_period_configs.history:read`
+     *
+     */
+    static listPayPeriodConfigHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/history',
+            ...options
+        });
+    }
+    /**
+     * List pay schedules
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.pay_period_configs:read`
+     *
+     */
+    static listPayPeriodConfigs(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/pay_period_configs',
+            ...options
+        });
+    }
+    /**
+     * Show pay schedule
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.pay_period_configs:read`
+     *
+     */
+    static getPayPeriodConfig(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/pay_period_configs/{uid}',
+            ...options
+        });
+    }
+}
 export class Holidays {
     /**
      * List holidays
@@ -4532,38 +4782,6 @@ export class Holidays {
         });
     }
 }
-export class PaySchedules {
-    /**
-     * List pay schedules
-     *
-     * **Required scope:**
-     *
-     * `timekeeping.pay_period_configs:read`
-     *
-     */
-    static listPayPeriodConfigs(options) {
-        return (options?.client ?? client).get({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs',
-            ...options
-        });
-    }
-    /**
-     * Show pay schedule
-     *
-     * **Required scope:**
-     *
-     * `timekeeping.pay_period_configs:read`
-     *
-     */
-    static getPayPeriodConfig(options) {
-        return (options.client ?? client).get({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{uid}',
-            ...options
-        });
-    }
-}
 export class TimeCardActuals {
     /**
      * List time card actuals