|
| 1 | +# Changelog |
| 2 | + |
| 3 | +All notable changes to the **Sinch Python SDK** are documented in this file. |
| 4 | + |
| 5 | +> **Tag legend** |
| 6 | +> - `[feature]` — new capability |
| 7 | +> - `[fix]` — bug fix |
| 8 | +> - `[deprecation notice]` — will be removed in a future release |
| 9 | +> - `[dependency]` — third-party library update |
| 10 | +> - `[doc]` — documentation only |
| 11 | +> - `[test]` — test coverage |
| 12 | +> - `[refactor]` — internal restructuring |
| 13 | +> - `[releasing]` — release infrastructure |
| 14 | +> - `[design]` — API design change |
| 15 | +> - `[tech]` — technical improvement |
| 16 | +
|
| 17 | +--- |
| 18 | + |
| 19 | +## v2.0.0 – 2026-03-31 |
| 20 | + |
| 21 | +### Breaking Changes |
| 22 | + |
| 23 | +- see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md#200) |
| 24 | + |
| 25 | +### SDK |
| 26 | + |
| 27 | +- **[design]** Requires explicit `sms_region` and `conversation_region` on `SinchClient` before using SMS and Conversation APIs (no silent US/EU defaults); runtime failure if unset (#49, #110). |
| 28 | +- **[design]** The v1 asynchronous client and httpx-based async stack were removed; only synchronous `SinchClient` is supported (#55). |
| 29 | +- **[feature]** Automatic pagination via a shared `Paginator` pattern for paged list APIs (#46, #54). |
| 30 | +- **[doc]** README and configuration tests clarify which credentials apply to each API (#48). |
| 31 | + |
| 32 | +### Conversation |
| 33 | + |
| 34 | +- **[feature]** Messages API refresh: convenience send methods (`send_text_message()`, `send_card_message()`, `send_carousel_message()`, `send_choice_message()`, `send_contact_info_message()`, `send_list_message()`, `send_location_message()`, `send_media_message()`, `send_template_message()`), `list()` as a paginator, `update()`, `event_destination_target` (wires `callback_url`), and a `sinch_client.conversation.sinch_events(...)` helper for inbound event handling (#109–#120). |
| 35 | +- **[feature]** Conversation Sinch Events (webhooks) support (#122, #131, #132, #133). |
| 36 | +- **[design]** Conversation webhook REST client removed; handle inbound traffic via Sinch Events (see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md)) (#131, #132, #133). |
| 37 | + |
| 38 | +### Numbers |
| 39 | + |
| 40 | +- **[feature]** Flatter API (`rent`, `list`, `event_destinations`, and related entry points), `event_destination_target`, and a Numbers Sinch Events helper (#44, #53, #57, #58, #59, #62). |
| 41 | +- **[feature]** Available Regions endpoint (#56). |
| 42 | +- **[feature]** Webhook helper validates the signing secret in `validate_signature_header()` (#61). |
| 43 | +- **[tech]** Numbers Events payloads are passed through without client-side pre-processing (#63). |
| 44 | + |
| 45 | +### Number Lookup |
| 46 | + |
| 47 | +- **[feature]** Number Lookup v1 (lookup API, models, snippets, and E2E coverage) (#99, #101, #104). |
| 48 | + |
| 49 | +### SMS |
| 50 | + |
| 51 | +- **[design]** SMS client configuration and authentication paths refactored for project vs service-plan credentials, including delivery-report flows (#90). |
| 52 | +- **[feature]** SMS delivery reports models and pagination (#87). `groups` and `inbounds` are planned for a future release (see migration guide). |
| 53 | +- **[feature]** SMS Sinch Events (webhooks) support (#103). |
| 54 | +- **[doc]** SMS migration guide and Sinch events quickstart material (#107, #108). |
| 55 | + |
| 56 | +### Verification |
| 57 | + |
| 58 | +- **[design]** Verification V1 APIs are removed (#124). V2 Verification support is planned in a future release (see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md)). |
| 59 | + |
| 60 | +### Voice |
| 61 | + |
| 62 | +- **[design]** Voice V1 APIs are removed (#124). V2 Voice support is planned in a future release (see [MIGRATION_GUIDE.md](MIGRATION_GUIDE.md)). |
| 63 | + |
| 64 | +### Others |
| 65 | + |
| 66 | +- **[dependency]** Pydantic v2 (`pydantic = ">=2.0.0"`). |
| 67 | +- **[releasing]** Ruff linter adoption (#84) and CI workflow updates (#121). |
| 68 | +- **[doc]** Snippets and Getting Started live under `examples/` (#95, #98, #105, #106, #115, #118, #125, #127). |
| 69 | +- **[doc]** Docstring updates across Numbers, SMS, and Conversation (#64, #65, #67, #96, #97). |
| 70 | +- **[refactor]** Model, type, and class renames (#60, #70, #82). |
| 71 | +- **[tech]** Conversation, Numbers, and SMS models and endpoints resynchronized with OpenAPI specification (#68, #75, #123, #128, #129, #134, #135). |
| 72 | +- **[test]** E2E test infrastructure and refactoring (#45, #66, #102); SMS batches test coverage (#91, #93, #94). |
| 73 | + |
| 74 | +--- |
| 75 | + |
| 76 | +## v1.1.4 – 2025-10-23 |
| 77 | + |
| 78 | +### SDK |
| 79 | + |
| 80 | +- **[feature]** Python 3.13 and 3.14 support (#86, #89). |
| 81 | +- **[releasing]** CI updates (#86, #89). |
| 82 | + |
| 83 | +--- |
| 84 | + |
| 85 | +## v1.1.3 – 2025-09-11 |
| 86 | + |
| 87 | +### Voice |
| 88 | + |
| 89 | +- **[fix]** DTMF conference fix (#79). |
| 90 | + |
| 91 | +--- |
| 92 | + |
| 93 | +## v1.1.2 – 2025-06-18 |
| 94 | + |
| 95 | +### Test |
| 96 | + |
| 97 | +- **[test]** End-to-end tests disabled. |
| 98 | +- **[test]** Tests and CI improvements (#41, #42, #43, #74). |
| 99 | + |
| 100 | +### SDK |
| 101 | + |
| 102 | +- **[fix]** Async authentication fixes (#41, #42, #43, #74). |
| 103 | + |
| 104 | +### Chore |
| 105 | + |
| 106 | +- **[doc]** README link updates. |
| 107 | +- **[releasing]** CI and release-related updates. |
| 108 | + |
| 109 | +--- |
| 110 | + |
| 111 | +## v1.1.1 – 2024-12-19 |
| 112 | + |
| 113 | +### SDK |
| 114 | + |
| 115 | +- **[fix]** Remove aiohttp leftovers (#40). |
| 116 | + |
| 117 | +--- |
| 118 | + |
| 119 | +## v1.1.0 – 2024-12-19 |
| 120 | + |
| 121 | +### Chore |
| 122 | + |
| 123 | +- **[releasing]** CI strategy updates (#34, #36, #29, #17). |
| 124 | + |
| 125 | +### Verification |
| 126 | + |
| 127 | +- **[feature]** Backwards-compatible Verification API update. |
| 128 | + |
| 129 | +### SDK |
| 130 | + |
| 131 | +- **[feature]** PyPI publishing and httpx/async HTTP stack. |
| 132 | + |
| 133 | +### SMS |
| 134 | + |
| 135 | +- **[feature]** SMS service plan API. |
| 136 | + |
| 137 | +--- |
| 138 | + |
| 139 | +## v1.0.0 – 2024-05-20 |
| 140 | + |
| 141 | +### SDK |
| 142 | + |
| 143 | +- **[feature]** Verification API (#26, #27, #28). |
| 144 | +- **[feature]** Voice API (#26, #27, #28). |
| 145 | + |
| 146 | +### Chore |
| 147 | + |
| 148 | +- **[doc]** General availability README updates (#26, #27, #28). |
0 commit comments