brynq-sdk-nmbrs 2.0.1__tar.gz → 2.1.0__tar.gz

{brynq_sdk_nmbrs-2.0.1 → brynq_sdk_nmbrs-2.1.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_nmbrs
-Version: 2.0.1
+Version: 2.1.0
 Summary: Nmbrs wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_nmbrs-2.0.1 → brynq_sdk_nmbrs-2.1.0}/brynq_sdk_nmbrs/__init__.py

@@ -20,6 +20,7 @@ from .salary_tables import SalaryTables, SalaryScales, SalarySteps
 from .employment import Employment
 from .function import EmployeeFunction
 from .hours import VariableHours, FixedHours
+from .manager import EmployeeManager, Manager
 from .salaries import Salaries
 from .schedules import Schedule
 from .wagecomponents import EmployeeFixedWageComponents, EmployeeVariableWageComponents
@@ -73,6 +74,8 @@ class Nmbrs(BrynQ):
         self.function = EmployeeFunction(self)
         self.fixed_hours = FixedHours(self)
         self.variable_hours = VariableHours(self)
+        self.manager = Manager(self)
+        self.employee_manager = EmployeeManager(self)
         self.salaries = Salaries(self)
         self.schedule = Schedule(self)
         self.fixed_wagecomponents = EmployeeFixedWageComponents(self)
@@ -96,23 +99,22 @@ class Nmbrs(BrynQ):
     def _get_soap_auth_header(self):
         """
         Creates the SOAP authentication header using credentials from initial_credentials.
-        
         Returns:
             AuthHeaderWithDomainType: The authentication header for SOAP requests
         """
         initial_credentials = self.get_system_credential(system='nmbrs', label='bob')
         config = initial_credentials.get("config", {})
-        
+
         # Get the AuthHeaderWithDomain type from the WSDL
         AuthHeaderWithDomainType = self.soap_client.get_element('ns0:AuthHeaderWithDomain')
-        
+
         # Create the auth header using credentials from config
         auth_header = AuthHeaderWithDomainType(
             Username=config.get("soap_api_username"),
             Token=config.get("soap_api_token"),
             Domain=config.get("soap_api_domain")
         )
-        
+
         return auth_header
 
     def get_paginated_result(self, request: requests.Request) -> List:
@@ -158,4 +160,3 @@ class Nmbrs(BrynQ):
         df.columns = map(camel_to_snake_case, df.columns)
 
         return df
-

brynq_sdk_nmbrs-2.1.0/brynq_sdk_nmbrs/manager.py

