brynq-sdk-nmbrs 2.3.3.dev0__py3-none-any.whl → 2.4.5__py3-none-any.whl

brynq_sdk_nmbrs/employees.py

@@ -1,9 +1,8 @@
 import logging
-from typing import Any, Dict, Optional
+from typing import Any, Dict, Tuple
 
 import pandas as pd
 import requests
-from pydantic import BaseModel
 from zeep.exceptions import Fault
 from zeep.helpers import serialize_object
 
@@ -23,19 +22,11 @@ from .leave import Leave, LeaveBalance
 from .salaries import Salaries
 from .schedules import Schedule
 from .schemas.employees import (
-    AdditionalEmployeeInfo,
-    BasicInfo,
-    BirthInfo,
     BsnGet,
-    ContactInfo,
-    CreateEmployeePersonalInfo,
     DefaultEmployeeTemplates,
     EmployeeCreate,
-    EmployeeDelete,
     EmployeeGet,
     EmployeeUpdate,
-    PartnerInfo,
-    Period,
 )
 from .wage_tax import WageTax
 from .wagecomponents import EmployeeFixedWageComponents, EmployeeVariableWageComponents
@@ -66,7 +57,7 @@ class Employees:
 
     def get(self,
             employee_type: str = None
-            ) -> (pd.DataFrame, pd.DataFrame):
+            ) -> Tuple[pd.DataFrame, pd.DataFrame]:
         employees = pd.DataFrame()
         for company in self.nmbrs.company_ids:
             company_employees = self._get(company, employee_type)
@@ -172,6 +163,11 @@ class Employees:
             timeout=self.nmbrs.timeout
         )
 
+        # Handle social security number update if present
+        if 'social_security_number' in data and resp.ok:
+            employee_id = resp.json().get('employeeId')
+            if employee_id:
+                self._update_social_security_number(employee_id, data['social_security_number'])
 
         return resp
 
@@ -206,17 +202,55 @@ class Employees:
         )
 
         # Handle social security number update if present
-        #TODO niuet overtschirjven
-        if 'social_security_number' in data:
-            social_security_payload = {
-                "socialSecurityNumber": data['social_security_number']
-            }
-            resp = self.nmbrs.session.put(
-                url=f"{self.nmbrs.base_url}employees/{employee_id}/socialsecuritynumber",
-                json=social_security_payload,
-                timeout=self.nmbrs.timeout
-            )
+        if 'socialSecurityNumber' in data:
+            self._update_social_security_number(employee_id, data['socialSecurityNumber'])
+
+        return resp
+
+    def get_by_id(self, employee_id: str) -> pd.DataFrame:
+        """
+        Get detailed information about a specific employee.
+
+        The data returned is detailed and refers to the latest entry on the
+        current period of the company.
+
+        Args:
+            employee_id: The ID of the employee
+
+        Returns:
+            DataFrame containing employee details
+        """
+        request = requests.Request(
+            method='GET',
+            url=f"{self.nmbrs.base_url}employees/{employee_id}"
+        )
+
+        data = self.nmbrs.get_paginated_result(request)
+        df = pd.json_normalize(data)
+
+        return df
+
+    def _update_social_security_number(self, employee_id: str, social_security_number: str):
+        """
+        Internal method to update an employee's social security number (BSN).
 
+        Args:
+            employee_id: The ID of the employee
+            social_security_number: The new social security number
+
+        Returns:
+            Response from the API
+        """
+        payload = {
+            "socialSecurityNumber": social_security_number
+        }
+
+        resp = self.nmbrs.session.put(
+            url=f"{self.nmbrs.base_url}employees/{employee_id}/socialsecuritynumber",
+            json=payload,
+            timeout=self.nmbrs.timeout
+        )
+        resp.raise_for_status()
         return resp
 
     def get_soap_ids(self) -> pd.DataFrame:

brynq_sdk_nmbrs/employment.py

@@ -1,4 +1,3 @@
-import math
 from typing import Any, Dict
 
 import pandas as pd
@@ -8,7 +7,6 @@ from brynq_sdk_functions import Functions
 
 from .schemas.employment import (
     EmploymentCreate,
-    EmploymentDelete,
     EmploymentGet,
     EmploymentUpdate,
 )

brynq_sdk_nmbrs/extra_fields.py

