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

merge/resources/accounting/resources/accounts/raw_client.py

@@ -16,8 +16,10 @@ from ...types.account_request import AccountRequest
 from ...types.account_response import AccountResponse
 from ...types.meta_response import MetaResponse
 from ...types.paginated_account_list import PaginatedAccountList
+from .types.accounts_list_request_classification import AccountsListRequestClassification
 from .types.accounts_list_request_remote_fields import AccountsListRequestRemoteFields
 from .types.accounts_list_request_show_enum_origins import AccountsListRequestShowEnumOrigins
+from .types.accounts_list_request_status import AccountsListRequestStatus
 from .types.accounts_retrieve_request_remote_fields import AccountsRetrieveRequestRemoteFields
 from .types.accounts_retrieve_request_show_enum_origins import AccountsRetrieveRequestShowEnumOrigins
 
@@ -33,7 +35,7 @@ class RawAccountsClient:
         self,
         *,
         account_type: typing.Optional[str] = None,
-        classification: typing.Optional[str] = None,
+        classification: typing.Optional[AccountsListRequestClassification] = None,
         company_id: typing.Optional[str] = None,
         created_after: typing.Optional[dt.datetime] = None,
         created_before: typing.Optional[dt.datetime] = None,
@@ -49,7 +51,7 @@ class RawAccountsClient:
         remote_fields: typing.Optional[AccountsListRequestRemoteFields] = None,
         remote_id: typing.Optional[str] = None,
         show_enum_origins: typing.Optional[AccountsListRequestShowEnumOrigins] = None,
-        status: typing.Optional[str] = None,
+        status: typing.Optional[AccountsListRequestStatus] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[PaginatedAccountList]:
         """
@@ -60,7 +62,7 @@ class RawAccountsClient:
         account_type : typing.Optional[str]
             If provided, will only return accounts with the passed in enum.
 
-        classification : typing.Optional[str]
+        classification : typing.Optional[AccountsListRequestClassification]
             If provided, will only return accounts with this classification.
 
         company_id : typing.Optional[str]
@@ -108,7 +110,7 @@ class RawAccountsClient:
         show_enum_origins : typing.Optional[AccountsListRequestShowEnumOrigins]
             A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
 
-        status : typing.Optional[str]
+        status : typing.Optional[AccountsListRequestStatus]
             If provided, will only return accounts with this status.
 
         request_options : typing.Optional[RequestOptions]
@@ -332,7 +334,7 @@ class AsyncRawAccountsClient:
         self,
         *,
         account_type: typing.Optional[str] = None,
-        classification: typing.Optional[str] = None,
+        classification: typing.Optional[AccountsListRequestClassification] = None,
         company_id: typing.Optional[str] = None,
         created_after: typing.Optional[dt.datetime] = None,
         created_before: typing.Optional[dt.datetime] = None,
@@ -348,7 +350,7 @@ class AsyncRawAccountsClient:
         remote_fields: typing.Optional[AccountsListRequestRemoteFields] = None,
         remote_id: typing.Optional[str] = None,
         show_enum_origins: typing.Optional[AccountsListRequestShowEnumOrigins] = None,
-        status: typing.Optional[str] = None,
+        status: typing.Optional[AccountsListRequestStatus] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[PaginatedAccountList]:
         """
@@ -359,7 +361,7 @@ class AsyncRawAccountsClient:
         account_type : typing.Optional[str]
             If provided, will only return accounts with the passed in enum.
 
-        classification : typing.Optional[str]
+        classification : typing.Optional[AccountsListRequestClassification]
             If provided, will only return accounts with this classification.
 
         company_id : typing.Optional[str]
