Added Remove User, Get Credits Endpoints

Author: nnayudu

README.md

@@ -139,10 +139,18 @@ const userId = await client.createUser();
 * [`setUserName`](https://developers.shrimpy.io/docs/#naming-a-user)
 ```js
 await client.setUserName(
+    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', //userId
     'mycustomname' // name
 );
 ```
 
+* [`removeUser`](https://developers.shrimpy.io/docs/#removing-a-user)
+```js
+await client.removeUser(
+    '701e0d16-1e9e-42c9-b6a1-4cada1f395b8', //userId
+);
+```
+
 * [`enableUser`](https://developers.shrimpy.io/docs/#enabling-a-user)
 ```js
 await client.enableUser(
@@ -492,9 +500,9 @@ const orderbooks = await client.getHistoricalOrderBooks(
 const status = await client.getStatus();
 ```
 
-* [`getUsage`](https://developers.shrimpy.io/docs/#get-usage)
+* [`getCredits`](https://developers.shrimpy.io/docs/#get-credits)
 ```js
-const usage = await client.getUsage();
+const usage = await client.getCredits();
 ```
 
 ## Websocket

lib/client/shrimpy-api-client.ts

@@ -21,6 +21,7 @@ import {
     IHistoricalTrade,
     ILimitOrder,
     ILimitOrderStatus,
+    IManagementCredits,
     IManagementStatus,
     IManagementUsage,
     IMarketOrderBooks,
@@ -251,6 +252,11 @@ export class ShrimpyApiClient {
         await this._callEndpoint<any>(endpoint, 'POST', parameters, true);
     }
 
+    public async removeUser(userId: string): Promise<void> {
+        const endpoint = `users/${userId}`;
+        await this._callEndpoint<any>(endpoint, 'DELETE', {}, true);
+    }
+
     public async enableUser(userId: string): Promise<void> {
         // Deprecated, this endpoint no longer has any functionality
         // It has been preserved to avoid breaking deployments from library upgrades
@@ -797,7 +803,14 @@ export class ShrimpyApiClient {
         return await this._callEndpoint<IManagementStatus>(endpoint, 'GET', null, true);
     }
 
+    public async getCredits(): Promise<IManagementCredits> {
+        const endpoint = `management/credits`;
+        return await this._callEndpoint<IManagementCredits>(endpoint, 'GET', null, true);
+    }
+
     public async getUsage(): Promise<IManagementUsage> {
+        // Deprecated, this endpoint no longer has any functionality
+        // It has been preserved to avoid breaking deployments from library upgrades
         const endpoint = `management/usage`;
         return await this._callEndpoint<IManagementUsage>(endpoint, 'GET', null, true);
     }

lib/models/imanagement-credits.ts

@@ -0,0 +1,3 @@
+export interface IManagementCredits {
+    credits: number;
+}

lib/models/index.ts

@@ -22,6 +22,7 @@ export * from './ihistorical-instrument';
 export * from './ihistorical-trade';
 export * from './ilimit-order';
 export * from './ilimit-order-status';
+export * from './imanagement-credits';
 export * from './imanagement-status';
 export * from './imanagement-usage';
 export * from './imarket-order-books';

package-lock.json

@@ -1,6 +1,6 @@
 {
   "name": "shrimpy-node",
-  "version": "0.2.11",
+  "version": "0.2.12",
   "author": "Shrimpy",
   "bugs": "https://github.com/shrimpy-dev/shrimpy-node/issues",
   "contributors": [