fix: adds custom domain email support

Signed-off-by: nitish <[email protected]>

Author: nitish-sudo

.secrets.baseline

@@ -3,7 +3,7 @@
     "files": "^.secrets.baseline$",
     "lines": null
   },
-  "generated_at": "2023-06-14T06:40:41Z",
+  "generated_at": "2023-08-02T09:08:09Z",
   "plugins_used": [
     {
       "name": "AWSKeyDetector"
@@ -92,7 +92,7 @@
         "hashed_secret": "45ef428ffb0d89f2412db1cb133370f3900b0d58",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 31,
+        "line_number": 36,
         "type": "Box Credentials",
         "verified_result": null
       }
@@ -102,13 +102,13 @@
         "hashed_secret": "776917ec7fd348ce384f3ea92c2e6a06eef86796",
         "is_secret": false,
         "is_verified": false,
-        "line_number": 33,
+        "line_number": 38,
         "type": "Box Credentials",
         "verified_result": null
       }
     ]
   },
-  "version": "0.13.1+ibm.47.dss",
+  "version": "0.13.1+ibm.60.dss",
   "word_list": {
     "file": null,
     "hash": null

README.md

@@ -120,6 +120,7 @@ SDK Methods to consume
   - [Get Destination](#get-destination)
   - [Update Destination](#update-destination)
   - [Delete Destination](#delete-destination)
+  - [Custom Domain_Name_verification](#custom-domain-name-verification)
 - [Push Destination APIs](#push-destination-apis)
   - [Create Destination tag subscription](#create-destination-tag-subscription)
   - [List Destination tag subscription](#list-destination-tag-subscription)
@@ -392,7 +393,25 @@ DeleteDestinationOptions deleteDestinationOptions = new DeleteDestinationOptions
 
 Response<Void> response = eventNotificationsService.deleteDestination(deleteDestinationOptions).execute();
 ```
+### Custom Domain Name Verification
 
+After creation of the custom email destination with your domain name, make sure its validated for the right ownership.
+This can be done with SPF and DKIM verification.
+* Sender Policy Framework (SPF), which is used to authenticate the sender of an email. SPF specifies the mail servers that are allowed to send email for your domain.
+* DomainKeys Identified Mail (DKIM), which allows an organization to take responsibility for transmitting a message by signing it. DKIM allows
+  the receiver to check the email that claimed to have come from a specific domain, is authorized by the owner of that domain.
+
+```java
+UpdateVerifyDestinationOptions updateVerifyDestinationOptionsModel = new UpdateVerifyDestinationOptions.Builder()
+        .instanceId(<instanceId>)
+        .id(<destinationId>)
+        .type(<verificationType>)
+        .build();
+
+Response<VerificationResponse> verificationResponse = service.updateVerifyDestination(updateVerifyDestinationOptionsModel).execute();
+VerificationResponse responseObj = verificationResponse.getResult();
+
+```
 ## Push Destination APIs
 
 ### Create Destination tag subscription

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

@@ -64,6 +64,8 @@
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.UpdateDestinationOptions;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.UpdateSourceOptions;
 import com.ibm.cloud.eventnotifications.event_notifications.v1.model.UpdateSubscriptionOptions;
+import com.ibm.cloud.eventnotifications.event_notifications.v1.model.UpdateVerifyDestinationOptions;
+import com.ibm.cloud.eventnotifications.event_notifications.v1.model.VerificationResponse;
 import com.ibm.cloud.sdk.core.http.RequestBuilder;
 import com.ibm.cloud.sdk.core.http.ResponseConverter;
 import com.ibm.cloud.sdk.core.http.ServiceCall;
@@ -697,6 +699,32 @@ public ServiceCall<Void> deleteDestination(DeleteDestinationOptions deleteDestin
     return createServiceCall(builder.build(), responseConverter);
   }
 
+  /**
+   * Verify status of spf or dkim records of custom email.
+   *
+   * Verify status of spf or dkim records of custom email.
+   *
+   * @param updateVerifyDestinationOptions the {@link UpdateVerifyDestinationOptions} containing the options for the call
+   * @return a {@link ServiceCall} with a result of type {@link VerificationResponse}
+   */
+  public ServiceCall<VerificationResponse> updateVerifyDestination(UpdateVerifyDestinationOptions updateVerifyDestinationOptions) {
+    com.ibm.cloud.sdk.core.util.Validator.notNull(updateVerifyDestinationOptions,
+      "updateVerifyDestinationOptions cannot be null");
+    Map<String, String> pathParamsMap = new HashMap<String, String>();
+    pathParamsMap.put("instance_id", updateVerifyDestinationOptions.instanceId());
+    pathParamsMap.put("id", updateVerifyDestinationOptions.id());
+    RequestBuilder builder = RequestBuilder.patch(RequestBuilder.resolveRequestUrl(getServiceUrl(), "/v1/instances/{instance_id}/destinations/{id}/verify", pathParamsMap));
+    Map<String, String> sdkHeaders = SdkCommon.getSdkHeaders("event_notifications", "v1", "updateVerifyDestination");
+    for (Entry<String, String> header : sdkHeaders.entrySet()) {
+      builder.header(header.getKey(), header.getValue());
+    }
+    builder.header("Accept", "application/json");
+    builder.query("type", String.valueOf(updateVerifyDestinationOptions.type()));
+    ResponseConverter<VerificationResponse> responseConverter =
+      ResponseConverterUtils.getValue(new com.google.gson.reflect.TypeToken<VerificationResponse>() { }.getType());
+    return createServiceCall(builder.build(), responseConverter);
+  }
+
   /**
    * Create a new tag subscription.
    *

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

@@ -56,6 +56,8 @@ public interface Type {
     String IBMCOS = "ibmcos";
     /** push_huawei. */
     String PUSH_HUAWEI = "push_huawei";
+    /** smtp_custom. */
+    String SMTP_CUSTOM = "smtp_custom";
   }
 
   protected String instanceId;

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

@@ -0,0 +1,146 @@
+/*
+ * (C) Copyright IBM Corp. 2023.
+ *
+ * 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;
+
+import com.google.gson.annotations.SerializedName;
+import com.ibm.cloud.sdk.core.service.model.GenericModel;
+
+/**
+ * The DKIM attributes.
+ */
+public class DKIMAttributes extends GenericModel {
+
+  @SerializedName("public_key")
+  protected String publicKey;
+  protected String selector;
+  protected String verification;
+
+  /**
+   * Builder.
+   */
+  public static class Builder {
+    private String publicKey;
+    private String selector;
+    private String verification;
+
+    /**
+     * Instantiates a new Builder from an existing DKIMAttributes instance.
+     *
+     * @param dkimAttributes the instance to initialize the Builder with
+     */
+    private Builder(DKIMAttributes dkimAttributes) {
+      this.publicKey = dkimAttributes.publicKey;
+      this.selector = dkimAttributes.selector;
+      this.verification = dkimAttributes.verification;
+    }
+
+    /**
+     * Instantiates a new builder.
+     */
+    public Builder() {
+    }
+
+    /**
+     * Builds a DKIMAttributes.
+     *
+     * @return the new DKIMAttributes instance
+     */
+    public DKIMAttributes build() {
+      return new DKIMAttributes(this);
+    }
+
+    /**
+     * Set the publicKey.
+     *
+     * @param publicKey the publicKey
+     * @return the DKIMAttributes builder
+     */
+    public Builder publicKey(String publicKey) {
+      this.publicKey = publicKey;
+      return this;
+    }
+
+    /**
+     * Set the selector.
+     *
+     * @param selector the selector
+     * @return the DKIMAttributes builder
+     */
+    public Builder selector(String selector) {
+      this.selector = selector;
+      return this;
+    }
+
+    /**
+     * Set the verification.
+     *
+     * @param verification the verification
+     * @return the DKIMAttributes builder
+     */
+    public Builder verification(String verification) {
+      this.verification = verification;
+      return this;
+    }
+  }
+
+  protected DKIMAttributes() { }
+
+  protected DKIMAttributes(Builder builder) {
+    publicKey = builder.publicKey;
+    selector = builder.selector;
+    verification = builder.verification;
+  }
+
+  /**
+   * New builder.
+   *
+   * @return a DKIMAttributes builder
+   */
+  public Builder newBuilder() {
+    return new Builder(this);
+  }
+
+  /**
+   * Gets the publicKey.
+   *
+   * dkim public key.
+   *
+   * @return the publicKey
+   */
+  public String publicKey() {
+    return publicKey;
+  }
+
+  /**
+   * Gets the selector.
+   *
+   * dkim selector.
+   *
+   * @return the selector
+   */
+  public String selector() {
+    return selector;
+  }
+
+  /**
+   * Gets the verification.
+   *
+   * dkim verification.
+   *
+   * @return the verification
+   */
+  public String verification() {
+    return verification;
+  }
+}
+

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

@@ -56,6 +56,8 @@ public interface Type {
     String IBMCOS = "ibmcos";
     /** push_huawei. */
     String PUSH_HUAWEI = "push_huawei";
+    /** smtp_custom. */
+    String SMTP_CUSTOM = "smtp_custom";
   }
 
   protected String id;

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

@@ -22,6 +22,7 @@
  * DestinationConfigOneOf.
  *
  * Classes which extend this class:
+ * - DestinationConfigOneOfCustomDomainEmailDestinationConfig
  * - DestinationConfigOneOfWebhookDestinationConfig
  * - DestinationConfigOneOfFCMDestinationConfig
  * - DestinationConfigOneOfIOSDestinationConfig
@@ -48,6 +49,9 @@ public interface Verb {
     String POST = "post";
   }
 
+  protected String domain;
+  protected DKIMAttributes dkim;
+  protected SPFAttributes spf;
   protected String url;
   protected String verb;
   @SerializedName("custom_headers")
@@ -106,6 +110,39 @@ public interface Verb {
 
   protected DestinationConfigOneOf() { }
 
+  /**
+   * Gets the domain.
+   *
+   * Email Domain.
+   *
+   * @return the domain
+   */
+  public String domain() {
+    return domain;
+  }
+
+  /**
+   * Gets the dkim.
+   *
+   * The DKIM attributes.
+   *
+   * @return the dkim
+   */
+  public DKIMAttributes dkim() {
+    return dkim;
+  }
+
+  /**
+   * Gets the spf.
+   *
+   * The SPF attributes.
+   *
+   * @return the spf
+   */
+  public SPFAttributes spf() {
+    return spf;
+  }
+
   /**
    * Gets the url.
    *