ds_provider_simployer_py_lib.enums
==================================

.. py:module:: ds_provider_simployer_py_lib.enums

.. autoapi-nested-parse::

   **File:** ``enums.py``
   **Region:** ``ds_provider_simployer_py_lib/enums``

   Constants for Simployer provider.

   .. rubric:: Example

   >>> ResourceType.SIMPLOYER_LINKED_SERVICE
   'ds.resource.linked-service.simployer'
   >>> ResourceType.SIMPLOYER_DATASET
   'ds.resource.dataset.simployer'
   >>> SimployerDataProducts.EMPLOYEES
   'employees'



Classes
-------

.. autoapisummary::

   ds_provider_simployer_py_lib.enums.ResourceType
   ds_provider_simployer_py_lib.enums.SimployerDataProducts


Module Contents
---------------

.. py:class:: ResourceType

   Bases: :py:obj:`enum.StrEnum`


   Constants for Simployer provider.


   .. py:attribute:: SIMPLOYER_LINKED_SERVICE
      :value: 'ds.resource.linked-service.simployer'



   .. py:attribute:: SIMPLOYER_DATASET
      :value: 'ds.resource.dataset.simployer'



.. py:class:: SimployerDataProducts

   Bases: :py:obj:`enum.StrEnum`


   Simployer data products available through the HRConnect API.
   Each value matches a key in the ENDPOINTS dictionary in endpoint_info.py,
   which defines the API endpoint and supported methods for that data product.
   The values are used in SimployerDatasetSettings to specify which data product
   to read from or write to.
   Example usage:
       settings = SimployerDatasetSettings(
           data_product=SimployerDataProducts.EMPLOYEES,
           read=ReadSettings(page_size=100)
       )


   .. py:attribute:: ABSENCE_COMMENTS
      :value: 'absence_comments'



   .. py:attribute:: ABSENCE_LOST_DAYS
      :value: 'absence_lost_days'



   .. py:attribute:: ABSENCES_BY_UNIT
      :value: 'absences_by_unit'



   .. py:attribute:: ABSENCE_TYPES
      :value: 'absence_types'



   .. py:attribute:: CONTACT_ADDRESSES
      :value: 'contact_addresses'



   .. py:attribute:: CONTACT_ADDRESS
      :value: 'contact_address'



   .. py:attribute:: CONTACT_ADDRESS_UNIT
      :value: 'contact_address_unit'



   .. py:attribute:: CONTACT_ELECTRONIC_ADDRESSES
      :value: 'contact_electronic_addresses'



   .. py:attribute:: CONTACT_ELECTRONIC_ADDRESS
      :value: 'contact_electronic_address'



   .. py:attribute:: CONTACT_ELECTRONIC_ADDRESS_UNIT
      :value: 'contact_electronic_address_unit'



   .. py:attribute:: CONTACT_PHONE_NUMBERS
      :value: 'contact_phone_numbers'



   .. py:attribute:: CONTACT_PHONE_NUMBER
      :value: 'contact_phone_number'



   .. py:attribute:: CONTACT_PHONE_NUMBER_UNIT
      :value: 'contact_phone_number_unit'



   .. py:attribute:: DOCUMENTS_PERSONS
      :value: 'documents_persons'



   .. py:attribute:: EMPLOYEES
      :value: 'employees'



   .. py:attribute:: EMPLOYEE
      :value: 'employee'



   .. py:attribute:: EMPLOYMENTS
      :value: 'employments'



   .. py:attribute:: EMPLOYMENT
      :value: 'employment'



   .. py:attribute:: EMPLOYMENT_AGREEMENT_GUID
      :value: 'employment_agreement_guid'



   .. py:attribute:: EMPLOYMENT_SET_TERMINATION_CAUSE
      :value: 'employment_set_termination_cause'



   .. py:attribute:: EMPLOYMENT_CATEGORIES
      :value: 'employment_categories'



   .. py:attribute:: EMPLOYMENT_CATEGORY
      :value: 'employment_category'



   .. py:attribute:: EMPLOYMENT_CONTRACTS
      :value: 'employment_contracts'



   .. py:attribute:: EMPLOYMENT_CONTRACT
      :value: 'employment_contract'



   .. py:attribute:: EMPLOYMENT_CONTRACTS_PERSON
      :value: 'employment_contracts_person'



   .. py:attribute:: EMPLOYMENT_COST_CENTER_DEPARTMENT
      :value: 'employment_cost_center_department'



   .. py:attribute:: EMPLOYMENT_EMPLOYEE
      :value: 'employment_employee'



   .. py:attribute:: EMPLOYMENT_PERSON
      :value: 'employment_person'



   .. py:attribute:: EMPLOYMENT_SALARIES
      :value: 'employment_salaries'



   .. py:attribute:: EMPLOYMENT_SALARIES_EMPLOYMENT
      :value: 'employment_salaries_employment'



   .. py:attribute:: EMPLOYMENT_SALARIES_PERSON
      :value: 'employment_salaries_person'



   .. py:attribute:: EMPLOYMENT_TERMINATION_CAUSES
      :value: 'employment_termination_causes'



   .. py:attribute:: EMPLOYMENT_TERMINATION_CAUSE
      :value: 'employment_termination_cause'



   .. py:attribute:: EXTENDED_PROPERTY_TYPES
      :value: 'extended_property_types'



   .. py:attribute:: EXTENDED_PROPERTY_TYPE
      :value: 'extended_property_type'



   .. py:attribute:: EXTENDED_PROPERTY_TYPE_VALUES
      :value: 'extended_property_type_values'



   .. py:attribute:: EXTENDED_PROPERTY_TYPE_VALUE
      :value: 'extended_property_type_value'



   .. py:attribute:: LEAVE_PERIODS
      :value: 'leave_periods'



   .. py:attribute:: ORGANIZATIONS
      :value: 'organizations'



   .. py:attribute:: ORGANIZATION
      :value: 'organization'



   .. py:attribute:: ORGANIZATION_GROUPS
      :value: 'organization_groups'



   .. py:attribute:: ORGANIZATION_GROUP
      :value: 'organization_group'



   .. py:attribute:: ORGANIZATION_GROUP_AFFILIATED_PEOPLE
      :value: 'organization_group_affiliated_people'



   .. py:attribute:: ORGANIZATION_GROUPS_AFFILIATED_PEOPLE
      :value: 'organization_groups_affiliated_people'



   .. py:attribute:: ORGANIZATION_GROUPS_CATEGORIES
      :value: 'organization_groups_categories'



   .. py:attribute:: ORGANIZATION_GROUPS_CATEGORY
      :value: 'organization_groups_category'



   .. py:attribute:: ORGANIZATION_GROUPS_PERSON
      :value: 'organization_groups_person'



   .. py:attribute:: ORGANIZATION_HIERARCHY
      :value: 'organization_hierarchy'



   .. py:attribute:: PERSONS
      :value: 'persons'



   .. py:attribute:: PERSON
      :value: 'person'



   .. py:attribute:: PERSON_IDENTITY_IDENTIFIERS
      :value: 'person_identity_identifiers'



   .. py:attribute:: PERSON_CHILDREN
      :value: 'person_children'



   .. py:attribute:: PERSON_EXTENDED_PROPERTIES
      :value: 'person_extended_properties'



   .. py:attribute:: PERSON_NEXT_OF_KIN
      :value: 'person_next_of_kin'



   .. py:attribute:: PERSON_SPECIFIED_MANAGER
      :value: 'person_specified_manager'



   .. py:attribute:: PERSONS_IDENTITY_IDENTIFIERS
      :value: 'persons_identity_identifiers'



   .. py:attribute:: PERSONS_IDENTITY_IDENTIFIER
      :value: 'persons_identity_identifier'



   .. py:attribute:: PERSONS_AUDIT_LOGS
      :value: 'persons_audit_logs'



   .. py:attribute:: PERSONS_CHILDREN
      :value: 'persons_children'



   .. py:attribute:: PERSONS_CHILD
      :value: 'persons_child'



   .. py:attribute:: PERSONS_EXTENDED_PROPERTIES
      :value: 'persons_extended_properties'



   .. py:attribute:: PERSONS_EXTENDED_PROPERTY
      :value: 'persons_extended_property'



   .. py:attribute:: PERSONS_EXTENDED_PROPERTIES_TYPE
      :value: 'persons_extended_properties_type'



   .. py:attribute:: PERSONS_MANAGER_STRUCTURE
      :value: 'persons_manager_structure'



   .. py:attribute:: PERSONS_NEXT_OF_KIN
      :value: 'persons_next_of_kin'



   .. py:attribute:: PERSONS_NEXT_OF_KIN_ID
      :value: 'persons_next_of_kin_id'



   .. py:attribute:: SICK_LEAVE_PERIODS
      :value: 'sick_leave_periods'



   .. py:attribute:: TENANTS
      :value: 'tenants'



   .. py:attribute:: TENANTS_PERSON_USERS
      :value: 'tenants_person_users'



   .. py:attribute:: TENANTS_USERS
      :value: 'tenants_users'



   .. py:attribute:: TENANTS_USER
      :value: 'tenants_user'



   .. py:attribute:: VACATION_DAYS
      :value: 'vacation_days'



   .. py:attribute:: VACATION_PERIODS
      :value: 'vacation_periods'