Merge pull request #159 from gocardless/template-changes

Changes from gocardless/gocardless-pro-java-template

Author: martin-nef

README.md

@@ -14,14 +14,14 @@ With Maven:
 <dependency>
     <groupId>com.gocardless</groupId>
     <artifactId>gocardless-pro</artifactId>
-    <version>7.4.0</version>
+    <version>7.5.0</version>
 </dependency>
 ```
 
 With Gradle:
 
 ```
-implementation 'com.gocardless:gocardless-pro:7.4.0'
+implementation 'com.gocardless:gocardless-pro:7.5.0'
 ```
 
 ## Initializing the client

build.gradle

@@ -25,7 +25,7 @@ plugins {
 sourceCompatibility = 1.8
 targetCompatibility = 1.8
 group = 'com.gocardless'
-version = '7.4.0'
+version = '7.5.0'
 
 apply plugin: 'ch.raffael.pegdown-doclet'
 

src/main/java/com/gocardless/GoCardlessClient.java

@@ -16,6 +16,7 @@ public class GoCardlessClient {
     private final HttpClient httpClient;
     private final BalanceService balances;
     private final BankAccountDetailService bankAccountDetails;
+    private final BankAccountHolderVerificationService bankAccountHolderVerifications;
     private final BankAuthorisationService bankAuthorisations;
     private final BankDetailsLookupService bankDetailsLookups;
     private final BillingRequestService billingRequests;
@@ -43,6 +44,8 @@ public class GoCardlessClient {
     private final PayerAuthorisationService payerAuthorisations;
     private final PayerThemeService payerThemes;
     private final PaymentService payments;
+    private final PaymentAccountService paymentAccounts;
+    private final PaymentAccountTransactionService paymentAccountTransactions;
     private final PayoutService payouts;
     private final PayoutItemService payoutItems;
     private final RedirectFlowService redirectFlows;
@@ -177,6 +180,7 @@ private GoCardlessClient(HttpClient httpClient) {
         this.httpClient = httpClient;
         this.balances = new BalanceService(httpClient);
         this.bankAccountDetails = new BankAccountDetailService(httpClient);
+        this.bankAccountHolderVerifications = new BankAccountHolderVerificationService(httpClient);
         this.bankAuthorisations = new BankAuthorisationService(httpClient);
         this.bankDetailsLookups = new BankDetailsLookupService(httpClient);
         this.billingRequests = new BillingRequestService(httpClient);
@@ -204,6 +208,8 @@ private GoCardlessClient(HttpClient httpClient) {
         this.payerAuthorisations = new PayerAuthorisationService(httpClient);
         this.payerThemes = new PayerThemeService(httpClient);
         this.payments = new PaymentService(httpClient);
+        this.paymentAccounts = new PaymentAccountService(httpClient);
+        this.paymentAccountTransactions = new PaymentAccountTransactionService(httpClient);
         this.payouts = new PayoutService(httpClient);
         this.payoutItems = new PayoutItemService(httpClient);
         this.redirectFlows = new RedirectFlowService(httpClient);
@@ -231,6 +237,13 @@ public BankAccountDetailService bankAccountDetails() {
         return bankAccountDetails;
     }
 
+    /**
+     * A service class for working with bank account holder verification resources.
+     */
+    public BankAccountHolderVerificationService bankAccountHolderVerifications() {
+        return bankAccountHolderVerifications;
+    }
+
     /**
      * A service class for working with bank authorisation resources.
      */
@@ -420,6 +433,20 @@ public PaymentService payments() {
         return payments;
     }
 
+    /**
+     * A service class for working with payment account resources.
+     */
+    public PaymentAccountService paymentAccounts() {
+        return paymentAccounts;
+    }
+
+    /**
+     * A service class for working with payment account transaction resources.
+     */
+    public PaymentAccountTransactionService paymentAccountTransactions() {
+        return paymentAccountTransactions;
+    }
+
     /**
      * A service class for working with payout resources.
      */

src/main/java/com/gocardless/http/HttpClient.java

@@ -35,7 +35,7 @@ public class HttpClient {
     private static final String DISALLOWED_USER_AGENT_CHARACTERS =
             "[^\\w!#$%&'\\*\\+\\-\\.\\^`\\|~]";
     private static final String USER_AGENT =
