feat (Verification/StartSMS): Support additional properties onto Star…

…t request
sinch · Sep 4, 2024 · e9caba6 · e9caba6
1 parent d93c34d
commit e9caba6
Show file tree

Hide file tree

Showing 22 changed files with 299 additions and 53 deletions.
diff --git a/.../test/java/com/sinch/sdk/domains/verification/adapters/VerificationsStartServiceTest.java b/.../test/java/com/sinch/sdk/domains/verification/adapters/VerificationsStartServiceTest.java
@@ -1,5 +1,6 @@
 package com.sinch.sdk.domains.verification.adapters;
 
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.spy;
 import static org.mockito.Mockito.when;
@@ -9,11 +10,12 @@
 import com.sinch.sdk.core.TestHelpers;
 import com.sinch.sdk.core.exceptions.ApiException;
 import com.sinch.sdk.domains.verification.adapters.converters.VerificationsDtoConverterTest;
-import com.sinch.sdk.domains.verification.models.dto.v1.start.VerificationStartResponseTest;
+import com.sinch.sdk.domains.verification.models.dto.v1.start.response.VerificationStartResponseTest;
 import com.sinch.sdk.domains.verification.models.response.StartVerificationResponseCallout;
 import com.sinch.sdk.domains.verification.models.response.StartVerificationResponseFlashCall;
 import com.sinch.sdk.domains.verification.models.response.StartVerificationResponseSMS;
 import com.sinch.sdk.domains.verification.models.response.StartVerificationResponseSeamless;
+import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestSms;
 import com.sinch.sdk.domains.verification.models.v1.start.request.internal.VerificationStartRequestInternalImpl;
 import org.junit.jupiter.api.BeforeEach;
 import org.junit.jupiter.api.Test;
