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

merge/resources/crm/resources/contacts/client.py

@@ -116,14 +116,39 @@ class ContactsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.crm.resources.contacts import ContactsListRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.crm.contacts.list(
+            account_id="account_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",
+            email_addresses="email_addresses",
+            expand=ContactsListRequestExpand.ACCOUNT,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=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,
+            phone_numbers="phone_numbers",
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -185,6 +210,8 @@ class ContactsClient:
             api_key="YOUR_API_KEY",
         )
         client.crm.contacts.create(
+            is_debug_mode=True,
+            run_async=True,
             model=ContactRequest(),
         )
         """
@@ -233,6 +260,7 @@ class ContactsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.crm.resources.contacts import ContactsRetrieveRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -240,6 +268,10 @@ class ContactsClient:
         )
         client.crm.contacts.retrieve(
             id="id",
+            expand=ContactsRetrieveRequestExpand.ACCOUNT,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -295,6 +327,8 @@ class ContactsClient:
         )
         client.crm.contacts.partial_update(
             id="id",
+            is_debug_mode=True,
+            run_async=True,
             model=PatchedContactRequest(),
         )
         """
@@ -463,6 +497,13 @@ class ContactsClient:
         )
         client.crm.contacts.remote_field_classes_list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
+            is_common_model_field=True,
+            is_custom=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.remote_field_classes_list(
@@ -575,8 +616,10 @@ class AsyncContactsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.contacts import ContactsListRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -586,7 +629,29 @@ class AsyncContactsClient:
 
         async def main() -> None:
             await client.crm.contacts.list(
+                account_id="account_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",
+                email_addresses="email_addresses",
+                expand=ContactsListRequestExpand.ACCOUNT,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=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,
+                phone_numbers="phone_numbers",
+                remote_id="remote_id",
             )
 
 
@@ -656,6 +721,8 @@ class AsyncContactsClient:
 
         async def main() -> None:
             await client.crm.contacts.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=ContactRequest(),
             )
 
@@ -709,6 +776,7 @@ class AsyncContactsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.contacts import ContactsRetrieveRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -719,6 +787,10 @@ class AsyncContactsClient:
         async def main() -> None:
             await client.crm.contacts.retrieve(
                 id="id",
+                expand=ContactsRetrieveRequestExpand.ACCOUNT,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -782,6 +854,8 @@ class AsyncContactsClient:
         async def main() -> None:
             await client.crm.contacts.partial_update(
                 id="id",
+                is_debug_mode=True,
+                run_async=True,
                 model=PatchedContactRequest(),
             )
 
@@ -984,6 +1058,13 @@ class AsyncContactsClient:
         async def main() -> None:
             await client.crm.contacts.remote_field_classes_list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
+                is_common_model_field=True,
+                is_custom=True,
+                page_size=1,
             )
 
 

merge/resources/crm/resources/custom_object_classes/client.py

@@ -89,6 +89,8 @@ class CustomObjectClassesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -96,7 +98,24 @@ class CustomObjectClassesClient:
             api_key="YOUR_API_KEY",
         )
         client.crm.custom_object_classes.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(
@@ -158,6 +177,8 @@ class CustomObjectClassesClient:
         )
         client.crm.custom_object_classes.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -250,6 +271,7 @@ class AsyncCustomObjectClassesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -261,7 +283,24 @@ class AsyncCustomObjectClassesClient:
 
         async def main() -> None:
             await client.crm.custom_object_classes.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",
             )
 
 
@@ -331,6 +370,8 @@ class AsyncCustomObjectClassesClient:
         async def main() -> None:
             await client.crm.custom_object_classes.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/crm/resources/custom_objects/client.py

