Module: FlavorsApi

API for interacting with flavors.

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

Methods


<inner> create(params)

Create a new flavor.

Parameters:
Name Type Description
params module:FlavorsApi~createRequest

Parameters for flavor creation.

Returns:

Newly created flavor.

Type
Promise.<Flavor>

<inner> list(params)

Query a list of flavors matching the specified query.

Parameters:
Name Type Default Description
params Object {}

Filter and pagination 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 flavor tags.

Parameters:
Name Type Description
params module:FlavorsApi~updateTagsRequest

Parameters for updating flavor 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 flavor.

quorum Number <optional>

The number of keys required to sign transactions that issue tokens of the flavor. Defaults to the number keys provided.

tags Object <optional>

User-specified, arbitrary/unstructured data.


updateTagsRequest

Type:
  • Object
Properties:
Name Type Argument Description
id String

The flavor ID.

tags Object <optional>

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