mergepythonclient 2.4.0__py3-none-any.whl → 2.5.0__py3-none-any.whl

merge/resources/hris/resources/time_off_balances/client.py

@@ -82,7 +82,7 @@ class TimeOffBalancesClient:
             If provided, only objects synced by Merge before this date time will be returned.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         policy_type : typing.Optional[TimeOffBalancesListRequestPolicyType]
             If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
@@ -113,14 +113,38 @@ class TimeOffBalancesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.hris.resources.time_off_balances import (
+            TimeOffBalancesListRequestPolicyType,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.hris.time_off_balances.list(
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            employee_id="employee_id",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            page_size=1,
+            policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT,
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -194,6 +218,8 @@ class TimeOffBalancesClient:
         )
         client.hris.time_off_balances.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -279,7 +305,7 @@ class AsyncTimeOffBalancesClient:
             If provided, only objects synced by Merge before this date time will be returned.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         policy_type : typing.Optional[TimeOffBalancesListRequestPolicyType]
             If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
@@ -311,8 +337,12 @@ class AsyncTimeOffBalancesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.hris.resources.time_off_balances import (
+            TimeOffBalancesListRequestPolicyType,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -322,7 +352,26 @@ class AsyncTimeOffBalancesClient:
 
         async def main() -> None:
             await client.hris.time_off_balances.list(
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                employee_id="employee_id",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                page_size=1,
+                policy_type=TimeOffBalancesListRequestPolicyType.BEREAVEMENT,
+                remote_id="remote_id",
             )
 
 
@@ -404,6 +453,8 @@ class AsyncTimeOffBalancesClient:
         async def main() -> None:
             await client.hris.time_off_balances.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/hris/resources/time_off_balances/raw_client.py

@@ -76,7 +76,7 @@ class RawTimeOffBalancesClient:
             If provided, only objects synced by Merge before this date time will be returned.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         policy_type : typing.Optional[TimeOffBalancesListRequestPolicyType]
             If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')
@@ -271,7 +271,7 @@ class AsyncRawTimeOffBalancesClient:
             If provided, only objects synced by Merge before this date time will be returned.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         policy_type : typing.Optional[TimeOffBalancesListRequestPolicyType]
             If provided, will only return TimeOffBalance with this policy type. Options: ('VACATION', 'SICK', 'PERSONAL', 'JURY_DUTY', 'VOLUNTEER', 'BEREAVEMENT')

merge/resources/hris/resources/timesheet_entries/client.py

@@ -99,7 +99,7 @@ class TimesheetEntriesClient:
             Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
@@ -120,14 +120,50 @@ class TimesheetEntriesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.hris.resources.timesheet_entries import (
+            TimesheetEntriesListRequestOrderBy,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.hris.timesheet_entries.list(
+            created_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            created_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            employee_id="employee_id",
+            ended_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            ended_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING,
+            page_size=1,
+            remote_id="remote_id",
+            started_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            started_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
         )
         """
         _response = self._raw_client.list(
@@ -191,6 +227,8 @@ class TimesheetEntriesClient:
             api_key="YOUR_API_KEY",
         )
         client.hris.timesheet_entries.create(
+            is_debug_mode=True,
+            run_async=True,
             model=TimesheetEntryRequest(),
         )
         """
@@ -242,6 +280,8 @@ class TimesheetEntriesClient:
         )
         client.hris.timesheet_entries.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -363,7 +403,7 @@ class AsyncTimesheetEntriesClient:
             Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
@@ -385,8 +425,12 @@ class AsyncTimesheetEntriesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.hris.resources.timesheet_entries import (
+            TimesheetEntriesListRequestOrderBy,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -396,7 +440,38 @@ class AsyncTimesheetEntriesClient:
 
         async def main() -> None:
             await client.hris.timesheet_entries.list(
+                created_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                created_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                employee_id="employee_id",
+                ended_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                ended_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                order_by=TimesheetEntriesListRequestOrderBy.START_TIME_DESCENDING,
+                page_size=1,
+                remote_id="remote_id",
+                started_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                started_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
             )
 
 
@@ -468,6 +543,8 @@ class AsyncTimesheetEntriesClient:
 
         async def main() -> None:
             await client.hris.timesheet_entries.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=TimesheetEntryRequest(),
             )
 
@@ -527,6 +604,8 @@ class AsyncTimesheetEntriesClient:
         async def main() -> None:
             await client.hris.timesheet_entries.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/hris/resources/timesheet_entries/raw_client.py

@@ -93,7 +93,7 @@ class RawTimesheetEntriesClient:
             Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.
@@ -377,7 +377,7 @@ class AsyncRawTimesheetEntriesClient:
             Overrides the default ordering for this endpoint. Possible values include: start_time, -start_time.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         remote_id : typing.Optional[str]
             The API provider's ID for the given object.

merge/resources/hris/types/__init__.py

@@ -10,6 +10,7 @@ if typing.TYPE_CHECKING:
     from .account_details_and_actions import AccountDetailsAndActions
     from .account_details_and_actions_category import AccountDetailsAndActionsCategory
     from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration
+    from .account_details_and_actions_status import AccountDetailsAndActionsStatus
     from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum
     from .account_details_category import AccountDetailsCategory
     from .account_integration import AccountIntegration
@@ -32,6 +33,7 @@ if typing.TYPE_CHECKING:
     from .common_model_scope_api import CommonModelScopeApi
     from .common_model_scopes_body_request import CommonModelScopesBodyRequest
     from .company import Company
+    from .completed_account_initial_screen_enum import CompletedAccountInitialScreenEnum
     from .country_enum import CountryEnum
     from .data_passthrough_request import DataPassthroughRequest
     from .debug_mode_log import DebugModeLog
@@ -210,6 +212,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "AccountDetailsAndActions": ".account_details_and_actions",
     "AccountDetailsAndActionsCategory": ".account_details_and_actions_category",
     "AccountDetailsAndActionsIntegration": ".account_details_and_actions_integration",
+    "AccountDetailsAndActionsStatus": ".account_details_and_actions_status",
     "AccountDetailsAndActionsStatusEnum": ".account_details_and_actions_status_enum",
     "AccountDetailsCategory": ".account_details_category",
     "AccountIntegration": ".account_integration",
@@ -232,6 +235,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "CommonModelScopeApi": ".common_model_scope_api",
     "CommonModelScopesBodyRequest": ".common_model_scopes_body_request",
     "Company": ".company",
+    "CompletedAccountInitialScreenEnum": ".completed_account_initial_screen_enum",
     "CountryEnum": ".country_enum",
     "DataPassthroughRequest": ".data_passthrough_request",
     "DebugModeLog": ".debug_mode_log",
@@ -430,6 +434,7 @@ __all__ = [
     "AccountDetailsAndActions",
     "AccountDetailsAndActionsCategory",
     "AccountDetailsAndActionsIntegration",
+    "AccountDetailsAndActionsStatus",
     "AccountDetailsAndActionsStatusEnum",
     "AccountDetailsCategory",
     "AccountIntegration",
@@ -452,6 +457,7 @@ __all__ = [
     "CommonModelScopeApi",
     "CommonModelScopesBodyRequest",
     "Company",
+    "CompletedAccountInitialScreenEnum",
     "CountryEnum",
     "DataPassthroughRequest",
     "DebugModeLog",

merge/resources/hris/types/account_details_and_actions.py

@@ -8,7 +8,7 @@ from ....core.pydantic_utilities import IS_PYDANTIC_V2
 from ....core.unchecked_base_model import UncheckedBaseModel
 from .account_details_and_actions_category import AccountDetailsAndActionsCategory
 from .account_details_and_actions_integration import AccountDetailsAndActionsIntegration
-from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum
+from .account_details_and_actions_status import AccountDetailsAndActionsStatus
 
 
 class AccountDetailsAndActions(UncheckedBaseModel):
@@ -23,7 +23,7 @@ class AccountDetailsAndActions(UncheckedBaseModel):
 
     id: str
     category: typing.Optional[AccountDetailsAndActionsCategory] = None
-    status: AccountDetailsAndActionsStatusEnum
+    status: AccountDetailsAndActionsStatus
     status_detail: typing.Optional[str] = None
     end_user_origin_id: typing.Optional[str] = None
     end_user_organization_name: str

merge/resources/hris/types/account_details_and_actions_status.py

@@ -0,0 +1,7 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+from .account_details_and_actions_status_enum import AccountDetailsAndActionsStatusEnum
+
+AccountDetailsAndActionsStatus = typing.Union[AccountDetailsAndActionsStatusEnum, str]

merge/resources/hris/types/completed_account_initial_screen_enum.py

@@ -0,0 +1,5 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+CompletedAccountInitialScreenEnum = typing.Literal["SELECTIVE_SYNC"]

merge/resources/hris/types/field_mapping_api_instance.py

@@ -14,6 +14,7 @@ class FieldMappingApiInstance(UncheckedBaseModel):
     is_integration_wide: typing.Optional[bool] = None
     target_field: typing.Optional[FieldMappingApiInstanceTargetField] = None
     remote_field: typing.Optional[FieldMappingApiInstanceRemoteField] = None
+    jmes_path: typing.Optional[str] = None
 
     if IS_PYDANTIC_V2:
         model_config: typing.ClassVar[pydantic.ConfigDict] = pydantic.ConfigDict(extra="allow", frozen=True)  # type: ignore # Pydantic v2

merge/resources/knowledgebase/__init__.py

@@ -123,10 +123,13 @@ if typing.TYPE_CHECKING:
     )
     from .resources import (
         ArticlesListRequestExpand,
+        ArticlesListRequestType,
         ArticlesRetrieveRequestExpand,
         AsyncPassthroughRetrieveResponse,
         ContainersListRequestExpand,
+        ContainersListRequestType,
         ContainersRetrieveRequestExpand,
+        EndUserDetailsRequestCompletedAccountInitialScreen,
         EndUserDetailsRequestLanguage,
         GroupsListRequestExpand,
         GroupsRetrieveRequestExpand,
@@ -179,6 +182,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "ArticleTypeEnum": ".types",
     "ArticleVisibility": ".types",
     "ArticlesListRequestExpand": ".resources",
+    "ArticlesListRequestType": ".resources",
     "ArticlesRetrieveRequestExpand": ".resources",
     "AsyncPassthroughReciept": ".types",
     "AsyncPassthroughRetrieveResponse": ".resources",
@@ -199,6 +203,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "ContainerTypeEnum": ".types",
     "ContainerVisibility": ".types",
     "ContainersListRequestExpand": ".resources",
+    "ContainersListRequestType": ".resources",
     "ContainersRetrieveRequestExpand": ".resources",
     "DataPassthroughRequest": ".types",
     "DataPassthroughRequestMethod": ".types",
@@ -207,6 +212,7 @@ _dynamic_imports: typing.Dict[str, str] = {
     "DebugModelLogSummary": ".types",
     "EnabledActionsEnum": ".types",
     "EncodingEnum": ".types",
+    "EndUserDetailsRequestCompletedAccountInitialScreen": ".resources",
     "EndUserDetailsRequestLanguage": ".resources",
     "ErrorValidationProblem": ".types",
     "EventTypeEnum": ".types",
@@ -347,6 +353,7 @@ __all__ = [
     "ArticleTypeEnum",
     "ArticleVisibility",
     "ArticlesListRequestExpand",
+    "ArticlesListRequestType",
     "ArticlesRetrieveRequestExpand",
     "AsyncPassthroughReciept",
     "AsyncPassthroughRetrieveResponse",
@@ -367,6 +374,7 @@ __all__ = [
     "ContainerTypeEnum",
     "ContainerVisibility",
     "ContainersListRequestExpand",
+    "ContainersListRequestType",
     "ContainersRetrieveRequestExpand",
     "DataPassthroughRequest",
     "DataPassthroughRequestMethod",
@@ -375,6 +383,7 @@ __all__ = [
     "DebugModelLogSummary",
     "EnabledActionsEnum",
     "EncodingEnum",
+    "EndUserDetailsRequestCompletedAccountInitialScreen",
     "EndUserDetailsRequestLanguage",
     "ErrorValidationProblem",
     "EventTypeEnum",

merge/resources/knowledgebase/resources/__init__.py

@@ -30,19 +30,22 @@ if typing.TYPE_CHECKING:
         users,
         webhook_receivers,
     )
-    from .articles import ArticlesListRequestExpand, ArticlesRetrieveRequestExpand
+    from .articles import ArticlesListRequestExpand, ArticlesListRequestType, ArticlesRetrieveRequestExpand
     from .async_passthrough import AsyncPassthroughRetrieveResponse
-    from .containers import ContainersListRequestExpand, ContainersRetrieveRequestExpand
+    from .containers import ContainersListRequestExpand, ContainersListRequestType, ContainersRetrieveRequestExpand
     from .groups import GroupsListRequestExpand, GroupsRetrieveRequestExpand
     from .issues import IssuesListRequestStatus
-    from .link_token import EndUserDetailsRequestLanguage
+    from .link_token import EndUserDetailsRequestCompletedAccountInitialScreen, EndUserDetailsRequestLanguage
     from .linked_accounts import LinkedAccountsListRequestCategory
 _dynamic_imports: typing.Dict[str, str] = {
     "ArticlesListRequestExpand": ".articles",
+    "ArticlesListRequestType": ".articles",
     "ArticlesRetrieveRequestExpand": ".articles",
     "AsyncPassthroughRetrieveResponse": ".async_passthrough",
     "ContainersListRequestExpand": ".containers",
+    "ContainersListRequestType": ".containers",
     "ContainersRetrieveRequestExpand": ".containers",
+    "EndUserDetailsRequestCompletedAccountInitialScreen": ".link_token",
     "EndUserDetailsRequestLanguage": ".link_token",
     "GroupsListRequestExpand": ".groups",
     "GroupsRetrieveRequestExpand": ".groups",
@@ -94,10 +97,13 @@ def __dir__():
 
 __all__ = [
     "ArticlesListRequestExpand",
+    "ArticlesListRequestType",
     "ArticlesRetrieveRequestExpand",
     "AsyncPassthroughRetrieveResponse",
     "ContainersListRequestExpand",
+    "ContainersListRequestType",
     "ContainersRetrieveRequestExpand",
+    "EndUserDetailsRequestCompletedAccountInitialScreen",
     "EndUserDetailsRequestLanguage",
     "GroupsListRequestExpand",
     "GroupsRetrieveRequestExpand",

merge/resources/knowledgebase/resources/articles/__init__.py

@@ -6,9 +6,10 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
-    from .types import ArticlesListRequestExpand, ArticlesRetrieveRequestExpand
+    from .types import ArticlesListRequestExpand, ArticlesListRequestType, ArticlesRetrieveRequestExpand
 _dynamic_imports: typing.Dict[str, str] = {
     "ArticlesListRequestExpand": ".types",
+    "ArticlesListRequestType": ".types",
     "ArticlesRetrieveRequestExpand": ".types",
 }
 
@@ -32,4 +33,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["ArticlesListRequestExpand", "ArticlesRetrieveRequestExpand"]
+__all__ = ["ArticlesListRequestExpand", "ArticlesListRequestType", "ArticlesRetrieveRequestExpand"]