mergepythonclient 1.0.4__py3-none-any.whl → 1.0.6__py3-none-any.whl

merge/client.py

@@ -22,13 +22,14 @@ class Merge:
         environment: MergeEnvironment = MergeEnvironment.PRODUCTION,
         account_token: typing.Optional[str] = None,
         api_key: typing.Union[str, typing.Callable[[], str]],
-        timeout: typing.Optional[float] = 60
+        timeout: typing.Optional[float] = 60,
+        httpx_client: typing.Optional[httpx.Client] = None
     ):
         self._client_wrapper = SyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
             account_token=account_token,
             api_key=api_key,
-            httpx_client=httpx.Client(timeout=timeout),
+            httpx_client=httpx.Client(timeout=timeout) if httpx_client is None else httpx_client,
         )
         self.ats = AtsClient(client_wrapper=self._client_wrapper)
         self.crm = CrmClient(client_wrapper=self._client_wrapper)
@@ -46,13 +47,14 @@ class AsyncMerge:
         environment: MergeEnvironment = MergeEnvironment.PRODUCTION,
         account_token: typing.Optional[str] = None,
         api_key: typing.Union[str, typing.Callable[[], str]],
-        timeout: typing.Optional[float] = 60
+        timeout: typing.Optional[float] = 60,
+        httpx_client: typing.Optional[httpx.AsyncClient] = None
     ):
         self._client_wrapper = AsyncClientWrapper(
             base_url=_get_base_url(base_url=base_url, environment=environment),
             account_token=account_token,
             api_key=api_key,
-            httpx_client=httpx.AsyncClient(timeout=timeout),
+            httpx_client=httpx.AsyncClient(timeout=timeout) if httpx_client is None else httpx_client,
         )
         self.ats = AsyncAtsClient(client_wrapper=self._client_wrapper)
         self.crm = AsyncCrmClient(client_wrapper=self._client_wrapper)

merge/core/__init__.py

@@ -5,11 +5,13 @@ from .client_wrapper import AsyncClientWrapper, BaseClientWrapper, SyncClientWra
 from .datetime_utils import serialize_datetime
 from .jsonable_encoder import jsonable_encoder
 from .remove_none_from_dict import remove_none_from_dict
