brynq-sdk-acerta 1.1.1__py3-none-any.whl

brynq_sdk_acerta/salaries.py

@@ -0,0 +1,74 @@
+from typing import Dict, Any, Tuple
+import pandas as pd
+import requests
+from brynq_sdk_functions import Functions
+from .schemas.salaries import BasicSalaryGet, PatchBasicSalariesRequest
+from typing import TYPE_CHECKING
+if TYPE_CHECKING:
+	from .acerta import Acerta
+
+
+class Salaries:
+	"""Resource class for Agreement Basic Salaries endpoints"""
+
+	def __init__(self, acerta):
+		self.acerta: Acerta = acerta
+		self.base_uri = "agreement-data-management/v1/agreements"
+
+	def get(self) -> Tuple[pd.DataFrame, pd.DataFrame]:
+		"""
+		GET /agreement-data-management/v1/agreements/{agreementId}/basic-salaries - Basic Salaries
+
+		Retrieves basic salary history segments and their salary elements for all cached agreements.
+
+		Args:
+
+		Returns:
+			Tuple[pd.DataFrame, pd.DataFrame]: (valid_df, invalid_df) after normalizing and validating
+		"""
+		if not self.acerta._agreement_ids:
+			self.acerta.agreements.get()
+
+		frames = []
+		for agreement_id in self.acerta._agreement_ids:
+			response = self.acerta.session.get(
+				url=f"{self.acerta.base_url}/{self.base_uri}/{agreement_id}/basic-salaries",
+				timeout=self.acerta.TIMEOUT,
+			)
+			response.raise_for_status()
+			raw = response.json()
+			df = pd.json_normalize(
+				raw,
+				record_path=["basicSalaries", "basicSalaryElements"],
+				meta=["agreementId", ["basicSalaries", "period", "startDate"], ["basicSalaries", "period", "endDate"]],
+				errors="ignore",
+				sep=".",
+			)
+			frames.append(df)
+
+		combined = pd.concat(frames, ignore_index=True) if frames else pd.DataFrame()
+
+		valid_df, invalid_df = Functions.validate_data(combined, BasicSalaryGet)
+
+		return valid_df, invalid_df
+
+	def update(self, agreement_id: str, data: Dict[str, Any]) -> requests.Response:
+		"""
+		PATCH /agreement-data-management/v1/agreements/{agreementId}/basic-salaries - Basic Salaries
+
+		Update basic salary elements for a given agreement in a time window.
+		"""
+		nested_data = Functions.flat_to_nested_with_prefix(data, PatchBasicSalariesRequest)
+
+		# Validate the nested data
+		validated_data = PatchBasicSalariesRequest(**nested_data)
+
+		# Make API request
+		response = self.acerta.session.patch(
+			url=f"{self.acerta.base_url}/{self.base_uri}/{agreement_id}/basic-salaries",
+			json=validated_data.model_dump(by_alias=True, exclude_none=True),
+			timeout=self.acerta.TIMEOUT,
+		)
+		response.raise_for_status()
+
+		return response

brynq_sdk_acerta/schemas/__init__.py

