brynq-sdk-nmbrs 2.3.1__py3-none-any.whl

brynq_sdk_nmbrs/salaries.py

@@ -0,0 +1,85 @@
+import math
+import pandas as pd
+import requests
+from typing import Dict, Any
+from brynq_sdk_functions import Functions
+from .schemas.salary import SalaryGet, SalaryCreate
+
+
+class Salaries:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self,
+            created_from: str = None,
+            employee_id: str = None) -> tuple[pd.DataFrame, pd.DataFrame]:
+        salaries = pd.DataFrame()
+        for company in self.nmbrs.company_ids:
+            salaries = pd.concat([salaries, self._get(company, created_from, employee_id)])
+
+        valid_salaries, invalid_salaries = Functions.validate_data(df=salaries, schema=SalaryGet, debug=True)
+
+        return valid_salaries, invalid_salaries
+
+    def _get(self,
+            company_id: str,
+            created_from: str = None,
+            employee_id: str = None) -> pd.DataFrame:
+        params = {}
+        if created_from:
+            params['createdFrom'] = created_from
+        if employee_id:
+            params['employeeId'] = employee_id
+        request = requests.Request(method='GET',
+                                   url=f"{self.nmbrs.base_url}companies/{company_id}/employees/salaries",
+                                   params=params)
+        data = self.nmbrs.get_paginated_result(request)
+        df = pd.json_normalize(
+            data,
+            record_path='salaries',
+            meta=['employeeId']
+        )
+        return df
+
+    def get_salary_tables(self,
+            salary_table_id: str) -> pd.DataFrame:
+        params = {}
+        request = requests.Request(method='GET',
+                                   url=f"{self.nmbrs.base_url}salarytable/{salary_table_id}",
+                                   params=params)
+        data = self.nmbrs.get_paginated_result(request)
+
+        df = pd.DataFrame(data)
+
+        return df
+
+    def create(self, employee_id: str, data: Dict[str, Any]):
+        """
+        Create a new salary for an employee using Pydantic validation.
+
+        Args:
+            employee_id: The ID of the employee
+            data: Dictionary containing salary data with fields matching
+                 the SalaryCreate schema (using camelCase field names)
+
+        Returns:
+            Response from the API
+        """
+        # Validate with Pydantic model
+        nested_data = self.nmbrs.flat_dict_to_nested_dict(data, SalaryCreate)
+        salary_model = SalaryCreate(**nested_data)
+
+        if self.nmbrs.mock_mode:
+            return salary_model
+
+        # Convert validated model to dict for API payload
+        payload = salary_model.model_dump_json(exclude_none=True, by_alias=True)
+
+        # Send request
+        resp = self.nmbrs.session.post(
+            url=f"{self.nmbrs.base_url}employees/{employee_id}/salary",
+            data=payload,
+            headers={"Content-Type": "application/json"},
+            timeout=self.nmbrs.timeout
+        )
+        return resp

brynq_sdk_nmbrs/salary_tables.py

