@factorialco/api-client 4.0.0-beta.2027010111 → 4.0.0-beta.2027010113

package/dist/esm/generated/sdk.gen.d.ts

@@ -686,7 +686,7 @@ export declare const getApi20270101ResourcesCompensationsCyclesById: <ThrowOnErr
 /**
  * Reads all Employees compensations
  *
- * Retrieves employee compensations (result_type=compensation)
+ * Retrieves employee compensations (result_type=compensation). Listing requires at least one of the `ids`, `payroll_run_ids`, `cycle_ids`, `payroll_run_employee_ids` or `payroll_concept_ids` filters; a list request without any of them is rejected with a 400.
  */
 export declare const getApi20270101ResourcesCompensationsEmployeesCompensations: <ThrowOnError extends boolean = false>(options?: Options<GetApi20270101ResourcesCompensationsEmployeesCompensationsData, ThrowOnError>) => RequestResult<GetApi20270101ResourcesCompensationsEmployeesCompensationsResponses, GetApi20270101ResourcesCompensationsEmployeesCompensationsErrors, ThrowOnError>;
 /**
@@ -704,7 +704,7 @@ export declare const deleteApi20270101ResourcesCompensationsEmployeesCompensatio
 /**
  * Reads a single Employees compensation
  *
- * Retrieves employee compensations (result_type=compensation)
+ * Retrieves employee compensations (result_type=compensation). Listing requires at least one of the `ids`, `payroll_run_ids`, `cycle_ids`, `payroll_run_employee_ids` or `payroll_concept_ids` filters; a list request without any of them is rejected with a 400.
  */
 export declare const getApi20270101ResourcesCompensationsEmployeesCompensationsById: <ThrowOnError extends boolean = false>(options: Options<GetApi20270101ResourcesCompensationsEmployeesCompensationsByIdData, ThrowOnError>) => RequestResult<GetApi20270101ResourcesCompensationsEmployeesCompensationsByIdResponses, GetApi20270101ResourcesCompensationsEmployeesCompensationsByIdErrors, ThrowOnError>;
 /**
@@ -3394,7 +3394,7 @@ export declare const getApi20270101ResourcesTeamsMemberships: <ThrowOnError exte
 /**
  * Creates a Membership
  *
- * Assign an employee to a team, meaning create a membership. For companies with nested teams, two extra semantics apply. Propagation: memberships are inherited upwards, so after adding an employee to a sub-team, inherited membership rows for its ancestor teams are materialized asynchronously — rows you did not create will appear in later reads. Reuse: if the employee already has a membership row on that team (typically an inherited one), no new row is created — the employee becomes a direct member of the team, the `lead` flag is applied when you send one, and the existing row (with its existing id) is returned instead of a new resource. Omitting `lead` leaves a reused row's leadership as it was, so replaying an addition never demotes a current lead; a genuinely new row is created without it. The response is still `201` when an existing row is reused, so compare the returned `id` against what you already hold to tell the two cases apart.
+ * Assign an employee to a team, meaning create a membership. For companies with nested teams, two extra semantics apply. Propagation: memberships are inherited upwards, so after adding an employee to a sub-team, inherited membership rows for its ancestor teams are materialized asynchronously — rows you did not create will appear in later reads. Reuse: if the employee already has a membership row on that team (typically an inherited one), no new row is created — the employee becomes a direct member of the team and the existing row (with its existing id) is returned instead of a new resource. On a reused row, `lead: true` promotes the employee, while `lead: false` or omitting `lead` leaves their leadership as it was: an addition never demotes a current lead, so use the update endpoint to demote. A genuinely new row is created with the `lead` you send, or without it. The response is still `201` when an existing row is reused, so compare the returned `id` against what you already hold to tell the two cases apart.
  */
 export declare const postApi20270101ResourcesTeamsMemberships: <ThrowOnError extends boolean = false>(options?: Options<PostApi20270101ResourcesTeamsMembershipsData, ThrowOnError>) => RequestResult<PostApi20270101ResourcesTeamsMembershipsResponses, PostApi20270101ResourcesTeamsMembershipsErrors, ThrowOnError>;
 /**

package/dist/esm/generated/sdk.gen.js

@@ -1299,7 +1299,7 @@ export const getApi20270101ResourcesCompensationsCyclesById = (options) => (opti
 /**
  * Reads all Employees compensations
  *
- * Retrieves employee compensations (result_type=compensation)
+ * Retrieves employee compensations (result_type=compensation). Listing requires at least one of the `ids`, `payroll_run_ids`, `cycle_ids`, `payroll_run_employee_ids` or `payroll_concept_ids` filters; a list request without any of them is rejected with a 400.
  */
 export const getApi20270101ResourcesCompensationsEmployeesCompensations = (options) => (options?.client ?? client).get({
     security: [{ scheme: 'bearer', type: 'http' }, { name: 'x-api-key', type: 'apiKey' }],
@@ -1333,7 +1333,7 @@ export const deleteApi20270101ResourcesCompensationsEmployeesCompensationsById =
 /**
  * Reads a single Employees compensation
  *
- * Retrieves employee compensations (result_type=compensation)
+ * Retrieves employee compensations (result_type=compensation). Listing requires at least one of the `ids`, `payroll_run_ids`, `cycle_ids`, `payroll_run_employee_ids` or `payroll_concept_ids` filters; a list request without any of them is rejected with a 400.
  */
 export const getApi20270101ResourcesCompensationsEmployeesCompensationsById = (options) => (options.client ?? client).get({
     security: [{ scheme: 'bearer', type: 'http' }, { name: 'x-api-key', type: 'apiKey' }],
@@ -6221,7 +6221,7 @@ export const getApi20270101ResourcesTeamsMemberships = (options) => (options?.cl
 /**
  * Creates a Membership
  *
- * Assign an employee to a team, meaning create a membership. For companies with nested teams, two extra semantics apply. Propagation: memberships are inherited upwards, so after adding an employee to a sub-team, inherited membership rows for its ancestor teams are materialized asynchronously — rows you did not create will appear in later reads. Reuse: if the employee already has a membership row on that team (typically an inherited one), no new row is created — the employee becomes a direct member of the team, the `lead` flag is applied when you send one, and the existing row (with its existing id) is returned instead of a new resource. Omitting `lead` leaves a reused row's leadership as it was, so replaying an addition never demotes a current lead; a genuinely new row is created without it. The response is still `201` when an existing row is reused, so compare the returned `id` against what you already hold to tell the two cases apart.
+ * Assign an employee to a team, meaning create a membership. For companies with nested teams, two extra semantics apply. Propagation: memberships are inherited upwards, so after adding an employee to a sub-team, inherited membership rows for its ancestor teams are materialized asynchronously — rows you did not create will appear in later reads. Reuse: if the employee already has a membership row on that team (typically an inherited one), no new row is created — the employee becomes a direct member of the team and the existing row (with its existing id) is returned instead of a new resource. On a reused row, `lead: true` promotes the employee, while `lead: false` or omitting `lead` leaves their leadership as it was: an addition never demotes a current lead, so use the update endpoint to demote. A genuinely new row is created with the `lead` you send, or without it. The response is still `201` when an existing row is reused, so compare the returned `id` against what you already hold to tell the two cases apart.
  */
 export const postApi20270101ResourcesTeamsMemberships = (options) => (options?.client ?? client).post({
     security: [{ scheme: 'bearer', type: 'http' }, { name: 'x-api-key', type: 'apiKey' }],

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

@@ -8331,11 +8331,29 @@ export type TimeoffAllowanceStatsNew = {
      * Array of cycle objects describing each accrual period for the allowance.
      */
     cycles: Array<{
+        /**
+         * Virtual ID of the cycle, composed of allowance_id/start_at/end_at.
+         */
         id: string;
+        /**
+         * First day this counter covers for the employee. It is the latest of the policy cycle start (regular_start_at), the employee's hire date and the day the employee moved onto this policy, so it is later than regular_start_at when the counter opened part-way through the cycle (for example after a policy change).
+         */
         start_at: string;
+        /**
+         * Last day this counter covers for the employee. It is the earliest of the policy cycle end (regular_end_at), the employee's termination date and the day before the employee moved off this policy, so it is earlier than regular_end_at when the counter closed part-way through the cycle.
+         */
         end_at: string;
+        /**
+         * First day of the policy's own cycle, regardless of when the employee joined the policy.
+         */
         regular_start_at: string;
+        /**
+         * Last day of the policy's own cycle, regardless of when the employee left the policy.
+         */
         regular_end_at: string;
+        /**
+         * ID of the allowance this cycle belongs to.
+         */
         allowance_id: string;
     }>;
     /**
@@ -8421,7 +8439,7 @@ export type TimeoffAllowanceStatsNew = {
      */
     policy_allowance: string;
     /**
-     * Allowance days after proration based on employee tenure or configuration.
+     * Allowance days after proration based on employee tenure or configuration. When the allowance prorates (its proration_type is proration_enabled) and the counter covers only part of the cycle (cycles start_at/end_at differ from regular_start_at/regular_end_at, for example after a policy change), it counts only what accrues within those covered days, so it is a part-cycle share of policy_allowance rather than the full-cycle amount. With proration disabled the counter still gets the full policy_allowance over the covered days. Overtime and worked-time allowances are never prorated; they count what was earned in the covered days.
      */
     prorated_allowance_days: string;
     /**
@@ -8819,7 +8837,7 @@ export type TimePlanningPlanningVersion = {
      */
     effective_at: string;
     /**
-     * Type of planning tool (shift_management, work_schedules, contract_hours)
+     * Type of planning tool (shift_management, work_schedule, contract_hours)
      */
     planning_tool: string;
     /**
@@ -56125,7 +56143,7 @@ export type GetApi20270101ResourcesTimePlanningPlanningVersionsData = {
          */
         only_active: boolean;
         /**
-         * Type of planning tool (shift_management, work_schedules, contract_hours)
+         * Type of planning tool (shift_management, work_schedule, contract_hours)
          */
         planning_tool?: 'shift_management' | 'work_schedule' | 'contract_hours';
         /**
@@ -56203,7 +56221,7 @@ export type PostApi20270101ResourcesTimePlanningPlanningVersionsData = {
          */
         effective_at: string;
         /**
-         * Type of planning tool (shift_management, work_schedules, contract_hours)
+         * Type of planning tool (shift_management, work_schedule, contract_hours)
          */
         planning_tool: string;
         /**
@@ -56362,7 +56380,7 @@ export type PutApi20270101ResourcesTimePlanningPlanningVersionsByIdData = {
          */
         number_of_rest_days_in_cents?: number;
         /**
-         * Type of planning tool (shift_management, work_schedules, contract_hours)
+         * Type of planning tool (shift_management, work_schedule, contract_hours)
          */
         planning_tool: string;
         /**
@@ -56444,7 +56462,7 @@ export type PostApi20270101ResourcesTimePlanningPlanningVersionsBulkCreateData =
          */
         effective_at: string;
         /**
-         * Type of planning tool (shift_management, work_schedules, contract_hours)
+         * Type of planning tool (shift_management, work_schedule, contract_hours)
          */
         planning_tool: string;
         /**