Class NodesApi

NodesApi - object-oriented interface

export

Hierarchy

BaseAPI
- NodesApi

Index

Constructors

constructor

Properties

Methods

Constructors

constructor

new NodesApi(configuration?: Configuration, basePath?: string, axios?: AxiosInstance): NodesApi

Inherited from BaseAPI.constructor
- Defined in api/base.ts:50
Parameters
- Optional configuration: Configuration
- basePath: string = ...
- axios: AxiosInstance = ...
Returns NodesApi

Properties

Protected axios

axios: AxiosInstance = ...

Protected basePath

basePath: string = ...

Protected configuration

configuration: undefined | Configuration

Methods

createaNewNode

createaNewNode(requestParameters: NodesApiCreateaNewNodeRequest, options?: any): Promise<AxiosResponse<NodesResponse>>

- Defined in api/api.ts:9109
Create a new transfer node. User must be an organization admin.

summary

Create a New Node

throws

{RequiredError}

memberof

NodesApi

Parameters
- requestParameters: NodesApiCreateaNewNodeRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<NodesResponse>>

deleteaSpecificNode

deleteaSpecificNode(requestParameters: NodesApiDeleteaSpecificNodeRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:9121
Delete a specific transfer node, as specified by node ID. User must be an organization admin.

summary

Delete a Specific Node

throws

{RequiredError}

memberof

NodesApi

Parameters
- requestParameters: NodesApiDeleteaSpecificNodeRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>

getInformationonaSpecificNode

getInformationonaSpecificNode(requestParameters: NodesApiGetInformationonaSpecificNodeRequest, options?: any): Promise<AxiosResponse<NodesResponse>>

- Defined in api/api.ts:9133
Retrieve information about a specific transfer node.

summary

Get Information on a Specific Node

throws

{RequiredError}

memberof

NodesApi

Parameters
- requestParameters: NodesApiGetInformationonaSpecificNodeRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<NodesResponse>>

getaListingofAllNodes

getaListingofAllNodes(requestParameters?: NodesApiGetaListingofAllNodesRequest, options?: any): Promise<AxiosResponse<NodesResponse[]>>

- Defined in api/api.ts:9145
Get information about all transfer nodes belonging to your organization.

summary

Get a Listing of All Nodes

throws

{RequiredError}

memberof

NodesApi

Parameters
- requestParameters: NodesApiGetaListingofAllNodesRequest = {}
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<NodesResponse[]>>

updateaNode

updateaNode(requestParameters: NodesApiUpdateaNodeRequest, options?: any): Promise<AxiosResponse<void>>

- Defined in api/api.ts:9157
Make changes to an existing transfer node. User must be an organization admin.

summary

Update a Node

throws

{RequiredError}

memberof

NodesApi

Parameters
- requestParameters: NodesApiUpdateaNodeRequest
  
  Request parameters.
- Optional options: any
Returns Promise<AxiosResponse<void>>