@@ -0,0 +1,242 @@
+from typing import Dict, List, Union, Tuple
+import pandas as pd
+from zeep.exceptions import Fault
+from zeep.ns import WSDL, SOAP_ENV_11
+from zeep.xsd import ComplexType, Element, String
+from zeep.helpers import serialize_object
+# import logging
+from brynq_sdk_functions import Functions
+from .schemas.salary import SalaryTableGet, SalaryScalesGet, SalaryStepsGet
+
+
+class SalaryTables:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+        self.soap_client_companies = nmbrs.soap_client_companies
+
+    def get(self, period: int, year: int) -> (pd.DataFrame, pd.DataFrame):
+        """
+        Get salary tables for all companies for a specific period and year.
+
+        Args:
+            period (int): The period number
+            year (int): The year
+
+        Returns:
+            pd.DataFrame: DataFrame containing the salary tables
+        """
+        salary_tables = pd.DataFrame()
+        for company in self.nmbrs.soap_company_ids.to_dict(orient='records'):
+            salary_table_temp = self._get(company['i_d'], period, year)
+            if not salary_table_temp.empty:
+                salary_table_temp['companyId'] = company['number']
+                salary_tables = pd.concat([salary_tables, salary_table_temp])
+
+        valid_salary_tables, invalid_salary_tables = Functions.validate_data(df=salary_tables, schema=SalaryTableGet, debug=True)
+
+        # No validation schema for now, but could be added later
+        return valid_salary_tables, invalid_salary_tables
+
+    def _get(self, company_id: int, period: int, year: int) -> pd.DataFrame:
+        """
+        Get salary tables for a specific company, period and year.
+
+        Args:
+            company_id (int): The ID of the company
+            period (int): The period number
+            year (int): The year
+
+        Returns:
+            pd.DataFrame: DataFrame containing the salary tables
+        """
+        try:
+            # Make SOAP request with the proper header structure
+            response = self.soap_client_companies.service.SalaryTable2_Get(
+                CompanyId=company_id,
+                Period=period,
+                Year=year,
+                _soapheaders=[self.nmbrs.soap_auth_header]
+            )
+
+            # Convert response to DataFrame
+            if response:
+                # Convert Zeep objects to Python dictionaries
+                serialized_response = serialize_object(response)
+
+                # Convert to list if it's not already
+                if not isinstance(serialized_response, list):
+                    serialized_response = [serialized_response]
+
+                # Convert to DataFrame
+                df = pd.DataFrame(serialized_response)
+
+                return df
+            else:
+                return pd.DataFrame()
+
+        except Fault as e:
+            raise Exception(f"SOAP request failed: {str(e)}")
+        except Exception as e:
+            raise Exception(f"Failed to get salary tables: {str(e)}")
+
+
+class SalaryScales:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+        self.soap_client_companies = nmbrs.soap_client_companies
+
+    def get(self, period: int, year: int) -> (pd.DataFrame, pd.DataFrame):
+        """
+        Get salary scales for all companies for a specific period and year.
+
+        Args:
+            period (int): The period number
+            year (int): The year
+
+        Returns:
+            pd.DataFrame: DataFrame containing the salary scales
+        """
+        salary_scales = pd.DataFrame()
+        for company in self.nmbrs.soap_company_ids.to_dict(orient='records'):
+            salary_scale_temp = self._get(company['i_d'], period, year)
+            if not salary_scale_temp.empty:
+                salary_scale_temp['companyId'] = company['number']
+                salary_scales = pd.concat([salary_scales, salary_scale_temp])
+
+        valid_salary_scales, invalid_salary_scales = Functions.validate_data(df=salary_scales, schema=SalaryScalesGet, debug=True)
+
+        return valid_salary_scales, invalid_salary_scales
+
+    def _get(self, company_id: int, period: int, year: int) -> pd.DataFrame:
+        """
+        Get salary scales for a specific company, period and year.
+
+        Args:
+            company_id (int): The ID of the company
+            period (int): The period number
+            year (int): The year
+
+        Returns:
+            pd.DataFrame: DataFrame containing the salary scales
+        """
+        try:
+            # Make SOAP request with the proper header structure
+            response = self.soap_client_companies.service.SalaryTable2_GetScales(
+                CompanyId=company_id,
+                Period=period,
+                Year=year,
+                _soapheaders=[self.nmbrs.soap_auth_header]
+            )
+
+            # Convert response to DataFrame
+            if response:
+                # Convert Zeep objects to Python dictionaries
+                serialized_response = serialize_object(response)
+
+                # Convert to list if it's not already
+                if not isinstance(serialized_response, list):
+                    serialized_response = [serialized_response]
+
+                # Convert to DataFrame
+                df = pd.DataFrame(serialized_response)
+
+                return df
+            else:
+                return pd.DataFrame()
+
+        except Fault as e:
+            raise Exception(f"SOAP request failed: {str(e)}")
+        except Exception as e:
+            raise Exception(f"Failed to get salary scales: {str(e)}")
+
+
+class SalarySteps:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+        self.soap_client_companies = nmbrs.soap_client_companies
+
+    def get(self, period: int, year: int, scale: dict) -> (pd.DataFrame, pd.DataFrame):
+        """
+        Get salary steps for all companies for a specific period, year and scale.
+
+        Args:
+            period (int): The period number
+            year (int): The year
+            scale (dict): Dictionary containing scale information with keys:
+                - scale (str): The scale identifier (e.g., "Swapper")
+                - schaal_description (str): Description of the scale
+                - scale_value (float): The scale value
+                - scale_percentage_max (float): Maximum percentage
+                - scale_percentage_min (float): Minimum percentage
+
+        Returns:
+            pd.DataFrame: DataFrame containing the salary steps
+        """
+        salary_steps = pd.DataFrame()
+        for company in self.nmbrs.soap_company_ids.to_dict(orient='records'):
+            salary_steps_temp = self._get(company['i_d'], period, year, scale)
+            if not salary_steps_temp.empty:
+                salary_steps_temp['companyId'] = company['number']
+                salary_steps = pd.concat([salary_steps, salary_steps_temp])
+
+        valid_salary_steps, invalid_salary_steps = Functions.validate_data(df=salary_steps, schema=SalaryStepsGet, debug=True)
+
+        return valid_salary_steps, invalid_salary_steps
+
+    def _get(self, company_id: int, period: int, year: int, scale: dict) -> pd.DataFrame:
+        """
+        Get salary steps for a specific company, period, year and scale.
+
+        Args:
+            company_id (int): The ID of the company
+            period (int): The period number
+            year (int): The year
+            scale (dict): Dictionary containing scale information with keys:
+                - scale (str): The scale identifier (e.g., "Swapper")
+                - schaal_description (str): Description of the scale
+                - scale_value (float): The scale value
+                - scale_percentage_max (float): Maximum percentage
+                - scale_percentage_min (float): Minimum percentage
+
+        Returns:
+            pd.DataFrame: DataFrame containing the salary steps
+        """
+        try:
+            # Make SOAP request with the proper header structure
+            response = self.soap_client_companies.service.SalaryTable2_GetSteps(
+                CompanyId=company_id,
+                Period=period,
+                Year=year,
+                Scale={
+                    'Scale': scale.get('scale', ''),
+                    'SchaalDescription': scale.get('schaal_description', ''),
+                    'ScaleValue': scale.get('scale_value', 0),
+                    'ScalePercentageMax': scale.get('scale_percentage_max', 0),
+                    'ScalePercentageMin': scale.get('scale_percentage_min', 0)
+                },
+                _soapheaders=[self.nmbrs.soap_auth_header]
+            )
+
+            # Convert response to DataFrame
+            if response:
+                # Convert Zeep objects to Python dictionaries
+                serialized_response = serialize_object(response)
+
+                # Convert to list if it's not already
+                if not isinstance(serialized_response, list):
+                    serialized_response = [serialized_response]
+
+                # Convert to DataFrame
+                df = pd.DataFrame(serialized_response)
+
+
+                return df
+            else:
+                return pd.DataFrame()
+
+        except Fault as e:
+            # logger.exception(f"SOAP Fault: {str(e)}")
+            raise Exception(f"SOAP request failed: {str(e)}")
+        except Exception as e:
+            # logger.exception("Exception in SalarySteps.get:")
+            raise Exception(f"Failed to get salary steps: {str(e)}")

