brynq-sdk-factorial 2.0.0__tar.gz → 2.2.0__tar.gz

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.0}/PKG-INFO

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

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.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):
@@ -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.2.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.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial/schemas/attendance_schemas.py

@@ -16,6 +16,16 @@ class Break_configurationsGet(BrynQPanderaDataFrameModel):
     name: Series[String] = pa.Field(coerce=True, nullable=True, description="Name of the break configuration", alias="name")
     paid: Series[Bool] = pa.Field(coerce=True, nullable=True, description="Check the break configuration is paid or not", alias="paid")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "time_settings_break_configuration_id": {
+                "parent_schema": "Break_configurationsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Edit_timesheet_requestsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Unique identifier for the edit timesheet request", alias="id")
     approved: Series[Bool] = pa.Field(coerce=True, nullable=True, description="Status of the edit timesheet request", alias="approved")
@@ -32,6 +42,26 @@ class Edit_timesheet_requestsGet(BrynQPanderaDataFrameModel):
     date: Series[String] = pa.Field(coerce=True, nullable=True, description="Date of the shift", alias="date")
     reference_date: Series[String] = pa.Field(coerce=True, nullable=True, description="Reference date for the shift", alias="reference_date")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "attendance_shift_id": {
+                "parent_schema": "ShiftsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "time_settings_break_configuration_id": {
+                "parent_schema": "Break_configurationsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Overtime_requestsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="", alias="id")
     employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="", alias="employee_id")
@@ -47,6 +77,26 @@ class Overtime_requestsGet(BrynQPanderaDataFrameModel):
     approver_full_name: Series[String] = pa.Field(coerce=True, nullable=True, description="", alias="approver_full_name")
     is_editable: Series[Bool] = pa.Field(coerce=True, nullable=False, description="Defines if the overtime request can be edited", alias="is_editable")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "approver_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "author_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class ShiftsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Unique identifier for the shift", alias="id")
     employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Identifier for the employee assigned to the shift", alias="employee_id")
@@ -74,6 +124,27 @@ class ShiftsGet(BrynQPanderaDataFrameModel):
     minutes: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Number in minutes of the shift", alias="minutes")
     clock_in_with_seconds: Series[String] = pa.Field(coerce=True, nullable=True, description="Clock in time with seconds", alias="clock_in_with_seconds")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "workplace_id": {
+                "parent_schema": "LocationsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "time_settings_break_configuration_id": {
+                "parent_schema": "Break_configurationsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+
+        }
+
 class Break_configurationsCreate(BaseModel):
     time_settings_break_configuration_id: int = Field(..., description="Id of the time settings break configuration", alias="time_settings_break_configuration_id")
     attendance_employees_setting_id: int = Field(..., description="Id of the attendance employee setting", alias="attendance_employees_setting_id")
@@ -191,4 +262,3 @@ class ShiftsUpdate(BaseModel):
 
 class ShiftsDelete(BaseModel):
     id: int = Field(..., description="ID", alias="id")
-

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial/schemas/banking_schemas.py

@@ -28,6 +28,16 @@ class Bank_accountsGet(BrynQPanderaDataFrameModel):
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="Last updated date.", alias="updated_at")
     legal_entity_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Factorial unique identifier of the legal entity.", alias="legal_entity_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class TransactionsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Factorial unique identifier.", alias="id")
     bank_account_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Factorial Banking Bank Account unique identifier.", alias="bank_account_id")
@@ -40,6 +50,16 @@ class TransactionsGet(BrynQPanderaDataFrameModel):
     value_date: Series[String] = pa.Field(coerce=True, nullable=False, description="Value date of the transaction.", alias="value_date")
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="Date when the transaction was last updated.", alias="updated_at")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "bank_account_id": {
+                "parent_schema": "Bank_accountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Bank_accountsCreate(BaseModel):
     id: int = Field(..., description="Factorial unique identifier.", alias="id")
     external_id: str = Field(..., description="External ID for the bank account.", alias="external_id")
@@ -65,4 +85,3 @@ class Bank_accountsDelete(BaseModel):
 
 class TransactionsDelete(BaseModel):
     id: int = Field(..., description="ID", alias="id")
-

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial/schemas/companies_schemas.py

@@ -21,6 +21,9 @@ class Legal_entitiesGet(BrynQPanderaDataFrameModel):
     address_line_1: Series[String] = pa.Field(coerce=True, nullable=True, description="Address line 1 of the legal entity", alias="address_line_1")
     address_line_2: Series[String] = pa.Field(coerce=True, nullable=True, description="Address line 2 of the legal entity", alias="address_line_2")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {}
+
 class Legal_entitiesDelete(BaseModel):
     id: int = Field(..., description="ID", alias="id")
-

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial/schemas/contracts_schemas.py

@@ -28,11 +28,30 @@ class CompensationsGet(BrynQPanderaDataFrameModel):
     minimum_amount_of_hours: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="", alias="minimum_amount_of_hours")
     minimum_amount_of_hours_in_cents: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Compensation expected minimum amount of hours in cents", alias="minimum_amount_of_hours_in_cents")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "contract_version_id": {
