@dsptch-work/api-client 0.24.0 → 0.25.0

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

@@ -383,7 +383,7 @@ export type DirectUploadParameters = {
     /**
      * What the file is for, named as the endpoint that will attach it (for example `assets.vendors`). Required. It decides where the file is stored, and the signed ID this call returns is issued for that resource alone — it will not resolve at any other endpoint, so a vendor logo cannot be attached as an avatar, or an avatar as a logo.
      */
-    resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
+    resource: 'assets.items' | 'assets.items.documents' | 'assets.items.service_events' | 'assets.products' | 'assets.vendors' | 'compliance.checks' | 'internal.companies' | 'internal.company_todos' | 'internal.job_todos' | 'internal.project_todos' | 'pay_periods.imports.aggregate_times' | 'pay_periods.imports.dsptch_cprs' | 'pay_periods.imports.time_entries' | 'payrolls.payroll_runs.imports.paystubs' | 'users';
     /**
      * Metadata describing the file being registered, before its bytes are uploaded.
      */
@@ -1026,7 +1026,7 @@ export type ApprenticeshipOccupationUpdateParameters = {
  */
 export type ApprenticeshipProgramEmployerParameters = {
     /**
-     * ID of the company to authorize as an employer in this program; it need not be related to the sponsor, since a group program names unaffiliated contractors. Naming a company here grants its admins and managers read access to this program, the right to enroll their own workers in it, the right to curate its trade-to-occupation scope decisions, and a passing apprenticeship-program compliance check; it grants no access to that company's own data. Cannot be changed once the employer has apprentices. Required.
+     * ID of the company to authorize as an employer. An API key may name only its own company. Required.
      */
     company_id: string;
     /**
@@ -1035,11 +1035,11 @@ export type ApprenticeshipProgramEmployerParameters = {
     require_timecard_allocation?: boolean;
 };
 /**
- * Update an employer authorization in a program. Send only the fields to change; only the program's sponsor may manage this roster.
+ * Update an employer authorization in a program. Send only the fields to change; only the program's sponsor may manage this roster, and an API key may change only the row naming its own company.
  */
 export type ApprenticeshipProgramEmployerUpdateParameters = {
     /**
-     * ID of the company authorized as an employer in this program. It cannot be changed once the employer has apprentices; omit to leave it unchanged.
+     * ID of the company authorized as an employer. An API key may name only its own company; omit to leave it unchanged.
      */
     company_id?: string;
     /**
@@ -4518,26 +4518,38 @@ export type UserUpdateParameters = {
      */
     avatar_signed_id?: string | null;
 };
-/**
- * Request body for onboarding a worker into your company. In one call it creates the person (if new), their employment record, roles, group memberships, an optional invite, and optional compliance details. company_id, email, first_name, and last_name are required.
- */
-export type UserParameters = {
+export type UserParameters = ({
+    /**
+     * Work email address; the worker signs in and receives their invite here. Null when the worker has none. Required to send an invite unless a phone number is given.
+     */
+    email: string;
+} | {
+    /**
+     * Contact phone number. Null when the worker has none. Required to send an invite unless a work email is given.
+     */
+    phone_number: string;
+} | {
+    /**
+     * Non-stored field. If true, no invite is created and work email / phone are not required.
+     */
+    skip_invite: true;
+}) & {
     /**
      * Id of the company to onboard the worker into. Must be the company that owns the API key.
      */
-    company_id: string;
+    company_id?: string;
     /**
-     * Work email address; the worker signs in and receives their invite here.
+     * Work email address; the worker signs in and receives their invite here. Null when the worker has none. Required to send an invite unless a phone number is given.
      */
-    email: string;
+    email?: string | null;
     /**
      * Personal (non-work) email address.
      */
-    personal_email?: string;
+    personal_email?: string | null;
     /**
-     * Contact phone number.
+     * Contact phone number. Null when the worker has none. Required to send an invite unless a work email is given.
      */
-    phone_number?: string;
+    phone_number?: string | null;
     /**
      * Legal first name. Used for compliance and other exports.
      */
@@ -4599,7 +4611,7 @@ export type UserParameters = {
      */
     skip_notify?: boolean;
     /**
-     * Non-stored field. If true will not create an invite at all.
+     * Non-stored field. If true, no invite is created and work email / phone are not required.
      */
     skip_invite?: boolean;
     type?: UserCompanyType;
@@ -8623,6 +8635,19 @@ export type PayRatesRulePackageParameters = {
      */
     description?: string | null;
 };
+/**
+ * Request body for updating a pay-rate rule package. Send only the fields to change. `default`, `selectable`, and `scoped_to_job_id` are not writable on this operation.
+ */
+export type PayRatesRulePackageUpdateParameters = {
+    /**
+     * Human-readable package name. Omit to leave it unchanged.
+     */
+    name?: string;
+    /**
+     * Free-form package description; omit to leave it unchanged, or send null to clear it.
+     */
+    description?: string | null;
+};
 /**
  * A page of a job's positions, with pagination metadata and navigation links.
  */
@@ -8655,11 +8680,11 @@ export type PositionParameters = {
      */
     end_time?: string | null;
     /**
-     * ID of the position function (role) to assign; null for none.
+     * ID of the position function (role) to assign; null for none. Must be a global function or one of the job's company.
      */
     position_function_id?: string | null;
     /**
-     * ID of the per diem to apply; its rate and currency are copied onto the position.
+     * ID of the per diem to apply; its rate and currency are copied onto the position. Must belong to the job's company.
      */
     per_diem_id?: string | null;
     /**
@@ -12691,6 +12716,33 @@ export type CreateAllocationResponses = {
     201: ApprenticeshipAllocationResponseObject;
 };
 export type CreateAllocationResponse = CreateAllocationResponses[keyof CreateAllocationResponses];
+export type DeleteAllocationData = {
+    body?: never;
+    path: {
+        apprentice_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/apprentices/{apprentice_id}/allocations/{id}';
+};
+export type DeleteAllocationErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type DeleteAllocationError = DeleteAllocationErrors[keyof DeleteAllocationErrors];
+export type DeleteAllocationResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteAllocationResponse = DeleteAllocationResponses[keyof DeleteAllocationResponses];
 export type GetAllocationData = {
     body?: never;
     path: {
@@ -12936,6 +12988,64 @@ export type CreateOccupationResponses = {
     201: ApprenticeshipOccupationResponseObject;
 };
 export type CreateOccupationResponse = CreateOccupationResponses[keyof CreateOccupationResponses];
+export type DeleteOccupationData = {
+    body?: never;
+    path: {
+        program_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/programs/{program_id}/occupations/{id}';
+};
+export type DeleteOccupationErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type DeleteOccupationError = DeleteOccupationErrors[keyof DeleteOccupationErrors];
+export type DeleteOccupationResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteOccupationResponse = DeleteOccupationResponses[keyof DeleteOccupationResponses];
+export type GetOccupationData = {
+    body?: never;
+    path: {
+        program_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/programs/{program_id}/occupations/{id}';
+};
+export type GetOccupationErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetOccupationError = GetOccupationErrors[keyof GetOccupationErrors];
+export type GetOccupationResponses = {
+    /**
+     * Success
+     */
+    200: ApprenticeshipOccupationResponseObject;
+};
+export type GetOccupationResponse = GetOccupationResponses[keyof GetOccupationResponses];
 export type UpdateOccupationData = {
     body?: ApprenticeshipOccupationUpdateParameters;
     path: {
@@ -13028,7 +13138,11 @@ export type CreateEmployerData = {
 };
 export type CreateEmployerErrors = {
     /**
-     * Forbidden
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden. Also returned when `company_id` names a company other than the API key's own.
      */
     403: Problem;
     /**
@@ -13082,7 +13196,11 @@ export type UpdateEmployerData = {
 };
 export type UpdateEmployerErrors = {
     /**
-     * Forbidden
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden. Also returned when `company_id`, sent or stored, names a company other than the API key's own.
      */
     403: Problem;
     /**
@@ -13171,6 +13289,62 @@ export type CreateProgramResponses = {
     201: ApprenticeshipProgramResponseObject;
 };
 export type CreateProgramResponse = CreateProgramResponses[keyof CreateProgramResponses];
+export type DeleteProgramData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/programs/{id}';
+};
+export type DeleteProgramErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type DeleteProgramError = DeleteProgramErrors[keyof DeleteProgramErrors];
+export type DeleteProgramResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteProgramResponse = DeleteProgramResponses[keyof DeleteProgramResponses];
+export type GetProgramData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/programs/{id}';
+};
+export type GetProgramErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetProgramError = GetProgramErrors[keyof GetProgramErrors];
+export type GetProgramResponses = {
+    /**
+     * Success
+     */
+    200: ApprenticeshipProgramResponseObject;
+};
+export type GetProgramResponse = GetProgramResponses[keyof GetProgramResponses];
 export type UpdateProgramData = {
     body?: ApprenticeshipProgramUpdateParameters;
     path: {
@@ -13402,6 +13576,64 @@ export type CreateWageScheduleResponses = {
     201: ApprenticeshipWageScheduleResponseObject;
 };
 export type CreateWageScheduleResponse = CreateWageScheduleResponses[keyof CreateWageScheduleResponses];
+export type DeleteWageScheduleData = {
+    body?: never;
+    path: {
+        occupation_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules/{id}';
+};
+export type DeleteWageScheduleErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type DeleteWageScheduleError = DeleteWageScheduleErrors[keyof DeleteWageScheduleErrors];
+export type DeleteWageScheduleResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteWageScheduleResponse = DeleteWageScheduleResponses[keyof DeleteWageScheduleResponses];
+export type GetWageScheduleData = {
+    body?: never;
+    path: {
+        occupation_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/apprenticeship/occupations/{occupation_id}/wage_schedules/{id}';
+};
+export type GetWageScheduleErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetWageScheduleError = GetWageScheduleErrors[keyof GetWageScheduleErrors];
+export type GetWageScheduleResponses = {
+    /**
+     * Success
+     */
+    200: ApprenticeshipWageScheduleResponseObject;
+};
+export type GetWageScheduleResponse = GetWageScheduleResponses[keyof GetWageScheduleResponses];
 export type UpdateWageScheduleData = {
     body?: ApprenticeshipWageScheduleUpdateParameters;
     path: {
@@ -18566,7 +18798,7 @@ export type ListJobsData = {
          */
         'filter[production_tracking_kind]'?: 'none' | 'feature' | 'quantity';
         /**
-         * Returns jobs whose name contains this substring (case-insensitive). Matches the name column only — not display ID, company, or site names.
+         * Fuzzy-matches the job name (trigram word-similarity). Matches the name column only — not display ID, company, or site names.
          */
         'filter[name]'?: string;
         /**
@@ -20035,6 +20267,36 @@ export type CreatePayRateRulePackageResponses = {
     201: PayRatesRulePackageResponseObject;
 };
 export type CreatePayRateRulePackageResponse = CreatePayRateRulePackageResponses[keyof CreatePayRateRulePackageResponses];
+export type DeletePayRateRulePackageData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{id}';
+};
+export type DeletePayRateRulePackageErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type DeletePayRateRulePackageError = DeletePayRateRulePackageErrors[keyof DeletePayRateRulePackageErrors];
+export type DeletePayRateRulePackageResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeletePayRateRulePackageResponse = DeletePayRateRulePackageResponses[keyof DeletePayRateRulePackageResponses];
 export type GetPayRateRulePackageData = {
     body?: never;
     path: {
@@ -20061,6 +20323,40 @@ export type GetPayRateRulePackageResponses = {
     200: PayRatesRulePackageResponseObject;
 };
 export type GetPayRateRulePackageResponse = GetPayRateRulePackageResponses[keyof GetPayRateRulePackageResponses];
+export type UpdatePayRateRulePackageData = {
+    body?: PayRatesRulePackageUpdateParameters;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/pay/rates/rule_packages/{id}';
+};
+export type UpdatePayRateRulePackageErrors = {
+    /**
+     * Bad Request
+     */
+    400: Problem;
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type UpdatePayRateRulePackageError = UpdatePayRateRulePackageErrors[keyof UpdatePayRateRulePackageErrors];
+export type UpdatePayRateRulePackageResponses = {
+    /**
+     * Success
+     */
+    200: PayRatesRulePackageResponseObject;
+};
+export type UpdatePayRateRulePackageResponse = UpdatePayRateRulePackageResponses[keyof UpdatePayRateRulePackageResponses];
 export type ListAggregateTimeImportsData = {
     body?: never;
     path: {
@@ -22735,6 +23031,10 @@ export type ListProjectsData = {
          * Return only projects whose external_id matches this value exactly.
          */
         'filter[external_id]'?: string;
+        /**
+         * Fuzzy-matches the project name (trigram word-similarity). Matches the name column only — not external_id.
+         */
+        'filter[name]'?: string;
         'filter[created_at][gte]'?: string;
         'filter[created_at][lte]'?: string;
         'filter[updated_at][gte]'?: string;
@@ -22898,6 +23198,32 @@ export type CreateCompanyUserDetailResponses = {
     201: PwaCompanyUserDetailsResponseObject;
 };
 export type CreateCompanyUserDetailResponse = CreateCompanyUserDetailResponses[keyof CreateCompanyUserDetailResponses];
+export type DeleteCompanyUserDetailData = {
+    body?: never;
+    path: {
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/pwa/company_user_details/{id}';
+};
+export type DeleteCompanyUserDetailErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type DeleteCompanyUserDetailError = DeleteCompanyUserDetailErrors[keyof DeleteCompanyUserDetailErrors];
+export type DeleteCompanyUserDetailResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeleteCompanyUserDetailResponse = DeleteCompanyUserDetailResponses[keyof DeleteCompanyUserDetailResponses];
 export type UpdateCompanyUserDetailData = {
     body: PwaCompanyUserDetailsUpdateParameters;
     path: {
@@ -23375,6 +23701,10 @@ export type CreatePositionErrors = {
      * Forbidden
      */
     403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
     /**
      * Unprocessable Content
      */
@@ -23388,6 +23718,64 @@ export type CreatePositionResponses = {
     201: PositionResponseObject;
 };
 export type CreatePositionResponse = CreatePositionResponses[keyof CreatePositionResponses];
+export type DeletePositionData = {
+    body?: never;
+    path: {
+        job_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/jobs/{job_id}/positions/{id}';
+};
+export type DeletePositionErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+    /**
+     * Unprocessable Content
+     */
+    422: Problem;
+};
+export type DeletePositionError = DeletePositionErrors[keyof DeletePositionErrors];
+export type DeletePositionResponses = {
+    /**
+     * No Content
+     */
+    204: void;
+};
+export type DeletePositionResponse = DeletePositionResponses[keyof DeletePositionResponses];
+export type GetPositionData = {
+    body?: never;
+    path: {
+        job_id: string;
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/jobs/{job_id}/positions/{id}';
+};
+export type GetPositionErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetPositionError = GetPositionErrors[keyof GetPositionErrors];
+export type GetPositionResponses = {
+    /**
+     * Success
+     */
+    200: PositionResponseObject;
+};
+export type GetPositionResponse = GetPositionResponses[keyof GetPositionResponses];
 export type UpdatePositionData = {
     body?: PositionParameters;
     path: {
@@ -24176,6 +24564,35 @@ export type DeleteTimeEntryResponses = {
     200: TimeEntryResponseObject;
 };
 export type DeleteTimeEntryResponse = DeleteTimeEntryResponses[keyof DeleteTimeEntryResponses];
+export type GetTimeEntryData = {
+    body?: never;
+    path: {
+        /**
+         * Unique identifier of the time entry.
+         */
+        id: string;
+    };
+    query?: never;
+    url: '/api/v1/time_entries/{id}';
+};
+export type GetTimeEntryErrors = {
+    /**
+     * Forbidden
+     */
+    403: Problem;
+    /**
+     * Not Found
+     */
+    404: Problem;
+};
+export type GetTimeEntryError = GetTimeEntryErrors[keyof GetTimeEntryErrors];
+export type GetTimeEntryResponses = {
+    /**
+     * Success
+     */
+    200: TimeEntryResponseObject;
+};
+export type GetTimeEntryResponse = GetTimeEntryResponses[keyof GetTimeEntryResponses];
 export type UpdateTimeEntryData = {
     body: TimeEntryUpdateParameters;
     path: {