feat: updated api docs to bee-js v0.7.0 (#49)

Author: vojtechsimetka

bee-js

@@ -31,7 +31,7 @@ Name | Type |
 
 Inherited from: [BeeError](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/7dfd556/src/utils/error.ts#L7)
+Defined in: [bee-js/src/utils/error.ts:7](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/error.ts#L7)
 
 ## Properties
 

docs/api/classes/bee.md

@@ -26,14 +26,16 @@ Name | Type |
 
 **Returns:** [*BeeDebug*](beedebug.md)
 
-Defined in: [bee-js/src/bee-debug.ts:28](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L28)
+Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L36)
 
 ## Properties
 
 ### url
 
 • `Readonly` **url**: *string*
 
+Defined in: [bee-js/src/bee-debug.ts:36](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L36)
+
 ## Methods
 
 ### cashoutLastCheque
@@ -50,25 +52,25 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*CashoutResponse*](../interfaces/cashoutresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:134](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L134)
+Defined in: [bee-js/src/bee-debug.ts:161](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L161)
 
 ___
 
 ### depositTokens
 
-▸ **depositTokens**(`amount`: *number*): *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
+▸ **depositTokens**(`amount`: *number* \| BigInt): *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
 
 Deposit tokens from overlay address into chequebook
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`amount` | *number* | Amount of tokens to deposit    |
+`amount` | *number* \| BigInt | Amount of tokens to deposit (must be positive integer)    |
 
 **Returns:** *Promise*<[*DepositTokensResponse*](../interfaces/deposittokensresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:143](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L143)
+Defined in: [bee-js/src/bee-debug.ts:170](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L170)
 
 ___
 
@@ -80,7 +82,7 @@ Get the balances with all known peers including prepaid services
 
 **Returns:** *Promise*<[*BalanceResponse*](../interfaces/balanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:57](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L57)
+Defined in: [bee-js/src/bee-debug.ts:81](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L81)
 
 ___
 
@@ -92,31 +94,56 @@ Get settlements with all known peers and total amount sent or received
 
 **Returns:** *Promise*<[*AllSettlements*](../interfaces/allsettlements.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:172](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L172)
+Defined in: [bee-js/src/bee-debug.ts:207](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L207)
+
+___
+
+### getBlocklist
+
+▸ **getBlocklist**(): *Promise*<[*Peer*](../interfaces/peer.md)[]\>
+
+**Returns:** *Promise*<[*Peer*](../interfaces/peer.md)[]\>
+
+Defined in: [bee-js/src/bee-debug.ts:51](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L51)
 
 ___
 
 ### getChequebookAddress
 
 ▸ **getChequebookAddress**(): *Promise*<[*ChequebookAddressResponse*](../interfaces/chequebookaddressresponse.md)\>
 
-Get the address of the chequebook contract used
+Get the address of the chequebook contract used.
+
+**Warning:** The address is returned with 0x prefix unlike all other calls.
+https://github.com/ethersphere/bee/issues/1443
 
 **Returns:** *Promise*<[*ChequebookAddressResponse*](../interfaces/chequebookaddressresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:93](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L93)
+Defined in: [bee-js/src/bee-debug.ts:120](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L120)
 
 ___
 
-### getChequeubookBalance
+### getChequebookBalance
 
-▸ **getChequeubookBalance**(): *Promise*<[*ChequebookBalanceResponse*](../interfaces/chequebookbalanceresponse.md)\>
+▸ **getChequebookBalance**(): *Promise*<[*ChequebookBalanceResponse*](../interfaces/chequebookbalanceresponse.md)\>
 
 Get the balance of the chequebook
 
 **Returns:** *Promise*<[*ChequebookBalanceResponse*](../interfaces/chequebookbalanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:100](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L100)
+Defined in: [bee-js/src/bee-debug.ts:127](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L127)
+
+___
+
+### getHealth
+
+▸ **getHealth**(): *Promise*<[*Health*](../interfaces/health.md)\>
+
+Get health of node
+
+**Returns:** *Promise*<[*Health*](../interfaces/health.md)\>
+
+Defined in: [bee-js/src/bee-debug.ts:214](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L214)
 
 ___
 
@@ -134,7 +161,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*LastCashoutActionResponse*](../interfaces/lastcashoutactionresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:125](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L125)
+Defined in: [bee-js/src/bee-debug.ts:152](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L152)
 
 ___
 
