Release 5.1.0

Author: lvukadinovic-ib

CHANGELOG.md

@@ -5,6 +5,84 @@ All notable changes to the library will be documented in this file.
 The format of the file is based on [Keep a Changelog](http://keepachangelog.com/)
 and this library adheres to [Semantic Versioning](http://semver.org/) as mentioned in [README.md][readme] file.
 
+## [ [5.1.0](https://github.com/infobip/infobip-api-python-client/releases/tag/5.1.0) ] - 2025-03-20
+
+⚠️ **IMPORTANT NOTE:** This release contains breaking changes.
+All changes, including breaking changes, are addressed and explained in the list bellow.
+If you find out that something was not addressed properly, please submit an issue.
+
+### Added
+* Most recent feature set for:
+    * [Infobip Voice API](https://www.infobip.com/docs/api/channels/voice).
+        * Support for Calls Configuration.
+    * [Infobip SMS API](https://www.infobip.com/docs/api/channels/sms).
+    * [Infobip 2FA API](https://www.infobip.com/docs/api/platform/2fa).
+    * [Infobip Email API](https://www.infobip.com/docs/api/channels/email).
+        * Support for Email IP Management instead of set of deprecated Email IP endpoints. Check [Email API documentation](https://www.infobip.com/docs/api/channels/email) for additional details.
+    * [Infobip Moments](https://www.infobip.com/docs/api/customer-engagement/moments).
+* **Added** support for `WEBSOCKET` option in call routing endpoint.
+* **Added** new Calls error code type: `MACHINE_DETECTED`.
+* **Added** support for `CallsProviderSipTrunkUpdateRequest`.
+
+### Changed
+
+- General
+  - **Unified** `message_response`, `message_response_details`, `message_group_error`, `sending_speed_limit`, `security_config_type`, `api_exception` and `speed_limit_time_unit`.
+
+- Voice API
+  - **Updated** `calls_update_scenario_response.last_usage_date` field type from `datetime` → `date`.
+  - **Updated** `calls_search_response.last_usage_date` field type from `datetime` → `date`.
+  - **Removed** `priority` and `weight` duplicated fields from `call_routing_endpoint_destination`.
+  - **Removed** `priority` and `weight` duplicated fields from `call_routing_url_destination`.
+  - Adjusted Sip Trunk models in location processing. Location is now implemented as a string to increase usability of the feature. Locations should be passed as strings to the Sip Trunk request model in all upcoming SDK versions.
+      - **Updated** `call_sip_trunk_response.location` field type from `Optional[CallsSipTrunkLocation]` → `Optional[StrictStr]`.
+  - **Updated** `calls_transcription.language` field type from `CallsLanguage` → `CallTranscriptionLanguage`.
+  - **Updated** `calls_speech_capture_request.language` field type from `CallsLanguage` → `CallTranscriptionLanguage`.
+  - **Removed** `calls_voice` – Certain fields removed due to API updates.
+  - **Fixed** Number Masking UTC date-time deserialization in setup response model.
+  - **Fixed** Number Masking content schema when uploading audio files.
+  - Adjusted IVR models in script processing. Scenario scripting is now implemented as a raw string to increase usability of the feature. Scripts should be passed as strings to the IVR request model in all upcoming SDK versions.
+        - **Updated** `calls_update_scenario_response.script` field type from `Optional[Dict[str, Any]]` → `Optional[StrictStr]`.
+        - **Updated** `calls_update_scenario_request.script` field type from `List[CallsScriptInner]` → `StrictStr`.
+        - **Updated** `calls_search_response.script` and `else` fields type from `Optional[Dict[str, Any]]` → `Optional[StrictStr]`.
+  - **Updated** `calls_get_voices_response.voices` field type from `Optional[List[CallsVoice]]` → `Optional[List[CallsSynthesisVoice]]`.
+  - **Removed** `call_routing_url_security_config_type` – Unified into `security_config_type` enumeration class.
+  - **Removed** `call_url_security_config_type` – Unified into `security_config_type` enumeration class.
+
+- Email API
+  - **Updated** `email_supression_info.created_date` field type from `StrictStr` → `datetime`.
+  - **Removed** `email_single_message_status` – Now integrated into the unified `MessageStatus` class.
+  - Email suppression type enum models are now consolidated. Use `email_suppression_type` and `email_add_suppression_type` instead of `email_add_delete_suppression_type` and `email_get_suppression_type`.
+
+### Removed:
+- All the Calls IVR script related class and from now on all the scripts are processed as `String`:
+  - `calls_call_api`
+  - `calls_capture`
+  - `calls_collect`
+  - `calls_dial`
+  - `calls_dial_to_many`
+  - `calls_dial_to_webrtc`
+  - `calls_dial_to_conversations`
+  - `calls_for_each`
+  - `calls_go_to`
+  - `calls_hangup`
+  - `calls_if_then_else`
+  - `calls_machine_detection`
+  - `calls_pause`
+  - `calls_play`
+  - `calls_play_from_recording`
+  - `calls_record`
+  - `calls_repeat_until`
+  - `calls_repeat_while`
+  - `calls_say`
+  - `calls_send_sms`
+  - `calls_set_variable`
+  - `calls_switch_case`
+  - `calls_while_do`
+- **Removed** `DISCONNECTED` option from `call_state`.
+
+These changes align the SDK with the current API specification, ensuring consistency and reliability in future updates.
+
 ## [ [5.0.0](https://github.com/infobip/infobip-api-python-client/releases/tag/5.0.0) ] - 2024-12-23
 
 🎉 **NEW Major Version of `infobip-api-python-client`.**
@@ -103,4 +181,4 @@ In this release, we updated and modernized the `infobip_api_client` library. It
 - Support for [Infobip SMS Tracking API](https://www.infobip.com/docs/sms/tracking) methods (to be included back in one of the next releases)
 - `examples` directory
 
-[readme]: README.mustache
+[readme]: README.mustache

CONTRIBUTING.md

@@ -80,7 +80,7 @@ Afterward, you can use pip to build the project locally:
 pip install .
 ```
 
-Install the required test packages and run the tests that are in repository, all test should pass.
+Install the required test packages and run the tests that are in repository, all tests should pass.
 
 ```bash
 pip install -r test-requirements.txt

README.md

@@ -1,5 +1,3 @@
-from infobip_api_client import SmsMessageContent
-
 # Infobip API Python Client
 
 <img src="https://cdn-web.infobip.com/uploads/2023/01/Infobip-logo.svg" height="93px" alt="Infobip" />
@@ -15,7 +13,7 @@ We use [OpenAPI Generator](https://openapi-generator.tech/) to generate the pack
 
 
 #### Table of contents:
-* [API documentation](#documentation)
+* [API documentation](#api-documentation)
 * [General Info](#general-info)
 * [Installation](#installation)
 * [Quickstart](#quickstart)
@@ -75,7 +73,7 @@ Now you are ready use the API.
 Here's a basic example of sending the SMS message.
 
 ```python
-    from infobip_api_client.models import SmsAdvancedTextualRequest, SmsTextualMessage, SmsDestination, SmsResponse
+    from infobip_api_client.models import SmsRequest, SmsMessage, SmsMessageContent, SmsTextContent, SmsDestination, SmsResponse
     from infobip_api_client.api.sms_api import SmsApi
 
     sms_request = SmsRequest(
@@ -128,7 +126,7 @@ Bulk ID will be received only when you send a message to more than one destinati
 ```
 
 #### Receive sent SMS report
-For each SMS that you send out, we can send you a message delivery report in real time. All you need to do is specify your endpoint when sending SMS in `notify_url` field of `SmsTextualMessage`, or subscribe for reports by contacting our support team.
+All you need to do is specify your endpoint when sending SMS in the `webhooks.delivery.url` field of your request, or subscribe for reports by contacting our support team at [email protected].
 e.g. `https://{yourDomain}/delivery-reports`
 
 Example of webhook implementation using Flask:
@@ -145,7 +143,7 @@ Example of webhook implementation using Flask:
         for result in delivery_results.results:
             print("message {0} sent at {1}".format(result.message_id, result.sent_at))
 ```
-If you prefer to use your own serializer, please pay attention to the supported [date format](https://www.infobip.com/docs/essentials/integration-best-practices#date-formats).
+If you prefer to use your own serializer, please pay attention to the supported [date format](https://www.infobip.com/docs/essentials/api-essentials/integration-best-practices#date-formats-backward-compatibility).
 
 #### Fetching delivery reports
 If you are for any reason unable to receive real time delivery reports on your endpoint, you can use `message_id` or `bulk_id` to fetch them.
@@ -194,7 +192,7 @@ Example of webhook implementation using Flask:
 For 2FA quick start guide please check [these examples](two-factor-authentication.md).
 
 #### Calls
-For Calls quick start guide please check [these_examples](calls.md)
+For Calls quick start guide please check [these examples](calls.md)
 
 ## Ask for help