doc(transactions): Finishing adding all documention.

Author: taylorjdawson

dist/web3data.min.js

@@ -1047,21 +1047,233 @@ Retrieves all transactions matching the specified filters.
 | ---- | ---- | ----------- | -------- |
 | filterOptions |  |  The filter options associated with the request. |   |
 | filterOptions.status |  |  Filter by the status of the transactions to retrieve (all, completed, failed, pending). |   |
+| filterOptions.includePrice |  |  Indicates whether or not to include price data with the results. |   |
 
 
 
 
 ##### Examples
 
 ```javascript
-const transactions = await web3data.transaction.getTransactions()
+const transactions = await web3data.transaction.getTransactions() 
+// Include pricing data with transactions
+const transactions = await web3data.transaction.getTransactions({
+includePrice: true
+})
+```
+
+
+##### Returns
+
+
+-  All transactions matched by the specified filters.
+
+
+
+
+
+#### getTransaction(hash, filterOptions)
+
+
+Retrieves the transaction data for the specified hash.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| hash |  |  The transaction hash. |   |
+| filterOptions |  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#gettransaction) for more details. |   |
+| filterOptions.validationMethod=none |  |  The validation method to be added to the response: `none`, `basic`, `full`. |   |
+| filterOptions.includePrice=true |  |  Indicates whether or not to include price data with the results. |   |
+
+
+
+
+##### Examples
+
+```javascript
+const transaction = await web3data.transaction.getTransaction('0xd0a5a0912fdf87993b3cebd696f1ee667a8fbbe8fc890a22dcbdf114f36de4cf')
+```
+
+
+##### Returns
+
+
+-  The data for the specified transaction hash.
+
+
+
+
+
+#### getPendingTransactions()
+
+
+Retrieves all pending transaction.
+
+
+
+
+
+
+##### Examples
+
+```javascript
+const pendingTransactions = await web3data.transaction.getPendingTransactions()
+```
+
+
+##### Returns
+
+
+-  The pending transactions.
+
+
+
+
+
+#### getGasPrediction()
+
+
+Retrieves the latest gas predictions for the transactions.
+
+
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+-  The latest gas predictions for the transactions.
+
+
+
+
+
+#### getGasPercentiles(filterOptions)
+
+
+Retrieves the latest gas price percentiles for the transactions.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filterOptions |  |  The filter options associated with the request. |   |
+| filterOptions.numBlocks |  |  Number of past blocks on which to base the percentiles. |   |
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+-  The latest gas price percentiles for the transactions.
+
+
+
+
+
+#### getGasPrice()
+
+
+Retrieves the latest average gas price. Uses `getGasPrediction` under the hood.
+
+
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+-  The latest gas price.
+
+
+
+
+
+#### getVolume(filterOptions)
+
+
+Retrieves the historical (time series) volume of transactions.
+
+
+
+
+##### Parameters
+
+| Name | Type | Description |  |
+| ---- | ---- | ----------- | -------- |
+| filterOptions |  |  The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#gethistoricaltransactionvolume) for more details. |   |
+
+
+
+
+##### Examples
+
+```javascript
+
+```
+
+
+##### Returns
+
+
+-  The historical (time series) volume of transactions.
+
+
+
+
+
+#### getMetrics()
+
+
+Get metrics for recent confirmed transactions for a given blockchain. Default metrics are over a 24h period.
+
+
+
+
+
+
+##### Examples
+
+```javascript
+
 ```
 
 
 ##### Returns
 
 
--  - All transactions matched by the specified filters.
+-  Metrics for recent confirmed transactions.
 
 
 

dist/web3data.min.js.map

