rest_market.agreement.md

Class: Agreement

yajsapi / Exports / rest/market / Agreement

Class: Agreement

rest/market.Agreement

Table of contents

Constructors

• constructor

Properties

• _api
• _id
• _subscription

Methods

• confirm
• details
• id
• terminate

Constructors

constructor

• new Agreement(api, subscription, agreement_id)

Parameters

Name	Type
api	RequestorApi
subscription	Subscription
agreement_id	string

Defined in

yajsapi/rest/market.ts:47

Properties

_api

• Private _api: any

Defined in

yajsapi/rest/market.ts:45

_id

• Private _id: any

Defined in

yajsapi/rest/market.ts:47

_subscription

• Private _subscription: any

Defined in

yajsapi/rest/market.ts:46

Methods

confirm

▸ confirm(): Promise

Returns

Promise

Defined in

yajsapi/rest/market.ts:68

details

▸ details(): Promise

Returns

Promise

Defined in

yajsapi/rest/market.ts:63

id

▸ id(): string

Returns

string

Defined in

yajsapi/rest/market.ts:59

terminate

▸ terminate(reason?): Promise

Parameters

Name	Type	Default value
reason	string	"Finished"

Returns

Promise

Defined in

yajsapi/rest/market.ts:84