Skip to content

Commit a04615b

Browse files
authored
Updated documentation (#49)
* Updated CHANGELOG.md and README.md
1 parent 822eb08 commit a04615b

File tree

2 files changed

+10
-6
lines changed

2 files changed

+10
-6
lines changed

CHANGELOG.md

Lines changed: 9 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -16,24 +16,29 @@ If you find out that something was not addressed properly, please submit an issu
1616
### Added
1717
* Most recent feature set for:
1818
* [Infobip SMS API](https://www.infobip.com/docs/api/channels/sms)
19+
* Introduced `/sms/3/messages (V3)` replacing the `/sms/2/text/advanced (V2)` and `/sms/2/binary/advanced (V2)` endpoints.
20+
* Introduced `/sms/3/reports (V3)` replacing `/sms/1/reports (V1)` endpoint.
21+
* Introduced `/sms/3/logs (V3)` replacing `/sms/1/logs (V1)` endpoint.
1922
* [Infobip Email API](https://www.infobip.com/docs/api/channels/email)
2023
* [Infobip Voice API](https://www.infobip.com/docs/api/channels/voice)
2124

2225
### Changed
2326
* **Fixes and changes**
27+
* Introduced the new [SmsMessage](src/main/java/com/infobip/model/SmsMessage.java) class to replace `SmsTextualMessage` and `SmsBinaryMessage`, providing a unified structure for SMS messaging.
28+
* Added a content field within `SmsMessage` to define the message content. This supports both textual and binary messages, which can be created using [SmsTextContent](src/main/java/com/infobip/model/SmsTextContent.java) or [SmsBinaryContent](src/main/java/com/infobip/model/SmsBinaryContent.java), respectively.
29+
* Unified request classes by replacing `SmsAdvancedTextualRequest` and `SmsAdvancedBinaryRequest` with the new [SmsRequest](src/main/java/com/infobip/model/SmsRequest.java) class.
30+
* Consolidated sending functions: use `sendSmsMessages` instead of the `sendSmsMessage` and `sendBinarySmsMessage` functions.
2431
* Changed 'sentAt', 'doneAt' field type in [MmsReport](src/main/java/com/infobip/model/MmsReport.java) from String to OffsetDateTime since it didn't correspond to the state of the endpoint.
2532
* Across all voice models, the 'applicationId' field has been removed and replaced with the 'platform' field, as it better reflects the state of the endpoint.
26-
27-
* **Removed classes and unified structures**
2833
* Removed delivery time window configuration classes (`SmsDeliveryTimeWindow`, `MmsDeliveryTimeWindow`, `ViberDeliveryTimeWindow`, `CallRoutingAllowedTimeWindow`, `CallsDeliveryTimeWindow`, `SmsDeliveryTimeWindow`, `CallsTimeWindow`) in favor of a unified class: [DeliveryTimeWindow](src/main/java/com/infobip/model/DeliveryTimeWindow.java)
2934
* Removed delivery time configuration classes (`SmsDeliveryTimeFrom`, `SmsDeliveryTimeTo`, `MmsDeliveryTime`, `ViberDeliveryTime`, `CallsTimeWindowPoint`, `WebRtcTimeOfDay`, `CallRoutingAllowedTimeFrom`, `CallRoutingAllowedTimeTo`, `WebRtcTimeOfDay`) in favor of a unified class: [DeliveryTime](src/main/java/com/infobip/model/DeliveryTime.java)
3035
* Removed URL options configuration classes (`MessagesApiUrlOptions`, `ViberUrlOptions`, `WhatsAppUrlOptions`) in favor of a unified class: [UrlOptions](src/main/java/com/infobip/model/UrlOptions.java)
3136
* Removed platform configuration class (`ViberPlatform`, `MessagesApiPlatform`) in favor of a unified class: [Platform](src/main/java/com/infobip/model/Platform.java)
3237
* Removed TurkeyIys options configuration classes (`MessagesApiTurkeyIysOptions`, `ViberTurkeyIysOptions`, `SmsTurkeyIysOptions`) in favor of a unified class: [TurkeyIysOptions](src/main/java/com/infobip/model/TurkeyIysOptions.java)
3338
* Removed delivery day enumeration classes (`SmsDeliveryDay`, `MmsDeliveryDay`, `CallsDeliveryDay`, `CallRoutingAllowedDay`) in favor of a unified class: [DeliveryDay](src/main/java/com/infobip/model/DeliveryDay.java)
3439
* Removed recipient type enumeration classes (`SmsIysRecipientType`, `ViberRecipientType`, `MessagesApiRecipientType`) in favor of a unified class: [IysRecipientType](src/main/java/com/infobip/model/IysRecipientType.java)
35-
* Removed validity period configuration classes (`ViberValidityPeriod`, `MessagesApiValidityPeriod`) in favor of a unified class: [IysRecipientType](src/main/java/com/infobip/model/IysRecipientType.java)
36-
* Removed validity period time unit enumeration classes (`ViberValidityPeriodTimeUnit`, `MessagesApiValidityPeriodTimeUnit`) in favor of a unified class: [IysRecipientType](src/main/java/com/infobip/model/IysRecipientType.java)
40+
* Removed validity period configuration classes (`ViberValidityPeriod`, `MessagesApiValidityPeriod`) in favor of a unified class: [ValidityPeriod](src/main/java/com/infobip/model/ValidityPeriod.java)
41+
* Removed validity period time unit enumeration classes (`ViberValidityPeriodTimeUnit`, `MessagesApiValidityPeriodTimeUnit`) in favor of a unified class: [ValidityPeriodTimeUnit](src/main/java/com/infobip/model/ValidityPeriodTimeUnit.java)
3742

3843
## [ [4.4.0](https://github.com/infobip/infobip-api-java-client/releases/tag/4.4.0) ] - 2024-11-19
3944

README.md

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -135,8 +135,7 @@ Bulk ID is received only when you send a message to more than one destination ad
135135
```
136136

137137
#### Receive sent SMS report
138-
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 the `notifyUrl` field within `SmsTextualMessage`, or subscribe for reports by contacting our support team at [email protected].
139-
e.g. `https://{yourDomain}/delivery-reports`
138+
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].
140139

141140
You can use data models from the library and the pre-configured `com.infobip.JSON` serializer.
142141

0 commit comments

Comments
 (0)