brynq-sdk-zenegy 1.3.3__py3-none-any.whl

brynq_sdk_zenegy/zenegy.py

@@ -0,0 +1,221 @@
+import requests
+import pandas as pd
+from typing import Dict, Any, Optional, Type, List
+from uuid import UUID
+from pydantic import BaseModel
+from datetime import datetime
+
+from .absence import Absences
+from brynq_sdk_brynq import BrynQ
+from brynq_sdk_functions import Functions
+from .companies import Companies
+from .employees import Employees
+from .cost_center import CostCenter
+from .payroll import Payrolls
+from .payslips import Payslips
+from .global_values import GlobalValues
+from .global_value_sets import GlobalValueSets
+from .supplements_and_deductions_rates import SupplementsAndDeductionsRates
+from .departments import CompanyDepartments
+from .employee_documents import EmployeeDocuments
+
+class Zenegy(BrynQ):
+    """
+    Base class for interacting with the Zenegy API.
+    """
+
+    # Default timeout in seconds for all requests
+    TIMEOUT = 30
+
+    def __init__(self, system_type: str,
+                 debug: bool = False, test_environment: bool = False, test_environment_id: str = None):
+        """
+        Initialize the Zenegy API client.
+
+        Args:
+            system_type (str): System type
+            test_environment (bool): Test environment flag
+            debug (bool): Debug flag
+        """
+        super().__init__()
+
+        if not test_environment and test_environment_id is None:
+            self.base_url = "https://api.zenegy.com"
+            system = "zenegy"
+        elif test_environment_id:
+            self.base_url = "https://api-gateway.beta.zalary.com"
+            system = "zenegy-development"
+            self.data_interface_id = test_environment_id
+            self.interfaces._brynq.data_interface_id = test_environment_id
+            self.interfaces.credentials._brynq.data_interface_id = test_environment_id
+        else:
+            raise ValueError("Test environment ID is required, please set up interface for test enviromnent of Zenegy")
+
+        # Get credentials
+        credentials = self.interfaces.credentials.get(
+            system=system,
+            system_type=system_type,
+            test_environment=test_environment,
+        )
+
+        # Get bearer token
+        self.token = credentials["data"]["access_token"]
+        self.company_uid = credentials["data"]["company_id"]
+
+        # Initialize session with timeout
+        self.session = requests.Session()
+        self.session.headers.update({
+            "Authorization": f"Bearer {self.token}",
+            "Accept": "application/json",
+            "Content-Type": "application/json"
+        })
+        self.session.timeout = self.TIMEOUT
+
+        # Set debug mode
+        self.debug = debug
+
+        # Initialize entity classes
+        self.absences = Absences(self)
+        self.companies = Companies(self)
+        self.cost_centers = CostCenter(self)
+        self.employees = Employees(self)
+        self.payrolls = Payrolls(self)
+        self.payslips = Payslips(self)
+        self.employee_documents = EmployeeDocuments(self)
+        self.global_values = GlobalValues(self)
+        self.global_value_sets = GlobalValueSets(self)
+        self.supplements_and_deduction_rates = SupplementsAndDeductionsRates(self)
+        self.departments = CompanyDepartments(self)
+
+    def get(self, endpoint: str, params: Dict[str, Any] = None):
+        """
+        Make a GET request to the API.
+
+        Args:
+            endpoint: API endpoint to call
+            params: Query parameters
+
+        Returns:
+            Raw API response data
+        """
+        try:
+            # Make the API request
+            response = self.session.get(
+                url=f"{self.base_url}/{endpoint}",
+                params=params,
+                timeout=self.TIMEOUT,
+            )
+            self.raise_for_status_with_details(response)
+            content = response.json()
+
+            return content
+
+        except Exception as e:
+            raise Exception(f"Failed to retrieve data: {str(e)}") from e
+
+    def post(self, endpoint: str, json: Optional[Dict[str, Any]] = None) -> requests.Response:
+        """
+        Make a POST request using the shared session with timeout.
+
+        Args:
+            endpoint: API endpoint to call
+            json: JSON body to send in the request
+
+        Returns:
+            requests.Response: Raw response object
+        """
+        try:
+            response = self.session.post(
+                url=f"{self.base_url}/{endpoint}",
+                json=json,
+                timeout=self.TIMEOUT,
+            )
+            self.raise_for_status_with_details(response)
+            return response
+        except Exception as e:
+            raise Exception(f"Failed to POST {endpoint}: {str(e)}") from e
+
+    def patch(self, endpoint: str, json: Optional[Dict[str, Any]] = None) -> requests.Response:
+        """
+        Make a PATCH request using the shared session with timeout.
+
+        Args:
+            endpoint: API endpoint to call
+            json: JSON body to send in the request
+
+        Returns:
+            requests.Response: Raw response object
+        """
+        try:
+            response = self.session.patch(
+                url=f"{self.base_url}/{endpoint}",
+                json=json,
+                timeout=self.TIMEOUT,
+            )
+            self.raise_for_status_with_details(response)
+            return response
+        except Exception as e:
+            raise Exception(f"Failed to PATCH {endpoint}: {str(e)}") from e
+
+    def put(self, endpoint: str, json: Optional[Dict[str, Any]] = None) -> requests.Response:
+        """
+        Make a PUT request using the shared session with timeout.
+
+        Args:
+            endpoint: API endpoint to call
+            json: JSON body to send in the request
+
+        Returns:
+            requests.Response: Raw response object
+        """
+        try:
+            response = self.session.put(
+                url=f"{self.base_url}/{endpoint}",
+                json=json,
+                timeout=self.TIMEOUT,
+            )
+            self.raise_for_status_with_details(response)
+            return response
+        except Exception as e:
+            raise Exception(f"Failed to PUT {endpoint}: {str(e)}") from e
+
+    def delete(self, endpoint: str) -> requests.Response:
+        """
+        Make a DELETE request using the shared session with timeout.
+
+        Args:
+            endpoint: API endpoint to call
+
+        Returns:
+            requests.Response: Raw response object
+        """
+        try:
+            response = self.session.delete(
+                url=f"{self.base_url}/{endpoint}",
+                timeout=self.TIMEOUT,
+            )
+            self.raise_for_status_with_details(response)
+            return response
+        except Exception as e:
+            raise Exception(f"Failed to DELETE {endpoint}: {str(e)}") from e
+
+    def raise_for_status_with_details(self, response: requests.Response) -> None:
+        """
+        Raises HTTPError if the response contains an HTTP error status.
+        Additionally includes response content (JSON or plain text) in the exception message
+        to provide more detailed context.
+        """
+        try:
+            response.raise_for_status()
+        except requests.exceptions.HTTPError as e:
+            # Attempt to extract error details from the response
+            try:
+                error_details = response.json()
+            except ValueError:
+                # If the response is not JSON, fall back to plain text
+                error_details = response.text
+
+            # Raise a new exception with the detailed message
+            raise requests.exceptions.HTTPError(
+                f"{str(e)}\nResponse details:\n{error_details}"
+            ) from e

