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

merge/resources/accounting/resources/general_ledger_transactions/client.py

@@ -103,14 +103,44 @@ class GeneralLedgerTransactionsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.general_ledger_transactions import (
+            GeneralLedgerTransactionsListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.general_ledger_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=GeneralLedgerTransactionsListRequestExpand.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,
+            posted_date_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            posted_date_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            remote_id="remote_id",
         )
         """
         _response = self._raw_client.list(
@@ -168,6 +198,9 @@ class GeneralLedgerTransactionsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.general_ledger_transactions import (
+            GeneralLedgerTransactionsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -175,6 +208,9 @@ class GeneralLedgerTransactionsClient:
         )
         client.accounting.general_ledger_transactions.retrieve(
             id="id",
+            expand=GeneralLedgerTransactionsRetrieveRequestExpand.ACCOUNTING_PERIOD,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -279,8 +315,12 @@ class AsyncGeneralLedgerTransactionsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.general_ledger_transactions import (
+            GeneralLedgerTransactionsListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -290,7 +330,32 @@ class AsyncGeneralLedgerTransactionsClient:
 
         async def main() -> None:
             await client.accounting.general_ledger_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=GeneralLedgerTransactionsListRequestExpand.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,
+                posted_date_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                posted_date_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                remote_id="remote_id",
             )
 
 
@@ -353,6 +418,9 @@ class AsyncGeneralLedgerTransactionsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.general_ledger_transactions import (
+            GeneralLedgerTransactionsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -363,6 +431,9 @@ class AsyncGeneralLedgerTransactionsClient:
         async def main() -> None:
             await client.accounting.general_ledger_transactions.retrieve(
                 id="id",
+                expand=GeneralLedgerTransactionsRetrieveRequestExpand.ACCOUNTING_PERIOD,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/income_statements/client.py

@@ -93,6 +93,8 @@ class IncomeStatementsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -100,7 +102,25 @@ class IncomeStatementsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.income_statements.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",
+            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(
@@ -163,6 +183,8 @@ class IncomeStatementsClient:
         )
         client.accounting.income_statements.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -259,6 +281,7 @@ class AsyncIncomeStatementsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -270,7 +293,25 @@ class AsyncIncomeStatementsClient:
 
         async def main() -> None:
             await client.accounting.income_statements.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",
+                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",
             )
 
 
@@ -341,6 +382,8 @@ class AsyncIncomeStatementsClient:
         async def main() -> None:
             await client.accounting.income_statements.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/invoices/client.py

@@ -150,14 +150,51 @@ class InvoicesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.invoices import (
+            InvoicesListRequestExpand,
+            InvoicesListRequestStatus,
+            InvoicesListRequestType,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.invoices.list(
+            company_id="company_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=InvoicesListRequestExpand.ACCOUNTING_PERIOD,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
+            issue_date_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            issue_date_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            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",
+            ),
+            number="number",
+            page_size=1,
+            remote_id="remote_id",
+            status=InvoicesListRequestStatus.DRAFT,
+            type=InvoicesListRequestType.ACCOUNTS_PAYABLE,
         )
         """
         _response = self._raw_client.list(
@@ -227,6 +264,8 @@ class InvoicesClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.invoices.create(
+            is_debug_mode=True,
+            run_async=True,
             model=InvoiceRequest(),
         )
         """
@@ -283,6 +322,9 @@ class InvoicesClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.invoices import (
+            InvoicesRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -290,6 +332,10 @@ class InvoicesClient:
         )
         client.accounting.invoices.retrieve(
             id="id",
+            expand=InvoicesRetrieveRequestExpand.ACCOUNTING_PERIOD,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -347,6 +393,8 @@ class InvoicesClient:
         )
         client.accounting.invoices.partial_update(
             id="id",
+            is_debug_mode=True,
+            run_async=True,
             model=InvoiceRequest(),
         )
         """
@@ -411,6 +459,12 @@ class InvoicesClient:
         )
         client.accounting.invoices.line_items_remote_field_classes_list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            is_common_model_field=True,
+            is_custom=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.line_items_remote_field_classes_list(
@@ -539,6 +593,12 @@ class InvoicesClient:
         )
         client.accounting.invoices.remote_field_classes_list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            is_common_model_field=True,