-            String.format("gocardless-pro-java/7.4.0 java/%s %s/%s %s/%s",
+            String.format("gocardless-pro-java/7.5.0 java/%s %s/%s %s/%s",
                     cleanUserAgentToken(System.getProperty("java.vm.specification.version")),
                     cleanUserAgentToken(System.getProperty("java.vm.name")),
                     cleanUserAgentToken(System.getProperty("java.version")),
@@ -49,7 +49,7 @@ public class HttpClient {
         builder.put("GoCardless-Version", "2015-07-06");
         builder.put("Accept", "application/json");
         builder.put("GoCardless-Client-Library", "gocardless-pro-java");
-        builder.put("GoCardless-Client-Version", "7.4.0");
+        builder.put("GoCardless-Client-Version", "7.5.0");
         HEADERS = builder.build();
     }
     private final OkHttpClient rawClient;

src/main/java/com/gocardless/resources/BankAccountHolderVerification.java

@@ -0,0 +1,94 @@
+package com.gocardless.resources;
+
+import com.google.gson.annotations.SerializedName;
+
+/**
+ * Represents a bank account holder verification resource returned from the API.
+ *
+ * Create a bank account holder verification for a bank account.
+ */
+public class BankAccountHolderVerification {
+    private BankAccountHolderVerification() {
+        // blank to prevent instantiation
+    }
+
+    private String actualAccountName;
+    private String id;
+    private Result result;
+    private Status status;
+    private Type type;
+
+    /**
+     * The actual account name returned by the recipient's bank, populated only in the case of a
+     * partial match.
+     */
+    public String getActualAccountName() {
+        return actualAccountName;
+    }
+
+    /**
+     * The unique identifier for the bank account holder verification resource, e.g. "BAHV123".
+     */
+    public String getId() {
+        return id;
+    }
+
+    /**
+     * Result of the verification, could be one of
+     * <ul>
+     * <li>`full_match`: The verification has confirmed that the account name exactly matches the
+     * details provided.</li>
+     * <li>`partial_match`: The verification has confirmed that the account name is similar but does
+     * not match to the details provided.</li>
+     * <li>`no_match`: The verification concludes the provided name does not match the account
+     * details.</li>
+     * <li>`unable_to_match`: The verification could not be performed due to recipient bank issues
+     * or technical issues</li>
+     * </ul>
+     */
+    public Result getResult() {
+        return result;
+    }
+
+    /**
+     * The status of the bank account holder verification.
+     * <ul>
+     * <li>`pending`: We have triggered the verification, but the result has not come back yet.</li>
+     * <li>`completed`: The verification is complete and is ready to be used.</li>
+     * </ul>
+     * 
+     */
+    public Status getStatus() {
+        return status;
+    }
+
+    /**
+     * Type of the verification that has been performed eg. [Confirmation of
+     * Payee](https://www.wearepay.uk/what-we-do/overlay-services/confirmation-of-payee/)
+     */
+    public Type getType() {
+        return type;
+    }
+
+    public enum Result {
+        @SerializedName("full_match")
+        FULL_MATCH, @SerializedName("partial_match")
+        PARTIAL_MATCH, @SerializedName("no_match")
+        NO_MATCH, @SerializedName("unable_to_match")
+        UNABLE_TO_MATCH, @SerializedName("unknown")
+        UNKNOWN
+    }
+
+    public enum Status {
+        @SerializedName("pending")
+        PENDING, @SerializedName("completed")
+        COMPLETED, @SerializedName("unknown")
+        UNKNOWN
+    }
+
+    public enum Type {
+        @SerializedName("confirmation_of_payee")
+        CONFIRMATION_OF_PAYEE, @SerializedName("unknown")
+        UNKNOWN
+    }
+}

src/main/java/com/gocardless/resources/BillingRequest.java

@@ -478,7 +478,7 @@ public String getPaymentReference() {
 
         /**
          * On failure, automatically retry payments using [intelligent
-         * retries](#success-intelligent-retries). Default is `false`.
+         * retries](/success-plus/overview). Default is `false`.
          * <p class="notice">
          * <strong>Important</strong>: To be able to use intelligent retries, Success+ needs to be
          * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
@@ -1386,9 +1386,10 @@ private CustomerBankAccount() {
             private Map<String, Object> metadata;
 
             /**
-             * Name of the account holder, as known by the bank. This field will be transliterated,
-             * upcased and truncated to 18 characters. This field is required unless the request
-             * includes a [customer bank account
+             * Name of the account holder, as known by the bank. The full name provided when the
+             * customer is created is stored and is available via the API, but is transliterated,
+             * upcased, and truncated to 18 characters in bank submissions. This field is required
+             * unless the request includes a [customer bank account
              * token](#javascript-flow-customer-bank-account-tokens).
              */
             public String getAccountHolderName() {
@@ -1756,7 +1757,7 @@ public String getPaymentReference() {
 
         /**
          * On failure, automatically retry payments using [intelligent
-         * retries](#success-intelligent-retries). Default is `false`.
+         * retries](/success-plus/overview). Default is `false`.
          * <p class="notice">
          * <strong>Important</strong>: To be able to use intelligent retries, Success+ needs to be
          * enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).

src/main/java/com/gocardless/resources/BillingRequestWithAction.java

@@ -680,7 +680,7 @@ public String getPaymentReference() {
 
             /**
              * On failure, automatically retry payments using [intelligent
-             * retries](#success-intelligent-retries). Default is `false`.
+             * retries](/success-plus/overview). Default is `false`.
              * <p class="notice">
              * <strong>Important</strong>: To be able to use intelligent retries, Success+ needs to
              * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).
@@ -1597,9 +1597,10 @@ private CustomerBankAccount() {
                 private Map<String, Object> metadata;
 
                 /**
-                 * Name of the account holder, as known by the bank. This field will be
-                 * transliterated, upcased and truncated to 18 characters. This field is required
-                 * unless the request includes a [customer bank account
+                 * Name of the account holder, as known by the bank. The full name provided when the
+                 * customer is created is stored and is available via the API, but is
+                 * transliterated, upcased, and truncated to 18 characters in bank submissions. This
+                 * field is required unless the request includes a [customer bank account
                  * token](#javascript-flow-customer-bank-account-tokens).
                  */
                 public String getAccountHolderName() {
@@ -1970,7 +1971,7 @@ public String getPaymentReference() {
 
             /**
              * On failure, automatically retry payments using [intelligent
-             * retries](#success-intelligent-retries). Default is `false`.
+             * retries](/success-plus/overview). Default is `false`.
              * <p class="notice">
              * <strong>Important</strong>: To be able to use intelligent retries, Success+ needs to
              * be enabled in [GoCardless dashboard](https://manage.gocardless.com/success-plus).

src/main/java/com/gocardless/resources/CustomerBankAccount.java

@@ -38,8 +38,9 @@ private CustomerBankAccount() {
     private Map<String, Object> metadata;
 
     /**
-     * Name of the account holder, as known by the bank. This field will be transliterated, upcased
-     * and truncated to 18 characters. This field is required unless the request includes a
+     * Name of the account holder, as known by the bank. The full name provided when the customer is
+     * created is stored and is available via the API, but is transliterated, upcased, and truncated
+     * to 18 characters in bank submissions. This field is required unless the request includes a
      * [customer bank account token](#javascript-flow-customer-bank-account-tokens).
      */
     public String getAccountHolderName() {

src/main/java/com/gocardless/resources/Event.java

@@ -352,6 +352,7 @@ private Links() {
         private String newCustomerBankAccount;
         private String newMandate;
         private String organisation;
+        private String outboundPayment;
         private String parentEvent;
         private String payerAuthorisation;
         private String payment;
@@ -461,6 +462,14 @@ public String getOrganisation() {
             return organisation;
         }
 
+        /**
+         * If `resource_type` is `outbound_payments`, this is the ID of the outbound_payment which
+         * has been updated.
+         */
+        public String getOutboundPayment() {
+            return outboundPayment;
+        }
+
         /**
          * If this event was caused by another, this is the ID of the cause. For example, if a
          * mandate is cancelled it automatically cancels all pending payments associated with it; in

src/main/java/com/gocardless/resources/OutboundPayment.java

@@ -11,12 +11,13 @@
  * GoCardless will notify you via a [webhook](#appendix-webhooks) when the status of the outbound
  * payment [changes](#event-types-outbound-payment).
  * 
- * <p class="restricted-notice">
- * <strong>Restricted</strong>: Outbound Payments are currently in Early Access and available only
- * to a limited list of organisations. If you are interested in using this feature, please stay
- * tuned for our public launch announcement. We are actively testing and refining our API to ensure
- * it meets your needs and provides the best experience.
- * </p>
+ * ####Rate limiting
+ * 
+ * Two rate limits apply to the Outbound Payments APIs: - All POST Outbound Payment endpoints
+ * (create, withdraw, approve, cancel and etc.) share a single rate-limit group of 300 requests per
+ * minute. As initiating a payment typically requires two API calls (one to create the payment and
+ * one to approve it), this allows you to add approximately 150 outbound payments per minute. - All
+ * remaining Outbound Payment endpoints are limited to 500 requests per minute.
  */
 public class OutboundPayment {
     private OutboundPayment() {