@itwin/access-control-client
Version:
Access control client for the iTwin platform
34 lines • 1.52 kB
TypeScript
/** @packageDocumentation
* @module AccessControlClient
*/
import type { AccessToken } from "@itwin/core-bentley";
import type { Method } from "axios";
import type { AxiosRequestConfig } from "axios";
import type { AccessControlAPIResponse, AccessControlQueryArg } from "../accessControlTypes";
export declare class BaseClient {
protected _baseUrl: string;
constructor(url?: string);
/**
* Sends a basic API request
* @param accessTokenString The client access token string
* @param method The method type of the request (ex. GET, POST, DELETE, etc)
* @param url The url of the request
*/
protected sendGenericAPIRequest(accessToken: AccessToken, method: Method, url: string, data?: any, property?: string, additionalHeaders?: {
[key: string]: string;
}): Promise<AccessControlAPIResponse<any>>;
/**
* Build the request methods, headers, and other options
* @param accessTokenString The client access token string
*/
protected getRequestOptions(accessTokenString: string, method: Method, url: string, data?: any, additionalHeaders?: {
[key: string]: string;
}): AxiosRequestConfig;
/**
* Build a query to be appended to a URL
* @param queryArg Object container queryable properties
* @returns query string with AccessControlQueryArg applied, which should be appended to a url
*/
protected getQueryString(queryArg: AccessControlQueryArg): string;
}
//# sourceMappingURL=BaseClient.d.ts.map