@@ -0,0 +1,126 @@
+import pandas as pd
+import requests
+from typing import Optional
+from .schemas.extra_fields import ExtraFieldSettingsGet, EmployeeExtraFieldsGet
+from brynq_sdk_functions import Functions
+
+
+class ExtraFieldSettings:
+    """
+    Class for handling company-level extra field settings.
+
+    Endpoints:
+        - GET /api/companies/{companyId}/extrafieldSettings
+    """
+
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self, company_id: Optional[str] = None) -> tuple:
+        """
+        Get extra field settings for a company.
+
+        Args:
+            company_id: Optional company ID. If not provided, fetches for all companies.
+
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        if company_id:
+            df = self._get(company_id)
+        else:
+            df = pd.DataFrame()
+            for company in self.nmbrs.company_ids:
+                df = pd.concat([df, self._get(company)])
+
+        if df.empty:
+            return df, pd.DataFrame()
+
+        valid_data, invalid_data = Functions.validate_data(df=df, schema=ExtraFieldSettingsGet, debug=self.nmbrs.debug)
+        return valid_data, invalid_data
+
+    def _get(self, company_id: str) -> pd.DataFrame:
+        """
+        Internal method to get extra field settings for a single company.
+        """
+        request = requests.Request(
+            method='GET',
+            url=f"{self.nmbrs.base_url}companies/{company_id}/extrafieldSettings"
+        )
+
+        data = self.nmbrs.get_paginated_result(request)
+        df = pd.DataFrame(data)
+
+        if not df.empty:
+            df['companyId'] = company_id
+
+        return df
+
+
+class EmployeeExtraFields:
+    """
+    Class for handling employee extra fields.
+
+    Endpoints:
+        - GET /api/companies/{companyId}/employees/extraFields
+    """
+
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self,
+            company_id: Optional[str] = None,
+            extra_field_type: Optional[str] = None) -> tuple:
+        """
+        Get extra fields for employees of a company.
+
+        Args:
+            company_id: Optional company ID. If not provided, fetches for all companies.
+            extra_field_type: Optional filter by extra field type
+                              (text, decimal, number, date, yesNo, textDate)
+
+        Returns:
+            Tuple of (valid_data, invalid_data) DataFrames
+        """
+        if company_id:
+            df = self._get(company_id, extra_field_type)
+        else:
+            df = pd.DataFrame()
+            for company in self.nmbrs.company_ids:
+                df = pd.concat([df, self._get(company, extra_field_type)])
+
+        if df.empty:
+            return df, pd.DataFrame()
+
+        valid_data, invalid_data = Functions.validate_data(df=df, schema=EmployeeExtraFieldsGet, debug=self.nmbrs.debug)
+        return valid_data, invalid_data
+
+    def _get(self,
+             company_id: str,
+             extra_field_type: Optional[str] = None) -> pd.DataFrame:
+        """
+        Internal method to get employee extra fields for a single company.
+        """
+        params = {}
+        if extra_field_type is not None:
+            params['extraFieldType'] = extra_field_type
+
+        request = requests.Request(
+            method='GET',
+            url=f"{self.nmbrs.base_url}companies/{company_id}/employees/extraFields",
+            params=params
+        )
+
+        data = self.nmbrs.get_paginated_result(request)
+
+        # Normalize nested data structure
+        df = pd.json_normalize(
+            data,
+            record_path='extraFields',
+            meta=['employeeId']
+        )
+
+        if not df.empty:
+            df['companyId'] = company_id
+
+        return df

brynq_sdk_nmbrs/function.py

@@ -1,14 +1,17 @@
+from typing import Any, Dict, Union
+
 import pandas as pd
 import requests
+from zeep.exceptions import Fault
+from zeep.helpers import serialize_object
+
 from brynq_sdk_functions import Functions as BrynQFunctions
-import math
-from typing import Dict, Any, Union
+
 from .schemas.function import (
-    EmployeeFunctionGet, FunctionUpdate, FunctionGet,
-    FunctionCreate, FunctionDelete, FunctionMasterUpdate
+    EmployeeFunctionGet,
+    FunctionGet,
+    FunctionUpdate,
 )
-from zeep.exceptions import Fault
-from zeep.helpers import serialize_object
 
 
 class EmployeeFunction:
@@ -39,7 +42,7 @@ class EmployeeFunction:
                 record_path='functions',
                 meta=['employeeId']
             )
-        except requests.HTTPError as e:
+        except requests.HTTPError:
             df = pd.DataFrame()
         return df
 
@@ -59,9 +62,6 @@ class EmployeeFunction:
         nested_data = self.nmbrs.flat_dict_to_nested_dict(data, FunctionUpdate)
         function_model = FunctionUpdate(**nested_data)
 
-        if self.nmbrs.mock_mode:
-            return function_model
-
         # Convert validated model to dict for API payload
         payload = function_model.model_dump(exclude_none=True, by_alias=True)
 
@@ -83,9 +83,6 @@ class EmployeeFunction:
         Returns:
             DataFrame with current function
         """