@@ -407,7 +409,7 @@ class AsyncRawAccountsClient:
         show_enum_origins : typing.Optional[AccountsListRequestShowEnumOrigins]
             A comma separated list of enum field names for which you'd like the original values to be returned, instead of Merge's normalized enum values. [Learn more](https://help.merge.dev/en/articles/8950958-show_enum_origins-query-parameter)
 
-        status : typing.Optional[str]
+        status : typing.Optional[AccountsListRequestStatus]
             If provided, will only return accounts with this status.
 
         request_options : typing.Optional[RequestOptions]

merge/resources/accounting/resources/accounts/types/__init__.py

@@ -6,13 +6,17 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
+    from .accounts_list_request_classification import AccountsListRequestClassification
     from .accounts_list_request_remote_fields import AccountsListRequestRemoteFields
     from .accounts_list_request_show_enum_origins import AccountsListRequestShowEnumOrigins
+    from .accounts_list_request_status import AccountsListRequestStatus
     from .accounts_retrieve_request_remote_fields import AccountsRetrieveRequestRemoteFields
     from .accounts_retrieve_request_show_enum_origins import AccountsRetrieveRequestShowEnumOrigins
 _dynamic_imports: typing.Dict[str, str] = {
+    "AccountsListRequestClassification": ".accounts_list_request_classification",
     "AccountsListRequestRemoteFields": ".accounts_list_request_remote_fields",
     "AccountsListRequestShowEnumOrigins": ".accounts_list_request_show_enum_origins",
+    "AccountsListRequestStatus": ".accounts_list_request_status",
     "AccountsRetrieveRequestRemoteFields": ".accounts_retrieve_request_remote_fields",
     "AccountsRetrieveRequestShowEnumOrigins": ".accounts_retrieve_request_show_enum_origins",
 }
@@ -38,8 +42,10 @@ def __dir__():
 
 
 __all__ = [
+    "AccountsListRequestClassification",
     "AccountsListRequestRemoteFields",
     "AccountsListRequestShowEnumOrigins",
+    "AccountsListRequestStatus",
     "AccountsRetrieveRequestRemoteFields",
     "AccountsRetrieveRequestShowEnumOrigins",
 ]

merge/resources/accounting/resources/accounts/types/accounts_list_request_classification.py

@@ -0,0 +1,37 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class AccountsListRequestClassification(str, enum.Enum):
+    EMPTY = ""
+    ASSET = "ASSET"
+    EQUITY = "EQUITY"
+    EXPENSE = "EXPENSE"
+    LIABILITY = "LIABILITY"
+    REVENUE = "REVENUE"
+
+    def visit(
+        self,
+        empty: typing.Callable[[], T_Result],
+        asset: typing.Callable[[], T_Result],
+        equity: typing.Callable[[], T_Result],
+        expense: typing.Callable[[], T_Result],
+        liability: typing.Callable[[], T_Result],
+        revenue: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is AccountsListRequestClassification.EMPTY:
+            return empty()
+        if self is AccountsListRequestClassification.ASSET:
+            return asset()
+        if self is AccountsListRequestClassification.EQUITY:
+            return equity()
+        if self is AccountsListRequestClassification.EXPENSE:
+            return expense()
+        if self is AccountsListRequestClassification.LIABILITY:
+            return liability()
+        if self is AccountsListRequestClassification.REVENUE:
+            return revenue()

merge/resources/accounting/resources/accounts/types/accounts_list_request_status.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import enum
+import typing
+
+T_Result = typing.TypeVar("T_Result")
+
+
+class AccountsListRequestStatus(str, enum.Enum):
+    EMPTY = ""
+    ACTIVE = "ACTIVE"
+    INACTIVE = "INACTIVE"
+    PENDING = "PENDING"
+
+    def visit(
+        self,
+        empty: typing.Callable[[], T_Result],
+        active: typing.Callable[[], T_Result],
+        inactive: typing.Callable[[], T_Result],
+        pending: typing.Callable[[], T_Result],
+    ) -> T_Result:
+        if self is AccountsListRequestStatus.EMPTY:
+            return empty()
+        if self is AccountsListRequestStatus.ACTIVE:
+            return active()
+        if self is AccountsListRequestStatus.INACTIVE:
+            return inactive()
+        if self is AccountsListRequestStatus.PENDING:
+            return pending()

merge/resources/accounting/resources/addresses/client.py

@@ -70,6 +70,8 @@ class AddressesClient:
         )
         client.accounting.addresses.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -150,6 +152,8 @@ class AsyncAddressesClient:
         async def main() -> None:
             await client.accounting.addresses.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/attachments/client.py

@@ -95,6 +95,8 @@ class AttachmentsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -102,7 +104,25 @@ class AttachmentsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.attachments.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(
@@ -160,6 +180,8 @@ class AttachmentsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.attachments.create(
+            is_debug_mode=True,
+            run_async=True,
             model=AccountingAttachmentRequest(),
         )
         """
@@ -207,6 +229,8 @@ class AttachmentsClient:
         )
         client.accounting.attachments.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -325,6 +349,7 @@ class AsyncAttachmentsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -336,7 +361,25 @@ class AsyncAttachmentsClient:
 
         async def main() -> None:
             await client.accounting.attachments.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",
             )
 
 
@@ -402,6 +445,8 @@ class AsyncAttachmentsClient:
 
         async def main() -> None:
             await client.accounting.attachments.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=AccountingAttachmentRequest(),
             )
 
@@ -457,6 +502,8 @@ class AsyncAttachmentsClient:
         async def main() -> None:
             await client.accounting.attachments.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/audit_trail/client.py

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

merge/resources/accounting/resources/balance_sheets/client.py

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

merge/resources/accounting/resources/bank_feed_accounts/client.py

@@ -78,6 +78,10 @@ class BankFeedAccountsClient:
         )
         client.accounting.bank_feed_accounts.list(
             cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            page_size=1,
         )
         """
         _response = self._raw_client.list(
@@ -129,6 +133,8 @@ class BankFeedAccountsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.bank_feed_accounts.create(
+            is_debug_mode=True,
+            run_async=True,
             model=BankFeedAccountRequest(),
         )
         """
@@ -176,6 +182,8 @@ class BankFeedAccountsClient:
         )
         client.accounting.bank_feed_accounts.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -282,6 +290,10 @@ class AsyncBankFeedAccountsClient:
         async def main() -> None:
             await client.accounting.bank_feed_accounts.list(
                 cursor="cD0yMDIxLTAxLTA2KzAzJTNBMjQlM0E1My40MzQzMjYlMkIwMCUzQTAw",
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                page_size=1,
             )
 
 
@@ -341,6 +353,8 @@ class AsyncBankFeedAccountsClient:
 
         async def main() -> None:
             await client.accounting.bank_feed_accounts.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=BankFeedAccountRequest(),
             )
 
@@ -396,6 +410,8 @@ class AsyncBankFeedAccountsClient:
         async def main() -> None:
             await client.accounting.bank_feed_accounts.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/bank_feed_transactions/client.py

@@ -99,6 +99,8 @@ class BankFeedTransactionsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
 
         client = Merge(
@@ -106,7 +108,25 @@ class BankFeedTransactionsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.bank_feed_transactions.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,
+            is_processed=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(
@@ -165,6 +185,8 @@ class BankFeedTransactionsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.bank_feed_transactions.create(
+            is_debug_mode=True,
+            run_async=True,
             model=BankFeedTransactionRequestRequest(),
         )
         """
@@ -216,6 +238,8 @@ class BankFeedTransactionsClient:
         )
         client.accounting.bank_feed_transactions.retrieve(
             id="id",
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -339,6 +363,7 @@ class AsyncBankFeedTransactionsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
 
@@ -350,7 +375,25 @@ class AsyncBankFeedTransactionsClient:
 
         async def main() -> None:
             await client.accounting.bank_feed_transactions.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,
+                is_processed=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",
             )
 
 
@@ -417,6 +460,8 @@ class AsyncBankFeedTransactionsClient:
 
         async def main() -> None:
             await client.accounting.bank_feed_transactions.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=BankFeedTransactionRequestRequest(),
             )
 
@@ -476,6 +521,8 @@ class AsyncBankFeedTransactionsClient:
         async def main() -> None:
             await client.accounting.bank_feed_transactions.retrieve(
                 id="id",
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/cash_flow_statements/client.py

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