@factorialco/api-client 3.0.0-beta.2026100128 → 3.0.0-beta.2026100129

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.
package/dist/cjs/sdk.js CHANGED
@@ -17,11 +17,11 @@ var __exportStar = (this && this.__exportStar) || function(m, exports) {
17
17
  for (var p in m) if (p !== "default" && !Object.prototype.hasOwnProperty.call(exports, p)) __createBinding(exports, m, p);
18
18
  };
19
19
  Object.defineProperty(exports, "__esModule", { value: true });
20
- exports.CustomFieldsFieldsResource = exports.ContractsTaxonomiesResource = exports.ContractsSpanishWorkingDayTypesResource = exports.ContractsSpanishProfessionalCategoriesResource = exports.ContractsSpanishEducationLevelsResource = exports.ContractsSpanishContractTypesResource = exports.ContractsReferenceContractsResource = exports.ContractsPortugueseContractTypesResource = exports.ContractsMaterializedTemplatesResource = exports.ContractsGermanContractTypesResource = exports.ContractsFrenchContractTypesResource = exports.ContractsContractVersionsResource = exports.ContractsContractVersionMetaDataResource = exports.ContractsContractVersionHistoriesResource = exports.ContractsContractTemplatesResource = exports.ContractsCompensationsResource = exports.CompensationsPayrollRunsResource = exports.CompensationsPayrollRunEmployeesCompensationsResource = exports.CompensationsPayrollResultsResource = exports.CompensationsEmployeesCompensationsResource = exports.CompensationsCyclesResource = exports.CompensationsConceptsResource = 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 = void 0;
21
- exports.MarketplaceInstallationsResource = exports.MarketplaceInstallationSettingsResource = exports.LocationsWorkAreasResource = exports.LocationsLocationsResource = exports.JobCatalogTreeNodesResource = exports.JobCatalogRolesResource = exports.JobCatalogNodeAttributesResource = exports.JobCatalogLevelsResource = exports.ItManagementItAssetsResource = exports.ItManagementItAssetModelsResource = exports.ItManagementAssetCategoriesResource = exports.IntegrationsSyncableSyncRunsResource = exports.IntegrationsSyncableStatesResource = exports.IntegrationsSyncableItemsResource = 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 = void 0;
22
- exports.TimeSettingsBreakConfigurationsResource = exports.TimePlanningPlanningVersionsResource = exports.TimePlanningPlannedBreaksResource = exports.TeamsTeamsResource = exports.TeamsMembershipsResource = exports.TasksTasksResource = exports.TasksTaskFilesResource = 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.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 = void 0;
23
- exports.ShiftManagementNamespace = exports.ProjectManagementNamespace = exports.ProcurementNamespace = exports.PostsNamespace = exports.PerformanceNamespace = exports.PayrollIntegrationsBaseNamespace = exports.PayrollEmployeesNamespace = exports.PayrollNamespace = 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 = void 0;
24
- exports.FactorialClient = exports.WorkScheduleNamespace = exports.TrainingsNamespace = exports.TimeoffNamespace = exports.TimeSettingsNamespace = exports.TimePlanningNamespace = exports.TeamsNamespace = exports.TasksNamespace = void 0;
20
+ exports.ContractsTaxonomiesResource = exports.ContractsSpanishWorkingDayTypesResource = exports.ContractsSpanishProfessionalCategoriesResource = exports.ContractsSpanishEducationLevelsResource = exports.ContractsSpanishContractTypesResource = exports.ContractsReferenceContractsResource = exports.ContractsPortugueseContractTypesResource = exports.ContractsMaterializedTemplatesResource = exports.ContractsGermanContractTypesResource = exports.ContractsFrenchContractTypesResource = exports.ContractsContractVersionsResource = exports.ContractsContractVersionMetaDataResource = exports.ContractsContractVersionHistoriesResource = exports.ContractsContractTemplatesResource = 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 = void 0;
21
+ exports.MarketplaceInstallationSettingsResource = exports.LocationsWorkAreasResource = exports.LocationsLocationsResource = exports.JobCatalogTreeNodesResource = exports.JobCatalogRolesResource = exports.JobCatalogNodeAttributesResource = exports.JobCatalogLevelsResource = exports.ItManagementItAssetsResource = exports.ItManagementItAssetModelsResource = exports.ItManagementAssetCategoriesResource = exports.IntegrationsSyncableSyncRunsResource = exports.IntegrationsSyncableStatesResource = exports.IntegrationsSyncableItemsResource = 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 = void 0;
22
+ exports.TimePlanningPlanningVersionsResource = exports.TimePlanningPlannedBreaksResource = exports.TeamsTeamsResource = exports.TeamsMembershipsResource = exports.TasksTasksResource = exports.TasksTaskFilesResource = 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.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 = void 0;
23
+ exports.ProjectManagementNamespace = exports.ProcurementNamespace = exports.PostsNamespace = exports.PerformanceNamespace = exports.PayrollIntegrationsBaseNamespace = exports.PayrollEmployeesNamespace = exports.PayrollNamespace = 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.TimeSettingsBreakConfigurationsResource = void 0;
24
+ exports.FactorialClient = exports.WorkScheduleNamespace = exports.TrainingsNamespace = exports.TimeoffNamespace = exports.TimeSettingsNamespace = exports.TimePlanningNamespace = exports.TeamsNamespace = exports.TasksNamespace = exports.ShiftManagementNamespace = void 0;
25
25
  const index_js_1 = require("./generated/client/index.js");
