@dsptch-work/api-client 0.20.0 → 0.21.0

package/dist/gen/sdk.gen.js

@@ -3704,6 +3704,344 @@ export class OvertimeRules {
         });
     }
 }
+export class PayRateRules {
+    /**
+     * Shift pay rate rule genesis
+     *
+     * Move where the rule family's valid-time timeline begins. Moving genesis earlier
+     * extends the first version; moving it later removes coverage before the new date.
+     * A shift to or past a standing termination is refused because it would leave no
+     * coverage.
+     *
+     * The response echoes the family's new first version and carries the new family
+     * `ETag`; use history to inspect the whole resulting timeline.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules.genesis:update`
+     *
+     */
+    static shiftPayRateRuleGenesis(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/genesis',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List pay rate rule version history
+     *
+     * List one rule's complete valid-time sequence, newest window first. Entries
+     * carry the shared family identity as `pay_rates_rule_id`; their temporal
+     * coordinates distinguish versions. Corrections are empty because this rule
+     * engine has no transaction-time audit layer. Both `as_of[valid]` and
+     * `as_of[transaction]` are rejected because this endpoint returns the complete
+     * valid-time timeline and the resource has no transaction-time axis.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules.history:read`
+     *
+     */
+    static listPayRateRuleHistory(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/history',
+            ...options
+        });
+    }
+    /**
+     * Cancel scheduled pay rate rule changes
+     *
+     * Cancel every version after the baseline selected now, preserving that baseline.
+     * The preserved baseline extends through any gap before the first canceled version.
+     * For a wholly future family, the first future version is the baseline.
+     *
+     * Conditional: send the rule's ETag as If-Match.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules.scheduled_changes:delete`
+     *
+     */
+    static cancelPayRateRuleScheduledChanges(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * List scheduled pay rate rule changes
+     *
+     * List every version after the baseline selected now, oldest boundary first. This
+     * paginated timeline slice is the exact set a cancellation removes. Entries carry
+     * pay_rates_rule_id, never an entry-level id; a wholly future family's first
+     * version is its preserved baseline.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules.scheduled_changes:read`
+     *
+     */
+    static listPayRateRuleScheduledChanges(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes',
+            ...options
+        });
+    }
+    /**
+     * Schedule a pay rate rule change
+     *
+     * Apply a rule recipe from a date forward. Omitted recipe halves carry from the
+     * version affected at that date. Returns 201 only when a new segment is added.
+     * A no-op against the targeted segment leaves later scheduled segments unchanged.
+     *
+     * Conditional: send the rule's ETag as If-Match.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules.scheduled_changes:create`
+     *
+     */
+    static schedulePayRateRuleChange(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Cancel pay rate rule scheduled termination
+     *
+     * Remove the family's standing finite end and restore an open-ended upper bound.
+     * The response echoes the current or otherwise most-relevant version and carries the
+     * new family `ETag`; use history to inspect the whole reopened timeline. Cancellation
+     * reopens the last surviving version with its existing recipe and does not restore
+     * versions removed when the termination was scheduled.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules.scheduled_terminations:delete`
+     *
+     */
+    static cancelPayRateRuleScheduledTermination(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_termination',
+            ...options
+        });
+    }
+    /**
+     * Schedule pay rate rule termination
+     *
+     * Close the rule family's valid-time timeline at `effective_date`. The rule remains
+     * readable before that date and stops applying from it. Past, current, and future
+     * dates are accepted when they fall after genesis. A family can have one standing
+     * termination; cancel it before scheduling another. Scheduling removes versions
+     * that start after the new end and truncates the version spanning it.
+     *
+     * The response echoes the family's current or otherwise most-relevant version and
+     * carries the new family `ETag`; use history to inspect the whole resulting timeline.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules.scheduled_terminations:create`
+     *
+     */
+    static schedulePayRateRuleTermination(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_termination',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List pay rate rules
+     *
+     * List the versions of this package's rules valid at one point in time. Each
+     * `id` is stable across that rule's valid-time versions.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules:read`
+     *
+     */
+    static listPayRateRules(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules',
+            ...options
+        });
+    }
+    /**
+     * Create a pay rate rule
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules:create`
+     *
+     */
+    static createPayRateRule(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete a pay rate rule
+     *
+     * Remove every valid-time version of the rule family.
+     *
+     * To preserve history while stopping future applicability, schedule a termination instead.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules:delete`
+     *
+     */
+    static deletePayRateRule(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}',
+            ...options
+        });
+    }
+    /**
+     * Get a pay rate rule
+     *
+     * Fetch the version of one package rule valid at a point in time.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules:read`
+     *
+     */
+    static getPayRateRule(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update a pay rate rule
+     *
+     * Change a rule from an effective date forward. Omitted effect or conditions
+     * keep that part of the targeted version. When the targeted recipe changes, the
+     * resulting complete recipe applies from that coordinate across later scheduled
+     * versions; an unchanged recipe does not alter later scheduled versions. Omit `effective_from` to
+     * correct the version valid now — or the nearest past/future version when none is
+     * valid now — from its exact existing start. A beginless version requires an
+     * explicit date.
+     *
+     * Conditional: send the rule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages.rules:update`
+     *
+     */
+    static updatePayRateRule(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+}
+export class PayRateRulePackages {
+    /**
+     * List pay rate rule packages
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages:read`
+     *
+     */
+    static listPayRateRulePackages(options) {
+        return (options?.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages',
+            ...options
+        });
+    }
+    /**
+     * Create a pay rate rule package
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages:create`
+     *
+     */
+    static createPayRateRulePackage(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Get a pay rate rule package
+     *
+     * **Required scope:**
+     *
+     * `pay.rates.rule_packages:read`
+     *
+     */
+    static getPayRateRulePackage(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/pay/rates/rule_packages/{id}',
+            ...options
+        });
+    }
+}
 export class AggregateTimeImports {
     /**
      * List Aggregate Time Imports
@@ -4367,7 +4705,9 @@ export class People {
      *
      * Every valid-time version of one employment stint, newest first. Each
      * entry uses `people_employment_id` rather than an entry-level id and
-     * includes prior recorded corrections.
+     * includes prior recorded corrections. Company managers may read
+     * coworker history, but direct monetary fields are limited to their
+     * own employment in versions and corrections.
      *
      *
      * **Required scope:**
@@ -4386,7 +4726,9 @@ export class People {
      * List employment histories
      *
      * Employment history across all authorized stints in the credential
-     * company, including ended stints and rehired employments.
+     * company, including ended stints and rehired employments. Company
+     * managers receive direct monetary fields only for their own
+     * employment in versions and corrections.
      *
      *
      * **Required scope:**
@@ -4405,8 +4747,9 @@ export class People {
      * List employments
      *
      * Current employments in the credential company, or versions at
-     * `as_of[valid]`. A user key sees its own records unless it is a
-     * company administrator.
+     * `as_of[valid]`. Company managers and administrators see every
+     * company employment. Managers receive direct monetary fields only
+     * for their own employment. Other user keys see only their own records.
      *
      *
      * **Required scope:**
@@ -4424,6 +4767,11 @@ export class People {
     /**
      * Get employment
      *
+     * The employment version covering now or `as_of[valid]`. Company
+     * managers may read coworkers, but receive direct monetary fields
+     * only for their own employment.
+     *
+     *
      * **Required scope:**
      *
      * `people.employments:read`
@@ -4719,9 +5067,11 @@ export class Projects {
      *
      * List the company's projects — the top-level containers that organize jobs into
      * federal and regional PWA compliance scopes. Returned oldest first (ordered by
-     * creation time, then id) and scoped to the API key's company, so projects owned
-     * by other companies are excluded. Narrow with the `filter[...]` query parameters
-     * and the `created_at`/`updated_at` time filters; results are paginated.
+     * creation time, then id) and scoped to projects owned by the API key's company,
+     * their descendants, and projects where the company participates. User-scoped
+     * keys also require the user's own project access. Narrow with the `filter[...]`
+     * query parameters and the `created_at`/`updated_at` time filters; results are
+     * paginated.
      *
      *
      * **Required scope:**
@@ -4746,10 +5096,11 @@ export class Projects {
      * prevailing-wage lock-in / beginning-of-construction / placed-in-service dates)
      * and `asset_owner` apply only while `federal_pwa_mode` is not `none`, so sending
      * one of them on a project that tracks no federal PWA — even as null — returns
-     * 422. Returns 201 with the created project; a duplicate name within the
-     * company, a creator outside the owning company, end_date before start_date, an
-     * unknown PWA mode, an unparseable date, or a regional mode without a region each
-     * return 422.
+     * 422. `parent_id` may name a project visible to the API key's policy, and
+     * `participating_company_ids` is the complete set of participating companies.
+     * Remove a participant's jobs before removing it from this set. Returns 201
+     * with the project; unknown or inaccessible parent or
+     * company IDs return 404, and invalid attributes or relationships return 422.
      *
      *
      * **Required scope:**
@@ -4771,8 +5122,10 @@ export class Projects {
     /**
      * Show project
      *
-     * Fetch a single project by id. Scoped to the API key's company — a project owned
-     * by another company, or an unknown id, returns 404.
+     * Fetch a single project by id. A company-scoped key can read its owned projects,
+     * their descendants, and projects where the company participates. User-scoped
+     * keys also require the user's own project access. An unrelated project or an
+     * unknown id returns 404.
      *
      *
      * **Required scope:**
@@ -4796,8 +5149,10 @@ export class Projects {
      * dates) and `asset_owner` apply only while `federal_pwa_mode` is not `none`:
      * switching it to `none` clears the stored values and forces `asset_owner`
      * false, and sending one of them while federal tracking is off — even as null —
-     * returns 422. `budget_currency` defaults to USD when blank. A project owned by
-     * another company, or an unknown id, returns 404.
+     * returns 422. `budget_currency` defaults to USD when blank. `parent_id` moves
+     * or detaches the project, and `participating_company_ids` replaces the complete
+     * set of participating companies. Remove a participant's jobs before removing
+     * it from this set. Only the owning company may update the project.
      *
      *
      * **Required scope:**