+                "parent_schema": "Contract_versionsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "contracts_taxonomy_id": {
+                "parent_schema": "TaxonomiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Contract_templatesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Unique identifier for the contract template", alias="id")
     company_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="ID of the company this template belongs to", alias="company_id")
     contract_version_type: Series[String] = pa.Field(coerce=True, nullable=True, description="Type of contract version (e.g., es for Spain, fr for France)", alias="contract_version_type")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {}
+
 class Contract_versionsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="identifier for the contract version.", alias="id")
     company_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="identifier for company.", alias="company_id")
@@ -85,36 +104,123 @@ class Contract_versionsGet(BrynQPanderaDataFrameModel):
     de_contract_type_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="contract type identifier.", alias="de_contract_type_id")
     pt_contract_type_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="contract type identifier.", alias="pt_contract_type_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "job_catalog_level_id": {
+                "parent_schema": "LevelsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "es_contract_type_id": {
+                "parent_schema": "Spanish_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "es_education_level_id": {
+                "parent_schema": "Spanish_education_levelsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "es_professional_category_id": {
+                "parent_schema": "Spanish_professional_categoriesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "fr_contract_type_id": {
+                "parent_schema": "French_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "de_contract_type_id": {
+                "parent_schema": "German_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "pt_contract_type_id": {
+                "parent_schema": "Portuguese_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class French_contract_typesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="identifier for the contract type", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="Contract type name", alias="name")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {}
+
 class German_contract_typesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="identifier for the contract type", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="Contract type name", alias="name")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {}
+
 class Portuguese_contract_typesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="identifier for the contract type", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="Contract type name", alias="name")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {}
+
 class Spanish_contract_typesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="identifier for the contract type", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="The name of the contract type", alias="name")
     default: Series[Bool] = pa.Field(coerce=True, nullable=True, description="This contract type is a predefined one", alias="default")
     contracts_contract_template_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="The contract template identifier. Refers to contracts/contract_templates.", alias="contracts_contract_template_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "contracts_contract_template_id": {
