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

merge/resources/accounting/resources/company_info/client.py

@@ -91,14 +91,37 @@ class CompanyInfoClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.company_info import (
+            CompanyInfoListRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.company_info.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=CompanyInfoListRequestExpand.ADDRESSES,
+            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(
@@ -153,6 +176,9 @@ class CompanyInfoClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.company_info import (
+            CompanyInfoRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -160,6 +186,9 @@ class CompanyInfoClient:
         )
         client.accounting.company_info.retrieve(
             id="id",
+            expand=CompanyInfoRetrieveRequestExpand.ADDRESSES,
+            include_remote_data=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -252,8 +281,12 @@ class AsyncCompanyInfoClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.company_info import (
+            CompanyInfoListRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -263,7 +296,25 @@ class AsyncCompanyInfoClient:
 
         async def main() -> None:
             await client.accounting.company_info.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=CompanyInfoListRequestExpand.ADDRESSES,
+                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",
             )
 
 
@@ -323,6 +374,9 @@ class AsyncCompanyInfoClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.company_info import (
+            CompanyInfoRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -333,6 +387,9 @@ class AsyncCompanyInfoClient:
         async def main() -> None:
             await client.accounting.company_info.retrieve(
                 id="id",
+                expand=CompanyInfoRetrieveRequestExpand.ADDRESSES,
+                include_remote_data=True,
+                include_shell_data=True,
             )
 
 

merge/resources/accounting/resources/contacts/__init__.py

@@ -6,9 +6,10 @@ import typing
 from importlib import import_module
 
 if typing.TYPE_CHECKING:
-    from .types import ContactsListRequestExpand, ContactsRetrieveRequestExpand
+    from .types import ContactsListRequestExpand, ContactsListRequestStatus, ContactsRetrieveRequestExpand
 _dynamic_imports: typing.Dict[str, str] = {
     "ContactsListRequestExpand": ".types",
+    "ContactsListRequestStatus": ".types",
     "ContactsRetrieveRequestExpand": ".types",
 }
 
@@ -32,4 +33,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["ContactsListRequestExpand", "ContactsRetrieveRequestExpand"]
+__all__ = ["ContactsListRequestExpand", "ContactsListRequestStatus", "ContactsRetrieveRequestExpand"]

merge/resources/accounting/resources/contacts/client.py

@@ -14,6 +14,7 @@ from ...types.paginated_remote_field_class_list import PaginatedRemoteFieldClass
 from ...types.patched_contact_request import PatchedContactRequest
 from .raw_client import AsyncRawContactsClient, RawContactsClient
 from .types.contacts_list_request_expand import ContactsListRequestExpand
+from .types.contacts_list_request_status import ContactsListRequestStatus
 from .types.contacts_retrieve_request_expand import ContactsRetrieveRequestExpand
 
 # this is used as the default value for optional parameters
@@ -57,7 +58,7 @@ class ContactsClient:
         remote_fields: typing.Optional[typing.Literal["status"]] = None,
         remote_id: typing.Optional[str] = None,
         show_enum_origins: typing.Optional[typing.Literal["status"]] = None,
-        status: typing.Optional[str] = None,
+        status: typing.Optional[ContactsListRequestStatus] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedContactList:
         """
@@ -122,7 +123,7 @@ class ContactsClient:
         show_enum_origins : typing.Optional[typing.Literal["status"]]
             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[ContactsListRequestStatus]
             If provided, will only return Contacts that match this status.
 
         request_options : typing.Optional[RequestOptions]
@@ -135,14 +136,45 @@ class ContactsClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.contacts import (
+            ContactsListRequestExpand,
+            ContactsListRequestStatus,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.contacts.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",
+            email_address="email_address",
+            expand=ContactsListRequestExpand.ADDRESSES,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
+            is_customer="is_customer",
+            is_supplier="is_supplier",
+            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",
+            ),
+            name="name",
+            page_size=1,
+            remote_id="remote_id",
+            status=ContactsListRequestStatus.EMPTY,
         )
         """
         _response = self._raw_client.list(
@@ -209,6 +241,8 @@ class ContactsClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.contacts.create(
+            is_debug_mode=True,
+            run_async=True,
             model=ContactRequest(),
         )
         """
@@ -265,6 +299,9 @@ class ContactsClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.contacts import (
+            ContactsRetrieveRequestExpand,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -272,6 +309,10 @@ class ContactsClient:
         )
         client.accounting.contacts.retrieve(
             id="id",
+            expand=ContactsRetrieveRequestExpand.ADDRESSES,
+            include_remote_data=True,
+            include_remote_fields=True,
+            include_shell_data=True,
         )
         """
         _response = self._raw_client.retrieve(
@@ -329,6 +370,8 @@ class ContactsClient:
         )
         client.accounting.contacts.partial_update(
             id="id",
+            is_debug_mode=True,
+            run_async=True,
             model=PatchedContactRequest(),
         )
         """
@@ -451,6 +494,12 @@ class ContactsClient:
         )
         client.accounting.contacts.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(
@@ -503,7 +552,7 @@ class AsyncContactsClient:
         remote_fields: typing.Optional[typing.Literal["status"]] = None,
         remote_id: typing.Optional[str] = None,
         show_enum_origins: typing.Optional[typing.Literal["status"]] = None,
-        status: typing.Optional[str] = None,
+        status: typing.Optional[ContactsListRequestStatus] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> PaginatedContactList:
         """
@@ -568,7 +617,7 @@ class AsyncContactsClient:
         show_enum_origins : typing.Optional[typing.Literal["status"]]
             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[ContactsListRequestStatus]
             If provided, will only return Contacts that match this status.
 
         request_options : typing.Optional[RequestOptions]
@@ -582,8 +631,13 @@ class AsyncContactsClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.contacts import (
+            ContactsListRequestExpand,
+            ContactsListRequestStatus,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -593,7 +647,32 @@ class AsyncContactsClient:
 
         async def main() -> None:
             await client.accounting.contacts.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",
+                email_address="email_address",
+                expand=ContactsListRequestExpand.ADDRESSES,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
+                is_customer="is_customer",
+                is_supplier="is_supplier",
+                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",
+                ),
+                name="name",
+                page_size=1,
+                remote_id="remote_id",
+                status=ContactsListRequestStatus.EMPTY,
             )
 
 
@@ -668,6 +747,8 @@ class AsyncContactsClient:
 
         async def main() -> None:
             await client.accounting.contacts.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=ContactRequest(),
             )
 
@@ -729,6 +810,9 @@ class AsyncContactsClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.contacts import (
+            ContactsRetrieveRequestExpand,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -739,6 +823,10 @@ class AsyncContactsClient:
         async def main() -> None:
             await client.accounting.contacts.retrieve(
                 id="id",
+                expand=ContactsRetrieveRequestExpand.ADDRESSES,
+                include_remote_data=True,
+                include_remote_fields=True,
+                include_shell_data=True,
             )
 
 
@@ -804,6 +892,8 @@ class AsyncContactsClient:
         async def main() -> None:
             await client.accounting.contacts.partial_update(
                 id="id",
+                is_debug_mode=True,
+                run_async=True,
                 model=PatchedContactRequest(),
             )
 
@@ -952,6 +1042,12 @@ class AsyncContactsClient:
         async def main() -> None:
             await client.accounting.contacts.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/contacts/raw_client.py

@@ -19,6 +19,7 @@ from ...types.paginated_contact_list import PaginatedContactList
 from ...types.paginated_remote_field_class_list import PaginatedRemoteFieldClassList
 from ...types.patched_contact_request import PatchedContactRequest
 from .types.contacts_list_request_expand import ContactsListRequestExpand
+from .types.contacts_list_request_status import ContactsListRequestStatus
 from .types.contacts_retrieve_request_expand import ContactsRetrieveRequestExpand
 
 # this is used as the default value for optional parameters
@@ -51,7 +52,7 @@ class RawContactsClient:
         remote_fields: typing.Optional[typing.Literal["status"]] = None,
         remote_id: typing.Optional[str] = None,
         show_enum_origins: typing.Optional[typing.Literal["status"]] = None,
-        status: typing.Optional[str] = None,
+        status: typing.Optional[ContactsListRequestStatus] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> HttpResponse[PaginatedContactList]:
         """
@@ -116,7 +117,7 @@ class RawContactsClient:
         show_enum_origins : typing.Optional[typing.Literal["status"]]
             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[ContactsListRequestStatus]
             If provided, will only return Contacts that match this status.
 
         request_options : typing.Optional[RequestOptions]
@@ -541,7 +542,7 @@ class AsyncRawContactsClient:
         remote_fields: typing.Optional[typing.Literal["status"]] = None,
         remote_id: typing.Optional[str] = None,
         show_enum_origins: typing.Optional[typing.Literal["status"]] = None,
-        status: typing.Optional[str] = None,
+        status: typing.Optional[ContactsListRequestStatus] = None,
         request_options: typing.Optional[RequestOptions] = None,
     ) -> AsyncHttpResponse[PaginatedContactList]:
         """
@@ -606,7 +607,7 @@ class AsyncRawContactsClient:
         show_enum_origins : typing.Optional[typing.Literal["status"]]
             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[ContactsListRequestStatus]
             If provided, will only return Contacts that match this status.
 
         request_options : typing.Optional[RequestOptions]

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

@@ -7,9 +7,11 @@ from importlib import import_module
 
 if typing.TYPE_CHECKING:
     from .contacts_list_request_expand import ContactsListRequestExpand
+    from .contacts_list_request_status import ContactsListRequestStatus
     from .contacts_retrieve_request_expand import ContactsRetrieveRequestExpand
 _dynamic_imports: typing.Dict[str, str] = {
     "ContactsListRequestExpand": ".contacts_list_request_expand",
+    "ContactsListRequestStatus": ".contacts_list_request_status",
     "ContactsRetrieveRequestExpand": ".contacts_retrieve_request_expand",
 }
 
@@ -33,4 +35,4 @@ def __dir__():
     return sorted(lazy_attrs)
 
 
-__all__ = ["ContactsListRequestExpand", "ContactsRetrieveRequestExpand"]
+__all__ = ["ContactsListRequestExpand", "ContactsListRequestStatus", "ContactsRetrieveRequestExpand"]

merge/resources/accounting/resources/contacts/types/contacts_list_request_status.py

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

merge/resources/accounting/resources/credit_notes/client.py

@@ -121,14 +121,48 @@ class CreditNotesClient:
 
         Examples
         --------
+        import datetime
+
         from merge import Merge
+        from merge.resources.accounting.resources.credit_notes import (
+            CreditNotesListRequestExpand,
+            CreditNotesListRequestRemoteFields,
+            CreditNotesListRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
             api_key="YOUR_API_KEY",
         )
         client.accounting.credit_notes.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=CreditNotesListRequestExpand.ACCOUNTING_PERIOD,
+            include_deleted_data=True,
+            include_remote_data=True,
+            include_shell_data=True,
+            modified_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            modified_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            page_size=1,
+            remote_fields=CreditNotesListRequestRemoteFields.STATUS,
+            remote_id="remote_id",
+            show_enum_origins=CreditNotesListRequestShowEnumOrigins.STATUS,
+            transaction_date_after=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
+            transaction_date_before=datetime.datetime.fromisoformat(
+                "2024-01-15 09:30:00+00:00",
+            ),
         )
         """
         _response = self._raw_client.list(
@@ -191,6 +225,8 @@ class CreditNotesClient:
             api_key="YOUR_API_KEY",
         )
         client.accounting.credit_notes.create(
+            is_debug_mode=True,
+            run_async=True,
             model=CreditNoteRequest(),
         )
         """
@@ -243,6 +279,11 @@ class CreditNotesClient:
         Examples
         --------
         from merge import Merge
+        from merge.resources.accounting.resources.credit_notes import (
+            CreditNotesRetrieveRequestExpand,
+            CreditNotesRetrieveRequestRemoteFields,
+            CreditNotesRetrieveRequestShowEnumOrigins,
+        )
 
         client = Merge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -250,6 +291,11 @@ class CreditNotesClient:
         )
         client.accounting.credit_notes.retrieve(
             id="id",
+            expand=CreditNotesRetrieveRequestExpand.ACCOUNTING_PERIOD,
+            include_remote_data=True,
+            include_shell_data=True,
+            remote_fields=CreditNotesRetrieveRequestRemoteFields.STATUS,
+            show_enum_origins=CreditNotesRetrieveRequestShowEnumOrigins.STATUS,
         )
         """
         _response = self._raw_client.retrieve(
@@ -391,8 +437,14 @@ class AsyncCreditNotesClient:
         Examples
         --------
         import asyncio
+        import datetime
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.credit_notes import (
+            CreditNotesListRequestExpand,
+            CreditNotesListRequestRemoteFields,
+            CreditNotesListRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -402,7 +454,34 @@ class AsyncCreditNotesClient:
 
         async def main() -> None:
             await client.accounting.credit_notes.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=CreditNotesListRequestExpand.ACCOUNTING_PERIOD,
+                include_deleted_data=True,
+                include_remote_data=True,
+                include_shell_data=True,
+                modified_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                modified_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                page_size=1,
+                remote_fields=CreditNotesListRequestRemoteFields.STATUS,
+                remote_id="remote_id",
+                show_enum_origins=CreditNotesListRequestShowEnumOrigins.STATUS,
+                transaction_date_after=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
+                transaction_date_before=datetime.datetime.fromisoformat(
+                    "2024-01-15 09:30:00+00:00",
+                ),
             )
 
 
@@ -473,6 +552,8 @@ class AsyncCreditNotesClient:
 
         async def main() -> None:
             await client.accounting.credit_notes.create(
+                is_debug_mode=True,
+                run_async=True,
                 model=CreditNoteRequest(),
             )
 
@@ -530,6 +611,11 @@ class AsyncCreditNotesClient:
         import asyncio
 
         from merge import AsyncMerge
+        from merge.resources.accounting.resources.credit_notes import (
+            CreditNotesRetrieveRequestExpand,
+            CreditNotesRetrieveRequestRemoteFields,
+            CreditNotesRetrieveRequestShowEnumOrigins,
+        )
 
         client = AsyncMerge(
             account_token="YOUR_ACCOUNT_TOKEN",
@@ -540,6 +626,11 @@ class AsyncCreditNotesClient:
         async def main() -> None:
             await client.accounting.credit_notes.retrieve(
                 id="id",
+                expand=CreditNotesRetrieveRequestExpand.ACCOUNTING_PERIOD,
+                include_remote_data=True,
+                include_shell_data=True,
+                remote_fields=CreditNotesRetrieveRequestRemoteFields.STATUS,
+                show_enum_origins=CreditNotesRetrieveRequestShowEnumOrigins.STATUS,
             )