Recommend billing item presence (#748)

* API version V20211004
ClouDesire · Oct 6, 2021 · 24418ae · 24418ae
1 parent c5a4b53
commit 24418ae
Show file tree

Hide file tree

Showing 3 changed files with 50 additions and 5 deletions.
diff --git a/...desire-api-client-dto/src/main/java/com/cloudesire/platform/apiclient/dto/ApiVersion.java b/...desire-api-client-dto/src/main/java/com/cloudesire/platform/apiclient/dto/ApiVersion.java
@@ -2,6 +2,7 @@
 
 public final class ApiVersion
 {
+    public static final long V20211004 = 20211004;
     public static final long V20210406 = 20210406;
     public static final long V20210215 = 20210215;
     public static final long V20210125 = 20210125;
@@ -33,7 +34,7 @@ public final class ApiVersion
     public static final long V20180101 = 20180101;
     public static final long NO_VERSION = 0;
 
-    public static final Long LATEST_API_VERSION = V20210406;
+    public static final Long LATEST_API_VERSION = V20211004;
 
     private ApiVersion()
     {

diff --git a/...ent-dto/src/main/java/com/cloudesire/platform/apiclient/dto/model/dto/BillingItemDTO.java b/...ent-dto/src/main/java/com/cloudesire/platform/apiclient/dto/model/dto/BillingItemDTO.java
@@ -1,6 +1,10 @@
 package com.cloudesire.platform.apiclient.dto.model.dto;
 
+import com.cloudesire.platform.apiclient.dto.ApiVersion;
+import com.cloudesire.platform.apiclient.dto.annotations.FieldAPI;
+import com.cloudesire.platform.apiclient.dto.annotations.UnsupportedAPI;
 import com.cloudesire.platform.apiclient.dto.model.constants.ErrorKeys;
+import com.cloudesire.platform.apiclient.dto.model.enums.BillingItemPresence;
 import com.cloudesire.platform.apiclient.dto.model.enums.BillingItemType;
 import com.cloudesire.platform.apiclient.dto.model.enums.BillingItemValueType;
 import com.fasterxml.jackson.annotation.JsonIgnore;
@@ -48,8 +52,12 @@ public class BillingItemDTO extends NamedEntityDTO
     @ApiModelProperty( "Percentage of revenues for the platform owner" )
     private BigDecimal cloudesireQuota;
 
-    @ApiModelProperty( "Whether the billing item will be included in every subscription" )
-    private boolean required;
+    @FieldAPI( sinceVersion = ApiVersion.V20211004 )
+    private BillingItemPresence presence = BillingItemPresence.OPTIONAL;
+
+    @ApiModelProperty( value = "Whether the billing item will be included in every subscription", hidden = true )
+    @UnsupportedAPI( sinceVersion = ApiVersion.V20211004 )
+    private Boolean required;
 
     @ApiModelProperty( "Whether the billing item can be downgraded" )
     private boolean downgradable = true;
@@ -168,12 +176,31 @@ public BillingItemDTO setCloudesireQuota( BigDecimal cloudesireQuota )
         return this;
     }
 
-    public boolean isRequired()
+    public BillingItemPresence getPresence()
+    {
+        return presence;
+    }
+
+    public BillingItemDTO setPresence( BillingItemPresence presence )
+    {
+        this.presence = presence;
+        return this;
+    }
+
+    /**
+     * @deprecated by {@link #getPresence()}
+     */
+    @Deprecated
+    public Boolean isRequired()
     {
         return required;
     }
 
-    public BillingItemDTO setRequired( boolean required )
+    /**
+     * @deprecated by {@link #setPresence(BillingItemPresence)}
+     */
+    @Deprecated
+    public BillingItemDTO setRequired( Boolean required )
     {
         this.required = required;
         return this;

diff --git a/.../src/main/java/com/cloudesire/platform/apiclient/dto/model/enums/BillingItemPresence.java b/.../src/main/java/com/cloudesire/platform/apiclient/dto/model/enums/BillingItemPresence.java
@@ -0,0 +1,17 @@
+package com.cloudesire.platform.apiclient.dto.model.enums;
+
+import io.swagger.annotations.ApiModel;
+import io.swagger.annotations.ApiModelProperty;
+
+@ApiModel( "Configuration for the presence of the Billing Item when buying a Subscription" )
+public enum BillingItemPresence
+{
+    @ApiModelProperty( "The Billing Item is optional" )
+    OPTIONAL,
+
+    @ApiModelProperty( "The Billing Item will be included in every Subscription" )
+    REQUIRED,
+
+    @ApiModelProperty( "The Billing Item will be suggested for inclusion on purchase" )
+    RECOMMENDED
+}