@fewcha/aptos/src/generated/services/GeneralService.ts

Aptos SDK

/* istanbul ignore file */
/* tslint:disable */
/* eslint-disable */
import type { HealthCheckSuccess } from '../models/HealthCheckSuccess';
import type { IndexResponse } from '../models/IndexResponse';

import type { CancelablePromise } from '../core/CancelablePromise';
import type { BaseHttpRequest } from '../core/BaseHttpRequest';

export class GeneralService {

    constructor(public readonly httpRequest: BaseHttpRequest) {}

    /**
     * Show OpenAPI explorer
     * Provides a UI that you can use to explore the API. You can also
     * retrieve the API directly at `/spec.yaml` and `/spec.json`.
     * @returns string
     * @throws ApiError
     */
    public spec(): CancelablePromise<string> {
        return this.httpRequest.request({
            method: 'GET',
            url: '/spec',
        });
    }

    /**
     * Check basic node health
     * By default this endpoint just checks that it can get the latest ledger
     * info and then returns 200.
     *
     * If the duration_secs param is provided, this endpoint will return a
     * 200 if the following condition is true:
     *
     * `server_latest_ledger_info_timestamp >= server_current_time_timestamp - duration_secs`
     * @param durationSecs Threshold in seconds that the server can be behind to be considered healthy
     *
     * If not provided, the healthcheck will always succeed
     * @returns HealthCheckSuccess
     * @throws ApiError
     */
    public healthy(
        durationSecs?: number,
    ): CancelablePromise<HealthCheckSuccess> {
        return this.httpRequest.request({
            method: 'GET',
            url: '/-/healthy',
            query: {
                'duration_secs': durationSecs,
            },
        });
    }

    /**
     * Get ledger info
     * Get the latest ledger information, including data such as chain ID,
     * role type, ledger versions, epoch, etc.
     * @returns IndexResponse
     * @throws ApiError
     */
    public getLedgerInfo(): CancelablePromise<IndexResponse> {
        return this.httpRequest.request({
            method: 'GET',
            url: '/',
        });
    }

}