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

merge/resources/hris/resources/payroll_runs/client.py

@@ -88,7 +88,7 @@ class PayrollRunsClient:
             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.
 
         remote_fields : typing.Optional[PayrollRunsListRequestRemoteFields]
             Deprecated. Use show_enum_origins.
@@ -124,14 +124,53 @@ class PayrollRunsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.hris.resources.payroll_runs import (
+            PayrollRunsListRequestRemoteFields,
+            PayrollRunsListRequestRunType,
+            PayrollRunsListRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.hris.payroll_runs.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",
+            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",
+            ),
+            page_size=1,
+            remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE,
+            remote_id="remote_id",
+            run_type=PayrollRunsListRequestRunType.CORRECTION,
+            show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE,
+            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(
@@ -196,6 +235,10 @@ class PayrollRunsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.hris.resources.payroll_runs import (
+            PayrollRunsRetrieveRequestRemoteFields,
+            PayrollRunsRetrieveRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -203,6 +246,10 @@ class PayrollRunsClient:
         )
         client.hris.payroll_runs.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
+            remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE,
+            show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE,
         )
         """
         _response = self._raw_client.retrieve(
@@ -289,7 +336,7 @@ class AsyncPayrollRunsClient:
             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.
 
         remote_fields : typing.Optional[PayrollRunsListRequestRemoteFields]
             Deprecated. Use show_enum_origins.
@@ -326,8 +373,14 @@ class AsyncPayrollRunsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.hris.resources.payroll_runs import (
+            PayrollRunsListRequestRemoteFields,
+            PayrollRunsListRequestRunType,
+            PayrollRunsListRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -337,7 +390,39 @@ class AsyncPayrollRunsClient:
 
         async def main() -> None:
             await client.hris.payroll_runs.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",
+                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",
+                ),
+                page_size=1,
+                remote_fields=PayrollRunsListRequestRemoteFields.RUN_STATE,
+                remote_id="remote_id",
+                run_type=PayrollRunsListRequestRunType.CORRECTION,
+                show_enum_origins=PayrollRunsListRequestShowEnumOrigins.RUN_STATE,
+                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",
+                ),
             )
 
 
@@ -407,6 +492,10 @@ class AsyncPayrollRunsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.hris.resources.payroll_runs import (
+            PayrollRunsRetrieveRequestRemoteFields,
+            PayrollRunsRetrieveRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -417,6 +506,10 @@ class AsyncPayrollRunsClient:
         async def main() -> None:
             await client.hris.payroll_runs.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
+                remote_fields=PayrollRunsRetrieveRequestRemoteFields.RUN_STATE,
+                show_enum_origins=PayrollRunsRetrieveRequestShowEnumOrigins.RUN_STATE,
             )
 
 

merge/resources/hris/resources/payroll_runs/raw_client.py

@@ -82,7 +82,7 @@ class RawPayrollRunsClient:
             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.
 
         remote_fields : typing.Optional[PayrollRunsListRequestRemoteFields]
             Deprecated. Use show_enum_origins.
@@ -281,7 +281,7 @@ class AsyncRawPayrollRunsClient:
             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.
 
         remote_fields : typing.Optional[PayrollRunsListRequestRemoteFields]
             Deprecated. Use show_enum_origins.

merge/resources/hris/resources/sync_status/client.py

@@ -39,7 +39,7 @@ class SyncStatusClient:
             The pagination cursor value.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -59,6 +59,7 @@ class SyncStatusClient:
         )
         client.hris.sync_status.list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            page_size=1,
         )
         """
         _response = self._raw_client.list(cursor=cursor, page_size=page_size, request_options=request_options)
@@ -96,7 +97,7 @@ class AsyncSyncStatusClient:
             The pagination cursor value.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -121,6 +122,7 @@ class AsyncSyncStatusClient:
         async def main() -> None:
             await client.hris.sync_status.list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                page_size=1,
             )
 
 

merge/resources/hris/resources/sync_status/raw_client.py

@@ -31,7 +31,7 @@ class RawSyncStatusClient:
             The pagination cursor value.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.
@@ -86,7 +86,7 @@ class AsyncRawSyncStatusClient:
             The pagination cursor value.
 
         page_size : typing.Optional[int]
-            Number of results to return per page.
+            Number of results to return per page. The maximum limit is 100.
 
         request_options : typing.Optional[RequestOptions]
             Request-specific configuration.

merge/resources/hris/resources/teams/client.py

@@ -75,7 +75,7 @@ class TeamsClient:
             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.
 
         parent_team_id : typing.Optional[str]
             If provided, will only return teams with this parent team.
@@ -93,6 +93,8 @@ class TeamsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -100,7 +102,25 @@ class TeamsClient:
             api_key="YOUR_API_KEY",
         )
         client.hris.teams.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",
+            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,
+            parent_team_id="parent_team_id",
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -163,6 +183,8 @@ class TeamsClient:
         )
         client.hris.teams.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -240,7 +262,7 @@ class AsyncTeamsClient:
             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.
 
         parent_team_id : typing.Optional[str]
             If provided, will only return teams with this parent team.
@@ -259,6 +281,7 @@ class AsyncTeamsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -270,7 +293,25 @@ class AsyncTeamsClient:
 
         async def main() -> None:
             await client.hris.teams.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",