brynq_sdk_nmbrs/schedules.py

@@ -0,0 +1,84 @@
+import pandas as pd
+import requests
+import math
+from brynq_sdk_functions import Functions
+from .schemas.schedules import ScheduleGet, ScheduleCreate
+from datetime import datetime
+from typing import Dict, Any, Optional, Tuple
+
+
+class Schedule:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self,
+            created_from: str = None,
+            employee_id: str = None) -> Tuple[pd.DataFrame, pd.DataFrame]:
+        schedules = pd.DataFrame()
+        for company in self.nmbrs.company_ids:
+            schedules = pd.concat([schedules, self._get(company, created_from, employee_id)])
+
+        valid_schedules, invalid_schedules = Functions.validate_data(df=schedules, schema=ScheduleGet, debug=True)
+
+        return valid_schedules, invalid_schedules
+
+    def _get(self,
+            company_id: str,
+            created_from: str = None,
+            employee_id: str = None) -> pd.DataFrame:
+        params = {}
+        if created_from:
+            params['createdFrom'] = created_from
+        if employee_id:
+            params['employeeId'] = employee_id
+
+        request = requests.Request(method='GET',
+                                   url=f"{self.nmbrs.base_url}companies/{company_id}/employees/schedules",
+                                   params=params)
+
+        data = self.nmbrs.get_paginated_result(request)
+        df = pd.json_normalize(
+            data,
+            record_path='schedules',
+            meta=['employeeId']
+        )
+        return df
+
+    def create(self,
+               employee_id: str,
+               data: Dict[str, Any]):
+        """
+        Create a new schedule for an employee using Pydantic validation
+
+        Args:
+            employee_id: The employee ID
+            data: Schedule data dictionary with the following keys:
+                - start_date_schedule: Start date of the schedule
+                - weekly_hours: Hours per week (optional)
+                - hours_monday, hours_tuesday, etc.: Hours for each day
+
+        Returns:
+            Response from the API
+        """
+        # Validate with Pydantic schema
+        try:
+            nested_data = self.nmbrs.flat_dict_to_nested_dict(data, ScheduleCreate)
+            validated_data = ScheduleCreate(**nested_data)
+
+            if self.nmbrs.mock_mode:
+                return validated_data
+
+            # Convert validated model to dict for API payload
+            payload = validated_data.model_dump_json(exclude_none=True, by_alias=True)
+
+            # Use the validated data for the API call
+            resp = self.nmbrs.session.post(
+                url=f"{self.nmbrs.base_url}employees/{employee_id}/schedule",
+                data=payload,
+                timeout=self.nmbrs.timeout,
+                headers={'Content-Type': 'application/json'}
+            )
+            return resp
+
+        except Exception as e:
+            raise ValueError(f"Schedule validation failed: {str(e)}")

