@finagraph/strongbox-finconnect-react/dist/Models/Api/ClientBase.d.ts

React components to integrate with Finagraph Strongbox

/** Defines what a delegated access token is to be used for. */
export type DelegatedAccessTokenPurpose = "ConnectAccountingSystem" | "ConnectionManagement";
/** A Delegated Access Token response. */
export interface IDelegatedAccessToken {
    /** A JWT access token. */
    accessToken: string;
    /** An identifier for the entity to which access is being delegated. */
    actorId: string;
    /** The UTC time after which the access token is no longer valid. */
    expiration: string;
    /** Specifies what the delegated access token is to be used for. */
    purpose: DelegatedAccessTokenPurpose[];
    /** The Authorization header scheme to use when presenting the token. Only "Bearer" is supported at this time. */
    tokenType: string;
}
/**
 * Base class for Api Clients, handling Auth and transformation of requests.
 */
export declare abstract class ClientBase {
    /**
     * If the currently Access Token in use expires, this will be called in an attempt to get a new one.
     * @returns Promise which resolves to a new Access Token.
     */
    onTokenExpired: (() => Promise<IDelegatedAccessToken>) | undefined;
    private _token;
    /**
     * Create an ClientBase base class.
     * @param accessToken An access token to use to authenticate/authorize requests.
     * @param onTokenExpired Function to call when currently registered token is expired to attempt to
     * retrieve a new one.
     */
    constructor(accessToken: IDelegatedAccessToken);
    /**
     * Validate and transform RequestInit for making requests to Strongbox.
     * @param options Fetch RequestInit to transform.
     */
    transformOptions(options: RequestInit): Promise<RequestInit>;
}