+                "parent_schema": "Contract_templatesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Spanish_education_levelsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Education level identifier", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="education level name", alias="name")
     default: Series[Bool] = pa.Field(coerce=True, nullable=True, description="Whether the education level is a predefined value", alias="default")
     contracts_contract_template_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Contract template identifier, refers to contracts/contract_templates", alias="contracts_contract_template_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "contracts_contract_template_id": {
+                "parent_schema": "Contract_templatesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Spanish_professional_categoriesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Professional category identifier", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="Professional category name", alias="name")
     default: Series[Bool] = pa.Field(coerce=True, nullable=True, description="Whether the professional category is a predefined value", alias="default")
     contracts_contract_template_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Contract template identifier, refers to contracts/contract_templates", alias="contracts_contract_template_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "contracts_contract_template_id": {
+                "parent_schema": "Contract_templatesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class TaxonomiesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="", alias="name")
@@ -122,6 +228,16 @@ class TaxonomiesGet(BrynQPanderaDataFrameModel):
     default: Series[Bool] = pa.Field(coerce=True, nullable=False, description="", alias="default")
     legal_entity_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="", alias="legal_entity_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class CompensationsCreate(BaseModel):
     contract_version_id: int = Field(..., description="", alias="contract_version_id")
     contracts_taxonomy_id: int = Field(..., description="", alias="contracts_taxonomy_id")
@@ -277,4 +393,3 @@ class Spanish_professional_categoriesDelete(BaseModel):
 
 class TaxonomiesDelete(BaseModel):
     id: int = Field(..., description="ID", alias="id")
-

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial/schemas/employee_updates_schemas.py

@@ -23,6 +23,21 @@ class AbsencesGet(BrynQPanderaDataFrameModel):
     leave_type_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="", alias="leave_type_id")
     leave_type_name: Series[String] = pa.Field(coerce=True, nullable=True, description="", alias="leave_type_name")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "leave_type_id": {
+                "parent_schema": "Leave_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Contract_changesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="The id of the contract change incidence", alias="id")
     status: Series[String] = pa.Field(coerce=True, nullable=False, description="The status of the contract change incidence", alias="status")
@@ -74,6 +89,71 @@ class Contract_changesGet(BrynQPanderaDataFrameModel):
     created_at: Series[String] = pa.Field(coerce=True, nullable=False, description="", alias="created_at")
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="", alias="updated_at")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "es_contract_type_id": {
+                "parent_schema": "Spanish_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "es_education_level_id": {
+                "parent_schema": "Spanish_education_levelsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "es_professional_category_id": {
+                "parent_schema": "Spanish_professional_categoriesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "fr_level_id": {
+                "parent_schema": "French_levelSchema",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "fr_step_id": {
+                "parent_schema": "French_stepSchema",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "fr_mutual_id": {
+                "parent_schema": "French_mutualSchema",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "fr_professional_category_id": {
+                "parent_schema": "French_professional_categoriesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "fr_work_type_id": {
+                "parent_schema": "French_work_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "fr_contract_type_id": {
+                "parent_schema": "French_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "de_contract_type_id": {
+                "parent_schema": "German_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "pt_contract_type_id": {
+                "parent_schema": "Portuguese_contract_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class New_hiresGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="The id of the new hire incidence", alias="id")
     status: Series[String] = pa.Field(coerce=True, nullable=False, description="The status of the new hire incidence", alias="status")
@@ -109,6 +189,31 @@ class New_hiresGet(BrynQPanderaDataFrameModel):
     legal_entity_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="The legal entity id of the new hire", alias="legal_entity_id")
     workplace_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="workplace id of the employee.", alias="workplace_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "manager_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "workplace_id": {
+                "parent_schema": "LocationsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Personal_changesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="The id of the new hire incidence", alias="id")
     status: Series[String] = pa.Field(coerce=True, nullable=False, description="The status of the new hire incidence", alias="status")
@@ -134,6 +239,21 @@ class Personal_changesGet(BrynQPanderaDataFrameModel):
     job_title: Series[String] = pa.Field(coerce=True, nullable=True, description="job title of the employee.", alias="job_title")
     workplace_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="workplace id of the employee.", alias="workplace_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "workplace_id": {
+                "parent_schema": "LocationsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class TerminationsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="", alias="id")
     status: Series[String] = pa.Field(coerce=True, nullable=False, description="", alias="status")
@@ -146,6 +266,21 @@ class TerminationsGet(BrynQPanderaDataFrameModel):
     termination_reason_type: Series[String] = pa.Field(coerce=True, nullable=True, description="", alias="termination_reason_type")
     termination_type_description: Series[String] = pa.Field(coerce=True, nullable=True, description="The description of the termination type.", alias="termination_type_description")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "employee_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class AbsencesDelete(BaseModel):
     id: int = Field(..., description="ID", alias="id")
 

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial/schemas/employees_schemas.py

@@ -58,6 +58,31 @@ class EmployeesGet(BrynQPanderaDataFrameModel):
     disability_percentage_cents: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="officially certified level of disability granted by public administration for individuals with physical or mental impairments, expressed in cents", alias="disability_percentage_cents")
     identifier_expiration_date: Series[String] = pa.Field(coerce=True, nullable=True, description="identifier expiration date", alias="identifier_expiration_date")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "location_id": {
+                "parent_schema": "LocationsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "manager_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "timeoff_manager_id": {
+                "parent_schema": "EmployeesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class EmployeesCreate(BaseModel):
     id: int = Field(..., description="id of the employee.", alias="id")
     access_id: int = Field(..., description="access_id associated to the employee.", alias="access_id")
@@ -160,4 +185,3 @@ class EmployeesUpdate(BaseModel):
 
 class EmployeesDelete(BaseModel):
     id: int = Field(..., description="ID", alias="id")
-

brynq_sdk_factorial-2.2.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.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial/schemas/finance_schemas.py

@@ -24,6 +24,61 @@ class Accounting_settingsGet(BrynQPanderaDataFrameModel):
     default_account_for_clients_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Default account for clients.", alias="default_account_for_clients_id")
     default_account_for_benefits_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Default account for benefits.", alias="default_account_for_benefits_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_purchase_invoices_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_vendors_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_banks_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_suspense_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_expenses_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_employees_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_sale_invoices_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_clients_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "default_account_for_benefits_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class AccountsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Unique identifier in factorial for the ledger account", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=True, description="Name of the ledger account", alias="name")
@@ -34,6 +89,16 @@ class AccountsGet(BrynQPanderaDataFrameModel):
     external_id: Series[String] = pa.Field(coerce=True, nullable=True, description="Id of the ledger account on the external system", alias="external_id")
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="Last updated date of the ledger account", alias="updated_at")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class ContactsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Unique identifier for the Contact.", alias="id")
     tax_id: Series[String] = pa.Field(coerce=True, nullable=False, description="Tax identification number assigned to the Contact.", alias="tax_id")
@@ -45,6 +110,10 @@ class ContactsGet(BrynQPanderaDataFrameModel):
     bank_code: Series[String] = pa.Field(coerce=True, nullable=True, description="Bank or branch code for the Contact if relevant.", alias="bank_code")
     preferred_payment_method: Series[String] = pa.Field(coerce=True, nullable=True, description="Preferred payment method for the Contact (e.g. wire_transfer, paypal).", alias="preferred_payment_method")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {}
+
 class Cost_centersGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="", alias="name")
@@ -57,6 +126,16 @@ class Cost_centersGet(BrynQPanderaDataFrameModel):
     status: Series[String] = pa.Field(coerce=True, nullable=False, description="", alias="status")
     deactivation_date: Series[String] = pa.Field(coerce=True, nullable=True, description="", alias="deactivation_date")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Financial_documentsGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Factorial unique identifier.", alias="id")
     net_amount_cents: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Net amount in cents.", alias="net_amount_cents")
@@ -76,10 +155,40 @@ class Financial_documentsGet(BrynQPanderaDataFrameModel):
     duplicate_financial_document_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Factorial unique identifier for the duplicate financial document.", alias="duplicate_financial_document_id")
     validated_at: Series[String] = pa.Field(coerce=True, nullable=True, description="Date when was validated.", alias="validated_at")
     validated_by_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Factorial unique identifier for the user who validated the financial document.", alias="validated_by_id")
-    document_type: Series[String] = pa.Field(coerce=True, nullable=False, description="Type of the financial document. Using "invoice" as default.", alias="document_type")
+    document_type: Series[String] = pa.Field(coerce=True, nullable=False, description="Type of the financial document. Using 'invoice' as default.", alias="document_type")
     parent_financial_document_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Factorial unique identifier for the parent financial document of the financial document.", alias="parent_financial_document_id")
     taxes_total_amount_cents: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Taxes total amount in cents.", alias="taxes_total_amount_cents")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "vendor_id": {
+                "parent_schema": "ContactsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "duplicate_financial_document_id": {
+                "parent_schema": "Financial_documentsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "validated_by_id": {
+                "parent_schema": "UserSchema",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "parent_financial_document_id": {
+                "parent_schema": "Financial_documentsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Journal_entriesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Journal entry ID", alias="id")
     number: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Incremental number assigned to the journal entry", alias="number")
@@ -94,6 +203,16 @@ class Journal_entriesGet(BrynQPanderaDataFrameModel):
     status: Series[String] = pa.Field(coerce=True, nullable=False, description="The status of the journal entry (draft, published, etc.)", alias="status")
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="Timestamp when the journal entry was last updated.", alias="updated_at")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Journal_linesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Factorial id", alias="id")
     number: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Sequential number assigned to the line", alias="number")
@@ -105,6 +224,21 @@ class Journal_linesGet(BrynQPanderaDataFrameModel):
     external_id: Series[String] = pa.Field(coerce=True, nullable=True, description="External identifier for the journal line", alias="external_id")
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="Timestamp when the journal line was last updated.", alias="updated_at")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "journal_entry_id": {
+                "parent_schema": "Journal_entriesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "account_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Ledger_account_resourcesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Factorial unique identifier.", alias="id")
     resource_type: Series[String] = pa.Field(coerce=True, nullable=False, description="Ledger account resource type.", alias="resource_type")
@@ -115,6 +249,21 @@ class Ledger_account_resourcesGet(BrynQPanderaDataFrameModel):
     external_id: Series[String] = pa.Field(coerce=True, nullable=True, description="External identifier.", alias="external_id")
     legal_entity_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Factorial unique identifier of the Legal entity.", alias="legal_entity_id")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "account_id": {
+                "parent_schema": "AccountsGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            },
+            "legal_entity_id": {
+                "parent_schema": "Legal_entitiesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Tax_ratesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Factorial id", alias="id")
     rate: Series[Float] = pa.Field(coerce=True, nullable=False, description="Specifies the numerical percentage for the tax rate between -1 and 1.", alias="rate")
@@ -123,6 +272,16 @@ class Tax_ratesGet(BrynQPanderaDataFrameModel):
     external_id: Series[String] = pa.Field(coerce=True, nullable=True, description="The external id of the tax rate.", alias="external_id")
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="Last update date of the tax rate.", alias="updated_at")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {
+            "tax_type_id": {
+                "parent_schema": "Tax_typesGet",
+                "parent_column": "id",
+                "cardinality": "N:1"
+            }
+        }
+
 class Tax_typesGet(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=False, description="Factorial id", alias="id")
     name: Series[String] = pa.Field(coerce=True, nullable=False, description="The name assigned to the tax type.", alias="name")
