@docbrasil/api-systemmanager 1.1.75 → 1.1.77

package/docs/Help.html

@@ -863,6 +863,281 @@ const externalUrls = await api.user.help.listExternalUrls(session);
     
 
 
+</div>
+            
+                <div class="member">
+
+
+    
+    <h4 class="name" id="updateSchedule">
+        <a class="href-link" href="#updateSchedule">#</a>
+        
+            
+                <span class='tag'>async</span>
+            
+        
+        <span class="code-name">
+            
+                updateSchedule<span class="signature">(params, session)</span><span class="type-signature"> &rarr; {promise.&lt;object>}</span>
+            
+        </span>
+    </h4>
+    
+
+    
+    
+    <div class="description">
+        Update a schedule associated with a help page.
+Allows partial updates (e.g., just the cron expression).
+    </div>
+    
+
+
+
+
+
+
+
+
+
+    <h5>Parameters:</h5>
+    
+<div class="table-container">
+    <table class="params table">
+        <thead>
+        <tr>
+            
+            <th>Name</th>
+            
+
+            <th>Type</th>
+
+            
+
+            
+
+            <th class="last">Description</th>
+        </tr>
+        </thead>
+
+        <tbody>
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>params</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Params for update</td>
+</tr>
+
+  
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>id</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Schedule id (_id database)</td>
+</tr>
+
+  
+    
+<tr class="deep-level-1">
+  
+      <td class="name"><code>data</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">object</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Partial update data (e.g., { schedule: { cron: '0 9 * * *' } })</td>
+</tr>
+
+  
+
+
+        
+
+            
+<tr class="deep-level-0">
+  
+      <td class="name"><code>session</code></td>
+  
+
+  <td class="type">
+  
+      
+<code class="param-type">string</code>
+
+
+  
+  </td>
+
+  
+
+  
+
+  <td class="description last">Session, token JWT</td>
+</tr>
+
+
+        
+        </tbody>
+    </table>
+</div>
+
+
+
+
+
+<dl class="details">
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+
+    
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:augusto.pissarra@myndware.com">Myndware</a></li>
+        </ul>
+    </dd>
+    
+
+    
+
+    
+
+    
+    
+
+    
+
+    
+
+    
+        <p class="tag-source">
+            <a href="user_help.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_help.js.html">user/help.js</a>, <a href="user_help.js.html#line176">line 176</a>
+            </span>
+        </p>
+    
+</dl>
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+
+    <div class='columns method-parameter'>
+        <div class="column is-2"><label>Returns:</label></div>
+        <div class="column is-10">
+            
+                    
+
+<div class="columns">
+    
+    <div class='param-desc column is-7'>Updated schedule document</div>
+    
+    
+    <div class='column is-5 has-text-left'>
+        <label>Type: </label>
+        
+<code class="param-type">promise.&lt;object></code>
+
+
+    </div>
+    
+</div>
+
+                
+        </div>
+    </div>
+
+
+
+
+    <h5>Example</h5>
+    
+    
+        <pre class="prettyprint"><code>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);</code></pre>
+    
+
+
 </div>
             
             </div>

package/docs/admin_list.js.html

@@ -215,6 +215,220 @@ class AdminLists {
       throw ex;
     }
   }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Filter organization lists by name
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {array} [params.names=[]] Array of list names to filter (empty = all)
+   * @param {string} session JWT session token
+   * @return {Promise<array>} Array of matching org lists sorted by name
+   * @public
+   * @async
+   * @example
+   *
+   * 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);
+   */
+  async filterByName(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, names = [] } = params;
+      const payload = { names };
+
+      const apiCall = self._client.post(
+        `/admin/organizations/${orgId}/orgtags/filter`,
+        payload,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Create a new organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.name List name (required)
+   * @param {array} [params.list=[]] Initial list items
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Created list document
+   * @public
+   * @async
+   * @example
+   *
+   * 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);
+   */
+  async create(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.name, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, name, list = [] } = params;
+      const payload = { orgId, name, list };
+
+      const apiCall = self._client.put(
+        `/admin/organizations/${orgId}/orgtags`,
+        payload,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update an organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.id List ID (required)
+   * @param {object} params.data Fields to update (name, list, etc.)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated list document
+   * @public
+   * @async
+   * @example
+   *
+   * 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);
+   */
+  async update(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(params.data, Joi.object().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, id, data } = params;
+
+      const apiCall = self._client.put(
+        `/admin/organizations/${orgId}/orgtags/${id}`,
+        data,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Remove an organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.id List ID to remove (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Removal confirmation
+   * @public
+   * @async
+   * @example
+   *
+   * 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);
+   */
+  async remove(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, id } = params;
+
+      const apiCall = self._client.delete(
+        `/admin/organizations/${orgId}/orgtags/${id}`,
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update list items of an organization list
+   * @param {object} params Parameters
+   * @param {string} params.orgId Organization ID (required)
+   * @param {string} params.id List ID (required)
+   * @param {array} params.list Updated list items array (required)
+   * @param {string} session JWT session token
+   * @return {Promise<object>} Updated list document
+   * @public
+   * @async
+   * @example
+   *
+   * 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);
+   */
+  async updateListItems(params = {}, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required());
+      Joi.assert(params.orgId, Joi.string().required());
+      Joi.assert(params.id, Joi.string().required());
+      Joi.assert(params.list, Joi.array().required());
+      Joi.assert(session, Joi.string().required());
+
+      const { orgId, id, list } = params;
+
+      const apiCall = self._client.put(
+        `/admin/organizations/${orgId}/orgtags/${id}`,
+        { list },
+        self._setHeader(session)
+      );
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
 }
 
 export default AdminLists;

package/docs/user_help.js.html

@@ -237,6 +237,47 @@ class Help {
     }
   }
 
+  /**
+   * @author Myndware <augusto.pissarra@myndware.com>
+   * @description Update a schedule associated with a help page.
+   * Allows partial updates (e.g., just the cron expression).
+   * @param {object} params Params for update
+   * @param {string} params.id Schedule id (_id database)
+   * @param {object} params.data Partial update data (e.g., { schedule: { cron: '0 9 * * *' } })
+   * @param {string} session Session, token JWT
+   * @returns {promise<object>} Updated schedule document
+   * @public
+   * @example
+   *
+   * 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);
+   */
+  async updateSchedule(params, session) {
+    const self = this;
+
+    try {
+      Joi.assert(params, Joi.object().required(), 'Params to update schedule');
+      Joi.assert(params.id, Joi.string().required(), 'Schedule id (_id database)');
+      Joi.assert(params.data, Joi.object().required(), 'Data to update');
+      Joi.assert(session, Joi.string().required(), 'Session token JWT');
+
+      const { id, data } = params;
+      const apiCall = self._client.put(`/help/schedule/${id}`, data, self._setHeader(session));
+
+      return self._returnData(await apiCall);
+    } catch (ex) {
+      throw ex;
+    }
+  }
+
 }
 
 export default Help;

package/package.json

@@ -1,7 +1,7 @@
 {
   "name": "@docbrasil/api-systemmanager",
   "description": "Module API System Manager",
-  "version": "1.1.75",
+  "version": "1.1.77",
   "scripts": {
     "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
     "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",