@@ -25,8 +25,14 @@ class Transaction {
    *
    * @param [filterOptions] - The filter options associated with the request.
    * @param [filterOptions.status] - Filter by the status of the transactions to retrieve (all, completed, failed, pending).
-   * @returns - All transactions matched by the specified filters.
+   * @param [filterOptions.includePrice] - Indicates whether or not to include price data with the results.
+   * @returns All transactions matched by the specified filters.
    * @example const transactions = await web3data.transaction.getTransactions()
+   *
+   * // Include pricing data with transactions
+   * const transactions = await web3data.transaction.getTransactions({
+   * includePrice: true
+   * })
    */
   getTransactions(filterOptions = {}) {
     return get(this.web3data, {
@@ -35,7 +41,17 @@ class Transaction {
     }).then(onFulfilled, onError)
   }
 
-  getTransaction(hash, filterOptions) {
+  /**
+   * Retrieves the transaction data for the specified hash.
+   *
+   * @param hash - The transaction hash.
+   * @param [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#get-transaction) for more details.
+   * @param [filterOptions.validationMethod=none] - The validation method to be added to the response: `none`, `basic`, `full`.
+   * @param [filterOptions.includePrice=true] - Indicates whether or not to include price data with the results.
+   * @returns The data for the specified transaction hash.
+   * @example const transaction = await web3data.transaction.getTransaction('0xd0a5a0912fdf87993b3cebd696f1ee667a8fbbe8fc890a22dcbdf114f36de4cf')
+   */
+  getTransaction(hash, filterOptions = {}) {
     throwIf(is.notHash(hash), NO_HASH)
     return get(this.web3data, {
       pathParam: hash,
@@ -44,6 +60,12 @@ class Transaction {
     }).then(onFulfilled, onError)
   }
 
+  /**
+   * Retrieves all pending transaction.
+   *
+   * @returns The pending transactions.
+   * @example const pendingTransactions = await web3data.transaction.getPendingTransactions()
+   */
   getPendingTransactions() {
     return this.getTransactions({status: 'pending'}).then(
       pendingTransactions => {
@@ -57,21 +79,41 @@ class Transaction {
     )
   }
 
+  /**
+   * Retrieves the latest gas predictions for the transactions.
+   *
+   * @returns The latest gas predictions for the transactions.
+   * @example
+   */
   getGasPrediction() {
     return get(this.web3data, {
       endpoint: ENDPOINT,
       subendpoint: 'gas/predictions'
     }).then(onFulfilled, onError)
   }
 
-  getGasPercentiles(filterOptions) {
+  /**
+   * Retrieves the latest gas price percentiles for the transactions.
+   *
+   * @param [filterOptions] - The filter options associated with the request.
+   * @param [filterOptions.numBlocks] - Number of past blocks on which to base the percentiles.
+   * @returns The latest gas price percentiles for the transactions.
+   * @example
+   */
+  getGasPercentiles(filterOptions = {}) {
     return get(this.web3data, {
       endpoint: ENDPOINT,
       subendpoint: 'gas/percentiles',
       filterOptions
     }).then(onFulfilled, onError)
   }
 
+  /**
+   * Retrieves the latest average gas price. Uses `getGasPrediction` under the hood.
+   *
+   * @returns The latest gas price.
+   * @example
+   */
   getGasPrice() {
     return this.getGasPrediction().then(gasPrediction => {
       throwIf(
@@ -82,15 +124,28 @@ class Transaction {
     })
   }
 
-  getVolume(filterOptions) {
+  /**
+   * Retrieves the historical (time series) volume of transactions.
+   *
+   * @param [filterOptions] - The filter options associated with the request. See [docs](https://docs.amberdata.io/reference#get-historical-transaction-volume) for more details.
+   * @returns The historical (time series) volume of transactions.
+   * @example
+   */
+  getVolume(filterOptions = {}) {
     return get(this.web3data, {
       endpoint: ENDPOINT,
       subendpoint: 'volume',
       filterOptions
     }).then(onFulfilled, onError)
   }
 
-  getMetrics(filterOptions) {
+  /**
+   * Get metrics for recent confirmed transactions for a given blockchain. Default metrics are over a 24h period.
+   *
+   * @returns Metrics for recent confirmed transactions.
+   * @example
+   */
+  getMetrics(filterOptions = {}) {
     return get(this.web3data, {
       endpoint: ENDPOINT,
       subendpoint: 'metrics/latest',