@@ -0,0 +1,135 @@
+"""
+Schemas module for Acerta SDK
+"""
+
+from .agreement import AgreementGet, AgreementRemunerationBankAccountCreate, AgreementRemunerationBankAccountUpdate
+from .family import (
+    FamilyMemberGet,
+    FamilySituationGet,
+    FamilySituationUpdate,
+    FamilyMemberCreate,
+    FamilyMemberPersonalia,
+    FamilyMemberName,
+    FamilyMemberOther,
+    CivilStatus,
+    Partner,
+    DependantsChildren,
+    DependantsOver65,
+    DependantsOthers,
+    Dependants,
+    FiscalDetails
+)
+from .bank_account import BankAccountUpdate, BankOwner, OwnerName, BankDetails
+from .employee import (
+    AdditionalInformationGet,
+    AdditionalInformationUpdate,
+    PersonalDetailsGet,
+    PersonalDetailsUpdate,
+    EmployeeName,
+    EmployeeBirth,
+    AddressBase,
+    ContactBase,
+    EmergencyContactBase,
+    EmployeePersonalDetails,
+    EmployeeAddressDetails,
+    EmployeeAdditionalInformation,
+    EmployeeContactInformation,
+    EmployeeCivilStatus,
+    EmployeePartner,
+    EmployeeDependants,
+    EmployeeDependantsChildren,
+    EmployeeDependantsOver65,
+    EmployeeDependantsOthers,
+    EmployeeFiscalDetails,
+    EmployeeFamilySituation,
+    EmployeeBankDetails,
+    EmployeeForeignBankAccount,
+    EmployeeBankAccountOwner,
+    EmployeeBankAccount,
+    EmployeeCreate
+)
+from .contact_information import ContactInformationGet, ContactInformationUpdate, Contact, EmergencyContact
+from .address import AddressGet, AddressUpdate, Address, OfficialAddressUpdate, CorrespondenceAddressUpdate
+from .planning import CountryGet, BelgianCityGet
+from .employer import JointCommitteeGet, FunctionGet, SalaryCodeGet
+from .in_service import EmploymentCreate, EmploymentRehire
+from .cost_center import CostCenterGet, CostCenterCreate, CostCenterDescription, CostCenterPeriod
+from .salaries import BasicSalaryGet, PatchBasicSalariesRequest
+from .company_car import CompanyCarGet, CompanyCarCreate, CompanyCarUpdate
+
+__all__ = [
+    'AgreementGet',
+    'AgreementRemunerationBankAccountCreate',
+    'AgreementRemunerationBankAccountUpdate',
+    'FamilyMemberGet',
+    'FamilySituationGet',
+    'FamilySituationUpdate',
+    'FamilyMemberCreate',
+    'FamilyMemberPersonalia',
+    'FamilyMemberName',
+    'FamilyMemberOther',
+    'CivilStatus',
+    'Partner',
+    'DependantsChildren',
+    'DependantsOver65',
+    'DependantsOthers',
+    'Dependants',
+    'FiscalDetails',
+    'BankAccountLinkGet',
+    'BankAccountUpdate',
+    'BankOwner',
+    'OwnerName',
+    'BankDetails',
+    'EmployeeGet',
+    'ContactInformationGet',
+    'ContactInformationUpdate',
+    'Contact',
+    'EmergencyContact',
+    'AddressGet',
+    'AddressUpdate',
+    'Address',
+    'OfficialAddressUpdate',
+    'CorrespondenceAddressUpdate',
+    'AdditionalInformationGet',
+    'AdditionalInformationUpdate',
+    'PersonalDetailsGet',
+    'PersonalDetailsUpdate',
+    'EmployeeName',
+    'EmployeeBirth',
+    'AddressBase',
+    'ContactBase',
+    'EmergencyContactBase',
+    'EmployeePersonalDetails',
+    'EmployeeAddressDetails',
+    'EmployeeAdditionalInformation',
+    'EmployeeContactInformation',
+    'EmployeeCivilStatus',
+    'EmployeePartner',
+    'EmployeeDependants',
+    'EmployeeDependantsChildren',
+    'EmployeeDependantsOver65',
+    'EmployeeDependantsOthers',
+    'EmployeeFiscalDetails',
+    'EmployeeFamilySituation',
+    'EmployeeBankDetails',
+    'EmployeeForeignBankAccount',
+    'EmployeeBankAccountOwner',
+    'EmployeeBankAccount',
+    'EmployeeCreate',
+    'CountryGet',
+    'BelgianCityGet',
+    'JointCommitteeGet',
+    'FunctionGet',
+    'SalaryCodeGet',
+    'EmploymentCreate',
+    'EmploymentRehire',
+    'CostCenterGet',
+    'CostCenterCreate',
+    'CostCenterDescription',
+    'CostCenterPeriod',
+    'BasicSalaryGet',
+    'PatchBasicSalariesRequest',
+    'CompanyCarGet',
+    'CompanyCarCreate',
+    'CompanyCarUpdate'
+]

brynq_sdk_acerta/schemas/address.py

