bitfinexcom · prdn · Jul 3, 2023 · Jul 3, 2023 · Jul 3, 2023 · Jul 3, 2023
diff --git a/CHANGELOG b/CHANGELOG
@@ -1,3 +1,6 @@
+# 1.8.0
+- feature: Weighted Averages model
+
 # 1.7.1
 - fix: Change FundingOffer, Order, Position model to support new rest api signature
 - fix: Test coverage to support new rest api signature

diff --git a/docs/AccountSummary.html b/docs/AccountSummary.html
diff --git a/docs/Alert.html b/docs/Alert.html
diff --git a/docs/AuthPermission.html b/docs/AuthPermission.html
diff --git a/docs/BalanceInfo.html b/docs/BalanceInfo.html
diff --git a/docs/Candle.html b/docs/Candle.html
diff --git a/docs/ChangeLog.html b/docs/ChangeLog.html
diff --git a/docs/CoreSettings.html b/docs/CoreSettings.html
diff --git a/docs/Currency.html b/docs/Currency.html
diff --git a/docs/FundingCredit.html b/docs/FundingCredit.html
diff --git a/docs/FundingInfo.html b/docs/FundingInfo.html
diff --git a/docs/FundingLoan.html b/docs/FundingLoan.html
diff --git a/docs/FundingOffer.html b/docs/FundingOffer.html
diff --git a/docs/FundingTicker.html b/docs/FundingTicker.html
diff --git a/docs/FundingTickerHist.html b/docs/FundingTickerHist.html
diff --git a/docs/FundingTrade.html b/docs/FundingTrade.html
diff --git a/docs/Invoice.html b/docs/Invoice.html
diff --git a/docs/LedgerEntry.html b/docs/LedgerEntry.html
diff --git a/docs/Liquidations.html b/docs/Liquidations.html
diff --git a/docs/Login.html b/docs/Login.html
diff --git a/docs/MarginInfo.html b/docs/MarginInfo.html
diff --git a/docs/Model.html b/docs/Model.html
diff --git a/docs/Movement.html b/docs/Movement.html
diff --git a/docs/MovementInfo.html b/docs/MovementInfo.html
diff --git a/docs/Notification.html b/docs/Notification.html
diff --git a/docs/Order.html b/docs/Order.html
diff --git a/docs/OrderBook.html b/docs/OrderBook.html
diff --git a/docs/Position.html b/docs/Position.html
diff --git a/docs/PublicPulseProfile.html b/docs/PublicPulseProfile.html
diff --git a/docs/PublicTrade.html b/docs/PublicTrade.html
diff --git a/docs/PulseMessage.html b/docs/PulseMessage.html
diff --git a/docs/StatusMessagesDeriv.html b/docs/StatusMessagesDeriv.html
diff --git a/docs/SymbolDetails.html b/docs/SymbolDetails.html
diff --git a/docs/Trade.html b/docs/Trade.html
diff --git a/docs/TradingTicker.html b/docs/TradingTicker.html
diff --git a/docs/TradingTickerHist.html b/docs/TradingTickerHist.html
diff --git a/docs/TransactionFee.html b/docs/TransactionFee.html
diff --git a/docs/UserInfo.html b/docs/UserInfo.html
diff --git a/docs/Wallet.html b/docs/Wallet.html
diff --git a/docs/WalletHist.html b/docs/WalletHist.html
diff --git a/docs/WeightedAverages.html b/docs/WeightedAverages.html
diff --git a/docs/account_summary.js.html b/docs/account_summary.js.html
diff --git a/docs/alert.js.html b/docs/alert.js.html
diff --git a/docs/auth_permission.js.html b/docs/auth_permission.js.html
diff --git a/docs/balance_info.js.html b/docs/balance_info.js.html
diff --git a/docs/candle.js.html b/docs/candle.js.html
diff --git a/docs/change_log.js.html b/docs/change_log.js.html
diff --git a/docs/core_settings.js.html b/docs/core_settings.js.html
diff --git a/docs/currency.js.html b/docs/currency.js.html
diff --git a/docs/funding_credit.js.html b/docs/funding_credit.js.html
diff --git a/docs/funding_info.js.html b/docs/funding_info.js.html
diff --git a/docs/funding_loan.js.html b/docs/funding_loan.js.html
diff --git a/docs/funding_offer.js.html b/docs/funding_offer.js.html
diff --git a/docs/funding_ticker.js.html b/docs/funding_ticker.js.html
diff --git a/docs/funding_ticker_hist.js.html b/docs/funding_ticker_hist.js.html
diff --git a/docs/funding_trade.js.html b/docs/funding_trade.js.html
diff --git a/docs/global.html b/docs/global.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/invoice.js.html b/docs/invoice.js.html
diff --git a/docs/ledger_entry.js.html b/docs/ledger_entry.js.html
diff --git a/docs/liquidations.js.html b/docs/liquidations.js.html
diff --git a/docs/login.js.html b/docs/login.js.html
diff --git a/docs/margin_info.js.html b/docs/margin_info.js.html
diff --git a/docs/model.js.html b/docs/model.js.html
diff --git a/docs/movement.js.html b/docs/movement.js.html
diff --git a/docs/movement_info.js.html b/docs/movement_info.js.html
diff --git a/docs/notification.js.html b/docs/notification.js.html
diff --git a/docs/order.js.html b/docs/order.js.html
diff --git a/docs/order_book.js.html b/docs/order_book.js.html
diff --git a/docs/position.js.html b/docs/position.js.html
diff --git a/docs/public_pulse_profile.js.html b/docs/public_pulse_profile.js.html
diff --git a/docs/public_trade.js.html b/docs/public_trade.js.html
diff --git a/docs/pulse_message.js.html b/docs/pulse_message.js.html
diff --git a/docs/status_messages_deriv.js.html b/docs/status_messages_deriv.js.html
diff --git a/docs/symbol_details.js.html b/docs/symbol_details.js.html
diff --git a/docs/trade.js.html b/docs/trade.js.html
diff --git a/docs/trading_ticker.js.html b/docs/trading_ticker.js.html
diff --git a/docs/trading_ticker_hist.js.html b/docs/trading_ticker_hist.js.html
diff --git a/docs/transaction_fee.js.html b/docs/transaction_fee.js.html
diff --git a/docs/user_info.js.html b/docs/user_info.js.html
diff --git a/docs/util_assign_from_collection_or_instance.js.html b/docs/util_assign_from_collection_or_instance.js.html
diff --git a/docs/util_is_collection.js.html b/docs/util_is_collection.js.html
diff --git a/docs/validators_amount.js.html b/docs/validators_amount.js.html
diff --git a/docs/validators_array.js.html b/docs/validators_array.js.html
diff --git a/docs/validators_bool.js.html b/docs/validators_bool.js.html
diff --git a/docs/validators_currency.js.html b/docs/validators_currency.js.html
diff --git a/docs/validators_date.js.html b/docs/validators_date.js.html
diff --git a/docs/validators_number.js.html b/docs/validators_number.js.html
diff --git a/docs/validators_object.js.html b/docs/validators_object.js.html
diff --git a/docs/validators_price.js.html b/docs/validators_price.js.html
diff --git a/docs/validators_string.js.html b/docs/validators_string.js.html
diff --git a/docs/validators_symbol.js.html b/docs/validators_symbol.js.html
diff --git a/docs/wallet.js.html b/docs/wallet.js.html
diff --git a/docs/wallet_hist.js.html b/docs/wallet_hist.js.html
diff --git a/docs/weighted_averages.js.html b/docs/weighted_averages.js.html
diff --git a/lib/index.js b/lib/index.js
@@ -39,6 +39,7 @@ module.exports = {
   AccountSummary: require('./account_summary'),
   AuthPermission: require('./auth_permission'),
   CoreSettings: require('./core_settings'),
+  WeightedAverages: require('./weighted_averages'),
 
   isCollection: require('./util/is_collection')
 }
