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

merge/resources/ats/resources/audit_trail/client.py

@@ -75,6 +75,11 @@ class AuditTrailClient:
         )
         client.ats.audit_trail.list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            end_date="end_date",
+            event_type="event_type",
+            page_size=1,
+            start_date="start_date",
+            user_email="user_email",
         )
         """
         _response = self._raw_client.list(
@@ -161,6 +166,11 @@ class AsyncAuditTrailClient:
         async def main() -> None:
             await client.ats.audit_trail.list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                end_date="end_date",
+                event_type="event_type",
+                page_size=1,
+                start_date="start_date",
+                user_email="user_email",
             )
 
 

merge/resources/ats/resources/candidates/client.py

@@ -115,14 +115,39 @@ class CandidatesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ats.resources.candidates import CandidatesListRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ats.candidates.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",
+            email_addresses="email_addresses",
+            expand=CandidatesListRequestExpand.APPLICATIONS,
+            first_name="first_name",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            last_name="last_name",
+            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_id="remote_id",
+            tags="tags",
         )
         """
         _response = self._raw_client.list(
@@ -187,6 +212,8 @@ class CandidatesClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.candidates.create(
+            is_debug_mode=True,
+            run_async=True,
             model=CandidateRequest(),
             remote_user_id="remote_user_id",
         )
@@ -236,6 +263,9 @@ class CandidatesClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ats.resources.candidates import (
+            CandidatesRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -243,6 +273,9 @@ class CandidatesClient:
         )
         client.ats.candidates.retrieve(
             id="id",
+            expand=CandidatesRetrieveRequestExpand.APPLICATIONS,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -300,6 +333,8 @@ class CandidatesClient:
         )
         client.ats.candidates.partial_update(
             id="id",
+            is_debug_mode=True,
+            run_async=True,
             model=PatchedCandidateRequest(),
             remote_user_id="remote_user_id",
         )
@@ -514,8 +549,10 @@ class AsyncCandidatesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.candidates import CandidatesListRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -525,7 +562,29 @@ class AsyncCandidatesClient:
 
         async def main() -> None:
             await client.ats.candidates.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",
+                email_addresses="email_addresses",
+                expand=CandidatesListRequestExpand.APPLICATIONS,
+                first_name="first_name",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                last_name="last_name",
+                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_id="remote_id",
+                tags="tags",
             )
 
 
@@ -598,6 +657,8 @@ class AsyncCandidatesClient:
 
         async def main() -> None:
             await client.ats.candidates.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=CandidateRequest(),
                 remote_user_id="remote_user_id",
             )
@@ -652,6 +713,9 @@ class AsyncCandidatesClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.candidates import (
+            CandidatesRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -662,6 +726,9 @@ class AsyncCandidatesClient:
         async def main() -> None:
             await client.ats.candidates.retrieve(
                 id="id",
+                expand=CandidatesRetrieveRequestExpand.APPLICATIONS,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 
@@ -727,6 +794,8 @@ class AsyncCandidatesClient:
         async def main() -> None:
             await client.ats.candidates.partial_update(
                 id="id",
+                is_debug_mode=True,
+                run_async=True,
                 model=PatchedCandidateRequest(),
                 remote_user_id="remote_user_id",
             )

merge/resources/ats/resources/departments/client.py

@@ -85,6 +85,8 @@ class DepartmentsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -92,7 +94,24 @@ class DepartmentsClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.departments.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,
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -149,6 +168,8 @@ class DepartmentsClient:
         )
         client.ats.departments.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -236,6 +257,7 @@ class AsyncDepartmentsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -247,7 +269,24 @@ class AsyncDepartmentsClient:
 
         async def main() -> None:
             await client.ats.departments.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,
+                remote_id="remote_id",
             )
 
 
@@ -312,6 +351,8 @@ class AsyncDepartmentsClient:
         async def main() -> None:
             await client.ats.departments.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/ats/resources/eeocs/client.py

