@factorialco/api-client 3.0.0-beta.2026100104 → 3.0.0-beta.2026100105

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
@@ -732,6 +732,18 @@ export type AttendanceEditTimesheetRequest = {
732
732
  * Reference date for the shift
733
733
  */
734
734
  reference_date?: string;
735
+ /**
736
+ * Id of the workplace (location) for the shift
737
+ */
738
+ workplace_id?: string;
739
+ /**
740
+ * Id of the clock-in work area within the workplace
741
+ */
742
+ clock_in_work_area_id?: string;
743
+ /**
744
+ * Id of the clock-out work area within the workplace
745
+ */
746
+ clock_out_work_area_id?: string;
735
747
  };
736
748
  export type AttendanceEstimatedTime = {
737
749
  date: string;
@@ -1267,6 +1279,10 @@ export type CompaniesLegalEntity = {
1267
1279
  * Tax identification number
1268
1280
  */
1269
1281
  tin?: string;
1282
+ /**
1283
+ * SIRET number (France-specific). System for identifying French establishments. 14-digit identifier for each French establishment.
1284
+ */
1285
+ siret?: string;
1270
1286
  /**
1271
1287
  * City of the legal entity
1272
1288
  */
@@ -3369,6 +3385,10 @@ export type ExpensesMileage = {
3369
3385
  * The reimbursement rate per distance unit, in `currency`
3370
3386
  */
3371
3387
  rate?: string;
3388
+ /**
3389
+ * The distance unit the `rate` is denominated in (e.g. mi). The distance is converted into this unit before the rate is applied.
3390
+ */
3391
+ rate_measurement_unit?: string;
3372
3392
  /**
3373
3393
  * The origin location
3374
3394
  */
@@ -4148,6 +4168,32 @@ export type HolidaysCompanyHoliday = {
4148
4168
  */
4149
4169
  half_day?: 'beginning_of_day' | 'end_of_day';
4150
4170
  };
4171
+ export type IntegrationsSyncRun = {
4172
+ /**
4173
+ * Identifier of the sync run
4174
+ */
4175
+ id: string;
4176
+ /**
4177
+ * Status of the sync run
4178
+ */
4179
+ status: 'succeeded' | 'running' | 'errored' | 'succededwitherrors';
4180
+ /**
4181
+ * Timestamp when the sync run started
4182
+ */
4183
+ started_at: string;
4184
+ /**
4185
+ * Timestamp when the sync run finished
4186
+ */
4187
+ finished_at?: string;
4188
+ /**
4189
+ * Identifier of the company
4190
+ */
4191
+ company_id: string;
4192
+ /**
4193
+ * UUID of the marketplace integration
4194
+ */
4195
+ integration_uuid: string;
4196
+ };
4151
4197
  export type IntegrationsSyncRunOutput = {
4152
4198
  /**
4153
4199
  * Identifier of the sync run output
@@ -5855,7 +5901,7 @@ export type ProjectManagementSubproject = {
5855
5901
  /**
5856
5902
  * The status of the subproject
5857
5903
  */
5858
- status?: 'active' | 'closed' | 'draft' | 'processing';
5904
+ status: 'active' | 'closed' | 'draft' | 'processing';
5859
5905
  /**
5860
5906
  * The code of the subproject
5861
5907
  */
@@ -6200,6 +6246,9 @@ export type TimeoffAllowance = {
6200
6246
  * How the accrued units of the allowance are rounded. It depends if the allowance is set in hours or days.
6201
6247
  */
6202
6248
  rounding: 'half_day' | 'decimals' | 'quarters' | 'round_up';
6249
+ /**
6250
+ * Whether employees are notified when the allowance changes
6251
+ */
6203
6252
  send_notification?: boolean;
6204
6253
  /**
6205
6254
  * This field configures the type of allowance (fixed balance, based on worked time)
@@ -8911,18 +8960,66 @@ export type GetApi20261001ResourcesAttendanceEditTimesheetRequestsResponses = {
8911
8960
  export type GetApi20261001ResourcesAttendanceEditTimesheetRequestsResponse = GetApi20261001ResourcesAttendanceEditTimesheetRequestsResponses[keyof GetApi20261001ResourcesAttendanceEditTimesheetRequestsResponses];
8912
8961
  export type PostApi20261001ResourcesAttendanceEditTimesheetRequestsData = {
8913
8962
  body?: {
8963
+ /**
8964
+ * Id of the employee related.
8965
+ */
8914
8966
  employee_id: string;
8967
+ /**
8968
+ * Type of the request. Could be create_shift, update_shift or delete_shift.
8969
+ */
8915
8970
  request_type: 'create_shift' | 'delete_shift' | 'update_shift';
8971
+ /**
8972
+ * Reason or comment justifying the edit timesheet request.
8973
+ */
8916
8974
  reason?: string;
8975
+ /**
8976
+ * Date of the shift in case the request is to create a new shift.
8977
+ */
8917
8978
  date?: string;
8979
+ /**
8980
+ * Clock in of the shift in case is for create or edit a shift.
8981
+ */
8918
8982
  clock_in?: string;
8983
+ /**
8984
+ * Clock in of the shift in case is for create or edit a shift.
8985
+ */
8919
8986
  clock_out?: string;
8987
+ /**
8988
+ * If the shift is a workable shift or a break in case is for create or edit a shift.
8989
+ */
8920
8990
  workable?: boolean;
8991
+ /**
8992
+ * The id of the shift in case is for edit or delete a shift.
8993
+ */
8921
8994
  attendance_shift_id?: string;
8995
+ /**
8996
+ * Reference date of the shift in case is for create or edit a shift.
8997
+ */
8922
8998
  reference_date?: string;
8999
+ /**
9000
+ * Id of the break in case is for create or editing a break.
9001
+ */
8923
9002
  time_settings_break_configuration_id?: string;
9003
+ /**
9004
+ * Type of the location in case is for create or edit a shift.
9005
+ */
8924
9006
  location_type?: 'office' | 'business_trip' | 'work_from_home';
9007
+ /**
9008
+ * Shift observations in case is for create or edit a shift.
9009
+ */
8925
9010
  observations?: string;
9011
+ /**
9012
+ * Id of the workplace (location) for the shift.
9013
+ */
9014
+ workplace_id?: string;
9015
+ /**
9016
+ * Id of the clock-in work area within the workplace.
9017
+ */
9018
+ clock_in_work_area_id?: string;
9019
+ /**
9020
+ * Id of the clock-out work area within the workplace.
9021
+ */
9022
+ clock_out_work_area_id?: string;
8926
9023
  };
8927
9024
  path?: never;
8928
9025
  query?: never;
@@ -8970,19 +9067,67 @@ export type GetApi20261001ResourcesAttendanceEditTimesheetRequestsByIdResponses
8970
9067
  export type GetApi20261001ResourcesAttendanceEditTimesheetRequestsByIdResponse = GetApi20261001ResourcesAttendanceEditTimesheetRequestsByIdResponses[keyof GetApi20261001ResourcesAttendanceEditTimesheetRequestsByIdResponses];
8971
9068
  export type PutApi20261001ResourcesAttendanceEditTimesheetRequestsByIdData = {
8972
9069
  body?: {
9070
+ /**
9071
+ * The id of the shift.
9072
+ */
8973
9073
  attendance_shift_id?: string;
9074
+ /**
9075
+ * Clock in of the shift.
9076
+ */
8974
9077
  clock_in?: string;
9078
+ /**
9079
+ * Clock in of the shift.
9080
+ */
8975
9081
  clock_out?: string;
9082
+ /**
9083
+ * Date of the shift in case the request.
9084
+ */
8976
9085
  date?: string;
9086
+ /**
9087
+ * Reference date of the shift.
9088
+ */
8977
9089
  reference_date?: string;
9090
+ /**
9091
+ * Id of the employee related.
9092
+ */
8978
9093
  employee_id: string;
9094
+ /**
9095
+ * Id of the edit timesheet request to update.
9096
+ */
8979
9097
  id: string;
9098
+ /**
9099
+ * Type of the location.
9100
+ */
8980
9101
  location_type?: 'office' | 'business_trip' | 'work_from_home';
9102
+ /**
9103
+ * Shift observations.
9104
+ */
8981
9105
  observations?: string;
9106
+ /**
9107
+ * Reason or comment justifying the edit timesheet request.
9108
+ */
8982
9109
  reason?: string;
9110
+ /**
9111
+ * Id of the break.
9112
+ */
8983
9113
  time_settings_break_configuration_id?: string;
9114
+ /**
9115
+ * Id of the workplace (location) for the shift.
9116
+ */
9117
+ workplace_id?: string;
9118
+ /**
9119
+ * Id of the clock-in work area within the workplace.
9120
+ */
9121
+ clock_in_work_area_id?: string;
9122
+ /**
9123
+ * Id of the clock-out work area within the workplace.
9124
+ */
9125
+ clock_out_work_area_id?: string;
8984
9126
  };
8985
9127
  path: {
9128
+ /**
9129
+ * Id of the edit timesheet request to update.
9130
+ */
8986
9131
  id: string;
8987
9132
  };
8988
9133
  query?: never;
@@ -14543,6 +14688,35 @@ export type GetApi20261001ResourcesHolidaysCompanyHolidaysByIdResponses = {
14543
14688
  200: HolidaysCompanyHoliday;
14544
14689
  };
14545
14690
  export type GetApi20261001ResourcesHolidaysCompanyHolidaysByIdResponse = GetApi20261001ResourcesHolidaysCompanyHolidaysByIdResponses[keyof GetApi20261001ResourcesHolidaysCompanyHolidaysByIdResponses];
14691
+ export type GetApi20261001ResourcesIntegrationsSyncRunsData = {
14692
+ body?: never;
14693
+ path?: never;
14694
+ query: {
14695
+ /**
14696
+ * Identifier of the company
14697
+ */
14698
+ company_id: string;
14699
+ /**
14700
+ * UUIDs of the marketplace integrations to filter by
14701
+ */
14702
+ 'integration_uuids[]': Array<string>;
14703
+ /**
14704
+ * Filter sync runs by their creation timestamp (`created_at`), on or after this timestamp (inclusive).
14705
+ */
14706
+ created_at_gteq: string;
14707
+ };
14708
+ url: '/api/2026-10-01/resources/integrations/sync_runs';
14709
+ };
14710
+ export type GetApi20261001ResourcesIntegrationsSyncRunsResponses = {
14711
+ /**
14712
+ * OK
14713
+ */
14714
+ 200: {
14715
+ data?: Array<IntegrationsSyncRun>;
14716
+ meta?: PagedIndexMeta;
14717
+ };
14718
+ };
14719
+ export type GetApi20261001ResourcesIntegrationsSyncRunsResponse = GetApi20261001ResourcesIntegrationsSyncRunsResponses[keyof GetApi20261001ResourcesIntegrationsSyncRunsResponses];
14546
14720
  export type PostApi20261001ResourcesIntegrationsSyncRunOutputsData = {
14547
14721
  body?: {
14548
14722
  /**
@@ -16189,7 +16363,8 @@ export type GetApi20261001ResourcesPerformanceReviewEvaluationsData = {
16189
16363
  * Only evaluations where the participant is managed by the specified employee ID
16190
16364
  */
16191
16365
  with_targets_managed_by_filter?: {
16192
- [key: string]: unknown;
16366
+ manager_employee_id: string;
16367
+ only_direct_reports: boolean;
16193
16368
  };
16194
16369
  /**
16195
16370
  * Exclude evaluations by IDs
@@ -16985,7 +17160,8 @@ export type GetApi20261001ResourcesPerformanceReviewProcessTargetsData = {
16985
17160
  * Only participants managed by the specified employee ID
16986
17161
  */
16987
17162
  managed_by_filter?: {
16988
- [key: string]: unknown;
17163
+ manager_employee_id: string;
17164
+ only_direct_reports: boolean;
16989
17165
  };
16990
17166
  };
16991
17167
  url: '/api/2026-10-01/resources/performance/review_process_targets';
@@ -19071,7 +19247,7 @@ export type PutApi20261001ResourcesProjectManagementSubprojectsByIdData = {
19071
19247
  /**
19072
19248
  * The name of the subproject.
19073
19249
  */
19074
- name?: string;
19250
+ name: string;
19075
19251
  /**
19076
19252
  * The description of the subproject.
19077
19253
  */
@@ -19079,7 +19255,7 @@ export type PutApi20261001ResourcesProjectManagementSubprojectsByIdData = {
19079
19255
  /**
19080
19256
  * The status of the subproject.
19081
19257
  */
19082
- status?: 'active' | 'closed' | 'draft' | 'processing';
19258
+ status: 'active' | 'closed' | 'draft' | 'processing';
19083
19259
  /**
19084
19260
  * The code of the subproject.
19085
19261
  */
@@ -19141,6 +19317,10 @@ export type GetApi20261001ResourcesProjectManagementTimeRecordsData = {
19141
19317
  * Subproject ids to retrieve
19142
19318
  */
19143
19319
  'subproject_ids[]'?: Array<string>;
19320
+ /**
19321
+ * Project task ids to retrieve
19322
+ */
19323
+ 'project_task_ids[]'?: Array<string>;
19144
19324
  /**
19145
19325
  * Attendance shift ids to retrieve
19146
19326
  */
@@ -19157,6 +19337,9 @@ export type GetApi20261001ResourcesProjectManagementTimeRecordsData = {
19157
19337
  * Year to filter
19158
19338
  */
19159
19339
  year?: number;
19340
+ /**
19341
+ * Retrieve only the time records created or updated after the date provided.
19342
+ */
19160
19343
  updated_after?: string;
19161
19344
  };
19162
19345
  url: '/api/2026-10-01/resources/project_management/time_records';
@@ -19173,9 +19356,30 @@ export type GetApi20261001ResourcesProjectManagementTimeRecordsResponses = {
19173
19356
  export type GetApi20261001ResourcesProjectManagementTimeRecordsResponse = GetApi20261001ResourcesProjectManagementTimeRecordsResponses[keyof GetApi20261001ResourcesProjectManagementTimeRecordsResponses];
19174
19357
  export type PostApi20261001ResourcesProjectManagementTimeRecordsData = {
19175
19358
  body?: {
19359
+ /**
19360
+ * Id of the project worker
19361
+ */
19176
19362
  project_worker_id: string;
19363
+ /**
19364
+ * Id of the attendance shift
19365
+ */
19177
19366
  attendance_shift_id?: string;
19367
+ /**
19368
+ * Id of the subproject
19369
+ */
19178
19370
  subproject_id?: string;
19371
+ /**
19372
+ * Id of the project task assigned to the time record. Refers to project_management/project_tasks endpoint.
19373
+ */
19374
+ project_task_id?: string;
19375
+ /**
19376
+ * Imputed minutes for the time record (used when no attendance shift is provided)
19377
+ */
19378
+ imputed_minutes?: number;
19379
+ /**
19380
+ * Reference date for the time record (used when no attendance shift is provided)
19381
+ */
19382
+ date?: string;
19179
19383
  };
19180
19384
  path?: never;
19181
19385
  query?: never;
@@ -19253,11 +19457,46 @@ export type PostApi20261001ResourcesProjectManagementTimeRecordsBulkProcessRespo
19253
19457
  200: Array<ProjectManagementTimeRecord>;
19254
19458
  };
19255
19459
  export type PostApi20261001ResourcesProjectManagementTimeRecordsBulkProcessResponse = PostApi20261001ResourcesProjectManagementTimeRecordsBulkProcessResponses[keyof PostApi20261001ResourcesProjectManagementTimeRecordsBulkProcessResponses];
19460
+ export type PostApi20261001ResourcesProjectManagementTimeRecordsUpdateObservationsData = {
19461
+ body?: {
19462
+ /**
19463
+ * Id of the time record
19464
+ */
19465
+ id: string;
19466
+ /**
19467
+ * Comment for the time record
19468
+ */
19469
+ observations?: string;
19470
+ };
19471
+ path?: never;
19472
+ query?: never;
19473
+ url: '/api/2026-10-01/resources/project_management/time_records/update_observations';
19474
+ };
19475
+ export type PostApi20261001ResourcesProjectManagementTimeRecordsUpdateObservationsResponses = {
19476
+ /**
19477
+ * OK
19478
+ */
19479
+ 200: ProjectManagementTimeRecord;
19480
+ };
19481
+ export type PostApi20261001ResourcesProjectManagementTimeRecordsUpdateObservationsResponse = PostApi20261001ResourcesProjectManagementTimeRecordsUpdateObservationsResponses[keyof PostApi20261001ResourcesProjectManagementTimeRecordsUpdateObservationsResponses];
19256
19482
  export type PostApi20261001ResourcesProjectManagementTimeRecordsUpdateProjectWorkerData = {
19257
19483
  body?: {
19484
+ /**
19485
+ * Id of the time record
19486
+ */
19258
19487
  id: string;
19488
+ /**
19489
+ * Id of the project worker
19490
+ */
19259
19491
  project_worker_id: string;
19492
+ /**
19493
+ * Id of the subproject
19494
+ */
19260
19495
  subproject_id?: string;
19496
+ /**
19497
+ * Id of the project task assigned to the time record. Refers to project_management/project_tasks endpoint.
19498
+ */
19499
+ project_task_id?: string;
19261
19500
  };
19262
19501
  path?: never;
19263
19502
  query?: never;
@@ -20253,6 +20492,9 @@ export type GetApi20261001ResourcesTimeoffAllowancesByIdResponses = {
20253
20492
  export type GetApi20261001ResourcesTimeoffAllowancesByIdResponse = GetApi20261001ResourcesTimeoffAllowancesByIdResponses[keyof GetApi20261001ResourcesTimeoffAllowancesByIdResponses];
20254
20493
  export type PutApi20261001ResourcesTimeoffAllowancesByIdData = {
20255
20494
  body?: {
20495
+ /**
20496
+ * Unique identifier of the allowance to update
20497
+ */
20256
20498
  id: string;
20257
20499
  /**
20258
20500
  * Only for Allowances based on worked time. It represents how many units you need to work to be granted allowance units
@@ -20356,6 +20598,9 @@ export type PutApi20261001ResourcesTimeoffAllowancesByIdData = {
20356
20598
  unlimited_holidays?: boolean;
20357
20599
  };
20358
20600
  path: {
20601
+ /**
20602
+ * Unique identifier of the allowance to update
20603
+ */
20359
20604
  id: string;
20360
20605
  };
20361
20606
  query?: never;