@@ -146,7 +173,7 @@ Get last cheques for all peers
 
 **Returns:** *Promise*<[*LastChequesResponse*](../interfaces/lastchequesresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:107](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L107)
+Defined in: [bee-js/src/bee-debug.ts:134](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L134)
 
 ___
 
@@ -164,17 +191,17 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*LastChequesForPeerResponse*](../interfaces/lastchequesforpeerresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:116](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L116)
+Defined in: [bee-js/src/bee-debug.ts:143](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L143)
 
 ___
 
-### getOverlayAddress
+### getNodeAddresses
 
-▸ **getOverlayAddress**(): *Promise*<string\>
+▸ **getNodeAddresses**(): *Promise*<[*NodeAddresses*](../interfaces/nodeaddresses.md)\>
 
-**Returns:** *Promise*<string\>
+**Returns:** *Promise*<[*NodeAddresses*](../interfaces/nodeaddresses.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:31](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L31)
+Defined in: [bee-js/src/bee-debug.ts:47](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L47)
 
 ___
 
@@ -186,7 +213,7 @@ Get the past due consumption balances with all known peers
 
 **Returns:** *Promise*<[*BalanceResponse*](../interfaces/balanceresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:73](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L73)
+Defined in: [bee-js/src/bee-debug.ts:97](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L97)
 
 ___
 
@@ -204,7 +231,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:82](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L82)
+Defined in: [bee-js/src/bee-debug.ts:106](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L106)
 
 ___
 
@@ -222,7 +249,7 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*PeerBalance*](../interfaces/peerbalance.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:66](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L66)
+Defined in: [bee-js/src/bee-debug.ts:90](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L90)
 
 ___
 
@@ -234,17 +261,7 @@ Get list of peers for this node
 
 **Returns:** *Promise*<[*Peer*](../interfaces/peer.md)[]\>
 
-Defined in: [bee-js/src/bee-debug.ts:46](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L46)
-
-___
-
-### getPssPublicKey
-
-▸ **getPssPublicKey**(): *Promise*<string\>
-
-**Returns:** *Promise*<string\>
-
-Defined in: [bee-js/src/bee-debug.ts:37](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L37)
+Defined in: [bee-js/src/bee-debug.ts:58](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L58)
 
 ___
 
@@ -262,22 +279,78 @@ Name | Type | Description |
 
 **Returns:** *Promise*<[*Settlements*](../interfaces/settlements.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:165](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L165)
+Defined in: [bee-js/src/bee-debug.ts:200](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L200)
+
+___
+
+### getTopology
+
+▸ **getTopology**(): *Promise*<[*Topology*](../interfaces/topology.md)\>
+
+**Returns:** *Promise*<[*Topology*](../interfaces/topology.md)\>
+
+Defined in: [bee-js/src/bee-debug.ts:66](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L66)
+
+___
+
+### isSupportedVersion
+
+▸ **isSupportedVersion**(): *Promise*<boolean\>
+
+Connnects to a node and checks if it is a supported Bee version by the bee-js
+
+**Returns:** *Promise*<boolean\>
+
+true if the Bee node version is supported
+
+Defined in: [bee-js/src/bee-debug.ts:223](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L223)
+
+___
+
+### pingPeer
+
+▸ **pingPeer**(`peer`: *string*): *Promise*<[*PingResponse*](../interfaces/pingresponse.md)\>
+
+#### Parameters:
+
+Name | Type |
+:------ | :------ |
+`peer` | *string* |
+
+**Returns:** *Promise*<[*PingResponse*](../interfaces/pingresponse.md)\>
+
+Defined in: [bee-js/src/bee-debug.ts:70](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L70)
+
+___
+
+### removePeer
+
+▸ **removePeer**(`peer`: *string*): *Promise*<[*RemovePeerResponse*](../interfaces/removepeerresponse.md)\>
+
+#### Parameters:
+
+Name | Type |
+:------ | :------ |
+`peer` | *string* |
+
+**Returns:** *Promise*<[*RemovePeerResponse*](../interfaces/removepeerresponse.md)\>
+
+Defined in: [bee-js/src/bee-debug.ts:62](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L62)
 
 ___
 
 ### withdrawTokens
 
