## Order High level order model; provides methods for execution & can stay updated via a WSv2 connection **Kind**: global class * [Order](#Order) * [new Order(data, ws)](#new_Order_new) * _instance_ * [.registerListeners(ws)](#Order+registerListeners) * [.removeListeners(ws)](#Order+removeListeners) * [.cbGID()](#Order+cbGID) ⇒ string * [.submit(ws)](#Order+submit) ⇒ Promise * [.cancel(ws)](#Order+cancel) ⇒ Promise * [.recreate(ws)](#Order+recreate) ⇒ Promise * [.getLastFillAmount()](#Order+getLastFillAmount) ⇒ number * [.getBaseCurrency()](#Order+getBaseCurrency) ⇒ string * [.getQuoteCurrency()](#Order+getQuoteCurrency) ⇒ string * [.getNotionalValue()](#Order+getNotionalValue) ⇒ number * [.serialize()](#Order+serialize) ⇒ Array * [.toNewOrderPacket()](#Order+toNewOrderPacket) ⇒ Object * _static_ * [.unserialize(arr)](#Order.unserialize) ⇒ Object * [.getBaseCurrency(arr)](#Order.getBaseCurrency) ⇒ string * [.getQuoteCurrency(arr)](#Order.getQuoteCurrency) ⇒ string ### new Order(data, ws) | Param | Type | Description | | --- | --- | --- | | data | Object | Array | either a map of order fields or a raw array | | ws | WSv2 | optional, saved for a later call to registerListeners() | ### order.registerListeners(ws) Registers for updates/persistence on the specified ws2 instance **Kind**: instance method of [Order](#Order) | Param | Type | Description | | --- | --- | --- | | ws | WSv2 | optional, defaults to internal ws | ### order.removeListeners(ws) Removes update listeners from the specified ws2 instance **Kind**: instance method of [Order](#Order) | Param | Type | Description | | --- | --- | --- | | ws | WSv2 | optional, defaults to internal ws | ### order.cbGID() ⇒ string **Kind**: instance method of [Order](#Order) **Returns**: string - cbGID ### order.submit(ws) ⇒ Promise **Kind**: instance method of [Order](#Order) **Returns**: Promise - p | Param | Type | Description | | --- | --- | --- | | ws | WSv2 | optional, defaults to internal ws | ### order.cancel(ws) ⇒ Promise **Kind**: instance method of [Order](#Order) **Returns**: Promise - p | Param | Type | Description | | --- | --- | --- | | ws | WSv2 | optional, defaults to internal ws | ### order.recreate(ws) ⇒ Promise Equivalent to calling cancel() followed by submit() **Kind**: instance method of [Order](#Order) **Returns**: Promise - p | Param | Type | Description | | --- | --- | --- | | ws | WSv2 | optional, defaults to internal ws | ### order.getLastFillAmount() ⇒ number Query the amount that was filled on the last order update **Kind**: instance method of [Order](#Order) **Returns**: number - amount ### order.getBaseCurrency() ⇒ string **Kind**: instance method of [Order](#Order) **Returns**: string - currency ### order.getQuoteCurrency() ⇒ string **Kind**: instance method of [Order](#Order) **Returns**: string - currency ### order.getNotionalValue() ⇒ number **Kind**: instance method of [Order](#Order) **Returns**: number - value ### order.serialize() ⇒ Array **Kind**: instance method of [Order](#Order) **Returns**: Array - o ### order.toNewOrderPacket() ⇒ Object Creates an order map that can be passed to the `on` command. **Kind**: instance method of [Order](#Order) **Returns**: Object - o ### Order.unserialize(arr) ⇒ Object **Kind**: static method of [Order](#Order) **Returns**: Object - order | Param | Type | | --- | --- | | arr | Array | ### Order.getBaseCurrency(arr) ⇒ string **Kind**: static method of [Order](#Order) **Returns**: string - currency - base currency from symbol | Param | Type | Description | | --- | --- | --- | | arr | Array | order in ws2 array format | ### Order.getQuoteCurrency(arr) ⇒ string **Kind**: static method of [Order](#Order) **Returns**: string - currency - quote currency from symbol | Param | Type | Description | | --- | --- | --- | | arr | Array | order in ws2 array format |