brynq-sdk-bob 2.6.0__tar.gz → 2.6.2.dev1__tar.gz

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_bob
-Version: 2.6.0
+Version: 2.6.2.dev1
 Summary: Bob wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/__init__.py

@@ -45,6 +45,10 @@ class Bob(BrynQ):
 
     def _get_request_headers(self, system_type):
         credentials = self.interfaces.credentials.get(system='bob', system_type=system_type)
+        if type(credentials) is list:
+            credentials = credentials[0]
+
+        print(credentials)
         auth_token = base64.b64encode(f"{credentials.get('data').get('User ID')}:{credentials.get('data').get('API Token')}".encode()).decode('utf-8')
         headers = {
             "accept": "application/json",

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/bank.py

@@ -2,6 +2,8 @@ import pandas as pd
 from brynq_sdk_functions import Functions
 from .schemas.bank import BankSchema
 
+import time
+from tqdm import tqdm
 
 class Bank:
     def __init__(self, bob):
@@ -10,7 +12,7 @@ class Bank:
 
     def get(self, person_ids: pd.Series, field_selection: list[str] = []) -> (pd.DataFrame, pd.DataFrame):
         data = []
-        for person_id in person_ids:
+        for person_id in tqdm(person_ids, desc="Fetching bank accounts"):
             resp = self.bob.session.get(url=f"{self.bob.base_url}people/{person_id}/bank-accounts", timeout=self.bob.timeout)
             resp.raise_for_status()
             temp_data = resp.json()['values']
@@ -19,6 +21,9 @@ class Bank:
                 account['employee_id'] = person_id
             data += temp_data
 
+            # rate limit is 50 per minute
+            time.sleep(1.3)
+
         df = pd.DataFrame(data)
 
         valid_banks, invalid_banks = Functions.validate_data(df=df, schema=BankSchema, debug=True)

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/custom_tables.py

@@ -29,7 +29,7 @@ class CustomTables:
             record_path=['values']
         )
 
-        df['employeeId'] = employee_id
+        df['employee_id'] = employee_id
         valid_data, invalid_data = Functions.validate_data(df=df, schema=self.schema, debug=True)
 
         return valid_data, invalid_data

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/payments.py

@@ -3,23 +3,67 @@ from typing import Optional, List
 from brynq_sdk_functions import Functions
 from .schemas.payments import VariablePaymentSchema, ActualPaymentsSchema
 
+import time
+from tqdm import tqdm
+
 
 class Payments:
     def __init__(self, bob):
         self.bob = bob
         self.schema = VariablePaymentSchema
 
