Latest v2019-10-10 Changes

src/main/java/com/recurly/v3/exception/ExceptionFactory.java

@@ -62,6 +62,9 @@ public static <T extends RecurlyException> T getExceptionClass(ApiException apiE
 
       case "missing_feature":
         return (T) new MissingFeatureException(e.getMessage(), e);
+
+      case "rate_limited":
+        return (T) new RateLimitedException(e.getMessage(), e);
     }
     return (T) apiException;
   }

src/main/java/com/recurly/v3/exception/RateLimitedException.java

@@ -0,0 +1,16 @@
+/**
+ * This file is automatically created by Recurly's OpenAPI generation process and thus any edits you
+ * make by hand will be lost. If you wish to make a change to this file, please create a Github
+ * issue explaining the changes you need and we will usher them to the appropriate places.
+ */
+package com.recurly.v3.exception;
+
+import com.recurly.v3.ApiException;
+import com.recurly.v3.resources.ErrorMayHaveTransaction;
+
+public class RateLimitedException extends ApiException {
+
+  public RateLimitedException(String message, ErrorMayHaveTransaction e) {
+    super(message, e);
+  }
+}

src/main/java/com/recurly/v3/requests/AccountAcquisitionUpdatable.java

@@ -24,6 +24,7 @@ public class AccountAcquisitionUpdatable extends Request {
   @Expose
   private String channel;
 
+  /** Account balance */
   @SerializedName("cost")
   @Expose
   private AccountAcquisitionCost cost;
@@ -60,11 +61,12 @@ public void setChannel(final String channel) {
     this.channel = channel;
   }
 
+  /** Account balance */
   public AccountAcquisitionCost getCost() {
     return this.cost;
   }
 
-  /** @param cost */
+  /** @param cost Account balance */
   public void setCost(final AccountAcquisitionCost cost) {
     this.cost = cost;
   }

src/main/java/com/recurly/v3/requests/AccountCreate.java

@@ -50,6 +50,11 @@ public class AccountCreate extends Request {
   @Expose
   private String company;
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   @SerializedName("custom_fields")
   @Expose
   private List<CustomField> customFields;
@@ -225,11 +230,20 @@ public void setCompany(final String company) {
     this.company = company;
   }
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   public List<CustomField> getCustomFields() {
     return this.customFields;
   }
 
-  /** @param customFields */
+  /**
+   * @param customFields The custom fields will only be altered when they are included in a request.
+   *     Sending an empty array will not remove any existing values. To remove a field send the name
+   *     with a null or empty value.
+   */
   public void setCustomFields(final List<CustomField> customFields) {
     this.customFields = customFields;
   }

src/main/java/com/recurly/v3/requests/AccountPurchase.java

@@ -50,6 +50,11 @@ public class AccountPurchase extends Request {
   @Expose
   private String company;
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   @SerializedName("custom_fields")
   @Expose
   private List<CustomField> customFields;
@@ -229,11 +234,20 @@ public void setCompany(final String company) {
     this.company = company;
   }
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   public List<CustomField> getCustomFields() {
     return this.customFields;
   }
 
-  /** @param customFields */
+  /**
+   * @param customFields The custom fields will only be altered when they are included in a request.
+   *     Sending an empty array will not remove any existing values. To remove a field send the name
+   *     with a null or empty value.
+   */
   public void setCustomFields(final List<CustomField> customFields) {
     this.customFields = customFields;
   }

src/main/java/com/recurly/v3/requests/AccountUpdate.java

@@ -41,6 +41,11 @@ public class AccountUpdate extends Request {
   @Expose
   private String company;
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   @SerializedName("custom_fields")
   @Expose
   private List<CustomField> customFields;
@@ -190,11 +195,20 @@ public void setCompany(final String company) {
     this.company = company;
   }
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   public List<CustomField> getCustomFields() {
     return this.customFields;
   }
 
-  /** @param customFields */
+  /**
+   * @param customFields The custom fields will only be altered when they are included in a request.
+   *     Sending an empty array will not remove any existing values. To remove a field send the name
+   *     with a null or empty value.
+   */
   public void setCustomFields(final List<CustomField> customFields) {
     this.customFields = customFields;
   }

src/main/java/com/recurly/v3/requests/BillingInfoCreate.java

@@ -41,6 +41,21 @@ public class BillingInfoCreate extends Request {
   @Expose
   private String fraudSessionId;
 
+  /**
+   * An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
+   */
+  @SerializedName("gateway_code")
+  @Expose
+  private String gatewayCode;
+
+  /**
+   * A token used in place of a credit card in order to perform transactions. Must be used in
+   * conjunction with `gateway_code`.
+   */
+  @SerializedName("gateway_token")
+  @Expose
+  private String gatewayToken;
+
   /** *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information. */
   @SerializedName("ip_address")
   @Expose
@@ -156,6 +171,37 @@ public void setFraudSessionId(final String fraudSessionId) {
     this.fraudSessionId = fraudSessionId;
   }
 
+  /**
+   * An identifier for a specific payment gateway. Must be used in conjunction with `gateway_token`.
+   */
+  public String getGatewayCode() {
+    return this.gatewayCode;
+  }
+
+  /**
+   * @param gatewayCode An identifier for a specific payment gateway. Must be used in conjunction
+   *     with `gateway_token`.
+   */
+  public void setGatewayCode(final String gatewayCode) {
+    this.gatewayCode = gatewayCode;
+  }
+
+  /**
+   * A token used in place of a credit card in order to perform transactions. Must be used in
+   * conjunction with `gateway_code`.
+   */
+  public String getGatewayToken() {
+    return this.gatewayToken;
+  }
+
+  /**
+   * @param gatewayToken A token used in place of a credit card in order to perform transactions.
+   *     Must be used in conjunction with `gateway_code`.
+   */
+  public void setGatewayToken(final String gatewayToken) {
+    this.gatewayToken = gatewayToken;
+  }
+
   /** *STRONGLY RECOMMENDED* Customer's IP address when updating their billing information. */
   public String getIpAddress() {
     return this.ipAddress;

src/main/java/com/recurly/v3/requests/ItemCreate.java

@@ -28,6 +28,11 @@ public class ItemCreate extends Request {
   @Expose
   private List<Pricing> currencies;
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   @SerializedName("custom_fields")
   @Expose
   private List<CustomField> customFields;
@@ -99,11 +104,20 @@ public void setCurrencies(final List<Pricing> currencies) {
     this.currencies = currencies;
   }
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   public List<CustomField> getCustomFields() {
     return this.customFields;
   }
 
-  /** @param customFields */
+  /**
+   * @param customFields The custom fields will only be altered when they are included in a request.
+   *     Sending an empty array will not remove any existing values. To remove a field send the name
+   *     with a null or empty value.
+   */
   public void setCustomFields(final List<CustomField> customFields) {
     this.customFields = customFields;
   }

src/main/java/com/recurly/v3/requests/ItemUpdate.java

@@ -28,6 +28,11 @@ public class ItemUpdate extends Request {
   @Expose
   private List<Pricing> currencies;
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   @SerializedName("custom_fields")
   @Expose
   private List<CustomField> customFields;
@@ -99,11 +104,20 @@ public void setCurrencies(final List<Pricing> currencies) {
     this.currencies = currencies;
   }
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   public List<CustomField> getCustomFields() {
     return this.customFields;
   }
 
-  /** @param customFields */
+  /**
+   * @param customFields The custom fields will only be altered when they are included in a request.
+   *     Sending an empty array will not remove any existing values. To remove a field send the name
+   *     with a null or empty value.
+   */
   public void setCustomFields(final List<CustomField> customFields) {
     this.customFields = customFields;
   }

src/main/java/com/recurly/v3/requests/SubscriptionChangeCreate.java

@@ -71,6 +71,7 @@ public class SubscriptionChangeCreate extends Request {
   @Expose
   private Integer quantity;
 
+  /** The shipping address can currently only be changed immediately, using SubscriptionUpdate. */
   @SerializedName("shipping")
   @Expose
   private SubscriptionChangeShippingCreate shipping;
@@ -224,11 +225,15 @@ public void setQuantity(final Integer quantity) {
     this.quantity = quantity;
   }
 
+  /** The shipping address can currently only be changed immediately, using SubscriptionUpdate. */
   public SubscriptionChangeShippingCreate getShipping() {
     return this.shipping;
   }
 
-  /** @param shipping */
+  /**
+   * @param shipping The shipping address can currently only be changed immediately, using
+   *     SubscriptionUpdate.
+   */
   public void setShipping(final SubscriptionChangeShippingCreate shipping) {
     this.shipping = shipping;
   }

src/main/java/com/recurly/v3/requests/SubscriptionCreate.java

@@ -54,6 +54,11 @@ public class SubscriptionCreate extends Request {
   @Expose
   private String currency;
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   @SerializedName("custom_fields")
   @Expose
   private List<CustomField> customFields;
@@ -260,11 +265,20 @@ public void setCurrency(final String currency) {
     this.currency = currency;
   }
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   public List<CustomField> getCustomFields() {
     return this.customFields;
   }
 
-  /** @param customFields */
+  /**
+   * @param customFields The custom fields will only be altered when they are included in a request.
+   *     Sending an empty array will not remove any existing values. To remove a field send the name
+   *     with a null or empty value.
+   */
   public void setCustomFields(final List<CustomField> customFields) {
     this.customFields = customFields;
   }

src/main/java/com/recurly/v3/requests/SubscriptionPurchase.java

@@ -24,6 +24,11 @@ public class SubscriptionPurchase extends Request {
   @Expose
   private Boolean autoRenew;
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   @SerializedName("custom_fields")
   @Expose
   private List<CustomField> customFields;
@@ -114,11 +119,20 @@ public void setAutoRenew(final Boolean autoRenew) {
     this.autoRenew = autoRenew;
   }
 
+  /**
+   * The custom fields will only be altered when they are included in a request. Sending an empty
+   * array will not remove any existing values. To remove a field send the name with a null or empty
+   * value.
+   */
   public List<CustomField> getCustomFields() {
     return this.customFields;
   }
 
-  /** @param customFields */
+  /**
+   * @param customFields The custom fields will only be altered when they are included in a request.
+   *     Sending an empty array will not remove any existing values. To remove a field send the name
+   *     with a null or empty value.
+   */
   public void setCustomFields(final List<CustomField> customFields) {
     this.customFields = customFields;
   }