v1.4.0

Author: zeplin-dev

src/apis/authorization-api.ts

@@ -42,7 +42,15 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
          * @param {*} [options] Override http request option.
          * @throws {RequiredError}
          */
-        oAuthAuthorize: (responseType: string, clientId: string, redirectUri: string, state?: string, options: any = {}): RequestArgs => {
+        oAuthAuthorize: (
+            responseType: string, 
+            clientId: string, 
+            redirectUri: string, 
+            state?: string, 
+            codeChallenge?: string, 
+            codeChallengeMethod?: string, 
+            options: any = {}
+        ): RequestArgs => {
             // verify required parameter 'responseType' is not null or undefined
             assertParamExists('oAuthAuthorize', 'responseType', responseType)
             // verify required parameter 'clientId' is not null or undefined
@@ -77,6 +85,14 @@ export const AuthorizationApiAxiosParamCreator = function (configuration?: Confi
                 localVarQueryParameter['state'] = state;
             }
 
+            if (codeChallenge !== undefined) {
+                localVarQueryParameter['code_challenge'] = codeChallenge;
+                localVarQueryParameter['code_challenge_method'] = 'S256';
+            }
+
+            if (codeChallengeMethod !== undefined) {
+                localVarQueryParameter['code_challenge_method'] = codeChallengeMethod;
+            }
 
             setSearchParams(localVarUrlObj, localVarQueryParameter, options.query);
             let headersFromBaseOptions = baseOptions && baseOptions.headers ? baseOptions.headers : {};
@@ -174,6 +190,20 @@ export interface AuthorizationApiGetAuthorizationUrlSearchParams {
      * @memberof AuthorizationApiGetAuthorizationUrlSearchParams
      */
     readonly state?: string
+
+    /**
+     * RECOMMENDED. A PKCE code challenge derived from the code verifier, to be verified against later.
+     * @type {string}
+     * @memberof AuthorizationApiGetAuthorizationUrlSearchParams
+     */
+    readonly codeChallenge?: string
+
+    /**
+     * RECOMMENDED. PKCE code verifier transformation method.
+     * @type {string}
+     * @memberof AuthorizationApiGetAuthorizationUrlSearchParams
+     */
+    readonly codeChallengeMethod?: string
 }
 
 
@@ -206,7 +236,13 @@ export interface AuthorizationApiCreateTokenParams {
      * @type {string}
      * @memberof AuthorizationApiCreateTokenParams
      */
-    clientSecret: string;
+    clientSecret?: string;
+    /**
+     * A cryptographically random string that is used to correlate the authorization request to the token request
+     * @type {string}
+     * @memberof AuthorizationApiCreateTokenParams
+     */
+    codeVerifier?: string;
 }
 
 
@@ -233,7 +269,13 @@ export interface AuthorizationApiRefreshTokenParams {
      * @type {string}
      * @memberof AuthorizationApiRefreshTokenParams
      */
-    clientSecret: string;
+    clientSecret?: string;
+    /**
+     * A cryptographically random string that is used to correlate the authorization request to the token request
+     * @type {string}
+     * @memberof AuthorizationApiRefreshTokenParams
+     */
+    codeVerifier?: string;
 }
 
 
@@ -256,7 +298,15 @@ export class AuthorizationApi extends BaseAPI {
      */
     public getAuthorizationUrl(searchParams: AuthorizationApiGetAuthorizationUrlSearchParams, options?: any): string {
         const paramCreator = AuthorizationApiAxiosParamCreator(this.configuration);
-        const params = paramCreator.oAuthAuthorize("code", searchParams.clientId, searchParams.redirectUri, searchParams.state, options);
+        const params = paramCreator.oAuthAuthorize(
+            "code", 
+            searchParams.clientId, 
+            searchParams.redirectUri, 
+            searchParams.state, 
+            searchParams.codeChallenge, 
+            searchParams.codeChallengeMethod, 
+            options
+        );
         return this.axios.getUri({
             ...params.options,
             url: this.basePath + params.url

src/models/token-create-authorization-code-body.ts

@@ -20,7 +20,8 @@ export const transformTokenCreateAuthorizationCodeBodyToJSON = function (value:
         code: value.code,
         redirect_uri: value.redirectUri,
         client_id: value.clientId,
-        client_secret: value.clientSecret
+        client_secret: value.clientSecret,
+        code_verifier: value.codeVerifier
     }
 }
 
@@ -30,7 +31,8 @@ export const transformJSONToTokenCreateAuthorizationCodeBody = function (value:
         code: value.code,
         redirectUri: value.redirect_uri,
         clientId: value.client_id,
-        clientSecret: value.client_secret
+        clientSecret: value.client_secret,
+        codeVerifier: value.code_verifier
     }
 }
 
@@ -65,11 +67,17 @@ export interface TokenCreateAuthorizationCodeBody {
      */
     clientId: string;
     /**
-     * The `client_secret` of your Zeplin app
+     * The `client_secret` of your Zeplin app  **Note**: `client_secret` is required for `code` values obtained without using a PKCE `code_challenge` value.  **Warning**: `client_secret` property should only be used in a server-side application.  If your Zeplin app is a public client, you should use PKCE authorization flow. 
      * @type {string}
      * @memberof TokenCreateAuthorizationCodeBody
      */
-    clientSecret: string;
+    clientSecret?: string;
+    /**
+     * A cryptographically random string that is used to correlate the authorization request to the token request
+     * @type {string}
+     * @memberof TokenCreateAuthorizationCodeBody
+     */
+    codeVerifier?: string;
 }
 
 

src/models/token-create-refresh-token-body.ts

@@ -19,7 +19,8 @@ export const transformTokenCreateRefreshTokenBodyToJSON = function (value: Token
         grant_type: value.grantType,
         refresh_token: value.refreshToken,
         client_id: value.clientId,
-        client_secret: value.clientSecret
+        client_secret: value.clientSecret,
+        code_verifier: value.codeVerifier
     }
 }
 
@@ -28,7 +29,8 @@ export const transformJSONToTokenCreateRefreshTokenBody = function (value: any):
         grantType: value.grant_type,
         refreshToken: value.refresh_token,
         clientId: value.client_id,
-        clientSecret: value.client_secret
+        clientSecret: value.client_secret,
+        codeVerifier: value.code_verifier
     }
 }
 
@@ -57,11 +59,17 @@ export interface TokenCreateRefreshTokenBody {
      */
     clientId: string;
     /**
-     * The `client_secret` of your Zeplin app
+     * The `client_secret` of your Zeplin app  **Note**: `client_secret` is required for `code` values obtained without using a PKCE `code_challenge` value.  **Warning**: `client_secret` property should only be used in a server-side application.  If your Zeplin app is a public client, you should use PKCE authorization flow. 
      * @type {string}
      * @memberof TokenCreateRefreshTokenBody
      */
-    clientSecret: string;
+    clientSecret?: string;
+    /**
+     * A cryptographically random string that is used to correlate the authorization request to the token request
+     * @type {string}
+     * @memberof TokenCreateRefreshTokenBody
+     */
+    codeVerifier?: string;
 }