v2.0.0

Merge Python SDK Release Notes - Version [2.0.0]

This release includes support for all of the latest updates to the Merge API. For more information, see https://www.merge.dev/changelog

Breaking Changes

• AccessLevelEnum was renamed
  Usages of AccessLevelEnum need to be updated to TicketAccessLevelEnum in code as well as when importing

---

v1.2.1

This change impacts only the Accounting Category.

• Added category_type and status query params on the /tracking-categories endpoint
• Added status query param on the /accounts endpoint
• Added status query param on the /contacts endpoint

v1.2.0

This release affects all categories.

• (feat): Requests for file download will now allow users to pass in a chunk_size option that allows them to receive chunks of a specific size from the resultant iter_bytes invocation on the response byte stream.
• (fix): Update shared http_client.py to remove omitted entries during file upload requests.
• (fix): pyproject.toml now has a [project] block making it Poetry v2 compatible.
• (feat): Set the default number of retries to 2 (was 0) to align with the generated README.
• (fix): Fix an issue where GeneratorExit was unintentionally being swallowed by code blocks within the HttpClient.stream() contextmanager.
• (fix): Fix an issue where parameter names that conflict with the request_options parameter are now properly deconflicted by prepending an underscore to the request_options parameter name.
• (fix): Fix an issue where the default timeout was not being respected when a custom httpx_client was provided.
• (feat): Add support for raw bytes responses.
• (feat): Add support for user-agent header
• (fix): Always represent nullable as Optional rather than NotRequired, only use NotRequired for optional in typeddicts.
• (fix): Fix an issue where TypedDicts with circular references were not correctly serialized. This issue only affected users that enabled use_typeddict_requests.

v1.1.4

This release impacts all categories.

• Updated descriptions and code snippets
• Add query parameters for multiple Common Model endpoints
• async POST request support
• [accounting] add GeneralLedgerTransactions
• [accounting] add BankFeeds and BankFeedTransactions
• updated RemoteData and RemoteFields objects to allow for better handling

v1.1.3

Note this change impacts all categories.

• Resolving issue with v1.1.2
• Github issue: #102

v1.1.2

Note this release is limited to a single model across all categories.

• Fix the Async Passthrough POST return object typing to allow for a string return when polling for passthrough task completion
• update dependency packages to latest compatible versions.

v1.1.1

Note: this release impacts ALL categories

• Sync the SDKs with the latest updates to the Merge API.
  • New common models, query parameters, and fields
  • isShellData query parameter
  • TaxRate added to InvoiceLineItems
  • Add MergeLink localization language parameter to linkToken generation function
• [CRM + Ticketing] Improved typing on the RemoteFields object value field to avoid breakage when returning variable types.
• Improvements to developer experience
• update code snippets in line
• better comments for easier use of the interfaces

v1.1.0

Note: This release impacts all categories

• Improvement: The root client users interact with is now exported from the main __init__.py, this allows users to access the client via from my_sdk import my_sdk_client as opposed to from my_sdk.client import my_sdk_client.
• Generated SDKs now use ruff for linting and formatting instead of Black.
• Introduce Pythonic naming for discriminated union members through union_naming configuration flag.
• Allow specifying pip extras within your pyproject.toml.
• Parameters of file upload functions now default to OMIT, not None, so that the SDK appropriately filters out unset parameters, while still allowing for user specified None values.
• Generated README and code snippet improvements

v1.0.13

Note: This change impacts all categories.

• Sync the SDKs with the latest updates to the Merge API.
  • New common models, query parameters, and fields
• [CRM + Ticketing] Improved typing on the RemoteFields object value field to avoid breakage when returning variable types.
• Improvements to developer experience

v1.0.12

Note: This release only impacts the ACCOUNTING category.

• Fix issue with Merge OpenAPI spec (API definition) where the tracking_categories field on submodels was marked as Required.