@@ -0,0 +1,294 @@
+import pandas as pd
+import requests
+from brynq_sdk_functions import Functions as BrynQFunctions
+import math
+from typing import Dict, Any
+from .schemas.manager import (
+    ManagerGet, ManagerBasicGet, EmployeeManagerGet, ManagerHistoricBasicGet,
+    ManagerCreate, ManagerUpdate, ManagerDelete, UpdateEmployeeManager
+)
+
+
+class EmployeeManager:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self, created_from: str = None) -> tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get employee manager history for all companies.
+
+        Args:
+            created_from: Optional filter to get managers created from a specific date
+
+        Returns:
+            Tuple of (valid_managers, invalid_managers) DataFrames
+        """
+        managers = pd.DataFrame()
+        for company in self.nmbrs.company_ids:
+            managers = pd.concat([managers, self._get(company, created_from)])
+
+        valid_managers, invalid_managers = BrynQFunctions.validate_data(df=managers, schema=EmployeeManagerGet, debug=True)
+
+        return valid_managers, invalid_managers
+
+    def _get(self, company_id: str, created_from: str = None) -> pd.DataFrame:
+        """
+        Get employee manager history for a specific company.
+
+        Args:
+            company_id: The ID of the company
+            created_from: Optional filter to get managers created from a specific date
+
+        Returns:
+            DataFrame containing employee manager data
+        """
+        params = {}
+        if created_from:
+            params['createdFrom'] = created_from
+
+        try:
+            request = requests.Request(
+                method='GET',
+                url=f"{self.nmbrs.base_url}companies/{company_id}/employees/managers",
+                params=params
+            )
+            data = self.nmbrs.get_paginated_result(request)
+            df = pd.json_normalize(
+                data,
+                record_path='managers',
+                meta=['employeeId']
+            )
+            df['companyId'] = company_id
+        except requests.HTTPError as e:
+            df = pd.DataFrame()
+
+        return df
+
+    def get_historic_basic(self, created_from: str = None) -> tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get historic basic manager information for employees.
+
+        Args:
+            created_from: Optional filter to get managers created from a specific date
+
+        Returns:
+            Tuple of (valid_managers, invalid_managers) DataFrames
+        """
+        managers = pd.DataFrame()
+        for company in self.nmbrs.company_ids:
+            managers = pd.concat([managers, self._get_historic_basic(company, created_from)])
+
+        valid_managers, invalid_managers = BrynQFunctions.validate_data(df=managers, schema=ManagerHistoricBasicGet, debug=True)
+
+        return valid_managers, invalid_managers
+
+    def _get_historic_basic(self, company_id: str, created_from: str = None) -> pd.DataFrame:
+        """
+        Get historic basic manager information for a specific company.
+
+        Args:
+            company_id: The ID of the company
+            created_from: Optional filter to get managers created from a specific date
+
+        Returns:
+            DataFrame containing historic basic manager data
+        """
+        params = {}
+        if created_from:
+            params['createdFrom'] = created_from
+
+        try:
+            request = requests.Request(
+                method='GET',
+                url=f"{self.nmbrs.base_url}companies/{company_id}/employees/managers",
+                params=params
+            )
+            data = self.nmbrs.get_paginated_result(request)
+            df = pd.json_normalize(
+                data,
+                record_path='managers',
+                meta=['employeeId']
+            )
+            df['companyId'] = company_id
+        except requests.HTTPError as e:
+            df = pd.DataFrame()
+
+        return df
+
+    def update(self, employee_id: str, data: Dict[str, Any]):
+        """
+        Update the manager of a specific employee using Pydantic validation.
+
+        Args:
+            employee_id: The ID of the employee
+            data: Dictionary containing manager data with fields matching
+                 the UpdateEmployeeManager schema (using camelCase field names)
+
+        Returns:
+            Response from the API
+        """
+        # Validate with Pydantic model
+        manager_model = UpdateEmployeeManager(**data)
+
+        if self.nmbrs.mock_mode:
+            return manager_model
+
+        # Convert validated model to dict for API payload
+        payload = manager_model.dict(exclude_none=True)
+
+        # Send request
+        resp = self.nmbrs.session.put(
+            url=f"{self.nmbrs.base_url}employees/{employee_id}/manager",
+            json=payload,
+            timeout=self.nmbrs.timeout
+        )
+        return resp
+
+
+class Manager:
+    def __init__(self, nmbrs):
+        self.nmbrs = nmbrs
+
+    def get(self, debtor_id: str) -> tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get all managers for a specific debtor.
+
+        Args:
+            debtor_id: The ID of the debtor
+
+        Returns:
+            Tuple of (valid_managers, invalid_managers) DataFrames
+        """
+        try:
+            request = requests.Request(
+                method='GET',
+                url=f"{self.nmbrs.base_url}debtors/{debtor_id}/managers"
+            )
+
+            data = self.nmbrs.get_paginated_result(request)
+            df = pd.DataFrame(data)
+            df['debtorId'] = debtor_id
+
+            valid_managers, invalid_managers = BrynQFunctions.validate_data(df=df, schema=ManagerGet, debug=True)
+
+        except requests.HTTPError as e:
+            df = pd.DataFrame()
+            valid_managers = df
+            invalid_managers = df
+
+        return valid_managers, invalid_managers
+
+    def get_basic(self, debtor_id: str) -> tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get basic manager information for a specific debtor.
+
+        Args:
+            debtor_id: The ID of the debtor
+
+        Returns:
+            Tuple of (valid_managers, invalid_managers) DataFrames
+        """
+        try:
+            request = requests.Request(
+                method='GET',
+                url=f"{self.nmbrs.base_url}debtors/{debtor_id}/managers"
+            )
+
+            data = self.nmbrs.get_paginated_result(request)
+            df = pd.DataFrame(data)
+            df['debtorId'] = debtor_id
+
+            valid_managers, invalid_managers = BrynQFunctions.validate_data(df=df, schema=ManagerBasicGet, debug=True)
+
+        except requests.HTTPError as e:
+            df = pd.DataFrame()
+            valid_managers = df
+            invalid_managers = df
+
+        return valid_managers, invalid_managers
+
+    def create(self, debtor_id: str, data: Dict[str, Any]):
+        """
+        Create a new manager using Pydantic validation.
+
+        Args:
+            debtor_id: The ID of the debtor
+            data: Dictionary containing manager data with fields matching
+                 the ManagerCreate schema (using camelCase field names)
+
+        Returns:
+            Response from the API
+        """
+        # Validate with Pydantic model
+        manager_model = ManagerCreate(**data)
+
+        if self.nmbrs.mock_mode:
+            return manager_model
+
+        # Convert validated model to dict for API payload
+        payload = manager_model.dict(exclude_none=True)
+
+        # Send request
+        resp = self.nmbrs.session.post(
+            url=f"{self.nmbrs.base_url}debtors/{debtor_id}/managers",
+            json=payload,
+            timeout=self.nmbrs.timeout
+        )
+        return resp
+
+    def update(self, debtor_id: str, data: Dict[str, Any]):
+        """
+        Update a manager using Pydantic validation.
+
+        Args:
+            debtor_id: The ID of the debtor
+            data: Dictionary containing manager data with fields matching
+                 the ManagerUpdate schema (using camelCase field names)
+
+        Returns:
+            Response from the API
+        """
+        # Validate with Pydantic model
+        manager_model = ManagerUpdate(**data)
+
+        if self.nmbrs.mock_mode:
+            return manager_model
+
+        # Convert validated model to dict for API payload
+        payload = manager_model.dict(exclude_none=True)
+
+        # Send request
+        resp = self.nmbrs.session.put(
+            url=f"{self.nmbrs.base_url}debtors/{debtor_id}/managers/{payload['managerId']}",
+            json=payload,
+            timeout=self.nmbrs.timeout
+        )
+        return resp
+
+    def delete(self, debtor_id: str, data: Dict[str, Any]):
+        """
+        Delete a manager using Pydantic validation.
+
+        Args:
+            debtor_id: The ID of the debtor
+            data: Dictionary containing manager data with fields matching
+                 the ManagerDelete schema (using camelCase field names)
+
+        Returns:
+            Response from the API
+        """
+        # Validate with Pydantic model
+        manager_model = ManagerDelete(**data)
+
+        if self.nmbrs.mock_mode:
+            return manager_model
+
+        # Convert validated model to dict for API payload
+        payload = manager_model.dict(exclude_none=True)
+
+        # Send request
+        resp = self.nmbrs.session.delete(
+            url=f"{self.nmbrs.base_url}debtors/{debtor_id}/managers/{payload['managerId']}",
+            timeout=self.nmbrs.timeout
+        )
+        return resp

