Merge pull request #99 from square/release/20.1.0

Generated PR for Release: 20.1.0

Author: joanc-sq

doc/models/obtain-token-request.md

@@ -18,6 +18,7 @@
 | `migrationToken` | `string \| undefined` | 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` |
 | `scopes` | `string[] \| undefined` | 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. |
 | `shortLived` | `boolean \| undefined` | 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. |
+| `codeVerifier` | `string \| undefined` | 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`. |
 
 ## Example (as JSON)
 

doc/models/obtain-token-response.md

@@ -19,6 +19,9 @@
 | `refreshToken` | `string \| undefined` | 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` |
 | `shortLived` | `boolean \| undefined` | 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. |
 | `errors` | [`Error[] \| undefined`](../../doc/models/error.md) | Optional | Any errors that occurred during the request. |
+| `refreshTokenExpiresAt` | `string \| undefined` | 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` |
+| `appSubscriptionId` | `string \| undefined` | 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. |
+| `appPlanId` | `string \| undefined` | 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. |
 
 ## Example (as JSON)
 

package.json

@@ -1,5 +1,5 @@
 {
-  "version": "20.0.0",
+  "version": "20.1.0",
   "license": "MIT",
   "sideEffects": false,
   "main": "dist/index.js",

src/client.ts

@@ -63,7 +63,7 @@ import {
 import { XmlSerialization } from './http/xmlSerialization';
 
 /** Current SDK version */
-export const SDK_VERSION = '20.0.0';
+export const SDK_VERSION = '20.1.0';
 export class Client implements ClientInterface {
   private _config: Readonly<Configuration>;
   private _timeout: number;
@@ -122,7 +122,7 @@ export class Client implements ClientInterface {
         ? this._config.httpClientOptions.timeout
         : this._config.timeout;
     this._userAgent = updateUserAgent(
-      'Square-TypeScript-SDK/20.0.0 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}',
+      'Square-TypeScript-SDK/20.1.0 ({api-version}) {engine}/{engine-version} ({os-info}) {detail}',
       this._config.squareVersion,
       this._config.userAgentDetail
     );

src/models/obtainTokenRequest.ts

@@ -51,6 +51,11 @@ export interface ObtainTokenRequest {
    * The short-lived access token returned in the response expires in 24 hours.
    */
   shortLived?: boolean;
+  /**
+   * 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`.
+   */
+  codeVerifier?: string;
 }
 
 export const obtainTokenRequestSchema: Schema<ObtainTokenRequest> = object({
@@ -63,4 +68,5 @@ export const obtainTokenRequestSchema: Schema<ObtainTokenRequest> = object({
   migrationToken: ['migration_token', optional(string())],
   scopes: ['scopes', optional(array(string()))],
   shortLived: ['short_lived', optional(boolean())],
+  codeVerifier: ['code_verifier', optional(string())],
 });

src/models/obtainTokenResponse.ts

@@ -50,6 +50,18 @@ export interface ObtainTokenResponse {
   shortLived?: boolean;
   /** Any errors that occurred during the request. */
   errors?: Error[];
+  /** The date when the `refresh_token` expires, in [ISO 8601](http://www.iso.org/iso/home/standards/iso8601.htm) format. */
+  refreshTokenExpiresAt?: string;
+  /**
+   * 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.
+   */
+  appSubscriptionId?: string;
+  /**
+   * 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.
+   */
+  appPlanId?: string;
 }
 
 export const obtainTokenResponseSchema: Schema<ObtainTokenResponse> = object({
@@ -63,4 +75,7 @@ export const obtainTokenResponseSchema: Schema<ObtainTokenResponse> = object({
   refreshToken: ['refresh_token', optional(string())],
   shortLived: ['short_lived', optional(boolean())],
   errors: ['errors', optional(array(lazy(() => errorSchema)))],
+  refreshTokenExpiresAt: ['refresh_token_expires_at', optional(string())],
+  appSubscriptionId: ['app_subscription_id', optional(string())],
+  appPlanId: ['app_plan_id', optional(string())],
 });