Merge pull request #82 from square/release/22.0.0.20220720

Generated PR for Release: 22.0.0.20220720

Author: joanc-sq

doc/models/obtain-token-request.md

@@ -18,6 +18,7 @@
 | `MigrationToken` | `String` | Optional | A legacy OAuth access token obtained using a Connect API version prior<br>to 2019-03-13. This parameter is required if `grant_type` is set to<br>`migration_token` to indicate that the application wants to get a replacement<br>OAuth access token. The response also returns a refresh token.<br>For more information, see [Migrate to Using Refresh Tokens](https://developer.squareup.com/docs/oauth-api/migrate-to-refresh-tokens).<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | String getMigrationToken() |
 | `Scopes` | `List<String>` | Optional | A JSON list of strings representing the permissions that the application is requesting.<br>For example, "`["MERCHANT_PROFILE_READ","PAYMENTS_READ","BANK_ACCOUNTS_READ"]`".<br><br>The access token returned in the response is granted the permissions<br>that comprise the intersection between the requested list of permissions and those<br>that belong to the provided refresh token. | List<String> getScopes() |
 | `ShortLived` | `Boolean` | Optional | A Boolean indicating a request for a short-lived access token.<br><br>The short-lived access token returned in the response expires in 24 hours. | Boolean getShortLived() |
+| `CodeVerifier` | `String` | Optional | Must be provided when using PKCE OAuth flow. The `code_verifier` will be used to verify against the<br>`code_challenge` associated with the `authorization_code`. | String getCodeVerifier() |
 
 ## Example (as JSON)
 

doc/models/obtain-token-response.md

@@ -19,6 +19,9 @@
 | `RefreshToken` | `String` | Optional | A refresh token. OAuth refresh tokens are 64 bytes long.<br>For more information, see [Refresh, Revoke, and Limit the Scope of OAuth Tokens](https://developer.squareup.com/docs/oauth-api/refresh-revoke-limit-scope).<br>**Constraints**: *Minimum Length*: `2`, *Maximum Length*: `1024` | String getRefreshToken() |
 | `ShortLived` | `Boolean` | Optional | A Boolean indicating that the access token is a short-lived access token.<br>The short-lived access token returned in the response expires in 24 hours. | Boolean getShortLived() |
 | `Errors` | [`List<Error>`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. | List<Error> getErrors() |
+| `RefreshTokenExpiresAt` | `String` | Optional | The date when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.<br>**Constraints**: *Minimum Length*: `20`, *Maximum Length*: `48` | String getRefreshTokenExpiresAt() |
+| `AppSubscriptionId` | `String` | Optional | The subscription id of a v2 subscription the merchant signed up<br>for. The subscription id is only present if the merchant signed up for a subscription during authorization. | String getAppSubscriptionId() |
+| `AppPlanId` | `String` | Optional | The plan id of a v2 subscription plan the merchant signed up<br>for. The plan id is only present if the merchant signed up for a subscription plan during authorization. | String getAppPlanId() |
 
 ## Example (as JSON)
 

pom.xml

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

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

@@ -645,7 +645,7 @@ public String getAccessToken() {
      * @return sdkVersion
      */
     public String getSdkVersion() {
-        return "21.0.0.20220720";
+        return "22.0.0.20220720";
     }
 
     /**

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/21.0.0.20220720 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
+    private static String userAgent = "Square-Java-SDK/22.0.0.20220720 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}";
 
     /**
      * Protected variables to hold an instance of Configuration.

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

@@ -21,6 +21,7 @@ public class ObtainTokenRequest {
     private final String migrationToken;
     private final List<String> scopes;
     private final Boolean shortLived;
+    private final String codeVerifier;
 
     /**
      * Initialization constructor.
@@ -33,6 +34,7 @@ public class ObtainTokenRequest {
      * @param  migrationToken  String value for migrationToken.
      * @param  scopes  List of String value for scopes.
      * @param  shortLived  Boolean value for shortLived.
+     * @param  codeVerifier  String value for codeVerifier.
      */
     @JsonCreator
     public ObtainTokenRequest(
@@ -44,7 +46,8 @@ public ObtainTokenRequest(
             @JsonProperty("refresh_token") String refreshToken,
             @JsonProperty("migration_token") String migrationToken,
             @JsonProperty("scopes") List<String> scopes,
-            @JsonProperty("short_lived") Boolean shortLived) {
+            @JsonProperty("short_lived") Boolean shortLived,
+            @JsonProperty("code_verifier") String codeVerifier) {
         this.clientId = clientId;
         this.clientSecret = clientSecret;
         this.code = code;
@@ -54,6 +57,7 @@ public ObtainTokenRequest(
         this.migrationToken = migrationToken;
         this.scopes = scopes;
         this.shortLived = shortLived;
+        this.codeVerifier = codeVerifier;
     }
 
     /**
@@ -168,10 +172,22 @@ public Boolean getShortLived() {
         return shortLived;
     }
 
+    /**
+     * Getter for CodeVerifier.
+     * Must be provided when using PKCE OAuth flow. The `code_verifier` will be used to verify
+     * against the `code_challenge` associated with the `authorization_code`.
+     * @return Returns the String
+     */
+    @JsonGetter("code_verifier")
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public String getCodeVerifier() {
+        return codeVerifier;
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(clientId, clientSecret, code, redirectUri, grantType, refreshToken,
-                migrationToken, scopes, shortLived);
+                migrationToken, scopes, shortLived, codeVerifier);
     }
 
     @Override
@@ -191,7 +207,8 @@ public boolean equals(Object obj) {
             && Objects.equals(refreshToken, other.refreshToken)
             && Objects.equals(migrationToken, other.migrationToken)
             && Objects.equals(scopes, other.scopes)
-            && Objects.equals(shortLived, other.shortLived);
+            && Objects.equals(shortLived, other.shortLived)
+            && Objects.equals(codeVerifier, other.codeVerifier);
     }
 
     /**
@@ -203,7 +220,8 @@ public String toString() {
         return "ObtainTokenRequest [" + "clientId=" + clientId + ", clientSecret=" + clientSecret
                 + ", grantType=" + grantType + ", code=" + code + ", redirectUri=" + redirectUri
                 + ", refreshToken=" + refreshToken + ", migrationToken=" + migrationToken
-                + ", scopes=" + scopes + ", shortLived=" + shortLived + "]";
+                + ", scopes=" + scopes + ", shortLived=" + shortLived + ", codeVerifier="
+                + codeVerifier + "]";
     }
 
     /**
@@ -218,7 +236,8 @@ public Builder toBuilder() {
                 .refreshToken(getRefreshToken())
                 .migrationToken(getMigrationToken())
                 .scopes(getScopes())
-                .shortLived(getShortLived());
+                .shortLived(getShortLived())
+                .codeVerifier(getCodeVerifier());
         return builder;
     }
 
@@ -235,6 +254,7 @@ public static class Builder {
         private String migrationToken;
         private List<String> scopes;
         private Boolean shortLived;
+        private String codeVerifier;
 
         /**
          * Initialization constructor.
@@ -338,13 +358,23 @@ public Builder shortLived(Boolean shortLived) {
             return this;
         }
 
+        /**
+         * Setter for codeVerifier.
+         * @param  codeVerifier  String value for codeVerifier.
+         * @return Builder
+         */
+        public Builder codeVerifier(String codeVerifier) {
+            this.codeVerifier = codeVerifier;
+            return this;
+        }
+
         /**
          * Builds a new {@link ObtainTokenRequest} object using the set fields.
          * @return {@link ObtainTokenRequest}
          */
         public ObtainTokenRequest build() {
             return new ObtainTokenRequest(clientId, clientSecret, grantType, code, redirectUri,
-                    refreshToken, migrationToken, scopes, shortLived);
+                    refreshToken, migrationToken, scopes, shortLived, codeVerifier);
         }
     }
 }

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

@@ -25,6 +25,9 @@ public class ObtainTokenResponse {
     private final String refreshToken;
     private final Boolean shortLived;
     private final List<Error> errors;
+    private final String refreshTokenExpiresAt;
+    private final String appSubscriptionId;
+    private final String appPlanId;
 
     /**
      * Initialization constructor.
@@ -38,6 +41,9 @@ public class ObtainTokenResponse {
      * @param  refreshToken  String value for refreshToken.
      * @param  shortLived  Boolean value for shortLived.
      * @param  errors  List of Error value for errors.
+     * @param  refreshTokenExpiresAt  String value for refreshTokenExpiresAt.
+     * @param  appSubscriptionId  String value for appSubscriptionId.
+     * @param  appPlanId  String value for appPlanId.
      */
     @JsonCreator
     public ObtainTokenResponse(
@@ -50,7 +56,10 @@ public ObtainTokenResponse(
             @JsonProperty("id_token") String idToken,
             @JsonProperty("refresh_token") String refreshToken,
             @JsonProperty("short_lived") Boolean shortLived,
-            @JsonProperty("errors") List<Error> errors) {
+            @JsonProperty("errors") List<Error> errors,
+            @JsonProperty("refresh_token_expires_at") String refreshTokenExpiresAt,
+            @JsonProperty("app_subscription_id") String appSubscriptionId,
+            @JsonProperty("app_plan_id") String appPlanId) {
         this.accessToken = accessToken;
         this.tokenType = tokenType;
         this.expiresAt = expiresAt;
@@ -61,6 +70,9 @@ public ObtainTokenResponse(
         this.refreshToken = refreshToken;
         this.shortLived = shortLived;
         this.errors = errors;
+        this.refreshTokenExpiresAt = refreshTokenExpiresAt;
+        this.appSubscriptionId = appSubscriptionId;
+        this.appPlanId = appPlanId;
     }
 
     @JsonIgnore
@@ -187,10 +199,47 @@ public List<Error> getErrors() {
         return errors;
     }
 
+    /**
+     * Getter for RefreshTokenExpiresAt.
+     * The date when the `refresh_token` expires, in [ISO
+     * 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format.
+     * @return Returns the String
+     */
+    @JsonGetter("refresh_token_expires_at")
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public String getRefreshTokenExpiresAt() {
+        return refreshTokenExpiresAt;
+    }
+
+    /**
+     * Getter for AppSubscriptionId.
+     * The subscription id of a v2 subscription the merchant signed up for. The subscription id is
+     * only present if the merchant signed up for a subscription during authorization.
+     * @return Returns the String
+     */
+    @JsonGetter("app_subscription_id")
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public String getAppSubscriptionId() {
+        return appSubscriptionId;
+    }
+
+    /**
+     * Getter for AppPlanId.
+     * The plan id of a v2 subscription plan the merchant signed up for. The plan id is only present
+     * if the merchant signed up for a subscription plan during authorization.
+     * @return Returns the String
+     */
+    @JsonGetter("app_plan_id")
+    @JsonInclude(JsonInclude.Include.NON_NULL)
+    public String getAppPlanId() {
+        return appPlanId;
+    }
+
     @Override
     public int hashCode() {
         return Objects.hash(accessToken, tokenType, expiresAt, merchantId, subscriptionId, planId,
-                idToken, refreshToken, shortLived, errors);
+                idToken, refreshToken, shortLived, errors, refreshTokenExpiresAt, appSubscriptionId,
+                appPlanId);
     }
 
     @Override
@@ -211,7 +260,10 @@ public boolean equals(Object obj) {
             && Objects.equals(idToken, other.idToken)
             && Objects.equals(refreshToken, other.refreshToken)
             && Objects.equals(shortLived, other.shortLived)
-            && Objects.equals(errors, other.errors);
+            && Objects.equals(errors, other.errors)
+            && Objects.equals(refreshTokenExpiresAt, other.refreshTokenExpiresAt)
+            && Objects.equals(appSubscriptionId, other.appSubscriptionId)
+            && Objects.equals(appPlanId, other.appPlanId);
     }
 
     /**
@@ -223,7 +275,9 @@ public String toString() {
         return "ObtainTokenResponse [" + "accessToken=" + accessToken + ", tokenType=" + tokenType
                 + ", expiresAt=" + expiresAt + ", merchantId=" + merchantId + ", subscriptionId="
                 + subscriptionId + ", planId=" + planId + ", idToken=" + idToken + ", refreshToken="
-                + refreshToken + ", shortLived=" + shortLived + ", errors=" + errors + "]";
+                + refreshToken + ", shortLived=" + shortLived + ", errors=" + errors
+                + ", refreshTokenExpiresAt=" + refreshTokenExpiresAt + ", appSubscriptionId="
+                + appSubscriptionId + ", appPlanId=" + appPlanId + "]";
     }
 
     /**
@@ -242,7 +296,10 @@ public Builder toBuilder() {
                 .idToken(getIdToken())
                 .refreshToken(getRefreshToken())
                 .shortLived(getShortLived())
-                .errors(getErrors());
+                .errors(getErrors())
+                .refreshTokenExpiresAt(getRefreshTokenExpiresAt())
+                .appSubscriptionId(getAppSubscriptionId())
+                .appPlanId(getAppPlanId());
         return builder;
     }
 
@@ -261,6 +318,9 @@ public static class Builder {
         private String refreshToken;
         private Boolean shortLived;
         private List<Error> errors;
+        private String refreshTokenExpiresAt;
+        private String appSubscriptionId;
+        private String appPlanId;
 
 
 
@@ -374,14 +434,45 @@ public Builder errors(List<Error> errors) {
             return this;
         }
 
+        /**
+         * Setter for refreshTokenExpiresAt.
+         * @param  refreshTokenExpiresAt  String value for refreshTokenExpiresAt.
+         * @return Builder
+         */
+        public Builder refreshTokenExpiresAt(String refreshTokenExpiresAt) {
+            this.refreshTokenExpiresAt = refreshTokenExpiresAt;
+            return this;
+        }
+
+        /**
+         * Setter for appSubscriptionId.
+         * @param  appSubscriptionId  String value for appSubscriptionId.
+         * @return Builder
+         */
+        public Builder appSubscriptionId(String appSubscriptionId) {
+            this.appSubscriptionId = appSubscriptionId;
+            return this;
+        }
+
+        /**
+         * Setter for appPlanId.
+         * @param  appPlanId  String value for appPlanId.
+         * @return Builder
+         */
+        public Builder appPlanId(String appPlanId) {
+            this.appPlanId = appPlanId;
+            return this;
+        }
+
         /**
          * Builds a new {@link ObtainTokenResponse} object using the set fields.
          * @return {@link ObtainTokenResponse}
          */
         public ObtainTokenResponse build() {
             ObtainTokenResponse model =
                     new ObtainTokenResponse(accessToken, tokenType, expiresAt, merchantId,
-                            subscriptionId, planId, idToken, refreshToken, shortLived, errors);
+                            subscriptionId, planId, idToken, refreshToken, shortLived, errors,
+                            refreshTokenExpiresAt, appSubscriptionId, appPlanId);
             model.httpContext = httpContext;
             return model;
         }