{brynq_sdk_nmbrs-2.0.1 → brynq_sdk_nmbrs-2.1.0}/brynq_sdk_nmbrs/schemas/__init__.py

@@ -10,6 +10,7 @@ from .employees import EmployeeGet, EmployeeCreate, EmployeeUpdate, EmployeeDele
 from .employment import EmploymentGet, EmploymentCreate, EmploymentUpdate, EmploymentDelete
 from .function import FunctionGet, FunctionCreate, FunctionUpdate, FunctionDelete
 from .hours import FixedHoursGet, FixedHoursCreate, FixedHoursUpdate, HoursDelete, VariableHoursGet, VariableHoursCreate, VariableHoursUpdate
+from .manager import ManagerGet, ManagerBasicGet, EmployeeManagerGet, ManagerHistoricBasicGet, ManagerCreate, ManagerUpdate, ManagerDelete, UpdateEmployeeManager
 from .salary import SalaryGet, SalaryCreate, SalaryUpdate, SalaryDelete
 from .wagecomponents import FixedWageComponentGet, FixedWageComponentCreate, FixedWageComponentUpdate, WageComponentDelete, VariableWageComponentGet, VariableWageComponentCreate, VariableWageComponentUpdate
 
@@ -25,6 +26,8 @@ __all__ = [
     'FunctionGet', 'FunctionCreate', 'FunctionUpdate', 'FunctionDelete',
     'FixedHoursGet', 'FixedHoursCreate', 'FixedHoursUpdate', 'HoursDelete',
     'VariableHoursGet', 'VariableHoursCreate', 'VariableHoursUpdate',
+    'ManagerGet', 'ManagerBasicGet', 'EmployeeManagerGet', 'ManagerHistoricBasicGet',
+    'ManagerCreate', 'ManagerUpdate', 'ManagerDelete', 'UpdateEmployeeManager',
     'SalaryGet', 'SalaryCreate', 'SalaryUpdate', 'SalaryDelete',
     'FixedWageComponentGet', 'FixedWageComponentCreate', 'FixedWageComponentUpdate', 'WageComponentDelete',
     'VariableWageComponentGet', 'VariableWageComponentCreate', 'VariableWageComponentUpdate'

brynq_sdk_nmbrs-2.1.0/brynq_sdk_nmbrs/schemas/manager.py

@@ -0,0 +1,123 @@
+from datetime import datetime
+
+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
+from pydantic import BaseModel, Field
+
+# ---------------------------
+# Get Schemas
+# ---------------------------
+class ManagerGet(BrynQPanderaDataFrameModel):
+    manager_id: Series[pa.String] = pa.Field(coerce=True, description="Manager unique identifier", alias="managerId")
+    number: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="The manager's number", alias="number")
+    first_name: Series[pa.String] = pa.Field(coerce=True, description="The manager's first name", alias="firstName")
+    last_name: Series[pa.String] = pa.Field(coerce=True, description="The manager's last name", alias="lastName")
+    gender: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="The manager's gender", alias="gender")
+    phone_number: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="The manager's phone number", alias="phoneNumber")
+    cellphone: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="The manager's cellphone", alias="cellphone")
+    fax: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="The manager's fax", alias="fax")
+    email: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="The manager's email", alias="email")
+    department_id: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Department ID", alias="department.departmentId")
+    department_code: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Department Code", alias="department.code")
+    department_description: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Department Description", alias="department.description")
+    department_created_at: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Department Created At", alias="department.createdAt")
+    function_id: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Function ID", alias="function.functionId")
+    function_code: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Function Code", alias="function.code")
+    function_description: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Function Description", alias="function.description")
+    function_created_at: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Function Created At", alias="function.createdAt")
+
+    class _Annotation:
+        primary_key = "manager_id"
+
+class ManagerBasicGet(BrynQPanderaDataFrameModel):
+    manager_id: Series[pa.String] = pa.Field(coerce=True, description="Manager unique identifier", alias="managerId")
+    first_name: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager first name", alias="firstName")
+    last_name: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager last name", alias="lastName")
+    email: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager email", alias="email")
+
+    class _Annotation:
+        primary_key = "manager_id"
+
+class EmployeeManagerGet(BrynQPanderaDataFrameModel):
+    employee_id: Series[pa.String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    manager_id: Series[pa.String] = pa.Field(coerce=True, description="Manager ID", alias="managerId")
+    number: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Manager number", alias="number")
+    first_name: Series[pa.String] = pa.Field(coerce=True, description="Manager first name", alias="firstName")
+    last_name: Series[pa.String] = pa.Field(coerce=True, description="Manager last name", alias="lastName")
+    gender: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager gender", alias="gender")
+    phone_number: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager phone number", alias="phoneNumber")
+    cellphone: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager cellphone", alias="cellphone")
+    fax: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager fax", alias="fax")
+    email: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager email", alias="email")
+    created_at: Series[datetime] = pa.Field(coerce=True, description="Manager created at", alias="createdAt")
+    period_period: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Period", alias="period.period")
+    period_year: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Year", alias="period.year")
+    department_id: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Department ID", alias="department.departmentId")
+    department_code: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Department Code", alias="department.code")
+    department_description: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Department Description", alias="department.description")
+    department_created_at: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Department Created At", alias="department.createdAt")
+    function_id: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Function ID", alias="function.functionId")
+    function_code: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Function Code", alias="function.code")
+    function_description: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Function Description", alias="function.description")
+    function_created_at: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Function Created At", alias="function.createdAt")
+
+    class _Annotation:
+        primary_key = "manager_id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeeSchema",
+                "parent_column": "employee_id",
+                "cardinality": "N:1"
+            }
+        }
+
+class ManagerHistoricBasicGet(BrynQPanderaDataFrameModel):
+    employee_id: Series[pa.String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    manager_id: Series[pa.String] = pa.Field(coerce=True, description="Manager ID", alias="managerId")
+    first_name: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager first name", alias="firstName")
+    last_name: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager last name", alias="lastName")
+    email: Series[pa.String] = pa.Field(coerce=True, nullable=True, description="Manager email", alias="email")
+    created_at: Series[datetime] = pa.Field(coerce=True, description="Manager created at", alias="createdAt")
+
+    class _Annotation:
+        primary_key = "manager_id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeeSchema",
+                "parent_column": "employee_id",
+                "cardinality": "N: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 ManagerCreate(BaseModel):
+    number: int = Field(..., ge=1, example=1, description="Manager number", alias="number")
+    first_name: str = Field(..., max_length=100, example="John", description="Manager first name", alias="firstName")
+    last_name: str = Field(..., max_length=100, example="Doe", description="Manager last name", alias="lastName")
+    gender: Optional[str] = Field(None, example="Male", description="Manager gender", alias="gender")
+    phone_number: Optional[str] = Field(None, max_length=50, example="0640986755", description="Manager phone number", alias="phoneNumber")
+    cellphone: Optional[str] = Field(None, max_length=50, example="0640986755", description="Manager cellphone", alias="cellphone")
+    fax: Optional[str] = Field(None, max_length=50, description="Manager fax", alias="fax")
+    email: Optional[str] = Field(None, max_length=100, example="john.doe@company.com", description="Manager email", alias="email")
+
+class ManagerUpdate(BaseModel):
+    manager_id: str = Field(..., example="2f6aa11c-504a-49a1-903b-e15e79965702", description="Manager ID", alias="managerId")
+    period_details: Period = Field(..., alias="periodDetails")
+
+class ManagerDelete(BaseModel):
+    manager_id: str = Field(..., example="2f6aa11c-504a-49a1-903b-e15e79965702", description="Manager ID", alias="managerId")
+
+class UpdateEmployeeManager(BaseModel):
+    manager_id: str = Field(..., example="2f6aa11c-504a-49a1-903b-e15e79965702", description="Manager ID", alias="managerId")
+    period_details: Period = Field(..., alias="periodDetails")

{brynq_sdk_nmbrs-2.0.1 → brynq_sdk_nmbrs-2.1.0}/brynq_sdk_nmbrs.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-nmbrs
-Version: 2.0.1
+Version: 2.1.0
 Summary: Nmbrs wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_nmbrs-2.0.1 → brynq_sdk_nmbrs-2.1.0}/brynq_sdk_nmbrs.egg-info/SOURCES.txt