@@ -0,0 +1,80 @@
+"""
+Schema for GET /employee-data-management/v3/employees/{employeeId}/addresses
+"""
+
+import pandas as pd
+import pandera as pa
+from pandera.typing import Series
+from typing import Optional
+from pydantic import BaseModel, Field
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+
+
+class AddressGet(BrynQPanderaDataFrameModel):
+    """Schema for GET /employee-data-management/v3/employees/{employeeId}/addresses endpoint."""
+
+    # Employee identification
+    employee_id: Series[pd.StringDtype] = pa.Field(coerce=True, description="Employee identifier", alias="employeeId")
+
+    # Period information
+    period_start_date: Series[pd.StringDtype] = pa.Field(coerce=True, description="Address period start date", alias="period.startDate")
+    period_end_date: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Address period end date", alias="period.endDate")
+
+    # Official address
+    official_street: Series[pd.StringDtype] = pa.Field(coerce=True, description="Official address street", alias="officialAddress.street")
+    official_house_number: Series[pd.StringDtype] = pa.Field(coerce=True, description="Official address house number", alias="officialAddress.houseNumber")
+    official_post_box: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Official address post box", alias="officialAddress.postBox")
+    official_postal_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Official address postal code", alias="officialAddress.postalCode")
+    official_community: Series[pd.StringDtype] = pa.Field(coerce=True, description="Official address community", alias="officialAddress.community")
+    official_country_name: Series[pd.StringDtype] = pa.Field(coerce=True, description="Official address country name", alias="officialAddress.country.name")
+    official_country_nis_code: Series[pd.StringDtype] = pa.Field(coerce=True, description="Official address country NIS code", alias="officialAddress.country.NISCode")
+
+    # Correspondence address (nullable)
+    correspondence_street: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Correspondence address street", alias="correspondenceAddress.street")
+    correspondence_house_number: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Correspondence address house number", alias="correspondenceAddress.houseNumber")
+    correspondence_post_box: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Correspondence address post box", alias="correspondenceAddress.postBox")
+    correspondence_postal_code: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Correspondence address postal code", alias="correspondenceAddress.postalCode")
+    correspondence_community: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Correspondence address community", alias="correspondenceAddress.community")
+    correspondence_country_name: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Correspondence address country name", alias="correspondenceAddress.country.name")
+    correspondence_country_nis_code: Optional[Series[pd.StringDtype]] = pa.Field(coerce=True, nullable=True, description="Correspondence address country NIS code", alias="correspondenceAddress.country.NISCode")
+
+    class _Annotation:
+        primary_key = "employee_id"
+        foreign_keys = {}
+
+    class Config:
+        metadata = {"class": "Address", "dependencies": []}
+
+
+# Pydantic schemas for PATCH address
+# Uses json_schema_extra for prefix-based field mapping
+
+class Address(BaseModel):
+    """Reusable address schema (no prefix in field names)"""
+    street: str = Field(..., min_length=1, max_length=40, example="Bondgenotenlaan", description="Street name", alias="street")
+    house_number: str = Field(..., min_length=1, max_length=9, example="2", description="House number", alias="houseNumber")
+    post_box: Optional[str] = Field(None, min_length=1, max_length=4, example="A", description="Box number", alias="postBox")
+    postal_code: str = Field(..., min_length=1, max_length=14, example="3000", description="Postal code", alias="postalCode")
+    community: str = Field(..., min_length=1, max_length=35, example="Leuven", description="City name", alias="community")
+    country: str = Field(..., min_length=3, max_length=3, example="150", description="NIS Code of the country", alias="country")
+
+    class Config:
+        populate_by_name = True
+
+
+# Backward compatibility aliases
+OfficialAddressUpdate = Address
+CorrespondenceAddressUpdate = Address
+
+
+class AddressUpdate(BaseModel):
+    """Schema for PATCH /employee-data-management/v3/employees/{employeeId}/addresses endpoint"""
+    # Function parameters
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
+
+    from_date: Optional[str] = Field(None, example="2022-01-01", description="Date from which this information is valid", alias="fromDate")
+    official_address: Optional[Address] = Field(None, description="Official address of the employee", alias="officialAddress", json_schema_extra={"prefix": "official_address_"})
+    correspondence_address: Optional[Address] = Field(None, description="Correspondence address of the employee", alias="correspondenceAddress", json_schema_extra={"prefix": "correspondence_address_"})
+
+    class Config:
+        populate_by_name = True