@dsptch-work/api-client 0.2.0 → 0.4.0

package/dist/gen/sdk.gen.js

@@ -1615,7 +1615,7 @@ export class AtlasFeatures {
     /**
      * List features
      *
-     * For company- and user-authenticated keys, Atlas API access must be enabled for the key's company.
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
      *
      * **Required scope:**
      *
@@ -1632,7 +1632,7 @@ export class AtlasFeatures {
     /**
      * Show feature
      *
-     * For company- and user-authenticated keys, Atlas API access must be enabled for the key's company.
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
      *
      * **Required scope:**
      *
@@ -1651,7 +1651,7 @@ export class AtlasSites {
     /**
      * List sites
      *
-     * For company- and user-authenticated keys, Atlas API access must be enabled for the key's company.
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
      *
      * **Required scope:**
      *
@@ -1668,7 +1668,7 @@ export class AtlasSites {
     /**
      * Show site
      *
-     * For company- and user-authenticated keys, Atlas API access must be enabled for the key's company.
+     * Company- and user-authenticated keys require the paid Atlas entitlement for the key's company.
      *
      * **Required scope:**
      *
@@ -2041,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 {
     /**
@@ -2843,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
@@ -2903,8 +2954,11 @@ export class ExternalMaps {
      * 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; `as_of[valid]` is rejected, since pinning a point on the valid
-     * axis would collapse the sequence this endpoint returns.
+     * 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:**
@@ -3339,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.
      *
      *
@@ -4144,6 +4198,15 @@ export class TimeEntries {
     /**
      * List time entry versions
      *
+     * Change feed for time entries, following the API-wide
+     * change-feed contract (see "Change feeds" in the API
+     * overview): poll with `filter[created_at][gte]` set to your
+     * watermark, deduplicate on `(id, event, timestamp)`, and
+     * advance the watermark only to `meta.complete_through`.
+     * The feed carries `create`, `update`, and `destroy` events,
+     * retained for at least 30 days.
+     *
+     *
      * **Required scope:**
      *
      * `time_entries.deltas:read`
@@ -4164,7 +4227,7 @@ export class TimeEntries {
      * and approval status. Results are ordered by start_time then id (ascending)
      * and cursor-paginated. Narrow with filter[user_id], filter[job_id] (or
      * filter[job_id][null]=true for entries with no job), and
-     * filter[time_card_id]; the controller also accepts gte/lte time-range
+     * filter[timekeeping_time_card_id]; the controller also accepts gte/lte time-range
      * filters on start_time, end_time, created_at, and updated_at.
      *
      *
@@ -4183,12 +4246,12 @@ export class TimeEntries {
     /**
      * Create time entry
      *
-     * Create a time entry. Required: time_card_id, start_time, and end_time;
+     * Create a time entry. Required: timekeeping_time_card_id, start_time, and end_time;
      * user_id is derived server-side from the time card. Both start_time and
      * end_time must fall on a whole-minute boundary (nonzero seconds are
      * rejected); start_time must fall within the time card's pay period, and
      * end_time must be after start_time. Optional job_id (the worker must have a
-     * Position covering that job at start_time), timecode_id (must be one of the
+     * Position covering that job at start_time), timekeeping_timecode_id (must be one of the
      * company's default timecodes), state, description, hourly_rate_cents (derived
      * from the position/user default when omitted), and feature_ids. Supplying
      * feature_ids — or setting feature_allocation_acknowledged true — satisfies a
@@ -4295,8 +4358,11 @@ export class Timecodes {
      * 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; `as_of[valid]` is rejected, since pinning a point on the valid
-     * axis would collapse the sequence this endpoint returns.
+     * 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:**
@@ -4423,31 +4489,6 @@ export class Timecodes {
             }
         });
     }
-    /**
-     * Terminate timecode
-     *
-     * Terminate a timecode by closing its valid-time range — a soft delete that
-     * sets `valid_to` to the supplied `termination_date` (defaulting to today)
-     * rather than removing the row, and returns the updated timecode. A
-     * `termination_date` earlier than the timecode's `valid_from` returns 422.
-     *
-     *
-     * **Required scope:**
-     *
-     * `timecodes:delete`
-     *
-     */
-    static terminateTimecode(options) {
-        return (options.client ?? client).delete({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timecodes/{id}',
-            ...options,
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers
-            }
-        });
-    }
     /**
      * Show timecode
      *