@qbraid-core/base
Version:
Core functionality for interacting with qBraid Cloud Services.
40 lines (39 loc) • 1.25 kB
TypeScript
/**
* Module for making requests to the qBraid API v1.
*/
import { AxiosInstance } from 'axios';
export declare const DEFAULT_USER_DOMAIN = "qbraid.com";
export declare const DEFAULT_BASE_URL = "https://api-staging.qbraid.com/api/v1";
export interface AuthDataV1 {
apiKey?: string;
accessToken?: string;
}
export interface QbraidSessionV1Options {
apiKey?: string;
accessToken?: string;
userDomain?: string;
baseURL?: string;
}
export declare class QbraidSessionV1 {
private apiKey?;
private accessToken?;
private userDomain;
private baseURL;
client: AxiosInstance;
/**
* Construct a session.
*
* Accepts either:
* - new QbraidSessionV1(apiKey, userDomain?, baseURL?) // legacy positional
* - new QbraidSessionV1({ apiKey?, accessToken?, userDomain?, baseURL? })
*
* If neither apiKey nor accessToken is provided, falls back to the
* QBRAID_ACCESS_TOKEN environment variable.
*/
constructor(apiKeyOrOptions?: string | QbraidSessionV1Options, userDomain?: string, baseURL?: string);
private authDataToHeaders;
private normalizeBaseURL;
private getUserAgent;
addUserAgent(userAgent: string): void;
private initializeClient;
}