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

merge/resources/accounting/resources/transactions/client.py

@@ -103,14 +103,44 @@ class TransactionsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.transactions import (
+            TransactionsListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.transactions.list(
+            company_id="company_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=TransactionsListRequestExpand.ACCOUNT,
+            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",
+            transaction_date_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            transaction_date_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
         )
         """
         _response = self._raw_client.list(
@@ -168,6 +198,9 @@ class TransactionsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.transactions import (
+            TransactionsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -175,6 +208,9 @@ class TransactionsClient:
         )
         client.accounting.transactions.retrieve(
             id="id",
+            expand=TransactionsRetrieveRequestExpand.ACCOUNT,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -279,8 +315,12 @@ class AsyncTransactionsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.transactions import (
+            TransactionsListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -290,7 +330,32 @@ class AsyncTransactionsClient:
 
         async def main() -> None:
             await client.accounting.transactions.list(
+                company_id="company_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=TransactionsListRequestExpand.ACCOUNT,
+                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",
+                transaction_date_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                transaction_date_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
             )
 
 
@@ -353,6 +418,9 @@ class AsyncTransactionsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.transactions import (
+            TransactionsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -363,6 +431,9 @@ class AsyncTransactionsClient:
         async def main() -> None:
             await client.accounting.transactions.retrieve(
                 id="id",
+                expand=TransactionsRetrieveRequestExpand.ACCOUNT,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/vendor_credits/client.py

@@ -109,14 +109,44 @@ class VendorCreditsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.vendor_credits import (
+            VendorCreditsListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.vendor_credits.list(
+            company_id="company_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=VendorCreditsListRequestExpand.ACCOUNTING_PERIOD,
+            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",
+            transaction_date_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            transaction_date_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
         )
         """
         _response = self._raw_client.list(
@@ -177,6 +207,8 @@ class VendorCreditsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.vendor_credits.create(
+            is_debug_mode=True,
+            run_async=True,
             model=VendorCreditRequest(),
         )
         """
@@ -221,6 +253,9 @@ class VendorCreditsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.vendor_credits import (
+            VendorCreditsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -228,6 +263,9 @@ class VendorCreditsClient:
         )
         client.accounting.vendor_credits.retrieve(
             id="id",
+            expand=VendorCreditsRetrieveRequestExpand.ACCOUNTING_PERIOD,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -359,8 +397,12 @@ class AsyncVendorCreditsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.vendor_credits import (
+            VendorCreditsListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -370,7 +412,32 @@ class AsyncVendorCreditsClient:
 
         async def main() -> None:
             await client.accounting.vendor_credits.list(
+                company_id="company_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=VendorCreditsListRequestExpand.ACCOUNTING_PERIOD,
+                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",
+                transaction_date_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                transaction_date_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
             )
 
 
@@ -439,6 +506,8 @@ class AsyncVendorCreditsClient:
 
         async def main() -> None:
             await client.accounting.vendor_credits.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=VendorCreditRequest(),
             )
 
@@ -488,6 +557,9 @@ class AsyncVendorCreditsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.vendor_credits import (
+            VendorCreditsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -498,6 +570,9 @@ class AsyncVendorCreditsClient:
         async def main() -> None:
             await client.accounting.vendor_credits.retrieve(
                 id="id",
+                expand=VendorCreditsRetrieveRequestExpand.ACCOUNTING_PERIOD,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/ats/resources/activities/client.py

@@ -111,14 +111,40 @@ class ActivitiesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ats.resources.activities import (
+            ActivitiesListRequestRemoteFields,
+            ActivitiesListRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ats.activities.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_fields=ActivitiesListRequestRemoteFields.ACTIVITY_TYPE,
+            remote_id="remote_id",
+            show_enum_origins=ActivitiesListRequestShowEnumOrigins.ACTIVITY_TYPE,
+            user_id="user_id",
         )
         """
         _response = self._raw_client.list(
@@ -182,6 +208,8 @@ class ActivitiesClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.activities.create(
+            is_debug_mode=True,
+            run_async=True,
             model=ActivityRequest(),
             remote_user_id="remote_user_id",
         )
@@ -239,6 +267,10 @@ class ActivitiesClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ats.resources.activities import (
+            ActivitiesRetrieveRequestRemoteFields,
+            ActivitiesRetrieveRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -246,6 +278,10 @@ class ActivitiesClient:
         )
         client.ats.activities.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
+            remote_fields=ActivitiesRetrieveRequestRemoteFields.ACTIVITY_TYPE,
+            show_enum_origins=ActivitiesRetrieveRequestShowEnumOrigins.ACTIVITY_TYPE,
         )
         """
         _response = self._raw_client.retrieve(
@@ -379,8 +415,13 @@ class AsyncActivitiesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.activities import (
+            ActivitiesListRequestRemoteFields,
+            ActivitiesListRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -390,7 +431,27 @@ class AsyncActivitiesClient:
 
         async def main() -> None:
             await client.ats.activities.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_fields=ActivitiesListRequestRemoteFields.ACTIVITY_TYPE,
+                remote_id="remote_id",
+                show_enum_origins=ActivitiesListRequestShowEnumOrigins.ACTIVITY_TYPE,
+                user_id="user_id",
             )
 
 
@@ -462,6 +523,8 @@ class AsyncActivitiesClient:
 
         async def main() -> None:
             await client.ats.activities.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=ActivityRequest(),
                 remote_user_id="remote_user_id",
             )
@@ -524,6 +587,10 @@ class AsyncActivitiesClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.activities import (
+            ActivitiesRetrieveRequestRemoteFields,
+            ActivitiesRetrieveRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -534,6 +601,10 @@ class AsyncActivitiesClient:
         async def main() -> None:
             await client.ats.activities.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
+                remote_fields=ActivitiesRetrieveRequestRemoteFields.ACTIVITY_TYPE,
+                show_enum_origins=ActivitiesRetrieveRequestShowEnumOrigins.ACTIVITY_TYPE,
             )
 
 

merge/resources/ats/resources/applications/client.py

@@ -121,14 +121,43 @@ class ApplicationsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.ats.resources.applications import (
+            ApplicationsListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.ats.applications.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",
+            ),
+            credited_to_id="credited_to_id",
+            current_stage_id="current_stage_id",
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            expand=ApplicationsListRequestExpand.CANDIDATE,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            job_id="job_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",
+            ),
+            page_size=1,
+            reject_reason_id="reject_reason_id",
+            remote_id="remote_id",
+            source="source",
         )
         """
         _response = self._raw_client.list(
@@ -198,6 +227,8 @@ class ApplicationsClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.applications.create(
+            is_debug_mode=True,
+            run_async=True,
             model=ApplicationRequest(),
             remote_user_id="remote_user_id",
         )
@@ -247,6 +278,9 @@ class ApplicationsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.ats.resources.applications import (
+            ApplicationsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -254,6 +288,9 @@ class ApplicationsClient:
         )
         client.ats.applications.retrieve(
             id="id",
+            expand=ApplicationsRetrieveRequestExpand.CANDIDATE,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -311,6 +348,8 @@ class ApplicationsClient:
         )
         client.ats.applications.change_stage_create(
             id="id",
+            is_debug_mode=True,
+            run_async=True,
         )
         """
         _response = self._raw_client.change_stage_create(
@@ -353,7 +392,9 @@ class ApplicationsClient:
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
-        client.ats.applications.meta_post_retrieve()
+        client.ats.applications.meta_post_retrieve(
+            application_remote_template_id="application_remote_template_id",
+        )
         """
         _response = self._raw_client.meta_post_retrieve(
             application_remote_template_id=application_remote_template_id, request_options=request_options
@@ -465,8 +506,12 @@ class AsyncApplicationsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.applications import (
+            ApplicationsListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -476,7 +521,31 @@ class AsyncApplicationsClient:
 
         async def main() -> None:
             await client.ats.applications.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",
+                ),
+                credited_to_id="credited_to_id",
+                current_stage_id="current_stage_id",
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                expand=ApplicationsListRequestExpand.CANDIDATE,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                job_id="job_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",
+                ),
+                page_size=1,
+                reject_reason_id="reject_reason_id",
+                remote_id="remote_id",
+                source="source",
             )
 
 
@@ -554,6 +623,8 @@ class AsyncApplicationsClient:
 
         async def main() -> None:
             await client.ats.applications.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=ApplicationRequest(),
                 remote_user_id="remote_user_id",
             )
@@ -608,6 +679,9 @@ class AsyncApplicationsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.ats.resources.applications import (
+            ApplicationsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -618,6 +692,9 @@ class AsyncApplicationsClient:
         async def main() -> None:
             await client.ats.applications.retrieve(
                 id="id",
+                expand=ApplicationsRetrieveRequestExpand.CANDIDATE,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 
@@ -683,6 +760,8 @@ class AsyncApplicationsClient:
         async def main() -> None:
             await client.ats.applications.change_stage_create(
                 id="id",
+                is_debug_mode=True,
+                run_async=True,
             )
 
 
@@ -733,7 +812,9 @@ class AsyncApplicationsClient:
 
 
         async def main() -> None:
-            await client.ats.applications.meta_post_retrieve()
+            await client.ats.applications.meta_post_retrieve(
+                application_remote_template_id="application_remote_template_id",
+            )
 
 
         asyncio.run(main())

merge/resources/ats/resources/attachments/client.py

@@ -107,6 +107,8 @@ class AttachmentsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -114,7 +116,25 @@ class AttachmentsClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.attachments.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_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -178,6 +198,8 @@ class AttachmentsClient:
             api_key="YOUR_API_KEY",
         )
         client.ats.attachments.create(
+            is_debug_mode=True,
+            run_async=True,
             model=AttachmentRequest(),
             remote_user_id="remote_user_id",
         )
@@ -242,6 +264,8 @@ class AttachmentsClient:
         )
         client.ats.attachments.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -375,6 +399,7 @@ class AsyncAttachmentsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -386,7 +411,25 @@ class AsyncAttachmentsClient:
 
         async def main() -> None:
             await client.ats.attachments.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_id="remote_id",
             )
 
 
@@ -458,6 +501,8 @@ class AsyncAttachmentsClient:
 
         async def main() -> None:
             await client.ats.attachments.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=AttachmentRequest(),
                 remote_user_id="remote_user_id",
             )
@@ -530,6 +575,8 @@ class AsyncAttachmentsClient:
         async def main() -> None:
             await client.ats.attachments.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )