@docbrasil/api-systemmanager 1.0.66 → 1.0.67

package/doc/api.md

@@ -49,7 +49,7 @@
 <dt><a href="#Users">Users</a></dt>
 <dd><p>API request, user permission level</p>
 </dd>
-<dt><a href="#Register">Register</a></dt>
+<dt><a href="#Notification">Notification</a></dt>
 <dd><p>Class for user registration in a user</p>
 </dd>
 <dt><a href="#Organization">Organization</a></dt>
@@ -1460,26 +1460,29 @@ API request, user permission level
 | options | <code>object</code> | Params of the constructor |
 | options.parent | <code>object</code> | This of the pararent |
 
-<a name="Register"></a>
+<a name="Notification"></a>
 
-## Register
+## Notification
 Class for user registration in a user
 
 **Kind**: global class  
 
-* [Register](#Register)
-    * [.addToken(params)](#Register+addToken) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
-    * [.execute(params)](#Register+execute) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code>
-    * [.getOrgname()](#Register+getOrgname) ⇒ <code>string</code>
-    * [.validateEmail(params)](#Register+validateEmail) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>string</code> \| <code>object</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>object</code> \| <code>string</code> \| <code>string</code>
-    * [.execute(params)](#Register+execute) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code>
+* [Notification](#Notification)
+    * [.tokenTypes](#Notification+tokenTypes) ⇒ <code>Object</code>
+    * [.addToken(params)](#Notification+addToken) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
 
-<a name="Register+addToken"></a>
+<a name="Notification+tokenTypes"></a>
 
-### register.addToken(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
+### notification.tokenTypes ⇒ <code>Object</code>
+Notification token types
+
+**Kind**: instance property of [<code>Notification</code>](#Notification)  
+<a name="Notification+addToken"></a>
+
+### notification.addToken(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
 Method to add a notification token
 
-**Kind**: instance method of [<code>Register</code>](#Register)  
+**Kind**: instance method of [<code>Notification</code>](#Notification)  
 **Returns**: <code>promise.&lt;object&gt;</code> - data<code>boolean</code> - data._id the id of the added token  
 **Access**: public  
 **Author**: CloudBrasil <abernardo.br@gmail.com>  
@@ -1500,167 +1503,6 @@ const params = {
 };
 const retData = await api.user.notification.addToken(params);
 ```
-<a name="Register+execute"></a>
-
-### register.execute(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code>
-Method to register a user
-
-**Kind**: instance method of [<code>Register</code>](#Register)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>boolean</code> - data.success If the operation was successfully done (true|false)<code>boolean</code> - data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned<code>object</code> - auth The full authentication data with session, if login is true.<code>string</code> - auth.redirectUrl The url to redirect.  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| params | <code>object</code> |  | Params to get task |
-| params.registerId | <code>string</code> |  | The registerId that comes with the registration page context |
-| params.type | <code>string</code> | <code>&quot;sign&quot;</code> | The type of the registration. By defailt, |
-| params.login | <code>boolean</code> | <code>false</code> | If we want to login the user directly after registering the user successfully. If you have a redirect, the best option is to login automatically. |
-| params.emailInfo | <code>object</code> |  | The information for the email validation |
-| params.emailInfo.email | <code>string</code> |  | The email validation information |
-| params.emailInfo.code | <code>string</code> |  | The 4 digit code to validate the email |
-| params.registerData | <code>object</code> |  | The registration data |
-| params.registerData.name | <code>string</code> |  | The name if the user |
-| params.registerData.registerEmail | <code>string</code> |  | The email of the user |
-| params.registerData.phone | <code>string</code> |  | The phone of the user |
-| params.registerData.idcard | <code>string</code> |  | The ID card of the user |
-| params.registerData.registerPassword | <code>string</code> |  | The user password in open text |
-| params.registerData.emailValidationCode | <code>string</code> |  | The code used to validate the email |
-| params.registerData.phoneValidationCode | <code>string</code> |  | The code used to validate the phone |
-| params.registerData.language | <code>string</code> |  | The defaulf navigator language (i.e.: navigator.language) |
-| params.registerData.timezone | <code>string</code> |  | The defaulf navigator timezone (i.e.: Intl.DateTimeFormat().resolvedOptions().timeZone) |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const params ={
-    "registerId": 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
-    "type": 'sign',
-    "login": false,
-    "emailInfo": {
-      "code": "5974",
-      "email": "cbtoto_1@mailinator.com"
-    },
-    "registerData": {
-      "name": "Augusto Totlo",
-      "registerEmail": "cbtoto_1@mailinator.com",
-      "phone": "",
-      "idcard": "",
-      "dob": "1978-01-12T03:00:00.000Z",
-      "registerPassword": "123456",
-      "emailValidationCode": "5974",
-      "phoneValidationCode": "",
-      "language": "en-US",
-      "timezone": "Europe/Dublin"
-    }
-  };
-const retData = await api.user.register.execute(params);
-```
-<a name="Register+getOrgname"></a>
-
-### register.getOrgname() ⇒ <code>string</code>
-**Kind**: instance method of [<code>Register</code>](#Register)  
-**Returns**: <code>string</code> - orgname The orgname of the organization in the registerId  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params.registerId | <code>object</code> | The registerId that comes with the registration page context |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const params = {
- registerId: 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...'
-};
-const orgname = await api.user.register.getOrgname(params);
-```
-<a name="Register+validateEmail"></a>
-
-### register.validateEmail(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>string</code> \| <code>object</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>object</code> \| <code>string</code> \| <code>string</code>
-Method to find task by id
-
-**Kind**: instance method of [<code>Register</code>](#Register)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>boolean</code> - data.success If the operation was successfully done (true|false)<code>boolean</code> - data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned<code>string</code> - data.registrationEmailInfoRaw The fully cryptographed registration information<code>object</code> - data.registrationEmailInfo The registration information<code>string</code> - data.registrationEmailInfo.orgname The orgname<code>string</code> - data.registrationEmailInfo.orgId The orgId of the organization<code>string</code> - data.registrationEmailInfo.guid The unique id for the registration<code>object</code> - data.registrationEmailInfo.emailValidation The email validation information<code>string</code> - data.registrationEmailInfo.emailValidation.email The email that the code was sent to<code>string</code> - data.registrationEmailInfo.emailValidation.code The 4 digit code to validate the email  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | Params to get task |
-| params.registerId | <code>string</code> | The registerId that comes with the registration page context |
-| params.email | <code>object</code> | The email to validate |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const params = {
- registerId: 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
- email: 'myemail@company.com'
-};
-const retData = await api.user.register.validateEmail(params);
-```
-<a name="Register+execute"></a>
-
-### register.execute(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code>
-Method to register a user
-
-**Kind**: instance method of [<code>Register</code>](#Register)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>boolean</code> - data.success If the operation was successfully done (true|false)<code>boolean</code> - data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned<code>object</code> - auth The full authentication data with session, if login is true.<code>string</code> - auth.redirectUrl The url to redirect.  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| params | <code>object</code> |  | Params to get task |
-| params.registerId | <code>string</code> |  | The registerId that comes with the registration page context |
-| params.type | <code>string</code> | <code>&quot;sign&quot;</code> | The type of the registration. By defailt, |
-| params.login | <code>boolean</code> | <code>false</code> | If we want to login the user directly after registering the user successfully. If you have a redirect, the best option is to login automatically. |
-| params.emailInfo | <code>object</code> |  | The information for the email validation |
-| params.emailInfo.email | <code>string</code> |  | The email validation information |
-| params.emailInfo.code | <code>string</code> |  | The 4 digit code to validate the email |
-| params.registerData | <code>object</code> |  | The registration data |
-| params.registerData.name | <code>string</code> |  | The name if the user |
-| params.registerData.registerEmail | <code>string</code> |  | The email of the user |
-| params.registerData.phone | <code>string</code> |  | The phone of the user |
-| params.registerData.idcard | <code>string</code> |  | The ID card of the user |
-| params.registerData.registerPassword | <code>string</code> |  | The user password in open text |
-| params.registerData.emailValidationCode | <code>string</code> |  | The code used to validate the email |
-| params.registerData.phoneValidationCode | <code>string</code> |  | The code used to validate the phone |
-| params.registerData.language | <code>string</code> |  | The defaulf navigator language (i.e.: navigator.language) |
-| params.registerData.timezone | <code>string</code> |  | The defaulf navigator timezone (i.e.: Intl.DateTimeFormat().resolvedOptions().timeZone) |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const params ={
-    "registerId": 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
-    "type": 'sign',
-    "login": false,
-    "emailInfo": {
-      "code": "5974",
-      "email": "cbtoto_1@mailinator.com"
-    },
-    "registerData": {
-      "name": "Augusto Totlo",
-      "registerEmail": "cbtoto_1@mailinator.com",
-      "phone": "",
-      "idcard": "",
-      "dob": "1978-01-12T03:00:00.000Z",
-      "registerPassword": "123456",
-      "emailValidationCode": "5974",
-      "phoneValidationCode": "",
-      "language": "en-US",
-      "timezone": "Europe/Dublin"
-    }
-  };
-const retData = await api.user.register.execute(params);
-```
 <a name="Organization"></a>
 
 ## Organization
@@ -1921,95 +1763,10 @@ Class for user registration in a user
 **Kind**: global class  
 
 * [Register](#Register)
-    * [.addToken(params)](#Register+addToken) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
-    * [.execute(params)](#Register+execute) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code>
     * [.getOrgname()](#Register+getOrgname) ⇒ <code>string</code>
     * [.validateEmail(params)](#Register+validateEmail) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>string</code> \| <code>object</code> \| <code>string</code> \| <code>string</code> \| <code>string</code> \| <code>object</code> \| <code>string</code> \| <code>string</code>
     * [.execute(params)](#Register+execute) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code>
 
-<a name="Register+addToken"></a>
-
-### register.addToken(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code>
-Method to add a notification token
-
-**Kind**: instance method of [<code>Register</code>](#Register)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>boolean</code> - data._id the id of the added token  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Description |
-| --- | --- | --- |
-| params | <code>object</code> | Params to add notification token |
-| params.token | <code>string</code> | The token |
-| params.type | <code>object</code> | The token type |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const params = {
- token: 'V6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz2',
- type: 'FCM_WEB'
-};
-const retData = await api.user.notification.addToken(params);
-```
-<a name="Register+execute"></a>
-
-### register.execute(params) ⇒ <code>promise.&lt;object&gt;</code> \| <code>boolean</code> \| <code>boolean</code> \| <code>object</code> \| <code>string</code>
-Method to register a user
-
-**Kind**: instance method of [<code>Register</code>](#Register)  
-**Returns**: <code>promise.&lt;object&gt;</code> - data<code>boolean</code> - data.success If the operation was successfully done (true|false)<code>boolean</code> - data.userAlreadyExists If the user already exists (true|false), if true, then the other information is not returned<code>object</code> - auth The full authentication data with session, if login is true.<code>string</code> - auth.redirectUrl The url to redirect.  
-**Access**: public  
-**Author**: CloudBrasil <abernardo.br@gmail.com>  
-
-| Param | Type | Default | Description |
-| --- | --- | --- | --- |
-| params | <code>object</code> |  | Params to get task |
-| params.registerId | <code>string</code> |  | The registerId that comes with the registration page context |
-| params.type | <code>string</code> | <code>&quot;sign&quot;</code> | The type of the registration. By defailt, |
-| params.login | <code>boolean</code> | <code>false</code> | If we want to login the user directly after registering the user successfully. If you have a redirect, the best option is to login automatically. |
-| params.emailInfo | <code>object</code> |  | The information for the email validation |
-| params.emailInfo.email | <code>string</code> |  | The email validation information |
-| params.emailInfo.code | <code>string</code> |  | The 4 digit code to validate the email |
-| params.registerData | <code>object</code> |  | The registration data |
-| params.registerData.name | <code>string</code> |  | The name if the user |
-| params.registerData.registerEmail | <code>string</code> |  | The email of the user |
-| params.registerData.phone | <code>string</code> |  | The phone of the user |
-| params.registerData.idcard | <code>string</code> |  | The ID card of the user |
-| params.registerData.registerPassword | <code>string</code> |  | The user password in open text |
-| params.registerData.emailValidationCode | <code>string</code> |  | The code used to validate the email |
-| params.registerData.phoneValidationCode | <code>string</code> |  | The code used to validate the phone |
-| params.registerData.language | <code>string</code> |  | The defaulf navigator language (i.e.: navigator.language) |
-| params.registerData.timezone | <code>string</code> |  | The defaulf navigator timezone (i.e.: Intl.DateTimeFormat().resolvedOptions().timeZone) |
-
-**Example**  
-```js
-const API = require('@docbrasil/api-systemmanager');
-const api = new API();
-const params ={
-    "registerId": 'U2FsdGVkX1+xEq+sV6OSBr4aEVoiE9H1b4xzLe+vqmXB+ShVNc/FvJGxnIz4tZv6jBJkk4aQzz24O5koH+rGmdl/DjqfyWfENe5NFuQ+6xXhuOSN24Z+Topo87+e+CrRO8ox...',
-    "type": 'sign',
-    "login": false,
-    "emailInfo": {
-      "code": "5974",
-      "email": "cbtoto_1@mailinator.com"
-    },
-    "registerData": {
-      "name": "Augusto Totlo",
-      "registerEmail": "cbtoto_1@mailinator.com",
-      "phone": "",
-      "idcard": "",
-      "dob": "1978-01-12T03:00:00.000Z",
-      "registerPassword": "123456",
-      "emailValidationCode": "5974",
-      "phoneValidationCode": "",
-      "language": "en-US",
-      "timezone": "Europe/Dublin"
-    }
-  };
-const retData = await api.user.register.execute(params);
-```
 <a name="Register+getOrgname"></a>
 
 ### register.getOrgname() ⇒ <code>string</code>

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.0.66",
+  "version": "1.0.67",
   "scripts": {
     "doc": "rm -f  doc/api.md && jsdoc2md api/**/** > doc/api.md",
     "build": "node bundleRollup.js"