brynq-sdk-bob 2.5.0__tar.gz → 2.6.0__tar.gz

{brynq_sdk_bob-2.5.0 → brynq_sdk_bob-2.6.0}/PKG-INFO

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

{brynq_sdk_bob-2.5.0 → brynq_sdk_bob-2.6.0}/brynq_sdk_bob/custom_tables.py

@@ -29,7 +29,7 @@ class CustomTables:
             record_path=['values']
         )
 
-        df['employee_id'] = employee_id
+        df['employeeId'] = 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/people.py

@@ -0,0 +1,59 @@
+import pandas as pd
+from typing import Optional
+from brynq_sdk_functions import Functions
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+from .bank import Bank
+from .employment import Employment
+from .salaries import Salaries
+from .schemas.people import PeopleSchema
+from .work import Work
+from .custom_tables import CustomTables
+
+
+class People:
+    def __init__(self, bob):
+        self.bob = bob
+        self.salaries = Salaries(bob)
+        self.employment = Employment(bob)
+        self.bank = Bank(bob)
+        self.work = Work(bob)
+        self.custom_tables = CustomTables(bob)
+        self.schema = PeopleSchema
+
+
+        # Build API fields using column metadata if present (api_field), otherwise use the column (alias) name
+    def __build_api_fields(self, schema_model: BrynQPanderaDataFrameModel) -> list[str]:
+        schema = schema_model.to_schema()
+        return [
+            ((getattr(col, "metadata", None) or {}).get("api_field")) or col_name
+            for col_name, col in schema.columns.items()
+        ]
+
+    def get(self, schema_custom_fields: Optional[BrynQPanderaDataFrameModel] = 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
+
+        resp = self.bob.session.post(url=f"{self.bob.base_url}people/search",
+                                      json={
+                                          "fields": fields,
+                                          "filters": []
+                                          #"humanReadable": "REPLACE"
+                                      },
+                                      timeout=self.bob.timeout)
+        resp.raise_for_status()
+        df = pd.json_normalize(resp.json()['employees'])
+        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)
+
+        if schema_custom_fields is not None:
+            valid_people, invalid_people_custom = Functions.validate_data(df=df, schema=schema_custom_fields, debug=True)
+        else:
+            valid_people = df
+            invalid_people_custom = pd.DataFrame()
+
+        valid_people, invalid_people = Functions.validate_data(df=valid_people, schema=PeopleSchema, debug=True)
+
+        return valid_people, pd.concat([invalid_people, invalid_people_custom])

brynq_sdk_bob-2.6.0/brynq_sdk_bob/salaries.py

@@ -0,0 +1,38 @@
+import pandas as pd
+import requests
+from brynq_sdk_functions import Functions
+from .schemas.salary import SalarySchema, SalaryCreateSchema
+
+
+class Salaries:
+    def __init__(self, bob):
+        self.bob = bob
+        self.schema = SalarySchema
+
+    def get(self) -> tuple[pd.DataFrame, pd.DataFrame]:
+        request = requests.Request(method='GET',
+                                   url=f"{self.bob.base_url}bulk/people/salaries",
+                                   params={"limit": 100})
+        data = self.bob.get_paginated_result(request)
+        df = pd.json_normalize(
+            data,
+            record_path='values',
+            meta=['employeeId']
+        )
+        valid_salaries, invalid_salaries = Functions.validate_data(df=df, schema=SalarySchema, debug=True)
+
+        return valid_salaries, invalid_salaries
+
+    def create(self, salary_data: dict) -> requests.Response:
+        nested_data = self.nmbrs.flat_dict_to_nested_dict(salary_data, SalaryCreateSchema)
+        salary_data = SalaryCreateSchema(**nested_data)
+        payload = salary_data.model_dump(exclude_none=True, by_alias=True)
+
+        resp = self.bob.session.post(url=f"{self.bob.base_url}people/{salary_data.employee_id}/salaries", json=payload)
+        resp.raise_for_status()
+        return resp
+
+    def delete(self, employee_id: str, salary_id: str) -> requests.Response:
+        resp = self.bob.session.delete(url=f"{self.bob.base_url}people/{employee_id}/salaries/{salary_id}")
+        resp.raise_for_status()
+        return resp

{brynq_sdk_bob-2.5.0 → brynq_sdk_bob-2.6.0}/brynq_sdk_bob/schemas/employment.py

@@ -6,7 +6,7 @@ from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
 class EmploymentSchema(BrynQPanderaDataFrameModel):
     id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employment ID", alias="id")
-    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
     active_effective_date: Series[DateTime] = pa.Field(coerce=True, description="Active Effective Date", alias="activeEffectiveDate")
     contract: Series[String] = pa.Field(coerce=True, nullable=True, description="Contract", alias="contract") # has a list of possible values
     creation_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Creation Date", alias="creationDate")

{brynq_sdk_bob-2.5.0 → brynq_sdk_bob-2.6.0}/brynq_sdk_bob/schemas/payments.py

@@ -21,8 +21,9 @@ class VariablePaymentSchema(BrynQPanderaDataFrameModel):
     end_effective_date: Series[DateTime] = pa.Field(nullable=True, coerce=True, description="End Effective Date", alias="endEffectiveDate")
     payment_period: Series[String] = pa.Field(coerce=True, description="Payment Period", alias="paymentPeriod")
     effective_date: Series[DateTime] = pa.Field(coerce=True, description="Effective Date", alias="effectiveDate")
