@dsptch-work/api-client 0.7.0 → 0.9.0

package/dist/gen/zod.gen.js

@@ -200,6 +200,12 @@ export const zProblem = z.object({
  *
  * A deletion is refused by the record's guards — dependent records restrict removal. The message carries the specifics; remove or reassign the dependents first.
  *
+ * ### interval_too_wide
+ *
+ * **Interval Too Wide**
+ *
+ * A change feed was asked for a span of event time wider than one request may cover. Split it into consecutive windows no wider than the maximum stated in the feed's operation and read them in order; their pages concatenate without gaps. Both bounds are inclusive, so an event stamped exactly on a shared bound appears in both pages — deduplicate as usual.
+ *
  * ### invalid_date
  *
  * **Unparseable Date Value**
@@ -210,7 +216,7 @@ export const zProblem = z.object({
  *
  * **Invalid Filter Value**
  *
- * A declared filter key carries a value outside its accepted set — a non-boolean on a boolean key, or a token outside an enum key's vocabulary. Send an accepted value.
+ * A declared filter key carries a value outside its accepted set — a non-boolean on a boolean key, a token outside an enum key's vocabulary, or a range whose upper bound precedes its lower bound. Send an accepted value.
  *
  * ### invalid_iso8601_duration
  *
@@ -278,12 +284,6 @@ export const zProblem = z.object({
  *
  * The apprentice's wage schedule does not belong to the program in the URL. Use a schedule from that program.
  *
- * ### watermark_outside_retention
- *
- * **Watermark Outside Retention Window**
- *
- * A change feed was polled from a watermark older than the window it covers, so no page it could return would be complete. Resync instead: re-crawl the live index, diff it against your replica, and resume polling from the `meta.complete_through` of the first page you then read.
- *
  * ## 428
  *
  * ### precondition_required
@@ -346,6 +346,7 @@ export const zProblemTypeCatalog = z.enum([
     'company_not_employer',
     'confirm_apprenticeship_conflict',
     'destroy_restricted',
+    'interval_too_wide',
     'invalid_date',
     'invalid_filter_value',
     'invalid_iso8601_duration',
@@ -359,7 +360,6 @@ export const zProblemTypeCatalog = z.enum([
     'user_not_company_member',
     'validation_failed',
     'wage_schedule_outside_program',
-    'watermark_outside_retention',
     'precondition_required',
     'too_many_requests',
     'internal_error',
@@ -683,7 +683,7 @@ export const zTimecodeResponseObject = z.object({
         'job_with_timecode'
     ]),
     default_for_company_id: z.string().nullable(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     transaction_from: z.iso.datetime(),
     transaction_to: z.iso.datetime().nullable(),
@@ -713,7 +713,7 @@ export const zTimecodeHistoryVersionObject = z.object({
         'job_with_timecode'
     ]),
     default_for_company_id: z.string().nullable(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     transaction_from: z.iso.datetime(),
     transaction_to: z.iso.datetime().nullable(),
@@ -969,7 +969,7 @@ export const zTimeCardPerDiemParameters = z.object({
  */
 export const zHolidayResponseObject = z.object({
     id: z.string(),
-    pay_period_config_uid: z.string(),
+    timekeeping_pay_period_config_id: z.string(),
     date: z.iso.date(),
     name: z.string(),
     holiday_type: z.enum(['fixed', 'floating']),
@@ -990,7 +990,7 @@ export const zHolidayResponseObject = z.object({
  */
 export const zAttestationConfigResponseObject = z.object({
     id: z.string(),
-    pay_period_config_uid: z.string(),
+    timekeeping_pay_period_config_id: z.string(),
     content: z.string().nullable(),
     expected_response: z.boolean(),
     us_state_id: z.string().nullable(),
@@ -1007,10 +1007,10 @@ export const zAttestationConfigParameters = z.object({
     us_state_id: z.string().nullish()
 });
 /**
- * A pay schedule (PayPeriodConfig) — the top-level timekeeping unit that sets a company's payroll cadence and tracking modes and generates its stream of pay periods. Read-only; only the currently-valid version is returned, keyed by its stable uid.
+ * A pay schedule (PayPeriodConfig) — the top-level timekeeping unit that sets a company's payroll cadence and tracking modes and generates its stream of pay periods. Read-only; only the currently-valid version is returned, keyed by its stable id.
  */
 export const zPayPeriodConfigResponseObject = z.object({
-    uid: z.string(),
+    id: z.string(),
     company_id: z.string(),
     name: z.string(),
     frequency: z.enum(['weekly', 'biweekly']),
@@ -1042,12 +1042,12 @@ export const zPayPeriodConfigResponseObject = z.object({
     requires_external_map_contributor: z.boolean(),
     paid_after_holiday: z.boolean(),
     demo: z.boolean().nullable(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime()
 });
 export const zPayPeriodConfigHistoryVersionObject = z.object({
-    uid: z.string(),
+    id: z.string(),
     company_id: z.string(),
     name: z.string(),
     frequency: z.enum(['weekly', 'biweekly']),
@@ -1079,7 +1079,7 @@ export const zPayPeriodConfigHistoryVersionObject = z.object({
     requires_external_map_contributor: z.boolean(),
     paid_after_holiday: z.boolean(),
     demo: z.boolean().nullable(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime(),
     version_status: z.enum([
@@ -1772,7 +1772,6 @@ export const zJobParameters = z.object({
     end_time: z.string().nullish(),
     tz_name: z.string().optional(),
     time_card_start_day: zTimeCardStartDay.optional(),
-    require_clock_in: z.boolean().nullish(),
     clock_in_requirement: z.enum([
         'none',
         'warning',
@@ -2088,7 +2087,7 @@ export const zCompensationElementResponseObject = z.object({
  */
 export const zPayrollFringeBenefitPlanResponseObject = z.object({
     id: z.string(),
-    pay_period_config_uid: z.string(),
+    timekeeping_pay_period_config_id: z.string(),
     name: z.string(),
     plan_number: z.string(),
     funded: z.boolean(),
@@ -2112,10 +2111,10 @@ export const zPayrollFringeBenefitPlanResponseObject = z.object({
     updated_at: z.iso.datetime()
 });
 /**
- * Request body for creating or updating a fringe-benefit plan. pay_period_config_uid, name, plan_number, and benefit_category are required.
+ * Request body for creating or updating a fringe-benefit plan. timekeeping_pay_period_config_id, name, plan_number, and benefit_category are required.
  */
 export const zPayrollFringeBenefitPlanParameters = z.object({
-    pay_period_config_uid: z.string(),
+    timekeeping_pay_period_config_id: z.string(),
     name: z.string(),
     plan_number: z.string(),
     funded: z.boolean().optional(),
@@ -2141,7 +2140,6 @@ export const zPayrollFringeBenefitPlanParameters = z.object({
  */
 export const zPayrollExternalMapResponseObject = z.object({
     id: z.string(),
-    bitemporal_id: z.string(),
     name: z.string(),
     payrolls_compensation_element_id: z.string(),
     compensation_element_name: z.string(),
@@ -2154,7 +2152,7 @@ export const zPayrollExternalMapResponseObject = z.object({
         'garnishment',
         'other'
     ]),
-    pay_period_config_uid: z.string().nullable(),
+    timekeeping_pay_period_config_id: z.string().nullable(),
     payrolls_fringe_benefit_plan_id: z.string().nullable(),
     contributor: z.enum([
         'any',
@@ -2164,7 +2162,7 @@ export const zPayrollExternalMapResponseObject = z.object({
     annual_periods: z.int(),
     created_by_user_id: z.string().nullable(),
     global: z.boolean(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     transaction_from: z.iso.datetime(),
     transaction_to: z.iso.datetime().nullable(),
@@ -2173,7 +2171,6 @@ export const zPayrollExternalMapResponseObject = z.object({
 });
 export const zPayrollExternalMapHistoryVersionObject = z.object({
     id: z.string(),
-    bitemporal_id: z.string(),
     name: z.string(),
     payrolls_compensation_element_id: z.string(),
     compensation_element_name: z.string(),
@@ -2186,7 +2183,7 @@ export const zPayrollExternalMapHistoryVersionObject = z.object({
         'garnishment',
         'other'
     ]),
-    pay_period_config_uid: z.string().nullable(),
+    timekeeping_pay_period_config_id: z.string().nullable(),
     payrolls_fringe_benefit_plan_id: z.string().nullable(),
     contributor: z.enum([
         'any',
@@ -2196,7 +2193,7 @@ export const zPayrollExternalMapHistoryVersionObject = z.object({
     annual_periods: z.int(),
     created_by_user_id: z.string().nullable(),
     global: z.boolean(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     transaction_from: z.iso.datetime(),
     transaction_to: z.iso.datetime().nullable(),
@@ -3150,7 +3147,7 @@ export const zUserResponseObject = z.object({
     hire_date: z.string().nullable(),
     termination_date: z.string().nullable(),
     employment_window: z.object({
-        valid_from: z.iso.datetime(),
+        valid_from: z.iso.datetime().nullable(),
         valid_to: z.iso.datetime().nullable()
     }),
     manager_user_id: z.string().nullable(),
@@ -3437,6 +3434,18 @@ export const zFormSubmissionIndexObject = z.object({
         updated_at: z.iso.datetime().optional()
     })).optional()
 });
+/**
+ * A page of change events for form submissions, written at archival time; archiving hard-deletes the live row, so this feed is the deletion signal the main index cannot give. Visibility derives from metadata retained at archival time — a subset of the live submission index, never a superset.
+ */
+export const zFormSubmissionDeltasResponse = z.object({
+    meta: zDeltaMeta,
+    links: zLinks,
+    data: z.array(z.object({
+        event: z.enum(['destroy']),
+        id: z.uuid(),
+        timestamp: z.iso.datetime()
+    }))
+});
 /**
  * A page of change events (create, update, destroy) for time entries, drawn from version history; scoped by the surviving parent time card, so a destroyed entry's history stays visible.
  */
@@ -3462,7 +3471,6 @@ export const zPayPeriodsResponseObject = z.object({
     data: z.array(z.object({
         id: z.string().optional(),
         timekeeping_pay_period_config_id: z.string().optional(),
-        pay_period_config_uid: z.string().optional(),
         pay_date: z.iso.date().optional(),
         start_time: z.iso.datetime().optional(),
         end_time: z.iso.datetime().optional(),
@@ -3611,7 +3619,7 @@ export const zFederalJobWageDeterminationResponseObject = z.object({
         'residential'
     ]),
     general_wage_determination: z.string().nullable(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
@@ -3649,7 +3657,7 @@ export const zRegionalJobWageDeterminationResponseObject = z.object({
     fringe_rate_cents: z.string(),
     general_wage_determination: z.string().nullable(),
     regional_fields: zRegionalWageDeterminationFields,
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
@@ -3678,7 +3686,7 @@ export const zFederalJobWageDeterminationHistoryVersionObject = z.object({
         'residential'
     ]),
     general_wage_determination: z.string().nullable(),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime(),
@@ -3700,7 +3708,7 @@ export const zRegionalJobWageDeterminationHistoryVersionObject = z.object({
     fringe_rate_cents: z.string(),
     general_wage_determination: z.string().nullable(),
     regional_fields: zRegionalWageDeterminationFields,
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime(),
@@ -3824,7 +3832,7 @@ export const zRateRuleResponseObject = z.object({
     pay_rates_rule_package_id: z.string(),
     effect: zRateRuleEffect,
     conditions: z.array(zRateRuleCondition),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime()
@@ -3836,7 +3844,7 @@ export const zRateRuleHistoryVersionObject = z.object({
     pay_rates_rule_package_id: z.string(),
     effect: zRateRuleEffect,
     conditions: z.array(zRateRuleCondition),
-    valid_from: z.iso.datetime(),
+    valid_from: z.iso.datetime().nullable(),
     valid_to: z.iso.datetime().nullable(),
     created_at: z.iso.datetime(),
     updated_at: z.iso.datetime(),
@@ -5860,6 +5868,24 @@ export const zListFormDefinitionsQuery = z.object({
  * Success
  */
 export const zListFormDefinitionsResponse = zFormDefinitionResponseObject;
+export const zListFormSubmissionDeltasQuery = z.object({
+    'filter[event]': z.enum([
+        'create',
+        'update',
+        'destroy'
+    ]).optional(),
+    'filter[created_at][gte]': z.iso.datetime().optional(),
+    'filter[created_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 zListFormSubmissionDeltasResponse = zFormSubmissionDeltasResponse;
 export const zListFormSubmissionsQuery = z.object({
     'filter[form_definition_id]': z.string().optional(),
     'filter[created_at][gte]': z.iso.datetime().optional(),
@@ -6258,7 +6284,7 @@ export const zListExternalMapHistoryResponse = z.object({
 });
 export const zListExternalMapsQuery = z.object({
     'filter[name]': z.string().optional(),
-    'filter[pay_period_config_uid]': z.string().optional(),
+    'filter[timekeeping_pay_period_config_id]': z.string().optional(),
     'filter[global]': z.boolean().optional(),
     filter: z.string().optional(),
     'filter[unexpected]': z.string().optional(),
@@ -6292,7 +6318,7 @@ export const zGetExternalMapQuery = z.object({
 export const zGetExternalMapResponse = zPayrollExternalMapResponseObject;
 export const zListFringeBenefitPlansQuery = z.object({
     'filter[name]': z.string().optional(),
-    'filter[pay_period_config_uid]': z.string().optional(),
+    'filter[timekeeping_pay_period_config_id]': z.string().optional(),
     filter: z.string().optional(),
     'filter[unexpected]': z.string().optional(),
     'page[cursor]': z.string().optional(),
@@ -7156,7 +7182,7 @@ export const zCreateManagerTimeEntryApprovalPath = z.object({
  */
 export const zCreateManagerTimeEntryApprovalResponse = zTimeEntryApprovalResponseObject;
 export const zListAttestationConfigsPath = z.object({
-    pay_period_config_uid: z.string()
+    pay_period_config_id: z.string()
 });
 /**
  * Success
@@ -7168,14 +7194,14 @@ export const zListAttestationConfigsResponse = z.object({
 });
 export const zCreateAttestationConfigBody = zAttestationConfigParameters;
 export const zCreateAttestationConfigPath = z.object({
-    pay_period_config_uid: z.string()
+    pay_period_config_id: z.string()
 });
 /**
  * Created
  */
 export const zCreateAttestationConfigResponse = zAttestationConfigResponseObject;
 export const zDeleteAttestationConfigPath = z.object({
-    pay_period_config_uid: z.string(),
+    pay_period_config_id: z.string(),
     id: z.string()
 });
 /**
@@ -7183,7 +7209,7 @@ export const zDeleteAttestationConfigPath = z.object({
  */
 export const zDeleteAttestationConfigResponse = zAttestationConfigResponseObject;
 export const zGetAttestationConfigPath = z.object({
-    pay_period_config_uid: z.string(),
+    pay_period_config_id: z.string(),
     id: z.string()
 });
 /**
@@ -7191,7 +7217,7 @@ export const zGetAttestationConfigPath = z.object({
  */
 export const zGetAttestationConfigResponse = zAttestationConfigResponseObject;
 export const zListPayPeriodConfigHistoryPath = z.object({
-    pay_period_config_uid: z.string()
+    pay_period_config_id: z.string()
 });
 export const zListPayPeriodConfigHistoryQuery = z.object({
     'as_of[valid]': z.string().optional()
@@ -7205,7 +7231,7 @@ export const zListPayPeriodConfigHistoryResponse = z.object({
     data: z.array(zPayPeriodConfigHistoryVersionObject).optional()
 });
 export const zListHolidaysPath = z.object({
-    pay_period_config_uid: z.string()
+    pay_period_config_id: z.string()
 });
 export const zListHolidaysQuery = z.object({
     'filter[overtime]': z.boolean().optional(),
@@ -7230,14 +7256,14 @@ export const zListHolidaysResponse = z.object({
 });
 export const zCreateHolidayBody = zHolidayParameters;
 export const zCreateHolidayPath = z.object({
-    pay_period_config_uid: z.string()
+    pay_period_config_id: z.string()
 });
 /**
  * Created
  */
 export const zCreateHolidayResponse = zHolidayResponseObject;
 export const zDeleteHolidayPath = z.object({
-    pay_period_config_uid: z.string(),
+    pay_period_config_id: z.string(),
     id: z.string()
 });
 /**
@@ -7246,7 +7272,7 @@ export const zDeleteHolidayPath = z.object({
 export const zDeleteHolidayResponse = zHolidayResponseObject;
 export const zUpdateHolidayBody = zHolidayParameters;
 export const zUpdateHolidayPath = z.object({
-    pay_period_config_uid: z.string(),
+    pay_period_config_id: z.string(),
     id: z.string()
 });
 /**
@@ -7272,7 +7298,7 @@ export const zListPayPeriodConfigsResponse = z.object({
     data: z.array(zPayPeriodConfigResponseObject).optional()
 });
 export const zGetPayPeriodConfigPath = z.object({
-    uid: z.string()
+    id: z.string()
 });
 export const zGetPayPeriodConfigQuery = z.object({
     'as_of[valid]': z.iso.datetime().optional()

package/package.json

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