Class Networks

Hierarchy

TagoIOModule<GenericModuleParams>
- Networks

Index

Constructors

constructor

Methods

Constructors

constructor

new Networks(params: GenericModuleParams): Networks

Inherited from TagoIOModule<GenericModuleParams>.constructor
- Defined in src/common/TagoIOModule.ts:79
Parameters
- params: GenericModuleParams
Returns Networks

Methods

create

create(connectorObj: NetworkCreateInfo): Promise<{ network: string }>

- Defined in src/modules/Account/Integration.Networks.ts:58
Generates and retrieves a new network from the account

Parameters
- connectorObj: NetworkCreateInfo
  
  Object data to create new Network
Returns Promise<{ network: string }>

edit

edit(networkID: string, connectorObj: Partial<NetworkCreateInfo>): Promise<string>

- Defined in src/modules/Account/Integration.Networks.ts:75
Modify any property of the network

Parameters
- networkID: string
  
  Network identification
- connectorObj: Partial<NetworkCreateInfo>
  
  Object data to create new Network
Returns Promise<string>

info

info(networkID: string, fields?: string[]): Promise<NetworkInfo>

- Defined in src/modules/Account/Integration.Networks.ts:42
Get Info of the Network

Parameters
- networkID: string
  
  Network identification
- fields: string[] = ...
  
  Fields to fetch.
Returns Promise<NetworkInfo>

list

list(queryObj?: NetworkQuery): Promise<NetworkInfo[]>

- Defined in src/modules/Account/Integration.Networks.ts:21
Retrieves a list with all Networks from account
default
```
queryObj: {
  page: 1,
  fields: ["id", "name"],
  filter: {},
  amount: 20,
  orderBy: "name,asc",
}
```
Parameters
- Optional queryObj: NetworkQuery
  
  Search query params
Returns Promise<NetworkInfo[]>

tokenCreate

tokenCreate(networkID: string, tokenParams: TokenData): Promise<TokenCreateResponse>

- Defined in src/modules/Account/Integration.Networks.ts:125
Generates and retrieves a new token

Parameters
- networkID: string
  
  Network ID
- tokenParams: TokenData
  
  Details of new token
Returns Promise<TokenCreateResponse>

tokenDelete

tokenDelete(token: string): Promise<string>

- Defined in src/modules/Account/Integration.Networks.ts:139
Deletes a token

Parameters
- token: string
  
  Token ID
Returns Promise<string>

tokenList

tokenList(networkID: string, queryObj?: ListTokenQuery): Promise<Partial<NetworkTokenInfo>[]>

- Defined in src/modules/Account/Integration.Networks.ts:102
Retrieves a list of all tokens
default
```
queryObj: {
  page: 1,
  fields: ["name", "token", "permission"],
  filter: {},
  amount: 20,
  orderBy: "created_at,desc",
}
```
Parameters
- networkID: string
  
  Network ID
- Optional queryObj: ListTokenQuery
  
  Search query params
Returns Promise<Partial<NetworkTokenInfo>[]>