-    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")
+    amount_value: Optional[Series[Float]] = pa.Field(coerce=True, description="Amount Value", alias="amount.value")
+    amount_alternative_value: Optional[Series[Float]] = pa.Field(coerce=True, description="Amount Value", alias="amount")
+    amount_currency: Optional[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[pd.Int64Dtype] = pa.Field(nullable=True, coerce=True, description="Change Changed By ID", alias="change.changedById")

brynq_sdk_bob-2.6.0/brynq_sdk_bob/schemas/people.py

@@ -0,0 +1,284 @@
+from datetime import datetime
+from typing import Optional, List, Dict
+
+import pandas as pd
+import pandera as pa
+from pandera import Bool
+from pandera.typing import Series, String, Float
+import pandera.extensions as extensions
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+from pandera.engines.pandas_engine import DateTime
+
+
+@extensions.register_check_method()
+def check_list(x):
+    return isinstance(x, list)
+
+
+class PeopleSchema(BrynQPanderaDataFrameModel):
+    id: Optional[Series[pd.Int64Dtype]] = 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"})
+    home_mobile_phone: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Mobile Phone", alias="home.mobilePhone")
+    home_private_email: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, alias='home.privateEmail')
+    surname: Optional[Series[String]] = pa.Field(coerce=True, description="Surname", alias="surname", metadata={"api_field": "root.surname"})
+    first_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="First Name", alias="firstName", metadata={"api_field": "root.firstName"})
+    full_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Full Name", alias="fullName", metadata={"api_field": "root.fullName"})
+    # the date is in DD/MM/YYYY format,
+    personal_birth_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=False, description="Personal Birth Date", alias="personal.birthDate") # , dtype_kwargs={"to_datetime_kwargs": {"format": "%d/%m/%Y"}}
+    personal_pronouns: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Pronouns", alias="personal.pronouns")
+    personal_honorific: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Honorific", alias="personal.honorific")
+    personal_nationality: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="Personal Nationality", alias="personal.nationality")
+    # employee_payroll_manager: Series[String] = pa.Field(coerce=True, nullable=True)
+    # employee_hrbp: Series[String] = pa.Field(coerce=True, nullable=True)
+    # employee_it_admin: Series[String] = pa.Field(coerce=True, nullable=True)
+    # employee_buddy: Series[String] = pa.Field(coerce=True, nullable=True)
+    employee_veteran_status: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="Employee Veteran Status", alias="employee.veteranStatus")
+    employee_disability_status: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Employee Disability Status", alias="employee.disabilityStatus")
+    work_start_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Work Start Date", alias="work.startDate")
+    work_manager: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Manager", alias="work.manager")
+    work_work_phone: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Work Phone", alias="work.workPhone")
+    work_tenure_duration_period_i_s_o: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Duration Period ISO", alias="work.tenureDuration.periodISO")
+    work_tenure_duration_sort_factor: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=False, description="Work Tenure Duration Sort Factor", alias="work.tenureDuration.sortFactor")
+    work_tenure_duration_humanize: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Duration Humanize", alias="work.tenureDuration.humanize")
+    work_duration_of_employment_period_i_s_o: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Duration of Employment Period ISO", alias="work.durationOfEmployment.periodISO")
+    work_duration_of_employment_sort_factor: Optional[Series[String]] = pa.Field(coerce=True, nullable=False, description="Work Duration of Employment Sort Factor", alias="work.durationOfEmployment.sortFactor")
+    work_duration_of_employment_humanize: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Duration of Employment Humanize", alias="work.durationOfEmployment.humanize")
+    work_reports_to_id_in_company: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Reports to ID in Company", alias="work.reportsToIdInCompany")
+    work_employee_id_in_company: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Employee ID in Company", alias="work.employeeIdInCompany")
+    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_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")
+    work_department: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Department", alias="work.department")
+    work_tenure_duration_years: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Duration Years", alias="work.tenureDurationYears")
+    work_tenure_years: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Years", alias="work.tenureYears")
+    work_is_manager: Optional[Series[Bool]] = pa.Field(coerce=True, nullable=True, description="Work Is Manager", alias="work.isManager")
+    work_title: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Title", alias="work.title")
+    work_site: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Site", alias="work.site")
+    work_original_start_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Work Original Start Date", alias="work.originalStartDate")
+    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[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")
+    payroll_employment_type: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Employment Type", alias="payroll.employment.type")
+    tax_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Tax ID", alias="payroll.taxCode")
+
+    about_food_preferences: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="About Food Preferences", alias="about.foodPreferences")
+    # about_social_data_linkedin: Series[String] = pa.Field(coerce=True, nullable=True)
+    about_social_data_twitter: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About Social Data Twitter", alias="about.socialData.twitter")
+
+    about_social_data_facebook: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About Social Data Facebook", alias="about.socialData.facebook")
+
+    about_superpowers: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="About Superpowers", alias="about.superpowers")
+    about_hobbies: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="About Hobbies", alias="about.hobbies")
+    about_about: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About About", alias="about.about")
+    about_avatar: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About Avatar", alias="about.avatar")
+    address_city: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address City", alias="address.city")
+    address_post_code: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Post Code", alias="address.postCode")
+    address_zip_code: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address ZIP Code", alias="address.zipCode")
+    address_line1: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Line 1", alias="address.line1")
+    address_line2: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Line 2", alias="address.line2")
+    address_country: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Country", alias="address.country")
+    address_active_effective_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Address Active Effective Date", alias="address.activeEffectiveDate") # , dtype_kwargs={"to_datetime_kwargs": {"format": "%d/%m/%Y"}}
+    address_full_address: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Full Address", alias="address.fullAddress")
+    address_site_address1: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Site Address 1", alias="address.siteAddress1")
+    address_site_address2: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Site Address 2", alias="address.siteAddress2")
+    address_site_country: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Site Country", alias="address.siteCountry")
+    address_site_postal_code: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Site Postal Code", alias="address.sitePostalCode")
+    address_site_city: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Site City", alias="address.siteCity")
+    address_site_state: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Site State", alias="address.siteState")
+    home_legal_gender: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Legal Gender", alias="home.legalGender")
+    home_family_status: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Family / Marital Status", alias="home.familyStatus")
+    home_spouse_first_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Spouse First Name", alias="home.spouse.firstName")
+    home_spouse_surname: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Spouse Surname", alias="home.spouse.surname")
+    # home_spouse_birth_date: Series[DateTime] = pa.Field(coerce=True, nullable=True)
+    home_spouse_gender: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Spouse Gender", alias="home.spouse.gender")
+    identification_ssn_serial_number: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="SSN Serial Number", alias="identification.ssnSerialNumber")
+    internal_termination_reason: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Internal Termination Reason", alias="internal.terminationReason")
+    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')
+    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")
+    employee_band_mid_ote: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Mid OTE", alias="employee.band_mid_ote")
+    employee_band_max_ote: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Max OTE", alias="employee.band_max_ote")
+    employee_band_pay_period_ote: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band Pay Period OTE", alias="employee.band_payPeriod_ote")
+    employee_band_currency_ote: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band Currency OTE", alias="employee.band_currency_ote")
+    employee_band_ote_id: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band OTE ID", alias="employee.band_ote_id")
+    employee_band_effective_date_base_salary: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Employee Band Effective Date Base Salary", alias="employee.band_effectiveDate_baseSalary")
+    employee_band_site_base_salary: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band Site Base Salary", alias="employee.band_site_baseSalary")
+    employee_band_min_base_salary: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Min Base Salary", alias="employee.band_min_baseSalary")
+    employee_band_mid_base_salary: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Mid Base Salary", alias="employee.band_mid_baseSalary")
+    employee_band_max_base_salary: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Max Base Salary", alias="employee.band_max_baseSalary")
+    employee_band_pay_period_base_salary: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band Pay Period Base Salary", alias="employee.band_payPeriod_baseSalary")
+    employee_band_currency_base_salary: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band Currency Base Salary", alias="employee.band_currency_baseSalary")
+    employee_band_base_salary_id: Optional[Series[object]] = pa.Field(coerce=True, nullable=True, check_name=check_list, description="Employee Band Base Salary ID", alias="employee.band_baseSalary_id")
+    employee_band_compa_ratio_ote: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Compa Ratio OTE", alias="employee.band_compaRatio_ote")
+    employee_band_range_positioning_ote: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Range Positioning OTE", alias="employee.band_rangePositioning_ote")
+    employee_band_compa_ratio_base_salary: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Compa Ratio Base Salary", alias="employee.band_compaRatio_baseSalary")
+    employee_band_range_positioning_base_salary: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Employee Band Range Positioning Base Salary", alias="employee.band_rangePositioning_baseSalary")
+
+    # Additional non-custom fields from available_fields.json
+    # Root extras
+    creation_date_time: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Root Creation Date Time", alias="creationDateTime", metadata={"api_field": "root.creationDateTime"})
+    cover_image_url: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Root Cover Image URL", alias="coverImageUrl", metadata={"api_field": "root.coverImageUrl"})
+    avatar_url: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Root Avatar URL", alias="avatarUrl", metadata={"api_field": "root.avatarUrl"})
+    second_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Middle Name", alias="secondName", metadata={"api_field": "root.secondName"})
+    state: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="State", alias="state", metadata={"api_field": "root.state"})
+    creation_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Creation Date", alias="creationDate", metadata={"api_field": "root.creationDate"})
+
+    # Personal extras
+    personal_age: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Age", alias="personal.age")
+    personal_short_birth_date: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Birthday Short", alias="personal.shortBirthDate")
+
+    # Personal contact
+    home_private_phone: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Phone", alias="home.privatePhone")
+
+    # Identification extras
+    financial_passport_number: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Passport Number", alias="financial.passportNumber")
+    financial_identification_number: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Identification Number", alias="financial.identificationNumber")
+    payroll_nin: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="NI Number", alias="payroll.nin")
+    identification_ssn: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="SSN", alias="identification.ssn")
+    employee_sin: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="SIN", alias="employee.sin")
+    employee_sin_expiration_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="SIN Expiration Date", alias="employee.sinExpirationDate")
+
+    # Work extras
+    work_short_start_date: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Anniversary", alias="work.shortStartDate")
+    work_duration_of_employment: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Accumulated Tenure (duration)", alias="work.durationOfEmployment")
+    work_tenure_duration: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Tenure (duration)", alias="work.tenureDuration")
+    work_work_change_type: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Change Type", alias="work.workChangeType")
+    work_reports_to: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Reports To", alias="work.reportsTo")
+    work_reports_to_email: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Manager Email", alias="work.reportsTo.email")
+
+    # Work roles
+    employee_buddy: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Buddy", alias="employee.buddy")
+    employee_hrbp: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="HRBP", alias="employee.hrbp")
+    employee_payroll_manager: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Payroll Manager", alias="employee.payrollManager")
+    employee_it_admin: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="IT Admin", alias="employee.itAdmin")
+    employee_org_level: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Org Level", alias="employee.orgLevel")
+
+    # Work contact
+    personal_communication_slack_username: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Slack Username", alias="personal.communication.slackUsername")
+    personal_communication_skype_username: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Skype Username", alias="personal.communication.skypeUsername")
+
+    # Address extras
+    address_usa_state: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="USA State", alias="address.usaState")
+
+    # Home extras
+    home_number_of_kids: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Number of Children", alias="home.numberOfKids")
+    home_spouse_birth_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Spouse Birth Date", alias="home.spouse.birthDate")
+    home_spouse_short_birth_date: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Spouse Birthday", alias="home.spouse.shortBirthDate")
+
+    # About social extras
+    about_social_data_linkedin: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Social LinkedIn", alias="about.socialData.linkedin")
+
+    # Right to work
+    financial_right_to_work_expiry_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Right to Work Expiry Date", alias="financial.rightToWorkExpiryDate")
+
+    # Employment extras
+    payroll_employment_active_effective_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Employment Active Effective Date", alias="payroll.employment.activeEffectiveDate")
+    payroll_employment_working_pattern: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Working Pattern", alias="payroll.employment.workingPattern")
+    payroll_employment_standard_working_pattern: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Standard Working Pattern", alias="payroll.employment.standardWorkingPattern")
+    payroll_employment_standard_working_pattern_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Standard Working Pattern ID", alias="payroll.employment.standardWorkingPattern.workingPatternId")
+    payroll_employment_personal_working_pattern_type: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Working Pattern Type", alias="payroll.employment.actualWorkingPattern.workingPatternType")
+    payroll_employment_hours_in_day_not_worked: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Hours in Day Not Worked", alias="payroll.employment.hoursInDayNotWorked")
+    payroll_employment_site_working_pattern: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern", alias="payroll.employment.siteWorkingPattern")
+    payroll_employment_actual_working_pattern: Optional[Series[dict]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern", alias="payroll.employment.actualWorkingPattern")
+    payroll_employment_actual_working_pattern_days_sunday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Sunday", alias="payroll.employment.actualWorkingPattern.days.sunday")
+    payroll_employment_actual_working_pattern_days_tuesday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Tuesday", alias="payroll.employment.actualWorkingPattern.days.tuesday")
+    payroll_employment_actual_working_pattern_days_wednesday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Wednesday", alias="payroll.employment.actualWorkingPattern.days.wednesday")
+    payroll_employment_actual_working_pattern_days_monday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Monday", alias="payroll.employment.actualWorkingPattern.days.monday")
+    payroll_employment_actual_working_pattern_days_friday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Friday", alias="payroll.employment.actualWorkingPattern.days.friday")
+    payroll_employment_actual_working_pattern_days_thursday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Thursday", alias="payroll.employment.actualWorkingPattern.days.thursday")
+    payroll_employment_actual_working_pattern_days_saturday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Saturday", alias="payroll.employment.actualWorkingPattern.days.saturday")
+    payroll_employment_actual_working_pattern_hours_per_day: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Hours Per Day", alias="payroll.employment.actualWorkingPattern.hoursPerDay")
+    payroll_employment_actual_working_pattern_working_pattern_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Actual Working Pattern - Working Pattern ID", alias="payroll.employment.actualWorkingPattern.workingPatternId")
+    payroll_employment_site_working_pattern_working_pattern_type: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Working Pattern Type", alias="payroll.employment.siteWorkingPattern.workingPatternType")
+    payroll_employment_site_working_pattern_days_sunday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Sunday", alias="payroll.employment.siteWorkingPattern.days.sunday")
+    payroll_employment_site_working_pattern_days_tuesday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Tuesday", alias="payroll.employment.siteWorkingPattern.days.tuesday")
+    payroll_employment_site_working_pattern_days_wednesday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Wednesday", alias="payroll.employment.siteWorkingPattern.days.wednesday")
+    payroll_employment_site_working_pattern_days_monday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Monday", alias="payroll.employment.siteWorkingPattern.days.monday")
+    payroll_employment_site_working_pattern_days_friday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Friday", alias="payroll.employment.siteWorkingPattern.days.friday")
+    payroll_employment_site_working_pattern_days_thursday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Thursday", alias="payroll.employment.siteWorkingPattern.days.thursday")
+    payroll_employment_site_working_pattern_days_saturday: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Saturday", alias="payroll.employment.siteWorkingPattern.days.saturday")
+    payroll_employment_site_working_pattern_hours_per_day: Optional[Series[float]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Hours Per Day", alias="payroll.employment.siteWorkingPattern.hoursPerDay")
+    payroll_employment_site_working_pattern_working_pattern_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Site Working Pattern - Working Pattern ID", alias="payroll.employment.siteWorkingPattern.workingPatternId")
+    payroll_employment_calendar_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Calendar ID", alias="payroll.employment.calendarId")
+
+
+    payroll_employment_salary_pay_type: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Salary Pay Type", alias="payroll.employment.salaryPayType")
+    payroll_employment_flsa_code: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="FLSA Code", alias="payroll.employment.flsaCode")
+    payroll_employment_fte: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="FTE %", alias="payroll.employment.fte")
+    payroll_employment_weekly_hours: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Weekly Hours", alias="payroll.employment.weeklyHours")
+
+    # Emergency contact
+    emergency_first_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency First Name", alias="emergency.firstName")
+    emergency_second_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Middle Name", alias="emergency.secondName")
+    emergency_surname: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Last Name", alias="emergency.surname")
+    emergency_relation: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Relation", alias="emergency.relation")
+    emergency_phone: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Phone", alias="emergency.phone")
+    emergency_mobile_phone: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Mobile Phone", alias="emergency.mobilePhone")
+    emergency_email: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Email", alias="emergency.email")
+    emergency_address: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Address", alias="emergency.address")
+    emergency_city: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency City", alias="emergency.city")
+    emergency_post_code: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Post Code", alias="emergency.postCode")
+    emergency_country: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Emergency Country", alias="emergency.country")
+
+    # Temporary address
+    temporary_address_line1: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Temporary Address Line 1", alias="temporaryAddress.line1")
+    temporary_address_line2: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Temporary Address Line 2", alias="temporaryAddress.line2")
+    temporary_address_city: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Temporary City", alias="temporaryAddress.city")
+    temporary_address_usa_state: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Temporary State", alias="temporaryAddress.usaState")
+    temporary_address_country: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Temporary Country", alias="temporaryAddress.country")
+    temporary_address_post_code: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Temporary Post Code", alias="temporaryAddress.postCode")
+
+    # Lifecycle extras
+    internal_period_since_termination: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Period Since Termination", alias="internal.periodSinceTermination")
+    internal_years_since_termination: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Years Since Termination", alias="internal.yearsSinceTermination")
+    internal_notice: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Notice Period", alias="internal.notice")
+    internal_lifecycle_status: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Lifecycle Status", alias="internal.lifecycleStatus")
+    internal_status: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Status", alias="internal.status")
+    internal_probation_end_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Probation End Date", alias="internal.probationEndDate")
+    internal_current_active_status_start_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Current Active Start Date", alias="internal.currentActiveStatusStartDate")
+
+    # EEO extras
+    eeo_ethnicity: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Ethnicity", alias="eeo.ethnicity")
+    eeo_job_category: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Job Category", alias="eeo.jobCategory")
+
+    # People analytics
+    people_analytics_age_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Age Risk Indicator", alias="peopleAnalytics.ageRiskIndicator")
+    people_analytics_kids_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Kids Risk Indicator", alias="peopleAnalytics.kidsRiskIndicator")
+    people_analytics_is_manager_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Is Manager Risk Indicator", alias="peopleAnalytics.isManagerRiskIndicator")
+    people_analytics_num_with_same_title_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Num With Same Title Risk Indicator", alias="peopleAnalytics.numWithSameTitleRiskIndicator")
+    people_analytics_team_size_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Team Size Risk Indicator", alias="peopleAnalytics.teamSizeRiskIndicator")
+    people_analytics_years_with_current_title_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Years With Current Title Risk Indicator", alias="peopleAnalytics.yearsWithCurrentTitleRiskIndicator")
+    people_analytics_years_with_recent_salary_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Years With Recent Salary Risk Indicator", alias="peopleAnalytics.yearsWithRecentSalaryRiskIndicator")
+    people_analytics_manager_tenure_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Manager Tenure Risk Indicator", alias="peopleAnalytics.managerTenureRiskIndicator")
+    people_analytics_num_of_direct_reports_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Number Of Direct Reports Risk Indicator", alias="peopleAnalytics.numOfDirectReportsRiskIndicator")
+    people_analytics_team_recent_turnover_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Team Recent Turnover Risk Indicator", alias="peopleAnalytics.teamRecentTurnoverRiskIndicator")
+    people_analytics_timeoff_frequency_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Timeoff Frequency Risk Indicator", alias="peopleAnalytics.timeoffFrequencyRiskIndicator")
+    people_analytics_tenure_rank_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Tenure Rank Risk Indicator", alias="peopleAnalytics.tenureRankRiskIndicator")
+    people_analytics_recent_manager_change_risk_indicator: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Recent Manager Change Risk Indicator", alias="peopleAnalytics.recentManagerChangeRiskIndicator")
+    people_analytics_low_risk_counter: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Low Risk Counter", alias="peopleAnalytics.lowRiskCounter")
+    people_analytics_some_risk_counter: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Some Risk Counter", alias="peopleAnalytics.someRiskCounter")
+    people_analytics_at_risk_counter: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="At Risk Counter", alias="peopleAnalytics.atRiskCounter")
+
+    # Positions / Job profile
+    employee_position_opening_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Position Opening ID", alias="employee.positionOpeningId")
+    employee_job_profile_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Job Profile ID", alias="employee.jobProfileId")
+    employee_recent_leave_start_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Recent Leave Start Date", alias="employee.recentLeaveStartDate")
+    employee_recent_leave_end_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Recent Leave End Date", alias="employee.recentLeaveEndDate")
+    employee_first_day_of_work: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="First Day Of Work", alias="employee.firstDayOfWork")
+
+    class Config:
+        coerce = True

