Class ServerSignersApi

ServerSignersApi - object-oriented interface

Export

ServerSignersApi

Hierarchy (view full)

BaseAPI
- ServerSignersApi

Implements

ServerSignersApiInterface

Index

Constructors

constructor

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

Properties

`Protected` axios

axios: AxiosInstance = globalAxios

`Protected` basePath

basePath: string = BASE_PATH

`Protected` configuration

configuration: undefined | Configuration

Methods

createServerSigner

createServerSigner(createServerSignerRequest?, options?): Promise<AxiosResponse<ServerSigner, any>>
Create a new Server-Signer
Parameters
- Optional createServerSignerRequest: CreateServerSignerRequest
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ServerSigner, any>>
Summary
Create a new Server-Signer

Throws
Memberof
ServerSignersApi
Implementation of ServerSignersApiInterface.createServerSigner
- Defined in src/client/api.ts:9088

getServerSigner

getServerSigner(serverSignerId, options?): Promise<AxiosResponse<ServerSigner, any>>
Get a server signer by ID
Parameters
- serverSignerId: string
  The ID of the server signer to fetch
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ServerSigner, any>>
Summary
Get a server signer by ID

Throws
Memberof
ServerSignersApi
Implementation of ServerSignersApiInterface.getServerSigner
- Defined in src/client/api.ts:9100

listServerSignerEvents

listServerSignerEvents(serverSignerId, limit?, page?, options?): Promise<AxiosResponse<ServerSignerEventList, any>>
List events for a server signer
Parameters
- serverSignerId: string
  The ID of the server signer to fetch events for
- Optional limit: number
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- Optional page: string
  A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ServerSignerEventList, any>>
Summary
List events for a server signer

Deprecated
Throws
Memberof
ServerSignersApi
Implementation of ServerSignersApiInterface.listServerSignerEvents
- Defined in src/client/api.ts:9115

listServerSigners

listServerSigners(limit?, page?, options?): Promise<AxiosResponse<ServerSignerList, any>>
List server signers for the current project
Parameters
- Optional limit: number
  A limit on the number of objects to be returned. Limit can range between 1 and 100, and the default is 10.
- Optional page: string
  A cursor for pagination across multiple pages of results. Don't include this parameter on the first call. Use the next_page value returned in a previous response to request subsequent results.
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<ServerSignerList, any>>
Summary
List server signers for the current project

Throws
Memberof
ServerSignersApi
Implementation of ServerSignersApiInterface.listServerSigners
- Defined in src/client/api.ts:9128

submitServerSignerSeedEventResult

submitServerSignerSeedEventResult(serverSignerId, seedCreationEventResult?, options?): Promise<AxiosResponse<SeedCreationEventResult, any>>
Submit the result of a server signer event
Parameters
- serverSignerId: string
  The ID of the server signer to submit the event result for
- Optional seedCreationEventResult: SeedCreationEventResult
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SeedCreationEventResult, any>>
Summary
Submit the result of a server signer event

Throws
Memberof
ServerSignersApi
Implementation of ServerSignersApiInterface.submitServerSignerSeedEventResult
- Defined in src/client/api.ts:9141

submitServerSignerSignatureEventResult

submitServerSignerSignatureEventResult(serverSignerId, signatureCreationEventResult?, options?): Promise<AxiosResponse<SignatureCreationEventResult, any>>
Submit the result of a server signer event
Parameters
- serverSignerId: string
  The ID of the server signer to submit the event result for
- Optional signatureCreationEventResult: SignatureCreationEventResult
- Optional options: RawAxiosRequestConfig
  Override http request option.
Returns Promise<AxiosResponse<SignatureCreationEventResult, any>>
Summary
Submit the result of a server signer event

Throws
Memberof
ServerSignersApi
Implementation of ServerSignersApiInterface.submitServerSignerSignatureEventResult
- Defined in src/client/api.ts:9154

Class ServerSignersApi

Export

Hierarchy (view full)

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

Returns ServerSignersApi

Properties

Protected axios

Protected basePath

Protected configuration

Methods

createServerSigner

Parameters

Returns Promise<AxiosResponse<ServerSigner, any>>

Summary

Throws

Memberof

getServerSigner

Parameters

Returns Promise<AxiosResponse<ServerSigner, any>>

Summary

Throws

Memberof

listServerSignerEvents

Parameters

Returns Promise<AxiosResponse<ServerSignerEventList, any>>

Summary

Deprecated

Throws

Memberof

listServerSigners

Parameters

Returns Promise<AxiosResponse<ServerSignerList, any>>

Summary

Throws

Memberof

submitServerSignerSeedEventResult

Parameters

Returns Promise<AxiosResponse<SeedCreationEventResult, any>>

Summary

Throws

Memberof

submitServerSignerSignatureEventResult

Parameters

Returns Promise<AxiosResponse<SignatureCreationEventResult, any>>

Summary

Throws

Memberof

Settings

Member Visibility

Theme

On This Page

`Protected` axios

`Protected` basePath

`Protected` configuration