CommonService
Constructors
new CommonService()
new CommonService(
httpRequest):CommonService
Parameters
• httpRequest: BaseHttpRequest
Returns
Defined in
services.gen.ts:1280
Properties
httpRequest
readonlyhttpRequest:BaseHttpRequest
Defined in
services.gen.ts:1280
Methods
getGenesis()
getGenesis():
CancelablePromise<string>
Gets the genesis information. Returns the entire genesis file in json.
Returns
CancelablePromise<string>
string The genesis file in json.
Throws
ApiError
Defined in
services.gen.ts:1288
getReady()
getReady():
CancelablePromise<unknown>
Returns OK if healthy and fully caught up.
Returns
CancelablePromise<unknown>
unknown OK.
Throws
ApiError
Defined in
services.gen.ts:1333
getVersion()
getVersion():
CancelablePromise<Version>
Retrieves the supported API versions, binary build versions, and genesis information.
Returns
Version VersionsResponse is the response to ‘GET /versions’
Throws
ApiError
Defined in
services.gen.ts:1366
healthCheck()
healthCheck():
CancelablePromise<unknown>
Returns OK if healthy.
Returns
CancelablePromise<unknown>
unknown OK.
Throws
ApiError
Defined in
services.gen.ts:1303
metrics()
metrics():
CancelablePromise<unknown>
Return metrics about algod functioning.
Returns
CancelablePromise<unknown>
unknown text with #-comments and key:value lines
Throws
ApiError
Defined in
services.gen.ts:1318
swaggerJson()
swaggerJson():
CancelablePromise<string>
Gets the current swagger spec. Returns the entire swagger spec in json.
Returns
CancelablePromise<string>
string The current swagger spec
Throws
ApiError
Defined in
services.gen.ts:1351