@@ -105,14 +105,40 @@ class EeocsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ats.resources.eeocs import (
+            EeocsListRequestRemoteFields,
+            EeocsListRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ats.eeocs.list(
+            candidate_id="candidate_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",
+            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=EeocsListRequestRemoteFields.DISABILITY_STATUS,
+            remote_id="remote_id",
+            show_enum_origins=EeocsListRequestShowEnumOrigins.DISABILITY_STATUS,
         )
         """
         _response = self._raw_client.list(
@@ -178,6 +204,10 @@ class EeocsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ats.resources.eeocs import (
+            EeocsRetrieveRequestRemoteFields,
+            EeocsRetrieveRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -185,6 +215,10 @@ class EeocsClient:
         )
         client.ats.eeocs.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
+            remote_fields=EeocsRetrieveRequestRemoteFields.DISABILITY_STATUS,
+            show_enum_origins=EeocsRetrieveRequestShowEnumOrigins.DISABILITY_STATUS,
         )
         """
         _response = self._raw_client.retrieve(
@@ -291,8 +325,13 @@ class AsyncEeocsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.eeocs import (
+            EeocsListRequestRemoteFields,
+            EeocsListRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -302,7 +341,27 @@ class AsyncEeocsClient:
 
         async def main() -> None:
             await client.ats.eeocs.list(
+                candidate_id="candidate_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",
+                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=EeocsListRequestRemoteFields.DISABILITY_STATUS,
+                remote_id="remote_id",
+                show_enum_origins=EeocsListRequestShowEnumOrigins.DISABILITY_STATUS,
             )
 
 
@@ -373,6 +432,10 @@ class AsyncEeocsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.eeocs import (
+            EeocsRetrieveRequestRemoteFields,
+            EeocsRetrieveRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -383,6 +446,10 @@ class AsyncEeocsClient:
         async def main() -> None:
             await client.ats.eeocs.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
+                remote_fields=EeocsRetrieveRequestRemoteFields.DISABILITY_STATUS,
+                show_enum_origins=EeocsRetrieveRequestShowEnumOrigins.DISABILITY_STATUS,
             )
 
 

merge/resources/ats/resources/field_mapping/client.py

@@ -59,7 +59,9 @@ class FieldMappingClient:
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
-        client.ats.field_mapping.field_mappings_retrieve()
+        client.ats.field_mapping.field_mappings_retrieve(
+            exclude_remote_field_metadata=True,
+        )
         """
         _response = self._raw_client.field_mappings_retrieve(
             exclude_remote_field_metadata=exclude_remote_field_metadata, request_options=request_options
@@ -121,6 +123,7 @@ class FieldMappingClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.field_mapping.field_mappings_create(
+            exclude_remote_field_metadata=True,
             target_field_name="example_target_field_name",
             target_field_description="this is a example description of the target field",
             remote_field_traversal_path=["example_remote_field"],
@@ -262,7 +265,10 @@ class FieldMappingClient:
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
-        client.ats.field_mapping.remote_fields_retrieve()
+        client.ats.field_mapping.remote_fields_retrieve(
+            common_models="common_models",
+            include_example_values="include_example_values",
+        )
         """
         _response = self._raw_client.remote_fields_retrieve(
             common_models=common_models, include_example_values=include_example_values, request_options=request_options
@@ -349,7 +355,9 @@ class AsyncFieldMappingClient:
 
 
         async def main() -> None:
-            await client.ats.field_mapping.field_mappings_retrieve()
+            await client.ats.field_mapping.field_mappings_retrieve(
+                exclude_remote_field_metadata=True,
+            )
 
 
         asyncio.run(main())
@@ -419,6 +427,7 @@ class AsyncFieldMappingClient:
 
         async def main() -> None:
             await client.ats.field_mapping.field_mappings_create(
+                exclude_remote_field_metadata=True,
                 target_field_name="example_target_field_name",
                 target_field_description="this is a example description of the target field",
                 remote_field_traversal_path=["example_remote_field"],
@@ -584,7 +593,10 @@ class AsyncFieldMappingClient:
 
 
         async def main() -> None:
-            await client.ats.field_mapping.remote_fields_retrieve()
+            await client.ats.field_mapping.remote_fields_retrieve(
+                common_models="common_models",
+                include_example_values="include_example_values",
+            )
 
 
         asyncio.run(main())

merge/resources/ats/resources/interviews/client.py

@@ -121,14 +121,39 @@ class InterviewsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ats.resources.interviews import InterviewsListRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ats.interviews.list(
+            application_id="application_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",
+            expand=InterviewsListRequestExpand.APPLICATION,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            job_id="job_id",
+            job_interview_stage_id="job_interview_stage_id",
+            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",
+            ),
+            organizer_id="organizer_id",
+            page_size=1,
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -195,6 +220,8 @@ class InterviewsClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.interviews.create(
+            is_debug_mode=True,
+            run_async=True,
             model=ScheduledInterviewRequest(),
             remote_user_id="remote_user_id",
         )
@@ -252,6 +279,9 @@ class InterviewsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ats.resources.interviews import (
+            InterviewsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -259,6 +289,9 @@ class InterviewsClient:
         )
         client.ats.interviews.retrieve(
             id="id",
+            expand=InterviewsRetrieveRequestExpand.APPLICATION,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -404,8 +437,10 @@ class AsyncInterviewsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.interviews import InterviewsListRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -415,7 +450,29 @@ class AsyncInterviewsClient:
 
         async def main() -> None:
             await client.ats.interviews.list(
+                application_id="application_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",
+                expand=InterviewsListRequestExpand.APPLICATION,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                job_id="job_id",
+                job_interview_stage_id="job_interview_stage_id",
+                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",
+                ),
+                organizer_id="organizer_id",
+                page_size=1,
+                remote_id="remote_id",
             )
 
 
@@ -490,6 +547,8 @@ class AsyncInterviewsClient:
 
         async def main() -> None:
             await client.ats.interviews.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=ScheduledInterviewRequest(),
                 remote_user_id="remote_user_id",
             )
@@ -552,6 +611,9 @@ class AsyncInterviewsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.interviews import (
+            InterviewsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -562,6 +624,9 @@ class AsyncInterviewsClient:
         async def main() -> None:
             await client.ats.interviews.retrieve(
                 id="id",
+                expand=InterviewsRetrieveRequestExpand.APPLICATION,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/ats/resources/issues/client.py

@@ -102,14 +102,38 @@ class IssuesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ats.resources.issues import IssuesListRequestStatus
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ats.issues.list(
+            account_token="account_token",
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            end_date="end_date",
+            end_user_organization_name="end_user_organization_name",
+            first_incident_time_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            first_incident_time_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            include_muted="include_muted",
+            integration_name="integration_name",
+            last_incident_time_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            last_incident_time_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            linked_account_id="linked_account_id",
+            page_size=1,
+            start_date="start_date",
+            status=IssuesListRequestStatus.ONGOING,
         )
         """
         _response = self._raw_client.list(
@@ -255,8 +279,10 @@ class AsyncIssuesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.issues import IssuesListRequestStatus
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -266,7 +292,28 @@ class AsyncIssuesClient:
 
         async def main() -> None:
             await client.ats.issues.list(
+                account_token="account_token",
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                end_date="end_date",
+                end_user_organization_name="end_user_organization_name",
+                first_incident_time_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                first_incident_time_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                include_muted="include_muted",
+                integration_name="integration_name",
+                last_incident_time_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                last_incident_time_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                linked_account_id="linked_account_id",
+                page_size=1,
+                start_date="start_date",
+                status=IssuesListRequestStatus.ONGOING,
             )