DEVEXP-1309: use event destinations and sinch events (numbers) (#322)

* feat (Numbers): Refactor 'callback configuration' and 'webhooks' to 'Event Destinations' and 'Sinch Events'

Author: JPPortier

MIGRATION-GUIDE.md

@@ -76,7 +76,7 @@ public interface ConversationService {
   ProjectSettingsService projectSettings();
 
   /**
-   * WebHooksService Service instance
+   * SinchEventsService Service instance
    *
    * @return service instance for project
    * @since 1.3

client/src/main/com/sinch/sdk/domains/conversation/api/v1/ConversationService.java

@@ -31,18 +31,18 @@ public interface NumbersService extends ActiveNumberService, AvailableNumberServ
   AvailableRegionsService regions();
 
   /**
-   * Callbacks Configuration Service instance
+   * Event Destinations Configuration Service instance
    *
    * @return service instance for project
    * @since 2.0
    */
-  CallbackConfigurationService callbackConfiguration();
+  EventDestinationsService eventDestinations();
 
   /**
-   * Webhooks helpers instance
+   * Sinch Events helpers instance
    *
-   * @return instance service related to webhooks helpers
-   * @since 1.2
+   * @return instance service related to Sinch Events helpers
+   * @since 2.0
    */
-  WebHooksService webhooks();
+  SinchEventsService sinchEvents();
 }

client/src/main/com/sinch/sdk/domains/numbers/api/v1/NumbersService.java

@@ -1,11 +1,11 @@
 package com.sinch.sdk.domains.numbers.api.v1;
 
 import com.sinch.sdk.core.exceptions.ApiMappingException;
-import com.sinch.sdk.domains.numbers.models.v1.webhooks.NumberEvent;
+import com.sinch.sdk.domains.numbers.models.v1.sinchevents.NumberSinchEvent;
 import java.util.Map;
 
 /**
- * Webhooks service
+ * Sinch Events service
  *
  * <p>Callback events are used to get notified about Numbers usage according to your configured
  * callback URL
@@ -16,7 +16,7 @@
  *
  * @since 1.2
  */
-public interface WebHooksService {
+public interface SinchEventsService {
 
   /**
    * The Sinch Platform can initiate callback requests to a URL you define (Callback URL) on request
@@ -47,5 +47,5 @@ boolean validateAuthenticationHeader(
    * @return The decoded event notification instance class
    * @since 1.2
    */
-  NumberEvent parseEvent(String jsonPayload) throws ApiMappingException;
+  NumberSinchEvent parseEvent(String jsonPayload) throws ApiMappingException;
 }

…ains/numbers/api/v1/WebHooksService.java …s/numbers/api/v1/SinchEventsService.javaclient/src/main/com/sinch/sdk/domains/numbers/api/v1/WebHooksService.java renamed to client/src/main/com/sinch/sdk/domains/numbers/api/v1/SinchEventsService.java client/src/main/com/sinch/sdk/domains/numbers/api/v1/WebHooksService.java renamed to client/src/main/com/sinch/sdk/domains/numbers/api/v1/SinchEventsService.java

@@ -8,7 +8,7 @@
 import com.sinch.sdk.core.models.ServerConfiguration;
 import com.sinch.sdk.core.utils.StringUtil;
 import com.sinch.sdk.domains.numbers.api.v1.AvailableRegionsService;
-import com.sinch.sdk.domains.numbers.api.v1.CallbackConfigurationService;
+import com.sinch.sdk.domains.numbers.api.v1.EventDestinationsService;
 import com.sinch.sdk.domains.numbers.models.v1.ActiveNumber;
 import com.sinch.sdk.domains.numbers.models.v1.EmergencyAddress;
 import com.sinch.sdk.domains.numbers.models.v1.request.ActiveNumberUpdateRequest;
@@ -46,8 +46,8 @@ public class NumbersService implements com.sinch.sdk.domains.numbers.api.v1.Numb
   private volatile AvailableNumberServiceFacade available;
   private volatile ActiveNumberServiceFacade active;
   private volatile AvailableRegionsService regions;
-  private volatile CallbackConfigurationService callbackConfiguration;
-  private volatile WebHooksService webhooks;
+  private volatile EventDestinationsService eventDestinations;
+  private volatile SinchEventsService sinchEvents;
 
   static {
     LocalLazyInit.init();
@@ -96,26 +96,26 @@ ActiveNumberServiceFacade active() {
     return this.active;
   }
 
-  public CallbackConfigurationService callbackConfiguration() {
-    if (null == this.callbackConfiguration) {
+  public EventDestinationsService eventDestinations() {
+    if (null == this.eventDestinations) {
       instanceLazyInit();
-      this.callbackConfiguration =
-          new CallbackConfigurationServiceImpl(
+      this.eventDestinations =
+          new EventDestinationsServiceImpl(
               httpClientSupplier.get(),
               context.getNumbersServer(),
               authManagers,
               HttpMapper.getInstance(),
               uriUUID);
     }
-    return this.callbackConfiguration;
+    return this.eventDestinations;
   }
 
-  public WebHooksService webhooks() {
+  public SinchEventsService sinchEvents() {
 
-    if (null == this.webhooks) {
-      this.webhooks = new WebHooksService(new NumbersWebhooksAuthenticationValidation());
+    if (null == this.sinchEvents) {
+      this.sinchEvents = new SinchEventsService(new SinchEventsAuthenticationValidation());
     }
-    return this.webhooks;
+    return this.sinchEvents;
   }
 
   @Override

client/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/NumbersService.java

@@ -11,7 +11,7 @@
 import javax.crypto.Mac;
 import javax.crypto.spec.SecretKeySpec;
 
-public class NumbersWebhooksAuthenticationValidation {
+public class SinchEventsAuthenticationValidation {
 
   public static final String SIGNATURE_HEADER = "X-Sinch-Signature";
   static final String HMAC_SHA1_ALGORITHM = "HmacSHA1";
@@ -39,7 +39,7 @@ private String encode(String secret, String stringToSign) {
       Mac mac = Mac.getInstance(HMAC_SHA1_ALGORITHM);
       mac.init(secretKeySpec);
       byte[] hmacSha256 = mac.doFinal(stringToSign.getBytes(StandardCharsets.UTF_8));
-      return NumbersWebhooksAuthenticationValidation.bytesToHex(hmacSha256);
+      return SinchEventsAuthenticationValidation.bytesToHex(hmacSha256);
     } catch (NoSuchAlgorithmException | InvalidKeyException e) {
       throw new ApiAuthException(e);
     }

…ersWebhooksAuthenticationValidation.java …SinchEventsAuthenticationValidation.javaclient/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/NumbersWebhooksAuthenticationValidation.java renamed to client/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/SinchEventsAuthenticationValidation.java client/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/NumbersWebhooksAuthenticationValidation.java renamed to client/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/SinchEventsAuthenticationValidation.java

@@ -3,13 +3,13 @@
 import com.fasterxml.jackson.core.JsonProcessingException;
 import com.sinch.sdk.core.exceptions.ApiMappingException;
 import com.sinch.sdk.core.utils.databind.Mapper;
-import com.sinch.sdk.domains.numbers.models.v1.webhooks.NumberEvent;
+import com.sinch.sdk.domains.numbers.models.v1.sinchevents.NumberSinchEvent;
 import java.util.Map;
 
-public class WebHooksService implements com.sinch.sdk.domains.numbers.api.v1.WebHooksService {
-  private final NumbersWebhooksAuthenticationValidation authenticationChecker;
+public class SinchEventsService implements com.sinch.sdk.domains.numbers.api.v1.SinchEventsService {
+  private final SinchEventsAuthenticationValidation authenticationChecker;
 
-  public WebHooksService(NumbersWebhooksAuthenticationValidation authenticationChecker) {
+  public SinchEventsService(SinchEventsAuthenticationValidation authenticationChecker) {
     this.authenticationChecker = authenticationChecker;
   }
 
@@ -20,10 +20,10 @@ public boolean validateAuthenticationHeader(
   }
 
   @Override
-  public NumberEvent parseEvent(String jsonPayload) throws ApiMappingException {
+  public NumberSinchEvent parseEvent(String jsonPayload) throws ApiMappingException {
 
     try {
-      return Mapper.getInstance().readValue(jsonPayload, NumberEvent.class);
+      return Mapper.getInstance().readValue(jsonPayload, NumberSinchEvent.class);
     } catch (JsonProcessingException e) {
       throw new ApiMappingException(jsonPayload, e);
     }

…ers/api/v1/adapters/WebHooksService.java …/api/v1/adapters/SinchEventsService.javaclient/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/WebHooksService.java renamed to client/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/SinchEventsService.java client/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/WebHooksService.java renamed to client/src/main/com/sinch/sdk/domains/numbers/api/v1/adapters/SinchEventsService.java

@@ -0,0 +1,6 @@
+/**
+ * Numbers API Event Destinations related models
+ *
+ * @since 1.2
+ */
+package com.sinch.sdk.domains.numbers.models.v1.eventdestinations;