@docbrasil/api-systemmanager 1.1.9 → 1.1.11
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/.vscode/settings.json +1 -0
- package/api/user/my_tasks.js +80 -0
- package/api/user/settings.js +2 -4
- package/dist/bundle.cjs +82 -4
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +567 -1271
- package/docs/Settings.html +3 -3
- package/docs/user_settings.js.html +2 -4
- package/package.json +1 -1
- package/tests/documents_002.spec.js +0 -107
|
@@ -0,0 +1 @@
|
|
|
1
|
+
{}
|
package/api/user/my_tasks.js
CHANGED
|
@@ -90,6 +90,86 @@ class MyTasks {
|
|
|
90
90
|
throw ex;
|
|
91
91
|
}
|
|
92
92
|
}
|
|
93
|
+
|
|
94
|
+
/**
|
|
95
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
96
|
+
* @description Update task dueDate
|
|
97
|
+
* @param {object} data The Date to save
|
|
98
|
+
* @param {string} data.dueDate DueDate
|
|
99
|
+
* @param {string} data.orgId Organization id
|
|
100
|
+
* @param {string} data.taskId Task Id
|
|
101
|
+
* @param {string} session Is token JWT of user
|
|
102
|
+
* @return {Promise}
|
|
103
|
+
* @public
|
|
104
|
+
* @async
|
|
105
|
+
* @example
|
|
106
|
+
*
|
|
107
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
108
|
+
* const api = new API();
|
|
109
|
+
* const data = {
|
|
110
|
+
* dueDate: '2011-10-05T14:48:00.000Z',
|
|
111
|
+
* orgId: '646386c9583e04a131adc894',
|
|
112
|
+
* taskId: '646386c9583e04a131adc895'
|
|
113
|
+
* };
|
|
114
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
115
|
+
* await api.user.task.mytasks.saveDueDate(data, session);
|
|
116
|
+
*/
|
|
117
|
+
async saveDueDate(data, session) {
|
|
118
|
+
const self = this;
|
|
119
|
+
|
|
120
|
+
try {
|
|
121
|
+
Joi.assert(data, Joi.object().required());
|
|
122
|
+
Joi.assert(data.dueDate, Joi.string().required());
|
|
123
|
+
Joi.assert(data.orgId, Joi.string().required());
|
|
124
|
+
Joi.assert(data.taskId, Joi.string().required());
|
|
125
|
+
Joi.assert(session, Joi.string().required());
|
|
126
|
+
|
|
127
|
+
const {taskId, orgId} = params;
|
|
128
|
+
|
|
129
|
+
const apiCall = self._client.put(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, data, self._setHeader(session));
|
|
130
|
+
return self._returnData(await apiCall);
|
|
131
|
+
} catch (ex) {
|
|
132
|
+
throw ex;
|
|
133
|
+
}
|
|
134
|
+
}
|
|
135
|
+
|
|
136
|
+
/**
|
|
137
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
138
|
+
* @description Update task dueDate
|
|
139
|
+
* @param {string} data.orgId Organization id
|
|
140
|
+
* @param {string} data.taskId Task Id
|
|
141
|
+
* @param {string} session Is token JWT of user NOT allow SU
|
|
142
|
+
* @return {Promise}
|
|
143
|
+
* @public
|
|
144
|
+
* @async
|
|
145
|
+
* @example
|
|
146
|
+
*
|
|
147
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
148
|
+
* const api = new API();
|
|
149
|
+
* const data = {
|
|
150
|
+
* orgId: '646386c9583e04a131adc894',
|
|
151
|
+
* taskId: '646386c9583e04a131adc895'
|
|
152
|
+
* };
|
|
153
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
154
|
+
* await api.user.task.mytasks.removeDueDate(data, session);
|
|
155
|
+
*/
|
|
156
|
+
async removeDueDate(data, session) {
|
|
157
|
+
const self = this;
|
|
158
|
+
|
|
159
|
+
try {
|
|
160
|
+
Joi.assert(data, Joi.object().required());
|
|
161
|
+
Joi.assert(data.orgId, Joi.string().required());
|
|
162
|
+
Joi.assert(data.taskId, Joi.string().required());
|
|
163
|
+
Joi.assert(session, Joi.string().required());
|
|
164
|
+
|
|
165
|
+
const {taskId, orgId} = params;
|
|
166
|
+
|
|
167
|
+
const apiCall = self._client.delete(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, self._setHeader(session));
|
|
168
|
+
return self._returnData(await apiCall);
|
|
169
|
+
} catch (ex) {
|
|
170
|
+
throw ex;
|
|
171
|
+
}
|
|
172
|
+
}
|
|
93
173
|
}
|
|
94
174
|
|
|
95
175
|
export default MyTasks;
|
package/api/user/settings.js
CHANGED
|
@@ -86,7 +86,7 @@ class Settings {
|
|
|
86
86
|
|
|
87
87
|
/**
|
|
88
88
|
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
89
|
-
* @description Gets the user settings
|
|
89
|
+
* @description Gets the user settings. Returns an array of settings.
|
|
90
90
|
* @param {string} session Is token JWT of user NOT allow SU
|
|
91
91
|
* @return {Promise}
|
|
92
92
|
* @public
|
|
@@ -96,13 +96,12 @@ class Settings {
|
|
|
96
96
|
* const API = require('@docbrasil/api-systemmanager');
|
|
97
97
|
* const api = new API();
|
|
98
98
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
99
|
-
* await api.user.settings.get(session);
|
|
99
|
+
* ret settings = await api.user.settings.get(session);
|
|
100
100
|
*/
|
|
101
101
|
async get(session) {
|
|
102
102
|
const self = this;
|
|
103
103
|
|
|
104
104
|
try {
|
|
105
|
-
Joi.assert(settings, Joi.object().required());
|
|
106
105
|
Joi.assert(session, Joi.string().required());
|
|
107
106
|
|
|
108
107
|
const apiCall = self._client.get(`/users/settings`, self._setHeader(session));
|
|
@@ -130,7 +129,6 @@ class Settings {
|
|
|
130
129
|
const self = this;
|
|
131
130
|
|
|
132
131
|
try {
|
|
133
|
-
Joi.assert(settings, Joi.object().required());
|
|
134
132
|
Joi.assert(session, Joi.string().required());
|
|
135
133
|
|
|
136
134
|
const apiCall = self._client.del(`/users/settings`, self._setHeader(session));
|
package/dist/bundle.cjs
CHANGED
|
@@ -2234,6 +2234,86 @@ class MyTasks {
|
|
|
2234
2234
|
throw ex;
|
|
2235
2235
|
}
|
|
2236
2236
|
}
|
|
2237
|
+
|
|
2238
|
+
/**
|
|
2239
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2240
|
+
* @description Update task dueDate
|
|
2241
|
+
* @param {object} data The Date to save
|
|
2242
|
+
* @param {string} data.dueDate DueDate
|
|
2243
|
+
* @param {string} data.orgId Organization id
|
|
2244
|
+
* @param {string} data.taskId Task Id
|
|
2245
|
+
* @param {string} session Is token JWT of user
|
|
2246
|
+
* @return {Promise}
|
|
2247
|
+
* @public
|
|
2248
|
+
* @async
|
|
2249
|
+
* @example
|
|
2250
|
+
*
|
|
2251
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2252
|
+
* const api = new API();
|
|
2253
|
+
* const data = {
|
|
2254
|
+
* dueDate: '2011-10-05T14:48:00.000Z',
|
|
2255
|
+
* orgId: '646386c9583e04a131adc894',
|
|
2256
|
+
* taskId: '646386c9583e04a131adc895'
|
|
2257
|
+
* };
|
|
2258
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2259
|
+
* await api.user.task.mytasks.saveDueDate(data, session);
|
|
2260
|
+
*/
|
|
2261
|
+
async saveDueDate(data, session) {
|
|
2262
|
+
const self = this;
|
|
2263
|
+
|
|
2264
|
+
try {
|
|
2265
|
+
Joi__default["default"].assert(data, Joi__default["default"].object().required());
|
|
2266
|
+
Joi__default["default"].assert(data.dueDate, Joi__default["default"].string().required());
|
|
2267
|
+
Joi__default["default"].assert(data.orgId, Joi__default["default"].string().required());
|
|
2268
|
+
Joi__default["default"].assert(data.taskId, Joi__default["default"].string().required());
|
|
2269
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
2270
|
+
|
|
2271
|
+
const {taskId, orgId} = params;
|
|
2272
|
+
|
|
2273
|
+
const apiCall = self._client.put(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, data, self._setHeader(session));
|
|
2274
|
+
return self._returnData(await apiCall);
|
|
2275
|
+
} catch (ex) {
|
|
2276
|
+
throw ex;
|
|
2277
|
+
}
|
|
2278
|
+
}
|
|
2279
|
+
|
|
2280
|
+
/**
|
|
2281
|
+
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
2282
|
+
* @description Update task dueDate
|
|
2283
|
+
* @param {string} data.orgId Organization id
|
|
2284
|
+
* @param {string} data.taskId Task Id
|
|
2285
|
+
* @param {string} session Is token JWT of user NOT allow SU
|
|
2286
|
+
* @return {Promise}
|
|
2287
|
+
* @public
|
|
2288
|
+
* @async
|
|
2289
|
+
* @example
|
|
2290
|
+
*
|
|
2291
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
2292
|
+
* const api = new API();
|
|
2293
|
+
* const data = {
|
|
2294
|
+
* orgId: '646386c9583e04a131adc894',
|
|
2295
|
+
* taskId: '646386c9583e04a131adc895'
|
|
2296
|
+
* };
|
|
2297
|
+
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
2298
|
+
* await api.user.task.mytasks.removeDueDate(data, session);
|
|
2299
|
+
*/
|
|
2300
|
+
async removeDueDate(data, session) {
|
|
2301
|
+
const self = this;
|
|
2302
|
+
|
|
2303
|
+
try {
|
|
2304
|
+
Joi__default["default"].assert(data, Joi__default["default"].object().required());
|
|
2305
|
+
Joi__default["default"].assert(data.orgId, Joi__default["default"].string().required());
|
|
2306
|
+
Joi__default["default"].assert(data.taskId, Joi__default["default"].string().required());
|
|
2307
|
+
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
2308
|
+
|
|
2309
|
+
const {taskId, orgId} = params;
|
|
2310
|
+
|
|
2311
|
+
const apiCall = self._client.delete(`/organizations/${orgId}/users/tasks/${taskId}/duedate`, self._setHeader(session));
|
|
2312
|
+
return self._returnData(await apiCall);
|
|
2313
|
+
} catch (ex) {
|
|
2314
|
+
throw ex;
|
|
2315
|
+
}
|
|
2316
|
+
}
|
|
2237
2317
|
}
|
|
2238
2318
|
|
|
2239
2319
|
/**
|
|
@@ -10445,7 +10525,7 @@ class Settings {
|
|
|
10445
10525
|
|
|
10446
10526
|
/**
|
|
10447
10527
|
* @author CloudBrasil <abernardo.br@gmail.com>
|
|
10448
|
-
* @description Gets the user settings
|
|
10528
|
+
* @description Gets the user settings. Returns an array of settings.
|
|
10449
10529
|
* @param {string} session Is token JWT of user NOT allow SU
|
|
10450
10530
|
* @return {Promise}
|
|
10451
10531
|
* @public
|
|
@@ -10455,13 +10535,12 @@ class Settings {
|
|
|
10455
10535
|
* const API = require('@docbrasil/api-systemmanager');
|
|
10456
10536
|
* const api = new API();
|
|
10457
10537
|
* const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
|
|
10458
|
-
* await api.user.settings.get(session);
|
|
10538
|
+
* ret settings = await api.user.settings.get(session);
|
|
10459
10539
|
*/
|
|
10460
10540
|
async get(session) {
|
|
10461
10541
|
const self = this;
|
|
10462
10542
|
|
|
10463
10543
|
try {
|
|
10464
|
-
Joi__default["default"].assert(settings, Joi__default["default"].object().required());
|
|
10465
10544
|
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
10466
10545
|
|
|
10467
10546
|
const apiCall = self._client.get(`/users/settings`, self._setHeader(session));
|
|
@@ -10489,7 +10568,6 @@ class Settings {
|
|
|
10489
10568
|
const self = this;
|
|
10490
10569
|
|
|
10491
10570
|
try {
|
|
10492
|
-
Joi__default["default"].assert(settings, Joi__default["default"].object().required());
|
|
10493
10571
|
Joi__default["default"].assert(session, Joi__default["default"].string().required());
|
|
10494
10572
|
|
|
10495
10573
|
const apiCall = self._client.del(`/users/settings`, self._setHeader(session));
|