brynq-sdk-bob 2.2.1__tar.gz → 2.4.0__tar.gz

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq_sdk_bob
-Version: 2.2.1
+Version: 2.4.0
 Summary: Bob wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

brynq_sdk_bob-2.4.0/brynq_sdk_bob/payments.py

@@ -0,0 +1,114 @@
+import pandas as pd
+from typing import Optional, List
+from brynq_sdk_functions import Functions
+from .schemas.payments import VariablePaymentSchema, ActualPaymentsSchema
+
+
+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'
+        )
+        df['employee_id'] = person_id
+        valid_payments, invalid_payments = Functions.validate_data(df=df, schema=self.schema, debug=True)
+
+        return valid_payments, invalid_payments
+
+    def get_actual_payments(
+        self,
+        limit: int = 200,
+        employee_ids: Optional[List[str]] = None,
+        pay_date_from: Optional[str] = None,
+        pay_date_to: Optional[str] = None
+    ) -> (pd.DataFrame, pd.DataFrame):
+        """
+        Search for actual payments with optional employee and pay date filters.
+        This method auto-paginates until all results are fetched.
+
+        See Bob API: https://apidocs.hibob.com/reference/post_people-actual-payments-search
+        See Pagination: https://apidocs.hibob.com/docs/pagination
+
+        Args:
+            limit (int): Number of records per page (default: 50, max: 200).
+            employee_ids (Optional[List[str]]): Filter by employee IDs.
+            pay_date_from (Optional[str]): Inclusive start date filter (YYYY-MM-DD).
+            pay_date_to (Optional[str]): Inclusive end date filter (YYYY-MM-DD).
+
+        Returns:
+            tuple: (valid_payments DataFrame, invalid_payments DataFrame)
+        """
+        base_payload = {
+            "pagination": {
+                "limit": limit
+            }
+        }
+
+        filters = []
+        if employee_ids:
+            filters.append({
+                "fieldPath": "employeeId",
+                "operator": "equals",
+                "values": employee_ids
+            })
+        if pay_date_from:
+            filters.append({
+                "fieldPath": "payDate",
+                "operator": "greaterThanOrEquals",
+                "value": pay_date_from
+            })
+        if pay_date_to:
+            filters.append({
+                "fieldPath": "payDate",
+                "operator": "lessThanOrEquals",
+                "value": pay_date_to
+            })
+
+        if filters:
+            base_payload["filters"] = filters
+
+        all_results = []
+        next_cursor = None
+
+        while True:
+            payload = dict(base_payload)
+            payload["pagination"] = dict(base_payload["pagination"])
+            if next_cursor:
+                payload["pagination"]["cursor"] = next_cursor
+
+            resp = self.bob.session.post(
+                url=f"{self.bob.base_url}people/actual-payments/search",
+                json=payload,
+                timeout=self.bob.timeout
+            )
+            resp.raise_for_status()
+            data = resp.json()
+
+            page_results = data.get('results') or []
+            if page_results:
+                all_results.extend(page_results)
+
+            next_cursor = (data.get('response_metadata') or {}).get('next_cursor')
+            if not next_cursor:
+                break
+
+        if not all_results:
+            empty_df = pd.DataFrame()
+            return empty_df, empty_df
+
+        df = pd.json_normalize(all_results)
+
+        valid_payments, invalid_payments = Functions.validate_data(
+            df=df,
+            schema=ActualPaymentsSchema,
+            debug=True
+        )
+
+        return valid_payments, invalid_payments

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/brynq_sdk_bob/schemas/payments.py

@@ -26,6 +26,20 @@ class VariablePaymentSchema(BrynQPanderaDataFrameModel):
     change_reason: Series[String] = pa.Field(nullable=True, coerce=True, description="Change Reason", alias="change.reason")
     change_changed_by: Series[String] = pa.Field(nullable=True, coerce=True, description="Change Changed By", alias="change.changedBy")
     change_changed_by_id: Series[pd.Int64Dtype] = pa.Field(nullable=True, coerce=True, description="Change Changed By ID", alias="change.changedById")
-    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="employeeId") #set manually
+    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="employee_id") #set manually
+    class Config:
+        coerce = True
+
+class ActualPaymentsSchema(BrynQPanderaDataFrameModel):
+    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Payment ID", alias="id")
+    pay_date: Series[DateTime] = pa.Field(coerce=True, description="Pay Date", alias="payDate")
+    pay_type: Series[String] = pa.Field(coerce=True, description="Pay Type", alias="payType")
+    amount_value: Series[Float] = pa.Field(coerce=True, description="Amount Value", alias="amount.value")
+    amount_currency: Series[String] = pa.Field(coerce=True, description="Amount Currency", alias="amount.currency")
+    change_reason: Series[String] = pa.Field(nullable=True, coerce=True, description="Change Reason", alias="change.reason")
+    change_changed_by: Series[String] = pa.Field(nullable=True, coerce=True, description="Change Changed By", alias="change.changedBy")
+    change_changed_by_id: Series[String] = pa.Field(nullable=True, coerce=True, description="Change Changed By ID", alias="change.changedById")
+
     class Config:
         coerce = True

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/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")
+    id: Optional[Series[String]] = pa.Field(coerce=True, description="Person ID", alias="id")
     display_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Display Name", alias="displayName")
     company_id: Optional[Series[String]] = pa.Field(coerce=True, description="Company ID", alias="companyId")
     email: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Email", alias="email")
@@ -63,7 +63,7 @@ class PeopleSchema(BrynQPanderaDataFrameModel):
     work_active_effective_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Work Active Effective Date", alias="work.activeEffectiveDate")
     work_direct_reports: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Direct Reports", alias="work.directReports")
     # work_work_change_type: Series[String] = pa.Field(coerce=True, nullable=True)
