Updating changelog

CHANGELOG.md

@@ -5,6 +5,13 @@ All notable changes to this project will be documented in this file.
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/),
 and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
 
+## [3.0.0] - 2024-01-11
+### Added
+- OTP API
+### Changed
+- Updated comments (made them javadoc style)
+- Use Javabeans style getters and setters instead of public fields
+
 ## [2.1.0] - 2023-07-07
 ### Changed
 - Implement DCS parameter (#23)
@@ -19,4 +26,4 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 ### Added
 - Pushed to Maven Central
 ### Changed
-- Changed namespace from com.cmtelecom to com.cm
+- Changed namespace from com.cmtelecom to com.cm

src/main/java/com/cm/text/models/identity/OtpRequest.java

@@ -69,8 +69,8 @@ public OtpRequest() {
     }
 
     /**
+     * The sender name The maximum length is 11 alphanumerical characters or 16 digits. Example: 'MyCompany'
      * @return This is the sender name.
-     * The maximum length is 11 alphanumerical characters or 16 digits. Example: 'MyCompany'
      */
     public String getFrom() {
         return from;
@@ -85,15 +85,15 @@ public void setFrom(String from) {
     }
 
     /**
-     *
+     * The destination mobile number.
      * @return The destination mobile number.
      */
     public String getTo() {
         return to;
     }
 
     /**
-     * Required: The destination mobile number.
+     *  Required: The destination mobile number.
      *  This value should be in international format. single mobile number per request. Example: '+316012345678'
      * @param to This value should be in international format. single mobile number per request. Example: '+316012345678'
      */
@@ -102,27 +102,31 @@ public void setTo(String to) {
     }
 
     /**
+     * The length of the code (min 4, max 10). default: 5.
      * @return The length of the code (min 4, max 10). default: 5.
      */
     public Integer getDigits() {
         return digits;
     }
 
     /**
+     * The length of the code (min 4, max 10). default: 5.
      * @param digits The length of the code (min 4, max 10). default: 5.
      */
     public void setDigits(Integer digits) {
         this.digits = digits;
     }
 
     /**
+     * The expiry in seconds (min 10, max 3600). default (when null): 60 seconds.
      * @return The expiry in seconds (min 10, max 3600). default (when null): 60 seconds.
      */
     public Integer getExpiry() {
         return expiry;
     }
 
     /**
+     * The expiry in seconds (min 10, max 3600). (default: 60 seconds.)
      * @param expiry The expiry in seconds (min 10, max 3600). (default: 60 seconds.)
      */
     public void setExpiry(Integer expiry) {
@@ -140,9 +144,10 @@ public String getChannel() {
     }
 
     /**
+     * The channel to send the code.
+     *      Supported values: auto, sms, push, whatsapp, voice, email.
+     *      Channel auto is only available with a SOLiD subscription.
      * @param channel The channel to send the code.
-     * Supported values: auto, sms, push, whatsapp, voice, email.
-     * Channel auto is only available with a SOLiD subscription.
      */
     public void setChannel(String channel) {
         this.channel = channel;