Merge pull request #20 from FreeClimbAPI/VCSWP-16218

Introduce new properties in expectation of 10DLC updates

Author: ngarg-vail

CHANGELOG.md

@@ -7,6 +7,22 @@ This project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.htm
 ## [Unreleased]
 None
 
+<a name="4.1.5"></a>
+
+## [4.1.5] 2022-01-18
+### Changed
+- Fixed typos and build errors
+### Added
+- Add `capabilities`, `campaignId`, and `provider` to `ListIncomingNumbersFilters` interface
+- Add `capabilities`, `campaignId`, and `provider` to `ListAvailableNumbersFilters` interface
+- Add `capabilities`, `campaignId`, and `provider` to `AvailableNumber` interface
+- Add `capabilities`, `campaignId`, and `provider` to `IncomingNumber` interface
+### Removed
+- Remove `smsEnabled` and `voiceEnabled` from `ListAvailableNumbersFilters` interface
+- Remove `smsEnabled` and `voiceEnabled` from `ListIncomingNumbersFilters` interface
+- Remove `smsEnabled` and `voiceEnabled` from `AvailableNumber` interface
+- Remove `smsEnabled` and `voiceEnabled` from `IncomingNumber` interface
+
 <a name="4.1.4"></a>
 
 ## [4.1.4] 2021-11-29

build.gradle

@@ -9,7 +9,7 @@ group = 'com.github.FreeClimbAPI'
 
 sourceCompatibility = 1.7 // java 7
 targetCompatibility = 1.7
