Module: AccountsApi

API for interacting with accounts.

More info: https://dashboard.seq.com/docs/accounts

Methods


<inner> create(params)

Create a new account.

Parameters:
Name Type Description
params module:AccountsApi~createRequest

Parameters for account creation.

Returns:

Newly created account.

Type
Promise.<Account>

<inner> list(params)

Query a list of accounts matching the specified query.

Parameters:
Name Type Default Description
params Object {}

Filter information.

Properties
Name Type Description
filter String

Filter string, see https://dashboard.seq.com/docs/filters.

filterParams Array.<(String|Number)>

Parameter values for filter string (if needed).

Returns:

Query to retrieve results.

Type
Query

<inner> updateTags(params)

Update account tags.

Parameters:
Name Type Description
params module:AccountsApi~updateTagsRequest

Parameters for updating account tags.

Returns:

Success message.

Type
Promise.<Object>

Type Definitions


createRequest

Type:
  • Object
Properties:
Name Type Argument Description
id String <optional>

Unique identifier. Will be auto-generated if not provided.

keyIds Array.<String>

The list of IDs for the keys that control the account.

quorum Number <optional>

The number of keys required to sign transactions that transfer or retire tokens from the account. Defaults to the number of keys provided.

tags Object <optional>

User-specified tag structure for the account.


updateTagsRequest

Type:
  • Object
Properties:
Name Type Argument Description
id String <optional>

The account ID.

tags Object

A new set of tags, which will replace the existing tags.