Class ConsensusApi

ConsensusApi - object-oriented interface

Export

ConsensusApi

Hierarchy

BaseAPI
- ConsensusApi

Index

Constructors

constructor

new ConsensusApi(
    configuration?: Configuration,
    basePath?: string,
    axios?: AxiosInstance,
): ConsensusApi
Parameters
- Optionalconfiguration: Configuration
- basePath: string = BASE_PATH
- axios: AxiosInstance = globalAxios
Returns ConsensusApi
Inherited from BaseAPI.constructor
- Defined in base.ts:53

Properties

`Protected`axios

axios: AxiosInstance = globalAxios

`Protected`basePath

basePath: string = BASE_PATH

`Protected`configuration

configuration: undefined | Configuration

Methods

consensusCreateMerge

consensusCreateMerge(
requestParameters?: ConsensusApiConsensusCreateMergeRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<void, any>>
Parameters
- requestParameters: ConsensusApiConsensusCreateMergeRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<void, any>>
Throws
Memberof
ConsensusApi
- Defined in api-client/consensus-api.ts:537

consensusListSettings

consensusListSettings(
requestParameters?: ConsensusApiConsensusListSettingsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<PaginatedConsensusSettingsList, any>>
Parameters
- requestParameters: ConsensusApiConsensusListSettingsRequest = {}
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<PaginatedConsensusSettingsList, any>>
Throws
Memberof
ConsensusApi
- Defined in api-client/consensus-api.ts:549

consensusPartialUpdateSettings

consensusPartialUpdateSettings(
requestParameters: ConsensusApiConsensusPartialUpdateSettingsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ConsensusSettings, any>>
Parameters
- requestParameters: ConsensusApiConsensusPartialUpdateSettingsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConsensusSettings, any>>
Throws
Memberof
ConsensusApi
- Defined in api-client/consensus-api.ts:561

consensusRetrieveSettings

consensusRetrieveSettings(
requestParameters: ConsensusApiConsensusRetrieveSettingsRequest,
options?: RawAxiosRequestConfig,
): Promise<AxiosResponse<ConsensusSettings, any>>
Parameters
- requestParameters: ConsensusApiConsensusRetrieveSettingsRequest
  Request parameters.
- Optionaloptions: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ConsensusSettings, any>>
Throws
Memberof
ConsensusApi
- Defined in api-client/consensus-api.ts:573

Class ConsensusApi

Export

Hierarchy

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ConsensusApi

Properties

Protectedaxios

ProtectedbasePath

Protectedconfiguration

Methods

consensusCreateMerge

Parameters

Returns Promise<AxiosResponse<void, any>>

Throws

Memberof

consensusListSettings

Parameters

Returns Promise<AxiosResponse<PaginatedConsensusSettingsList, any>>

Throws

Memberof

consensusPartialUpdateSettings

Parameters

Returns Promise<AxiosResponse<ConsensusSettings, any>>

Throws

Memberof

consensusRetrieveSettings

Parameters

Returns Promise<AxiosResponse<ConsensusSettings, any>>

Throws

Memberof

Settings

On This Page

`Protected`axios

`Protected`basePath

`Protected`configuration