Participants

Participants

Buying power participants resource

Constructor

new Participants()

Source:

Methods

createParticipant(opts) → {Promise.<JsonApiResponse>}

Create lot participant.

Source:
Parameters:
Name Type Description
opts object

Request opts.

Name Type Attributes Description
lotId string

Participant lot ID.

accountId string <optional>

Participant account ID.

depositIds Array.<string>

Attached participant deposit IDs.

Returns:
Type:
Promise.<JsonApiResponse>

rejectAllParticipants(lotId) → {Promise.<JsonApiResponse>}

Reject all participants.

Source:
Parameters:
Name Type Description
lotId string

Participants' lot ID.

Returns:
Type:
Promise.<JsonApiResponse>

rejectParticipant(lotId, accountId) → {Promise.<JsonApiResponse>}

Reject lot participant.

Source:
Parameters:
Name Type Description
lotId string

Participant lot ID.

accountId string

Participant account ID.

Returns:
Type:
Promise.<JsonApiResponse>

requestBuyNow(opts) → {Promise.<JsonApiResponse>}

Request buy now.

Source:
Parameters:
Name Type Description
opts object

Request opts.

Name Type Attributes Description
lotId string

Participant lot ID.

accountId string <optional>

Participant account ID.

Returns:
Type:
Promise.<JsonApiResponse>

setAutoBidLimit(opts) → {Promise.<JsonApiResponse>}

Set participant auto bid limit.

Source:
Parameters:
Name Type Description
opts object

Request opts.

Name Type Attributes Description
lotId string

Participant lot ID.

accountId string <optional>

Participant account ID.

amount string

Auto bid limit amount.

Returns:
Type:
Promise.<JsonApiResponse>

setBid(opts) → {Promise.<JsonApiResponse>}

Set participant bid.

Source:
Parameters:
Name Type Description
opts object

Request opts.

Name Type Attributes Description
lotId string

Participant lot ID.

accountId string <optional>

Participant account ID.

amount string

Bid amount.

Returns:
Type:
Promise.<JsonApiResponse>

setBidLimit(opts) → {Promise.<JsonApiResponse>}

Set participant bid limit.

Source:
Parameters:
Name Type Description
opts object

Request opts.

Name Type Attributes Description
lotId string

Participant lot ID.

accountId string <optional>

Participant account ID.

amount string

Bid limit amount.

Returns:
Type:
Promise.<JsonApiResponse>