-        if self.nmbrs.mock_mode:
-            return pd.DataFrame()
-
         try:
             response = self.nmbrs.soap_client_employees.service.Function_GetCurrent(
                 EmployeeId=int(employee_id),
@@ -114,102 +111,43 @@ class Functions:
     def __init__(self, nmbrs):
         self.nmbrs = nmbrs
 
-    def get(self, debtor_id: str) -> (pd.DataFrame, pd.DataFrame):
-        try:
-            request = requests.Request(method='GET',
-                                       url=f"{self.nmbrs.base_url}debtors/{debtor_id}/functions")
-
-            data = self.nmbrs.get_paginated_result(request)
-            df = pd.DataFrame(data)
-            valid_functions, invalid_functions = BrynQFunctions.validate_data(df=df, schema=FunctionGet, debug=True)
-
-        except requests.HTTPError as e:
-            df = pd.DataFrame()
-
-        return valid_functions, invalid_functions
-
-    def create(self, debtor_id: Union[int, str], data: Dict[str, Any]):
+    def get(self, debtor_id: str = None) -> tuple[pd.DataFrame, pd.DataFrame]:
         """
-        Create a new master function using SOAP API.
+        Get all functions for debtor(s).
 
         Args:
-            debtor_id: The ID of the debtor
-            data: Dictionary containing function data with fields matching FunctionCreate schema
+            debtor_id: Optional debtor ID. If not provided, fetches for all debtors.
 
         Returns:
-            Response from the API (function ID)
+            Tuple of (valid_functions, invalid_functions) DataFrames
         """
-        function_model = FunctionCreate(**data)
+        if debtor_id:
+            df = self._get(debtor_id)
+        else:
+            df = pd.DataFrame()
+            for debtor in self.nmbrs.debtor_ids:
+                df = pd.concat([df, self._get(debtor)])
 
-        if self.nmbrs.mock_mode:
-            return function_model
+        if df.empty:
+            return df, pd.DataFrame()
 
-        try:
-            response = self.nmbrs.soap_client_debtors.service.Function_Insert(
-                DebtorId=int(debtor_id),
-                function={
-                    'Id': 0,  # 0 for new function
-                    'Code': function_model.code,
-                    'Description': function_model.description
-                },
-                _soapheaders={'AuthHeaderWithDomain': self.nmbrs.soap_auth_header_debtors}
-            )
-            return response
-        except Fault as e:
-            raise Exception(f"SOAP request failed: {str(e)}")
+        valid_functions, invalid_functions = BrynQFunctions.validate_data(df=df, schema=FunctionGet, debug=self.nmbrs.debug)
+        return valid_functions, invalid_functions
 
-    def delete(self, debtor_id: Union[int, str], function_id: Union[int, str]):
+    def _get(self, debtor_id: str) -> pd.DataFrame:
         """
-        Delete a master function using SOAP API.
-
-        Args:
-            debtor_id: The ID of the debtor
-            function_id: The ID of the function to delete
-
-        Returns:
-            Response from the API
+        Internal method to get functions for a single debtor.
         """
-        delete_model = FunctionDelete(function_id=int(function_id))
-
-        if self.nmbrs.mock_mode:
-            return delete_model
-
         try:
-            response = self.nmbrs.soap_client_debtors.service.Function_Delete(
-                DebtorId=int(debtor_id),
-                id=delete_model.function_id,
-                _soapheaders={'AuthHeaderWithDomain': self.nmbrs.soap_auth_header_debtors}
-            )
-            return response
-        except Fault as e:
-            raise Exception(f"SOAP request failed: {str(e)}")
-
-    def update(self, debtor_id: Union[int, str], data: Dict[str, Any]):
-        """
-        Update a master function using SOAP API.
-
-        Args:
-            debtor_id: The ID of the debtor
-            data: Dictionary containing function data with fields matching FunctionMasterUpdate schema
+            request = requests.Request(method='GET',
+                                       url=f"{self.nmbrs.base_url}debtors/{debtor_id}/functions",
+                                       params={"includeArchived": "true"})
 
-        Returns:
-            Response from the API
-        """
-        function_model = FunctionMasterUpdate(**data)
+            data = self.nmbrs.get_paginated_result(request)
+            df = pd.DataFrame(data)
+            df['debtorId'] = debtor_id
 
-        if self.nmbrs.mock_mode:
-            return function_model
+        except requests.HTTPError:
+            df = pd.DataFrame()
 
-        try:
-            response = self.nmbrs.soap_client_debtors.service.Function_Update(
-                DebtorId=int(debtor_id),
-                function={
-                    'Id': function_model.function_id,
-                    'Code': function_model.code,
-                    'Description': function_model.description
-                },
-                _soapheaders={'AuthHeaderWithDomain': self.nmbrs.soap_auth_header_debtors}
-            )
-            return response
-        except Fault as e:
-            raise Exception(f"SOAP request failed: {str(e)}")
+        return df

brynq_sdk_nmbrs/leave.py

@@ -1,11 +1,19 @@
-import math
+from typing import Any, Dict
+
 import pandas as pd
 import requests
-from brynq_sdk_functions import Functions
-from typing import Dict, Any, Union
-from .schemas.leave import LeaveBalanceGet, LeaveGet, LeaveCreate, LeaveDelete, LeaveUpdate
 from zeep.exceptions import Fault
 
+from brynq_sdk_functions import Functions
+
+from .schemas.leave import (
+    LeaveBalanceGet,
+    LeaveCreate,
+    LeaveDelete,
+    LeaveGet,
+    LeaveUpdate,
+)
+
 
 class Leave:
     def __init__(self, nmbrs):
@@ -38,7 +46,7 @@ class Leave:
                 record_path='EmployeeLeaveRequests',
                 meta=['employeeId']
             )
