@docbrasil/api-systemmanager 1.0.54 → 1.0.57

package/doc/api.md

@@ -19,6 +19,9 @@
 <dt><a href="#AdminNotification">AdminNotification</a></dt>
 <dd><p>Admin Class for notification, permission admin</p>
 </dd>
+<dt><a href="#Organization">Organization</a></dt>
+<dd><p>Class for organizations, permission user</p>
+</dd>
 <dt><a href="#AdminPlugin">AdminPlugin</a></dt>
 <dd><p>Admin Class for plugin, permission admin</p>
 </dd>
@@ -649,6 +652,191 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.admin.notifications.findByIdAndDelete(params, session);
 ```
+<a name="Organization"></a>
+
+## Organization
+Class for organizations, permission user
+
+**Kind**: global class  
+
+* [Organization](#Organization)
+    * [.upsertAvatar(params, session)](#Organization+upsertAvatar) ⇒ <code>Promise</code>
+    * [.removeAvatar(session)](#Organization+removeAvatar) ⇒ <code>Promise</code>
+    * [.findById(orgId, session)](#Organization+findById)
+    * [.idCardExist(idcard, session)](#Organization+idCardExist)
+    * [.upsertAvatar(params, session)](#Organization+upsertAvatar) ⇒ <code>Promise</code>
+    * [.removeAvatar(session)](#Organization+removeAvatar) ⇒ <code>Promise</code>
+    * [.callFetch(params)](#Organization+callFetch) ⇒ <code>promise</code>
+
+<a name="Organization+upsertAvatar"></a>
+
+### organization.upsertAvatar(params, session) ⇒ <code>Promise</code>
+Update avatar of organization by session of user not allow session user SU
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to update avatar |
+| params.orgId | <code>string</code> | Organization id |
+| params.avatar | <code>string</code> | Image in base64 to update |
+| params.type | <code>string</code> | MimeType (image/png) |
+| session | <code>string</code> | Is token JWT of user SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '5dadd01dc4af3941d42f8c5c',
+ avatar: 'iVBORw0KGgoAAAANSUhEUgAAAasAAAHnCAYAAAAGi3J6AAA9BElEQVR...He3/kk/m7kl35S8AAAAASUVORK5CYII=',
+ type: 'image/png',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.organizations.upsertAvatar(params, session);
+```
+<a name="Organization+removeAvatar"></a>
+
+### organization.removeAvatar(session) ⇒ <code>Promise</code>
+Remove avatar of user by session of user not allow session user SU
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params.orgId | <code>string</code> | Organization id |
+| session | <code>string</code> | Is token JWT of user SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const orgId = '5dadd01dc4af3941d42f8c5c';
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.organizations.removeAvatar(orgId, session);
+```
+<a name="Organization+findById"></a>
+
+### organization.findById(orgId, session)
+Find organization by id
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: Augusto Pissarra <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| orgId | <code>string</code> | ID of the organization to find (_id database) |
+| session | <code>string</code> | Is token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const orgId = '80443245000122';
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.organization.findById(idCard, session);
+```
+<a name="Organization+idCardExist"></a>
+
+### organization.idCardExist(idcard, session)
+Check if id card exist
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: Augusto Pissarra <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| idcard | <code>string</code> | Check if id card exist |
+| session | <code>string</code> | Is token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const idCard = '80443245000122';
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.organization.idCardExist(idCard, session);
+```
+<a name="Organization+upsertAvatar"></a>
+
+### organization.upsertAvatar(params, session) ⇒ <code>Promise</code>
+Update avatar of organization by session of user not allow session user SU
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to update avatar |
+| params.avatar | <code>string</code> | Image in base64 to update |
+| params.type | <code>string</code> | mimeType (image/png) |
+| session | <code>string</code> | Is token JWT of user NOT allow SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ avatar: 'iVBORw0KGgoAAAANSUhEUgAAAasAAAHnCAYAAAAGi3J6AAA9BElEQVR...He3/kk/m7kl35S8AAAAASUVORK5CYII=',
+ type: 'image/png',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.profile.updateAvatar(params, session);
+```
+<a name="Organization+removeAvatar"></a>
+
+### organization.removeAvatar(session) ⇒ <code>Promise</code>
+Remove avatar of user by session of user not allow session user SU
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| session | <code>string</code> | Is token JWT of user NOT allow SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.profile.removeAvatar(session);
+```
+<a name="Organization+callFetch"></a>
+
+### organization.callFetch(params) ⇒ <code>promise</code>
+Call URL internal, need auth JWT (session)
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: Thiago Anselmo <thiagoo.anselmoo@gmail.com>  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| params | <code>object</code> |  | Params to call fectch (URL internal) |
+| params.url | <code>string</code> |  | URL to call |
+| [params.method] | <code>string</code> | <code>&quot;POST&quot;</code> | Fetch Method |
+| params.payload | <code>string</code> |  | Payload to send system manager |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+
+const params = {
+  url: 'http://localhost:8080/organizations/..../process/..../task/candidateAccepted/end/....',
+  method: 'POST'
+}
+await api.user.organization.callFetchs(params, session);
+```
 <a name="AdminPlugin"></a>
 
 ## AdminPlugin
@@ -1505,12 +1693,65 @@ Class for organizations, permission user
 **Kind**: global class  
 
 * [Organization](#Organization)
+    * [.upsertAvatar(params, session)](#Organization+upsertAvatar) ⇒ <code>Promise</code>
+    * [.removeAvatar(session)](#Organization+removeAvatar) ⇒ <code>Promise</code>
     * [.findById(orgId, session)](#Organization+findById)
     * [.idCardExist(idcard, session)](#Organization+idCardExist)
     * [.upsertAvatar(params, session)](#Organization+upsertAvatar) ⇒ <code>Promise</code>
     * [.removeAvatar(session)](#Organization+removeAvatar) ⇒ <code>Promise</code>
     * [.callFetch(params)](#Organization+callFetch) ⇒ <code>promise</code>
 
+<a name="Organization+upsertAvatar"></a>
+
+### organization.upsertAvatar(params, session) ⇒ <code>Promise</code>
+Update avatar of organization by session of user not allow session user SU
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params to update avatar |
+| params.orgId | <code>string</code> | Organization id |
+| params.avatar | <code>string</code> | Image in base64 to update |
+| params.type | <code>string</code> | MimeType (image/png) |
+| session | <code>string</code> | Is token JWT of user SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+ orgId: '5dadd01dc4af3941d42f8c5c',
+ avatar: 'iVBORw0KGgoAAAANSUhEUgAAAasAAAHnCAYAAAAGi3J6AAA9BElEQVR...He3/kk/m7kl35S8AAAAASUVORK5CYII=',
+ type: 'image/png',
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.organizations.upsertAvatar(params, session);
+```
+<a name="Organization+removeAvatar"></a>
+
+### organization.removeAvatar(session) ⇒ <code>Promise</code>
+Remove avatar of user by session of user not allow session user SU
+
+**Kind**: instance method of [<code>Organization</code>](#Organization)  
+**Access**: public  
+**Author**: CloudBrasil <abernardo.br@gmail.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params.orgId | <code>string</code> | Organization id |
+| session | <code>string</code> | Is token JWT of user SU |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const orgId = '5dadd01dc4af3941d42f8c5c';
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.organizations.removeAvatar(orgId, session);
+```
 <a name="Organization+findById"></a>
 
 ### organization.findById(orgId, session)

package/package.json

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