hollaex-node-lib 2.18.0 → 2.19.0

package/README.md

@@ -102,8 +102,9 @@ client
 | `getExchangeOrders` | <ul><li>**opts.userId**: The identifier of the user</li><li>**opts.side**: The order side (buy or side)</li><li>**opts.status**: The order's status e.g open, filled, canceled etc</li><li>**opts.open**: The info on whether the order is active or not </li><li>**opts.side**: The order side (buy or side)</li><li>**opts.limit**: Amount of orders per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of order data. Default: 1</li><li>**opts.symbol**: The symbol-pair to filter by, pass undefined to receive data on all currencies</li><li>**opts.orderBy:** The field to order data by e.g. amount, id.</li><li>**opts.order:** Ascending (asc) or descending (desc).</li><li>**opts.startDate:** Start date of query in ISO8601 format.</li><li>**opts.endDate:** End date of query in ISO8601 format.</li></ul> | Retrieve user's orders by admin |
 | `cancelExchangeUserOrder` | <ul><li>**userId**: The identifier of the user</li><li>**orderId**: The identifier of the order</li></ul> | Cancel user's order by order id |
 | `getExchangeUsers` | <ul><li>**opts**: Optional parameters</li><li>**opts.userId**: The identifier of the user to filter by</li><li>**opts.search**: The search text to filter by, pass undefined to receive data on all fields</li><li>**opts.pending**: The pending field to filter by, pass undefined to receive all data</li><li>**opts.pendingType**: Th pending type info to filter by, pass undefined to receive data</li><li>**opts.limit**: Amount of users per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of user data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve list of the user info by admin |
-| `createExchangeUser` | <ul><li>**email**: The mail address for the user</li<li>**password**: The password for the user</li></ul> | Create exchange user |
+| `createExchangeUser` | <ul><li>**email**: The mail address for the user</li><li>**password**: The password for the user</li><li>**opts.referral**: The referral code for the user</li></ul> | Create exchange user |
 | `updateExchangeUser` | <ul><li>**userId**: The identifier of the user to filter by</li><li>**opts.meta**: The field to update user meta info</li><li>**opts.overwrite**: the field to set overwrite option along with meta object</li><li>**opts.role**: The field to update user role ('admin', 'supervisor', 'support', 'kyc', 'communicator', 'user')</li><li>**opts.note**: The field to update user note </li><li>**opts.verification_level**: The field to set user's verification level</li></ul> | Update exchange user |
+| `deleteExchangeUser` | <ul><li>**user_id**: The id for the user</li></ul> | Delete exchange user |
 | `createExchangeUserWallet` | <ul><li>**userId**: The identifier of the user</li><li>**crypto**: The coin for the wallet e.g btc, eth</li><li>**opts.network**: The network info </li></ul> | Create wallet for exchange user |
 | `getExchangeUserWallet` | <ul><li>**opts.userId**: The identifier of the user to filter by</li><li>**opts.limit**: Amount of users per page. Maximum: 50. Default: 50</li><li>**opts.currency**: The currency to filter by</li><li>**opts.page**: Page of user data. Default: 1</li><li>**opts.orderBy**: The field to order data by e.g. amount, id.</li><li>**opts.order**: Ascending (asc) or descending (desc).</li><li>**opts.startDate**: Start date of query in ISO8601 format.</li><li>**opts.endDate**: End date of query in ISO8601 format.</li><li>**opts.address**: Address of crypto</li><li>**opts.isValid**: Specify whether or not wallet is valid</li><li>**opts.network**: Crypto network of currency</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve users' wallets by admin |
 | `getExchangeUserBalance` | <ul><li>**userId**: The identifier of the user</li></ul> | Retrieve user's login info by admin |
@@ -117,6 +118,9 @@ client
 | `sendRawEmail` | <ul><li>**receivers**:  The array of emails to send mail</li><li>**html**: The stringified html content</li><li>**opts.title**:  The title of the mail</li><li>**opts.text**:  The text of the mail</li></ul> | Send email to users with custom html by admin |
 | `getOraclePrice` | <ul><li>**assets**:  Assets to convert</li><li>**opts.quote**: Quote coin to convert to</li><li>**opts.amount**:  Amount to convert</li></ul> | Retrieve price conversion |
 | `getExchangeUserBalances` | <ul><li>**opts.userId**:  The identifier of the user to filter by</li><li>**opts.currency**: The currency to filter by, pass undefined to receive data on all currencies</li><li>**opts.format**: Custom format of data set. Enum: ['all', 'csv']</li></ul> | Retrieve user's balances by admin |
