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

merge/resources/crm/resources/field_mapping/client.py

@@ -59,7 +59,9 @@ class FieldMappingClient:
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
-        client.crm.field_mapping.field_mappings_retrieve()
+        client.crm.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.crm.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.crm.field_mapping.remote_fields_retrieve()
+        client.crm.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.crm.field_mapping.field_mappings_retrieve()
+            await client.crm.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.crm.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.crm.field_mapping.remote_fields_retrieve()
+            await client.crm.field_mapping.remote_fields_retrieve(
+                common_models="common_models",
+                include_example_values="include_example_values",
+            )
 
 
         asyncio.run(main())

merge/resources/crm/resources/issues/client.py

@@ -102,14 +102,38 @@ class IssuesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.crm.resources.issues import IssuesListRequestStatus
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.crm.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.crm.resources.issues import IssuesListRequestStatus
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -266,7 +292,28 @@ class AsyncIssuesClient:
 
         async def main() -> None:
             await client.crm.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,
             )
 
 

merge/resources/crm/resources/leads/client.py

@@ -122,14 +122,41 @@ class LeadsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.crm.resources.leads import LeadsListRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.crm.leads.list(
+            converted_account_id="converted_account_id",
+            converted_contact_id="converted_contact_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=LeadsListRequestExpand.CONVERTED_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",
+            ),
+            owner_id="owner_id",
+            page_size=1,
+            phone_numbers="phone_numbers",
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -193,6 +220,8 @@ class LeadsClient:
             api_key="YOUR_API_KEY",
         )
         client.crm.leads.create(
+            is_debug_mode=True,
+            run_async=True,
             model=LeadRequest(),
         )
         """
@@ -241,6 +270,7 @@ class LeadsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.crm.resources.leads import LeadsRetrieveRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -248,6 +278,10 @@ class LeadsClient:
         )
         client.crm.leads.retrieve(
             id="id",
+            expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -347,6 +381,13 @@ class LeadsClient:
         )
         client.crm.leads.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(
@@ -467,8 +508,10 @@ class AsyncLeadsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.leads import LeadsListRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -478,7 +521,31 @@ class AsyncLeadsClient:
 
         async def main() -> None:
             await client.crm.leads.list(
+                converted_account_id="converted_account_id",
+                converted_contact_id="converted_contact_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=LeadsListRequestExpand.CONVERTED_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",
+                ),
+                owner_id="owner_id",
+                page_size=1,
+                phone_numbers="phone_numbers",
+                remote_id="remote_id",
             )
 
 
@@ -550,6 +617,8 @@ class AsyncLeadsClient:
 
         async def main() -> None:
             await client.crm.leads.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=LeadRequest(),
             )
 
@@ -603,6 +672,7 @@ class AsyncLeadsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.leads import LeadsRetrieveRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -613,6 +683,10 @@ class AsyncLeadsClient:
         async def main() -> None:
             await client.crm.leads.retrieve(
                 id="id",
+                expand=LeadsRetrieveRequestExpand.CONVERTED_ACCOUNT,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -728,6 +802,13 @@ class AsyncLeadsClient:
         async def main() -> None:
             await client.crm.leads.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/linked_accounts/client.py

@@ -104,13 +104,28 @@ class LinkedAccountsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.crm.resources.linked_accounts import (
+            LinkedAccountsListRequestCategory,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.crm.linked_accounts.list(
+            category=LinkedAccountsListRequestCategory.ACCOUNTING,
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            end_user_email_address="end_user_email_address",
+            end_user_organization_name="end_user_organization_name",
+            end_user_origin_id="end_user_origin_id",
+            end_user_origin_ids="end_user_origin_ids",
+            id="id",
+            ids="ids",
+            include_duplicates=True,
+            integration_name="integration_name",
+            is_test_account="is_test_account",
+            page_size=1,
+            status="status",
         )
         """
         _response = self._raw_client.list(
@@ -229,6 +244,9 @@ class AsyncLinkedAccountsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.linked_accounts import (
+            LinkedAccountsListRequestCategory,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -238,7 +256,19 @@ class AsyncLinkedAccountsClient:
 
         async def main() -> None:
             await client.crm.linked_accounts.list(
+                category=LinkedAccountsListRequestCategory.ACCOUNTING,
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                end_user_email_address="end_user_email_address",
+                end_user_organization_name="end_user_organization_name",
+                end_user_origin_id="end_user_origin_id",
+                end_user_origin_ids="end_user_origin_ids",
+                id="id",
+                ids="ids",
+                include_duplicates=True,
+                integration_name="integration_name",
+                is_test_account="is_test_account",
+                page_size=1,
+                status="status",
             )
 
 

merge/resources/crm/resources/notes/client.py

@@ -118,14 +118,40 @@ class NotesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.crm.resources.notes import NotesListRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.crm.notes.list(
+            account_id="account_id",
+            contact_id="contact_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=NotesListRequestExpand.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",
+            ),
+            opportunity_id="opportunity_id",
+            owner_id="owner_id",
+            page_size=1,
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -188,6 +214,8 @@ class NotesClient:
             api_key="YOUR_API_KEY",
         )
         client.crm.notes.create(
+            is_debug_mode=True,
+            run_async=True,
             model=NoteRequest(),
         )
         """
@@ -236,6 +264,7 @@ class NotesClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.crm.resources.notes import NotesRetrieveRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -243,6 +272,10 @@ class NotesClient:
         )
         client.crm.notes.retrieve(
             id="id",
+            expand=NotesRetrieveRequestExpand.ACCOUNT,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -342,6 +375,13 @@ class NotesClient:
         )
         client.crm.notes.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(
@@ -458,8 +498,10 @@ class AsyncNotesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.notes import NotesListRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -469,7 +511,30 @@ class AsyncNotesClient:
 
         async def main() -> None:
             await client.crm.notes.list(
+                account_id="account_id",
+                contact_id="contact_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=NotesListRequestExpand.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",
+                ),
+                opportunity_id="opportunity_id",
+                owner_id="owner_id",
+                page_size=1,
+                remote_id="remote_id",
             )
 
 
@@ -540,6 +605,8 @@ class AsyncNotesClient:
 
         async def main() -> None:
             await client.crm.notes.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=NoteRequest(),
             )
 
@@ -593,6 +660,7 @@ class AsyncNotesClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.crm.resources.notes import NotesRetrieveRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -603,6 +671,10 @@ class AsyncNotesClient:
         async def main() -> None:
             await client.crm.notes.retrieve(
                 id="id",
+                expand=NotesRetrieveRequestExpand.ACCOUNT,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -718,6 +790,13 @@ class AsyncNotesClient:
         async def main() -> None:
             await client.crm.notes.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,
             )