brynq_sdk_bob-2.6.0/brynq_sdk_bob/schemas/salary.py

@@ -0,0 +1,49 @@
+import pandas as pd
+import pandera as pa
+from pandera import Bool
+from pandera.typing import Series, String, Float, DateTime
+import pandera.extensions as extensions
+from brynq_sdk_functions import BrynQPanderaDataFrameModel
+from pydantic import BaseModel, Field
+from datetime import datetime, date
+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")
+    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")
+    modification_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Modification Date", alias="modificationDate")
+    effective_date: Series[DateTime] = pa.Field(coerce=True, description="Effective Date", alias="effectiveDate")
+    end_effective_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="End Effective Date", alias="endEffectiveDate")
+    change_reason: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Reason", alias="change.reason")
+    pay_period: Series[String] = pa.Field(coerce=True, nullable=True, description="Pay Period", alias="payPeriod")
+    base_value: Series[Float] = pa.Field(coerce=True, nullable=True, description="Base Value", alias="base.value") #needs to become base.value?
+    base_currency: Series[String] = pa.Field(coerce=True, nullable=True, description="Base Currency", alias="base.currency")
+    active_effective_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Active Effective Date", alias="activeEffectiveDate")
+
+
+class SalaryCreateSchema(BaseModel):
+    can_be_deleted: Optional[bool] = Field(None, description="internal flag", alias="canBeDeleted")
+    work_change_type: Optional[str] = Field(None, description="The type of the change that was performed for this work entry. This will contain the ID of the value from the Change Type list.", alias="workChangeType")
+    salary_change_reason: Optional[str] = Field(None, description="Reason for the change", alias="change.reason")
+    salary_change_changed_by: Optional[str] = Field(None, description="Name of the user who changed the entry", alias="change.changedBy")
+    salary_change_changed_by_id: Optional[str] = Field(None, description="ID of the user who changed the entry", alias="change.changedById")
+    pay_frequency: Optional[str] = Field(None, description="Represents the frequency the salary is paid. This can be one of: Monthly, Semi Monthly, Weekly, or Bi-Weekly.", alias="payFrequency")
+    creation_date: Optional[date] = Field(None, description="The date this entry was created.", alias="creationDate")
+    is_current: Optional[bool] = Field(None, description="Is 'true' when this is the effective entry which is currently active.", alias="isCurrent")
+    modification_date: Optional[date] = Field(None, description="The date this entry was modified.", alias="modificationDate")
+    id: Optional[int] = Field(None, description="The id of the entry.", alias="id")
+    end_effective_date: Optional[date] = Field(None, description="For entries that are not active - this it the date this entry became not effective.", alias="endEffectiveDate")
+    active_effective_date: Optional[date] = Field(None, description="The active effective date for this entry.", alias="activeEffectiveDate")
+    custom_columns: Optional[Dict[str, Any]] = Field(None, description="If the table has custom columns, they will appear here.", alias="customColumns")
+    base_value: float = Field(..., description="Base amount value", alias="base.value")
+    base_currency: str = Field(..., description="Three-letter currency code.", alias="base.currency")
+    pay_period: str = Field(..., description="Represents the period for this salary entry. This can be one of: Annual, Hourly, Daily, Weekly, Monthly.", alias="payPeriod")
+    effective_date: Optional[date] = Field(None, description="The date this entry becomes effective. This is a mandatory field for a work entry.", alias="effectiveDate")
+
+    class Config:
+        allow_population_by_field_name = True
+        coerce = True