brynq_sdk_nmbrs/schemas/__init__.py

@@ -0,0 +1,37 @@
+"""Schema definitions for Nmbrs package"""
+
+DATEFORMAT = '%Y%m%d'
+
+from .address import AddressGet, AddressCreate
+from .bank import BankGet, BankCreate, BankUpdate, BankDelete
+from .contracts import ContractGet, ContractCreate, ContractUpdate, ContractDelete
+from .department import EmployeeDepartmentGet, DepartmentCreate, EmployeeDepartmentUpdate, DepartmentGet
+from .employees import EmployeeGet, EmployeeCreate, EmployeeUpdate, EmployeeDelete
+from .employment import EmploymentGet, EmploymentCreate, EmploymentUpdate, EmploymentDelete
+from .function import FunctionGet, FunctionUpdate
+from .hours import FixedHoursGet, FixedHoursCreate, FixedHoursUpdate, HoursDelete, VariableHoursGet, VariableHoursCreate, VariableHoursUpdate
+from .salary import SalaryGet, SalaryCreate
+from .manager import ManagerGet, ManagerBasicGet, EmployeeManagerGet, ManagerHistoricBasicGet, ManagerCreate, ManagerUpdate, ManagerDelete, UpdateEmployeeManager
+from .salary import SalaryGet, SalaryCreate
+from .wagecomponents import FixedWageComponentGet, FixedWageComponentCreate, FixedWageComponentUpdate, WageComponentDelete, VariableWageComponentGet, VariableWageComponentCreate, VariableWageComponentUpdate
+from .wage_tax import WageTaxGet, WageTaxUpdate
+
+
+__all__ = [
+    'DATEFORMAT',
+    'AddressGet', 'AddressCreate',
+    'BankGet', 'BankCreate', 'BankUpdate', 'BankDelete',
+    'ContractGet', 'ContractCreate', 'ContractUpdate', 'ContractDelete',
+    'EmployeeDepartmentGet', 'DepartmentCreate', 'EmployeeDepartmentUpdate', 'DepartmentGet',
+    'EmployeeGet', 'EmployeeCreate', 'EmployeeUpdate', 'EmployeeDelete',
+    'EmploymentGet', 'EmploymentCreate', 'EmploymentUpdate', 'EmploymentDelete',
+    'FunctionGet', 'FunctionUpdate',
+    'FixedHoursGet', 'FixedHoursCreate', 'FixedHoursUpdate', 'HoursDelete',
+    'VariableHoursGet', 'VariableHoursCreate', 'VariableHoursUpdate',
+    'ManagerGet', 'ManagerBasicGet', 'EmployeeManagerGet', 'ManagerHistoricBasicGet',
+    'ManagerCreate', 'ManagerUpdate', 'ManagerDelete', 'UpdateEmployeeManager',
+    'SalaryGet', 'SalaryCreate',
+    'FixedWageComponentGet', 'FixedWageComponentCreate', 'FixedWageComponentUpdate', 'WageComponentDelete',
+    'VariableWageComponentGet', 'VariableWageComponentCreate', 'VariableWageComponentUpdate',
+    'WageTaxGet', 'WageTaxUpdate'
+]

