fix: add slack destination support

Author: nitish-sudo

README.md

@@ -4,9 +4,6 @@
 # Java server SDK for IBM Cloud Event Notifications service Version 0.1.0
 Java client library to interact with various [IBM Cloud Event Notifications Service](https://cloud.ibm.com/apidocs?category=event-notifications).
 
-Disclaimer: this SDK is being released initially as a **pre-release** version.
-Changes might occur which impact applications that use this SDK.
-
 ## Table of Contents
 
 - [Overview](#overview)
@@ -444,9 +441,6 @@ Response<Void> response = eventNotificationsService.deleteSubscription(deleteSub
 ```
 ### Send Notifications
 ```java
-      List<String> userIds = new ArrayList<String>();
-      userIds.add(<user-ids>);
-
       List<String> fcmDevices = new ArrayList<String>();
       fcmDevices.add(<fcm-device-ids>);
 
@@ -459,7 +453,7 @@ Response<Void> response = eventNotificationsService.deleteSubscription(deleteSub
       List<String> devicePlatforms = new ArrayList<String>();
       devicePlatforms.add(<device-platforms>);
 
-      String notificationDevices = "{ 'user_ids' : " + userIds + "}";
+      String notificationDevices =  "{\"user_ids\": [\"userId\"]}";
       String fcmJsonString = "{ 'title' : '<notification-title>', 'badge': '<notification-message>' }";
       String apnsJsonString = "{'alert': '<notification-message>', 'badge': 5 }";
       JsonObject apnsJsonObject = JsonParser.parseString(apnsJsonString).getAsJsonObject();
@@ -489,7 +483,6 @@ Response<Void> response = eventNotificationsService.deleteSubscription(deleteSub
 <br>
 
 - **CeIbmenpushto** - Set up the push notifications targets.
-  - *user_ids* (Array of **String**) - Send notification to the specified userIds.
   - *fcm_devices* (Array of **String**) - Send notification to the list of specified Android devices.
   - *fcm_devices* (Array of **String**) - Send notification to the list of specified iOS devices.
   - *_devices* (Array of **String**) - Send notification to the list of specified Chrome devices.

modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/EventNotifications.java

@@ -19,6 +19,7 @@
 
 import com.google.gson.JsonObject;
 import com.ibm.cloud.event_notifications.common.SdkCommon;
+import com.ibm.cloud.eventnotifications.event_notifications.v1.model.BulkNotificationResponse;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.CreateDestinationOptions;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.CreateSourcesOptions;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.CreateSubscriptionOptions;
@@ -49,6 +50,7 @@
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.ListTopicsOptions;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.NotificationResponse;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.ReplaceTopicOptions;
+import com.ibm.cloud.eventnotifications.event_notifications.v1.model.SendBulkNotificationsOptions;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.SendNotificationsOptions;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.Source;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.SourceList;
@@ -198,6 +200,33 @@ public ServiceCall<NotificationResponse> sendNotifications(SendNotificationsOpti
     return createServiceCall(builder.build(), responseConverter);
   }
 
+  /**
+   * Send Bulk notification.
+   *
+   * @param sendBulkNotificationsOptions the {@link SendBulkNotificationsOptions} containing the options for the call
+   * @return a {@link ServiceCall} with a result of type {@link BulkNotificationResponse}
+   */
+  public ServiceCall<BulkNotificationResponse> sendBulkNotifications(SendBulkNotificationsOptions sendBulkNotificationsOptions) {
+    com.ibm.cloud.sdk.core.util.Validator.notNull(sendBulkNotificationsOptions,
+      "sendBulkNotificationsOptions cannot be null");
+    Map<String, String> pathParamsMap = new HashMap<String, String>();
+    pathParamsMap.put("instance_id", sendBulkNotificationsOptions.instanceId());
+    RequestBuilder builder = RequestBuilder.post(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v1/instances/{instance_id}/notifications/bulk", pathParamsMap));
+    Map<String, String> sdkHeaders = SdkCommon.getSdkHeaders("event_notifications", "v1", "sendBulkNotifications");
+    for (Entry<String, String> header : sdkHeaders.entrySet()) {
+      builder.header(header.getKey(), header.getValue());
+    }
+    builder.header("Accept", "application/json");
+    final JsonObject contentJson = new JsonObject();
+    if (sendBulkNotificationsOptions.bulkMessages() != null) {
+      contentJson.add("bulk_messages", com.ibm.cloud.sdk.core.util.GsonSingleton.getGson().toJsonTree(sendBulkNotificationsOptions.bulkMessages()));
+    }
+    builder.bodyJson(contentJson);
+    ResponseConverter<BulkNotificationResponse> responseConverter =
+      ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken<BulkNotificationResponse>() { }.getType());
+    return createServiceCall(builder.build(), responseConverter);
+  }
+
   /**
    * Create a new API Source.
    *

modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/model/NotificationAPNSBody.java renamed to modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/model/BulkNotificationResponse.java

@@ -12,34 +12,41 @@
  */
 package com.ibm.cloud.eventnotifications.event_notifications.v1.model;
 
+import java.util.List;
+
 import com.google.gson.annotations.SerializedName;
-import com.google.gson.reflect.TypeToken;
-import com.ibm.cloud.sdk.core.service.model.DynamicModel;
+import com.ibm.cloud.sdk.core.service.model.GenericModel;
 
 /**
- * Payload describing a APNs Notifications body.
- *
- * Classes which extend this class:
- * - NotificationAPNSBodyMessageENData
- * - NotificationAPNSBodyNotificationPayload
+ * Payload describing a notifications response.
  */
-public class NotificationAPNSBody extends DynamicModel<Object> {
+public class BulkNotificationResponse extends GenericModel {
 
-  @SerializedName("en_data")
-  protected NotificationAPNSBodyMessageData enData;
+  @SerializedName("bulk_notification_id")
+  protected String bulkNotificationId;
+  @SerializedName("bulk_messages")
+  protected List<Object> bulkMessages;
 
-  protected NotificationAPNSBody() {
-    super(new TypeToken<Object>() { });
+  /**
+   * Gets the bulkNotificationId.
+   *
+   * Bulk Notification ID.
+   *
+   * @return the bulkNotificationId
+   */
+  public String getBulkNotificationId() {
+    return bulkNotificationId;
   }
 
   /**
-   * Gets the enData.
+   * Gets the bulkMessages.
    *
-   * Payload describing a apns notifications body message Data.
+   * List of Notifications.
    *
-   * @return the enData
+   * @return the bulkMessages
    */
-  public NotificationAPNSBodyMessageData getEnData() {
-    return this.enData;
+  public List<Object> getBulkMessages() {
+    return bulkMessages;
   }
 }
+

modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/model/CreateDestinationOptions.java

@@ -38,6 +38,8 @@ public interface Type {
     String PUSH_CHROME = "push_chrome";
     /** push_firefox. */
     String PUSH_FIREFOX = "push_firefox";
+    /** slack. */
+    String SLACK = "slack";
   }
 
   protected String instanceId;

modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/model/Destination.java

@@ -37,6 +37,8 @@ public interface Type {
     String PUSH_ANDROID = "push_android";
     /** push_ios. */
     String PUSH_IOS = "push_ios";
+    /** slack. */
+    String SLACK = "slack";
   }
 
   protected String id;

modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/model/DestinationConfigParams.java

@@ -27,6 +27,7 @@
  * - DestinationConfigParamsIOSDestinationConfig
  * - DestinationConfigParamsChromeDestinationConfig
  * - DestinationConfigParamsFirefoxDestinationConfig
+ * - DestinationConfigParamsSlackDestinationConfig
  */
 public class DestinationConfigParams extends GenericModel {
 

modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/model/DestinationConfigParamsSlackDestinationConfig.java

@@ -0,0 +1,82 @@
+/*
+ * (C) Copyright IBM Corp. 2022.
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on
+ * an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the
+ * specific language governing permissions and limitations under the License.
+ */
+package com.ibm.cloud.eventnotifications.event_notifications.v1.model;
+
+/**
+ * Payload describing a slack destination configuration.
+ */
+public class DestinationConfigParamsSlackDestinationConfig extends DestinationConfigParams {
+
+
+  /**
+   * Builder.
+   */
+  public static class Builder {
+    private String url;
+
+    public Builder(DestinationConfigParams destinationConfigParamsSlackDestinationConfig) {
+      this.url = destinationConfigParamsSlackDestinationConfig.url;
+    }
+
+    /**
+     * Instantiates a new builder.
+     */
+    public Builder() {
+    }
+
+    /**
+     * Instantiates a new builder with required properties.
+     *
+     * @param url the url
+     */
+    public Builder(String url) {
+      this.url = url;
+    }
+
+    /**
+     * Builds a DestinationConfigParamsSlackDestinationConfig.
+     *
+     * @return the new DestinationConfigParamsSlackDestinationConfig instance
+     */
+    public DestinationConfigParamsSlackDestinationConfig build() {
+      return new DestinationConfigParamsSlackDestinationConfig(this);
+    }
+
+    /**
+     * Set the url.
+     *
+     * @param url the url
+     * @return the DestinationConfigParamsSlackDestinationConfig builder
+     */
+    public Builder url(String url) {
+      this.url = url;
+      return this;
+    }
+  }
+
+  protected DestinationConfigParamsSlackDestinationConfig(Builder builder) {
+    com.ibm.cloud.sdk.core.util.Validator.notNull(builder.url,
+      "url cannot be null");
+    url = builder.url;
+  }
+
+  /**
+   * New builder.
+   *
+   * @return a DestinationConfigParamsSlackDestinationConfig builder
+   */
+  public Builder newBuilder() {
+    return new Builder(this);
+  }
+}
+

modules/event-notifications/src/main/java/com/ibm/cloud/eventnotifications/event_notifications/v1/model/DestinationListItem.java

@@ -37,6 +37,8 @@ public interface Type {
     String PUSH_ANDROID = "push_android";
     /** push_ios. */
     String PUSH_IOS = "push_ios";
+    /** slack. */
+    String SLACK = "slack";
   }
 
   protected String id;