brynq_sdk_zenegy-1.3.3.dist-info/METADATA

@@ -0,0 +1,16 @@
+Metadata-Version: 2.4
+Name: brynq_sdk_zenegy
+Version: 1.3.3
+Summary: Zenegy wrapper from BrynQ
+Author: BrynQ
+Author-email: support@brynq.com
+License: BrynQ License
+Requires-Dist: brynq-sdk-brynq>=3
+Dynamic: author
+Dynamic: author-email
+Dynamic: description
+Dynamic: license
+Dynamic: requires-dist
+Dynamic: summary
+
+Zenegy wrapper from BrynQ

brynq_sdk_zenegy-1.3.3.dist-info/RECORD

@@ -0,0 +1,33 @@
+brynq_sdk_zenegy/__init__.py,sha256=oj56tcw0Ia9VaZ1aNChTrk9SqoHt6B3Y-ugrL9zyZ0o,798
+brynq_sdk_zenegy/absence.py,sha256=ZmMy7t1CFmXK3-WfpA6b20XZ2ahwsR2gQeHInOb48Dk,3665
+brynq_sdk_zenegy/companies.py,sha256=DbNx4E-tjqdohbqpPeVrKTWCNCyOa9m7ZIXwuPx4ctU,1271
+brynq_sdk_zenegy/cost_center.py,sha256=zdBSe8KZ683LIeHIXCt5Y9sCY4HcXI_eEcooq3P9jSU,2763
+brynq_sdk_zenegy/departments.py,sha256=o2G59BkLioyo9_FhwppA_1nurzNf30k6XkkTYDLdsa4,2451
+brynq_sdk_zenegy/employee_documents.py,sha256=xYXukrSd6gqI5UbiupGb5_zrKzOsNeh4FbVippdIpw8,1396
+brynq_sdk_zenegy/employees.py,sha256=SYQGWBt3bNTvtByeftrJB0yAaxnzZXqpH2Unt56AsAM,12135
+brynq_sdk_zenegy/global_value_sets.py,sha256=2T63dLUvD4mY7L1coXYQD8UttE4m0gKGolH55r_2mmI,10289
+brynq_sdk_zenegy/global_values.py,sha256=RBv33piYctIu95Z022noDFsMhPjSzsaBbyeaU84V2bw,10598
+brynq_sdk_zenegy/paychecks.py,sha256=9kUuFY3jc8vfyYVxqBXDWSVXD_X-FlW693an-CirlTw,4844
+brynq_sdk_zenegy/payroll.py,sha256=gVLBEaMe2Rq3Vt06Gf2KllnGmwt5glNJFFiSylQ4AMs,4921
+brynq_sdk_zenegy/payslips.py,sha256=n21-6TXU-KrKza6vhglzahb6ThpvL9PW5WJSrn7lsdk,1371
+brynq_sdk_zenegy/pensions.py,sha256=1-IBvs8CzABTCDh_FYjx9nSk4qWQ0e6gXijncWXxgzg,4581
+brynq_sdk_zenegy/supplements_and_deductions_rates.py,sha256=cGVs73SYDFxeIifzvHfKGqzd_SrtxqeG-KFGJdDu2pA,2723
+brynq_sdk_zenegy/zenegy.py,sha256=q92m1Mhd9qRx4qQC2csjm_M5WyYzAI1m2GcQUM2e3-M,7666
+brynq_sdk_zenegy/schemas/__init__.py,sha256=B8EZcXMHd3S4wkOXS-jG9__irnZFeipsY1Va61DH-2w,1782
+brynq_sdk_zenegy/schemas/absences.py,sha256=jsQ4vLCyP6H__Omg7gJJXUPM69LcVxQ4veClJ3FS3yE,22182
+brynq_sdk_zenegy/schemas/companies.py,sha256=VKQgSSMcaNeVkpWj29h3DyVYxARx0WwR4TqmLEPf4h4,2988
+brynq_sdk_zenegy/schemas/company_cost_centers.py,sha256=a-t7RSWWai61B241WrxCBvUmTv7RbBIalqfKLh_57Js,1872
+brynq_sdk_zenegy/schemas/company_departments.py,sha256=CO8lj2ulBxUxQOumEa5jizqjIW9O9zp0qNdDBQyASdU,11364
+brynq_sdk_zenegy/schemas/employee_documents.py,sha256=zIYnZe5Egc2OsepNR2k9sa8_oYbgYlko_uUo9Pj1ac0,1853
+brynq_sdk_zenegy/schemas/employee_pay_checks.py,sha256=EPKeuxk7trFyza4HuHQhqmFFP73-EV8YQYlqTi4fQ0A,20965
+brynq_sdk_zenegy/schemas/employee_pensions.py,sha256=ql9u0ixeY7PJdiuCIeraEuxfUGkWUcQDEFhWMo-xIFA,9190
+brynq_sdk_zenegy/schemas/employees.py,sha256=mpfda-XNeJA_GDvsNZwebktep6qsdokZT136cB-cNow,224459
+brynq_sdk_zenegy/schemas/global_value_sets.py,sha256=T2-wbv1X3cynHagmSm5Txt2Nt8XM9IExpEgZavackQo,12797
+brynq_sdk_zenegy/schemas/global_values.py,sha256=p3O7Wcl7Zs1h5RuHFDqb43wBJKu-IPXy4MSnc5j2pzw,34182
+brynq_sdk_zenegy/schemas/payrolls.py,sha256=lH7wWQ9TlgxNdcv-YVmwTwU1CX0Bnjr7Q3c-PDB-nXA,16481
+brynq_sdk_zenegy/schemas/payslips.py,sha256=oo_synehNZl6BJdW9Ndqa1EL2bay89BHaZiWZiCgMWc,2450
+brynq_sdk_zenegy/schemas/supplements_and_deductions_rates.py,sha256=g4GSI-klmTKrTYcKuktatj3te5xVhUrYxTsrJ-mg6ho,16878
+brynq_sdk_zenegy-1.3.3.dist-info/METADATA,sha256=_K26zjKtbcibwmHCptAeIt8ve9RX2CmYsfr7bq1YEFE,341
+brynq_sdk_zenegy-1.3.3.dist-info/WHEEL,sha256=_zCd3N1l69ArxyTb8rzEoP9TpbYXkqRFSNOD5OuxnTs,91
+brynq_sdk_zenegy-1.3.3.dist-info/top_level.txt,sha256=quyHxFQMtqHujnE15mGvieYNp-0MR1aLx0ns5VYYWOo,17
+brynq_sdk_zenegy-1.3.3.dist-info/RECORD,,

brynq_sdk_zenegy-1.3.3.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (80.9.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

brynq_sdk_zenegy-1.3.3.dist-info/top_level.txt

@@ -0,0 +1 @@
+brynq_sdk_zenegy