brynq_sdk_nmbrs/schemas/absence.py

@@ -0,0 +1,61 @@
+import math
+import pandas as pd
+import pandera as pa
+from pandera import Bool
+from pandera.typing import Series, String, Float, DateTime
+import pandera.extensions as extensions
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+from typing import Optional, Annotated
+from pydantic import BaseModel, Field, StringConstraints
+from datetime import datetime
+
+#<AbsenceId>int</AbsenceId>
+# <Comment>string</Comment>
+# <Percentage>int</Percentage>
+# <Start>dateTime</Start>
+# <RegistrationStartDate>dateTime</RegistrationStartDate>
+# <End>dateTime</End>
+# <RegistrationEndDate>dateTime</RegistrationEndDate>
+# <Dossier>string</Dossier>
+# <Dossiernr>int</Dossiernr>
+
+class AbsenceGet(BrynQPanderaDataFrameModel):
+    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="EmployeeId")
+    absence_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Absence ID", alias="AbsenceId")
+    comment: Series[String] = pa.Field(coerce=True, description="Comment", alias="Comment")
+    percentage: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Percentage", alias="Percentage")
+    start: Series[DateTime] = pa.Field(coerce=True, description="Start", alias="Start")
+    registration_start_date: Series[DateTime] = pa.Field(coerce=True, description="Registration Start Date", alias="RegistrationStartDate")
+    end: Series[DateTime] = pa.Field(coerce=True, description="End", alias="End")
+    registration_end_date: Series[DateTime] = pa.Field(coerce=True, description="Registration End Date", alias="RegistrationEndDate")
+    dossier: Series[String] = pa.Field(coerce=True, description="Dossier", alias="Dossier")
+    dossiernr: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Dossier Number", alias="Dossiernr")
+
+
+class AbsenceCreate(BaseModel):
+    employee_id: Optional[int] = Field(None, example="1234567890", description="Employee ID", alias="EmployeeId")
+    absence_id: int = Field(coerce=True, description="Absence ID", alias="AbsenceId")
+    comment: str = Field(coerce=True, description="Comment", alias="Comment")
+    percentage: int = Field(coerce=True, description="Percentage", alias="Percentage")
+    start: datetime = Field(coerce=True, description="Start", alias="Start")
+    registration_start_date: datetime = Field(coerce=True, description="Registration Start Date", alias="RegistrationStartDate")
+    end: datetime = Field(coerce=True, description="End", alias="End")
+    registration_end_date: datetime = Field(coerce=True, description="Registration End Date", alias="RegistrationEndDate")
+    dossier: str = Field(coerce=True, description="Dossier", alias="Dossier")
+    dossiernr: int = Field(coerce=True, description="Dossier Number", alias="Dossiernr")
+    new_dossier: bool = pa.Field(coerce=True, description="New Dossier", alias="NewDossier")
+
+
+    def to_soap_settings(self, soap_client):
+        """Convert to SOAP Absence object"""
+        AbsenceType = soap_client.get_type(
+            '{https://api.nmbrs.nl/soap/v3/EmployeeService}Absence'
+        )
+
+        # Get payload with alias renaming, excluding employee_id field
+        payload = self.model_dump(exclude_none=True, by_alias=True, exclude={'employee_id', 'new_dossier'})
+
+        return AbsenceType(**payload)
+
+    class Config:
+        populate_by_name = True

