@dsptch-work/api-client 0.13.0 → 0.14.0

package/dist/gen/zod.gen.js

@@ -138,6 +138,12 @@ export const zProblem = z.object({
  *
  * The API key lacks the scope grant for this endpoint and verb. Grant the required scope to the key and retry.
  *
+ * ### user_scoped_key_required
+ *
+ * **User-Scoped Key Required**
+ *
+ * The endpoint records which person performed the action, so it needs a credential that names one. The presented key is scoped to the company itself. Retry with a user-scoped API key; no additional scope grant makes a company-scoped key acceptable here.
+ *
  * ## 404
  *
  * ### not_found
@@ -349,6 +355,7 @@ export const zProblemTypeCatalog = z.enum([
     'company_scoped_key_required',
     'forbidden',
     'insufficient_api_key_scope',
+    'user_scoped_key_required',
     'not_found',
     'already_terminated',
     'product_archived',
@@ -399,6 +406,7 @@ export const zDirectUploadParameters = z.object({
         'assets.items.service_events',
         'assets.products',
         'assets.vendors',
+        'pay_periods.imports.time_entries',
         'users'
     ]),
     blob: z.object({
@@ -1404,6 +1412,36 @@ export const zPwaTradeResponseObject = z.object({
 export const zPwaTradeParameters = z.object({
     name: z.string()
 });
+/**
+ * Parameters for renaming a PWA trade (craft). Renaming edits the display label only — the craft's match key and every determination grouped under it are untouched.
+ */
+export const zPwaTradeUpdateParameters = z.object({
+    name: z.string().optional()
+});
+/**
+ * A reviewed apprentice-scope decision pairing a registered apprenticeship occupation with a craft (trade). The row's existence means the pair was reviewed; scope_status carries the verdict. A pair with no row is undecided and denies apprentice treatment.
+ */
+export const zPwaTradeApprenticeshipOccupationResponseObject = z.object({
+    id: z.string(),
+    pwa_trade_id: z.string(),
+    apprenticeship_occupation_id: z.string(),
+    scope_status: z.enum(['in_scope', 'out_of_scope']),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * Parameters for recording an apprentice-scope decision on a trade.
+ */
+export const zPwaTradeApprenticeshipOccupationCreateParameters = z.object({
+    apprenticeship_occupation_id: z.string(),
+    scope_status: z.enum(['in_scope', 'out_of_scope']).nullish()
+});
+/**
+ * Parameters for flipping an existing apprentice-scope decision's verdict.
+ */
+export const zPwaTradeApprenticeshipOccupationUpdateParameters = z.object({
+    scope_status: z.enum(['in_scope', 'out_of_scope']).nullish()
+});
 /**
  * Prevailing-wage / apprenticeship (PWA) compliance details for a job, used in certified-payroll reporting. Fields for every supported state are always present; those outside the job's region come back null. Null on the job when it tracks no PWA compliance.
  */
@@ -1959,6 +1997,40 @@ export const zUserCompanyScheduledChangesResponse = z.object({
 export const zUserCompanyScheduledTerminationParameters = z.object({
     termination_date: z.string()
 });
+/**
+ * One problem found while processing an accepted import.
+ */
+export const zTimeEntryImportProcessingError = z.object({
+    code: z.string(),
+    row: z.int().nullable(),
+    column: z.string().nullable(),
+    context: z.record(z.string(), z.unknown())
+});
+/**
+ * One bulk upload of time entries against a pay period, and how it turned out.
+ */
+export const zTimeEntryImportResponseObject = z.object({
+    id: z.string(),
+    pay_period_id: z.string(),
+    status: z.enum([
+        'pending',
+        'processing',
+        'processed',
+        'success',
+        'failed'
+    ]),
+    processed_rows_count: z.int(),
+    processing_errors: z.array(zTimeEntryImportProcessingError),
+    completed_at: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime(),
+    updated_at: z.iso.datetime()
+});
+/**
+ * Submit a spreadsheet of time entries for a pay period. All seven of payroll_id, start_time, end_time, timecode, job_id, state and description must be present as column headers, or the file is refused naming the ones missing. Of those, payroll_id, start_time, end_time, timecode and state must also carry a value on every row. features, federal_labor_classification and regional_labor_classification are read when present. Header matching ignores case and treats spaces as underscores, and column order does not matter. Any other column is refused: a name this import does not read would be dropped without trace, so the file is rejected naming it rather than applied in part.
+ */
+export const zTimeEntryImportParameters = z.object({
+    file_signed_id: z.string()
+});
 /**
  * A worker's time card for one pay period — the aggregation root for their tracked time, carrying approval and lock status alongside the period's rolled-up minutes and pay totals. One per worker per pay period.
  */
@@ -4046,6 +4118,7 @@ export const zRegionalJobWageDeterminationParameters = z.object({
     hourly_rate_cents: z.string(),
     fringe_rate_cents: z.string().optional(),
     general_wage_determination: z.string().nullish(),
+    overtime_package_id: z.string().nullish(),
     regional_fields: zRegionalWageDeterminationFields.optional()
 });
 /**
@@ -4060,6 +4133,7 @@ export const zJobWageDeterminationParameters = z.discriminatedUnion('type', [
  */
 export const zJobWageDeterminationUpdateParameters = z.object({
     effective_from: z.iso.date().optional(),
+    overtime_package_id: z.string().nullish(),
     labor_classification: z.string().optional(),
     pwa_trade_id: z.string().optional(),
     hourly_rate_cents: z.string().optional(),
@@ -4080,7 +4154,6 @@ export const zJobWageDeterminationUpdateParameters = z.object({
 export const zJobWageDeterminationScheduledChangeParameters = z.object({
     effective_date: z.iso.date(),
     labor_classification: z.string().optional(),
-    pwa_trade_id: z.string().optional(),
     hourly_rate_cents: z.string().optional(),
     fringe_rate_cents: z.string().optional(),
     class_code: z.string().nullish(),
@@ -4209,6 +4282,177 @@ export const zRateRuleHistoryVersionObject = z.object({
     ]),
     corrections: z.array(zRateRuleHistoryCorrectionObject)
 });
+/**
+ * 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.
+ */
+export const zOvertimeRuleResponseObject = z.object({
+    id: z.string(),
+    overtime_package_id: z.string(),
+    type: z.enum(['DailyOvertimeRule', 'WeeklyOvertimeRule']),
+    rate_multiplier: z.enum([
+        'one_x',
+        'one_five_x',
+        'two_x'
+    ]),
+    region_id: z.string().nullable(),
+    eligible_hours_worked: z.int().nullable(),
+    specific_day_of_week: z.enum([
+        'sunday',
+        'monday',
+        'tuesday',
+        'wednesday',
+        'thursday',
+        'friday',
+        'saturday'
+    ]).nullable(),
+    specific_date: z.iso.date().nullable(),
+    valid_from: z.iso.datetime().nullable(),
+    valid_to: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime().nullable(),
+    updated_at: z.iso.datetime().nullable()
+});
+export const zOvertimeRuleHistoryCorrectionObject = z.object({
+    overtime_rule_id: z.string(),
+    overtime_package_id: z.string(),
+    type: z.enum(['DailyOvertimeRule', 'WeeklyOvertimeRule']),
+    rate_multiplier: z.enum([
+        'one_x',
+        'one_five_x',
+        'two_x'
+    ]),
+    region_id: z.string().nullable(),
+    eligible_hours_worked: z.int().nullable(),
+    specific_day_of_week: z.enum([
+        'sunday',
+        'monday',
+        'tuesday',
+        'wednesday',
+        'thursday',
+        'friday',
+        'saturday'
+    ]).nullable(),
+    specific_date: z.iso.date().nullable(),
+    valid_from: z.iso.datetime().nullable(),
+    valid_to: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime().nullable(),
+    updated_at: z.iso.datetime().nullable()
+});
+export const zOvertimeRuleHistoryVersionObject = z.object({
+    overtime_rule_id: z.string(),
+    overtime_package_id: z.string(),
+    type: z.enum(['DailyOvertimeRule', 'WeeklyOvertimeRule']),
+    rate_multiplier: z.enum([
+        'one_x',
+        'one_five_x',
+        'two_x'
+    ]),
+    region_id: z.string().nullable(),
+    eligible_hours_worked: z.int().nullable(),
+    specific_day_of_week: z.enum([
+        'sunday',
+        'monday',
+        'tuesday',
+        'wednesday',
+        'thursday',
+        'friday',
+        'saturday'
+    ]).nullable(),
+    specific_date: z.iso.date().nullable(),
+    valid_from: z.iso.datetime().nullable(),
+    valid_to: z.iso.datetime().nullable(),
+    created_at: z.iso.datetime().nullable(),
+    updated_at: z.iso.datetime().nullable(),
+    version_status: z.enum([
+        'scheduled',
+        'current',
+        'historical'
+    ]),
+    corrections: z.array(zOvertimeRuleHistoryCorrectionObject)
+});
+/**
+ * Create an overtime rule on the package. `type` and `rate_multiplier` are required; the qualifiers below are optional and describe when the multiplier applies.
+ */
+export const zOvertimeRuleParameters = z.object({
+    effective_date: z.iso.date().optional(),
+    type: z.enum(['DailyOvertimeRule', 'WeeklyOvertimeRule']),
+    rate_multiplier: z.enum([
+        'one_x',
+        'one_five_x',
+        'two_x'
+    ]),
+    region_id: z.string().nullish(),
+    eligible_hours_worked: z.int().nullish(),
+    specific_day_of_week: z.enum([
+        'sunday',
+        'monday',
+        'tuesday',
+        'wednesday',
+        'thursday',
+        'friday',
+        'saturday'
+    ]).nullish(),
+    specific_date: z.iso.date().nullish()
+});
+/**
+ * Edit the rule from a point in valid time forward. `type` is required, since it selects how the rule is compiled, and `rate_multiplier` carries forward when omitted. Everything describing *when* the multiplier applies — `region_id`, `eligible_hours_worked`, `specific_day_of_week`, `specific_date` — is recompiled from the body on every write, so omitting one drops it rather than keeping it. State the whole set of qualifiers you want, not just the ones you are changing.
+ */
+export const zOvertimeRuleUpdateParameters = z.object({
+    effective_from: z.iso.date().optional(),
+    type: z.enum(['DailyOvertimeRule', 'WeeklyOvertimeRule']),
+    rate_multiplier: z.enum([
+        'one_x',
+        'one_five_x',
+        'two_x'
+    ]).optional(),
+    region_id: z.string().nullish(),
+    eligible_hours_worked: z.int().nullish(),
+    specific_day_of_week: z.enum([
+        'sunday',
+        'monday',
+        'tuesday',
+        'wednesday',
+        'thursday',
+        'friday',
+        'saturday'
+    ]).nullish(),
+    specific_date: z.iso.date().nullish()
+});
+/**
+ * Schedule an effective-dated change to the rule, applying from a calendar date forward. `type` is required, since it selects how the rule is compiled, and `rate_multiplier` carries forward when omitted. Everything describing *when* the multiplier applies — `region_id`, `eligible_hours_worked`, `specific_day_of_week`, `specific_date` — is recompiled from the body on every write, so omitting one drops it rather than keeping it. State the whole set of qualifiers you want, not just the ones you are changing.
+ */
+export const zOvertimeRuleScheduledChangeParameters = z.object({
+    effective_date: z.iso.date(),
+    type: z.enum(['DailyOvertimeRule', 'WeeklyOvertimeRule']),
+    rate_multiplier: z.enum([
+        'one_x',
+        'one_five_x',
+        'two_x'
+    ]).optional(),
+    region_id: z.string().nullish(),
+    eligible_hours_worked: z.int().nullish(),
+    specific_day_of_week: z.enum([
+        'sunday',
+        'monday',
+        'tuesday',
+        'wednesday',
+        'thursday',
+        'friday',
+        'saturday'
+    ]).nullish(),
+    specific_date: z.iso.date().nullish()
+});
+/**
+ * Parameters for moving where an overtime rule's timeline begins.
+ */
+export const zOvertimeRuleGenesisParameters = z.object({
+    effective_date: z.iso.date()
+});
+/**
+ * Schedule when the overtime rule stops being valid.
+ */
+export const zOvertimeRuleScheduledTerminationParameters = z.object({
+    effective_date: z.iso.date()
+});
 /**
  * Create a rate rule on a job wage determination. `effect` is required. `conditions` is optional — an omitted or empty list makes the rule always apply. `effective_date` (YYYY-MM-DD) sets when the rule takes effect; it defaults to today and cannot predate the earliest applicable wage determination.
  */
@@ -6790,6 +7034,19 @@ export const zUpdateJobPath = z.object({
  * Success
  */
 export const zUpdateJobResponse = zJobResponseObject;
+/**
+ * Success
+ */
+export const zGetOpenapiDocumentResponse = z.object({
+    openapi: z.string(),
+    info: z.record(z.string(), z.unknown()),
+    externalDocs: z.record(z.string(), z.unknown()),
+    tags: z.array(z.record(z.string(), z.unknown())),
+    'x-tagGroups': z.array(z.record(z.string(), z.unknown())),
+    paths: z.record(z.string(), z.unknown()),
+    servers: z.array(z.record(z.string(), z.unknown())),
+    components: z.record(z.string(), z.unknown())
+});
 export const zListSiteCheckInsPath = z.object({
     site_id: z.string()
 });
@@ -6823,6 +7080,193 @@ export const zGetSiteCheckInPath = z.object({
  * Success
  */
 export const zGetSiteCheckInResponse = zSiteCheckInResponseObject;
+export const zShiftOvertimeRuleGenesisBody = zOvertimeRuleGenesisParameters;
+export const zShiftOvertimeRuleGenesisHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zShiftOvertimeRuleGenesisPath = z.object({
+    overtime_package_id: z.string(),
+    overtime_rule_id: z.string()
+});
+/**
+ * Success
+ */
+export const zShiftOvertimeRuleGenesisResponse = zOvertimeRuleResponseObject;
+export const zListOvertimeRuleHistoryPath = z.object({
+    overtime_package_id: z.string(),
+    overtime_rule_id: z.string()
+});
+export const zListOvertimeRuleHistoryQuery = z.object({
+    'as_of[valid]': z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListOvertimeRuleHistoryResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zOvertimeRuleHistoryVersionObject)
+});
+export const zCancelOvertimeRuleScheduledChangesHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCancelOvertimeRuleScheduledChangesPath = z.object({
+    overtime_package_id: z.string(),
+    overtime_rule_id: z.string()
+});
+/**
+ * Success
+ */
+export const zCancelOvertimeRuleScheduledChangesResponse = zOvertimeRuleResponseObject;
+export const zListOvertimeRuleScheduledChangesPath = z.object({
+    overtime_package_id: z.string(),
+    overtime_rule_id: z.string()
+});
+/**
+ * Success with scheduled changes
+ */
+export const zListOvertimeRuleScheduledChangesResponse = z.array(zOvertimeRuleResponseObject);
+export const zScheduleOvertimeRuleChangeBody = zOvertimeRuleScheduledChangeParameters;
+export const zScheduleOvertimeRuleChangeHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zScheduleOvertimeRuleChangePath = z.object({
+    overtime_package_id: z.string(),
+    overtime_rule_id: z.string()
+});
+/**
+ * Success (already scheduled)
+ */
+export const zScheduleOvertimeRuleChangeResponse = zOvertimeRuleResponseObject;
+export const zCancelOvertimeRuleScheduledTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zCancelOvertimeRuleScheduledTerminationPath = z.object({
+    overtime_package_id: z.string(),
+    overtime_rule_id: z.string()
+});
+/**
+ * Success
+ */
+export const zCancelOvertimeRuleScheduledTerminationResponse = zOvertimeRuleResponseObject;
+export const zScheduleOvertimeRuleTerminationBody = zOvertimeRuleScheduledTerminationParameters;
+export const zScheduleOvertimeRuleTerminationHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zScheduleOvertimeRuleTerminationPath = z.object({
+    overtime_package_id: z.string(),
+    overtime_rule_id: z.string()
+});
+/**
+ * Created
+ */
+export const zScheduleOvertimeRuleTerminationResponse = zOvertimeRuleResponseObject;
+export const zListOvertimeRulesPath = z.object({
+    overtime_package_id: z.string()
+});
+export const zListOvertimeRulesQuery = 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 zListOvertimeRulesResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zOvertimeRuleResponseObject)
+});
+export const zCreateOvertimeRuleBody = zOvertimeRuleParameters;
+export const zCreateOvertimeRulePath = z.object({
+    overtime_package_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateOvertimeRuleResponse = zOvertimeRuleResponseObject;
+export const zDeleteOvertimeRuleHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zDeleteOvertimeRulePath = z.object({
+    overtime_package_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zDeleteOvertimeRuleResponse = zOvertimeRuleResponseObject;
+export const zGetOvertimeRulePath = z.object({
+    overtime_package_id: z.string(),
+    id: z.string()
+});
+export const zGetOvertimeRuleQuery = z.object({
+    'as_of[valid]': z.iso.datetime().optional()
+});
+/**
+ * Success
+ */
+export const zGetOvertimeRuleResponse = zOvertimeRuleResponseObject;
+export const zUpdateOvertimeRuleBody = zOvertimeRuleUpdateParameters;
+export const zUpdateOvertimeRuleHeaders = z.object({
+    'If-Match': z.string()
+});
+export const zUpdateOvertimeRulePath = z.object({
+    overtime_package_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateOvertimeRuleResponse = zOvertimeRuleResponseObject;
+export const zListTimeEntryImportsPath = z.object({
+    pay_period_id: z.string()
+});
+export const zListTimeEntryImportsQuery = z.object({
+    'filter[status]': z.string().optional(),
+    filter: z.string().optional(),
+    'filter[unexpected]': z.string().optional(),
+    'filter[completed_at][gte]': z.iso.datetime().optional(),
+    'filter[completed_at][lte]': z.iso.datetime().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(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().optional()
+});
+/**
+ * Success
+ */
+export const zListTimeEntryImportsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zTimeEntryImportResponseObject)
+});
+export const zCreateTimeEntryImportBody = zTimeEntryImportParameters;
+export const zCreateTimeEntryImportPath = z.object({
+    pay_period_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateTimeEntryImportResponse = zTimeEntryImportResponseObject;
+export const zGetTimeEntryImportPath = z.object({
+    pay_period_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zGetTimeEntryImportResponse = zTimeEntryImportResponseObject;
 export const zListPayPeriodsQuery = z.object({
     'filter[start_time][gte]': z.iso.datetime().optional(),
     'filter[start_time][lte]': z.iso.datetime().optional(),
@@ -7288,9 +7732,57 @@ export const zUpdateCompanyUserDetailPath = z.object({
  * Success
  */
 export const zUpdateCompanyUserDetailResponse = zPwaCompanyUserDetailsResponseObject;
+export const zListApprenticeshipOccupationsPath = z.object({
+    trade_id: z.string()
+});
+export const zListApprenticeshipOccupationsQuery = z.object({
+    'filter[apprenticeship_occupation_id]': z.string().optional(),
+    'filter[scope_status]': z.enum(['in_scope', 'out_of_scope']).optional(),
+    'page[cursor]': z.string().optional(),
+    'page[limit]': z.int().gte(1).optional().default(20),
+    page: z.string().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()
+});
+/**
+ * Success
+ */
+export const zListApprenticeshipOccupationsResponse = z.object({
+    meta: zMeta,
+    links: zLinks,
+    data: z.array(zPwaTradeApprenticeshipOccupationResponseObject)
+});
+export const zCreateApprenticeshipOccupationBody = zPwaTradeApprenticeshipOccupationCreateParameters;
+export const zCreateApprenticeshipOccupationPath = z.object({
+    trade_id: z.string()
+});
+/**
+ * Created
+ */
+export const zCreateApprenticeshipOccupationResponse = zPwaTradeApprenticeshipOccupationResponseObject;
+export const zDeleteApprenticeshipOccupationPath = z.object({
+    trade_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zDeleteApprenticeshipOccupationResponse = zPwaTradeApprenticeshipOccupationResponseObject;
+export const zUpdateApprenticeshipOccupationBody = zPwaTradeApprenticeshipOccupationUpdateParameters;
+export const zUpdateApprenticeshipOccupationPath = z.object({
+    trade_id: z.string(),
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateApprenticeshipOccupationResponse = zPwaTradeApprenticeshipOccupationResponseObject;
 export const zListTradesQuery = z.object({
     'filter[project_id]': z.string().optional(),
     'filter[job_id]': z.string().optional(),
+    'filter[name]': z.string().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(),
@@ -7309,6 +7801,13 @@ export const zListTradesResponse = z.object({
     links: zLinks,
     data: z.array(zPwaTradeResponseObject)
 });
+export const zDeleteTradePath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zDeleteTradeResponse = zPwaTradeResponseObject;
 export const zGetTradePath = z.object({
     id: z.string()
 });
@@ -7316,6 +7815,14 @@ export const zGetTradePath = z.object({
  * Success
  */
 export const zGetTradeResponse = zPwaTradeResponseObject;
+export const zUpdateTradeBody = zPwaTradeUpdateParameters;
+export const zUpdateTradePath = z.object({
+    id: z.string()
+});
+/**
+ * Success
+ */
+export const zUpdateTradeResponse = zPwaTradeResponseObject;
 export const zCreateFormAssignmentTaskBody = z.object({
     form_definition_id: z.string(),
     spread_assignees: z.boolean().optional(),

package/package.json

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