-        except requests.HTTPError as e:
+        except requests.HTTPError:
             df = pd.DataFrame()
 
         return df
@@ -164,7 +172,7 @@ class LeaveBalance:
                 record_path='leaveBalances',
                 meta=['employeeId']
             )
-        except requests.HTTPError as e:
+        except requests.HTTPError:
             df = pd.DataFrame()
 
         return df
@@ -172,65 +180,52 @@ class LeaveBalance:
 
 class LeaveGroup:
     """
-    LeaveGroup (Leave Type Groups) - uses SOAP CompanyLeaveTypeGroups_Get
+    Class for handling company leave groups.
+
+    Endpoints:
+        - GET /api/companies/{companyId}/leaveGroups
     """
+
     def __init__(self, nmbrs):
         self.nmbrs = nmbrs
 
-    def get(self, company_id: Union[int, str] = None) -> pd.DataFrame:
+    def get(self, company_id: str = None) -> pd.DataFrame:
         """
-        Get leave type groups using SOAP API.
-        
+        Get leave groups available in a company.
+
+        A company can have up to 4 leave groups defined.
+
         Args:
-            company_id: Optional. If provided, get groups for this company only.
-                       If not provided, get groups for all companies.
-        
+            company_id: Optional company ID. If not provided, fetches for all companies.
+
         Returns:
-            DataFrame with leave type groups
+            DataFrame containing leave groups
         """
-        if self.nmbrs.mock_mode:
-            return pd.DataFrame()
+        if company_id:
+            return self._get(company_id)
 
-        from zeep.helpers import serialize_object
-        
-        all_groups = []
+        leave_groups = pd.DataFrame()
+        for company in self.nmbrs.company_ids:
+            leave_groups = pd.concat([leave_groups, self._get(company)])
+
+        return leave_groups
+
+    def _get(self, company_id: str) -> pd.DataFrame:
+        """
+        Internal method to get leave groups for a single company.
+        """
         try:
-            # If company_id provided, only get for that company
-            if company_id is not None:
-                company_ids = [int(company_id)]
-            else:
-                # Get all company IDs from SOAP
-                companies_response = self.nmbrs.soap_client_companies.service.List_GetAll(
-                    _soapheaders={'AuthHeaderWithDomain': self.nmbrs.soap_auth_header}
-                )
-                
-                # Handle response - could be list or object with Company attribute
-                companies = []
-                if companies_response:
-                    if hasattr(companies_response, 'Company'):
-                        companies = companies_response.Company or []
-                    elif isinstance(companies_response, list):
-                        companies = companies_response
-                
-                company_ids = [c.ID for c in companies]
-            
-            for cid in company_ids:
-                try:
-                    response = self.nmbrs.soap_client_companies.service.CompanyLeaveTypeGroups_Get(
-                        CompanyId=cid,
-                        _soapheaders={'AuthHeaderWithDomain': self.nmbrs.soap_auth_header}
-                    )
-                    if response and response.LeaveTypeGroup:
-                        groups = serialize_object(response.LeaveTypeGroup)
-                        if not isinstance(groups, list):
-                            groups = [groups]
-                        for group in groups:
-                            group['company_id'] = str(cid)
-                        all_groups.extend(groups)
-                except Exception:
-                    continue
-            
-            return pd.DataFrame(all_groups)
-        
-        except Fault as e:
-            raise Exception(f"SOAP request failed: {str(e)}")
+            request = requests.Request(
+                method='GET',
+                url=f"{self.nmbrs.base_url}companies/{company_id}/leaveGroups"
+            )
+
+            data = self.nmbrs.get_paginated_result(request)
+            df = pd.DataFrame(data)
+
+            if not df.empty:
+                df['companyId'] = company_id
+
+            return df
+        except requests.HTTPError:
+            return pd.DataFrame()