brynq_sdk_nmbrs/schemas/address.py

@@ -0,0 +1,76 @@
+import pandas as pd
+import pandera as pa
+from pandera import Bool
+from pandera.typing import Series, String, Float, DateTime
+import pandera.extensions as extensions
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+from typing import Optional, Annotated
+from pydantic import BaseModel, Field, StringConstraints
+
+# ---------------------------
+# Get Schemas
+# ---------------------------
+class AddressGet(BrynQPanderaDataFrameModel):
+    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    address_id: Series[String] = pa.Field(coerce=True, description="Address ID", alias="addressId")
+    is_default: Series[Bool] = pa.Field(coerce=True, description="Default Address", alias="isDefault")
+    type: Series[String] = pa.Field(
+        coerce=True,
+        isin=["homeAddress", "postAddress", "absenceAddress", "holidaysAddress", "weekendAddress", "workAddress"],
+        description="Address Type",
+        alias="type"
+    )
+    street: Series[String] = pa.Field(coerce=True, description="Street", alias="street")
+    house_number: Series[String] = pa.Field(coerce=True, nullable=True, description="House Number", alias="houseNumber")
+    house_number_addition: Series[String] = pa.Field(coerce=True, nullable=True, description="House Number Addition", alias="houseNumberAddition")
+    postal_code: Series[String] = pa.Field(coerce=True, description="Postal Code", alias="postalCode")
+    city: Series[String] = pa.Field(coerce=True, description="City", alias="city")
+    state_province: Series[String] = pa.Field(coerce=True, nullable=True, description="State or Province", alias="stateProvince")
+    country_i_s_o_code: Series[String] = pa.Field(coerce=True, nullable=True, description="Country ISO code", alias="countryISOCode")
+    period_year: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Year", alias="period.year")
+    period_period: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Period", alias="period.period")
+
+    class _Annotation:
+        primary_key = "address_id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeeSchema",
+                "parent_column": "employee_id",
+                "cardinality": "1:1"
+            }
+        }
+
+# ---------------------------
+# Upload Schemas
+# ---------------------------
+
+class Period(BaseModel):
+    year: int = Field(..., ge=1900, le=2100, example=2021, description="Year", alias="year")
+    period: int = Field(..., ge=1, le=53, example=4, description="Period", alias="period")
+
+class AddressCreate(BaseModel):
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
+    is_default: Optional[bool] = Field(None, description="Default Address", alias="isDefault")
+    type: Annotated[
+        str,
+        StringConstraints(
+            pattern=r'^(homeAddress|postAddress|absenceAddress|holidaysAddress|weekendAddress|workAddress)$',
+            strip_whitespace=True
+        )
+    ] = Field(..., example="homeAddress")
+    street: str = Field(..., min_length=1, max_length=200, example="Naritaweg", description="Street", alias="street")
+    house_number: Optional[str] = Field(None, max_length=20, example="70", description="House Number", alias="houseNumber")
+    house_number_addition: Optional[str] = Field(None, max_length=20, example="A", description="House Number Addition", alias="houseNumberAddition")
+    postal_code: Optional[str] = Field(None, max_length=15, example="1043BZ", description="Postal Code", alias="postalCode")
+    city: str = Field(..., min_length=1, max_length=100, example="Amsterdam", description="City", alias="city")
+    state_province: Optional[str] = Field(None, max_length=100, example="Noord-Holland", description="State or Province", alias="stateProvince")
+    country_code: Annotated[
+        str,
+        StringConstraints(
+            pattern=r'^[A-Za-z]+$',
+            strip_whitespace=True,
+            min_length=2,
+            max_length=3
+        )
+    ] = Field(..., example="NL", description="Country ISO Code", alias="countryISOCode")
+    period: Period

brynq_sdk_nmbrs/schemas/bank.py