-    def get(self, person_id: str) -> (pd.DataFrame, pd.DataFrame):
-        resp = self.bob.session.get(url=f"{self.bob.base_url}people/{person_id}/variable", timeout=self.bob.timeout)
-        resp.raise_for_status()
-        data = resp.json()
-        df = pd.json_normalize(
-            data,
-            record_path='values'
+    def _apply_named_list_mappings(self, df: pd.DataFrame) -> pd.DataFrame:
+        """Apply named list ID-to-value mappings to dataframe columns."""
+        if df.empty:
+            return df
+
+        # Fetch named lists from Bob API
+        resp_named_lists = self.bob.session.get(
+            url=f"{self.bob.base_url}company/named-lists",
+            timeout=self.bob.timeout,
+            headers=self.bob.headers
         )
-        df['employee_id'] = person_id
-        valid_payments, invalid_payments = Functions.validate_data(df=df, schema=self.schema, debug=True)
+        named_lists = resp_named_lists.json()
 
+        # Transform named_lists to create id-to-value mappings for each field
+        named_lists = {
+            key.split('.')[-1]: {item['id']: item['value'] for item in value['values']}
+            for key, value in named_lists.items()
+        }
+
+        for field in df.columns:
+            # Fields in the response and in the named-list have different building blocks
+            # but they both end with the same last block
+            field_df = field.split('.')[-1].split('work_')[-1]
+            if field_df in named_lists.keys() and field_df not in ['site']:
+                mapping = named_lists[field_df]
+                df[field] = df[field].apply(
+                    lambda v: [mapping.get(x, x) for x in v] if isinstance(v, list) else mapping.get(v, v)
+                )
+
+        return df
+
+    def get(self, person_ids: List[str]) -> (pd.DataFrame, pd.DataFrame):
+        df = pd.DataFrame()
+        for person_id in tqdm(person_ids, desc="Fetching variable payments"):
+            resp = self.bob.session.get(url=f"{self.bob.base_url}people/{person_id}/variable", timeout=self.bob.timeout)
+            resp.raise_for_status()
+            data = resp.json()
+            df = pd.concat([df, pd.json_normalize(
+                data,
+                record_path='values'
+            )])
+            df['employee_id'] = person_id
+
+            # Rate limit is 50 per minute
+            time.sleep(1.3)
+
+        df = df.reset_index(drop=True)
+
+        # Apply named list mappings
+        df = self._apply_named_list_mappings(df)
+
+        valid_payments, invalid_payments = Functions.validate_data(df=df, schema=self.schema, debug=True)
         return valid_payments, invalid_payments
 
     def get_actual_payments(
@@ -105,6 +149,9 @@ class Payments:
 
         df = pd.json_normalize(all_results)
 
+        # Apply named list mappings
+        df = self._apply_named_list_mappings(df)
+
         valid_payments, invalid_payments = Functions.validate_data(
             df=df,
             schema=ActualPaymentsSchema,

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/people.py

@@ -1,5 +1,5 @@
 import pandas as pd
-from typing import Optional
+from typing import Optional, List
 from brynq_sdk_functions import Functions
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
 from .bank import Bank
@@ -29,25 +29,69 @@ class People:
             for col_name, col in schema.columns.items()
         ]
 
-    def get(self, schema_custom_fields: Optional[BrynQPanderaDataFrameModel] = None) -> pd.DataFrame:
-
+    def get(self, schema_custom_fields: Optional[BrynQPanderaDataFrameModel] = None, employee_ids: Optional[List[str]] = None) -> pd.DataFrame:
         core_fields = self.__build_api_fields(PeopleSchema)
         custom_fields = self.__build_api_fields(schema_custom_fields) if schema_custom_fields is not None else []
         fields = core_fields + custom_fields
 
+        # Build filters based on employee_ids if provided
+        filters = []
+        if employee_ids is not None:
+            filters = [
+                {
+                    "fieldPath": "root.id",
+                    "operator": "equals",
+                    "values": employee_ids
+                }
+            ]
+
         resp = self.bob.session.post(url=f"{self.bob.base_url}people/search",
                                       json={
                                           "fields": fields,
-                                          "filters": []
+                                          "filters": filters
                                           #"humanReadable": "REPLACE"
                                       },
                                       timeout=self.bob.timeout)
         resp.raise_for_status()
         df = pd.json_normalize(resp.json()['employees'])
+        if df.empty and employee_ids is not None and resp.status_code == 200:
+            raise Exception(f"No employees found in HiBob for employee_ids: {employee_ids}")
+
         df = df.loc[:, ~df.columns.str.contains('value')]
+
         # Normalize separators in incoming data: convert '/' to '.' to match schema aliases
         df.columns = df.columns.str.replace('/', '.', regex=False)
 
+        # A lot of fields from Bob are returned with only ID's. Those fields should be mapped to names. Therefore, we need to get the mapping from the named-lists endpoint.
+        resp_named_lists = self.bob.session.get(url=f"{self.bob.base_url}company/named-lists", timeout=self.bob.timeout, headers=self.bob.headers)
+        named_lists = resp_named_lists.json()
+        # save json to file
+        # import json
+        # with open('named_lists.json', 'w') as f:
+        #     json.dump(named_lists, f, indent=4)
+
+        # Transform named_lists to create id-to-value mappings for each field
+        named_lists = {key.split('.')[-1]: {item['id']: item['value'] for item in value['values']} for key, value in named_lists.items()}
+
+        deviating_named_list_cols_mapping = {
+            'payroll.employment.type': 'payrollEmploymentType',
+            'home.familyStatus': 'familystatus',
+            'personal.nationality': 'nationalities',
+        }
+
+        for field in df.columns:
+            # Fields in the response and in the named-list does have different building blocks (e.g. people.payroll.entitlement. or people.entitlement.). But they both end with the same last block
+            field_df = field.split('.')[-1].split('work_')[-1]
+
+            # Check if this field has a deviating mapping
+            named_list_key = deviating_named_list_cols_mapping.get(field, field_df)
+
+            if named_list_key in named_lists.keys() and named_list_key not in ['site']:
+                mapping = named_lists[named_list_key]
+                df[field] = df[field].apply(
+                    lambda v: [mapping.get(x, x) for x in v] if isinstance(v, list) else mapping.get(v, v)
+                )
+
         if schema_custom_fields is not None:
             valid_people, invalid_people_custom = Functions.validate_data(df=df, schema=schema_custom_fields, debug=True)
         else:

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/salaries.py

@@ -1,5 +1,6 @@
 import pandas as pd
 import requests
+from typing import Optional, List
 from brynq_sdk_functions import Functions
 from .schemas.salary import SalarySchema, SalaryCreateSchema
 
@@ -9,10 +10,16 @@ class Salaries:
         self.bob = bob
         self.schema = SalarySchema
 
-    def get(self) -> tuple[pd.DataFrame, pd.DataFrame]:
+    def get(self, employee_ids: Optional[List[str]] = None) -> tuple[pd.DataFrame, pd.DataFrame]:
+        params = {"limit": 100}
+
+        # Add employeeIds filter if provided
+        if employee_ids is not None:
+            params["employeeIds"] = ",".join(employee_ids)
+
         request = requests.Request(method='GET',
                                    url=f"{self.bob.base_url}bulk/people/salaries",
-                                   params={"limit": 100})
+                                   params=params)
         data = self.bob.get_paginated_result(request)
         df = pd.json_normalize(
             data,

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/schemas/bank.py

@@ -1,4 +1,5 @@
 import pandera as pa
+from typing import Optional
 from pandera.typing import Series, String
 import pandas as pd
 from brynq_sdk_functions import BrynQPanderaDataFrameModel
@@ -6,19 +7,19 @@ from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
 class BankSchema(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Bank ID", alias="id")
-    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
-    amount: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Amount", alias="amount")
-    allocation: Series[String] = pa.Field(coerce=True, nullable=True, description="Allocation", alias="allocation")
-    branch_address: Series[String] = pa.Field(coerce=True, nullable=True, description="Branch Address", alias="branchAddress")
+    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employee_id")
+    amount: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, description="Amount", alias="amount")
+    allocation: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Allocation", alias="allocation")
+    branch_address: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Branch Address", alias="branchAddress")
     bank_name: Series[String] = pa.Field(coerce=True, nullable=True, description="Bank Name", alias="bankName")
     account_number: Series[String] = pa.Field(coerce=True, nullable=True, description="Account Number", alias="accountNumber")
-    routing_number: Series[String] = pa.Field(coerce=True, nullable=True, description="Routing Number", alias="routingNumber")
+    routing_number: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Routing Number", alias="routingNumber")
     bank_account_type: Series[String] = pa.Field(coerce=True, nullable=True, description="Bank Account Type", alias="bankAccountType")
-    bic_or_swift: Series[String] = pa.Field(coerce=True, nullable=True, description="BIC or SWIFT", alias="bicOrSwift")
+    bic_or_swift: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="BIC or SWIFT", alias="bicOrSwift")
     changed_by: Series[String] = pa.Field(coerce=True, nullable=True, description="Changed By", alias="changedBy")
     iban: Series[String] = pa.Field(coerce=True, description="IBAN", alias="iban")
     account_nickname: Series[String] = pa.Field(coerce=True, nullable=True, description="Account Nickname", alias="accountNickname")
-    use_for_bonus: Series[pd.BooleanDtype] = pa.Field(coerce=True, nullable=True, description="Use for Bonus", alias="useForBonus")
+    use_for_bonus: Optional[Series[pd.BooleanDtype]] = pa.Field(coerce=True, nullable=True, description="Use for Bonus", alias="useForBonus")
 
     class Config:
         coerce = True

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/schemas/people.py

@@ -16,7 +16,7 @@ def check_list(x):
 
 
 class PeopleSchema(BrynQPanderaDataFrameModel):
-    id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, description="Person ID", alias="id", metadata={"api_field": "root.id"})
+    id: Optional[Series[String]] = pa.Field(coerce=True, description="Person ID", alias="id", metadata={"api_field": "root.id"})
     display_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Display Name", alias="displayName", metadata={"api_field": "root.displayName"})
     company_id: Optional[Series[String]] = pa.Field(coerce=True, description="Company ID", alias="companyId", metadata={"api_field": "root.companyId"})
     email: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Email", alias="email", metadata={"api_field": "root.email"})
