@factorialco/api-client 4.0.0-beta.2027010101 → 4.0.0-beta.2027010102

package/dist/cjs/sdk.js

@@ -17,11 +17,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
     for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
 };
 Object.defineProperty(exports, "__esModule", { value: true });
-exports.ContractsReferenceContractsResource = exports.ContractsPortugueseContractTypesResource = exports.ContractsMaterializedTemplatesResource = exports.ContractsLegalEntityChangesResource = exports.ContractsGermanContractTypesResource = exports.ContractsFrenchContractTypesResource = exports.ContractsContractsResource = exports.ContractsContractVersionsResource = exports.ContractsContractVersionMetaDataResource = exports.ContractsContractVersionHistoriesResource = exports.ContractsContractTemplatesResource = exports.ContractsContractActivityPeriodsResource = exports.ContractsCompensationsResource = exports.CompensationsPayrollRunsResource = exports.CompensationsPayrollRunEmployeesCompensationsResource = exports.CompensationsPayrollResultsResource = exports.CompensationsEmployeesCompensationsResource = exports.CompensationsCyclesResource = exports.CompensationsConceptsResource = exports.CompensationsAdditionalCompensationsResource = exports.CompaniesLegalEntitiesResource = exports.BookkeepersManagementIncidencesResource = exports.BankingTransactionsResource = exports.BankingCardPaymentsResource = exports.BankingBankAccountsResource = exports.AttendanceWorkedTimesResource = exports.AttendanceShiftsResource = exports.AttendanceReviewsResource = exports.AttendanceOvertimeRequestsResource = exports.AttendanceOpenShiftsResource = exports.AttendanceEstimatedTimesResource = exports.AttendanceEditTimesheetRequestsResource = exports.AttendanceBreakConfigurationsResource = exports.AtsRejectionReasonsResource = exports.AtsQuestionsResource = exports.AtsMessagesResource = exports.AtsJobPostingsResource = exports.AtsHiringStagesResource = exports.AtsFeedbacksResource = exports.AtsEvaluationFormsResource = exports.AtsCandidatesResource = exports.AtsCandidateSourcesResource = exports.AtsApplicationsResource = exports.AtsApplicationPhasesResource = exports.AtsAnswersResource = exports.ApprovalsMaterializedApprovalsFlowsResource = exports.ApiPublicWebhookSubscriptionsResource = exports.ApiPublicCredentialsResource = exports.isFactorialApiError = exports.FactorialApiError = void 0;
-exports.JobCatalogRolesResource = exports.JobCatalogNodeAttributesResource = exports.JobCatalogLevelsResource = exports.ItManagementItAssetsResource = exports.ItManagementItAssetModelsResource = exports.ItManagementAssetCategoriesResource = exports.IntegrationsSyncableSyncRunsResource = exports.IntegrationsSyncableStatesResource = exports.IntegrationsSyncRunsResource = exports.IntegrationsSyncRunOutputsResource = exports.HolidaysCompanyHolidaysResource = exports.FinanceTaxTypesResource = exports.FinanceTaxRatesResource = exports.FinanceLedgerAccountResourcesResource = exports.FinanceJournalLinesResource = exports.FinanceJournalEntriesResource = exports.FinanceFinancialDocumentsResource = exports.FinanceCostCentersResource = exports.FinanceCostCenterMembershipsResource = exports.FinanceContactsResource = exports.FinanceCategoriesResource = exports.FinanceBudgetOptionsResource = exports.FinanceAccountsResource = exports.FinanceAccountingSettingsResource = exports.ExpensesPerDiemsResource = exports.ExpensesMileagesResource = exports.ExpensesExpensesResource = exports.ExpensesExpensablesResource = exports.EmployeesEmployeesResource = exports.EmployeeUpdatesTerminationsResource = exports.EmployeeUpdatesSummariesResource = exports.EmployeeUpdatesPersonalChangesResource = exports.EmployeeUpdatesNewHiresResource = exports.EmployeeUpdatesContractChangesResource = exports.EmployeeUpdatesAbsencesResource = exports.DocumentsFoldersResource = exports.DocumentsDownloadUrlsResource = exports.DocumentsDocumentsResource = exports.CustomResourcesValuesResource = exports.CustomResourcesSchemasResource = exports.CustomResourcesResourcesResource = exports.CustomFieldsValuesResource = exports.CustomFieldsResourceFieldsResource = exports.CustomFieldsOptionsResource = exports.CustomFieldsFieldsResource = exports.ContractsTaxonomiesResource = exports.ContractsSpanishWorkingDayTypesResource = exports.ContractsSpanishProfessionalCategoriesResource = exports.ContractsSpanishEducationLevelsResource = exports.ContractsSpanishContractTypesResource = void 0;
-exports.ShiftManagementShiftsResource = exports.ProjectManagementTimeRecordsResource = exports.ProjectManagementSubprojectsResource = exports.ProjectManagementRatesResource = exports.ProjectManagementProjectsResource = exports.ProjectManagementProjectWorkersResource = exports.ProjectManagementProjectTasksResource = exports.ProjectManagementPlannedRecordsResource = exports.ProjectManagementImputableProjectsResource = exports.ProjectManagementExportableExpensesResource = exports.ProjectManagementExpenseRecordsResource = exports.ProjectManagementBudgetStrategiesResource = exports.ProcurementTypesResource = exports.ProcurementPurchaseRequestsResource = exports.ProcurementPurchaseOrdersResource = exports.ProcurementPoTemplatesResource = exports.ProcurementPoTemplateVersionsResource = exports.ProcurementPoTemplateFieldDefinitionsResource = exports.ProcurementPoLineItemsResource = exports.ProcurementPoFieldValuesResource = exports.ProcessesProcessesResource = exports.ProcessesMaterializedProcessesResource = exports.PostsPostsResource = exports.PostsGroupsResource = exports.PostsCommentsResource = exports.PerformanceTargetManagersResource = exports.PerformanceReviewVisibilitySettingsResource = exports.PerformanceReviewQuestionnaireByStrategiesResource = exports.PerformanceReviewProcessesResource = exports.PerformanceReviewProcessTargetsResource = exports.PerformanceReviewProcessEstimatedTargetsResource = exports.PerformanceReviewProcessCustomTemplatesResource = exports.PerformanceReviewOwnersResource = exports.PerformanceReviewEvaluationsResource = exports.PerformanceReviewEvaluationScoresResource = exports.PerformanceReviewEvaluationAnswersResource = exports.PerformanceEmployeeScoreScalesResource = exports.PerformanceCompanyEmployeeScoreScalesResource = exports.PerformanceAgreementsResource = exports.PayrollIntegrationsBaseCodesResource = exports.PayrollEmployeesIdentifiersResource = exports.PayrollEmployeesGermanEmployeeDataResource = exports.PayrollSupplementsResource = exports.PayrollPolicyPeriodsResource = exports.PayrollFamilySituationsResource = exports.MarketplaceInstallationsResource = exports.MarketplaceInstallationSettingsResource = exports.LocationsWorkAreasResource = exports.LocationsLocationsResource = exports.JobCatalogTreeNodesResource = void 0;
-exports.MarketplaceNamespace = exports.LocationsNamespace = exports.JobCatalogNamespace = exports.ItManagementNamespace = exports.IntegrationsNamespace = exports.HolidaysNamespace = exports.FinanceNamespace = exports.ExpensesNamespace = exports.EmployeesNamespace = exports.EmployeeUpdatesNamespace = exports.DocumentsNamespace = exports.CustomResourcesNamespace = exports.CustomFieldsNamespace = exports.ContractsNamespace = exports.CompensationsNamespace = exports.CompaniesNamespace = exports.BookkeepersManagementNamespace = exports.BankingNamespace = exports.AttendanceNamespace = exports.AtsNamespace = exports.ApprovalsNamespace = exports.ApiPublicNamespace = exports.WorkScheduleSchedulesResource = exports.WorkScheduleOverlapPeriodsResource = exports.WorkScheduleDayConfigurationsResource = exports.TrainingsTrainingsResource = exports.TrainingsTrainingMembershipsResource = exports.TrainingsTrainingClassesResource = exports.TrainingsSessionsResource = exports.TrainingsSessionAttendancesResource = exports.TrainingsSessionAccessMembershipsResource = exports.TrainingsCategoriesResource = exports.TimeoffPolicyTimelinesResource = exports.TimeoffPolicyAssignmentsResource = exports.TimeoffPoliciesResource = exports.TimeoffLeavesResource = exports.TimeoffLeaveTypesResource = exports.TimeoffFrenchLeaveDayCountsResource = exports.TimeoffBlockedPeriodsResource = exports.TimeoffAllowancesResource = exports.TimeoffAllowanceStatsResource = exports.TimeoffAllowanceIncidencesResource = exports.TimeSettingsSplitCustomTimeRangeCategoriesResource = exports.TimeSettingsBreakConfigurationsResource = exports.TimePlanningPlanningVersionsResource = exports.TimePlanningPlannedBreaksResource = exports.TeamsTeamsResource = exports.TeamsMembershipsResource = exports.TasksTasksResource = exports.TasksTaskFilesResource = void 0;
-exports.FactorialClient = exports.WorkScheduleNamespace = exports.TrainingsNamespace = exports.TimeoffNamespace = exports.TimeSettingsNamespace = exports.TimePlanningNamespace = exports.TeamsNamespace = exports.TasksNamespace = exports.ShiftManagementNamespace = exports.ProjectManagementNamespace = exports.ProcurementNamespace = exports.ProcessesNamespace = exports.PostsNamespace = exports.PerformanceNamespace = exports.PayrollIntegrationsBaseNamespace = exports.PayrollEmployeesNamespace = exports.PayrollNamespace = void 0;
+exports.ContractsPortugueseContractTypesResource = exports.ContractsMaterializedTemplatesResource = exports.ContractsLegalEntityChangesResource = exports.ContractsGermanContractTypesResource = exports.ContractsFrenchContractTypesResource = exports.ContractsContractsResource = exports.ContractsContractVersionsResource = exports.ContractsContractVersionMetaDataResource = exports.ContractsContractVersionHistoriesResource = exports.ContractsContractTemplatesResource = exports.ContractsContractActivityPeriodsResource = exports.ContractsCompensationsResource = exports.CompensationsPayrollRunsResource = exports.CompensationsPayrollRunParticipantsResource = exports.CompensationsPayrollRunEmployeesCompensationsResource = exports.CompensationsPayrollResultsResource = exports.CompensationsEmployeesCompensationsResource = exports.CompensationsCyclesResource = exports.CompensationsConceptsResource = exports.CompensationsAdditionalCompensationsResource = exports.CompaniesLegalEntitiesResource = exports.BookkeepersManagementIncidencesResource = exports.BankingTransactionsResource = exports.BankingCardPaymentsResource = exports.BankingBankAccountsResource = exports.AttendanceWorkedTimesResource = exports.AttendanceShiftsResource = exports.AttendanceReviewsResource = exports.AttendanceOvertimeRequestsResource = exports.AttendanceOpenShiftsResource = exports.AttendanceEstimatedTimesResource = exports.AttendanceEditTimesheetRequestsResource = exports.AttendanceBreakConfigurationsResource = exports.AtsRejectionReasonsResource = exports.AtsQuestionsResource = exports.AtsMessagesResource = exports.AtsJobPostingsResource = exports.AtsHiringStagesResource = exports.AtsFeedbacksResource = exports.AtsEvaluationFormsResource = exports.AtsCandidatesResource = exports.AtsCandidateSourcesResource = exports.AtsApplicationsResource = exports.AtsApplicationPhasesResource = exports.AtsAnswersResource = exports.ApprovalsMaterializedApprovalsFlowsResource = exports.ApiPublicWebhookSubscriptionsResource = exports.ApiPublicCredentialsResource = exports.isFactorialApiError = exports.FactorialApiError = void 0;
+exports.JobCatalogNodeAttributesResource = exports.JobCatalogLevelsResource = exports.ItManagementItAssetsResource = exports.ItManagementItAssetModelsResource = exports.ItManagementAssetCategoriesResource = exports.IntegrationsSyncableSyncRunsResource = exports.IntegrationsSyncableStatesResource = exports.IntegrationsSyncRunsResource = exports.IntegrationsSyncRunOutputsResource = exports.HolidaysCompanyHolidaysResource = exports.FinanceTaxTypesResource = exports.FinanceTaxRatesResource = exports.FinanceLedgerAccountResourcesResource = exports.FinanceJournalLinesResource = exports.FinanceJournalEntriesResource = exports.FinanceFinancialDocumentsResource = exports.FinanceCostCentersResource = exports.FinanceCostCenterMembershipsResource = exports.FinanceContactsResource = exports.FinanceCategoriesResource = exports.FinanceBudgetOptionsResource = exports.FinanceAccountsResource = exports.FinanceAccountingSettingsResource = exports.ExpensesPerDiemsResource = exports.ExpensesMileagesResource = exports.ExpensesExpensesResource = exports.ExpensesExpensablesResource = exports.EmployeesEmployeesResource = exports.EmployeeUpdatesTerminationsResource = exports.EmployeeUpdatesSummariesResource = exports.EmployeeUpdatesPersonalChangesResource = exports.EmployeeUpdatesNewHiresResource = exports.EmployeeUpdatesContractChangesResource = exports.EmployeeUpdatesAbsencesResource = exports.DocumentsFoldersResource = exports.DocumentsDownloadUrlsResource = exports.DocumentsDocumentsResource = exports.CustomResourcesValuesResource = exports.CustomResourcesSchemasResource = exports.CustomResourcesResourcesResource = exports.CustomFieldsValuesResource = exports.CustomFieldsResourceFieldsResource = exports.CustomFieldsOptionsResource = exports.CustomFieldsFieldsResource = exports.ContractsTaxonomiesResource = exports.ContractsSpanishWorkingDayTypesResource = exports.ContractsSpanishProfessionalCategoriesResource = exports.ContractsSpanishEducationLevelsResource = exports.ContractsSpanishContractTypesResource = exports.ContractsReferenceContractsResource = void 0;
+exports.ProjectManagementTimeRecordsResource = exports.ProjectManagementSubprojectsResource = exports.ProjectManagementRatesResource = exports.ProjectManagementProjectsResource = exports.ProjectManagementProjectWorkersResource = exports.ProjectManagementProjectTasksResource = exports.ProjectManagementPlannedRecordsResource = exports.ProjectManagementImputableProjectsResource = exports.ProjectManagementExportableExpensesResource = exports.ProjectManagementExpenseRecordsResource = exports.ProjectManagementBudgetStrategiesResource = exports.ProcurementTypesResource = exports.ProcurementPurchaseRequestsResource = exports.ProcurementPurchaseOrdersResource = exports.ProcurementPoTemplatesResource = exports.ProcurementPoTemplateVersionsResource = exports.ProcurementPoTemplateFieldDefinitionsResource = exports.ProcurementPoLineItemsResource = exports.ProcurementPoFieldValuesResource = exports.ProcessesProcessesResource = exports.ProcessesMaterializedProcessesResource = exports.PostsPostsResource = exports.PostsGroupsResource = exports.PostsCommentsResource = exports.PerformanceTargetManagersResource = exports.PerformanceReviewVisibilitySettingsResource = exports.PerformanceReviewQuestionnaireByStrategiesResource = exports.PerformanceReviewProcessesResource = exports.PerformanceReviewProcessTargetsResource = exports.PerformanceReviewProcessEstimatedTargetsResource = exports.PerformanceReviewProcessCustomTemplatesResource = exports.PerformanceReviewOwnersResource = exports.PerformanceReviewEvaluationsResource = exports.PerformanceReviewEvaluationScoresResource = exports.PerformanceReviewEvaluationAnswersResource = exports.PerformanceEmployeeScoreScalesResource = exports.PerformanceCompanyEmployeeScoreScalesResource = exports.PerformanceAgreementsResource = exports.PayrollIntegrationsBaseCodesResource = exports.PayrollEmployeesIdentifiersResource = exports.PayrollEmployeesGermanEmployeeDataResource = exports.PayrollSupplementsResource = exports.PayrollPolicyPeriodsResource = exports.PayrollFamilySituationsResource = exports.MarketplaceInstallationsResource = exports.MarketplaceInstallationSettingsResource = exports.LocationsWorkAreasResource = exports.LocationsLocationsResource = exports.JobCatalogTreeNodesResource = exports.JobCatalogRolesResource = void 0;
+exports.LocationsNamespace = exports.JobCatalogNamespace = exports.ItManagementNamespace = exports.IntegrationsNamespace = exports.HolidaysNamespace = exports.FinanceNamespace = exports.ExpensesNamespace = exports.EmployeesNamespace = exports.EmployeeUpdatesNamespace = exports.DocumentsNamespace = exports.CustomResourcesNamespace = exports.CustomFieldsNamespace = exports.ContractsNamespace = exports.CompensationsNamespace = exports.CompaniesNamespace = exports.BookkeepersManagementNamespace = exports.BankingNamespace = exports.AttendanceNamespace = exports.AtsNamespace = exports.ApprovalsNamespace = exports.ApiPublicNamespace = exports.WorkScheduleSchedulesResource = exports.WorkScheduleOverlapPeriodsResource = exports.WorkScheduleDayConfigurationsResource = exports.TrainingsTrainingsResource = exports.TrainingsTrainingMembershipsResource = exports.TrainingsTrainingClassesResource = exports.TrainingsSessionsResource = exports.TrainingsSessionAttendancesResource = exports.TrainingsSessionAccessMembershipsResource = exports.TrainingsCategoriesResource = exports.TimeoffPolicyTimelinesResource = exports.TimeoffPolicyAssignmentsResource = exports.TimeoffPoliciesResource = exports.TimeoffLeavesResource = exports.TimeoffLeaveTypesResource = exports.TimeoffFrenchLeaveDayCountsResource = exports.TimeoffBlockedPeriodsResource = exports.TimeoffAllowancesResource = exports.TimeoffAllowanceStatsResource = exports.TimeoffAllowanceIncidencesResource = exports.TimeSettingsSplitCustomTimeRangeCategoriesResource = exports.TimeSettingsBreakConfigurationsResource = exports.TimePlanningPlanningVersionsResource = exports.TimePlanningPlannedBreaksResource = exports.TeamsTeamsResource = exports.TeamsMembershipsResource = exports.TasksTasksResource = exports.TasksTaskFilesResource = exports.ShiftManagementShiftsResource = void 0;
+exports.FactorialClient = exports.WorkScheduleNamespace = exports.TrainingsNamespace = exports.TimeoffNamespace = exports.TimeSettingsNamespace = exports.TimePlanningNamespace = exports.TeamsNamespace = exports.TasksNamespace = exports.ShiftManagementNamespace = exports.ProjectManagementNamespace = exports.ProcurementNamespace = exports.ProcessesNamespace = exports.PostsNamespace = exports.PerformanceNamespace = exports.PayrollIntegrationsBaseNamespace = exports.PayrollEmployeesNamespace = exports.PayrollNamespace = exports.MarketplaceNamespace = void 0;
 const index_js_1 = require("./generated/client/index.js");
 const errors_js_1 = require("./errors.js");
 const sdk_gen_js_1 = require("./generated/sdk.gen.js");