@@ -14,6 +14,7 @@ brynq_sdk_nmbrs/employees.py
 brynq_sdk_nmbrs/employment.py
 brynq_sdk_nmbrs/function.py
 brynq_sdk_nmbrs/hours.py
+brynq_sdk_nmbrs/manager.py
 brynq_sdk_nmbrs/salaries.py
 brynq_sdk_nmbrs/salary_tables.py
 brynq_sdk_nmbrs/schedules.py
@@ -36,6 +37,7 @@ brynq_sdk_nmbrs/schemas/employees.py
 brynq_sdk_nmbrs/schemas/employment.py
 brynq_sdk_nmbrs/schemas/function.py
 brynq_sdk_nmbrs/schemas/hours.py
+brynq_sdk_nmbrs/schemas/manager.py
 brynq_sdk_nmbrs/schemas/salary.py
 brynq_sdk_nmbrs/schemas/schedules.py
 brynq_sdk_nmbrs/schemas/wagecomponents.py

{brynq_sdk_nmbrs-2.0.1 → brynq_sdk_nmbrs-2.1.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_nmbrs',
-    version='2.0.1',
+    version='2.1.0',
     description='Nmbrs wrapper from BrynQ',
     long_description='Nmbrs wrapper from BrynQ',
     author='BrynQ',