@dsptch-work/api-client 0.8.0 → 0.10.0

package/dist/gen/sdk.gen.js

@@ -2234,6 +2234,61 @@ export class Forms {
             ...options
         });
     }
+    /**
+     * List form submission versions
+     *
+     * Change feed for form submissions, 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 `destroy` events only, returned
+     * oldest event first: archiving hard-deletes the row, so the live index
+     * offers no deletion signal, while creates and updates surface there through
+     * `created_at` / `updated_at` — and un-archiving does not exist in the
+     * product, so a `destroy` here is final.
+     *
+     * Events are guaranteed for at least the last 30 days. Older events are
+     * served for as long as they remain stored, and may be removed without
+     * notice. Past the retention window, or after a lost watermark, resync by
+     * re-listing the live index and diffing your replica.
+     *
+     * One request covers at most 32 days of event time, and
+     * `filter[created_at][gte]` and `[lte]` place that interval anywhere in the
+     * feed's history. Sending only `[gte]` covers the 32 days after it, only
+     * `[lte]` the 32 days before it, and neither the 32 days beginning 30 days
+     * ago. A wider interval is refused with a `422` of type `interval_too_wide`
+     * rather than narrowed to fit — split it into consecutive windows and read
+     * them in order, and their pages join without gaps. Both bounds are
+     * inclusive, so an event stamped exactly on a shared bound appears in both
+     * pages — deduplicate as usual. An interval whose `[lte]` precedes its
+     * `[gte]` is refused too, as a `422` of type `invalid_filter_value`, rather
+     * than answered with the empty page it names.
+     *
+     * `meta.complete_through` is never later than the end of the interval you
+     * asked for, so a request ending in the past reports its own `[lte]`.
+     * Advancing your watermark to it walks a consumer that has fallen behind
+     * forward one window per poll, rather than past events no response carried.
+     *
+     * Visibility is re-derived from the definition and submitter retained on the
+     * event; the live index also grants access through a job assignment, which
+     * archival clears, so a user-scoped key sees a subset of its index-visible
+     * events, never a superset. A company-scoped key reads the whole tenant and
+     * is unaffected. `timestamp` (and the `filter[created_at]` range) is the
+     * time the event occurred, not the submission's own timestamps.
+     *
+     *
+     * **Required scope:**
+     *
+     * `form_submissions.deltas:read`
+     *
+     */
+    static listFormSubmissionDeltas(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/form_submissions/deltas',
+            ...options
+        });
+    }
     /**
      * List form submissions
      *
@@ -2560,7 +2615,10 @@ export class JobWageDeterminationRateRules {
      *
      * 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`.
+     * window and a `version_status` of `scheduled`, `current` or `historical`. An
+     * entry carries the family key as `pay_rates_rule_id` and no `id` or `uid` of
+     * its own — every version shares the family key, so versions are told apart by
+     * their window coordinates.
      *
      * `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
@@ -2578,7 +2636,7 @@ export class JobWageDeterminationRateRules {
     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',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{rate_rule_id}/history',
             ...options
         });
     }
@@ -2593,7 +2651,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_uid}/rate_rules',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules',
             ...options
         });
     }
@@ -2608,7 +2666,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_uid}/rate_rules',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
@@ -2627,7 +2685,7 @@ 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_uid}/rate_rules/{uid}',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/rate_rules/{id}',
             ...options
         });
     }
@@ -2641,7 +2699,10 @@ export class JobWageDeterminations {
      * `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
+     * that wants a field-level diff compares two of them. An entry carries
+     * the family key as `job_wage_determination_id` and no `id` or `uid` of
+     * its own — every version shares the family key, so versions are told
+     * apart by their window coordinates. `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.
@@ -2655,7 +2716,7 @@ export class JobWageDeterminations {
     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',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{wage_determination_id}/history',
             ...options
         });
     }
@@ -2704,7 +2765,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/{uid}',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{id}',
             ...options
         });
     }
@@ -2719,7 +2780,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/{uid}',
+            url: '/api/v1/jobs/{job_id}/wage_determinations/{id}',
             ...options
         });
     }
@@ -2952,7 +3013,10 @@ export class ExternalMaps {
      * `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
+     * that wants a field-level diff compares two of them. An entry carries
+     * the family key as `payrolls_external_map_id` and no `id` or
+     * `bitemporal_id` of its own — every version shares the family key, so
+     * versions are told apart by their window coordinates. 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
@@ -4203,12 +4267,37 @@ export class TimeEntries {
      * 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
-     * for the last 30 days, returned oldest event first. A
-     * watermark older than that window is refused with a `422`
-     * rather than answered with a page that cannot be complete —
-     * resync by re-crawling `/api/v1/time_entries` and diffing
-     * against your replica.
+     * The feed carries `create`, `update`, and `destroy` events,
+     * returned oldest event first.
+     *
+     * Events are guaranteed for at least the last 30 days. Older
+     * events are served for as long as they remain stored, and
+     * may be removed without notice.
+     *
+     * One request covers at most 32 days of event time, and
+     * `filter[created_at][gte]` and `[lte]` place that interval
+     * anywhere in the feed's history. Sending only `[gte]`
+     * covers the 32 days after it, only `[lte]` the 32 days
+     * before it, and neither the 32 days beginning 30 days ago.
+     * A wider interval is refused with a `422` of type
+     * `interval_too_wide` rather than narrowed to fit — split it
+     * into consecutive windows and read them in order, and their
+     * pages join without gaps. Both bounds are inclusive, so an
+     * event stamped exactly on a shared bound appears in both
+     * pages — deduplicate as usual. An interval whose `[lte]`
+     * precedes its `[gte]` is refused too, as a `422` of type
+     * `invalid_filter_value`, rather than answered with the empty
+     * page it names.
+     *
+     * `meta.complete_through` is never later than the end of the
+     * interval you asked for, so a request ending in the past
+     * reports its own `[lte]`. Advancing your watermark to it
+     * walks a consumer that has fallen behind forward one window
+     * per poll, rather than past events no response carried.
+     *
+     * `filter[event]` narrows the payload, not the work: the
+     * feed is indexed on event time, so a filtered request costs
+     * what an unfiltered one over the same interval costs.
      *
      *
      * **Required scope:**
@@ -4308,8 +4397,8 @@ export class TimeEntries {
      * optional and only supplied fields change. Authorization is re-checked after
      * attributes are assigned, so moving the entry to a time card in another
      * company is forbidden (403). If the change would push categorized allocation
-     * minutes past the time card's worked minutes, the request returns 422 unless
-     * confirm_allocation_conflict is sent true. The feature-allocation cap is
+     * minutes past the time card's overtime eligible minutes, the request returns
+     * 422 unless confirm_allocation_conflict is sent true. The feature-allocation cap is
      * enforced, and because a persisted feature_ids= writes its join rows
      * immediately, a rejected save rolls them back within the enclosing
      * transaction.
@@ -4399,7 +4488,10 @@ export class Timecodes {
      * `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
+     * wants a field-level diff compares two of them. An entry carries the
+     * family key as `timekeeping_timecode_id` and no `id` of its own —
+     * every version shares the family key, so versions are told apart by
+     * their window coordinates. 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
@@ -4673,7 +4765,7 @@ export class AttestationConfigs {
     static listAttestationConfigs(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs',
             ...options
         });
     }
@@ -4688,7 +4780,7 @@ export class AttestationConfigs {
     static createAttestationConfig(options) {
         return (options.client ?? client).post({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
@@ -4707,7 +4799,7 @@ export class AttestationConfigs {
     static deleteAttestationConfig(options) {
         return (options.client ?? client).delete({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs/{id}',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}',
             ...options
         });
     }
@@ -4722,7 +4814,7 @@ export class AttestationConfigs {
     static getAttestationConfig(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/attestation_configs/{id}',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/attestation_configs/{id}',
             ...options
         });
     }
@@ -4736,7 +4828,10 @@ export class PaySchedules {
      * `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
+     * wants a field-level diff compares two of them. An entry carries the
+     * family key as `timekeeping_pay_period_config_id` and no identifier of
+     * its own — every version shares the family key, so versions are told
+     * apart by their window coordinates. `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.
@@ -4750,7 +4845,7 @@ export class PaySchedules {
     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',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/history',
             ...options
         });
     }
@@ -4780,7 +4875,7 @@ export class PaySchedules {
     static getPayPeriodConfig(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{uid}',
+            url: '/api/v1/timekeeping/pay_period_configs/{id}',
             ...options
         });
     }
@@ -4797,7 +4892,7 @@ export class Holidays {
     static listHolidays(options) {
         return (options.client ?? client).get({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays',
             ...options
         });
     }
@@ -4812,7 +4907,7 @@ export class Holidays {
     static createHoliday(options) {
         return (options.client ?? client).post({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays',
             ...options,
             headers: {
                 'Content-Type': 'application/json',
@@ -4831,7 +4926,7 @@ export class Holidays {
     static deleteHoliday(options) {
         return (options.client ?? client).delete({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays/{id}',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}',
             ...options
         });
     }
@@ -4846,7 +4941,7 @@ export class Holidays {
     static updateHoliday(options) {
         return (options.client ?? client).patch({
             security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_uid}/holidays/{id}',
+            url: '/api/v1/timekeeping/pay_period_configs/{pay_period_config_id}/holidays/{id}',
             ...options,
             headers: {
                 'Content-Type': 'application/json',