@@ -1138,6 +1138,34 @@ class CompensationsPayrollRunEmployeesCompensationsResource {
     get = (options) => (0, sdk_gen_js_1.getApi20270101ResourcesCompensationsPayrollRunEmployeesCompensationsById)({ client: this._client, ...options });
 }
 exports.CompensationsPayrollRunEmployeesCompensationsResource = CompensationsPayrollRunEmployeesCompensationsResource;
+/** Methods for the compensations > payroll_run_participants resource */
+class CompensationsPayrollRunParticipantsResource {
+    _client;
+    constructor(_client) {
+        this._client = _client;
+    }
+    /** Lists all payroll_run_participants */
+    list = (options) => (0, sdk_gen_js_1.getApi20270101ResourcesCompensationsPayrollRunParticipants)({ client: this._client, ...options });
+    /**
+     * Auto-paginate through all payroll_run_participants, yielding one item at a time.
+     * @example for await (const item of client.compensations.payrollRunParticipants.paginate()) { ... }
+     */
+    paginate(options) {
+        const { maxItems, limit, ...rest } = options ?? {};
+        return (0, pagination_js_1.paginate)(
+        // `limit`/`after_id` work at runtime but are absent from the spec's query type.
+        // eslint-disable-next-line @typescript-eslint/no-explicit-any
+        (params) => (0, sdk_gen_js_1.getApi20270101ResourcesCompensationsPayrollRunParticipants)({ client: this._client, ...rest, query: { ...rest.query, ...params } }), { maxItems, limit });
+    }
+    /**
+     * Fetch all payroll_run_participants across all pages into a single array.
+     * @example const all = await client.compensations.payrollRunParticipants.all()
+     */
+    all(options) {
+        return (0, pagination_js_1.collectAll)(this.paginate(options));
+    }
+}
+exports.CompensationsPayrollRunParticipantsResource = CompensationsPayrollRunParticipantsResource;
 /** Methods for the compensations > payroll_runs resource */
 class CompensationsPayrollRunsResource {
     _client;
@@ -5816,6 +5844,7 @@ class CompensationsNamespace {
     employeesCompensations;
     payrollResults;
     payrollRunEmployeesCompensations;
+    payrollRunParticipants;
     payrollRuns;
     constructor(client) {
         this.additionalCompensations = new CompensationsAdditionalCompensationsResource(client);
@@ -5824,6 +5853,7 @@ class CompensationsNamespace {
         this.employeesCompensations = new CompensationsEmployeesCompensationsResource(client);
         this.payrollResults = new CompensationsPayrollResultsResource(client);
         this.payrollRunEmployeesCompensations = new CompensationsPayrollRunEmployeesCompensationsResource(client);
+        this.payrollRunParticipants = new CompensationsPayrollRunParticipantsResource(client);
         this.payrollRuns = new CompensationsPayrollRunsResource(client);
     }
 }