Releases: merge-api/merge-python-client
v3.0.1
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
v3.0.0
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.
v3.0.0a1
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).
v2.6.4
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).
v2.6.3
Merge Python SDK Release Notes - Version [2.6.3]
Improvements
- Chat: Added
ONE_ON_ONE_CHAT,GROUP_CHAT, andMEETING_CHATconversation types to TypeEnum
v2.6.2
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
v2.6.1
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
v2.6.0
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
v2.5.0
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
v2.4.0
Merge Python SDK Release Notes - Version [2.4.0]
- Knowledge Base category now included in the SDK!