Added directory tree & usage method. (#107)

README.md

@@ -99,6 +99,41 @@ If you are using the types in a `commonjs` module, like in a Node app, you just
     ....
 ```
 
+## Directory structure
+```bash
+└── src
+│   ├── blockchain          // Blockchain API methods without private key
+│   ├── connector           // Wrapper around all HTTP methods
+│   ├── contracts           // Abi and byte code smart contracts
+│   │   ├── custodial
+│   │   ├── erc20
+│   │   ├── erc721
+│   │   ├── erc1155
+│   │   ├── marketplace
+│   │   ├── trc20
+│   │   ├── trc721
+│   ├── ledger              // Ledger API methods
+│   ├── model               // Validation, interfaces and DTO classes
+│   │   ├── request
+│   │   ├── response
+│   │   ├── validation
+│   ├── multiToken          // Multi Token API methods
+│   ├── nft                 // NFT API methods
+│   │   ├── marketplace     // Marketplace API methods
+│   ├── offchain            // Offchain API methods
+│   ├── record              // Logging API methods
+│   ├── security            // Security and KMS methods
+│   ├── tatum               // Service API methods
+│   ├── transaction         // Transaction API methods
+│   ├── wallet              // Wallet, private key and address API methods
+│   └── constants.ts        // Constants
+├── README.md
+├── package.json
+├── tslint.js
+├── tsconfig.json
+└── .gitignore
+```
+
 ## Contributing
 
 Contributions to the Tatum API client are welcome. Please ensure

src/model/response/common/Consumption.ts

@@ -0,0 +1,14 @@
+/**
+ * Usage information of credits
+ */
+export interface Consumption {
+    /**
+     * UTC millis timestamp of the day.
+     */
+    day: number
+
+    /**
+     * Number of credits consumed for the specific day.
+     */
+    usage: number
+}

src/model/response/index.ts

@@ -11,6 +11,7 @@ export * from './common/Rate';
 export * from './common/SignatureId';
 export * from './common/TransactionHash';
 export * from './common/TxHash';
+export * from './common/Consumption';
 export * from './kms/TransactionKMS';
 export * from './eth/EthBlock';
 export * from './eth/EthTx';

src/tatum/index.spec.ts

@@ -0,0 +1,9 @@
+import { getUsage } from './index'
+
+describe('Test Tatum Service', () => {
+    it('Test getUsage', async () => {
+        const usage = await getUsage()
+        expect(usage).not.toBeNull()
+        expect(Array.isArray(usage)).toBe(true)
+    });
+});

src/tatum/index.ts

@@ -1,10 +1,15 @@
 import { get } from '../connector/tatum'
-import {Currency} from '../model';
-import {Fiat} from '../model';
-import {Rate} from '../model/response/common/Rate';
+import { Consumption, Currency, Fiat, Rate } from '../model';
 
 /**
  * For more details, see <a href="https://tatum.io/apidoc#operation/getExchangeRate" target="_blank">Tatum API documentation</a>
  */
 export const getExchangeRate = async (currency: Fiat | Currency, basePair = Fiat.EUR): Promise<Rate> =>
-  get(`/v3/tatum/rate/${currency}?basePair=${basePair}`);
+  get(`/v3/tatum/rate/${currency}?basePair=${basePair}`);
+
+/**
+ * Returns credit consumption last of month.
+ *
+ * For more details, see <a href="https://tatum.io/apidoc#operation/getCredits" target="_blank">Tatum API documentation</a>
+ */
+export const getUsage = async (): Promise<Consumption[]> => get('/v3/tatum/usage')