+| `createOrderByAdmin` | <ul><li>**user_id**: User id for the order</li><li>**symbol**: Currency symbol of the order e.g. xht-usdt</li><li>**size**: Amount of the order</li><li>**side**: Order Side, buy or sell</li><li>**type**: Order Type, limit or market</li><li>**price**: Order Price</li></ul> | Create order on behalf of user |
+| `createTradeByAdmin` | <ul><li>**maker_id**: User id for the maker</li><li>**user_id**: User id for the taker</li><li>**user_id**: fee in percentage for the maker</li><li>**user_id**: fee in percentage for the taker</li><li>**symbol**: Currency symbol of the order e.g. xht-usdt</li><li>**size**: Amount of the order</li><li>**side**: Order Side, buy or sell</li><li>**price**: Order Price</li></ul> | Create order on behalf of user |
+| `createWithdrawalByAdmin` | <ul><li>**user_id**: User id for the withdrawal process</li><li>**address**: Specific address for the withdrawal</li><li>**amount**: Size of the withdrawal</li><li>**currency**: Currency symbol of the withdrawal</li><li>**opts.network**: Blockchain network</li></ul> | Create withdrawal on behalf of users |
 
 
 ### Websocket

package/kit.js

@@ -208,7 +208,7 @@ class HollaExKit {
 	) {
 		const verb = 'GET';
 		let path = `${this.baseUrl}/user/deposits`;
-		let params = '?'
+		let params = '?';
 
 		if (isString(opts.currency)) {
 			params += `&currency=${opts.currency}`;
@@ -318,7 +318,7 @@ class HollaExKit {
 	) {
 		const verb = 'GET';
 		let path = `${this.baseUrl}/user/withdrawals`;
-		let params = '?'
+		let params = '?';
 
 		if (isString(opts.currency)) {
 			params += `&currency=${opts.currency}`;
@@ -1828,15 +1828,23 @@ class HollaExKit {
 	 * Create exchange user
 	 * @param {string} email - The mail address for the user
 	 * @param {string} password - The password for the user
+	 * @param {string} opts.referral - The referral code for the user
 	 * @return {object} A JSON object with message
 	 */
-	createExchangeUser(email, password) {
+	createExchangeUser(email, password, opts = {
+		referral: null
+	}) {
 		const verb = 'POST';
 		let path = `${this.baseUrl}/admin/user`;
 		const data = {
 			email,
 			password
 		};
+		
+			
+		if (isString(opts.referral)) {
+			data.referral = opts.referral;
+		};
 	
 		const headers = generateHeaders(
 			this.headers,
@@ -1986,6 +1994,30 @@ class HollaExKit {
 		}
 	
 	}
+
+	/**
+	 * Delete exchange user
+	 * @param {number} user_id - The id for the user
+	 * @return {object} A JSON object with message
+	 */
+	deleteExchangeUser(user_id) {
+		const verb = 'DELETE';
+		let path = `${this.baseUrl}/admin/user`;
+		const data = {
+			user_id
+		};
+		
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter,
+			data
+		);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
+	}
+	
 	
 	/**
 	 * Create wallet for exchange user
@@ -2420,11 +2452,11 @@ class HollaExKit {
 		};
 
 		if(isString(opts.title)) {
-			data.title = opts.title
+			data.title = opts.title;
 		}
 		
 		if(isString(opts.text)) {
-			data.text = opts.text
+			data.text = opts.text;
 		}
 	
 		const headers = generateHeaders(
@@ -2445,39 +2477,166 @@ class HollaExKit {
 	 * @param {string} opts.format - Custom format of data set. Enum: ['all', 'csv']
 	 * @return {object} A JSON object with referral info
 	 */
-		getExchangeUserBalances(
-			opts = {
-				userId: null,
-				currency: null,
-				format: null
-			}
-		) {
-			const verb = 'GET';
-			let path = `${this.baseUrl}/admin/balances?`;
+	getExchangeUserBalances(
+		opts = {
+			userId: null,
+			currency: null,
+			format: null
+		}
+	) {
+		const verb = 'GET';
+		let path = `${this.baseUrl}/admin/balances?`;
 		
 			
-			if (isNumber(opts.userId)) {
-				path += `&user_id=${opts.userId}`;
-			}
+		if (isNumber(opts.userId)) {
+			path += `&user_id=${opts.userId}`;
+		}
 			
-			if (isString(opts.currency)) {
-				path += `&currency=${opts.currency}`;
-			}
+		if (isString(opts.currency)) {
+			path += `&currency=${opts.currency}`;
+		}
 			
-			if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
-				path += `&format=${opts.format}`;
-			}
+		if (isString(opts.format) && ['csv', 'all'].includes(opts.format)) {
+			path += `&format=${opts.format}`;
+		}
 		
-			const headers = generateHeaders(
-				this.headers,
-				this.apiSecret,
-				verb,
-				path,
-				this.apiExpiresAfter
-			);
-			return createRequest(verb, `${this.apiUrl}${path}`, headers);
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter
+		);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers);
+	}
+
+	/**
+	 * Create order on behalf of user
+	 * @param {number} user_id - User id for the order
+	 * @param {string} symbol - Currency symbol of the order e.g. xht-usdt
+	 * @param {number} size - Size of the order
+	 * @param {number} price - Order Price
+	 * @param {string} side - Order Side, buy or sell
+	 * @param {string} type - Order Type, limit or market
+	 */
+	createOrderByAdmin(
+		user_id,
+		symbol,
+		size,
+		price,
+		side,
+		type
+	) {
+		const verb = 'POST';
+		let path = `${this.baseUrl}/admin/order`;
+
+		const data = {
+			user_id,
+			size,
+			side,
+			type,
+			price,
+			symbol
+		};
+		
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter,
+			data
+		);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
+	}
+	
+	/**
+	 * Create trade on behalf of users
+	 * @param {number} maker_id - User id for the maker
+	 * @param {number} taker_id - User id for the taker
+	 * @param {number} maker_fee - fee in percentage for the maker
+	 * @param {number} taker_fee - fee in percentage for the taker
+	 * @param {string} symbol - Currency symbol of the order e.g. xht-usdt
+	 * @param {number} size - Size of the order
+	 * @param {number} price - Order Price
+	 * @param {string} side - Order Side, buy or sell
+	 */
+	createTradeByAdmin(
+		maker_id,
+		taker_id,
+		maker_fee,
+		taker_fee,
+		symbol,
+		size,
+		price,
+		side,
+	) {
+		const verb = 'POST';
+		let path = `${this.baseUrl}/admin/trade`;
+
+		const data = {
+			maker_id,
+			taker_id,
+			maker_fee,
+			taker_fee,
+			symbol,
+			size,
+			price,
+			side,
+		};
+		
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter,
+			data
+		);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
+	}
+	/**
+	 * Create withdrawal on behalf of users
+	 * @param {number} user_id - User id for the withdrawal process
+	 * @param {string} address - Specific address for the withdrawal
+	 * @param {number} amount - Size of the withdrawal
+	 * @param {string} currency - Currency symbol of the withdrawal
+	 * @param {string} opts.network - Blockchain network
+	 */
+	createWithdrawalByAdmin(
+		user_id,
+		address,
+		amount,
+		currency,
+		opts = {
+			network: null
+		}
+	) {
+		const verb = 'POST';
+		let path = `${this.baseUrl}/admin/withdrawal`;
+
+		const data = {
+			user_id,
+			address,
+			amount,
+			currency
+		};
+		
+		if(isString(opts.network)) {
+			data.network = opts.network;
 		}
 
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter,
+			data
+		);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
+	}
+
 	/**
 	 * Connect to hollaEx websocket and listen to an event
 	 * @param {array} events - The events to listen to

package/package.json

@@ -1,6 +1,6 @@
 {
 	"name": "hollaex-node-lib",
-	"version": "2.18.0",
+	"version": "2.19.0",
 	"description": "hollaex api and websocket library for nodejs",
 	"main": "index.js",
 	"dependencies": {