{brynq_sdk_bob-2.5.0 → brynq_sdk_bob-2.6.0}/brynq_sdk_bob/schemas/timeoff.py

@@ -6,7 +6,7 @@ from brynq_sdk_functions import BrynQPanderaDataFrameModel
 
 class TimeOffSchema(BrynQPanderaDataFrameModel):
     change_type: Series[String] = pa.Field(coerce=True, description="Change Type", alias="changeType")
-    employee_id: Series[String] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
+    employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
     employee_display_name: Series[String] = pa.Field(coerce=True, description="Employee Display Name", alias="employeeDisplayName")
     employee_email: Series[String] = pa.Field(coerce=True, description="Employee Email", alias="employeeEmail")
     request_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Request ID", alias="requestId")

{brynq_sdk_bob-2.5.0 → brynq_sdk_bob-2.6.0}/brynq_sdk_bob/schemas/work.py

@@ -18,14 +18,14 @@ class WorkSchema(BrynQPanderaDataFrameModel):
     active_effective_date: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Active Effective Date", alias="activeEffectiveDate")
     department: Series[str] = pa.Field(coerce=True, nullable=True, description="Department", alias="department")
     effective_date: Series[datetime] = pa.Field(coerce=True, nullable=True, description="Effective Date", alias="effectiveDate")
