brynq-sdk-factorial 2.1.0__tar.gz → 2.3.0__tar.gz

{brynq_sdk_factorial-2.1.0 → brynq_sdk_factorial-2.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_factorial
-Version: 2.1.0
+Version: 2.3.0
 Summary: Factorial wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_factorial-2.1.0 → brynq_sdk_factorial-2.3.0}/brynq_sdk_factorial/__init__.py

@@ -11,7 +11,7 @@ from .locations import Locations
 from .payroll import Payroll
 from .teams import Teams
 from .workschedules import Workschedules
-
+from .family_situation import FamilySituation
 
 # Set the base class for Factorial. This class will be used to set the credentials and those will be used in all other classes.
 class Factorial(BrynQ):
@@ -22,10 +22,10 @@ class Factorial(BrynQ):
         super().__init__()
         self.timeout = 3600
         if demo:
-            self.base_url = 'https://api.demo.factorial.dev/api/v2/'
+            self.base_url = 'https://api.demo.factorial.dev/api/2025-07-01/'
             self.base_url_v1 = 'https://api.demo.factorial.dev/api/v1/'
         else:
-            self.base_url = 'https://api.factorialhr.com/api/v2/'
+            self.base_url = 'https://api.factorialhr.com/api/2025-07-01/'
             self.base_url_v1 = 'https://api.factorialhr.com/api/v1/'
         headers = self._get_credentials(system_type)
         self.session = requests.Session()
@@ -40,6 +40,7 @@ class Factorial(BrynQ):
         self.payroll = Payroll(self)
         self.workschedules = Workschedules(self)
         self.files = Files(self)
+        self.family_situation = FamilySituation(self)
         self.debug = debug
 
     def _get_credentials(self, system_type):
@@ -57,4 +58,3 @@ class Factorial(BrynQ):
         }
 
         return headers
-

brynq_sdk_factorial-2.3.0/brynq_sdk_factorial/family_situation.py

@@ -0,0 +1,50 @@
+import requests
+import pandas as pd
+
+
+class FamilySituation:
+    def __init__(self, factorial):
+        self.factorial = factorial
+        self.base_endpoint = '/resources/payroll/family_situations'
+
+    def get(self,
+            employee_ids: list[int] = None) -> pd.DataFrame:
+
+        # Use locals() to get all function parameters as a dictionary. Do not move this down since it will include all variables in function scope
+        func_params = list(locals().items())
+        params = {}
+        for param, value in func_params:
+            if param != 'self' and value is not None:
+                params[param] = value
+
+        has_next_page = True
+        result_data = pd.DataFrame()
+        while has_next_page:
+            response = self.factorial.session.get(url=f'{self.factorial.base_url}{self.base_endpoint}',
+                                                  params=params,
+                                                  timeout=self.factorial.timeout)
+            response.raise_for_status()
+            response_data = response.json()
+            result_data = pd.concat([result_data, pd.DataFrame(response_data['data'])])
+            has_next_page = response_data['meta']['has_next_page']
+            if has_next_page:
+                params['after_id'] = response_data['meta']['end_cursor']
+
+        return result_data
+
+    def create(self, data: dict) -> requests.Response:
+        response = self.factorial.session.post(url=f'{self.factorial.base_url}{self.base_endpoint}',
+                                               json=data,
+                                               timeout=self.factorial.timeout)
+        response.raise_for_status()
+        return response
+
+    def update(self, family_situation_id: str, data: dict) -> requests.Response:
+        response = self.factorial.session.put(url=f'{self.factorial.base_url}{self.base_endpoint}/{family_situation_id}',
+                                              json=data,
+                                              timeout=self.factorial.timeout)
+        response.raise_for_status()
+        return response
+
+    def delete(self, family_situation_id: str) -> requests.Response:
+        raise NotImplementedError

brynq_sdk_factorial-2.3.0/brynq_sdk_factorial/schemas/family_situation.py

@@ -0,0 +1,33 @@
+# Auto-generated schemas for category: family_situation
+
+import pandas as pd
+import pandera as pa
+from pandera.typing import Series, String, Int, Float, Bool, DateTime
+import pandera.extensions as extensions
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+from typing import Optional, Annotated
+from pydantic import BaseModel, Field, StringConstraints
+
+class Family_situationGet(BrynQPanderaDataFrameModel):
+    id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="ID of the family situation.", alias="id")
+    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Employee id of the family situation.", alias="employee_id")
+    civil_status: Series[String] = pa.Field(coerce=True, nullable=True, description="Civil status of the employee.", alias="civil_status")
+    number_of_dependants: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Number of dependants of the employee.", alias="number_of_dependants")
+
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
+class Family_situationCreate(BaseModel):
+    employee_id: int = Field(..., description="Employee id.", alias="employee_id")
+    civil_status: Optional[Annotated[str, StringConstraints(pattern=r'^single|cohabitating|divorced|married|unknown|civil_partnership|separated|widow|not_applicable$', strip_whitespace=True)]] = Field(None, description="Civil status of the employee.", alias="civil_status")
+    number_of_dependants: Optional[int] = Field(None, description="Number of dependants of the employee.", alias="number_of_dependants")
+
+class Family_situationDelete(BaseModel):
+    id: int = Field(..., description="ID", alias="id")

{brynq_sdk_factorial-2.1.0 → brynq_sdk_factorial-2.3.0}/brynq_sdk_factorial.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-factorial
-Version: 2.1.0
+Version: 2.3.0
 Summary: Factorial wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_factorial-2.1.0 → brynq_sdk_factorial-2.3.0}/brynq_sdk_factorial.egg-info/SOURCES.txt

@@ -6,6 +6,7 @@ brynq_sdk_factorial/contracts.py
 brynq_sdk_factorial/costcenter.py
 brynq_sdk_factorial/custom_fields.py
 brynq_sdk_factorial/employees.py
+brynq_sdk_factorial/family_situation.py
 brynq_sdk_factorial/files.py
 brynq_sdk_factorial/locations.py
 brynq_sdk_factorial/payroll.py
@@ -25,6 +26,7 @@ brynq_sdk_factorial/schemas/documents_schemas.py
 brynq_sdk_factorial/schemas/employee_updates_schemas.py
 brynq_sdk_factorial/schemas/employees_schemas.py
 brynq_sdk_factorial/schemas/expenses_schemas.py
+brynq_sdk_factorial/schemas/family_situation.py
 brynq_sdk_factorial/schemas/finance_schemas.py
 brynq_sdk_factorial/schemas/holidays_schemas.py
 brynq_sdk_factorial/schemas/job_catalog_schemas.py

{brynq_sdk_factorial-2.1.0 → brynq_sdk_factorial-2.3.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_factorial',
-    version='2.1.0',
+    version='2.3.0',
     description='Factorial wrapper from BrynQ',
     long_description='Factorial wrapper from BrynQ',
     author='BrynQ',