@docbrasil/api-systemmanager 1.1.13 → 1.1.15

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.
package/doc/api.md CHANGED
@@ -1897,6 +1897,10 @@ Class for my tasks, permission user
1897
1897
  * [.getTaskMultiUsers(params, session)](#MyTasks+getTaskMultiUsers) ⇒ <code>promise</code>
1898
1898
  * [.removeMultiTaskUser(params, session)](#MyTasks+removeMultiTaskUser) ⇒ <code>Promise</code>
1899
1899
  * [.addMultiTaskUser(params, session)](#MyTasks+addMultiTaskUser) ⇒ <code>Promise</code>
1900
+ * [.getAssignTaskUsers(params, session)](#MyTasks+getAssignTaskUsers) ⇒ <code>promise</code>
1901
+ * [.assignTaskUsers(params, session)](#MyTasks+assignTaskUsers) ⇒ <code>Promise</code>
1902
+ * [.unclaim(params, session)](#MyTasks+unclaim) ⇒ <code>Promise</code>
1903
+ * [.escalate(params, session)](#MyTasks+escalate) ⇒ <code>Promise</code>
1900
1904
 
1901
1905
  <a name="MyTasks+find"></a>
1902
1906
 
@@ -2066,6 +2070,116 @@ const params = {
2066
2070
  const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2067
2071
  await api.user.task.mytasks.addMultiTaskUser(params, session);
2068
2072
  ```
2073
+ <a name="MyTasks+getAssignTaskUsers"></a>
2074
+
2075
+ ### myTasks.getAssignTaskUsers(params, session) ⇒ <code>promise</code>
2076
+ Method to get assign task users
2077
+
2078
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
2079
+ **Access**: public
2080
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
2081
+
2082
+ | Param | Type | Description |
2083
+ | --- | --- | --- |
2084
+ | params | <code>object</code> | Params to get task |
2085
+ | params.taskId | <code>object</code> | Task id (_id database) |
2086
+ | params.orgId | <code>object</code> | Organization id (_id database) |
2087
+ | session | <code>string</code> | Session, token JWT |
2088
+
2089
+ **Example**
2090
+ ```js
2091
+ const API = require('@docbrasil/api-systemmanager');
2092
+ const api = new API();
2093
+ const params = {
2094
+ taskId: '5df7f19618430c89a41a19d2',
2095
+ orgId: '55e4a3bd6be6b45210833fae',
2096
+ };
2097
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2098
+ await api.user.task.mytasks.getAssignTaskUsers(params, session);
2099
+ ```
2100
+ <a name="MyTasks+assignTaskUsers"></a>
2101
+
2102
+ ### myTasks.assignTaskUsers(params, session) ⇒ <code>Promise</code>
2103
+ Assign Task user
2104
+
2105
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
2106
+ **Access**: public
2107
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
2108
+
2109
+ | Param | Type | Description |
2110
+ | --- | --- | --- |
2111
+ | params | <code>object</code> | The params to assign task to user |
2112
+ | params.orgName | <code>string</code> | Organization Name |
2113
+ | params.userId | <code>string</code> | User id that will be assigned the task |
2114
+ | params.taskId | <code>string</code> | Task Id |
2115
+ | session | <code>string</code> | Is token JWT of user |
2116
+
2117
+ **Example**
2118
+ ```js
2119
+ const API = require('@docbrasil/api-systemmanager');
2120
+ const api = new API();
2121
+ const params = {
2122
+ orgName: 'pinkbrain',
2123
+ userId: '646386c9583e04a131adc894',
2124
+ taskId: '646386c9583e04a131adc895'
2125
+ };
2126
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2127
+ await api.user.task.mytasks.assignTaskUser(params, session);
2128
+ ```
2129
+ <a name="MyTasks+unclaim"></a>
2130
+
2131
+ ### myTasks.unclaim(params, session) ⇒ <code>Promise</code>
2132
+ Unclaim task
2133
+
2134
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
2135
+ **Access**: public
2136
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
2137
+
2138
+ | Param | Type | Description |
2139
+ | --- | --- | --- |
2140
+ | params | <code>object</code> | The params to unclaim task |
2141
+ | params.orgName | <code>string</code> | Organization Name |
2142
+ | params.taskId | <code>string</code> | Task Id |
2143
+ | session | <code>string</code> | Is token JWT of user |
2144
+
2145
+ **Example**
2146
+ ```js
2147
+ const API = require('@docbrasil/api-systemmanager');
2148
+ const api = new API();
2149
+ const params = {
2150
+ orgName: 'pinkbrain',
2151
+ taskId: '646386c9583e04a131adc895'
2152
+ };
2153
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2154
+ await api.user.task.mytasks.unclaim(params, session);
2155
+ ```
2156
+ <a name="MyTasks+escalate"></a>
2157
+
2158
+ ### myTasks.escalate(params, session) ⇒ <code>Promise</code>
2159
+ Escalate task
2160
+
2161
+ **Kind**: instance method of [<code>MyTasks</code>](#MyTasks)
2162
+ **Access**: public
2163
+ **Author**: CloudBrasil <abernardo.br@gmail.com>
2164
+
2165
+ | Param | Type | Description |
2166
+ | --- | --- | --- |
2167
+ | params | <code>object</code> | The params to escalate task |
2168
+ | params.orgName | <code>string</code> | Organization Name |
2169
+ | params.taskId | <code>string</code> | Task Id |
2170
+ | session | <code>string</code> | Is token JWT of user |
2171
+
2172
+ **Example**
2173
+ ```js
2174
+ const API = require('@docbrasil/api-systemmanager');
2175
+ const api = new API();
2176
+ const params = {
2177
+ orgName: 'pinkbrain',
2178
+ taskId: '646386c9583e04a131adc895'
2179
+ };
2180
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
2181
+ await api.user.task.mytasks.escalate(params, session);
2182
+ ```
2069
2183
  <a name="Notification"></a>
2070
2184
 
2071
2185
  ## Notification
package/package.json CHANGED
@@ -1,7 +1,7 @@
1
1
  {
2
2
  "name": "@docbrasil/api-systemmanager",
3
3
  "description": "Module API System Manager",
4
- "version": "1.1.13",
4
+ "version": "1.1.15",
5
5
  "scripts": {
6
6
  "htmldoc": "rm -rf docs && jsdoc api/** -d docs -t ./node_modules/better-docs",
7
7
  "doc": "rm -rf doc && mkdir doc && jsdoc2md api/**/* api/* > doc/api.md",
@@ -1 +0,0 @@
1
- {}