-    change_reason: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Reason", alias="changeReason")
-    change_changed_by: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Changed By", alias="changeChangedBy")
-    change_changed_by_id: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Changed By ID", alias="changeChangedById")
-    reports_to_id: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To ID", alias="reportsToId")
-    reports_to_first_name: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To First Name", alias="reportsToFirstName")
-    reports_to_surname: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To Surname", alias="reportsToSurname")
-    reports_to_email: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To Email", alias="reportsToEmail")
-    reports_to_display_name: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To Display Name", alias="reportsToDisplayName")
+    change_reason: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Reason", alias="change.reason")
+    change_changed_by: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Changed By", alias="change.changedBy")
+    change_changed_by_id: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Changed By ID", alias="change.changedById")
+    reports_to_id: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To ID", alias="reportsTo.id")
+    reports_to_first_name: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To First Name", alias="reportsTo.firstName")
+    reports_to_surname: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To Surname", alias="reportsTo.surname")
+    reports_to_email: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To Email", alias="reportsTo.email")
+    reports_to_display_name: Series[str] = pa.Field(coerce=True, nullable=True, description="Reports To Display Name", alias="reportsTo.displayName")
     reports_to: Series[pd.Int64Dtype] = pa.Field(coerce=True, nullable=True, description="Reports To", alias="reportsTo")
     employee_id: Series[pd.Int64Dtype] = pa.Field(coerce=True, description="Employee ID", alias="employeeId")
 

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

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

{brynq_sdk_bob-2.5.0 → brynq_sdk_bob-2.6.0}/setup.py

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

brynq_sdk_bob-2.5.0/brynq_sdk_bob/people.py