-version = '4.1.4'
+version = '4.1.5'
 
 repositories {
 	mavenCentral()

src/main/java/com/vailsys/freeclimb/api/call/Call.java

@@ -55,7 +55,7 @@ public class Call extends FreeClimbCommon {
 	/**
 	 * Additional paramter to support queries of active or terminated calls.
 	 */
-	private boolean active;
+	private Boolean active;
 	/**
 	 * This represents the current status or state of this call.
 	 * 
@@ -176,7 +176,7 @@ public String getPhoneNumberId() {
 	 *
 	 * @return whether the call was active or not
 	 */
-	public String getActive() {
+	public Boolean getActive() {
 		return this.active;
 	}
 

src/main/java/com/vailsys/freeclimb/api/call/CallsSearchFilters.java

@@ -46,7 +46,7 @@ public class CallsSearchFilters extends Filters {
 	/**
 	 * Additional paramter to support queries of active or terminated calls.
 	 */
-	private boolean active;
+	private Boolean active;
 
 	/**
 	 * Retrieve the value of the to (DNIS) filter.
@@ -138,7 +138,7 @@ public String getParentCallId() {
 	 *
 	 * @return whether the call was active or not
 	 */
-	public String getActive() {
+	public Boolean getActive() {
 		return this.active;
 	}
 

src/main/java/com/vailsys/freeclimb/api/phoneNumber/AvailablePhoneNumber.java

@@ -21,13 +21,17 @@
  */
 public class AvailablePhoneNumber extends PhoneNumber {
     /**
-     * The voiceEnabled setting for this phone number.
+     * The campaignId of this phone number.
      */
-    private boolean voiceEnabled;
+    private String campaignId;
     /**
-     * The smsEnabled setting for this phone number.
+     * The provider of this phone number.
      */
-    private boolean smsEnabled;
+    private String provider;
+    /**
+     * The capabilities of this phone number.
+     */
+    private PhoneNumberCapabilities capabilities;
     /**
      * The region of this phone number.
      */
@@ -54,21 +58,30 @@ public static AvailablePhoneNumber fromJson(String json) throws FreeClimbJSONExc
     }
 
     /**
-     * Retrieve the voiceEnabled setting from the object.
-     *
-     * @return The voiceEnabled for this AvailablePhoneNumber.
+     * Retrieve the capabilities of the phone number.
+     * 
+     * @return The capabilities of this AvailablePhoneNumber.
      */
-    public boolean isVoiceEnabled() {
-        return voiceEnabled;
+    public PhoneNumberCapabilities getCapabilities() {
+        return capabilities;
     }
 
     /**
-     * Retrieve the smsEnabled setting from the object.
-     *
-     * @return The smsEnabled for this AvailablePhoneNumber.
+     * Retrieve the campaignId of the phone number.
+     * 
+     * @return The campaignId of this AvailablePhoneNumber.
+     */
+    public String getCampaignId() {
+        return campaignId;
+    }
+
+    /**
+     * Retrieve the provider of the phone number.
+     * 
+     * @return The provider of this AvailablePhoneNumber.
      */
-    public boolean isSmsEnabled() {
-        return smsEnabled;
+    public String getProvider() {
+        return provider;
     }
 
     /**
@@ -99,14 +112,26 @@ public String getCountry() {
      */
     public boolean equals(AvailablePhoneNumber that) {
         boolean result = super.equals(that);
-        result = result && (this.isVoiceEnabled() == that.isVoiceEnabled());
-        result = result && (this.isSmsEnabled() == that.isSmsEnabled());
+        if (this.getProvider() != null) {
+            result = result && that.getProvider().equals(this.getProvider());
+        } else {
+            result = result && that.getProvider() == null;
+        }
+        if (this.getCampaignId() != null) {
+            result = result && that.getCampaignId().equals(this.getCampaignId());
+        } else {
+            result = result && that.getCampaignId() == null;
+        }
+        if (this.getCapabilities() != null) {
+            result = result && that.getCapabilities().equals(this.getCapabilities());
+        } else {
+            result = result && that.getCapabilities() == null;
+        }
         if (this.getRegion() != null) {
             result = result && that.getRegion().equals(this.getRegion());
         } else {
             result = result && that.getRegion() == null;
         }
-
         if (this.getCountry() != null) {
             result = result && that.getCountry().equals(this.getCountry());
         } else {

src/main/java/com/vailsys/freeclimb/api/phoneNumber/AvailablePhoneNumberSearchFilters.java

@@ -20,13 +20,22 @@ public class AvailablePhoneNumberSearchFilters extends Filters {
      */
     private String region;
     /**
-     * Indication of whether the phone number can handle sending and receiving SMS messages.
+     * Campaign ID of the this phone number.
      */
-    private boolean smsEnabled;
+    private String campaignId;
     /**
-     * Indicates whether the phone number can handle calls.
+     * Provider of this phone number.
      */
-    private boolean voiceEnabled;
+    private String provider;
+    /**
+     * Capabilities of this phone number.
+     */
+    private PhoneNumberCapabilities capabilities;
+    /**
+     * Alias of this phone number.
+     */
+    private String alias;
+
 
     /**
      * Retrieve the value of the phoneNumber filter.
@@ -62,7 +71,7 @@ public String getCountry() {
      * @param country The value of country to set
      */
     public void setCountry(String country) {
-        this.country = country
+        this.country = country;
     }
 
     /**
@@ -71,7 +80,7 @@ public void setCountry(String country) {
      * @return the region filter value
      */
     public String getRegion() {
-        return region
+        return region;
     }
 
     /**
@@ -80,42 +89,78 @@ public String getRegion() {
      * @param region The value of region to set
      */
     public void setRegion(String region) {
-        this.region = region
+        this.region = region;
+    }
+
+    /**
+     * Retrieve the capabilities of the phone number.
+     * 
+     * @return The capabilities of this AvailablePhoneNumber.
+     */
+    public PhoneNumberCapabilities getCapabilities() {
+        return capabilities;
+    }
+
+    /**
+     * Set the capabilities filter for available phone numbers.
+     * 
+     * @param capabilities The value of capabilities to set
+     */
+    public void setCapabilities(PhoneNumberCapabilities capabilities) {
+        this.capabilities = capabilities;
+    }
+
+    /**
+     * Retrieve the campaignId of the phone number.
+     * 
+     * @return The campaignId of this AvailablePhoneNumber.
+     */
+    public String getCampaignId() {
+        return campaignId;
+    }
+
+    /**
+     * Set the campaignId filter for available phone numbers.
+     * 
+     * @param campaignId The value of campaignId to set
+     */
+    public void setCampaignId(String campaignId) {
+        this.campaignId = campaignId;
     }
 
     /**
-     * Retrieve the value of the smsEnabled filter
+     * Retrieve the provider of the phone number.
      * 
-     * @return the smsEnabled filter value
+     * @return The provider of this AvailablePhoneNumber.
      */
-    public boolean getSmsEnabled() {
-        return smsEnabled
+    public String getProvider() {
+        return provider;
     }
 
     /**
-     * Set the smsEnabled filter for available phone numbers.
+     * Set the provider filter for available phone numbers.
      * 
-     * @param smsEnabled The value of smsEnabled to set
+     * @param provider The value of provider to set
      */
-    public void setSmsEnabled(boolean smsEnabled) {
-        this.smsEnabled = smsEnabled
+    public void setProvider(String provider) {
+        this.provider = provider;
     }
 
     /**
-     * Retrieve the value of the voiceEnabled filter
+     * Retrieve the alias of the phone number.
      * 
-     * @return the voiceEnabled filter value
+     * @return The alias of this AvailablePhoneNumber.
      */
-    public boolean getVoiceEnabled() {
-        return voiceEnabled
+    public String getAlias() {
+        return alias;
     }
 
     /**
-     * Set the voiceEnabled filter for available phone numbers.
+     * Set the alias filter for available phone numbers.
      * 
-     * @param voiceEnabled The value of voiceEnabled to set
+     * @param alias The value of alias to set
      */
-    public void setVoiceEnabled(boolean voiceEnabled) {
-        this.voiceEnabled = voiceEnabled
+    public void setAlias(String alias) {
+        this.alias = alias;
     }
 }