@@ -99,6 +99,8 @@ class CustomObjectsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -107,7 +109,25 @@ class CustomObjectsClient:
         )
         client.crm.custom_objects.custom_object_classes_custom_objects_list(
             custom_object_class_id="custom_object_class_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_remote_fields=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.custom_object_classes_custom_objects_list(
@@ -170,6 +190,8 @@ class CustomObjectsClient:
         )
         client.crm.custom_objects.custom_object_classes_custom_objects_create(
             custom_object_class_id="custom_object_class_id",
+            is_debug_mode=True,
+            run_async=True,
             model=CustomObjectRequest(
                 fields={"test_field": "hello"},
             ),
@@ -231,6 +253,9 @@ class CustomObjectsClient:
         client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
             custom_object_class_id="custom_object_class_id",
             id="id",
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.custom_object_classes_custom_objects_retrieve(
@@ -338,6 +363,13 @@ class CustomObjectsClient:
         )
         client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
+            is_common_model_field=True,
+            is_custom=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.custom_object_classes_custom_objects_remote_field_classes_list(
@@ -437,6 +469,7 @@ class AsyncCustomObjectsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -449,7 +482,25 @@ class AsyncCustomObjectsClient:
         async def main() -> None:
             await client.crm.custom_objects.custom_object_classes_custom_objects_list(
                 custom_object_class_id="custom_object_class_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_remote_fields=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",
             )
 
 
@@ -520,6 +571,8 @@ class AsyncCustomObjectsClient:
         async def main() -> None:
             await client.crm.custom_objects.custom_object_classes_custom_objects_create(
                 custom_object_class_id="custom_object_class_id",
+                is_debug_mode=True,
+                run_async=True,
                 model=CustomObjectRequest(
                     fields={"test_field": "hello"},
                 ),
@@ -589,6 +642,9 @@ class AsyncCustomObjectsClient:
             await client.crm.custom_objects.custom_object_classes_custom_objects_retrieve(
                 custom_object_class_id="custom_object_class_id",
                 id="id",
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -712,6 +768,13 @@ class AsyncCustomObjectsClient:
         async def main() -> None:
             await client.crm.custom_objects.custom_object_classes_custom_objects_remote_field_classes_list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
+                is_common_model_field=True,
+                is_custom=True,
+                page_size=1,
             )
 
 

merge/resources/crm/resources/engagement_types/client.py

@@ -90,6 +90,8 @@ class EngagementTypesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -97,7 +99,25 @@ class EngagementTypesClient:
             api_key="YOUR_API_KEY",
         )
         client.crm.engagement_types.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_remote_fields=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(
@@ -159,6 +179,9 @@ class EngagementTypesClient:
         )
         client.crm.engagement_types.retrieve(
             id="id",
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -230,6 +253,13 @@ class EngagementTypesClient:
         )
         client.crm.engagement_types.remote_field_classes_list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
+            is_common_model_field=True,
+            is_custom=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.remote_field_classes_list(
@@ -326,6 +356,7 @@ class AsyncEngagementTypesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -337,7 +368,25 @@ class AsyncEngagementTypesClient:
 
         async def main() -> None:
             await client.crm.engagement_types.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_remote_fields=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",
             )
 
 
@@ -407,6 +456,9 @@ class AsyncEngagementTypesClient:
         async def main() -> None:
             await client.crm.engagement_types.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -486,6 +538,13 @@ class AsyncEngagementTypesClient:
         async def main() -> None:
             await client.crm.engagement_types.remote_field_classes_list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
+                is_common_model_field=True,
+                is_custom=True,
+                page_size=1,
             )
 
 

merge/resources/crm/resources/engagements/client.py

@@ -111,14 +111,44 @@ class EngagementsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.crm.resources.engagements import (
+            EngagementsListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.crm.engagements.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",
+            expand=EngagementsListRequestExpand.ACCOUNT,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=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",
+            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(
@@ -179,6 +209,8 @@ class EngagementsClient:
             api_key="YOUR_API_KEY",
         )
         client.crm.engagements.create(
+            is_debug_mode=True,
+            run_async=True,
             model=EngagementRequest(),
         )
         """
@@ -227,6 +259,9 @@ class EngagementsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.crm.resources.engagements import (
+            EngagementsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -234,6 +269,10 @@ class EngagementsClient:
         )
         client.crm.engagements.retrieve(
             id="id",
+            expand=EngagementsRetrieveRequestExpand.ACCOUNT,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -289,6 +328,8 @@ class EngagementsClient:
         )
         client.crm.engagements.partial_update(
             id="id",
+            is_debug_mode=True,
+            run_async=True,
             model=PatchedEngagementRequest(),
         )
         """
@@ -415,6 +456,13 @@ class EngagementsClient:
         )
         client.crm.engagements.remote_field_classes_list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
+            is_common_model_field=True,
+            is_custom=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.remote_field_classes_list(
@@ -523,8 +571,12 @@ class AsyncEngagementsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.engagements import (
+            EngagementsListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -534,7 +586,32 @@ class AsyncEngagementsClient:
 
         async def main() -> None:
             await client.crm.engagements.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",
+                expand=EngagementsListRequestExpand.ACCOUNT,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=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",
+                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",
+                ),
             )
 
 
@@ -603,6 +680,8 @@ class AsyncEngagementsClient:
 
         async def main() -> None:
             await client.crm.engagements.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=EngagementRequest(),
             )
 
@@ -656,6 +735,9 @@ class AsyncEngagementsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.engagements import (
+            EngagementsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -666,6 +748,10 @@ class AsyncEngagementsClient:
         async def main() -> None:
             await client.crm.engagements.retrieve(
                 id="id",
+                expand=EngagementsRetrieveRequestExpand.ACCOUNT,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -729,6 +815,8 @@ class AsyncEngagementsClient:
         async def main() -> None:
             await client.crm.engagements.partial_update(
                 id="id",
+                is_debug_mode=True,
+                run_async=True,
                 model=PatchedEngagementRequest(),
             )
 
@@ -881,6 +969,13 @@ class AsyncEngagementsClient:
         async def main() -> None:
             await client.crm.engagements.remote_field_classes_list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
+                is_common_model_field=True,
+                is_custom=True,
+                page_size=1,
             )