-    work_second_level_manager: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Second Level Manager", alias="work.secondLevelManager")
+    work_second_level_manager: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Second Level Manager", alias="work.secondLevelManager")
     work_days_of_previous_service: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Days of Previous Service", alias="work.daysOfPreviousService")
     work_years_of_service: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Work Years of Service", alias="work.yearsOfService")
     payroll_employment_contract: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Contract Type", alias="payroll.employment.contract")

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/brynq_sdk_bob/schemas/salary.py

@@ -7,7 +7,7 @@ from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
 
 class SalarySchema(BrynQPanderaDataFrameModel):
-    id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Salary ID", alias="id")
+    id: Series[String] = pa.Field(coerce=True, description="Salary ID", alias="id")
     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")

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/brynq_sdk_bob/schemas/timeoff.py

@@ -27,3 +27,21 @@ class TimeOffSchema(BrynQPanderaDataFrameModel):
 
     class Config:
         coerce = True
+
+
+class TimeOffBalanceSchema(BrynQPanderaDataFrameModel):
+    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    policy_type_name: Series[String] = pa.Field(coerce=True, description="Policy Type Name", alias="policyTypeName")
+    policy_type_display_name: Series[String] = pa.Field(coerce=True, description="Policy Type Display Name", alias="policyTypeDisplayName")
+    balance: Series[Float] = pa.Field(coerce=True, description="Current Balance", alias="balance")
+    used: Series[Float] = pa.Field(coerce=True, description="Used Balance", alias="used")
+    available: Series[Float] = pa.Field(coerce=True, description="Available Balance", alias="available")
+    approved_requests: Series[Float] = pa.Field(coerce=True, description="Approved Requests", alias="approvedRequests")
+    pending_requests: Series[Float] = pa.Field(coerce=True, description="Pending Requests", alias="pendingRequests")
+    as_of_date: Series[String] = pa.Field(coerce=True, description="As of Date", alias="asOfDate")
+    accrual_start_date: Series[String] = pa.Field(nullable=True, coerce=True, description="Accrual Start Date", alias="accrualStartDate")
+    expiry_date: Series[String] = pa.Field(nullable=True, coerce=True, description="Expiry Date", alias="expiryDate")
+    duration_unit: Series[String] = pa.Field(coerce=True, description="Duration Unit", alias="durationUnit")
+
+    class Config:
+        coerce = True

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/brynq_sdk_bob/timeoff.py

@@ -1,7 +1,7 @@
 from datetime import datetime, timezone, timedelta
 import pandas as pd
 from brynq_sdk_functions import Functions
-from .schemas.timeoff import TimeOffSchema
+from .schemas.timeoff import TimeOffSchema, TimeOffBalanceSchema
 import warnings
 
 
@@ -9,6 +9,7 @@ class TimeOff:
     def __init__(self, bob):
         self.bob = bob
         self.schema = TimeOffSchema
+        self.balance_schema = TimeOffBalanceSchema
 
     def get(self, since: datetime = None) -> tuple[pd.DataFrame, pd.DataFrame]:
         """
@@ -49,3 +50,34 @@ class TimeOff:
         valid_timeoff, invalid_timeoff = Functions.validate_data(df=df, schema=self.schema, debug=True)
 
         return valid_timeoff, invalid_timeoff
+
+    def get_balance(self, employee_id: str, policy_type: str = None, as_of_date: str = None) -> tuple[pd.DataFrame, pd.DataFrame]:
+        """
+        Get time off balance for a specific employee
+
+        Args:
+            employee_id (str): The ID of the employee
+            policy_type (str, optional): The policy type to filter by. Defaults to None.
+            as_of_date (str, optional): The date to get balance as of (YYYY-MM-DD format). Defaults to None.
+
+        Returns:
+            tuple[pd.DataFrame, pd.DataFrame]: A tuple of (valid_balance, invalid_balance) as pandas DataFrames
+        """
+        params = {}
+        if policy_type:
+            params['policyType'] = policy_type
+        if as_of_date:
+            params['asOfDate'] = as_of_date
+
+        resp = self.bob.session.get(
+            url=f"{self.bob.base_url}timeoff/employees/{employee_id}/balance",
+            params=params,
+            timeout=self.bob.timeout
+        )
+        resp.raise_for_status()
+        data = resp.json()
+        df = pd.DataFrame(data)
+
+        valid_balance, invalid_balance = Functions.validate_data(df=df, schema=self.balance_schema, debug=True)
+
+        return valid_balance, invalid_balance

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/brynq_sdk_bob.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 1.0
 Name: brynq-sdk-bob
-Version: 2.2.1
+Version: 2.4.0
 Summary: Bob wrapper from BrynQ
 Home-page: UNKNOWN
 Author: BrynQ

{brynq_sdk_bob-2.2.1 → brynq_sdk_bob-2.4.0}/setup.py

@@ -2,7 +2,7 @@ from setuptools import setup, find_namespace_packages
 
 setup(
     name='brynq_sdk_bob',
-    version='2.2.1',
+    version='2.4.0',
     description='Bob wrapper from BrynQ',
     long_description='Bob wrapper from BrynQ',
     author='BrynQ',

brynq_sdk_bob-2.2.1/brynq_sdk_bob/payments.py

@@ -1,23 +0,0 @@
-from datetime import datetime
-import pandas as pd
-from brynq_sdk_functions import Functions
-from .schemas.payments import VariablePaymentSchema
-
-
-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'
-        )
-        df['employee_id'] = person_id
-        valid_payments, invalid_payments = Functions.validate_data(df=df, schema=self.schema, debug=True)
-
-        return valid_payments, invalid_payments