@docbrasil/api-systemmanager 1.1.75 → 1.1.77

package/doc/api.md

@@ -478,6 +478,11 @@ Admin Class for lists, permission admin
 * [AdminLists](#AdminLists)
     * [.findById(params, session)](#AdminLists+findById) ⇒ <code>Promise</code>
     * [.find(params, session)](#AdminLists+find) ⇒ <code>Promise</code>
+    * [.filterByName(params, session)](#AdminLists+filterByName) ⇒ <code>Promise.&lt;array&gt;</code>
+    * [.create(params, session)](#AdminLists+create) ⇒ <code>Promise.&lt;object&gt;</code>
+    * [.update(params, session)](#AdminLists+update) ⇒ <code>Promise.&lt;object&gt;</code>
+    * [.remove(params, session)](#AdminLists+remove) ⇒ <code>Promise.&lt;object&gt;</code>
+    * [.updateListItems(params, session)](#AdminLists+updateListItems) ⇒ <code>Promise.&lt;object&gt;</code>
 
 <a name="AdminLists+findById"></a>
 
@@ -533,6 +538,138 @@ const params = {
 const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
 await api.admin.list.find(params, session);
 ```
+<a name="AdminLists+filterByName"></a>
+
+### adminLists.filterByName(params, session) ⇒ <code>Promise.&lt;array&gt;</code>
+Filter organization lists by name
+
+**Kind**: instance method of [<code>AdminLists</code>](#AdminLists)  
+**Returns**: <code>Promise.&lt;array&gt;</code> - Array of matching org lists sorted by name  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| params | <code>object</code> |  | Parameters |
+| params.orgId | <code>string</code> |  | Organization ID (required) |
+| [params.names] | <code>array</code> | <code>[]</code> | Array of list names to filter (empty = all) |
+| session | <code>string</code> |  | JWT session token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = { orgId: '5edd11c46b6ce9729c2c297c', names: ['Tags', 'Categorias'] };
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const lists = await api.admin.list.filterByName(params, session);
+```
+<a name="AdminLists+create"></a>
+
+### adminLists.create(params, session) ⇒ <code>Promise.&lt;object&gt;</code>
+Create a new organization list
+
+**Kind**: instance method of [<code>AdminLists</code>](#AdminLists)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - Created list document  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Default | Description |
+| --- | --- | --- | --- |
+| params | <code>object</code> |  | Parameters |
+| params.orgId | <code>string</code> |  | Organization ID (required) |
+| params.name | <code>string</code> |  | List name (required) |
+| [params.list] | <code>array</code> | <code>[]</code> | Initial list items |
+| session | <code>string</code> |  | JWT session token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = { orgId: '5edd11c46b6ce9729c2c297c', name: 'My List', list: [] };
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const list = await api.admin.list.create(params, session);
+```
+<a name="AdminLists+update"></a>
+
+### adminLists.update(params, session) ⇒ <code>Promise.&lt;object&gt;</code>
+Update an organization list
+
+**Kind**: instance method of [<code>AdminLists</code>](#AdminLists)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - Updated list document  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Parameters |
+| params.orgId | <code>string</code> | Organization ID (required) |
+| params.id | <code>string</code> | List ID (required) |
+| params.data | <code>object</code> | Fields to update (name, list, etc.) |
+| session | <code>string</code> | JWT session token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = { orgId: '5edd11c46b6ce9729c2c297c', id: '55e4a3bd6be6b45210833fae', data: { name: 'Renamed' } };
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const list = await api.admin.list.update(params, session);
+```
+<a name="AdminLists+remove"></a>
+
+### adminLists.remove(params, session) ⇒ <code>Promise.&lt;object&gt;</code>
+Remove an organization list
+
+**Kind**: instance method of [<code>AdminLists</code>](#AdminLists)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - Removal confirmation  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Parameters |
+| params.orgId | <code>string</code> | Organization ID (required) |
+| params.id | <code>string</code> | List ID to remove (required) |
+| session | <code>string</code> | JWT session token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = { orgId: '5edd11c46b6ce9729c2c297c', id: '55e4a3bd6be6b45210833fae' };
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.admin.list.remove(params, session);
+```
+<a name="AdminLists+updateListItems"></a>
+
+### adminLists.updateListItems(params, session) ⇒ <code>Promise.&lt;object&gt;</code>
+Update list items of an organization list
+
+**Kind**: instance method of [<code>AdminLists</code>](#AdminLists)  
+**Returns**: <code>Promise.&lt;object&gt;</code> - Updated list document  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Parameters |
+| params.orgId | <code>string</code> | Organization ID (required) |
+| params.id | <code>string</code> | List ID (required) |
+| params.list | <code>array</code> | Updated list items array (required) |
+| session | <code>string</code> | JWT session token |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  orgId: '5edd11c46b6ce9729c2c297c',
+  id: '55e4a3bd6be6b45210833fae',
+  list: [{ _id: '1', value: 'Item 1', filter: '', order: 0 }]
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+const list = await api.admin.list.updateListItems(params, session);
+```
 <a name="AdminMessage"></a>
 
 ## AdminMessage
@@ -2330,6 +2467,7 @@ Class for user registration in a user
     * [.getTopics(filter, session)](#Help+getTopics)
     * [.get(params, session)](#Help+get) ⇒ <code>promise</code>
     * [.listExternalUrls(session)](#Help+listExternalUrls) ⇒ <code>promise.&lt;Array&gt;</code>
+    * [.updateSchedule(params, session)](#Help+updateSchedule) ⇒ <code>promise.&lt;object&gt;</code>
 
 <a name="Help+getTopics"></a>
 
@@ -2409,6 +2547,37 @@ const externalUrls = await api.user.help.listExternalUrls(session);
 //   }
 // ]
 ```
+<a name="Help+updateSchedule"></a>
+
+### help.updateSchedule(params, session) ⇒ <code>promise.&lt;object&gt;</code>
+Update a schedule associated with a help page.
+Allows partial updates (e.g., just the cron expression).
+
+**Kind**: instance method of [<code>Help</code>](#Help)  
+**Returns**: <code>promise.&lt;object&gt;</code> - Updated schedule document  
+**Access**: public  
+**Author**: Myndware <augusto.pissarra@myndware.com>  
+
+| Param | Type | Description |
+| --- | --- | --- |
+| params | <code>object</code> | Params for update |
+| params.id | <code>string</code> | Schedule id (_id database) |
+| params.data | <code>object</code> | Partial update data (e.g., { schedule: { cron: '0 9 * * *' } }) |
+| session | <code>string</code> | Session, token JWT |
+
+**Example**  
+```js
+const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const params = {
+  id: '5dadd01dc4af3941d42f8c5c',
+  data: {
+    schedule: { cron: '0 9 * * *' }
+  }
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.help.updateSchedule(params, session);
+```
 <a name="Users"></a>
 
 ## Users