@@ -50,7 +50,7 @@ class PeopleSchema(BrynQPanderaDataFrameModel):
     work_reports_to_display_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to Display Name", alias="work.reportsTo.displayName")
     work_reports_to_surname: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to Surname", alias="work.reportsTo.surname")
     work_reports_to_first_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to First Name", alias="work.reportsTo.firstName")
-    work_reports_to_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Reports to ID", alias="work.reportsTo.id")
+    work_reports_to_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to ID", alias="work.reportsTo.id")
     work_work_mobile: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Work Mobile", alias="work.workMobile")
     work_indirect_reports: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Indirect Reports", alias="work.indirectReports")
     work_site_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Site ID", alias="work.siteId")
@@ -106,7 +106,7 @@ class PeopleSchema(BrynQPanderaDataFrameModel):
     internal_termination_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Internal Termination Date", alias="internal.terminationDate")
     internal_termination_type: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Internal Termination Type", alias="internal.terminationType")
     employee_last_day_of_work: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Employee Last Day of Work", alias="employee.lastDayOfWork")
-    financial_iban: Series[String] = pa.Field(coerce=True, nullable=True, alias='financial.iban')
+    financial_iban: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, alias='financial.iban')
     employee_band_effective_date_ote: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Employee Band Effective Date OTE", alias="employee.band_effectiveDate_ote")
     employee_band_site_ote: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band Site OTE", alias="employee.band_site_ote")
     employee_band_min_ote: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Min OTE", alias="employee.band_min_ote")

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/schemas/salary.py