@@ -0,0 +1,83 @@
+import pandas as pd
+import pandera as pa
+from pandera.typing import Series, String, Float, DateTime
+import pandera.extensions as extensions
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+from typing import Optional, Annotated
+from pydantic import BaseModel, Field, StringConstraints
+from enum import Enum
+
+# ---------------------------
+# Enums
+# ---------------------------
+class BankAccountType(str, Enum):
+    BANK_ACCOUNT_1 = "bankAccount1"
+    BANK_ACCOUNT_2 = "bankAccount2"
+    BANK_ACCOUNT_3 = "bankAccount3"
+    BANK_ACCOUNT_4 = "bankAccount4"
+    BANK_ACCOUNT_5 = "bankAccount5"
+    SALARY_SAVINGS = "salarySavings"
+    LIFECYCLE_SAVING_SCHEMES = "lifecycleSavingSchemes"
+    STANDARD = "standard"
+
+# ---------------------------
+# Get Schemas
+# ---------------------------
+class BankGet(BrynQPanderaDataFrameModel):
+    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    bank_account_id: Series[String] = pa.Field(coerce=True, nullable=True, description="Bank Account ID", alias="bankAccountId")
+    number: Series[String] = pa.Field(coerce=True, nullable=True, description="Bank Account Number", alias="number")
+    description: Series[String] = pa.Field(coerce=True, nullable=True, description="Bank Account Description", alias="description")
+    iban: Series[String] = pa.Field(coerce=True, nullable=True, description="IBAN", alias="IBAN")
+    city: Series[String] = pa.Field(coerce=True, nullable=True, description="City Bank", alias="city")
+    name: Series[String] = pa.Field(coerce=True, nullable=True, description="Name Bank", alias="name")
+    bank_account_type: Series[String] = pa.Field(
+        coerce=True,
+        isin=BankAccountType,
+        description="Bank Account Type",
+        alias="bankAccountType"
+    )
+    created_at: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Bank Account Created At", alias="createdAt")
+
+    class _Annotation:
+        primary_key = "bank_account_id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeeSchema",
+                "parent_column": "employee_id",
+                "cardinality": "1:1"
+            }
+        }
+
+# ---------------------------
+# Upload Schemas
+# ---------------------------
+class BankCreate(BaseModel):
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
+    number: Optional[str] = Field(None, max_length=34, example="123456789", description="Bank Account Number", alias="number")
+    description: Optional[str] = Field(None, max_length=100, example="Salary Bank", description="Bank Account Description", alias="description")
+    iban: str = Field(..., min_length=5, max_length=34, example="NL20INGB0001234567", description="IBAN", alias="IBAN")
+    city: Optional[str] = Field(None, max_length=100, example="Amsterdam", description="City Bank", alias="city")
+    name: Optional[str] = Field(None, max_length=100, example="ING Bank", description="Name Bank", alias="name")
+    bank_account_type: Optional[BankAccountType] = Field(None, example=BankAccountType.BANK_ACCOUNT_1.value, description="Bank Account Type", alias="bankAccountType")
+
+class BankUpdate(BaseModel):
+    employee_id: str = Field(..., description="Employee identifier", alias="employeeId")
+    bank_account_id: str = Field(..., example="49a69eda-252e-4ccb-a220-38ea90511d4f", description="Bank Account ID", alias="bankAccountId")
+    number: Optional[str] = Field(None, max_length=34, example="123456789", description="Bank Account Number", alias="number")
+    description: Optional[str] = Field(None, max_length=100, example="Main Checking Account", description="Bank Account Description", alias="description")
+    iban: Optional[str] = Field(None, min_length=5, max_length=34, example="NL20INGB0001234567", description="IBAN", alias="IBAN")
+    city: Optional[str] = Field(None, max_length=100, example="Rotterdam", description="City Bank", alias="city")
+    name: Optional[str] = Field(None, max_length=100, example="ABN AMRO", description="Name Bank", alias="name")
+    country_code: Optional[Annotated[
+        str,
+        StringConstraints(
+            pattern=r'^[A-Za-z]+$',
+            strip_whitespace=True,
+            min_length=2,
+            max_length=3
+        )
+    ]] = Field(None, example="NL", description="Country Code Bank", alias="countryCode")
+
+class BankDelete(BaseModel):
+    bank_account_id: str = Field(..., example="49a69eda-252e-4ccb-a220-38ea90511d4f", description="Bank Account ID")