Merge Python SDK Release Notes - Version [3.1.0]

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

Merge Python SDK Release Notes - Version [3.1.0a1]

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

Merge Python SDK Release Notes - Version [3.0.1]

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

Merge Python SDK Release Notes - Version [3.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

Expand Parameter Type Changes:

Expand parameters changed from large string union enums to individual enum items that accept a single value or a list. Old pre-combined enum values (e.g. TicketsListRequestExpand.ACCOUNT_ASSIGNEES_CREATOR) have been
removed.

  # v2.x — single combined enum value
  client.ticketing.tickets.list(
      expand=TicketsListRequestExpand.ACCOUNT_ASSIGNEES_CREATOR,
  )

  # v3.x — single item or list of individual items
  from merge.resources.ticketing.resources.tickets import TicketsListRequestExpandItem

  client.ticketing.tickets.list(
      expand=[
          TicketsListRequestExpandItem.ACCOUNT,
          TicketsListRequestExpandItem.ASSIGNEES,
          TicketsListRequestExpandItem.CREATOR,
      ],
  )

  # Single expand still works
  client.ticketing.tickets.list(expand=TicketsListRequestExpandItem.ACCOUNT)

  # Passing a string is unchanged
  client.ticketing.tickets.list(expand="account,assignees,creator")

Affected types: all *ListRequestExpand and *RetrieveRequestExpand types have been replaced with *ListRequestExpandItem and *RetrieveRequestExpandItem equivalents across Accounting, ATS, Chat, CRM, File Storage,
HRIS, Knowledge Base, and Ticketing modules. The API request format (?expand=a,b,c) is unchanged — only the Python input shape changed.

ats.candidates.ignore_create Signature Change:

The reason and message keyword arguments were collapsed into a single request body model.

  # v2.x
  client.ats.candidates.ignore_create(
      model_id,
      reason=IgnoreCommonModelRequestReason.GENERAL_CUSTOMER_REQUEST,
      message="Customer requested ignore",
  )

  # v3.x
  from merge.resources.ats import IgnoreCommonModelRequest, IgnoreCommonModelRequestReason

  client.ats.candidates.ignore_create(
      model_id,
      request=IgnoreCommonModelRequest(
          reason=IgnoreCommonModelRequestReason.GENERAL_CUSTOMER_REQUEST,
          message="Customer requested ignore",
      ),
  )
  

IgnoreCommonModelRequestReason also moved from merge.resources.ats.resources.candidates to merge.resources.ats. The top-level category import works in both 2.x and 3.x; only the deep resource-scoped import path was
removed.

Merge Python SDK Release Notes - Version [3.0.0a1]

Breaking Changes

The per-resource *RequestExpand enums (which baked in every relation combination, e.g. TicketsListRequestExpand.ASSIGNEES_ACCOUNT_CREATOR) have been replaced by *RequestExpandItem enums of single values. Pass a list of items
for multiple relations, or a string for direct control. Wire-level request to Merge is unchanged.

# Before
from merge.resources.ticketing.resources.tickets import TicketsListRequestExpand

client.ticketing.tickets.list(expand=TicketsListRequestExpand.ACCOUNT)
client.ticketing.tickets.list(expand=TicketsListRequestExpand.ASSIGNEES_ACCOUNT_CREATOR)

# After
from merge.resources.ticketing.resources.tickets import TicketsListRequestExpandItem

client.ticketing.tickets.list(expand=TicketsListRequestExpandItem.ACCOUNT)
client.ticketing.tickets.list(expand=[
    TicketsListRequestExpandItem.ASSIGNEES,
    TicketsListRequestExpandItem.ACCOUNT,
    TicketsListRequestExpandItem.CREATOR,
])

# Strings continue to work unchanged
client.ticketing.tickets.list(expand="account")
client.ticketing.tickets.list(expand="account,assignees,creator")

Same pattern applies in every category (accounting, ats, crm, hris, filestorage, knowledgebase, chat, ticketing).

Merge Python SDK Release Notes - Version [2.6.4]

Improvements

• Chat: Added visible_history_start_datetime to the Member model, exposing the earliest message a member can access in a conversation (null indicates full history).

Merge Python SDK Release Notes - Version [2.6.3]

Improvements

• Chat: Added ONE_ON_ONE_CHAT, GROUP_CHAT, and MEETING_CHAT conversation types to TypeEnum

Merge Python SDK Release Notes - Version [2.6.2]

Improvements

• Accounting: Added quantity and unit_price fields to ExpenseLine and ExpenseLineRequest models
• File Storage: Added size field to Drive model

Merge Python SDK Release Notes - Version [2.6.1]

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

Merge Python SDK Release Notes - Version [2.6.0]

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

Merge Python SDK Release Notes - Version [2.5.0]

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

Merge Python SDK Release Notes - Version [2.4.0]

• Knowledge Base category now included in the SDK!

Merge Python SDK Release Notes - Version [2.3.2]

Improvements

• Adds the following fields to ticketing collection collection_url, remote_created_at and remote_updated_at
• Adds a name query param to ticketing collection
• Adds a email_address query param to ticketing contact
• Add a name query param to ticketing ticket
• Add employee_id and employee_number to hris employee and dependent

Merge Python SDK Release Notes - Version [2.3.1]

Improvements

• This release addresses an issue with passthrough when using the Async client AsyncMerge where calls to the passthrough client were failing with the following error name 'resources_ticketing_resources_passthrough_client_AsyncPassthroughClient' is not defined.

Merge Python SDK Release Notes - Version [2.3.0]

Improvements

• This release adds lazy loading of imports to greatly reduce the memory footprint of the SDK. Note the first usage of a client will have additional latency.

Merge Python SDK Release Notes - Version [2.2.0]

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

Merge Python SDK Release Notes - Version [2.1.1]

Changes

• Update nested object return type
  Dictionaries of objects, or lists of strings and objects will now be typed with the object. For example for the following code snippet:

import merge
from merge.client import Merge

merge_client = merge.Merge(api_key=api_key, account_token=account_token)
response = merge_client.filestorage.files.list(page_size=1)
assert response.results
file = response.results[0]
permission = file.permissions[0]

• The type of permission will be <class 'merge.resources.filestorage.types.permission.Permission'> instead of <class 'dict'>

Merge Python SDK Release Notes - Version [2.1.0]

Changes

• Reduce memory footprint of the SDK
  Should resolve issues with memory consumption of the Merge Python SDK. When this version is picked up, users should see drastic improvements, with memory footprint of imports down to 100MB.

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

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

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.

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

Note this change impacts all categories.

• Resolving issue with v1.1.2
• Github issue: https://github.com/merge-api/merge-python-client/issues/102

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.

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

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

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

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.

Note - this release impacts all categories. There is no change to the underlying AP; only limited to the SDK usage.

• Addressing the bug in https://github.com/merge-api/merge-python-client/issues/90 where the OpenAPI spec is not matching the SDK due to a misconfiguration of the Pydantic configs. All models should go back to matching the API in this release.

Note: This release impacts all categories. No changes to the underlying API, only includes changes to SDK usage.

• Pydantic introduced a "break" to their 1.x libs by adding in a .v1 submodule that does not mirror the one that comes with pydantic v2. To get around this we now force the usage of the v1 submodule only if the pydantic version is v2.
• Many minor upgrades to code and code snippet quality.

Note that changes in this release impact all categories!

• Addition of coverage field on the RemoteFieldAPI object
• Addition of integration_specific_config field on the EndUserDetailsRequest object
• Updated field and model descriptions

CRM

• Fix bug in the CRMAccountRequest object where the Address object field was missing.

Ticketing

• Add new endpoints POST Contact and POST Contact Meta

Note: The changes in this release impact all categories.

• We sync the SDK with the latest improvements to the Merge API
  • [Accounting] PATCH Invoices added
  • [Accounting] PATCH Payments added
  • [ATS] GET Job Postings added
  • [FILE] added mime_type as a query parameter on File
  • Better inline examples and model examples

Note: The changes in this release impact all categories.

• We sync the SDK with the latest improvements to the Merge API
  • Addition of the Field Mappings API
  • Addition of the Scopes manipulation API (both Organization-wide and Linked Account-wide)
  • Replacing the old is_in_beta field on the AccountIntegration model with the new and more accurate category_beta_status field.
  • [HRIS] Addition of the ended_after, ended_before, started_after, and started_before query parameters on the /time-off endpoint
  • [File Storage] We fix typing on the PermissionRequest model
  • Better inline examples

Note: This change adds improvements to all categories.

• We fix some reported enum serialization issues regarding sending the enum directly rather than the value of the enum itself.

• Add support for a RequestOptions object for each generated function within Python SDKs. This parameter is an optional final parameter that allows for configuring timeout, as well as pass in arbitrary data through to the request. RequestOptions is a TypedDict, with optional fields, so there's no need to instantiate an object, just pass in the relevent keys within a dict!

  • timeout_in_seconds overrides the timeout for this specific request
  • additional_body_parameters are expanded into the JSON request body
  • additional_query_parameters are expanded into the JSON query parameters map
  • additional_headers are expanded into the request's header map

• Remove support for Python 3.7. In order to support newer versions of libraries we depend on (such as typing and typing-extensions), we must move on to Python 3.8. With this change we are also able to:

  • Remove the backports dependency, as cached_property is now included within functools
  • Remove the upper bound dependency on Pydantic which had dropped support for Python 3.7
  • Note: Python 3.7 had reached end of life so we strongly encourage users to upgrade to >= 3.8. https://www.python.org/downloads/release/python-370/

Note: This release should have no impacts on SDK usage.

• Add support for bug fixes to generated Python code snippets
• General developer quality of life fixes to code.

Note: this release impacts the Accounting, ATS, CRM, and Ticketing categories

• For these categories, we fix the typing of the RemoteData object, specifically the data field. The typing is updated from being a list of the RemoteData object to a list of any types.

Note: This change is to roll back a bug in the SDK generator. There should be no impact on usage of the SDK or the models/fields available otherwise.

• Fix incorrect API endpoint paths bug in the Python generator

Note: this release impacts the Accounting, CRM, File Storage, and Ticketing categories

• In the Accounting category, we add the purchase_orders field to the InvoiceRequest object along with updating some field descriptions.
• In the CRM category, we add a query parameter on the accounts endpoint, multiple query parameters on the engagements endpoint, and the owner field to the Contact object.
• In the File Storage category, we add a query parameter to the file download endpoint.
• In the Ticketing category, we add a query parameter on the attachment download endpoint, and a new /roles endpoint along with its associated objects.

Note: this release only impacts the Accounting category

• For the Accounting category, we fix two enums that were mishandled in the initial implementation. currency on the ExpenseLineRequest model and status on the Invoice object.

Note: this release only impacts the Accounting category

• For the Accounting category, we update the Payment Line item. This impacts all Payment Line item submodels as well.

Note: We update the version to v1.0.0 for semantic purposes. This SDK has been out of Beta since a much earlier version.

This release makes no changes to our existing SDKs!

We update the generator to allow us to internally generate code snippets for better documentation on the docs.merge.dev website. This change is different from v0.2.9 in that it fixes a few issues with the code generation code as well as adds snippets inline as well.

This release makes no changes to our existing SDKs!

• We update the generator to allow us to internally generate code snippets for better documentation on the docs.merge.dev website.

This change only impacts the Accounting category

• We modify the typing of the Accounting Contact model's Address field to accept not only strings but object types as well so that expanding Accounting Contact works in our SDK.

Note this release should have no impact on existing usage of the Merge Python SDK.

• Support for Pydantic v2 while maintaining compatibility with Pydantic v1.

Note: Changes only impact CRM, Accounting, and HRIS categories

Changes

• In the CRM category, we've added support for new query parameters
• we've also added bug fix support for the Address and Phone Number submodels that were missing on the CRMAccount model.
• In the HRIS category, we've added support for new query parameters
• We've also added support for the preferred_name field on the Employee object.
• In the Accounting category, we've added support for new query parameters
• We've also added support for multiple new fields on our models and a CreditNoteApplyLine submodel line item

Note: Changes only impact FileStorage category

Changes

• We update the FileStorage SDK to include new query parameters offered in the Merge FileStorage API
• Additional support for the Permissions sub-object on File and Folder models
• New enums used in the Permissions object supported for expands.

Note: Changes only impact CRM and Ticketing

Changes

• in v0.1.3, we fix GET requests for RemoteFields. However, POSTs were still mistyped creating a bug that would not allow successful POST of RemoteFields. This is now fixed in the latest version.
• RemoteFields only exist for CRM and Ticketing categories

Note: Changes only impact CRM and Ticketing

Changes

• Typing was mishandled previously for RemoteField endpoint return objects. We update the schema to support the correct object shape.
• RemoteFields only exist for CRM and Ticketing categories

Categories Specific Changes

All Categories

• supported expands for sub-object GETs
• Async Passthrough endpoint exposed
• renamed delete Linked Account function from delete_account.create() to delete_account.delete()

Accounting

• Added tracking_categories field to Invoice Common Model with expands support
• Fix bug with listing BalanceSheet, CashFlowStatement, and IncomeStatement Common Models

HRIS

• Added Dependents Common Model with list() and retrieve() endpoints
• Added Employer Benefits Common Model with list() and retrieve() endpoints
• Deprecated benefit_plan_type field on the Benefits Common Model
• Added employer_benefit` field on Benefits Common Model

Ticketing

• Added remote_created_after query parameter on Attachment Common Model
• Added remote_created_after query parameter on Comments Common Model

Language Specific Changes

• Python datetimes now expect type datetime, rather than type string

• This release supports updating the compatibility of the httpx dependency to be >=0.23.3

• File Storage category now included in the SDK!
• Include additional Fern-specific forwarding headers such as X-Fern-SDK-Version

• BREAKING
• Accounting, CRM, and Ticketing categories use the wrong URL prior to this release. We resolve this issue. There should be no change to ATS and HRIS categories.
• Additional .fernignore file additions

• Fix pypi auth for deploy to remote package manager.
• Remove the need to include auth prefix when setting up Client (no need to include "Bearer" at the beginning of the api_key)
• Additional repo configuration changes (included reviewers file, additional fernignore entries, etc.)

Initial Fern SDK Release

• Includes swapover from Stainless SDK
• 5 released categories included (Accounting, ATS, CRM, HRIS, Ticketing)
• See README for additional details on implementation of the new SDK