26
26
  const sdk_gen_js_1 = require("./generated/sdk.gen.js");
27
27
  __exportStar(require("./generated/types.gen.js"), exports);
@@ -855,6 +855,39 @@ class CompaniesLegalEntitiesResource {
855
855
  get = (options) => (0, sdk_gen_js_1.getApi20261001ResourcesCompaniesLegalEntitiesById)({ client: this._client, ...options });
856
856
  }
857
857
  exports.CompaniesLegalEntitiesResource = CompaniesLegalEntitiesResource;
858
+ /** Methods for the compensations > additional_compensations resource */
859
+ class CompensationsAdditionalCompensationsResource {
860
+ _client;
861
+ constructor(_client) {
862
+ this._client = _client;
863
+ }
864
+ /** Lists all additional_compensations */
865
+ list = (options) => (0, sdk_gen_js_1.getApi20261001ResourcesCompensationsAdditionalCompensations)({ client: this._client, ...options });
866
+ /**
867
+ * Auto-paginate through all additional_compensations, yielding one item at a time.
868
+ * @example for await (const item of client.compensations.additionalCompensations.paginate()) { ... }
869
+ */
870
+ paginate(options) {
871
+ const { maxItems, ...rest } = options ?? {};
872
+ return (0, pagination_js_1.paginate)((params) => (0, sdk_gen_js_1.getApi20261001ResourcesCompensationsAdditionalCompensations)({ client: this._client, ...rest, query: { ...rest?.query, ...params } }), { maxItems });
873
+ }
874
+ /**
875
+ * Fetch all additional_compensations across all pages into a single array.
876
+ * @example const all = await client.compensations.additionalCompensations.all()
877
+ */
878
+ all(options) {
879
+ return (0, pagination_js_1.collectAll)(this.paginate(options));
880
+ }
881
+ /** Creates a additional_compensations record */
882
+ create = (options) => (0, sdk_gen_js_1.postApi20261001ResourcesCompensationsAdditionalCompensations)({ client: this._client, ...options });
883
+ /** Reads a single additional_compensations record */
884
+ get = (options) => (0, sdk_gen_js_1.getApi20261001ResourcesCompensationsAdditionalCompensationsById)({ client: this._client, ...options });
885
+ /** Updates a additional_compensations record */
886
+ update = (options) => (0, sdk_gen_js_1.putApi20261001ResourcesCompensationsAdditionalCompensationsById)({ client: this._client, ...options });
887
+ /** Deletes a additional_compensations record */
888
+ delete = (options) => (0, sdk_gen_js_1.deleteApi20261001ResourcesCompensationsAdditionalCompensationsById)({ client: this._client, ...options });
889
+ }
890
+ exports.CompensationsAdditionalCompensationsResource = CompensationsAdditionalCompensationsResource;
858
891
  /** Methods for the compensations > concepts resource */
859
892
  class CompensationsConceptsResource {
860
893
  _client;
@@ -5157,6 +5190,7 @@ class CompaniesNamespace {
5157
5190
  exports.CompaniesNamespace = CompaniesNamespace;
5158
5191
  /** Namespace for all compensations resources */
5159
5192
  class CompensationsNamespace {
5193
+ additionalCompensations;
5160
5194
  concepts;
5161
5195
  cycles;
5162
5196
  employeesCompensations;
@@ -5164,6 +5198,7 @@ class CompensationsNamespace {
5164
5198
  payrollRunEmployeesCompensations;
5165
5199
  payrollRuns;
5166
5200
  constructor(client) {
5201
+ this.additionalCompensations = new CompensationsAdditionalCompensationsResource(client);
5167
5202
  this.concepts = new CompensationsConceptsResource(client);
5168
5203
  this.cycles = new CompensationsCyclesResource(client);
5169
5204
  this.employeesCompensations = new CompensationsEmployeesCompensationsResource(client);