+                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,
+                parent_team_id="parent_team_id",
+                remote_id="remote_id",
             )
 
 
@@ -341,6 +382,8 @@ class AsyncTeamsClient:
         async def main() -> None:
             await client.hris.teams.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/hris/resources/teams/raw_client.py

@@ -69,7 +69,7 @@ class RawTeamsClient:
             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.
 
         parent_team_id : typing.Optional[str]
             If provided, will only return teams with this parent team.
@@ -232,7 +232,7 @@ class AsyncRawTeamsClient:
             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.
 
         parent_team_id : typing.Optional[str]
             If provided, will only return teams with this parent team.

merge/resources/hris/resources/time_off/client.py

@@ -110,7 +110,7 @@ class TimeOffClient:
             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.
 
         remote_fields : typing.Optional[TimeOffListRequestRemoteFields]
             Deprecated. Use show_enum_origins.
@@ -156,14 +156,59 @@ class TimeOffClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.hris.resources.time_off import (
+            TimeOffListRequestExpand,
+            TimeOffListRequestRemoteFields,
+            TimeOffListRequestRequestType,
+            TimeOffListRequestShowEnumOrigins,
+            TimeOffListRequestStatus,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.hris.time_off.list(
+            approver_id="approver_id",
+            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",
+            ),
+            expand=TimeOffListRequestExpand.APPROVER,
+            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,
+            remote_fields=TimeOffListRequestRemoteFields.REQUEST_TYPE,
+            remote_id="remote_id",
+            request_type=TimeOffListRequestRequestType.BEREAVEMENT,
+            show_enum_origins=TimeOffListRequestShowEnumOrigins.REQUEST_TYPE,
+            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",
+            ),
+            status=TimeOffListRequestStatus.APPROVED,
         )
         """
         _response = self._raw_client.list(
@@ -231,6 +276,8 @@ class TimeOffClient:
             api_key="YOUR_API_KEY",
         )
         client.hris.time_off.create(
+            is_debug_mode=True,
+            run_async=True,
             model=TimeOffRequest(),
         )
         """
@@ -283,6 +330,11 @@ class TimeOffClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.hris.resources.time_off import (
+            TimeOffRetrieveRequestExpand,
+            TimeOffRetrieveRequestRemoteFields,
+            TimeOffRetrieveRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -290,6 +342,11 @@ class TimeOffClient:
         )
         client.hris.time_off.retrieve(
             id="id",
+            expand=TimeOffRetrieveRequestExpand.APPROVER,
+            include_remote_data=True,
+            include_shell_data=True,
+            remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE,
+            show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE,
         )
         """
         _response = self._raw_client.retrieve(
@@ -417,7 +474,7 @@ class AsyncTimeOffClient:
             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.
 
         remote_fields : typing.Optional[TimeOffListRequestRemoteFields]
             Deprecated. Use show_enum_origins.
@@ -464,8 +521,16 @@ class AsyncTimeOffClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.hris.resources.time_off import (
+            TimeOffListRequestExpand,
+            TimeOffListRequestRemoteFields,
+            TimeOffListRequestRequestType,
+            TimeOffListRequestShowEnumOrigins,
+            TimeOffListRequestStatus,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -475,7 +540,43 @@ class AsyncTimeOffClient:
 
         async def main() -> None:
             await client.hris.time_off.list(
+                approver_id="approver_id",
+                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",
+                ),
+                expand=TimeOffListRequestExpand.APPROVER,
+                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,
+                remote_fields=TimeOffListRequestRemoteFields.REQUEST_TYPE,
+                remote_id="remote_id",
+                request_type=TimeOffListRequestRequestType.BEREAVEMENT,
+                show_enum_origins=TimeOffListRequestShowEnumOrigins.REQUEST_TYPE,
+                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",
+                ),
+                status=TimeOffListRequestStatus.APPROVED,
             )
 
 
@@ -551,6 +652,8 @@ class AsyncTimeOffClient:
 
         async def main() -> None:
             await client.hris.time_off.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=TimeOffRequest(),
             )
 
@@ -608,6 +711,11 @@ class AsyncTimeOffClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.hris.resources.time_off import (
+            TimeOffRetrieveRequestExpand,
+            TimeOffRetrieveRequestRemoteFields,
+            TimeOffRetrieveRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -618,6 +726,11 @@ class AsyncTimeOffClient:
         async def main() -> None:
             await client.hris.time_off.retrieve(
                 id="id",
+                expand=TimeOffRetrieveRequestExpand.APPROVER,
+                include_remote_data=True,
+                include_shell_data=True,
+                remote_fields=TimeOffRetrieveRequestRemoteFields.REQUEST_TYPE,
+                show_enum_origins=TimeOffRetrieveRequestShowEnumOrigins.REQUEST_TYPE,
             )
 
 

merge/resources/hris/resources/time_off/raw_client.py

@@ -104,7 +104,7 @@ class RawTimeOffClient:
             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.
 
         remote_fields : typing.Optional[TimeOffListRequestRemoteFields]
             Deprecated. Use show_enum_origins.
@@ -431,7 +431,7 @@ class AsyncRawTimeOffClient:
             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.
 
         remote_fields : typing.Optional[TimeOffListRequestRemoteFields]
             Deprecated. Use show_enum_origins.