-▸ **withdrawTokens**(`amount`: *number*): *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
+▸ **withdrawTokens**(`amount`: *number* \| BigInt): *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
 
 Withdraw tokens from the chequebook to the overlay address
 
 #### Parameters:
 
 Name | Type | Description |
 :------ | :------ | :------ |
-`amount` | *number* | Amount of tokens to withdraw    |
+`amount` | *number* \| BigInt | Amount of tokens to withdraw (must be positive integer)    |
 
 **Returns:** *Promise*<[*WithdrawTokensResponse*](../interfaces/withdrawtokensresponse.md)\>
 
-Defined in: [bee-js/src/bee-debug.ts:152](https://github.com/ethersphere/bee-js/blob/7dfd556/src/bee-debug.ts#L152)
+Defined in: [bee-js/src/bee-debug.ts:183](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/bee-debug.ts#L183)

docs/api/classes/beeargumenterror.md

@@ -34,7 +34,7 @@ Name | Type |
 
 **Returns:** [*BeeError*](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/7dfd556/src/utils/error.ts#L1)
+Defined in: [bee-js/src/utils/error.ts:1](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/error.ts#L1)
 
 ## Properties
 

docs/api/classes/beedebug.md

@@ -30,7 +30,7 @@ Name | Type |
 
 Inherited from: [BeeError](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/7dfd556/src/utils/error.ts#L13)
+Defined in: [bee-js/src/utils/error.ts:13](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/error.ts#L13)
 
 ## Properties
 

docs/api/classes/beeerror.md

@@ -31,7 +31,7 @@ Name | Type |
 
 Inherited from: [BeeError](beeerror.md)
 
-Defined in: [bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/7dfd556/src/utils/error.ts#L19)
+Defined in: [bee-js/src/utils/error.ts:19](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/error.ts#L19)
 
 ## Properties
 

docs/api/classes/beerequesterror.md

@@ -30,4 +30,4 @@ Name | Type | Description |
 
 **Returns:** [*Bytes*](../interfaces/utils.bytes.bytes.md)<Length\>
 
-Defined in: [bee-js/src/utils/bytes.ts:88](https://github.com/ethersphere/bee-js/blob/7dfd556/src/utils/bytes.ts#L88)
+Defined in: [bee-js/src/utils/bytes.ts:91](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/bytes.ts#L91)

docs/api/classes/beeresponseerror.md

@@ -23,4 +23,4 @@ Name | Type | Description |
 
 **Returns:** *boolean*
 
-Defined in: [bee-js/src/utils/bytes.ts:115](https://github.com/ethersphere/bee-js/blob/7dfd556/src/utils/bytes.ts#L115)
+Defined in: [bee-js/src/utils/bytes.ts:118](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/bytes.ts#L118)

docs/api/functions/utils.bytes.bytesatoffset.md

@@ -32,4 +32,4 @@ Name | Type | Description |
 
 **Returns:** [*FlexBytes*](../interfaces/utils.bytes.flexbytes.md)<Min, Max\>
 
-Defined in: [bee-js/src/utils/bytes.ts:100](https://github.com/ethersphere/bee-js/blob/7dfd556/src/utils/bytes.ts#L100)
+Defined in: [bee-js/src/utils/bytes.ts:103](https://github.com/ethersphere/bee-js/blob/0ac3a7d/src/utils/bytes.ts#L103)