Class StackingApi

Hierarchy

BaseAPI
- StackingApi

Implements

StackingApiInterface

Index

Constructors

constructor

new StackingApi(configuration?: Configuration): StackingApi
Parameters
- configuration: Configuration = ...
Returns StackingApi
Inherited from BaseAPI.constructor
- Defined in src/generated/runtime.ts:27

Properties

`Protected` configuration

configuration: Configuration = ...

Methods

getPoolDelegations

getPoolDelegations(requestParameters: GetPoolDelegationsRequest, initOverrides?: RequestInit): Promise<PoolDelegationsResponse>
Retrieves the list of stacking pool members for a given delegator principal. Stacking pool members
Parameters
- requestParameters: GetPoolDelegationsRequest
- Optional initOverrides: RequestInit
Returns Promise<PoolDelegationsResponse>
Implementation of StackingApiInterface.getPoolDelegations
- Defined in src/generated/apis/StackingApi.ts:108

getPoolDelegationsRaw

getPoolDelegationsRaw(requestParameters: GetPoolDelegationsRequest, initOverrides?: RequestInit): Promise<ApiResponse<PoolDelegationsResponse>>
Retrieves the list of stacking pool members for a given delegator principal. Stacking pool members
Parameters
- requestParameters: GetPoolDelegationsRequest
- Optional initOverrides: RequestInit
Returns Promise<ApiResponse<PoolDelegationsResponse>>
Implementation of StackingApiInterface.getPoolDelegationsRaw
- Defined in src/generated/apis/StackingApi.ts:69

`Protected` request

request(context: RequestOpts, initOverrides?: RequestInit): Promise<Response>
Parameters
- context: RequestOpts
- Optional initOverrides: RequestInit
Returns Promise<Response>
Inherited from BaseAPI.request
- Defined in src/generated/runtime.ts:47

withMiddleware

withMiddleware<T>(this: T, ...middlewares: Middleware[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...middlewares: Middleware[]
Returns T
Inherited from BaseAPI.withMiddleware
- Defined in src/generated/runtime.ts:31

withPostMiddleware

withPostMiddleware<T>(this: T, ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]
Returns T
Inherited from BaseAPI.withPostMiddleware
- Defined in src/generated/runtime.ts:42

withPreMiddleware

withPreMiddleware<T>(this: T, ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]): T
Type Parameters
- T extends BaseAPI<T>
Parameters
- this: T
- Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]
Returns T
Inherited from BaseAPI.withPreMiddleware
- Defined in src/generated/runtime.ts:37

Class StackingApi

Hierarchy

Implements

Index

Constructors

Properties

Methods

Constructors

constructor

Parameters

configuration: Configuration = ...

Returns StackingApi

Properties

Protected configuration

Methods

getPoolDelegations

Parameters

requestParameters: GetPoolDelegationsRequest

Optional initOverrides: RequestInit

Returns Promise<PoolDelegationsResponse>

getPoolDelegationsRaw

Parameters

requestParameters: GetPoolDelegationsRequest

Optional initOverrides: RequestInit

Returns Promise<ApiResponse<PoolDelegationsResponse>>

Protected request

Parameters

context: RequestOpts

Optional initOverrides: RequestInit

Returns Promise<Response>

withMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...middlewares: Middleware[]

Returns T

withPostMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

Returns T

withPreMiddleware

Type Parameters

T extends BaseAPI<T>

Parameters

this: T

Rest ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]

Returns T

Settings

Member Visibility

Theme

`Protected` configuration

`Optional` initOverrides: RequestInit

`Optional` initOverrides: RequestInit

`Protected` request

`Optional` initOverrides: RequestInit

`Rest` ...middlewares: Middleware[]

`Rest` ...postMiddlewares: ((context: ResponseContext) => Promise<void | Response>)[]

`Rest` ...preMiddlewares: ((context: RequestContext) => Promise<void | FetchParams>)[]