up-bank-typescript
Version:
Typescript wrapper for Up Bank API
17 lines (16 loc) • 601 B
TypeScript
import { Fetch } from '../fetch';
import { PingResponse } from './types';
/**
* Some endpoints exist not to expose data, but to test the API itself.
* Currently there is only one endpoint in this group: ping!
*/
export declare class Util {
private fetch;
constructor(fetch: Fetch);
/**
* Make a basic ping request to the API. This is useful to verify that
* authentication is functioning correctly. On authentication success an HTTP
* 200 status is returned. On failure an HTTP 401 error response is returned.
*/
ping(): Promise<PingResponse>;
}