@@ -1,344 +0,0 @@
-import pandas as pd
-import re
-from brynq_sdk_functions import Functions
-from .bank import Bank
-from .employment import Employment
-from .salaries import Salaries
-from .schemas.people import PeopleSchema
-from .work import Work
-from .custom_tables import CustomTables
-
-
-class People:
-    def __init__(self, bob):
-        self.bob = bob
-        self.salaries = Salaries(bob)
-        self.employment = Employment(bob)
-        self.bank = Bank(bob)
-        self.work = Work(bob)
-        self.custom_tables = CustomTables(bob)
-        self.schema = PeopleSchema
-        self.field_name_in_body, self.field_name_in_response, self.endpoint_to_response = self._init_fields()
-
-        # Define payroll information types and their configurations
-        self.payroll_types = {
-            'entitlement': {
-                'pattern': 'payroll.entitlement.',
-                'named_list_key': 'entitlementType'
-            },
-            'variable': {
-                'pattern': 'payroll.variable.',
-                'named_list_key': 'payrollVariableType'
-            }
-        }
-        self.payroll_mappings = {}
-
-    def _add_payroll_fields_to_request(self, body_fields: list, response_fields: list, payroll_type: str) -> tuple[list, list]:
-        """
-        Add payroll fields to request fields for a specific payroll type.
-
-        Args:
-            body_fields: Current body fields
-            response_fields: Current response fields
-            payroll_type: Type of payroll information (e.g., 'entitlement', 'variable')
-
-        Returns:
-            - body_fields: Updated body fields including payroll fields
-            - response_fields: Updated response fields including payroll fields
-        """
-        if payroll_type not in self.payroll_types:
-            return body_fields, response_fields
-
-        pattern = self.payroll_types[payroll_type]['pattern']
-        payroll_fields_to_add = [field for field in self.field_name_in_body if pattern in field.lower()]
-        payroll_response_fields = [self.endpoint_to_response.get(field) for field in payroll_fields_to_add if field in self.endpoint_to_response]
-
-        for field in payroll_fields_to_add:
-            if field not in body_fields:
-                body_fields.append(field)
-
-        for field in payroll_response_fields:
-            if field and field not in response_fields:
-                response_fields.append(field)
-
-        return body_fields, response_fields
-
-    def _get_payroll_mapping(self, payroll_type: str) -> dict:
-        """
-        Get mapping of payroll IDs to their names from the named-lists endpoint for a specific payroll type.
-
-        Args:
-            payroll_type: Type of payroll information (e.g., 'entitlement', 'variable')
-
-        Returns:
-            Dictionary mapping IDs to names
-        """
-        if payroll_type not in self.payroll_types:
-            return {}
-
-        # Check if we already have the mapping cached
-        if payroll_type in self.payroll_mappings:
-            return self.payroll_mappings[payroll_type]
-
-        resp = self.bob.session.get(
-            url=f"{self.bob.base_url}company/named-lists",
-            timeout=self.bob.timeout,
-            headers=self.bob.headers
-        )
-        named_lists = resp.json()
-
-        # Extract the mapping for this payroll type
-        mapping = {}
-        named_list_key = self.payroll_types[payroll_type]['named_list_key']
-        if named_list_key in named_lists:
-            for value in named_lists[named_list_key]['values']:
-                mapping[value['id']] = value['name']
-
-        # Cache the mapping
-        self.payroll_mappings[payroll_type] = mapping
-        return mapping
-
-    def _flatten_nested_payroll_data(self, df: pd.DataFrame, pattern: str) -> pd.DataFrame:
-        """
-        Flatten nested JSON structures in payroll columns.
-
-        Args:
-            df: DataFrame with potentially nested payroll data
-            pattern: Pattern to identify payroll columns (e.g., 'payroll.variable.')
-
-        Returns:
-            DataFrame with flattened payroll columns
-        """
-        # Identify payroll columns
-        payroll_columns = [col for col in df.columns if pattern in col.lower()]
-
-        if not payroll_columns:
-            return df
-
-        # Create a copy to avoid modifying the original
-        df_result = df.copy()
-
-        # Process each payroll column
-        for col in payroll_columns:
-            # Check if the column contains nested data
-            if df_result[col].notna().any():
-                # Get the first non-null value to check structure
-                sample_value = df_result[col].dropna().iloc[0] if not df_result[col].dropna().empty else None
-
-                if isinstance(sample_value, dict):
-                    # Flatten nested structure
-                    nested_df = pd.json_normalize(df_result[col].tolist())
-
-                    # Rename columns to include the original column name as prefix
-                    nested_df.columns = [f"{col}.{subcol}" for subcol in nested_df.columns]
-
-                    # Drop the original column and add flattened columns
-                    df_result = df_result.drop(columns=[col])
-                    df_result = pd.concat([df_result, nested_df], axis=1)
-
-        return df_result
-
-    def _extract_payroll_columns(self, df: pd.DataFrame, payroll_type: str) -> pd.DataFrame:
-        """
-        Extract payroll columns from DataFrame and rename them based on mapping.
-
-        Args:
-            df: DataFrame containing all data including payroll columns
-            payroll_type: Type of payroll information (e.g., 'entitlement', 'variable')
-
-        Returns:
-            DataFrame with only payroll columns (renamed if mapping available)
-        """
-        if payroll_type not in self.payroll_types:
-            return pd.DataFrame(index=df.index)
-
-        # Get the pattern for this payroll type
-        pattern = self.payroll_types[payroll_type]['pattern']
-
-        # Identify all payroll columns for this type
-        payroll_columns = [col for col in df.columns if pattern in col.lower()]
-
-        if not payroll_columns:
-            # No payroll columns found, return empty DataFrame
-            return pd.DataFrame(index=df.index)
-
-        # Extract payroll columns
-        df_payroll = df[payroll_columns].copy()
-
-        # Get mapping for this payroll type
-        payroll_mapping = self._get_payroll_mapping(payroll_type)
-
-        # Rename payroll columns if mapping is available
-        rename_dict = {}
-        if payroll_mapping:
-            for col in df_payroll.columns:
-                # Extract the ID from the column name (any digits after the pattern)
-                # Use case-insensitive match but extract from original column name
-                pattern_regex = pattern.replace('.', r'\.')  # Escape dots for regex
-                match = re.search(rf'({pattern_regex})(\d+)', col, re.IGNORECASE)
-                if match:
-                    payroll_id = match.group(2)
-                    if payroll_id in payroll_mapping:
-                        # Replace only the first occurrence of the ID with the name
-                        # This preserves any suffixes like .value, .currency, etc.
-                        new_col_name = col[:match.start(2)] + payroll_mapping[payroll_id] + col[match.end(2):]
-                        rename_dict[col] = new_col_name
-
-            # Apply the renaming
-            if rename_dict:
-                df_payroll = df_payroll.rename(columns=rename_dict)
-
-        return df_payroll
-
-    def get(self, additional_fields: list[str] = None, field_selection: list[str] = None, add_payroll_information: list[str] = None) -> tuple[pd.DataFrame, pd.DataFrame]:
-        """
-        Get people from Bob
-
-        Args:
-            additional_fields (list[str]): Additional fields to get (not defined in the schema)
-            field_selection (list[str]): Fields to get (defined in the schema), if not provided, all fields are returned.
-                Can be either pythonic field names (e.g., 'work_start_date') or Bob API field names (e.g., 'work.startDate').
-            add_payroll_information (list[str]): List of payroll information types to include (valid options: 'entitlement', 'variable')
-
-        Returns:
-            valid_people (pd.DataFrame): Validated people data (with payroll information appended if requested)
-            invalid_people (pd.DataFrame): Invalid records
-        """
-        #resp = self.bob.session.get(url=f"{self.bob.base_url}profiles", timeout=self.bob.timeout)
-        if additional_fields is None:
-            additional_fields = []
-        body_fields = list(set(self.field_name_in_body + additional_fields))
-        response_fields = list(set(self.field_name_in_response + additional_fields))
-
-        if field_selection:
-            # Convert pythonic field names to aliases (e.g., 'work_start_date' -> 'work.startDate')
-            field_selection = PeopleSchema.convert_pythonic_to_alias(field_selection)
-
-            body_fields = [field for field in body_fields if field in field_selection]
-            response_fields = [self.endpoint_to_response.get(field) for field in field_selection if field in self.endpoint_to_response]
-
-        # Add payroll fields to request if needed (before making the API call)
-        if add_payroll_information:
-            # Validate and filter payroll types
-            valid_payroll_types = [pt for pt in add_payroll_information if pt in self.payroll_types]
-
-            for payroll_type in valid_payroll_types:
-                body_fields, response_fields = self._add_payroll_fields_to_request(body_fields, response_fields, payroll_type)
-
-        # Bob sucks with default fields so you need to do a search call to retrieve additional fields.
-        resp_additional_fields = self.bob.session.post(url=f"{self.bob.base_url}people/search",
-                                                       json={
-                                                           "fields": body_fields,
-                                                           "filters": []
-                                                       },
-                                                       timeout=self.bob.timeout)
-        df = pd.json_normalize(resp_additional_fields.json()['employees'])
-
-        # Validate payroll types if requested
-        valid_payroll_types = []
-        if add_payroll_information:
-            valid_payroll_types = [pt for pt in add_payroll_information if pt in self.payroll_types]
-
-            # Flatten nested data for each payroll type
-            for payroll_type in valid_payroll_types:
-                pattern = self.payroll_types[payroll_type]['pattern']
-                df = self._flatten_nested_payroll_data(df, pattern)
-
-        # Now filter columns - include original response_fields plus any flattened payroll columns
-        columns_to_keep = []
-        for col in df.columns:
-            # Keep if it's in response_fields
-            if col in response_fields:
-                columns_to_keep.append(col)
-            # Or if it's a payroll column (original or flattened)
-            elif valid_payroll_types:
-                for payroll_type in valid_payroll_types:
-                    pattern = self.payroll_types[payroll_type]['pattern']
-                    if pattern in col.lower():
-                        columns_to_keep.append(col)
-                        break
-
-        df = df[columns_to_keep]
-
-        # Map DataFrame columns (response fields) back to alias (endpoint) fields for validation
-        response_to_endpoint = {v: k for k, v in self.endpoint_to_response.items() if v}
-        df = df.rename(columns={col: response_to_endpoint[col] for col in df.columns if col in response_to_endpoint})
-
-        # Extract payroll information if requested
-        payroll_dataframes = {}
-        if valid_payroll_types:
-            for payroll_type in valid_payroll_types:
-                # Extract payroll columns into separate DataFrame
-                df_payroll = self._extract_payroll_columns(df, payroll_type)
-                if not df_payroll.empty:
-                    payroll_dataframes[payroll_type] = df_payroll
-
-                    # Remove payroll columns from main DataFrame for validation
-                    pattern = self.payroll_types[payroll_type]['pattern']
-                    payroll_columns = [col for col in df.columns if pattern in col.lower()]
-                    if payroll_columns:
-                        df = df.drop(columns=payroll_columns)
-
-        # Validate the data (without payroll information)
-        valid_people, invalid_people = Functions.validate_data(df=df, schema=PeopleSchema, debug=True)
-
-        # Append all payroll information to valid_people if they exist
-        if payroll_dataframes and not valid_people.empty:
-            for payroll_type, df_payroll in payroll_dataframes.items():
-                # Only include payroll data for valid rows
-                df_payroll_valid = df_payroll.loc[valid_people.index]
-                # Append payroll columns to valid_people
-                valid_people = pd.concat([valid_people, df_payroll_valid], axis=1)
-
-
-        # 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()
-
-        # 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 valid_people.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]
-            if field_df in named_lists.keys() and field_df not in ['site']:
-                valid_people[field] = valid_people[field].map(named_lists[field_df])
-
-        return valid_people, invalid_people
-
-
-    def _init_fields(self) -> tuple[list[str], list[str], dict[str, str]]:
-        resp_fields = self.bob.session.get(
-            url=f"{self.bob.base_url}company/people/fields",
-            timeout=self.bob.timeout,
-            headers=self.bob.headers
-        )
-        fields = resp_fields.json()
-        field_name_in_body = [field.get('id') for field in fields]
-        # For all field names in field_name_in_body containing 'root.', add an alternative without 'root.' in addition to those fields
-        field_name_in_body = field_name_in_body
-        field_name_in_response = [field['jsonPath'] for field in fields]
-        endpoint_to_response = {field['id']: field['jsonPath'] for field in fields}
-
-        return field_name_in_body, field_name_in_response, endpoint_to_response
-
-
-
-    def _get_employee_id_to_person_id_mapping(self) -> tuple[pd.DataFrame, pd.DataFrame]:
-        employee_id_in_company = "work.employeeIdInCompany"
-        person_id = "root.id"
-
-        body_fields = [employee_id_in_company, person_id]
-        response_fields = [self.endpoint_to_response.get(field) for field in body_fields if field in self.endpoint_to_response]
-
-        resp_additional_fields = self.bob.session.post(url=f"{self.bob.base_url}people/search",
-                                                       json={
-                                                           "fields": body_fields,
-                                                           "filters": []
-                                                       },
-                                                       timeout=self.bob.timeout)
-        df = pd.json_normalize(resp_additional_fields.json()['employees'])
-        df = df[[col for col in response_fields if col in df.columns]]
-        # Get the valid column names from PeopleSchema
-        valid_people, invalid_people = Functions.validate_data(df=df, schema=PeopleSchema, debug=True)
-        return valid_people, invalid_people

