btcpay-greenfield-node-client
Version:
## Installation
46 lines (45 loc) • 1.52 kB
TypeScript
import type { ApiKeyData } from '../models/ApiKeyData';
export declare class ApiKeysService {
/**
* Revoke an API Key
* Revoke the current API key so that it cannot be used anymore
* @returns any The key has been deleted
* @throws ApiError
*/
static deleteApiKeysService({ apikey, }: {
/** The API Key to revoke **/
apikey: string;
}): Promise<any>;
/**
* Get the current API Key information
* View information about the current API key
* @returns ApiKeyData Information about the current api key
* @throws ApiError
*/
static getApiKeysService(): Promise<ApiKeyData>;
/**
* Revoke the current API Key
* Revoke the current API key so that it cannot be used anymore
* @returns ApiKeyData The key was revoked and is no longer usable
* @throws ApiError
*/
static deleteApiKeysService1(): Promise<ApiKeyData>;
/**
* Create a new API Key
* Create a new API Key
* @returns ApiKeyData Information about the new api key
* @throws ApiError
*/
static postApiKeysService({ requestBody, }: {
requestBody?: {
/**
* The label of the new API Key
*/
label?: string | null;
/**
* The permissions granted to this API Key (See API Key Authentication)
*/
permissions?: Array<string> | null;
};
}): Promise<ApiKeyData>;
}