@dsptch-work/api-client 0.46.0 → 0.48.0

package/dist/gen/sdk.gen.js

@@ -1755,6 +1755,108 @@ export class AssetsProducts {
             }
         });
     }
+    /**
+     * List documents
+     *
+     * **Required scope:**
+     *
+     * `assets.products.documents:read`
+     *
+     */
+    static listProductDocuments(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/documents',
+            ...options
+        });
+    }
+    /**
+     * Create document
+     *
+     * **Required scope:**
+     *
+     * `assets.products.documents:create`
+     *
+     */
+    static createProductDocument(options) {
+        return (options.client ?? client).post({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/documents',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * Delete document
+     *
+     * Permanently deletes the document (`destroy!`). Succeeds with 204 and no
+     * body. A document that belongs to another product is 404.
+     *
+     *
+     * **Required scope:**
+     *
+     * `assets.products.documents:delete`
+     *
+     */
+    static deleteProductDocument(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Show document
+     *
+     * **Required scope:**
+     *
+     * `assets.products.documents:read`
+     *
+     */
+    static getProductDocument(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/documents/{id}',
+            ...options
+        });
+    }
+    /**
+     * Update document
+     *
+     * **Required scope:**
+     *
+     * `assets.products.documents:update`
+     *
+     */
+    static updateProductDocument(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/documents/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
+    /**
+     * List document versions
+     *
+     * **Required scope:**
+     *
+     * `assets.products.documents.versions:read`
+     *
+     */
+    static listProductDocumentVersions(options) {
+        return (options.client ?? client).get({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/assets/products/{product_id}/documents/{document_id}/versions',
+            ...options
+        });
+    }
 }
 export class AssetsSites {
     /**
@@ -4657,6 +4759,28 @@ export class Jobs {
             }
         });
     }
+    /**
+     * Delete job
+     *
+     * Deletes a job that has no restricting activity. A job still
+     * referenced by time entries, time sessions, job-owned timecodes,
+     * archived form assignments, or other restricted dependents is
+     * refused with a `422`. An unused job returns `204` and is gone
+     * from a later GET.
+     *
+     *
+     * **Required scope:**
+     *
+     * `jobs:delete`
+     *
+     */
+    static deleteJob(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/jobs/{id}',
+            ...options
+        });
+    }
     /**
      * Show job
      *
@@ -5038,11 +5162,11 @@ export class ProductionJobScopePrices {
      * List production job scope prices
      *
      * Scope prices on a production-tracked job. Company keys,
-     * and user keys held by an administrator, manager, safety
-     * manager, or field lead of the company that owns the job,
-     * receive `unit_price_cents`. Other user
-     * keys, held by crew on the job, receive the same rows
-     * without the price. A present `unit_price_cents` is an
+     * and user keys held by an administrator, manager, or safety
+     * manager of the company that owns the job, receive
+     * `unit_price_cents`. Other user keys, held by a field lead
+     * of that company or by crew on the job, receive the same
+     * rows without the price. A present `unit_price_cents` is an
      * exact decimal string, or null when the current price is unknown.
      *
      *
@@ -5104,11 +5228,11 @@ export class ProductionJobScopePrices {
      * Show production job scope price
      *
      * One scope price on a production-tracked job. Company keys,
-     * and user keys held by an administrator, manager, safety
-     * manager, or field lead of the company that owns the job,
-     * receive `unit_price_cents`. Other user
-     * keys, held by crew on the job, receive the row without
-     * the price. A present `unit_price_cents` is an exact
+     * and user keys held by an administrator, manager, or safety
+     * manager of the company that owns the job, receive
+     * `unit_price_cents`. Other user keys, held by a field lead
+     * of that company or by crew on the job, receive the row
+     * without the price. A present `unit_price_cents` is an exact
      * decimal string, or null when the current price is unknown.
      *
      *
@@ -9772,6 +9896,10 @@ export class PwaTradeApprenticeScope {
      * undecided, which denies apprentice treatment just as `out_of_scope` does — the two
      * differ only in whether the pair still prompts a curator for review.
      *
+     * A key whose company owns the trade's project root, or created its standalone job,
+     * lists every decision on it. Any other key lists only the decisions on its company's
+     * own occupations.
+     *
      *
      * **Required scope:**
      *
@@ -9789,9 +9917,9 @@ export class PwaTradeApprenticeScope {
      * Record an apprentice scope decision
      *
      * Records a reviewed verdict for an (occupation, craft) pair. Writes are the
-     * occupation's employer companies' to make — a credential may read the decisions on any
-     * trade it can see, but may only write those whose occupation belongs to a program it
-     * is enrolled in as an employer.
+     * occupation's employer companies' to make — a key may write a decision on any trade
+     * it can read, but only for an occupation of a program its company is enrolled in as
+     * an employer.
      *
      * The decision re-prices every hour the occupation's apprentices charged to this craft,
      * so it takes effect on recorded work, not only on work going forward.
@@ -9837,8 +9965,9 @@ export class PwaTradeApprenticeScope {
      *
      * Returns one reviewed (occupation, craft) pair on this trade. The payload is
      * the same object create, update, and destroy already serialize. A missing,
-     * mismatched, or out-of-scope id is not found. Reading follows the trade;
-     * employer enrollment is not required.
+     * mismatched, or out-of-scope id is not found. A key whose company owns the
+     * trade's project root, or created its standalone job, reads every decision on
+     * it; any other key reads only the decisions on its company's own occupations.
      *
      *
      * **Required scope:**
@@ -10536,6 +10665,17 @@ export class Timecodes {
     /**
      * Cancel scheduled termination on timecode
      *
+     * Remove the timecode's standing end: its last version runs on, open-ended,
+     * with the values it carries now. Everything recorded since the end was set —
+     * a correction, a change scheduled ahead of the end, a genesis shift — is
+     * kept. A change that was scheduled past the end was removed when the end was
+     * set, and does not come back.
+     *
+     * Returns `422` `nothing_to_cancel` when the timecode has no end.
+     *
+     * Conditional: send the timecode's `ETag` as `If-Match`.
+     *
+     *
      * **Required scope:**
      *
      * `timecodes.scheduled_terminations:delete`
@@ -10659,20 +10799,25 @@ export class Timecodes {
      *
      * Update a timecode by applying a bitemporal correction rather than mutating
      * the row in place; `name` must remain present, and only the fields sent in
-     * the body are changed (omitted fields keep the corrected version's values).
-     * Changing rate-affecting attributes (billable, overtime_eligible, unpaid,
-     * pwa, holiday, pto, rest_and_recovery, incentive_pay_eligible) enqueues a
-     * background rate re-sync.
+     * the body are changed (omitted fields keep the values each corrected
+     * segment already holds). Changing rate-affecting attributes (billable,
+     * overtime_eligible, unpaid, pwa, holiday, pto, rest_and_recovery,
+     * incentive_pay_eligible) enqueues a background rate re-sync from the first
+     * instant one of them actually changes.
      *
      * The correction may name the stretch of valid time it applies to.
      * `effective_from` defaults to the addressed version's own start, and
      * `effective_to` — omitted — runs the correction to the end of the segment
      * containing it, so later scheduled changes stand. Sending `effective_to`
      * corrects exactly `[effective_from, effective_to)` and the timeline resumes
-     * its previous values afterwards. Neighbouring segments' boundaries are the
-     * engine's to move; a request never names one. Sending neither parameter
-     * corrects from the addressed version's start, which is what an unqualified
-     * update has always done.
+     * its previous values afterwards. A span may cross change points the
+     * timeline already carries: each segment it crosses takes the sent fields
+     * and keeps its own values for the rest, and each is validated as it would
+     * stand, so a value one of them cannot take refuses the whole correction
+     * with `422`, naming the change point. Neighbouring segments' boundaries are
+     * the engine's to move; a request never names one. Sending neither
+     * parameter corrects from the addressed version's start, which is what an
+     * unqualified update has always done.
      *
      * Conditional: send the timecode's `ETag` as `If-Match`.
      *
@@ -10862,6 +11007,35 @@ export class PaySchedules {
             }
         });
     }
+    /**
+     * Delete pay schedule
+     *
+     * Remove the pay schedule outright: every version of the family goes, and
+     * nothing is readable through `as_of[valid]` or `/history` afterwards. This
+     * is valid-axis erasure — the family is deleted, not retracted on the
+     * transaction axis.
+     *
+     * Deletion is asynchronous: an empty family, or a populated family this
+     * caller is allowed to delete, enqueues the same job the web app uses and
+     * answers `202`. Recorded time, payroll data, or retained payroll mappings
+     * that the caller cannot take with them answer `409`. A delete already
+     * running answers `409`.
+     *
+     * Conditional: send the schedule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.pay_period_configs:delete`
+     *
+     */
+    static deletePayPeriodConfig(options) {
+        return (options.client ?? client).delete({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/pay_period_configs/{id}',
+            ...options
+        });
+    }
     /**
      * Show pay schedule
      *
@@ -10877,6 +11051,39 @@ export class PaySchedules {
             ...options
         });
     }
+    /**
+     * Schedule a pay schedule change
+     *
+     * Apply a dated change to the pay schedule, the same path the
+     * web scheduled-change form uses. `effective_date` is required
+     * and must fall on `start_day_of_week`; the API never snaps it
+     * to another weekday. Other fields are optional. `tz_name`,
+     * `time_mode`, and `payroll_mode` are refused.
+     *
+     * The family is written immediately. Pay periods rebuild
+     * asynchronously, so this answers `202` with the family as
+     * `GET` would return it (the version valid now). Future
+     * versions are on `/history`.
+     *
+     * Conditional: send the schedule's `ETag` as `If-Match`.
+     *
+     *
+     * **Required scope:**
+     *
+     * `timekeeping.pay_period_configs:update`
+     *
+     */
+    static updatePayPeriodConfig(options) {
+        return (options.client ?? client).patch({
+            security: [{ name: 'X-Api-Key', type: 'apiKey' }],
+            url: '/api/v1/timekeeping/pay_period_configs/{id}',
+            ...options,
+            headers: {
+                'Content-Type': 'application/json',
+                ...options.headers
+            }
+        });
+    }
 }
 export class Holidays {
     /**