brynq_sdk_bob-2.5.0/brynq_sdk_bob/salaries.py

@@ -1,24 +0,0 @@
-import pandas as pd
-import requests
-from brynq_sdk_functions import Functions
-from .schemas.salary import SalarySchema
-
-
-class Salaries:
-    def __init__(self, bob):
-        self.bob = bob
-        self.schema = SalarySchema
-
-    def get(self) -> (pd.DataFrame, pd.DataFrame):
-        request = requests.Request(method='GET',
-                                   url=f"{self.bob.base_url}bulk/people/salaries",
-                                   params={"limit": 100})
-        data = self.bob.get_paginated_result(request)
-        df = pd.json_normalize(
-            data,
-            record_path='values',
-            meta=['employeeId']
-        )
-        valid_salaries, invalid_salaries = Functions.validate_data(df=df, schema=SalarySchema, debug=True)
-
-        return valid_salaries, invalid_salaries

brynq_sdk_bob-2.5.0/brynq_sdk_bob/schemas/people.py

@@ -1,136 +0,0 @@
-from datetime import datetime
-from typing import Optional, List, Dict
-
-import pandas as pd
-import pandera as pa
-from pandera import Bool
-from pandera.typing import Series, String, Float, DateTime
-import pandera.extensions as extensions
-from brynq_sdk_functions import BrynQPanderaDataFrameModel
-
-
-
-@extensions.register_check_method()
-def check_list(x):
-    return isinstance(x, list)
-
-
-class PeopleSchema(BrynQPanderaDataFrameModel):
-    id: Optional[Series[String]] = pa.Field(coerce=True, description="Person ID", alias="root.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="root.email")
-    home_mobile_phone: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Mobile Phone", alias="home.mobilePhone")
-    surname: Optional[Series[String]] = pa.Field(coerce=True, description="Surname", alias="root.surname")
-    first_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="First Name", alias="root.firstName")
-    full_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Full Name", alias="fullName")
-    personal_birth_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Personal Birth Date", alias="personal.birthDate")
-    personal_pronouns: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Pronouns", alias="personal.pronouns")
-    personal_honorific: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Personal Honorific", alias="personal.honorific")
-    personal_nationality: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="Personal Nationality", alias="personal.nationality")
-    # employee_payroll_manager: Series[String] = pa.Field(coerce=True, nullable=True)
-    # employee_hrbp: Series[String] = pa.Field(coerce=True, nullable=True)
-    # employee_it_admin: Series[String] = pa.Field(coerce=True, nullable=True)
-    # employee_buddy: Series[String] = pa.Field(coerce=True, nullable=True)
-    employee_veteran_status: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="Employee Veteran Status", alias="employee.veteranStatus")
-    employee_disability_status: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Employee Disability Status", alias="employee.disabilityStatus")
-    work_start_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Work Start Date", alias="work.startDate")
-    work_manager: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Manager", alias="work.manager")
-    work_work_phone: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Work Phone", alias="work.workPhone")
-    work_tenure_duration_period_i_s_o: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Duration Period ISO", alias="work.tenureDurationPeriodIso")
-    work_tenure_duration_sort_factor: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=False, description="Work Tenure Duration Sort Factor", alias="work.tenureDurationSortFactor")
-    work_tenure_duration_humanize: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Duration Humanize", alias="work.tenureDurationHumanize")
-    work_duration_of_employment_period_i_s_o: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Duration of Employment Period ISO", alias="work.durationOfEmploymentPeriodIso")
-    work_duration_of_employment_sort_factor: Optional[Series[String]] = pa.Field(coerce=True, nullable=False, description="Work Duration of Employment Sort Factor", alias="work.durationOfEmploymentSortFactor")
-    work_duration_of_employment_humanize: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Duration of Employment Humanize", alias="work.durationOfEmploymentHumanize")
-    work_reports_to_id_in_company: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Reports to ID in Company", alias="work.reportsToIdInCompany")
-    work_employee_id_in_company: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Employee ID in Company", alias="work.employeeIdInCompany")
-    work_reports_to_display_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to Display Name", alias="work.reportsToDisplayName")
-    work_reports_to_email: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to Email", alias="work.reportsToEmail")
-    work_reports_to_surname: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to Surname", alias="work.reportsToSurname")
-    work_reports_to_first_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Reports to First Name", alias="work.reportsToFirstName")
-    work_reports_to_id: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Reports to ID", alias="work.reportsToId")
-    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[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Site ID", alias="work.siteId")
-    work_department: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Department", alias="work.department")
-    work_tenure_duration_years: Optional[Series[Float]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Duration Years", alias="work.tenureDurationYears")
-    work_tenure_years: Optional[Series[pd.Int64Dtype]] = pa.Field(coerce=True, nullable=True, description="Work Tenure Years", alias="work.tenureYears")
-    work_is_manager: Optional[Series[Bool]] = pa.Field(coerce=True, nullable=True, description="Work Is Manager", alias="work.isManager")
-    work_title: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Title", alias="work.title")
-    work_site: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Work Site", alias="work.site")
-    work_original_start_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Work Original Start Date", alias="work.originalStartDate")
-    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[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")
-    payroll_employment_type: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Employment Type", alias="payroll.employment.type")
-    tax_id: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Tax ID", alias="payroll.taxCode")
-
-    about_food_preferences: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="About Food Preferences", alias="about.foodPreferences")
-    # about_social_data_linkedin: Series[String] = pa.Field(coerce=True, nullable=True)
-    about_social_data_twitter: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About Social Data Twitter", alias="about.socialDataTwitter")
-    about_social_data_facebook: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About Social Data Facebook", alias="about.socialDataFacebook")
-    about_superpowers: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="About Superpowers", alias="about.superpowers")
-    about_hobbies: Optional[Series[object]] = pa.Field(coerce=True, check_name=check_list, description="About Hobbies", alias="about.hobbies")
-    about_about: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About About", alias="about.about")
-    about_avatar: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="About Avatar", alias="about.avatar")
-    address_city: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address City", alias="address.city")
-    address_post_code: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Post Code", alias="address.postCode")
-    address_line1: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Line 1", alias="address.line1")
-    address_line2: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Line 2", alias="address.line2")
-    address_country: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Address Country", alias="address.country")
-    address_active_effective_date: Optional[Series[DateTime]] = pa.Field(coerce=True, nullable=True, description="Address Active Effective Date", alias="address.activeEffectiveDate")
-    home_legal_gender: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Legal Gender", alias="home.legalGender")
-    home_family_status: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Family / Marital Status", alias="home.familyStatus")
-    home_spouse_first_name: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Spouse First Name", alias="home.SpouseFirstName")
-    home_spouse_surname: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Spouse Surname", alias="home.SpouseSurname")
-    # home_spouse_birth_date: Series[DateTime] = pa.Field(coerce=True, nullable=True)
-    home_spouse_gender: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Spouse Gender", alias="home.SpouseGender")
-    identification_ssn_serial_number: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="SSN Serial Number", alias="identification.ssnSerialNumber")
-    internal_termination_reason: Optional[Series[String]] = pa.Field(coerce=True, nullable=True, description="Internal Termination Reason", alias="internal.terminationReason")
-    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")
-
-    class Config:
-        coerce = True
-
-    @classmethod
-    def convert_pythonic_to_alias(cls, pythonic_fields: List[str]) -> List[str]:
-        """
-        Convert pythonic field names to their Bob API aliases.
-
-        Args:
-            pythonic_fields: List of pythonic field names (e.g., ['work_start_date', 'first_name'])
-
-        Returns:
-            List of Bob API field aliases (e.g., ['work.startDate', 'root.firstName'])
-        """
-        # Get the alias mapping from the class (populated by BrynQPanderaDataFrameModel.__init_subclass__)
-        alias_map = getattr(cls, "_alias_map", {})
-
-        # Convert the provided pythonic fields to aliases
-        result = []
-        for field in pythonic_fields:
-            if field in alias_map:
-                result.append(alias_map[field])
-            else:
-                # If not found in schema, keep the field as-is (could be a custom field)
-                result.append(field)
-
-        return result
-
-    @classmethod
-    def get_pythonic_to_alias_mapping(cls) -> Dict[str, str]:
-        """
-        Get the complete mapping from pythonic field names to Bob API aliases.
-
-        Returns:
-            Dictionary mapping pythonic field names to aliases
-        """
-        # Get the alias mapping from the class (populated by BrynQPanderaDataFrameModel.__init_subclass__)
-        return getattr(cls, "_alias_map", {})