diff --git a/lib/weighted_averages.js b/lib/weighted_averages.js
@@ -0,0 +1,64 @@
+'use strict'
+
+const numberValidator = require('./validators/number')
+const Model = require('./model')
+const fields = {
+  tradeCount: 0,
+  sumBuyingSpent: 1,
+  sumBuyingAmount: 2,
+  sumSellingSpent: 4,
+  sumSellingAmount: 5,
+  buyingWeightedPrice: 7,
+  sellingWeightedPrice: 8
+}
+
+/**
+ * Weighted Averages model
+ */
+class WeightedAverages extends Model {
+  /**
+   * @param {object|Array} data - weighted averages data
+   * @param {number} data.tradeCount - trade count
+   * @param {number} data.sumBuyingSpent - sum buying spent
+   * @param {number} data.sumBuyingAmount - sum buying amount
+   * @param {number} data.sumSellingSpent - sum selling spent
+   * @param {number} data.sumSellingAmount - sum selling amount
+   * @param {number} data.buyingWeightedPrice - buying weighted price
+   * @param {number} data.sellingWeightedPrice - selling weighted price
+   */
+  constructor (data = {}) {
+    super({ data, fields })
+  }
+
+  /**
+   * @param {object[]|object|Array[]|Array} data - data to convert to POJO
+   * @returns {object} pojo
+   */
+  static unserialize (data) {
+    return super.unserialize({ data, fields })
+  }
+
+  /**
+   * Validates a given WeightedAverages instance
+   *
+   * @param {object[]|object|WeightedAverages[]|WeightedAverages|Array} data - instance to validate
+   * @returns {string} error - null if instance is valid
+   */
+  static validate (data) {
+    return super.validate({
+      data,
+      fields,
+      validators: {
+        tradeCount: numberValidator,
+        sumBuyingSpent: numberValidator,
+        sumBuyingAmount: numberValidator,
+        sumSellingSpent: numberValidator,
+        sumSellingAmount: numberValidator,
+        buyingWeightedPrice: numberValidator,
+        sellingWeightedPrice: numberValidator
+      }
+    })
+  }
+}
+
+module.exports = WeightedAverages
diff --git a/package.json b/package.json
@@ -1,6 +1,6 @@
 {
   "name": "bfx-api-node-models",
-  "version": "1.7.1",
+  "version": "1.8.0",
   "description": "Object models for usage with the Bitfinex node API",
   "engines": {
     "node": ">=8.3.0"

diff --git a/test/lib/models/weighted_averages.js b/test/lib/models/weighted_averages.js
@@ -0,0 +1,30 @@
+//* eslint-env mocha */
+'use strict'
+
+const { WeightedAverages } = require('../../../lib')
+const testModel = require('../../helpers/test_model')
+const testModelValidation = require('../../helpers/test_model_validation')
+
+describe('WeightedAverages model', () => {
+  testModel({
+    model: WeightedAverages,
+    orderedFields: [
+      'tradeCount', 'sumBuyingSpent', 'sumBuyingAmount', null,
+      'sumSellingSpent', 'sumSellingAmount', null,
+      'buyingWeightedPrice', 'sellingWeightedPrice'
+    ]
+  })
+
+  testModelValidation({
+    model: WeightedAverages,
+    validData: {
+      tradeCount: new Array(...(new Array(5))).map(() => Math.random()),
+      sumBuyingSpent: new Array(...(new Array(5))).map(() => Math.random()),
+      sumBuyingAmount: new Array(...(new Array(5))).map(() => Math.random()),
+      sumSellingSpent: new Array(...(new Array(5))).map(() => Math.random()),
+      sumSellingAmount: new Array(...(new Array(5))).map(() => Math.random()),
+      buyingWeightedPrice: new Array(...(new Array(5))).map(() => Math.random()),
+      sellingWeightedPrice: new Array(...(new Array(5))).map(() => Math.random())
+    }
+  })
+})