@dsptch-work/api-client 0.20.0 → 0.21.0

package/dist/gen/types.gen.d.ts

@@ -24,7 +24,7 @@ export type Problem = {
     /**
      * An opaque URN identifying this one occurrence of the failure, carrying the request's id. Quote it when correlating a failure with support or your logs.
      */
-    instance?: string;
+    instance: string;
     /**
      * Optional nonempty validation entries. Each item gives a readable detail and, when the server can prove a public body location, a pointer to it. Clients must accept entries without a pointer.
      */
@@ -1318,7 +1318,7 @@ export type TimecodeResponseObject = {
     updated_at: string;
 };
 /**
- * An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid].
+ * An employment stint in the credential company. Its id is stable across valid-time versions; a rehire is a separate stint with a new id. A read returns only a version covering now or as_of[valid]. Company keys, company administrators, and the employed person receive direct monetary fields; those fields are omitted for company managers reading coworkers.
  */
 export type PeopleEmploymentResponseObject = {
     /**
@@ -1394,21 +1394,21 @@ export type PeopleEmploymentResponseObject = {
      */
     training_annual_minutes: number | null;
     /**
-     * Hourly pay in cents as a decimal string; null when unset.
+     * Hourly pay in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
      */
-    hourly_rate_cents: string | null;
+    hourly_rate_cents?: string | null;
     /**
-     * Annual training amount in cents as a decimal string; null when unset.
+     * Annual training amount in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
      */
-    training_annual_amount_cents: string | null;
+    training_annual_amount_cents?: string | null;
     /**
-     * Employer health amount in cents as a decimal string; null when unset.
+     * Employer health amount in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
      */
-    employer_combined_health_amount_cents: string | null;
+    employer_combined_health_amount_cents?: string | null;
     /**
-     * Employer savings amount in cents as a decimal string; null when unset.
+     * Employer savings amount in cents as a decimal string; present for company keys, company administrators, and the employed person, and null when authorized but unset.
      */
-    employer_combined_savings_cents: string | null;
+    employer_combined_savings_cents?: string | null;
     /**
      * Currency from the company's current pay schedule, or the system default when it has none. It is company configuration context rather than historical employment data.
      */
@@ -1452,10 +1452,10 @@ export type PeopleEmploymentHistoryCorrectionObject = {
     pto_annual_minutes: number | null;
     holiday_annual_minutes: number | null;
     training_annual_minutes: number | null;
-    hourly_rate_cents: string | null;
-    training_annual_amount_cents: string | null;
-    employer_combined_health_amount_cents: string | null;
-    employer_combined_savings_cents: string | null;
+    hourly_rate_cents?: string | null;
+    training_annual_amount_cents?: string | null;
+    employer_combined_health_amount_cents?: string | null;
+    employer_combined_savings_cents?: string | null;
     currency: string;
     valid_from: string | null;
     valid_to: string | null;
@@ -1484,10 +1484,10 @@ export type PeopleEmploymentHistoryVersionObject = {
     pto_annual_minutes: number | null;
     holiday_annual_minutes: number | null;
     training_annual_minutes: number | null;
-    hourly_rate_cents: string | null;
-    training_annual_amount_cents: string | null;
-    employer_combined_health_amount_cents: string | null;
-    employer_combined_savings_cents: string | null;
+    hourly_rate_cents?: string | null;
+    training_annual_amount_cents?: string | null;
+    employer_combined_health_amount_cents?: string | null;
+    employer_combined_savings_cents?: string | null;
     currency: string;
     valid_from: string | null;
     valid_to: string | null;
@@ -6705,6 +6705,10 @@ export type ProjectResponseObject = {
      * Identifier of the immediate parent project in the ancestry hierarchy, or null for a top-level project.
      */
     parent_id: string | null;
+    /**
+     * Identifiers of companies participating in this project.
+     */
+    participating_company_ids: Array<string>;
     /**
      * Federal PWA tracking mode: `all` (prevailing wage + apprenticeship), `pw_only` (prevailing wage), `ap_only` (apprenticeship), or `none`.
      */
@@ -6771,7 +6775,7 @@ export type ProjectResponseObject = {
     updated_at: string;
 };
 /**
- * Request body for creating a project. `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body.
+ * Request body for creating or updating a project. Only `name` is required by the schema; `created_by_user_id` is additionally required on create and must be a member of the owning company. The owning company is inferred from the API key and is not part of the body. Omit relationship fields on PATCH to leave them unchanged.
  */
 export type ProjectParameters = {
     /**
@@ -6790,6 +6794,14 @@ export type ProjectParameters = {
      * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
      */
     created_by_user_id: string;
+    /**
+     * ID of a project visible to the API key's policy. Send null to make the project a root; the child schedule must fit within the parent's schedule.
+     */
+    parent_id?: string | null;
+    /**
+     * Complete desired set of participating company IDs. Send an empty array to clear the set. Remove a participant's jobs before removing it from this set.
+     */
+    participating_company_ids?: Array<string>;
     /**
      * Schedule start date as an ISO8601 date (YYYY-MM-DD), or null; requires tz_name to be set.
      */
@@ -6871,6 +6883,14 @@ export type ProjectUpdateParameters = {
      * User recorded as the project's creator; must be a member of the owning company. Required on create and immutable thereafter — an update that sets, changes, or clears it is rejected.
      */
     created_by_user_id?: string | null;
+    /**
+     * ID of a project visible to the API key's policy. Send null to make the project a root; the child schedule must fit within the parent's schedule.
+     */
+    parent_id?: string | null;
+    /**
+     * Complete desired set of participating company IDs. Send an empty array to clear the set. Remove a participant's jobs before removing it from this set.
+     */
+    participating_company_ids?: Array<string>;
     /**
      * Schedule start date as an ISO8601 date (YYYY-MM-DD), or null; requires tz_name to be set.
      */
@@ -8129,6 +8149,10 @@ export type PositionResponseObject = {
      * ID of the worker assigned to fill this position; null when the position is unfilled.
      */
     fulfilled_by_user_id: string | null;
+    /**
+     * ID of the pay-rate rule package applied to this position, or null when none is set.
+     */
+    pay_rates_rule_package_id: string | null;
     position_function: PositionFunction;
     /**
      * Name of the per diem applied to this position; null when none is set.
@@ -8208,6 +8232,56 @@ export type PositionResponseObject = {
      */
     updated_at: string;
 };
+/**
+ * A company-owned collection of conditional wage and fringe adjustments, optionally scoped to a job.
+ */
+export type PayRatesRulePackageResponseObject = {
+    /**
+     * Unique identifier of the rule package.
+     */
+    id: string;
+    /**
+     * Human-readable package name.
+     */
+    name: string;
+    /**
+     * Free-form package description, or null.
+     */
+    description: string | null;
+    /**
+     * ID of the job this package is scoped to, or null for a company-wide package.
+     */
+    scoped_to_job_id: string | null;
+    /**
+     * Whether this is the default package within its company-wide or job scope.
+     */
+    default: boolean;
+    /**
+     * Whether users may select this package directly in configuration workflows.
+     */
+    selectable: boolean;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
+/**
+ * Parameters for creating a company-wide pay-rate rule package.
+ */
+export type PayRatesRulePackageParameters = {
+    /**
+     * Human-readable package name.
+     */
+    name: string;
+    /**
+     * Free-form package description; send null or omit it when no description is needed.
+     */
+    description?: string | null;
+};
 /**
  * A page of a job's positions, with pagination metadata and navigation links.
  */
@@ -9458,6 +9532,10 @@ export type FederalJobWageDeterminationResponseObject = {
      * ID of the overtime package whose rules apply to this determination, or null when none is set. Not a versioned attribute: every version of the determination carries the same package, so this reads the same whatever point in time you ask for. The rules inside the package carry their own valid times.
      */
     overtime_package_id: string | null;
+    /**
+     * ID of the pay-rate rule package attached to this determination family, or null when none is set. The attachment is shared by every temporal version of the determination.
+     */
+    pay_rates_rule_package_id: string | null;
     /**
      * Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
      */
@@ -9523,6 +9601,10 @@ export type RegionalJobWageDeterminationResponseObject = {
      * ID of the overtime package whose rules apply to this determination, or null when none is set. Not a versioned attribute: every version of the determination carries the same package, so this reads the same whatever point in time you ask for. The rules inside the package carry their own valid times.
      */
     overtime_package_id: string | null;
+    /**
+     * ID of the pay-rate rule package attached to this determination family, or null when none is set. The attachment is shared by every temporal version of the determination.
+     */
+    pay_rates_rule_package_id: string | null;
     /**
      * Determination type — the Federal or Regional subtype (an STI class name). Federal carries a DOL class code and construction category; Regional carries the nested regional_fields object.
      */
@@ -9574,6 +9656,7 @@ export type FederalJobWageDeterminationHistoryVersionObject = {
     job_id: string;
     pwa_trade_id: string;
     overtime_package_id: string | null;
+    pay_rates_rule_package_id: string | null;
     type: 'Pwa::JobWageDeterminations::Federal';
     labor_classification: string;
     hourly_rate_cents: string;
@@ -9596,6 +9679,7 @@ export type RegionalJobWageDeterminationHistoryVersionObject = {
     job_id: string;
     pwa_trade_id: string;
     overtime_package_id: string | null;
+    pay_rates_rule_package_id: string | null;
     type: 'Pwa::JobWageDeterminations::Regional';
     labor_classification: string;
     hourly_rate_cents: string;
@@ -9622,6 +9706,7 @@ export type FederalJobWageDeterminationHistoryCorrectionObject = {
     job_id: string;
     pwa_trade_id: string;
     overtime_package_id: string | null;
+    pay_rates_rule_package_id: string | null;
     type: 'Pwa::JobWageDeterminations::Federal';
     labor_classification: string;
     hourly_rate_cents: string;
@@ -9642,6 +9727,7 @@ export type RegionalJobWageDeterminationHistoryCorrectionObject = {
     job_id: string;
     pwa_trade_id: string;
     overtime_package_id: string | null;
+    pay_rates_rule_package_id: string | null;
     type: 'Pwa::JobWageDeterminations::Regional';
     labor_classification: string;
     hourly_rate_cents: string;
@@ -9772,6 +9858,10 @@ export type FederalJobWageDeterminationParameters = {
      * The DOL general wage determination the rates are drawn from — the general decision number plus its revision (e.g. "CA20230001/5"); null when not recorded.
      */
     general_wage_determination?: string | null;
+    /**
+     * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
+     */
+    pay_rates_rule_package_id?: string | null;
 };
 /**
  * Parameters for creating a Regional (state prevailing-wage) wage determination on a job.
@@ -9805,6 +9895,10 @@ export type RegionalJobWageDeterminationParameters = {
      * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
      */
     overtime_package_id?: string | null;
+    /**
+     * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
+     */
+    pay_rates_rule_package_id?: string | null;
     regional_fields?: RegionalWageDeterminationFields;
 };
 /**
@@ -9819,6 +9913,10 @@ export type JobWageDeterminationUpdateParameters = {
      * Overtime package whose rules govern overtime on work under this determination. This is not a versioned attribute: setting it points every version at that package, not only the one this request writes, and `effective_from` does not date it. Send null to detach, leaving the determination with no overtime package of its own. Omit the key to leave the current attachment alone. A package belonging to another company is refused, and a Federal determination refuses one outright — only a Regional determination carries overtime rules.
      */
     overtime_package_id?: string | null;
+    /**
+     * Pay-rate rule package attached to the whole determination family. On create, omit it or send null to leave the family unattached. On update, send null to detach it or omit the key to keep the current attachment. A package belonging to another company is refused.
+     */
+    pay_rates_rule_package_id?: string | null;
     /**
      * Human-readable labor classification — the craft or trade this determination sets rates for; the display label, distinct from the machine class code.
      */
@@ -10084,6 +10182,134 @@ export type RateRuleHistoryVersionObject = {
     version_status: 'scheduled' | 'current' | 'historical';
     corrections: Array<RateRuleHistoryCorrectionObject>;
 };
+/**
+ * A conditional wage or fringe adjustment owned by a pay-rate rule package, with the selected version's valid-time window.
+ */
+export type PayRatesRuleResponseObject = {
+    /**
+     * Identity shared by every valid-time version of the rule; the member and history paths address the family with this value.
+     */
+    id: string;
+    /**
+     * ID of the pay-rate rule package that owns this rule.
+     */
+    pay_rates_rule_package_id: string;
+    /**
+     * ISO 4217 currency code for effect.amount_cents, inherited from the package's company.
+     */
+    currency: string;
+    effect: RateRuleEffect;
+    /**
+     * Conditions that decide when the effect applies. An empty list means the rule always applies.
+     */
+    conditions: Array<RateRuleCondition>;
+    /**
+     * Valid time — when this version begins applying (ISO 8601); null for an unbounded lower bound.
+     */
+    valid_from: string | null;
+    /**
+     * Valid time — the exclusive end when this version stops applying (ISO 8601); null for an open-ended upper bound.
+     */
+    valid_to: string | null;
+    /**
+     * When the record was created (ISO 8601).
+     */
+    created_at: string;
+    /**
+     * When the record was last updated (ISO 8601).
+     */
+    updated_at: string;
+};
+/**
+ * Parameters for creating a conditional wage or fringe adjustment in a pay-rate rule package.
+ */
+export type PayRatesRuleParameters = {
+    effect: RateRuleEffect;
+    /**
+     * Match conditions for the rule. Omit or send an empty list for an unconditional rule.
+     */
+    conditions?: Array<RateRuleCondition>;
+    /**
+     * Calendar date when the rule begins in the package company's timezone; defaults to today there.
+     */
+    effective_date?: string;
+};
+/**
+ * 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. An empty conditions list makes the rule unconditional. Omit effective_from to correct the selected version from its exact existing start. A rule with an unbounded lower limit requires effective_from.
+ */
+export type PayRatesRuleUpdateParameters = {
+    effect?: RateRuleEffect;
+    /**
+     * Replacement match conditions. Omit this field to keep the targeted version's conditions; send an empty list to make the rule unconditional.
+     */
+    conditions?: Array<RateRuleCondition>;
+    /**
+     * Date the change begins, YYYY-MM-DD. Omit it to correct the selected version from its exact existing start. Required when that version has no lower bound.
+     */
+    effective_from?: string;
+};
+/**
+ * Parameters for moving where a pay-rate rule family's valid-time timeline begins.
+ */
+export type PayRatesRuleGenesisParameters = {
+    /**
+     * The timeline's new start as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. Moving it earlier extends the first version back to it. Moving it later removes coverage before it. Refused with `422` when the new start would fall at or after a standing termination.
+     */
+    effective_date: string;
+};
+/**
+ * Parameters for scheduling when a pay-rate rule family stops being valid.
+ */
+export type PayRatesRuleScheduledTerminationParameters = {
+    /**
+     * The exclusive end of the family's valid-time timeline as a calendar date (`YYYY-MM-DD`); a value carrying a time component is refused with `422` rather than truncated. Must fall after genesis. Scheduling removes versions that start after the new end and truncates the version spanning it. A family holds at most one standing termination; cancel it before scheduling another. Cancellation reopens the last surviving version with its existing recipe and does not restore removed versions.
+     */
+    effective_date: string;
+};
+/**
+ * Schedule a rule recipe change from a company-local effective date.
+ */
+export type PayRatesRuleScheduledChangeParameters = {
+    /**
+     * Date the change begins, YYYY-MM-DD.
+     */
+    effective_date: string;
+    effect?: RateRuleEffect;
+    /**
+     * Replacement match conditions. Omit this field to keep the targeted version's conditions; send an empty list to make the rule unconditional.
+     */
+    conditions?: Array<RateRuleCondition>;
+};
+export type PayRatesRuleHistoryCorrectionObject = {
+    /**
+     * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
+     */
+    pay_rates_rule_id: string;
+    pay_rates_rule_package_id: string;
+    currency: string;
+    effect: RateRuleEffect;
+    conditions: Array<RateRuleCondition>;
+    valid_from: string | null;
+    valid_to: string | null;
+    created_at: string;
+    updated_at: string;
+};
+export type PayRatesRuleHistoryVersionObject = {
+    /**
+     * Family key shared by every entry on this timeline — the same identity the member route addresses. An entry carries no identifier of its own; versions are distinguished by their window coordinates.
+     */
+    pay_rates_rule_id: string;
+    pay_rates_rule_package_id: string;
+    currency: string;
+    effect: RateRuleEffect;
+    conditions: Array<RateRuleCondition>;
+    valid_from: string | null;
+    valid_to: string | null;
+    created_at: string;
+    updated_at: string;
+    version_status: 'scheduled' | 'current' | 'historical';
+    corrections: Array<PayRatesRuleHistoryCorrectionObject>;
+};
 /**
  * An overtime rule (daily or weekly) belonging to an overtime package. It sets a pay multiplier that applies once a worked-hours threshold — and any day or date qualifier — is met. `valid_from`/`valid_to` bound the window this version is in effect.
  */
@@ -17701,6 +17927,10 @@ export type CreateWageDeterminationData = {
     url: '/api/v1/jobs/{job_id}/wage_determinations';
 };
 export type CreateWageDeterminationErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
     /**
      * Forbidden
      */
@@ -18663,30 +18893,70 @@ export type UpdateOvertimeRuleResponses = {
     200: OvertimeRuleResponseObject;
 };
 export type UpdateOvertimeRuleResponse = UpdateOvertimeRuleResponses[keyof UpdateOvertimeRuleResponses];
-export type ListAggregateTimeImportsData = {
-    body?: never;
+export type ShiftPayRateRuleGenesisData = {
+    body: PayRatesRuleGenesisParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
+         */
+        'If-Match': string;
+    };
     path: {
-        pay_period_id: string;
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        rule_id: string;
     };
-    query?: {
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/genesis';
+};
+export type ShiftPayRateRuleGenesisErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type ShiftPayRateRuleGenesisError = ShiftPayRateRuleGenesisErrors[keyof ShiftPayRateRuleGenesisErrors];
+export type ShiftPayRateRuleGenesisResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRuleResponseObject;
+};
+export type ShiftPayRateRuleGenesisResponse = ShiftPayRateRuleGenesisResponses[keyof ShiftPayRateRuleGenesisResponses];
+export type ListPayRateRuleHistoryData = {
+    body?: never;
+    path: {
+        rule_package_id: string;
         /**
-         * Filter by import status:
-         * * `pending`
-         * * `processing`
-         * * `processed`
-         * * `success`
-         * * `failed`
-         *
+         * The rule's version-stable identity, as returned in `id`.
          */
-        'filter[status]'?: string;
-        filter?: string;
-        'filter[unexpected]'?: string;
-        'filter[completed_at][gte]'?: string;
-        'filter[completed_at][lte]'?: string;
-        'filter[created_at][gte]'?: string;
-        'filter[created_at][lte]'?: string;
-        'filter[updated_at][gte]'?: string;
-        'filter[updated_at][lte]'?: string;
+        rule_id: string;
+    };
+    query?: {
+        'as_of[valid]'?: string;
+        'as_of[transaction]'?: string;
         /**
          * This pagination cursor corresponds to the cursor value found in the response in
          * `meta.page.next_cursor`.
@@ -18698,9 +18968,9 @@ export type ListAggregateTimeImportsData = {
         'page[limit]'?: number;
         page?: string;
     };
-    url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times';
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/history';
 };
-export type ListAggregateTimeImportsErrors = {
+export type ListPayRateRuleHistoryErrors = {
     /**
      * Bad Request
      */
@@ -18710,27 +18980,688 @@ export type ListAggregateTimeImportsErrors = {
      */
     403: Problem;
     /**
-     * Unprocessable Content
+     * Not Found
      */
-    422: Problem;
+    404: Problem;
 };
-export type ListAggregateTimeImportsError = ListAggregateTimeImportsErrors[keyof ListAggregateTimeImportsErrors];
-export type ListAggregateTimeImportsResponses = {
+export type ListPayRateRuleHistoryError = ListPayRateRuleHistoryErrors[keyof ListPayRateRuleHistoryErrors];
+export type ListPayRateRuleHistoryResponses = {
     /**
      * Success
      */
     200: {
         meta: Meta;
         links: Links;
-        data: Array<AggregateTimeImportResponseObject>;
+        data: Array<PayRatesRuleHistoryVersionObject>;
     };
 };
-export type ListAggregateTimeImportsResponse = ListAggregateTimeImportsResponses[keyof ListAggregateTimeImportsResponses];
-export type CreateAggregateTimeImportData = {
-    body: AggregateTimeImportParameters;
-    path: {
-        pay_period_id: string;
-    };
+export type ListPayRateRuleHistoryResponse = ListPayRateRuleHistoryResponses[keyof ListPayRateRuleHistoryResponses];
+export type CancelPayRateRuleScheduledChangesData = {
+    body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against.
+         */
+        'If-Match': string;
+    };
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        rule_id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes';
+};
+export type CancelPayRateRuleScheduledChangesErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type CancelPayRateRuleScheduledChangesError = CancelPayRateRuleScheduledChangesErrors[keyof CancelPayRateRuleScheduledChangesErrors];
+export type CancelPayRateRuleScheduledChangesResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRuleResponseObject;
+};
+export type CancelPayRateRuleScheduledChangesResponse = CancelPayRateRuleScheduledChangesResponses[keyof CancelPayRateRuleScheduledChangesResponses];
+export type ListPayRateRuleScheduledChangesData = {
+    body?: never;
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        rule_id: string;
+    };
+    query?: {
+        'as_of[valid]'?: string;
+        'as_of[transaction]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes';
+};
+export type ListPayRateRuleScheduledChangesErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type ListPayRateRuleScheduledChangesError = ListPayRateRuleScheduledChangesErrors[keyof ListPayRateRuleScheduledChangesErrors];
+export type ListPayRateRuleScheduledChangesResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<PayRatesRuleHistoryVersionObject>;
+    };
+};
+export type ListPayRateRuleScheduledChangesResponse = ListPayRateRuleScheduledChangesResponses[keyof ListPayRateRuleScheduledChangesResponses];
+export type SchedulePayRateRuleChangeData = {
+    body: PayRatesRuleScheduledChangeParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against.
+         */
+        'If-Match': string;
+    };
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        rule_id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_changes';
+};
+export type SchedulePayRateRuleChangeErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type SchedulePayRateRuleChangeError = SchedulePayRateRuleChangeErrors[keyof SchedulePayRateRuleChangeErrors];
+export type SchedulePayRateRuleChangeResponses = {
+    /**
+     * Success without a new segment
+     */
+    200: PayRatesRuleResponseObject;
+    /**
+     * Created
+     */
+    201: PayRatesRuleResponseObject;
+};
+export type SchedulePayRateRuleChangeResponse = SchedulePayRateRuleChangeResponses[keyof SchedulePayRateRuleChangeResponses];
+export type CancelPayRateRuleScheduledTerminationData = {
+    body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
+         */
+        'If-Match': string;
+    };
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        rule_id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_termination';
+};
+export type CancelPayRateRuleScheduledTerminationErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type CancelPayRateRuleScheduledTerminationError = CancelPayRateRuleScheduledTerminationErrors[keyof CancelPayRateRuleScheduledTerminationErrors];
+export type CancelPayRateRuleScheduledTerminationResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRuleResponseObject;
+};
+export type CancelPayRateRuleScheduledTerminationResponse = CancelPayRateRuleScheduledTerminationResponses[keyof CancelPayRateRuleScheduledTerminationResponses];
+export type SchedulePayRateRuleTerminationData = {
+    body: PayRatesRuleScheduledTerminationParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
+         */
+        'If-Match': string;
+    };
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        rule_id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{rule_id}/scheduled_termination';
+};
+export type SchedulePayRateRuleTerminationErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Conflict
+     */
+    409: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type SchedulePayRateRuleTerminationError = SchedulePayRateRuleTerminationErrors[keyof SchedulePayRateRuleTerminationErrors];
+export type SchedulePayRateRuleTerminationResponses = {
+    /**
+     * Created
+     */
+    201: PayRatesRuleResponseObject;
+};
+export type SchedulePayRateRuleTerminationResponse = SchedulePayRateRuleTerminationResponses[keyof SchedulePayRateRuleTerminationResponses];
+export type ListPayRateRulesData = {
+    body?: never;
+    path: {
+        rule_package_id: string;
+    };
+    query?: {
+        /**
+         * Read the version valid at this point in time. Defaults to now.
+         */
+        'as_of[valid]'?: string;
+        as_of?: string;
+        'as_of[bogus_axis]'?: string;
+        'as_of[valid][gte]'?: string;
+        'as_of[transaction]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules';
+};
+export type ListPayRateRulesErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListPayRateRulesError = ListPayRateRulesErrors[keyof ListPayRateRulesErrors];
+export type ListPayRateRulesResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<PayRatesRuleResponseObject>;
+    };
+};
+export type ListPayRateRulesResponse = ListPayRateRulesResponses[keyof ListPayRateRulesResponses];
+export type CreatePayRateRuleData = {
+    body: PayRatesRuleParameters;
+    path: {
+        rule_package_id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules';
+};
+export type CreatePayRateRuleErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreatePayRateRuleError = CreatePayRateRuleErrors[keyof CreatePayRateRuleErrors];
+export type CreatePayRateRuleResponses = {
+    /**
+     * Created
+     */
+    201: PayRatesRuleResponseObject;
+};
+export type CreatePayRateRuleResponse = CreatePayRateRuleResponses[keyof CreatePayRateRuleResponses];
+export type DeletePayRateRuleData = {
+    body?: never;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
+         */
+        'If-Match': string;
+    };
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}';
+};
+export type DeletePayRateRuleErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type DeletePayRateRuleError = DeletePayRateRuleErrors[keyof DeletePayRateRuleErrors];
+export type DeletePayRateRuleResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRuleResponseObject;
+};
+export type DeletePayRateRuleResponse = DeletePayRateRuleResponses[keyof DeletePayRateRuleResponses];
+export type GetPayRateRuleData = {
+    body?: never;
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        id: string;
+    };
+    query?: {
+        /**
+         * Read the version valid at this point in time. Defaults to now.
+         */
+        'as_of[valid]'?: string;
+    };
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}';
+};
+export type GetPayRateRuleErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type GetPayRateRuleError = GetPayRateRuleErrors[keyof GetPayRateRuleErrors];
+export type GetPayRateRuleResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRuleResponseObject;
+};
+export type GetPayRateRuleResponse = GetPayRateRuleResponses[keyof GetPayRateRuleResponses];
+export type UpdatePayRateRuleData = {
+    body: PayRatesRuleUpdateParameters;
+    headers: {
+        /**
+         * Version validator this write is composed against — the `ETag` from a read of this rule, or `*` to write against whatever exists.
+         */
+        'If-Match': string;
+    };
+    path: {
+        rule_package_id: string;
+        /**
+         * The rule's version-stable identity.
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{rule_package_id}/rules/{id}';
+};
+export type UpdatePayRateRuleErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Precondition Failed
+     */
+    412: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+    /**
+     * Precondition Required
+     */
+    428: Problem;
+};
+export type UpdatePayRateRuleError = UpdatePayRateRuleErrors[keyof UpdatePayRateRuleErrors];
+export type UpdatePayRateRuleResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRuleResponseObject;
+};
+export type UpdatePayRateRuleResponse = UpdatePayRateRuleResponses[keyof UpdatePayRateRuleResponses];
+export type ListPayRateRulePackagesData = {
+    body?: never;
+    path?: never;
+    query?: {
+        /**
+         * Return packages scoped to this job.
+         */
+        'filter[scoped_to_job_id]'?: string;
+        /**
+         * Set to `true` to return company-wide packages without a job scope.
+         */
+        'filter[scoped_to_job_id][null]'?: boolean;
+        /**
+         * Filter by whether the package is the default for its scope.
+         */
+        'filter[default]'?: boolean;
+        /**
+         * Filter by whether users can select the package.
+         */
+        'filter[selectable]'?: boolean;
+        'filter[created_at][gte]'?: string;
+        'filter[created_at][lte]'?: string;
+        'filter[updated_at][gte]'?: string;
+        'filter[updated_at][lte]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/pay/rates/rule_packages';
+};
+export type ListPayRateRulePackagesErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListPayRateRulePackagesError = ListPayRateRulePackagesErrors[keyof ListPayRateRulePackagesErrors];
+export type ListPayRateRulePackagesResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<PayRatesRulePackageResponseObject>;
+    };
+};
+export type ListPayRateRulePackagesResponse = ListPayRateRulePackagesResponses[keyof ListPayRateRulePackagesResponses];
+export type CreatePayRateRulePackageData = {
+    body: PayRatesRulePackageParameters;
+    path?: never;
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages';
+};
+export type CreatePayRateRulePackageErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type CreatePayRateRulePackageError = CreatePayRateRulePackageErrors[keyof CreatePayRateRulePackageErrors];
+export type CreatePayRateRulePackageResponses = {
+    /**
+     * Created
+     */
+    201: PayRatesRulePackageResponseObject;
+};
+export type CreatePayRateRulePackageResponse = CreatePayRateRulePackageResponses[keyof CreatePayRateRulePackageResponses];
+export type GetPayRateRulePackageData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{id}';
+};
+export type GetPayRateRulePackageErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetPayRateRulePackageError = GetPayRateRulePackageErrors[keyof GetPayRateRulePackageErrors];
+export type GetPayRateRulePackageResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRulePackageResponseObject;
+};
+export type GetPayRateRulePackageResponse = GetPayRateRulePackageResponses[keyof GetPayRateRulePackageResponses];
+export type ListAggregateTimeImportsData = {
+    body?: never;
+    path: {
+        pay_period_id: string;
+    };
+    query?: {
+        /**
+         * Filter by import status:
+         * * `pending`
+         * * `processing`
+         * * `processed`
+         * * `success`
+         * * `failed`
+         *
+         */
+        'filter[status]'?: string;
+        filter?: string;
+        'filter[unexpected]'?: string;
+        'filter[completed_at][gte]'?: string;
+        'filter[completed_at][lte]'?: string;
+        'filter[created_at][gte]'?: string;
+        'filter[created_at][lte]'?: string;
+        'filter[updated_at][gte]'?: string;
+        'filter[updated_at][lte]'?: string;
+        /**
+         * This pagination cursor corresponds to the cursor value found in the response in
+         * `meta.page.next_cursor`.
+         */
+        'page[cursor]'?: string;
+        /**
+         * Maximum number of records to return per page. Defaults to 20. A value above 100 is capped to 100 rather than rejected; a value that is zero, negative, or not an integer is rejected with a `400`.
+         */
+        'page[limit]'?: number;
+        page?: string;
+    };
+    url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times';
+};
+export type ListAggregateTimeImportsErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type ListAggregateTimeImportsError = ListAggregateTimeImportsErrors[keyof ListAggregateTimeImportsErrors];
+export type ListAggregateTimeImportsResponses = {
+    /**
+     * Success
+     */
+    200: {
+        meta: Meta;
+        links: Links;
+        data: Array<AggregateTimeImportResponseObject>;
+    };
+};
+export type ListAggregateTimeImportsResponse = ListAggregateTimeImportsResponses[keyof ListAggregateTimeImportsResponses];
+export type CreateAggregateTimeImportData = {
+    body: AggregateTimeImportParameters;
+    path: {
+        pay_period_id: string;
+    };
     query?: never;
     url: '/api/v1/pay_periods/{pay_period_id}/imports/aggregate_times';
 };
@@ -20867,6 +21798,10 @@ export type CreateProjectErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */