@dsptch-work/api-client 0.20.0 → 0.21.0

package/dist/gen/zod.gen.js

@@ -8,7 +8,7 @@ export const zProblem = z.object({
     title: z.string(),
     status: z.int(),
     detail: z.string(),
-    instance: z.url().optional(),
+    instance: z.url(),
     errors: z.array(z.object({
         detail: z.string(),
         pointer: z.string().optional()
@@ -863,7 +863,7 @@ export const zTimecodeResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * 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 const zPeopleEmploymentResponseObject = z.object({
     id: z.string(),
@@ -884,10 +884,10 @@ export const zPeopleEmploymentResponseObject = z.object({
     pto_annual_minutes: z.int().nullable(),
     holiday_annual_minutes: z.int().nullable(),
     training_annual_minutes: z.int().nullable(),
-    hourly_rate_cents: z.string().nullable(),
-    training_annual_amount_cents: z.string().nullable(),
-    employer_combined_health_amount_cents: z.string().nullable(),
-    employer_combined_savings_cents: z.string().nullable(),
+    hourly_rate_cents: z.string().nullish(),
+    training_annual_amount_cents: z.string().nullish(),
+    employer_combined_health_amount_cents: z.string().nullish(),
+    employer_combined_savings_cents: z.string().nullish(),
     currency: z.string(),
     valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
@@ -913,10 +913,10 @@ export const zPeopleEmploymentHistoryCorrectionObject = z.object({
     pto_annual_minutes: z.int().nullable(),
     holiday_annual_minutes: z.int().nullable(),
     training_annual_minutes: z.int().nullable(),
-    hourly_rate_cents: z.string().nullable(),
-    training_annual_amount_cents: z.string().nullable(),
-    employer_combined_health_amount_cents: z.string().nullable(),
-    employer_combined_savings_cents: z.string().nullable(),
+    hourly_rate_cents: z.string().nullish(),
+    training_annual_amount_cents: z.string().nullish(),
+    employer_combined_health_amount_cents: z.string().nullish(),
+    employer_combined_savings_cents: z.string().nullish(),
     currency: z.string(),
     valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
@@ -942,10 +942,10 @@ export const zPeopleEmploymentHistoryVersionObject = z.object({
     pto_annual_minutes: z.int().nullable(),
     holiday_annual_minutes: z.int().nullable(),
     training_annual_minutes: z.int().nullable(),
-    hourly_rate_cents: z.string().nullable(),
-    training_annual_amount_cents: z.string().nullable(),
-    employer_combined_health_amount_cents: z.string().nullable(),
-    employer_combined_savings_cents: z.string().nullable(),
+    hourly_rate_cents: z.string().nullish(),
+    training_annual_amount_cents: z.string().nullish(),
+    employer_combined_health_amount_cents: z.string().nullish(),
+    employer_combined_savings_cents: z.string().nullish(),
     currency: z.string(),
     valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
@@ -3059,6 +3059,7 @@ export const zProjectResponseObject = z.object({
     owned_by_company_id: z.string(),
     created_by_user_id: z.string().nullable(),
     parent_id: z.string().nullable(),
+    participating_company_ids: z.array(z.string()),
     federal_pwa_mode: z.enum([
         'all',
         'pw_only',
@@ -3087,13 +3088,15 @@ export const zProjectResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * 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 const zProjectParameters = z.object({
     external_id: z.string().nullish(),
     name: z.string(),
     description: z.string().nullish(),
     created_by_user_id: z.string(),
+    parent_id: z.string().nullish(),
+    participating_company_ids: z.array(z.string()).optional(),
     start_date: z.iso.date().nullish(),
     end_date: z.iso.date().nullish(),
     tz_name: z.string().nullish(),
@@ -3128,6 +3131,8 @@ export const zProjectUpdateParameters = z.object({
     name: z.string().optional(),
     description: z.string().nullish(),
     created_by_user_id: z.string().nullish(),
+    parent_id: z.string().nullish(),
+    participating_company_ids: z.array(z.string()).optional(),
     start_date: z.iso.date().nullish(),
     end_date: z.iso.date().nullish(),
     tz_name: z.string().nullish(),
@@ -3862,6 +3867,26 @@ export const zPaystubLineItemUpdateParameters = z.object({
     contributor: z.enum(['employee', 'employer']).optional(),
     payrolls_external_map_id: z.string().optional()
 });
+/**
+ * A company-owned collection of conditional wage and fringe adjustments, optionally scoped to a job.
+ */
+export const zPayRatesRulePackageResponseObject = z.object({
+    id: z.string(),
+    name: z.string(),
+    description: z.string().nullable(),
+    scoped_to_job_id: z.string().nullable(),
+    default: z.boolean(),
+    selectable: z.boolean(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * Parameters for creating a company-wide pay-rate rule package.
+ */
+export const zPayRatesRulePackageParameters = z.object({
+    name: z.string().min(1),
+    description: z.string().nullish()
+});
 /**
  * Request body for creating or updating a position on a job. The job is taken from the URL path.
  */
@@ -4233,6 +4258,7 @@ export const zPositionResponseObject = z.object({
     id: z.string(),
     job_id: z.string(),
     fulfilled_by_user_id: z.string().nullable(),
+    pay_rates_rule_package_id: z.string().nullable(),
     position_function: zPositionFunction,
     per_diem_name: z.string().nullable(),
     per_diem_currency: z.string().nullable(),
@@ -4914,6 +4940,7 @@ export const zFederalJobWageDeterminationResponseObject = z.object({
     job_id: z.string(),
     pwa_trade_id: z.string(),
     overtime_package_id: z.string().nullable(),
+    pay_rates_rule_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Federal']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -4936,6 +4963,7 @@ export const zFederalJobWageDeterminationHistoryCorrectionObject = z.object({
     job_id: z.string(),
     pwa_trade_id: z.string(),
     overtime_package_id: z.string().nullable(),
+    pay_rates_rule_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Federal']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -5007,6 +5035,7 @@ export const zRegionalJobWageDeterminationResponseObject = z.object({
     job_id: z.string(),
     pwa_trade_id: z.string(),
     overtime_package_id: z.string().nullable(),
+    pay_rates_rule_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Regional']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -5030,6 +5059,7 @@ export const zRegionalJobWageDeterminationHistoryCorrectionObject = z.object({
     job_id: z.string(),
     pwa_trade_id: z.string(),
     overtime_package_id: z.string().nullable(),
+    pay_rates_rule_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Regional']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -5050,6 +5080,7 @@ export const zFederalJobWageDeterminationHistoryVersionObject = z.object({
     job_id: z.string(),
     pwa_trade_id: z.string(),
     overtime_package_id: z.string().nullable(),
+    pay_rates_rule_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Federal']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -5078,6 +5109,7 @@ export const zRegionalJobWageDeterminationHistoryVersionObject = z.object({
     job_id: z.string(),
     pwa_trade_id: z.string(),
     overtime_package_id: z.string().nullable(),
+    pay_rates_rule_package_id: z.string().nullable(),
     type: z.enum(['Pwa::JobWageDeterminations::Regional']),
     labor_classification: z.string(),
     hourly_rate_cents: z.string(),
@@ -5115,7 +5147,8 @@ export const zFederalJobWageDeterminationParameters = z.object({
         'highway',
         'residential'
     ]).nullish(),
-    general_wage_determination: z.string().nullish()
+    general_wage_determination: z.string().nullish(),
+    pay_rates_rule_package_id: z.string().nullish()
 });
 /**
  * Parameters for creating a Regional (state prevailing-wage) wage determination on a job.
@@ -5128,6 +5161,7 @@ export const zRegionalJobWageDeterminationParameters = z.object({
     fringe_rate_cents: z.string().optional(),
     general_wage_determination: z.string().nullish(),
     overtime_package_id: z.string().nullish(),
+    pay_rates_rule_package_id: z.string().nullish(),
     regional_fields: zRegionalWageDeterminationFields.optional()
 });
 /**
@@ -5143,6 +5177,7 @@ export const zJobWageDeterminationParameters = z.discriminatedUnion('type', [
 export const zJobWageDeterminationUpdateParameters = z.object({
     effective_from: z.iso.date().optional(),
     overtime_package_id: z.string().nullish(),
+    pay_rates_rule_package_id: z.string().nullish(),
     labor_classification: z.string().optional(),
     pwa_trade_id: z.string().optional(),
     hourly_rate_cents: z.string().optional(),
@@ -5291,6 +5326,84 @@ export const zRateRuleHistoryVersionObject = z.object({
     ]),
     corrections: z.array(zRateRuleHistoryCorrectionObject)
 });
+/**
+ * A conditional wage or fringe adjustment owned by a pay-rate rule package, with the selected version's valid-time window.
+ */
+export const zPayRatesRuleResponseObject = z.object({
+    id: z.string(),
+    pay_rates_rule_package_id: z.string(),
+    currency: z.string(),
+    effect: zRateRuleEffect,
+    conditions: z.array(zRateRuleCondition),
+    valid_from: z.iso.datetime().nullable(),
+    valid_to: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * Parameters for creating a conditional wage or fringe adjustment in a pay-rate rule package.
+ */
+export const zPayRatesRuleParameters = z.object({
+    effect: zRateRuleEffect,
+    conditions: z.array(zRateRuleCondition).optional(),
+    effective_date: z.iso.date().optional()
+});
+/**
+ * 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 const zPayRatesRuleUpdateParameters = z.object({
+    effect: zRateRuleEffect.optional(),
+    conditions: z.array(zRateRuleCondition).optional(),
+    effective_from: z.iso.date().optional()
+});
+/**
+ * Parameters for moving where a pay-rate rule family's valid-time timeline begins.
+ */
+export const zPayRatesRuleGenesisParameters = z.object({
+    effective_date: z.iso.date()
+});
+/**
+ * Parameters for scheduling when a pay-rate rule family stops being valid.
+ */
+export const zPayRatesRuleScheduledTerminationParameters = z.object({
+    effective_date: z.iso.date()
+});
+/**
+ * Schedule a rule recipe change from a company-local effective date.
+ */
+export const zPayRatesRuleScheduledChangeParameters = z.object({
+    effective_date: z.iso.date(),
+    effect: zRateRuleEffect.optional(),
+    conditions: z.array(zRateRuleCondition).optional()
+});
+export const zPayRatesRuleHistoryCorrectionObject = z.object({
+    pay_rates_rule_id: z.string(),
+    pay_rates_rule_package_id: z.string(),
+    currency: z.string(),
+    effect: zRateRuleEffect,
+    conditions: z.array(zRateRuleCondition),
+    valid_from: z.iso.datetime().nullable(),
+    valid_to: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+export const zPayRatesRuleHistoryVersionObject = z.object({
+    pay_rates_rule_id: z.string(),
+    pay_rates_rule_package_id: z.string(),
+    currency: z.string(),
+    effect: zRateRuleEffect,
+    conditions: z.array(zRateRuleCondition),
+    valid_from: z.iso.datetime().nullable(),
+    valid_to: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime(),
+    version_status: z.enum([
+        'scheduled',
+        'current',
+        'historical'
+    ]),
+    corrections: z.array(zPayRatesRuleHistoryCorrectionObject)
+});
 /**
  * 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.
  */
@@ -8465,6 +8578,202 @@ export const zUpdateOvertimeRulePath = z.object({
  * Success
  */
 export const zUpdateOvertimeRuleResponse = zOvertimeRuleResponseObject;
+export const zShiftPayRateRuleGenesisBody = zPayRatesRuleGenesisParameters;
+export const zShiftPayRateRuleGenesisHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zShiftPayRateRuleGenesisPath = z.object({
+    rule_package_id: z.string(),
+    rule_id: z.string()
+});
+/**
+ * Success
+ */
+export const zShiftPayRateRuleGenesisResponse = zPayRatesRuleResponseObject;
+export const zListPayRateRuleHistoryPath = z.object({
+    rule_package_id: z.string(),
+    rule_id: z.string()
+});
+export const zListPayRateRuleHistoryQuery = z.object({
+    'as_of[valid]': z.string().optional(),
+    'as_of[transaction]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListPayRateRuleHistoryResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zPayRatesRuleHistoryVersionObject)
+});
+export const zCancelPayRateRuleScheduledChangesHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCancelPayRateRuleScheduledChangesPath = z.object({
+    rule_package_id: z.string(),
+    rule_id: z.string()
+});
+/**
+ * Success
+ */
+export const zCancelPayRateRuleScheduledChangesResponse = zPayRatesRuleResponseObject;
+export const zListPayRateRuleScheduledChangesPath = z.object({
+    rule_package_id: z.string(),
+    rule_id: z.string()
+});
+export const zListPayRateRuleScheduledChangesQuery = z.object({
+    'as_of[valid]': z.string().optional(),
+    'as_of[transaction]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListPayRateRuleScheduledChangesResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zPayRatesRuleHistoryVersionObject)
+});
+export const zSchedulePayRateRuleChangeBody = zPayRatesRuleScheduledChangeParameters;
+export const zSchedulePayRateRuleChangeHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zSchedulePayRateRuleChangePath = z.object({
+    rule_package_id: z.string(),
+    rule_id: z.string()
+});
+/**
+ * Success without a new segment
+ */
+export const zSchedulePayRateRuleChangeResponse = zPayRatesRuleResponseObject;
+export const zCancelPayRateRuleScheduledTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCancelPayRateRuleScheduledTerminationPath = z.object({
+    rule_package_id: z.string(),
+    rule_id: z.string()
+});
+/**
+ * Success
+ */
+export const zCancelPayRateRuleScheduledTerminationResponse = zPayRatesRuleResponseObject;
+export const zSchedulePayRateRuleTerminationBody = zPayRatesRuleScheduledTerminationParameters;
+export const zSchedulePayRateRuleTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zSchedulePayRateRuleTerminationPath = z.object({
+    rule_package_id: z.string(),
+    rule_id: z.string()
+});
+/**
+ * Created
+ */
+export const zSchedulePayRateRuleTerminationResponse = zPayRatesRuleResponseObject;
+export const zListPayRateRulesPath = z.object({
+    rule_package_id: z.string()
+});
+export const zListPayRateRulesQuery = z.object({
+    'as_of[valid]': z.iso.datetime().optional(),
+    as_of: z.string().optional(),
+    'as_of[bogus_axis]': z.string().optional(),
+    'as_of[valid][gte]': z.string().optional(),
+    'as_of[transaction]': z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListPayRateRulesResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zPayRatesRuleResponseObject)
+});
+export const zCreatePayRateRuleBody = zPayRatesRuleParameters;
+export const zCreatePayRateRulePath = z.object({
+    rule_package_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreatePayRateRuleResponse = zPayRatesRuleResponseObject;
+export const zDeletePayRateRuleHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zDeletePayRateRulePath = z.object({
+    rule_package_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zDeletePayRateRuleResponse = zPayRatesRuleResponseObject;
+export const zGetPayRateRulePath = z.object({
+    rule_package_id: z.string(),
+    id: z.string()
+});
+export const zGetPayRateRuleQuery = z.object({
+    'as_of[valid]': z.iso.datetime().optional()
+});
+/**
+ * Success
+ */
+export const zGetPayRateRuleResponse = zPayRatesRuleResponseObject;
+export const zUpdatePayRateRuleBody = zPayRatesRuleUpdateParameters;
+export const zUpdatePayRateRuleHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zUpdatePayRateRulePath = z.object({
+    rule_package_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdatePayRateRuleResponse = zPayRatesRuleResponseObject;
+export const zListPayRateRulePackagesQuery = z.object({
+    'filter[scoped_to_job_id]': z.string().optional(),
+    'filter[scoped_to_job_id][null]': z.boolean().optional(),
+    'filter[default]': z.boolean().optional(),
+    'filter[selectable]': z.boolean().optional(),
+    'filter[created_at][gte]': z.iso.datetime().optional(),
+    'filter[created_at][lte]': z.iso.datetime().optional(),
+    'filter[updated_at][gte]': z.iso.datetime().optional(),
+    'filter[updated_at][lte]': z.iso.datetime().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListPayRateRulePackagesResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zPayRatesRulePackageResponseObject)
+});
+export const zCreatePayRateRulePackageBody = zPayRatesRulePackageParameters;
+/**
+ * Created
+ */
+export const zCreatePayRateRulePackageResponse = zPayRatesRulePackageResponseObject;
+export const zGetPayRateRulePackagePath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetPayRateRulePackageResponse = zPayRatesRulePackageResponseObject;
 export const zListAggregateTimeImportsPath = z.object({
     pay_period_id: z.string()
 });

package/package.json

@@ -1,6 +1,6 @@
 {
   "name": "@dsptch-work/api-client",
-  "version": "0.20.0",
+  "version": "0.21.0",
   "description": "Generated TypeScript client for the DSPTCH REST API.",
   "keywords": [
     "dsptch",