hollaex-node-lib 2.15.0 → 2.15.2

package/README.md

@@ -107,6 +107,8 @@ client
 | `deactivateExchangeUserOtp` | <ul><li>**userId**: The identifier of the user to deactivate their otp</li></ul> | Deactivate user otp by admin |
 | `getExchangeUserReferrals` | <ul><li>**userId**: The identifier of the user to filter by</li><li>**opts.limit**: Amount of referrals per page. Maximum: 50. Default: 50</li><li>**opts.page**: Page of referral 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></ul> | Retrieve user's referrals info by admin |
 | `getExchangeUserReferrer` | <ul><li>**userId**: The identifier of the user to filter by</li></ul> | Retrieve user's referer info by admin |
+| `sendExchangeUserEmail` | <ul><li>**userId**:  The identifier of the user</li><li>**mailType**: The mail type for the email payload</li><li>**data**: The content of the mail</li></ul> | Send email to exchange user account by admin |
+| `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 |
 
 
 ### Websocket
@@ -143,12 +145,14 @@ client.unsubscribe(['orderbook']);
 
 Here is the list of channels you can subscribe to:
 
-- `orderbook`
-- `trades`
+- `orderbook` (Available publicly)
+- `trade` (Available publicly)
 - `order` (Only available with authentication. Receive order updates)
+- `usertrade` (Only available with authentication. Receive user trades)
 - `wallet` (Only available with authentication. Receive balance updates)
 - `deposit` (Only available with authentication. Receive deposit notifications)
 - `withdrawal` (Only available with authentication. Receive withdrawal notifications)
+- `admin` (Only available with authentication for the exchange administrator. Receive exchange operations such as deposits and withdrawals of all users)
 
 
 For public channels (`orderbook`, `trade`), you can subscribe to specific symbols as follows:

package/kit.js

@@ -993,7 +993,7 @@ class HollaExKit {
 		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
 	}
 
-    /**
+	/**
 	 * Create exchange deposit by admin
 	 * @param {number} userId - The identifier of the user
 	 * @param {string} currency - The currency to specify
@@ -1371,7 +1371,6 @@ class HollaExKit {
 			orderBy: null,
 			order: null,
 			startDate: null,
-			startDate: null,
 			format: null
 		}
 	) {
@@ -2043,7 +2042,7 @@ class HollaExKit {
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
 	
-    /**
+	/**
 	 * Deactivate exchange user account by admin
 	 * @param {number} userId - The identifier of the user to deactivate their exchange account
 	 * @return {object} A JSON object with message
@@ -2173,7 +2172,72 @@ class HollaExKit {
 		return createRequest(verb, `${this.apiUrl}${path}`, headers);
 	}
 
+	/**
+	 * Send email to exchange user account by admin
+	 * @param {number} userId - The identifier of the user
+	 * @param {string} mailType - The mail type for the email payload
+	 * @param {object} data - The content of the mail
+	 * @return {object} A JSON object with message
+	 */
+	sendExchangeUserEmail(userId, mailType, data) {
+		const verb = 'POST';
+		let path = `${this.baseUrl}/admin/send-email`;
+		const data = {
+			user_id: userId,
+			mail_type: mailType,
+			data
+		};
+	
+		const headers = generateHeaders(
+			this.headers,
+			this.apiSecret,
+			verb,
+			path,
+			this.apiExpiresAfter,
+			data
+		);
+		return createRequest(verb, `${this.apiUrl}${path}`, headers, { data });
+	}
 
+	/**
+	 * Send email to users with custom html by admin
+	 * @param {array} receivers - The array of emails to send mail
+	 * @param {string} html - The stringified html content
+	 * @param {string} opts.title - The title of the mail
+	 * @param {string} opts.text - The text of the mail
+	 * @return {object} A JSON object with message
+	 */
+	sendRawEmail(receivers, html, opts = {
+		title: null,
+		text: null
+	}) {
+		const verb = 'POST';
+		let path = `${this.baseUrl}/admin/send-email/raw`;
+		const data = {
+			receivers,
+			html,
+		};
+
+		if(isString(opts.title)) {
+			data.title = opts.title
+		}
+		
+		if(isString(opts.text)) {
+			data.text = opts.text
+		}
+	
+		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.15.0",
+	"version": "2.15.2",
 	"description": "hollaex api and websocket library for nodejs",
 	"main": "index.js",
 	"dependencies": {