@@ -11,7 +11,7 @@ from typing import Optional, Dict, Any
 
 class SalarySchema(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Salary ID", alias="id")
-    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
     pay_frequency: Series[String] = pa.Field(coerce=True, nullable=True, description="Pay Frequency", alias="payFrequency") # has a list of possible values , isin=['Monthly']
     creation_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Creation Date", alias="creationDate")
     is_current: Series[Bool] = pa.Field(coerce=True, description="Is Current", alias="isCurrent")

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob/schemas/timeoff.py

@@ -12,19 +12,19 @@ class TimeOffSchema(BrynQPanderaDataFrameModel):
     request_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Request ID", alias="requestId")
     policy_type_display_name: Series[String] = pa.Field(coerce=True, description="Policy Type Display Name", alias="policyTypeDisplayName")
     type: Series[String] = pa.Field(coerce=True, description="Type", alias="type")
-    start_date: Series[String] = pa.Field(coerce=True, description="Start Date", alias="startDate")
-    start_portion: Series[String] = pa.Field(coerce=True, description="Start Portion", alias="startPortion")
-    end_date: Series[String] = pa.Field(coerce=True, description="End Date", alias="endDate")
-    end_portion: Series[String] = pa.Field(coerce=True, description="End Portion", alias="endPortion")
-    day_portion: Optional[Series[String]] = pa.Field(coerce=True, description="Day Portion", alias="dayPortion")
-    date: Optional[Series[String]] = pa.Field(coerce=True, description="Date", alias="date")
-    hours_on_date: Optional[Series[Float]] = pa.Field(coerce=True, description="Hours on Date", alias="hoursOnDate")
-    daily_hours: Optional[Series[Float]] = pa.Field(coerce=True, description="Daily Hours", alias="dailyHours")
-    duration_unit: Optional[Series[String]] = pa.Field(coerce=True, description="Duration Unit", alias="durationUnit")
-    total_duration: Optional[Series[Float]] = pa.Field(coerce=True, description="Total Duration", alias="totalDuration")
-    total_cost: Optional[Series[Float]] = pa.Field(coerce=True, description="Total Cost", alias="totalCost")
+    start_date: Series[String] = pa.Field(coerce=True, nullable=True, description="Start Date", alias="startDate")
+    start_portion: Series[String] = pa.Field(coerce=True, nullable=True, description="Start Portion", alias="startPortion")
+    end_date: Series[String] = pa.Field(coerce=True, nullable=True, description="End Date", alias="endDate")
+    end_portion: Series[String] = pa.Field(coerce=True, nullable=True, description="End Portion", alias="endPortion")
+    day_portion: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Day Portion", alias="dayPortion")
+    date: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Date", alias="date")
+    hours_on_date: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Hours on Date", alias="hoursOnDate")
+    daily_hours: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Daily Hours", alias="dailyHours")
+    duration_unit: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Duration Unit", alias="durationUnit")
+    total_duration: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Total Duration", alias="totalDuration")
+    total_cost: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Total Cost", alias="totalCost")
     change_reason: Optional[Series[String]] = pa.Field(nullable=True, coerce=True, description="Change Reason", alias="changeReason")
-    visibility: Optional[Series[String]] = pa.Field(coerce=True, description="Visibility", alias="visibility")
+    visibility: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Visibility", alias="visibility")
 
     class Config:
         coerce = True

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/brynq_sdk_bob.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-bob
-Version: 2.6.0
+Version: 2.6.2.dev1
 Summary: Bob wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_bob-2.6.0 → brynq_sdk_bob-2.6.2.dev1}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_bob',
-    version='2.6.0',
+    version='2.6.2.dev1',
     description='Bob wrapper from BrynQ',
     long_description='Bob wrapper from BrynQ',
     author='BrynQ',