Merge pull request #85 from square/release/23.1.0.20220823

Generated PR for Release: 23.1.0.20220823

Author: Xiao Hu

doc/client.md

@@ -5,7 +5,7 @@ The following parameters are configurable for the API Client:
 
 | Parameter | Type | Description |
 |  --- | --- | --- |
-| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2022-08-17"` |
+| `squareVersion` | `String` | Square Connect API versions<br>*Default*: `"2022-08-23"` |
 | `customUrl` | `String` | Sets the base URL requests are made to. Defaults to `https://connect.squareup.com`<br>*Default*: `"https://connect.squareup.com"` |
 | `environment` | `string` | The API environment. <br> **Default: `production`** |
 | `httpClientConfig` | `ReadonlyHttpClientConfiguration` | Http Client Configuration instance. |
@@ -19,7 +19,7 @@ The API client can be initialized as follows:
 SquareClient client = new SquareClient.Builder()
     .httpClientConfig(configBuilder -> configBuilder
             .timeout(0))
-    .squareVersion("2022-08-17")
+    .squareVersion("2022-08-23")
     .accessToken("AccessToken")
     .environment(Environment.PRODUCTION)
     .customUrl("https://connect.squareup.com")
@@ -45,7 +45,7 @@ public class Program {
         SquareClient client = new SquareClient.Builder()
             .httpClientConfig(configBuilder -> configBuilder
                     .timeout(0))
-            .squareVersion("2022-08-17")
+            .squareVersion("2022-08-23")
             .accessToken("AccessToken")
             .build();
 

doc/models/buy-now-pay-later-details.md

@@ -11,15 +11,17 @@ Additional details about a Buy Now Pay Later payment type.
 
 | Name | Type | Tags | Description | Getter |
 |  --- | --- | --- | --- | --- |
-| `Brand` | `String` | Optional | The brand used for the Buy Now Pay Later payment.<br>The brand can be `AFTERPAY` or `UNKNOWN`.<br>**Constraints**: *Maximum Length*: `50` | String getBrand() |
+| `Brand` | `String` | Optional | The brand used for the Buy Now Pay Later payment.<br>The brand can be `AFTERPAY`, `CLEARPAY` or `UNKNOWN`.<br>**Constraints**: *Maximum Length*: `50` | String getBrand() |
 | `AfterpayDetails` | [`AfterpayDetails`](../../doc/models/afterpay-details.md) | Optional | Additional details about Afterpay payments. | AfterpayDetails getAfterpayDetails() |
+| `ClearpayDetails` | [`ClearpayDetails`](../../doc/models/clearpay-details.md) | Optional | Additional details about Clearpay payments. | ClearpayDetails getClearpayDetails() |
 
 ## Example (as JSON)
 
 ```json
 {
   "brand": null,
-  "afterpay_details": null
+  "afterpay_details": null,
+  "clearpay_details": null
 }
 ```
 

doc/models/clearpay-details.md

@@ -0,0 +1,23 @@
+
+# Clearpay Details
+
+Additional details about Clearpay payments.
+
+## Structure
+
+`ClearpayDetails`
+
+## Fields
+
+| Name | Type | Tags | Description | Getter |
+|  --- | --- | --- | --- | --- |
+| `EmailAddress` | `String` | Optional | Email address on the buyer's Clearpay account.<br>**Constraints**: *Maximum Length*: `255` | String getEmailAddress() |
+
+## Example (as JSON)
+
+```json
+{
+  "email_address": null
+}
+```
+

pom.xml

@@ -4,7 +4,7 @@
 
   <groupId>com.squareup</groupId>
   <artifactId>square</artifactId>
-  <version>23.0.0.20220817</version>
+  <version>23.1.0.20220823</version>
   <packaging>jar</packaging>
 
   <name>Square</name>

src/main/java/com/squareup/square/SquareClient.java

@@ -658,7 +658,7 @@ public String getAccessToken() {
      * @return sdkVersion
      */
     public String getSdkVersion() {
-        return "23.0.0.20220817";
+        return "23.1.0.20220823";
     }
 
     /**
@@ -760,7 +760,7 @@ public static class Builder {
 
         private Environment environment = Environment.PRODUCTION;
         private String customUrl = "https://connect.squareup.com";
-        private String squareVersion = "2022-08-17";
+        private String squareVersion = "2022-08-23";
         private HttpClient httpClient;
         private Headers additionalHeaders = new Headers();
         private String userAgentDetail = null;

src/main/java/com/squareup/square/api/BaseApi.java

@@ -22,7 +22,7 @@ public abstract class BaseApi {
 
     protected String internalUserAgent;
 
-    private static String userAgent = "Square-Java-SDK/23.0.0.20220817 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
+    private static String userAgent = "Square-Java-SDK/23.1.0.20220823 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
 
     /**
      * Protected variables to hold an instance of Configuration.

src/main/java/com/squareup/square/models/BuyNowPayLaterDetails.java

@@ -13,23 +13,28 @@
 public class BuyNowPayLaterDetails {
     private final String brand;
     private final AfterpayDetails afterpayDetails;
+    private final ClearpayDetails clearpayDetails;
 
     /**
      * Initialization constructor.
      * @param  brand  String value for brand.
      * @param  afterpayDetails  AfterpayDetails value for afterpayDetails.
+     * @param  clearpayDetails  ClearpayDetails value for clearpayDetails.
      */
     @JsonCreator
     public BuyNowPayLaterDetails(
             @JsonProperty("brand") String brand,
-            @JsonProperty("afterpay_details") AfterpayDetails afterpayDetails) {
+            @JsonProperty("afterpay_details") AfterpayDetails afterpayDetails,
+            @JsonProperty("clearpay_details") ClearpayDetails clearpayDetails) {
         this.brand = brand;
         this.afterpayDetails = afterpayDetails;
+        this.clearpayDetails = clearpayDetails;
     }
 
     /**
      * Getter for Brand.
-     * The brand used for the Buy Now Pay Later payment. The brand can be `AFTERPAY` or `UNKNOWN`.
+     * The brand used for the Buy Now Pay Later payment. The brand can be `AFTERPAY`, `CLEARPAY` or
+     * `UNKNOWN`.
      * @return Returns the String
      */
     @JsonGetter("brand")
@@ -49,9 +54,20 @@ public AfterpayDetails getAfterpayDetails() {
         return afterpayDetails;
     }
 
+    /**
+     * Getter for ClearpayDetails.
+     * Additional details about Clearpay payments.
+     * @return Returns the ClearpayDetails
+     */
+    @JsonGetter("clearpay_details")
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public ClearpayDetails getClearpayDetails() {
+        return clearpayDetails;
+    }
+
     @Override
     public int hashCode() {
-        return Objects.hash(brand, afterpayDetails);
+        return Objects.hash(brand, afterpayDetails, clearpayDetails);
     }
 
     @Override
@@ -64,7 +80,8 @@ public boolean equals(Object obj) {
         }
         BuyNowPayLaterDetails other = (BuyNowPayLaterDetails) obj;
         return Objects.equals(brand, other.brand)
-            && Objects.equals(afterpayDetails, other.afterpayDetails);
+            && Objects.equals(afterpayDetails, other.afterpayDetails)
+            && Objects.equals(clearpayDetails, other.clearpayDetails);
     }
 
     /**
@@ -74,7 +91,7 @@ public boolean equals(Object obj) {
     @Override
     public String toString() {
         return "BuyNowPayLaterDetails [" + "brand=" + brand + ", afterpayDetails=" + afterpayDetails
-                + "]";
+                + ", clearpayDetails=" + clearpayDetails + "]";
     }
 
     /**
@@ -85,7 +102,8 @@ public String toString() {
     public Builder toBuilder() {
         Builder builder = new Builder()
                 .brand(getBrand())
-                .afterpayDetails(getAfterpayDetails());
+                .afterpayDetails(getAfterpayDetails())
+                .clearpayDetails(getClearpayDetails());
         return builder;
     }
 
@@ -95,6 +113,7 @@ public Builder toBuilder() {
     public static class Builder {
         private String brand;
         private AfterpayDetails afterpayDetails;
+        private ClearpayDetails clearpayDetails;
 
 
 
@@ -118,12 +137,22 @@ public Builder afterpayDetails(AfterpayDetails afterpayDetails) {
             return this;
         }
 
+        /**
+         * Setter for clearpayDetails.
+         * @param  clearpayDetails  ClearpayDetails value for clearpayDetails.
+         * @return Builder
+         */
+        public Builder clearpayDetails(ClearpayDetails clearpayDetails) {
+            this.clearpayDetails = clearpayDetails;
+            return this;
+        }
+
         /**
          * Builds a new {@link BuyNowPayLaterDetails} object using the set fields.
          * @return {@link BuyNowPayLaterDetails}
          */
         public BuyNowPayLaterDetails build() {
-            return new BuyNowPayLaterDetails(brand, afterpayDetails);
+            return new BuyNowPayLaterDetails(brand, afterpayDetails, clearpayDetails);
         }
     }
 }