brynq_sdk_bob-2.5.0/brynq_sdk_bob/schemas/salary.py

@@ -1,25 +0,0 @@
-import pandas as pd
-import pandera as pa
-from pandera import Bool
-from pandera.typing import Series, String, Float, DateTime
-import pandera.extensions as extensions
-from brynq_sdk_functions import BrynQPanderaDataFrameModel
-
-
-class SalarySchema(BrynQPanderaDataFrameModel):
-    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")
-    is_current: Series[Bool] = pa.Field(coerce=True, description="Is Current", alias="isCurrent")
-    modification_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Modification Date", alias="modificationDate")
-    effective_date: Series[DateTime] = pa.Field(coerce=True, description="Effective Date", alias="effectiveDate")
-    end_effective_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="End Effective Date", alias="endEffectiveDate")
-    change_reason: Series[str] = pa.Field(coerce=True, nullable=True, description="Change Reason", alias="change.reason")
-    pay_period: Series[String] = pa.Field(coerce=True, nullable=True, description="Pay Period", alias="payPeriod")
-    base_value: Series[Float] = pa.Field(coerce=True, nullable=True, description="Base Value", alias="base.value") #needs to become base.value?
-    base_currency: Series[String] = pa.Field(coerce=True, nullable=True, description="Base Currency", alias="base.currency")
-    active_effective_date: Series[DateTime] = pa.Field(coerce=True, nullable=True, description="Active Effective Date", alias="activeEffectiveDate")
-
-    class Config:
-        coerce = True