@dsptch-work/api-client 0.9.0 → 0.11.0

package/dist/gen/sdk.gen.js

@@ -779,40 +779,6 @@ export class AssetsItems {
             }
         });
     }
-    /**
-     * Unretire item
-     *
-     * **Required scope:**
-     *
-     * `assets.items.retirements:delete`
-     *
-     */
-    static unretireItem(options) {
-        return (options.client ?? client).delete({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/assets/items/{item_id}/retirement',
-            ...options
-        });
-    }
-    /**
-     * Retire item
-     *
-     * **Required scope:**
-     *
-     * `assets.items.retirements:create`
-     *
-     */
-    static retireItem(options) {
-        return (options.client ?? client).post({
-            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
-            url: '/api/v1/assets/items/{item_id}/retirement',
-            ...options,
-            headers: {
-                'Content-Type': 'application/json',
-                ...options.headers
-            }
-        });
-    }
     /**
      * List service schedules
      *
@@ -2615,7 +2581,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
@@ -2633,7 +2602,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
         });
     }
@@ -2648,7 +2617,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
         });
     }
@@ -2663,7 +2632,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',
@@ -2682,7 +2651,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
         });
     }
@@ -2696,7 +2665,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.
@@ -2710,7 +2682,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
         });
     }
@@ -2759,7 +2731,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
         });
     }
@@ -2774,7 +2746,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
         });
     }
@@ -3007,7 +2979,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
@@ -4479,7 +4454,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
@@ -4816,7 +4794,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.