quickbooks-api/dist/types/interfaces/token.d.ts

A modular TypeScript SDK for seamless integration with Intuit QuickBooks APIs. Provides robust authentication handling and future-ready foundation for accounting, payments, and commerce operations.

import type { TokenType } from '../types.js';
import type { IdToken } from './id-token.js';
import type { UserProfile } from './user-profile.js';
/**
 * The Token Object
 */
export interface Token {
    /**
     * The type of token
     */
    tokenType: TokenType;
    /**
     * The refresh token
     */
    refreshToken: string;
    /**
     * The expiration time of the refresh token
     */
    refreshTokenExpiryDate: Date;
    /**
     * The access token
     */
    accessToken: string;
    /**
     * The expiration time of the access token
     */
    accessTokenExpiryDate: Date;
    /**
     * The realm ID
     */
    realmId: string;
    /**
     * The ID token from OpenID Connect (present when openid scope is requested)
     */
    idToken?: IdToken;
    /**
     * The user profile information (present when SSO is used)
     */
    userProfile?: UserProfile;
}