@docusign/iam-sdk
Version:
Developer-friendly & type-safe Typescript SDK specifically catered to leverage *@docusign/iam-sdk* API.
80 lines • 3.25 kB
TypeScript
import * as z from "zod/v3";
import { ClosedEnum } from "../../types/enums.js";
import { Result as SafeParseResult } from "../../types/fp.js";
import { SDKValidationError } from "../errors/sdkvalidationerror.js";
export declare const GetTokenFromRefreshTokenServerList: readonly ["https://account-d.docusign.com", "https://account.docusign.com"];
export type GetTokenFromRefreshTokenSecurity = {
clientId?: string | undefined;
secretKey?: string | undefined;
};
/**
* The grant type. This value must be set to "refresh_token".
*/
export declare const GetTokenFromRefreshTokenGrantType: {
readonly RefreshToken: "refresh_token";
};
/**
* The grant type. This value must be set to "refresh_token".
*/
export type GetTokenFromRefreshTokenGrantType = ClosedEnum<typeof GetTokenFromRefreshTokenGrantType>;
/**
* This grant optionally uses Proof Key for Code Exchange (PKCE) to authenticate securely without requiring a client secret.
*/
export type AuthorizationCodeGrant = {
/**
* The grant type. This value must be set to "refresh_token".
*/
grantType?: GetTokenFromRefreshTokenGrantType | undefined;
/**
* The refresh token supplied to the callback.
*/
refreshToken: string;
/**
* The client ID.
*/
clientId?: string | undefined;
};
/**
* Successful response.
*/
export type GetTokenFromRefreshTokenResponse = {
/**
* The value of the access token. This value will be added to the Authorization header of all Docusign API calls.
*/
accessToken: string;
/**
* The type of token. For access tokens, the value of this will be Bearer.
*/
tokenType: string;
/**
* The refresh token.
*/
refreshToken: string;
/**
* The number of seconds until the access token expires.
*/
expiresIn: number;
};
/** @internal */
export type GetTokenFromRefreshTokenSecurity$Outbound = {
clientId?: string | undefined;
secretKey?: string | undefined;
};
/** @internal */
export declare const GetTokenFromRefreshTokenSecurity$outboundSchema: z.ZodType<GetTokenFromRefreshTokenSecurity$Outbound, z.ZodTypeDef, GetTokenFromRefreshTokenSecurity>;
export declare function getTokenFromRefreshTokenSecurityToJSON(getTokenFromRefreshTokenSecurity: GetTokenFromRefreshTokenSecurity): string;
/** @internal */
export declare const GetTokenFromRefreshTokenGrantType$outboundSchema: z.ZodNativeEnum<typeof GetTokenFromRefreshTokenGrantType>;
/** @internal */
export type AuthorizationCodeGrant$Outbound = {
grant_type: string;
refresh_token: string;
client_id?: string | undefined;
};
/** @internal */
export declare const AuthorizationCodeGrant$outboundSchema: z.ZodType<AuthorizationCodeGrant$Outbound, z.ZodTypeDef, AuthorizationCodeGrant>;
export declare function authorizationCodeGrantToJSON(authorizationCodeGrant: AuthorizationCodeGrant): string;
/** @internal */
export declare const GetTokenFromRefreshTokenResponse$inboundSchema: z.ZodType<GetTokenFromRefreshTokenResponse, z.ZodTypeDef, unknown>;
export declare function getTokenFromRefreshTokenResponseFromJSON(jsonString: string): SafeParseResult<GetTokenFromRefreshTokenResponse, SDKValidationError>;
//# sourceMappingURL=gettokenfromrefreshtoken.d.ts.map