npm - @docbrasil/api-systemmanager - Versions diffs - 1.1.7 → 1.1.9 - Mend

@docbrasil/api-systemmanager 1.1.7 → 1.1.9

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.

Files changed (76) hide show

package/api/user/document.js +15 -2
package/api/user/index.js +2 -0
package/api/user/settings.js +144 -0
package/dist/bundle.cjs +155 -2
package/dist/bundle.mjs +1 -1
package/doc/api.md +79 -0
package/docs/Admin.html +1 -1
package/docs/AdminDocuments.html +1 -1
package/docs/AdminForm.html +1 -1
package/docs/AdminLists.html +1 -1
package/docs/AdminMessage.html +1 -1
package/docs/AdminNotification.html +1 -1
package/docs/AdminPlugin.html +1 -1
package/docs/AdminPolicy.html +1 -1
package/docs/AdminProcesses.html +1 -1
package/docs/AdminTask.html +1 -1
package/docs/AdminUser.html +1 -1
package/docs/Application.html +1 -1
package/docs/Datasource.html +1 -1
package/docs/Dispatch.html +1 -1
package/docs/Documents.html +13 -13
package/docs/External.html +1 -1
package/docs/GeoLocation.html +1 -1
package/docs/Help.html +1 -1
package/docs/Login.html +1 -1
package/docs/MyTasks.html +1 -1
package/docs/Notification.html +1 -1
package/docs/Organization.html +1 -1
package/docs/Page.html +1 -1
package/docs/Process.html +1 -1
package/docs/Register.html +1 -1
package/docs/Session.html +1 -1
package/docs/Settings.html +863 -0
package/docs/Task.html +1 -1
package/docs/TaskAvailable.html +1 -1
package/docs/Updates.html +1 -1
package/docs/User.html +1 -1
package/docs/Users.html +2 -2
package/docs/admin_doctypes.js.html +1 -1
package/docs/admin_document.js.html +1 -1
package/docs/admin_form.js.html +1 -1
package/docs/admin_index.js.html +1 -1
package/docs/admin_list.js.html +1 -1
package/docs/admin_message.js.html +1 -1
package/docs/admin_notification.js.html +1 -1
package/docs/admin_organization.js.html +1 -1
package/docs/admin_plugin.js.html +1 -1
package/docs/admin_policy.js.html +1 -1
package/docs/admin_processes.js.html +1 -1
package/docs/admin_task.js.html +1 -1
package/docs/admin_user.js.html +1 -1
package/docs/dispatch.js.html +1 -1
package/docs/external.js.html +1 -1
package/docs/general_geoLocation.js.html +1 -1
package/docs/general_index.js.html +1 -1
package/docs/index.html +1 -1
package/docs/login.js.html +1 -1
package/docs/session.js.html +1 -1
package/docs/user_application.js.html +1 -1
package/docs/user_datasource.js.html +1 -1
package/docs/user_document.js.html +16 -3
package/docs/user_help.js.html +1 -1
package/docs/user_index.js.html +3 -1
package/docs/user_my_tasks.js.html +1 -1
package/docs/user_notification.js.html +1 -1
package/docs/user_organization.js.html +1 -1
package/docs/user_page.js.html +1 -1
package/docs/user_process.js.html +1 -1
package/docs/user_register.js.html +1 -1
package/docs/user_settings.js.html +261 -0
package/docs/user_task.js.html +1 -1
package/docs/user_task_available.js.html +1 -1
package/docs/user_updates.js.html +1 -1
package/docs/user_user.js.html +1 -1
package/docs/utils_promises.js.html +1 -1
package/package.json +1 -1

package/docs/Settings.html ADDED Viewed

@@ -0,0 +1,863 @@
+<!DOCTYPE html>
+<html lang="en">
+<head>
+  <meta charset="utf-8">
+  <meta name="viewport" content="width=device-width, initial-scale=1">
+  <title> Settings</title>
+  <script src="https://cdn.jsdelivr.net/gh/google/code-prettify@master/loader/run_prettify.js"></script>
+  <script src="https://unpkg.com/@babel/standalone/babel.min.js"></script>
+  <script src="./build/entry.js"></script>
+  <script src="https://ajax.googleapis.com/ajax/libs/jquery/3.3.1/jquery.min.js"></script>
+  <!--[if lt IE 9]>
+    <script src="//html5shiv.googlecode.com/svn/trunk/html5.js"></script>
+  <![endif]-->
+  <link href="https://fonts.googleapis.com/css?family=Roboto:100,400,700|Inconsolata,700" rel="stylesheet">
+  <link rel="stylesheet" href="https://use.fontawesome.com/releases/v5.6.3/css/all.css" integrity="sha384-UHRtZLI+pbxtHCWp1t77Bi1L4ZtiqrqD80Kn4Z8NTSRyMA2Fd33n5dQ8lWUE00s/" crossorigin="anonymous">
+  <link type="text/css" rel="stylesheet" href="https://jmblog.github.io/color-themes-for-google-code-prettify/themes/tomorrow-night.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/app.min.css">
+  <link type="text/css" rel="stylesheet" href="styles/iframe.css">
+  <link type="text/css" rel="stylesheet" href="">
+  <script async defer src="https://buttons.github.io/buttons.js"></script>
+</head>
+<body class="layout small-header">
+    <div id="stickyNavbarOverlay"></div>
+<div class="top-nav">
+    <div class="inner">
+        <a id="hamburger" role="button" class="navbar-burger" aria-label="menu" aria-expanded="false">
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+            <span aria-hidden="true"></span>
+        </a>
+        <div class="logo">
+        </div>
+        <div class="menu">
+            <div class="navigation">
+                <a
+                    href="index.html"
+                    class="link"
+                >
+                    Documentation
+                </a>
+            </div>
+        </div>
+    </div>
+</div>
+    <div id="main">
+        <div
+            class="sidebar "
+            id="sidebarNav"
+        >
+            <nav>
+                    <h2><a href="index.html">Documentation</a></h2><div class="category"><h3>Classes</h3><ul><li><a href="Admin.html">Admin</a></li><li><a href="AdminDocuments.html">AdminDocuments</a></li><li><a href="AdminForm.html">AdminForm</a></li><li><a href="AdminLists.html">AdminLists</a></li><li><a href="AdminMessage.html">AdminMessage</a></li><li><a href="AdminNotification.html">AdminNotification</a></li><li><a href="AdminPlugin.html">AdminPlugin</a></li><li><a href="AdminPolicy.html">AdminPolicy</a></li><li><a href="AdminProcesses.html">AdminProcesses</a></li><li><a href="AdminTask.html">AdminTask</a></li><li><a href="AdminUser.html">AdminUser</a></li><li><a href="Application.html">Application</a></li><li><a href="Datasource.html">Datasource</a></li><li><a href="Dispatch.html">Dispatch</a></li><li><a href="Documents.html">Documents</a></li><li><a href="External.html">External</a></li><li><a href="GeoLocation.html">GeoLocation</a></li><li><a href="Help.html">Help</a></li><li><a href="Login.html">Login</a></li><li><a href="MyTasks.html">MyTasks</a></li><li><a href="Notification.html">Notification</a></li><li><a href="Organization.html">Organization</a></li><li><a href="Page.html">Page</a></li><li><a href="Process.html">Process</a></li><li><a href="Register.html">Register</a></li><li><a href="Session.html">Session</a></li><li><a href="Settings.html">Settings</a></li><li><a href="Task.html">Task</a></li><li><a href="TaskAvailable.html">TaskAvailable</a></li><li><a href="Updates.html">Updates</a></li><li><a href="User.html">User</a></li><li><a href="Users.html">Users</a></li></ul></div>
+            </nav>
+        </div>
+        <div class="core" id="main-content-wrapper">
+            <div class="content">
+                <header class="page-title">
+                    <p>Class</p>
+                    <h1>Settings</h1>
+                </header>
+<section>
+<header>
+        <h2><span class="attribs"><span class="type-signature"></span></span>Settings<span class="signature">()</span><span class="type-signature"></span></h2>
+            <div class="class-description">Class for user settings</div>
+</header>
+<article>
+    <div class="container-overview">
+            <div class='vertical-section'>
+                <div class="members">
+                    <div class="member">
+                        <div class=name>
+                            <span class="tag">Constructor</span>
+                        </div>
+    <h4 class="name" id="Settings">
+        <a class="href-link" href="#Settings">#</a>
+        <span class="code-name">
+                new Settings<span class="signature">()</span><span class="type-signature"></span>
+        </span>
+    </h4>
+<dl class="details">
+        <p class="tag-source">
+            <a href="user_settings.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_settings.js.html">user/settings.js</a>, <a href="user_settings.js.html#line9">line 9</a>
+            </span>
+        </p>
+</dl>
+                    </div>
+                </div>
+            </div>
+    </div>
+        <div class='vertical-section'>
+            <h1>Methods</h1>
+            <div class="members">
+                <div class="member">
+    <h4 class="name" id="get">
+        <a class="href-link" href="#get">#</a>
+                <span class='tag'>async</span>
+        <span class="code-name">
+                get<span class="signature">(session)</span><span class="type-signature"> &rarr; {Promise}</span>
+        </span>
+    </h4>
+    <div class="description">
+        Gets the user settings
+    </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>session</code></td>
+  <td class="type">
+<code class="param-type">string</code>
+  </td>
+  <td class="description last">Is token JWT of user NOT allow SU</td>
+</tr>
+        </tbody>
+    </table>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+        </ul>
+    </dd>
+        <p class="tag-source">
+            <a href="user_settings.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_settings.js.html">user/settings.js</a>, <a href="user_settings.js.html#line101">line 101</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='column is-5 has-text-left'>
+        <label>Type: </label>
+<code class="param-type">Promise</code>
+    </div>
+</div>
+        </div>
+    </div>
+    <h5>Example</h5>
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.settings.get(session);</code></pre>
+</div>
+                <div class="member">
+    <h4 class="name" id="remove">
+        <a class="href-link" href="#remove">#</a>
+                <span class='tag'>async</span>
+        <span class="code-name">
+                remove<span class="signature">(session)</span><span class="type-signature"> &rarr; {Promise}</span>
+        </span>
+    </h4>
+    <div class="description">
+        Removes the user settings
+    </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>session</code></td>
+  <td class="type">
+<code class="param-type">string</code>
+  </td>
+  <td class="description last">Is token JWT of user NOT allow SU</td>
+</tr>
+        </tbody>
+    </table>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+        </ul>
+    </dd>
+        <p class="tag-source">
+            <a href="user_settings.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_settings.js.html">user/settings.js</a>, <a href="user_settings.js.html#line129">line 129</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='column is-5 has-text-left'>
+        <label>Type: </label>
+<code class="param-type">Promise</code>
+    </div>
+</div>
+        </div>
+    </div>
+    <h5>Example</h5>
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.settings.remove(session);</code></pre>
+</div>
+                <div class="member">
+    <h4 class="name" id="upsert">
+        <a class="href-link" href="#upsert">#</a>
+                <span class='tag'>async</span>
+        <span class="code-name">
+                upsert<span class="signature">(settings, session)</span><span class="type-signature"> &rarr; {Promise}</span>
+        </span>
+    </h4>
+    <div class="description">
+        Adds/updates a user settings
+    </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>settings</code></td>
+  <td class="type">
+<code class="param-type">object</code>
+  </td>
+  <td class="description last">Full user settings</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">Is token JWT of user NOT allow SU</td>
+</tr>
+        </tbody>
+    </table>
+</div>
+<dl class="details">
+    <dt class="tag-author">Author:</dt>
+    <dd class="tag-author">
+        <ul>
+            <li><a href="mailto:abernardo.br@gmail.com">CloudBrasil</a></li>
+        </ul>
+    </dd>
+        <p class="tag-source">
+            <a href="user_settings.js.html" class="button">View Source</a>
+            <span>
+                <a href="user_settings.js.html">user/settings.js</a>, <a href="user_settings.js.html#line73">line 73</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='column is-5 has-text-left'>
+        <label>Type: </label>
+<code class="param-type">Promise</code>
+    </div>
+</div>
+        </div>
+    </div>
+    <h5>Example</h5>
+        <pre class="prettyprint"><code>const API = require('@docbrasil/api-systemmanager');
+const api = new API();
+const settings = {
+ areaId: '55e4a3bd6be6b45210833fae'
+};
+const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
+await api.user.settings.upsert(settings, session);</code></pre>
+</div>
+            </div>
+        </div>
+</article>
+</section>
+            </div>
+            <footer class="footer">
+                <div class="content has-text-centered">
+                    <p>Documentation generated by <a href="https://github.com/jsdoc3/jsdoc">JSDoc 4.0.2</a></p>
+                    <p class="sidebar-created-by">
+                        <a href="https://github.com/SoftwareBrothers/better-docs" target="_blank">BetterDocs theme</a> provided with <i class="fas fa-heart"></i> by
+                        <a href="http://softwarebrothers.co" target="_blank">SoftwareBrothers - JavaScript Development Agency</a>
+                    </p>
+                </div>
+            </footer>
+        </div>
+        <div id="side-nav" class="side-nav">
+        </div>
+    </div>
+<script src="scripts/app.min.js"></script>
+<script>PR.prettyPrint();</script>
+<script src="scripts/linenumber.js"> </script>
+</body>
+</html>