src/main/java/com/squareup/square/models/ClearpayDetails.java

@@ -0,0 +1,100 @@
+
+package com.squareup.square.models;
+
+import com.fasterxml.jackson.annotation.JsonCreator;
+import com.fasterxml.jackson.annotation.JsonGetter;
+import com.fasterxml.jackson.annotation.JsonInclude;
+import com.fasterxml.jackson.annotation.JsonProperty;
+import java.util.Objects;
+
+/**
+ * This is a model class for ClearpayDetails type.
+ */
+public class ClearpayDetails {
+    private final String emailAddress;
+
+    /**
+     * Initialization constructor.
+     * @param  emailAddress  String value for emailAddress.
+     */
+    @JsonCreator
+    public ClearpayDetails(
+            @JsonProperty("email_address") String emailAddress) {
+        this.emailAddress = emailAddress;
+    }
+
+    /**
+     * Getter for EmailAddress.
+     * Email address on the buyer's Clearpay account.
+     * @return Returns the String
+     */
+    @JsonGetter("email_address")
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public String getEmailAddress() {
+        return emailAddress;
+    }
+
+    @Override
+    public int hashCode() {
+        return Objects.hash(emailAddress);
+    }
+
+    @Override
+    public boolean equals(Object obj) {
+        if (obj == this) {
+            return true;
+        }
+        if (!(obj instanceof ClearpayDetails)) {
+            return false;
+        }
+        ClearpayDetails other = (ClearpayDetails) obj;
+        return Objects.equals(emailAddress, other.emailAddress);
+    }
+
+    /**
+     * Converts this ClearpayDetails into string format.
+     * @return String representation of this class
+     */
+    @Override
+    public String toString() {
+        return "ClearpayDetails [" + "emailAddress=" + emailAddress + "]";
+    }
+
+    /**
+     * Builds a new {@link ClearpayDetails.Builder} object.
+     * Creates the instance with the state of the current model.
+     * @return a new {@link ClearpayDetails.Builder} object
+     */
+    public Builder toBuilder() {
+        Builder builder = new Builder()
+                .emailAddress(getEmailAddress());
+        return builder;
+    }
+
+    /**
+     * Class to build instances of {@link ClearpayDetails}.
+     */
+    public static class Builder {
+        private String emailAddress;
+
+
+
+        /**
+         * Setter for emailAddress.
+         * @param  emailAddress  String value for emailAddress.
+         * @return Builder
+         */
+        public Builder emailAddress(String emailAddress) {
+            this.emailAddress = emailAddress;
+            return this;
+        }
+
+        /**
+         * Builds a new {@link ClearpayDetails} object using the set fields.
+         * @return {@link ClearpayDetails}
+         */
+        public ClearpayDetails build() {
+            return new ClearpayDetails(emailAddress);
+        }
+    }
+}

src/main/java/com/squareup/square/utilities/WebhooksHelper.java

@@ -20,7 +20,7 @@ public class WebhooksHelper {
    * @param signatureHeader The value for the {@code x-square-hmacsha256-signature} header.
    * @param signatureKey    The signature key from the <a href="https://developer.squareup.com/apps">Square Developer portal</a> for the webhook subscription.
    * @param notificationUrl The notification endpoint URL as defined in the <a href="https://developer.squareup.com/apps">Square Developer portal</a> for the webhook subscription.
-   * @return {@code true} if the signature is valid, indicating that the event can be trusted as it came from Square.
+   * @return {@code true} if the signature is valid, indicating that the event can be trusted as it came from Square.<br/>
    * {@code false} if the signature validation fails, indicating that the event did not come from Square, so it may be malicious and should be discarded.
    */
   public static boolean isValidWebhookEventSignature(String requestBody, String signatureHeader,