@@ -22,16 +24,18 @@
 @TestWithResources
 public class VerificationsStartServiceTest extends VerificationBaseTest {
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestPhoneCallDto.json")
+  @GivenJsonResource(
+      "/domains/verification/v1/start/request/VerificationStartRequestPhoneCallDto.json")
   public VerificationStartRequestInternalImpl startVerificationPhoneCallRequestDto;
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestFlashCallDto.json")
+  @GivenJsonResource(
+      "/domains/verification/v1/start/request/VerificationStartRequestFlashCallDto.json")
   public VerificationStartRequestInternalImpl startVerificationFlashCallRequestDto;
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestDataDto.json")
+  @GivenJsonResource("/domains/verification/v1/start/request/VerificationStartRequestDataDto.json")
   public VerificationStartRequestInternalImpl startVerificationDataRequestDto;
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestSmsDto.json")
+  @GivenJsonResource("/domains/verification/v1/start/request/VerificationStartRequestSmsDto.json")
   public VerificationStartRequestInternalImpl startVerificationSmsRequestDto;
 
   @Mock com.sinch.sdk.domains.verification.api.v1.VerificationStartService v1;
@@ -46,7 +50,7 @@ public void initMocks() {
   @Test
   void startSms() throws ApiException {
 
-    when(v1.startSms(eq(startVerificationSmsRequestDto.getVerificationStartRequestSmsImpl())))
+    when(v1.startSms(any(VerificationStartRequestSms.class)))
         .thenReturn(
             VerificationStartResponseTest.expectedStartVerificationSmsDto
                 .getVerificationStartResponseSmsImpl());

diff --git a/...com/sinch/sdk/domains/verification/adapters/converters/VerificationsDtoConverterTest.java b/...com/sinch/sdk/domains/verification/adapters/converters/VerificationsDtoConverterTest.java
@@ -17,8 +17,8 @@
 import com.sinch.sdk.domains.verification.models.VerificationStatusType;
 import com.sinch.sdk.domains.verification.models.dto.v1.report.VerificationReportRequestDtoTest;
 import com.sinch.sdk.domains.verification.models.dto.v1.report.VerificationReportResponseDtoTest;
-import com.sinch.sdk.domains.verification.models.dto.v1.start.VerificationStartRequestTest;
-import com.sinch.sdk.domains.verification.models.dto.v1.start.VerificationStartResponseTest;
+import com.sinch.sdk.domains.verification.models.dto.v1.start.request.VerificationStartRequestTest;
+import com.sinch.sdk.domains.verification.models.dto.v1.start.response.VerificationStartResponseTest;
 import com.sinch.sdk.domains.verification.models.dto.v1.status.VerificationStatusResponseTest;
 import com.sinch.sdk.domains.verification.models.requests.SMSCodeType;
 import com.sinch.sdk.domains.verification.models.requests.StartVerificationCalloutOptions;
@@ -35,6 +35,8 @@
 import com.sinch.sdk.domains.verification.models.response.StartVerificationResponseFlashCall;
 import com.sinch.sdk.domains.verification.models.response.StartVerificationResponseSMS;
 import com.sinch.sdk.domains.verification.models.response.StartVerificationResponseSeamless;
+import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequest;
+import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestSms;
 import java.time.Instant;
 import org.junit.jupiter.api.Test;
 
@@ -136,9 +138,18 @@ void convertStartDataRequest() {
   @Test
   void convertStartSmsRequest() {
 
+    VerificationStartRequest expected =
+        VerificationStartRequestSms.builder()
+            .setCustom("a custom")
+            .setReference("a reference")
+            .setIdentity(
+                com.sinch.sdk.domains.verification.models.v1.NumberIdentity.valueOf("+endpoint"))
+            .setExpiry("01:02:03")
+            .setCodeType(VerificationStartRequestSms.CodeTypeEnum.ALPHANUMERIC)
+            .setTemplate("My template require to use '{{CODE}}' code")
+            .build();
     TestHelpers.recursiveEquals(
-        VerificationsDtoConverter.convert(startVerificationSmsRequest),
-        VerificationStartRequestTest.startVerificationSmsDto.getVerificationStartRequestSmsImpl());
+        VerificationsDtoConverter.convert(startVerificationSmsRequest), expected);
   }
 
   @Test

diff --git a/...java/com/sinch/sdk/domains/verification/api/v1/adapters/VerificationStartServiceTest.java b/...java/com/sinch/sdk/domains/verification/api/v1/adapters/VerificationStartServiceTest.java
@@ -1,5 +1,6 @@
 package com.sinch.sdk.domains.verification.api.v1.adapters;
 
+import static org.mockito.ArgumentMatchers.any;
 import static org.mockito.ArgumentMatchers.eq;
 import static org.mockito.Mockito.doReturn;
 import static org.mockito.Mockito.spy;
@@ -13,8 +14,8 @@
 import com.sinch.sdk.core.http.HttpClient;
 import com.sinch.sdk.domains.verification.adapters.VerificationBaseTest;
 import com.sinch.sdk.domains.verification.api.v1.internal.VerificationsStartApi;
-import com.sinch.sdk.domains.verification.models.dto.v1.start.VerificationStartRequestTest;
-import com.sinch.sdk.domains.verification.models.dto.v1.start.VerificationStartResponseTest;
+import com.sinch.sdk.domains.verification.models.dto.v1.start.request.VerificationStartRequestTest;
+import com.sinch.sdk.domains.verification.models.dto.v1.start.response.VerificationStartResponseTest;
 import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequest;
 import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestSms;
 import com.sinch.sdk.domains.verification.models.v1.start.request.VerificationStartRequestSmsImpl;
@@ -33,16 +34,18 @@
 @TestWithResources
 public class VerificationStartServiceTest extends VerificationBaseTest {
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestPhoneCallDto.json")
+  @GivenJsonResource(
+      "/domains/verification/v1/start/request/VerificationStartRequestPhoneCallDto.json")
   public VerificationStartRequestInternal startVerificationPhoneCallRequestDto;
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestFlashCallDto.json")
+  @GivenJsonResource(
+      "/domains/verification/v1/start/request/VerificationStartRequestFlashCallDto.json")
   public VerificationStartRequestInternal startVerificationFlashCallRequestDto;
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestDataDto.json")
+  @GivenJsonResource("/domains/verification/v1/start/request/VerificationStartRequestDataDto.json")
   public VerificationStartRequestInternal startVerificationDataRequestDto;
 
-  @GivenJsonResource("/domains/verification/v1/start/VerificationStartRequestSmsDto.json")
+  @GivenJsonResource("/domains/verification/v1/start/request/VerificationStartRequestSmsDto.json")
   public VerificationStartRequestInternal startVerificationSmsRequestDto;
 
   @Mock VerificationsStartApi api;
@@ -62,7 +65,7 @@ public void initMocks() {
   @Test
   void startSms() throws ApiException {
 
-    when(api.startVerification(eq(startVerificationSmsRequestDto), eq(null)))
+    when(api.startVerification(any(VerificationStartRequestInternal.class), eq(null)))
         .thenReturn(VerificationStartResponseTest.expectedStartVerificationSmsDto);
 
     VerificationStartResponseSms response =
@@ -95,7 +98,7 @@ void startSmsWithAcceptLanguage() throws ApiException {
         new VerificationStartRequestInternalImpl();
     internalWithAcceptLanguage.setActualInstance(withAcceptLanguage);
 
-    when(api.startVerification(eq(internalWithAcceptLanguage), eq("es-ES")))
+    when(api.startVerification(any(VerificationStartRequestInternal.class), eq("es-ES")))
         .thenReturn(VerificationStartResponseTest.expectedStartVerificationSmsDto);
 
     VerificationStartResponseSms response =

diff --git a/core/src/main/com/sinch/sdk/core/utils/databind/Mapper.java b/core/src/main/com/sinch/sdk/core/utils/databind/Mapper.java
@@ -1,5 +1,6 @@
 package com.sinch.sdk.core.utils.databind;
 
+import com.fasterxml.jackson.annotation.JsonAnyGetter;
 import com.fasterxml.jackson.annotation.JsonInclude;
 import com.fasterxml.jackson.core.JsonGenerator;
 import com.fasterxml.jackson.core.JsonParser;
@@ -47,19 +48,24 @@ public void serializeAsField(
             // Do not serialize uninitialized fields to avoid sending a null value when not required
             boolean serialize;
 
-            // Call getter to obtain value: if of OptionalValue type: use it to check serialization
-            // state
-            Object value = pojo.getClass().getMethod(member.getName()).invoke(pojo);
-            if (value instanceof OptionalValue) {
-              serialize = ((OptionalValue<?>) value).isPresent();
+            if (member.hasAnnotation(JsonAnyGetter.class)) {
+              serialize = true;
             } else {
-              /* @Deprecated
-               * Not find the expected OptionalValue: fallback to xxxDefined function call
-               * The xxDefined function feature will have to be deprecated in favour of OptionalValue usage
-               * This part could be suppressed as soon as all domains had moved to the OptionalValue support from OAS generated files
-               */
-              serialize =
-                  (boolean) pojo.getClass().getMethod(member.getName() + "Defined").invoke(pojo);
+              // Call getter to obtain value: if of OptionalValue type: use it to check
+              // serialization
+              // state
+              Object value = pojo.getClass().getMethod(member.getName()).invoke(pojo);
+              if (value instanceof OptionalValue) {
+                serialize = ((OptionalValue<?>) value).isPresent();
+              } else {
+                /* @Deprecated
+                 * Not find the expected OptionalValue: fallback to xxxDefined function call
+                 * The xxDefined function feature will have to be deprecated in favour of OptionalValue usage
+                 * This part could be suppressed as soon as all domains had moved to the OptionalValue support from OAS generated files
+                 */
+                serialize =
+                    (boolean) pojo.getClass().getMethod(member.getName() + "Defined").invoke(pojo);
+              }
             }
             // not set but is field is required ?
             if (!serialize) {

diff --git a/...m/sinch/sdk/domains/verification/models/v1/start/request/VerificationStartRequestSms.java b/...m/sinch/sdk/domains/verification/models/v1/start/request/VerificationStartRequestSms.java
@@ -104,6 +104,15 @@ public static String valueOf(CodeTypeEnum e) {
    */
   String getAcceptLanguage();
 
+  /**
+   * Return the extra-additional property with the specified name. Used in case of delegation
+   * pattern in use by class
+   *
+   * @param key the name of the property
+   * @return the additional property with the specified name
+   */
+  Object getExtraOption(String key);
+
   /**
    * Getting builder
    *
@@ -181,6 +190,14 @@ interface Builder
      */
     Builder setAcceptLanguage(String acceptLanguage);
 
+    /**
+     * see getter
+     *
+     * @return Current builder
+     * @see #getExtraOption
+     */
+    Builder putExtraOption(String key, Object value);
+
     /**
      * Create instance
      *

diff --git a/...nch/sdk/domains/verification/models/v1/start/request/VerificationStartRequestSmsImpl.java b/...nch/sdk/domains/verification/models/v1/start/request/VerificationStartRequestSmsImpl.java
@@ -126,8 +126,10 @@ public String getExpiry() {
   }
 
   public OptionalValue<String> expiry() {
-    return null != smsOptions
-        ? smsOptions.map(VerificationStartSmsOptions::getExpiry)
+    return null != smsOptions && smsOptions.isPresent()
+        ? smsOptions
+            .map(f -> ((VerificationStartSmsOptionsImpl) f).expiry())
+            .orElse(OptionalValue.empty())
         : OptionalValue.empty();
   }
 
@@ -140,7 +142,7 @@ public CodeTypeEnum getCodeType() {
   }
 
   public OptionalValue<CodeTypeEnum> codeType() {
-    return null != smsOptions
+    return null != smsOptions && smsOptions.isPresent()
         ? smsOptions.map(f -> CodeTypeEnum.from(smsOptions.get().getCodeType().value()))
         : OptionalValue.empty();
   }
@@ -154,8 +156,10 @@ public String getTemplate() {
   }
 
   public OptionalValue<String> template() {
-    return null != smsOptions
-        ? smsOptions.map(VerificationStartSmsOptions::getTemplate)
+    return null != smsOptions && smsOptions.isPresent()
+        ? smsOptions
+            .map(f -> ((VerificationStartSmsOptionsImpl) f).template())
+            .orElse(OptionalValue.empty())
         : OptionalValue.empty();
   }
 
@@ -170,11 +174,18 @@ public String getAcceptLanguage() {
   }
 
   public OptionalValue<String> acceptLanguage() {
-    return null != smsOptions
-        ? smsOptions.map(VerificationStartSmsOptions::getAcceptLanguage)
+    return null != smsOptions && smsOptions.isPresent()
+        ? smsOptions
+            .map(f -> ((VerificationStartSmsOptionsImpl) f).acceptLanguage())
+            .orElse(OptionalValue.empty())
         : OptionalValue.empty();
   }
 
+  @JsonIgnore
+  public Object getExtraOption(String key) {
+    return null != smsOptions && smsOptions.isPresent() ? smsOptions.get().get(key) : null;
+  }
+
   /** Return true if this VerificationStartRequestSms object is equal to o. */
   @Override
   public boolean equals(Object o) {
@@ -283,6 +294,11 @@ public Builder setAcceptLanguage(String acceptLanguage) {
       return this;
     }
 
+    public Builder putExtraOption(String key, Object value) {
+      getDelegatedBuilder().put(key, value);
+      return this;
+    }
+
     private VerificationStartSmsOptions.Builder getDelegatedBuilder() {
       if (null == _delegatedBuilder) {
         this._delegatedBuilder = VerificationStartSmsOptions.builder();

diff --git a/...dk/domains/verification/models/v1/start/request/internal/VerificationStartSmsOptions.java b/...dk/domains/verification/models/v1/start/request/internal/VerificationStartSmsOptions.java
@@ -84,6 +84,14 @@ public static String valueOf(CodeTypeEnum e) {
    */
   String getAcceptLanguage();
 
+  /**
+   * Return the additional property with the specified name.
+   *
+   * @param key the name of the property
+   * @return the additional property with the specified name
+   */
+  Object get(String key);
+
   /**
    * Getting builder
    *
@@ -132,6 +140,14 @@ interface Builder {
      */
     Builder setAcceptLanguage(String acceptLanguage);
 
+    /**
+     * see getter
+     *
+     * @return Current builder
+     * @see #get
+     */
+    Builder put(String key, Object value);
+
     /**
      * Create instance
      *