@@ -131,6 +290,10 @@ class Tax_typesGet(BrynQPanderaDataFrameModel):
     external_id: Series[String] = pa.Field(coerce=True, nullable=True, description="The external id of the tax type.", alias="external_id")
     updated_at: Series[String] = pa.Field(coerce=True, nullable=False, description="Last update date of the tax type.", alias="updated_at")
 
+    class _Annotation:
+        primary_key = "id"
+        foreign_keys = {}
+
 class Accounting_settingsCreate(BaseModel):
     id: int = Field(..., description="Identifier for the AccountingSetting.", alias="id")
     external_id: Optional[str] = Field(None, description="External ID for the accounting setting.", alias="external_id")
@@ -211,7 +374,7 @@ class Journal_entriesCreate(BaseModel):
     external_id: Optional[str] = Field(None, description="External identifier for the journal entry", alias="external_id")
     legal_entity_id: int = Field(..., description="The associated Legal Entity ID", alias="legal_entity_id")
     type: Optional[Annotated[str, StringConstraints(pattern=r'^bank|bill|invoice|credit_note|merged_ledger_account|reconciliation|tax|receipt|payroll_result|external$', strip_whitespace=True)]] = Field(None, description="Journal entry type (e.g. bank, invoice, tax)", alias="type")
-    lines: str = Field(..., description="Array of journal lines for this entry, example: [{"account_id": 9876, "debit_amount_cents": 0, "credit_amount_cents": 100, "external_id": "LINE-001"}, {"account_id": 9876, "debit_amount_cents": 100, "credit_amount_cents": 0, "external_id": "LINE-002"}]", alias="lines")
+    lines: str = Field(..., description="Array of journal lines for this entry, example: [{'account_id': 9876, 'debit_amount_cents': 0, 'credit_amount_cents': 100, 'external_id': 'LINE-001'}, {'account_id': 9876, 'debit_amount_cents': 100, 'credit_amount_cents': 0, 'external_id': 'LINE-002'}]", alias="lines")
     reference_date: str = Field(..., description="Date of the associate source", alias="reference_date")
     description: Optional[str] = Field(None, description="Description of the journal entry", alias="description")
     status: Optional[Annotated[str, StringConstraints(pattern=r'^published|reversed$', strip_whitespace=True)]] = Field(None, description="Status of the journal entry (reversed, published, etc.)", alias="status")
@@ -268,4 +431,3 @@ class Tax_typesUpdate(BaseModel):
 
 class Tax_typesDelete(BaseModel):
     id: int = Field(..., description="ID", alias="id")
-

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.0}/brynq_sdk_factorial.egg-info/PKG-INFO

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

{brynq_sdk_factorial-2.0.0 → brynq_sdk_factorial-2.2.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.0.0 → brynq_sdk_factorial-2.2.0}/setup.py

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