java 6.1.0 release

Author: ib-tjuhasz

CHANGELOG.md

@@ -5,6 +5,44 @@ 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.
 
+## [ [6.1.0](https://github.com/infobip/infobip-api-java-client/releases/tag/6.1.0) ] - 2025-04-07
+
+⚠️ **IMPORTANT NOTE:** This release contains compile time 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 Messages API](https://www.infobip.com/docs/api/platform/messages-api).
+  * [Infobip Voice API](https://www.infobip.com/docs/api/channels/voice).
+  * [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).
+  * [Infobip WhatsApp API](https://www.infobip.com/docs/api/channels/whatsapp).
+  * [Infobip Viber API](https://www.infobip.com/docs/api/channels/viber).
+  * [Infobip WebRTC API](https://www.infobip.com/docs/api/channels/webrtc-calls).
+  * [Infobip Moments](https://www.infobip.com/docs/api/customer-engagement/moments).
+  * [Infobip MMS API](https://www.infobip.com/docs/api/channels/mms).
+* **Added** new Viber Outbound Content type: `LIST`.
+* **Added** new MessagesApi message body types: `PRODUCT` and `MIXED`.
+* **Added** new WhatsAppInteractive payment status and payment details type: `UPI_INTENT`.
+* **Added** support for `WEBSOCKET` option in call routing endpoint.
+
+
+### Changed
+* [WhatsAppWebhookPaymentTransactionNotification](src/main/java/com/infobip/model/WhatsAppWebhookPaymentTransactionNotification.java) model, previously nested enum 'type' and 'status' are now extracted to a separate class.
+* [WhatsAppWebhookPaymentNotification](src/main/java/com/infobip/model/WhatsAppWebhookPaymentNotification.java) model, previously nested enum 'currency' is now extracted to a separate class.
+* **Updated** `WhatsAppTemplateCardContent.buttons` field type from `List<WhatsAppTemplateButtonContent>` → `List<WhatsAppCardAllowedTemplateButtonContent>`.
+* **Updated** `WhatsAppTemplatePublicApiRequest.structure` field type from `WhatAppTemplateStructureApiData` → `Object`.
+* **Updated** `CallsUpdateScenarioResponse.lastUsageDate` field type from `String` → `LocalDate`.
+* **Updated** `CallsSearchResponse.lastUsageDate` field type from `String` → `LocalDate`.
+* **Removed** `EmailWebhookTrackReport` and `EmailWebhookTrackResponse`  in favor of a unified class: `EmailWebhookTrackingPayload`.
+* **Updated** `FormsRequest.formType` field type from `FormType` → `String`.
+* Fixed Javadoc.
+
+### Removed
+* **Removed** deviceDetails and networkId fields `MessagesApiDeliveryResult`.
+
 ## [ [6.0.0](https://github.com/infobip/infobip-api-java-client/releases/tag/6.0.0) ] - 2025-02-17
 
 🎉 **NEW Major Version of `infobip-api-java-client`.**

CONTRIBUTING.md

@@ -38,10 +38,10 @@ please follow these guidelines to help us understand your proposal and evaluate
 * **Open a New Enhancement Issue** - if your suggestion is new, please open a new issue and prefix it with "ENHANCEMENT" or "SUGGESTION".
   Please try to title your issue as clearly as possible to summarize your enhancement idea.
 * **Provide a Detailed Description** - in your issue description, try to include as much of the following information:
-    * **Problem:** What problem does this enhancement solve? Why is this feature needed?
-    * **Proposed Solution:** Describe the enhancement or feature you’re suggesting. How should it work? Provide as much detail as possible.
-    * **Alternatives Considered:** Have you thought of other ways to solve the problem? If so, briefly explain why your proposed solution is better.
-    * **Additional Context:** Share any examples, mockups, screenshots, or links to similar implementations (if applicable).
+  * **Problem:** What problem does this enhancement solve? Why is this feature needed?
+  * **Proposed Solution:** Describe the enhancement or feature you’re suggesting. How should it work? Provide as much detail as possible.
+  * **Alternatives Considered:** Have you thought of other ways to solve the problem? If so, briefly explain why your proposed solution is better.
+  * **Additional Context:** Share any examples, mockups, screenshots, or links to similar implementations (if applicable).
 * **Stay Focused and Specific** - try to keep your enhancement idea focused on a single problem or feature. If you have multiple ideas, consider creating separate issues for each to make the discussion easier to follow.
 * **Be Open to Feedback** - we encourage healthy discussion about proposed enhancements. Be open to feedback, as maintainers and other contributors may have questions or alternative suggestions.
 * **Contribute the Enhancement** - if you want implement your suggestion or if you're interested in working on the other people's enhancements yourself, please check the [Pull request](#%EF%B8%8F-pull-request) section on how to do that.

README.md

@@ -27,7 +27,7 @@ The current version of this library includes this subset of Infobip products:
 * [SMS](https://www.infobip.com/docs/api/channels/sms)
 * [MMS](https://www.infobip.com/docs/api/channels/mms)
 * [Voice](https://www.infobip.com/docs/api/channels/voice)
-* [WebRTC](https://www.infobip.com/docs/api/channels/webrtc)
+* [WebRTC](https://www.infobip.com/docs/api/channels/webrtc-calls/webrtc)
 * [Email](https://www.infobip.com/docs/api/channels/email)
 * [WhatsApp](https://www.infobip.com/docs/api/channels/whatsapp)
 * [Viber](https://www.infobip.com/docs/api/channels/viber)
@@ -47,9 +47,9 @@ The library requires Java 11 and is compatible up to and including Java 19.
 Simply add the following in your project's POM file under `dependencies` tag:
 ```xml
 <dependency>
-    <groupId>com.infobip</groupId>
-    <artifactId>infobip-api-java-client</artifactId>
-    <version>6.0.0</version>
+      <groupId>com.infobip</groupId>
+      <artifactId>infobip-api-java-client</artifactId>
+      <version>6.1.0</version>
 </dependency>
 ```
 
@@ -91,7 +91,7 @@ See below, a simple example of sending a single SMS message to a single recipien
         .sender("InfoSMS")
         .addDestinationsItem(new SmsDestination().to("41793026727"))
         .content(new SmsTextContent().text("Hello World from infobip-api-java-client!"));
-    
+
     SmsRequest smsMessageRequest = new SmsRequest()
         .messages(List.of(message));
 ```
@@ -146,22 +146,24 @@ Example of webhook implementation with Spring Web framework:
     @PostMapping("/delivery-reports")
     public void receiveDeliveryReports(HttpServletRequest request) throws IOException {
         SmsDeliveryResult reports = new JSON().deserialize(request.getInputStream(), SmsDeliveryResult.class);
+
         for (SmsDeliveryReport report : reports.getResults()) {
             System.out.println(report.getMessageId() + " - " + report.getStatus().getName());
         }
     }
 ```
-If you prefer to use your own serializer, make note of the supported [date format](https://www.infobip.com/docs/essentials/integration-best-practices#date-formats).
+If you prefer to use your own serializer, make note of the supported [date format](https://www.infobip.com/docs/essentials/api-essentials/integration-best-practices#date-formats).
 You can always take a look at our [implementation](https://github.com/infobip/infobip-api-java-client/blob/master/src/main/java/com/infobip/JSON.java).
 
 #### Fetching delivery reports
 If you are for any reason unable to receive real-time delivery reports on your endpoint, you can use `messageId` or `bulkId` to fetch them.
-Each request will return a batch of delivery reports - only once. See [documentation](https://www.infobip.com/docs/api/channels/sms/sms-messaging/logs-and-status-reports/get-outbound-sms-message-delivery-reports) for more details.
+Each request will return a batch of delivery reports - only once. See [documentation](https://www.infobip.com/docs/api/channels/sms/logs-and-status-reports/get-outbound-sms-message-delivery-reports-v3) for more details.
 
 ```java
     SmsDeliveryResult deliveryResult = smsApi.getOutboundSmsMessageDeliveryReports()
                                              .bulkId("bulkId")
                                              .execute();
+
     for (SmsDeliveryReport report : deliveryResult.getResults()) {
         System.out.println(report.getMessageId() + " - " + report.getStatus().getName());
     }
@@ -173,9 +175,11 @@ Infobip API supports Unicode characters and automatically detects encoding. Unic
 ```java
     SmsPreviewRequest smsPreviewRequest = new SmsPreviewRequest()
             .text("Let's see how many characters will remain unused in this message.");
+
     SmsPreviewResponse previewResponse = smsApi
             .previewSmsMessage(smsPreviewRequest)
             .execute();
+
     System.out.println(previewResponse);
 ```
 

messages-api.md

@@ -8,8 +8,8 @@ The first step is to create an `ApiClient` instance with some configuration.
 
 ````java
     ApiClient apiClient = ApiClient.forApiKey(ApiKey.from(API_KEY))
-        .withBaseUrl(BaseUrl.from(BASE_URL))
-        .build();
+                                   .withBaseUrl(BaseUrl.from(BASE_URL))
+                                   .build();
 ````
 
 With that ready, you can now create an instance of `MessagesApi` which allows you to send messages using Messages API.
@@ -61,7 +61,7 @@ The easiest way to start with Messages API is to send a text message. First you
 Send the message invoking the appropriate send method and store the results in a new variable.
 
 ````java
-    MessagesApiResponse messageInfo = null;
+    MessageResponse messageInfo = null;
     try {
         messageInfo = messagesApi
             .sendMessagesApiMessage(messagesApiRequest)

pom.xml

@@ -4,7 +4,7 @@
 
     <groupId>com.infobip</groupId>
     <artifactId>infobip-api-java-client</artifactId>
-    <version>6.0.0</version>
+    <version>6.1.0</version>
     <packaging>jar</packaging>
 
     <name>infobip-api-java-client</name>

src/main/java/com/infobip/RequestFactory.java

@@ -26,7 +26,7 @@
  */
 final class RequestFactory {
 
-    private static final String USER_AGENT_HEADER_VALUE = "infobip-api-client-java/6.0.0";
+    private static final String USER_AGENT_HEADER_VALUE = "infobip-api-client-java/6.1.0";
 
     private final ApiKey apiKey;
     private final BaseUrl baseUrl;

src/main/java/com/infobip/api/CallsApi.java

@@ -50,7 +50,6 @@
 import com.infobip.model.CallsConfigurationUpdateRequest;
 import com.infobip.model.CallsConnectRequest;
 import com.infobip.model.CallsConnectWithNewCallRequest;
-import com.infobip.model.CallsCountryList;
 import com.infobip.model.CallsCreateSipTrunkResponse;
 import com.infobip.model.CallsDialogBroadcastWebrtcTextRequest;
 import com.infobip.model.CallsDialogLogPage;
@@ -77,12 +76,13 @@
 import com.infobip.model.CallsOnDemandComposition;
 import com.infobip.model.CallsPlayRequest;
 import com.infobip.model.CallsPreAnswerRequest;
+import com.infobip.model.CallsPublicCountry;
+import com.infobip.model.CallsPublicRegion;
 import com.infobip.model.CallsPublicSipTrunkServiceAddress;
 import com.infobip.model.CallsPublicSipTrunkServiceAddressRequest;
 import com.infobip.model.CallsRecordingFile;
 import com.infobip.model.CallsRecordingLocation;
 import com.infobip.model.CallsRecordingStartRequest;
-import com.infobip.model.CallsRegionList;
 import com.infobip.model.CallsRescheduleRequest;
 import com.infobip.model.CallsSayRequest;
 import com.infobip.model.CallsSipTrunkPage;
@@ -100,6 +100,7 @@
 import com.infobip.model.CallsUpdateRequest;
 import java.io.File;
 import java.time.OffsetDateTime;
+import java.util.List;
 import java.util.Objects;
 
 /**
@@ -5837,12 +5838,13 @@ private GetCountriesRequest() {}
         /**
          * Executes the getCountries request.
          *
-         * @return CallsCountryList The deserialized response.
+         * @return List<CallsPublicCountry> The deserialized response.
          * @throws ApiException If the API call fails or an error occurs during the request or response processing.
          */
-        public CallsCountryList execute() throws ApiException {
+        public List<CallsPublicCountry> execute() throws ApiException {
             RequestDefinition getCountriesDefinition = getCountriesDefinition();
-            return apiClient.execute(getCountriesDefinition, new TypeReference<CallsCountryList>() {}.getType());
+            return apiClient.execute(
+                    getCountriesDefinition, new TypeReference<List<CallsPublicCountry>>() {}.getType());
         }
 
         /**
@@ -5851,10 +5853,10 @@ public CallsCountryList execute() throws ApiException {
          * @param callback The {@link ApiCallback} to be invoked.
          * @return The {@link okhttp3.Call} associated with the API request.
          */
-        public okhttp3.Call executeAsync(ApiCallback<CallsCountryList> callback) {
+        public okhttp3.Call executeAsync(ApiCallback<List<CallsPublicCountry>> callback) {
             RequestDefinition getCountriesDefinition = getCountriesDefinition();
             return apiClient.executeAsync(
-                    getCountriesDefinition, new TypeReference<CallsCountryList>() {}.getType(), callback);
+                    getCountriesDefinition, new TypeReference<List<CallsPublicCountry>>() {}.getType(), callback);
         }
     }
 
@@ -6908,12 +6910,12 @@ private GetRegionsRequest(String countryCode) {
         /**
          * Executes the getRegions request.
          *
-         * @return CallsRegionList The deserialized response.
+         * @return List&lt;CallsPublicRegion&gt; The deserialized response.
          * @throws ApiException If the API call fails or an error occurs during the request or response processing.
          */
-        public CallsRegionList execute() throws ApiException {
+        public List<CallsPublicRegion> execute() throws ApiException {
             RequestDefinition getRegionsDefinition = getRegionsDefinition(countryCode);
-            return apiClient.execute(getRegionsDefinition, new TypeReference<CallsRegionList>() {}.getType());
+            return apiClient.execute(getRegionsDefinition, new TypeReference<List<CallsPublicRegion>>() {}.getType());
         }
 
         /**
@@ -6922,10 +6924,10 @@ public CallsRegionList execute() throws ApiException {
          * @param callback The {@link ApiCallback} to be invoked.
          * @return The {@link okhttp3.Call} associated with the API request.
          */
-        public okhttp3.Call executeAsync(ApiCallback<CallsRegionList> callback) {
+        public okhttp3.Call executeAsync(ApiCallback<List<CallsPublicRegion>> callback) {
             RequestDefinition getRegionsDefinition = getRegionsDefinition(countryCode);
             return apiClient.executeAsync(
-                    getRegionsDefinition, new TypeReference<CallsRegionList>() {}.getType(), callback);
+                    getRegionsDefinition, new TypeReference<List<CallsPublicRegion>>() {}.getType(), callback);
         }
     }
 

src/main/java/com/infobip/api/EmailApi.java

@@ -1933,6 +1933,7 @@ private RequestDefinition sendEmailDefinition(
             Boolean track,
             Boolean trackClicks,
             Boolean trackOpens,
+            String trackingPixelPosition,
             String trackingUrl,
             String bulkId,
             String messageId,
@@ -2007,6 +2008,9 @@ private RequestDefinition sendEmailDefinition(
         if (trackOpens != null) {
             builder.addFormParameter(new Parameter("trackOpens", trackOpens));
         }
+        if (trackingPixelPosition != null) {
+            builder.addFormParameter(new Parameter("trackingPixelPosition", trackingPixelPosition));
+        }
         if (trackingUrl != null) {
             builder.addFormParameter(new Parameter("trackingUrl", trackingUrl));
         }
@@ -2077,6 +2081,7 @@ public class SendEmailRequest {
         private Boolean track;
         private Boolean trackClicks;
         private Boolean trackOpens;
+        private String trackingPixelPosition;
         private String trackingUrl;
         private String bulkId;
         private String messageId;
@@ -2177,7 +2182,7 @@ public SendEmailRequest ampHtml(String ampHtml) {
         /**
          * Sets templateId.
          *
-         * @param templateId Template ID used for generating email content. The template is created over Infobip web interface. If `templateId` is present, then `html` and `text` values are ignored.  Note: `templateId` only supports the value of `Broadcast`. `Content` and `Flow` are not supported. (optional)
+         * @param templateId Template ID used for generating email content. The template is created over Infobip web interface or via the [Infobip Templates API](https://www.infobip.com/docs/api/channels/email/templates). If `templateId` is present, then `html` and `text` values are ignored.  Note: `templateId` only supports the value of `Broadcast`. `Content` and `Flow` are not supported. (optional)
          * @return SendEmailRequest
          */
         public SendEmailRequest templateId(Long templateId) {
@@ -2284,6 +2289,17 @@ public SendEmailRequest trackOpens(Boolean trackOpens) {
             return this;
         }
 
+        /**
+         * Sets trackingPixelPosition.
+         *
+         * @param trackingPixelPosition This parameter specifies the position of the open tracking pixel within the email content. Allowed values are `TOP` and `BOTTOM`. If no value is provided, the default is `TOP`. (optional)
+         * @return SendEmailRequest
+         */
+        public SendEmailRequest trackingPixelPosition(String trackingPixelPosition) {
+            this.trackingPixelPosition = trackingPixelPosition;
+            return this;
+        }
+
         /**
          * Sets trackingUrl.
          *
@@ -2475,6 +2491,7 @@ public EmailSendResponse execute() throws ApiException {
                     track,
                     trackClicks,
                     trackOpens,
+                    trackingPixelPosition,
                     trackingUrl,
                     bulkId,
                     messageId,
@@ -2519,6 +2536,7 @@ public okhttp3.Call executeAsync(ApiCallback<EmailSendResponse> callback) {
                     track,
                     trackClicks,
                     trackOpens,
+                    trackingPixelPosition,
                     trackingUrl,
                     bulkId,
                     messageId,

src/main/java/com/infobip/api/FormsApi.java

@@ -19,7 +19,6 @@
 import com.infobip.model.FormsResponseContent;
 import com.infobip.model.FormsStatus;
 import com.infobip.model.FormsStatusResponse;
-import com.infobip.model.FormsType;
 import java.util.Map;
 import java.util.Objects;
 
@@ -97,7 +96,7 @@ public GetFormRequest getForm(String id) {
     }
 
     private RequestDefinition getFormsDefinition(
-            Integer offset, Integer limit, FormsType formType, FormsStatus formStatus) {
+            Integer offset, Integer limit, String formType, FormsStatus formStatus) {
         RequestDefinition.Builder builder = RequestDefinition.builder("GET", "/forms/1/forms")
                 .requiresAuthentication(true)
                 .accept("application/json");
@@ -123,7 +122,7 @@ private RequestDefinition getFormsDefinition(
     public class GetFormsRequest {
         private Integer offset;
         private Integer limit;
-        private FormsType formType;
+        private String formType;
         private FormsStatus formStatus;
 
         private GetFormsRequest() {}
@@ -156,7 +155,7 @@ public GetFormsRequest limit(Integer limit) {
          * @param formType The type of returned forms. (optional)
          * @return GetFormsRequest
          */
-        public GetFormsRequest formType(FormsType formType) {
+        public GetFormsRequest formType(String formType) {
             this.formType = formType;
             return this;
         }