+from .request_options import RequestOptions
 
 __all__ = [
     "ApiError",
     "AsyncClientWrapper",
     "BaseClientWrapper",
+    "RequestOptions",
     "SyncClientWrapper",
     "jsonable_encoder",
     "remove_none_from_dict",

merge/core/client_wrapper.py

@@ -21,7 +21,7 @@ class BaseClientWrapper:
         headers: typing.Dict[str, str] = {
             "X-Fern-Language": "Python",
             "X-Fern-SDK-Name": "MergePythonClient",
-            "X-Fern-SDK-Version": "1.0.4",
+            "X-Fern-SDK-Version": "1.0.6",
         }
         if self._account_token is not None:
             headers["X-Account-Token"] = self._account_token

merge/core/request_options.py

@@ -0,0 +1,29 @@
+# This file was auto-generated by Fern from our API Definition.
+
+import typing
+
+try:
+    from typing import NotRequired  # type: ignore
+except ImportError:
+    from typing_extensions import NotRequired  # type: ignore
+
+
+class RequestOptions(typing.TypedDict):
+    """
+    Additional options for request-specific configuration when calling APIs via the SDK.
+    This is used primarily as an optional final parameter for service functions.
+
+    Attributes:
+        - timeout_in_seconds: int. The number of seconds to await an API call before timing out.
+
+        - additional_headers: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's header dict
+
+        - additional_query_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's query parameters dict
+
+        - additional_body_parameters: typing.Dict[str, typing.Any]. A dictionary containing additional parameters to spread into the request's body parameters dict
+    """
+
+    timeout_in_seconds: NotRequired[int]
+    additional_headers: NotRequired[typing.Dict[str, typing.Any]]
+    additional_query_parameters: NotRequired[typing.Dict[str, typing.Any]]
+    additional_body_parameters: NotRequired[typing.Dict[str, typing.Any]]

merge/resources/accounting/__init__.py

@@ -25,10 +25,6 @@ from .types import (
     AccountingPeriodStatusEnum,
     AccountingPhoneNumber,
     AccountingPhoneNumberRequest,
-    AccountsListRequestRemoteFields,
-    AccountsListRequestShowEnumOrigins,
-    AccountsRetrieveRequestRemoteFields,
-    AccountsRetrieveRequestShowEnumOrigins,
     Address,
     AddressCountry,
     AddressRequest,
@@ -54,8 +50,6 @@ from .types import (
     CommonModelScopesBodyRequest,
     CompanyInfo,
     CompanyInfoCurrency,
-    CompanyInfoListRequestExpand,
-    CompanyInfoRetrieveRequestExpand,
     ConditionSchema,
     ConditionSchemaConditionType,
     ConditionTypeEnum,
@@ -66,8 +60,6 @@ from .types import (
     ContactRequestStatus,
     ContactResponse,
     ContactStatus,
-    ContactsListRequestExpand,
-    ContactsRetrieveRequestExpand,
     CountryEnum,
     CreditNote,
     CreditNoteAccountingPeriod,
@@ -82,12 +74,6 @@ from .types import (
     CreditNoteStatus,
     CreditNoteStatusEnum,
     CreditNoteTrackingCategoriesItem,
-    CreditNotesListRequestExpand,
-    CreditNotesListRequestRemoteFields,
-    CreditNotesListRequestShowEnumOrigins,
-    CreditNotesRetrieveRequestExpand,
-    CreditNotesRetrieveRequestRemoteFields,
-    CreditNotesRetrieveRequestShowEnumOrigins,
     CurrencyEnum,
     DataPassthroughRequest,
     DebugModeLog,
@@ -125,8 +111,6 @@ from .types import (
     ExpenseRequestTrackingCategoriesItem,
     ExpenseResponse,
     ExpenseTrackingCategoriesItem,
-    ExpensesListRequestExpand,
-    ExpensesRetrieveRequestExpand,
     IncomeStatement,
     IncomeStatementCompany,
     IncomeStatementCurrency,
@@ -165,22 +149,14 @@ from .types import (
     InvoiceTrackingCategoriesItem,
     InvoiceType,
     InvoiceTypeEnum,
-    InvoicesListRequestExpand,
-    InvoicesListRequestType,
-    InvoicesRetrieveRequestExpand,
     Issue,
     IssueStatus,
     IssueStatusEnum,
-    IssuesListRequestStatus,
     Item,
     ItemCompany,
     ItemPurchaseAccount,
     ItemSalesAccount,
     ItemStatus,
-    ItemsListRequestExpand,
-    ItemsRetrieveRequestExpand,
-    JournalEntriesListRequestExpand,
-    JournalEntriesRetrieveRequestExpand,
     JournalEntry,
     JournalEntryAccountingPeriod,
     JournalEntryAppliedPaymentsItem,
@@ -212,7 +188,6 @@ from .types import (
     LinkedAccountSelectiveSyncConfiguration,
     LinkedAccountSelectiveSyncConfigurationRequest,
     LinkedAccountStatus,
-    LinkedAccountsListRequestCategory,
     MetaResponse,
     MethodEnum,
     ModelOperation,
@@ -262,8 +237,6 @@ from .types import (
     PaymentRequestTrackingCategoriesItem,
     PaymentResponse,
     PaymentTrackingCategoriesItem,
-    PaymentsListRequestExpand,
-    PaymentsRetrieveRequestExpand,
     PostingStatusEnum,
     PurchaseOrder,
     PurchaseOrderAccountingPeriod,
@@ -288,8 +261,6 @@ from .types import (
     PurchaseOrderStatusEnum,
     PurchaseOrderTrackingCategoriesItem,
     PurchaseOrderVendor,
-    PurchaseOrdersListRequestExpand,
-    PurchaseOrdersRetrieveRequestExpand,
     RemoteData,
     RemoteKey,
     RemoteResponse,
@@ -316,8 +287,6 @@ from .types import (
     TransactionLineItemCurrency,
     TransactionLineItemItem,
     TransactionTrackingCategoriesItem,
-    TransactionsListRequestExpand,
-    TransactionsRetrieveRequestExpand,
     ValidationProblemSource,
     VendorCredit,
     VendorCreditAccountingPeriod,
@@ -327,12 +296,43 @@ from .types import (
     VendorCreditLineAccount,
     VendorCreditTrackingCategoriesItem,
     VendorCreditVendor,
-    VendorCreditsListRequestExpand,
-    VendorCreditsRetrieveRequestExpand,
     WarningValidationProblem,
     WebhookReceiver,
 )
 from .resources import (
+    AccountsListRequestRemoteFields,
+    AccountsListRequestShowEnumOrigins,
+    AccountsRetrieveRequestRemoteFields,
+    AccountsRetrieveRequestShowEnumOrigins,
+    CompanyInfoListRequestExpand,
+    CompanyInfoRetrieveRequestExpand,
+    ContactsListRequestExpand,
+    ContactsRetrieveRequestExpand,
+    CreditNotesListRequestExpand,
+    CreditNotesListRequestRemoteFields,
+    CreditNotesListRequestShowEnumOrigins,
+    CreditNotesRetrieveRequestExpand,
+    CreditNotesRetrieveRequestRemoteFields,
+    CreditNotesRetrieveRequestShowEnumOrigins,
+    ExpensesListRequestExpand,
+    ExpensesRetrieveRequestExpand,
+    InvoicesListRequestExpand,
+    InvoicesListRequestType,
+    InvoicesRetrieveRequestExpand,
+    IssuesListRequestStatus,
+    ItemsListRequestExpand,
+    ItemsRetrieveRequestExpand,
+    JournalEntriesListRequestExpand,
+    JournalEntriesRetrieveRequestExpand,
+    LinkedAccountsListRequestCategory,
+    PaymentsListRequestExpand,
+    PaymentsRetrieveRequestExpand,
+    PurchaseOrdersListRequestExpand,
+    PurchaseOrdersRetrieveRequestExpand,
+    TransactionsListRequestExpand,
+    TransactionsRetrieveRequestExpand,
+    VendorCreditsListRequestExpand,
+    VendorCreditsRetrieveRequestExpand,
     account_details,
     account_token,
     accounting_periods,

merge/resources/accounting/resources/__init__.py

@@ -39,8 +39,67 @@ from . import (
     vendor_credits,
     webhook_receivers,
 )
+from .accounts import (
+    AccountsListRequestRemoteFields,
+    AccountsListRequestShowEnumOrigins,
+    AccountsRetrieveRequestRemoteFields,
+    AccountsRetrieveRequestShowEnumOrigins,
+)
+from .company_info import CompanyInfoListRequestExpand, CompanyInfoRetrieveRequestExpand
+from .contacts import ContactsListRequestExpand, ContactsRetrieveRequestExpand
+from .credit_notes import (
+    CreditNotesListRequestExpand,
+    CreditNotesListRequestRemoteFields,
+    CreditNotesListRequestShowEnumOrigins,
+    CreditNotesRetrieveRequestExpand,
+    CreditNotesRetrieveRequestRemoteFields,
+    CreditNotesRetrieveRequestShowEnumOrigins,
+)
+from .expenses import ExpensesListRequestExpand, ExpensesRetrieveRequestExpand
+from .invoices import InvoicesListRequestExpand, InvoicesListRequestType, InvoicesRetrieveRequestExpand
+from .issues import IssuesListRequestStatus
+from .items import ItemsListRequestExpand, ItemsRetrieveRequestExpand
+from .journal_entries import JournalEntriesListRequestExpand, JournalEntriesRetrieveRequestExpand
+from .linked_accounts import LinkedAccountsListRequestCategory
+from .payments import PaymentsListRequestExpand, PaymentsRetrieveRequestExpand
+from .purchase_orders import PurchaseOrdersListRequestExpand, PurchaseOrdersRetrieveRequestExpand
+from .transactions import TransactionsListRequestExpand, TransactionsRetrieveRequestExpand
+from .vendor_credits import VendorCreditsListRequestExpand, VendorCreditsRetrieveRequestExpand
 
 __all__ = [
+    "AccountsListRequestRemoteFields",
+    "AccountsListRequestShowEnumOrigins",
+    "AccountsRetrieveRequestRemoteFields",
+    "AccountsRetrieveRequestShowEnumOrigins",
+    "CompanyInfoListRequestExpand",
+    "CompanyInfoRetrieveRequestExpand",
+    "ContactsListRequestExpand",
+    "ContactsRetrieveRequestExpand",
+    "CreditNotesListRequestExpand",
+    "CreditNotesListRequestRemoteFields",
+    "CreditNotesListRequestShowEnumOrigins",
+    "CreditNotesRetrieveRequestExpand",
+    "CreditNotesRetrieveRequestRemoteFields",
+    "CreditNotesRetrieveRequestShowEnumOrigins",
+    "ExpensesListRequestExpand",
+    "ExpensesRetrieveRequestExpand",
+    "InvoicesListRequestExpand",
+    "InvoicesListRequestType",
+    "InvoicesRetrieveRequestExpand",
+    "IssuesListRequestStatus",
+    "ItemsListRequestExpand",
+    "ItemsRetrieveRequestExpand",
+    "JournalEntriesListRequestExpand",
+    "JournalEntriesRetrieveRequestExpand",
+    "LinkedAccountsListRequestCategory",
+    "PaymentsListRequestExpand",
+    "PaymentsRetrieveRequestExpand",
+    "PurchaseOrdersListRequestExpand",
+    "PurchaseOrdersRetrieveRequestExpand",
+    "TransactionsListRequestExpand",
+    "TransactionsRetrieveRequestExpand",
+    "VendorCreditsListRequestExpand",
+    "VendorCreditsRetrieveRequestExpand",
     "account_details",
     "account_token",
     "accounting_periods",

merge/resources/accounting/resources/account_details/client.py

@@ -1,10 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import typing
 import urllib.parse
 from json.decoder import JSONDecodeError
 
 from .....core.api_error import ApiError
 from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.jsonable_encoder import jsonable_encoder
+from .....core.remove_none_from_dict import remove_none_from_dict
+from .....core.request_options import RequestOptions
 from ...types.account_details import AccountDetails
 
 try:
@@ -17,10 +21,12 @@ class AccountDetailsClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def retrieve(self) -> AccountDetails:
+    def retrieve(self, *, request_options: typing.Optional[RequestOptions] = None) -> AccountDetails:
         """
         Get details for a linked account.
 
+        Parameters:
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
         from merge.client import Merge
 
@@ -33,8 +39,20 @@ class AccountDetailsClient:
         _response = self._client_wrapper.httpx_client.request(
             "GET",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "api/accounting/v1/account-details"),
-            headers=self._client_wrapper.get_headers(),
-            timeout=60,
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else 60,
         )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(AccountDetails, _response.json())  # type: ignore
@@ -49,10 +67,12 @@ class AsyncAccountDetailsClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def retrieve(self) -> AccountDetails:
+    async def retrieve(self, *, request_options: typing.Optional[RequestOptions] = None) -> AccountDetails:
         """
         Get details for a linked account.
 
+        Parameters:
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
         ---
         from merge.client import AsyncMerge
 
@@ -65,8 +85,20 @@ class AsyncAccountDetailsClient:
         _response = await self._client_wrapper.httpx_client.request(
             "GET",
             urllib.parse.urljoin(f"{self._client_wrapper.get_base_url()}/", "api/accounting/v1/account-details"),
-            headers=self._client_wrapper.get_headers(),
-            timeout=60,
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else 60,
         )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(AccountDetails, _response.json())  # type: ignore

merge/resources/accounting/resources/account_token/client.py

@@ -1,10 +1,14 @@
 # This file was auto-generated by Fern from our API Definition.
 
+import typing
 import urllib.parse
 from json.decoder import JSONDecodeError
 
 from .....core.api_error import ApiError
 from .....core.client_wrapper import AsyncClientWrapper, SyncClientWrapper
+from .....core.jsonable_encoder import jsonable_encoder
+from .....core.remove_none_from_dict import remove_none_from_dict
+from .....core.request_options import RequestOptions
 from ...types.account_token import AccountToken
 
 try:
@@ -17,20 +21,44 @@ class AccountTokenClient:
     def __init__(self, *, client_wrapper: SyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    def retrieve(self, public_token: str) -> AccountToken:
+    def retrieve(self, public_token: str, *, request_options: typing.Optional[RequestOptions] = None) -> AccountToken:
         """
         Returns the account token for the end user with the provided public token.
 
         Parameters:
             - public_token: str.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from merge.client import Merge
+
+        client = Merge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+        client.accounting.account_token.retrieve(
+            public_token="string",
+        )
         """
         _response = self._client_wrapper.httpx_client.request(
             "GET",
             urllib.parse.urljoin(
                 f"{self._client_wrapper.get_base_url()}/", f"api/accounting/v1/account-token/{public_token}"
             ),
-            headers=self._client_wrapper.get_headers(),
-            timeout=60,
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else 60,
         )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(AccountToken, _response.json())  # type: ignore
@@ -45,20 +73,46 @@ class AsyncAccountTokenClient:
     def __init__(self, *, client_wrapper: AsyncClientWrapper):
         self._client_wrapper = client_wrapper
 
-    async def retrieve(self, public_token: str) -> AccountToken:
+    async def retrieve(
+        self, public_token: str, *, request_options: typing.Optional[RequestOptions] = None
+    ) -> AccountToken:
         """
         Returns the account token for the end user with the provided public token.
 
         Parameters:
             - public_token: str.
+
+            - request_options: typing.Optional[RequestOptions]. Request-specific configuration.
+        ---
+        from merge.client import AsyncMerge
+
+        client = AsyncMerge(
+            account_token="YOUR_ACCOUNT_TOKEN",
+            api_key="YOUR_API_KEY",
+        )
+        await client.accounting.account_token.retrieve(
+            public_token="string",
+        )
         """
         _response = await self._client_wrapper.httpx_client.request(
             "GET",
             urllib.parse.urljoin(
                 f"{self._client_wrapper.get_base_url()}/", f"api/accounting/v1/account-token/{public_token}"
             ),
-            headers=self._client_wrapper.get_headers(),
-            timeout=60,
+            params=jsonable_encoder(
+                request_options.get("additional_query_parameters") if request_options is not None else None
+            ),
+            headers=jsonable_encoder(
+                remove_none_from_dict(
+                    {
+                        **self._client_wrapper.get_headers(),
+                        **(request_options.get("additional_headers", {}) if request_options is not None else {}),
+                    }
+                )
+            ),
+            timeout=request_options.get("timeout_in_seconds")
+            if request_options is not None and request_options.get("timeout_in_seconds") is not None
+            else 60,
         )
         if 200 <= _response.status_code < 300:
             return pydantic.parse_obj_as(AccountToken, _response.json())  # type: ignore