+            is_custom=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.remote_field_classes_list(
@@ -684,8 +744,14 @@ class AsyncInvoicesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.invoices import (
+            InvoicesListRequestExpand,
+            InvoicesListRequestStatus,
+            InvoicesListRequestType,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -695,7 +761,37 @@ class AsyncInvoicesClient:
 
         async def main() -> None:
             await client.accounting.invoices.list(
+                company_id="company_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=InvoicesListRequestExpand.ACCOUNTING_PERIOD,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
+                issue_date_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                issue_date_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                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",
+                ),
+                number="number",
+                page_size=1,
+                remote_id="remote_id",
+                status=InvoicesListRequestStatus.DRAFT,
+                type=InvoicesListRequestType.ACCOUNTS_PAYABLE,
             )
 
 
@@ -773,6 +869,8 @@ class AsyncInvoicesClient:
 
         async def main() -> None:
             await client.accounting.invoices.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=InvoiceRequest(),
             )
 
@@ -834,6 +932,9 @@ class AsyncInvoicesClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.invoices import (
+            InvoicesRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -844,6 +945,10 @@ class AsyncInvoicesClient:
         async def main() -> None:
             await client.accounting.invoices.retrieve(
                 id="id",
+                expand=InvoicesRetrieveRequestExpand.ACCOUNTING_PERIOD,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -909,6 +1014,8 @@ class AsyncInvoicesClient:
         async def main() -> None:
             await client.accounting.invoices.partial_update(
                 id="id",
+                is_debug_mode=True,
+                run_async=True,
                 model=InvoiceRequest(),
             )
 
@@ -981,6 +1088,12 @@ class AsyncInvoicesClient:
         async def main() -> None:
             await client.accounting.invoices.line_items_remote_field_classes_list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                is_common_model_field=True,
+                is_custom=True,
+                page_size=1,
             )
 
 
@@ -1135,6 +1248,12 @@ class AsyncInvoicesClient:
         async def main() -> None:
             await client.accounting.invoices.remote_field_classes_list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                is_common_model_field=True,
+                is_custom=True,
+                page_size=1,
             )
 
 

merge/resources/accounting/resources/issues/client.py

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

@@ -110,14 +110,36 @@ class ItemsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.items import ItemsListRequestExpand
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.items.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=ItemsListRequestExpand.COMPANY,
+            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 +200,8 @@ class ItemsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.items.create(
+            is_debug_mode=True,
+            run_async=True,
             model=ItemRequestRequest(),
         )
         """
@@ -230,6 +254,9 @@ class ItemsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.items import (
+            ItemsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -237,6 +264,9 @@ class ItemsClient:
         )
         client.accounting.items.retrieve(
             id="id",
+            expand=ItemsRetrieveRequestExpand.COMPANY,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -293,6 +323,8 @@ class ItemsClient:
         )
         client.accounting.items.partial_update(
             id="id",
+            is_debug_mode=True,
+            run_async=True,
             model=PatchedItemRequestRequest(),
         )
         """
@@ -452,8 +484,10 @@ class AsyncItemsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.items import ItemsListRequestExpand
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -463,7 +497,26 @@ class AsyncItemsClient:
 
         async def main() -> None:
             await client.accounting.items.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=ItemsListRequestExpand.COMPANY,
+                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",
             )
 
 
@@ -532,6 +585,8 @@ class AsyncItemsClient:
 
         async def main() -> None:
             await client.accounting.items.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=ItemRequestRequest(),
             )
 
@@ -589,6 +644,9 @@ class AsyncItemsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.items import (
+            ItemsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -599,6 +657,9 @@ class AsyncItemsClient:
         async def main() -> None:
             await client.accounting.items.retrieve(
                 id="id",
+                expand=ItemsRetrieveRequestExpand.COMPANY,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 
@@ -663,6 +724,8 @@ class AsyncItemsClient:
         async def main() -> None:
             await client.accounting.items.partial_update(
                 id="id",
+                is_debug_mode=True,
+                run_async=True,
                 model=PatchedItemRequestRequest(),
             )