@docbrasil/api-systemmanager 1.1.67 → 1.1.68
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/api/admin/document.js +33 -4
- package/dist/bundle.cjs +33 -4
- package/dist/bundle.mjs +1 -1
- package/doc/api.md +27 -0
- package/docs/AdminDocuments.html +251 -3
- package/docs/admin_document.js.html +33 -4
- package/package.json +1 -1
package/api/admin/document.js
CHANGED
|
@@ -183,7 +183,6 @@ class AdminDocuments {
|
|
|
183
183
|
* const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiKey);
|
|
184
184
|
*/
|
|
185
185
|
async signedUrl(params = {}, apiKey) {
|
|
186
|
-
|
|
187
186
|
Joi.assert(params, Joi.object().required());
|
|
188
187
|
Joi.assert(params.methodType, Joi.string().required());
|
|
189
188
|
Joi.assert(params.docId, Joi.string().required());
|
|
@@ -221,7 +220,6 @@ class AdminDocuments {
|
|
|
221
220
|
* await api.admin.document.updateContent(params, apiKey);
|
|
222
221
|
*/
|
|
223
222
|
async updateContent(params = {}, apiKey) {
|
|
224
|
-
|
|
225
223
|
Joi.assert(params, Joi.object().required());
|
|
226
224
|
Joi.assert(params.content, Joi.string().required());
|
|
227
225
|
Joi.assert(params.docId, Joi.string().required());
|
|
@@ -268,7 +266,6 @@ class AdminDocuments {
|
|
|
268
266
|
* await api.admin.document.updateContent(params, apiKey);
|
|
269
267
|
*/
|
|
270
268
|
async updateAI(params = {}, apiKey) {
|
|
271
|
-
|
|
272
269
|
Joi.assert(params, Joi.object().required());
|
|
273
270
|
Joi.assert(params.docId, Joi.string().required());
|
|
274
271
|
Joi.assert(apiKey, Joi.string().required());
|
|
@@ -313,7 +310,6 @@ class AdminDocuments {
|
|
|
313
310
|
* await api.admin.document.getContent(params, apiKey);
|
|
314
311
|
*/
|
|
315
312
|
async getContent(params = {}, apiKey) {
|
|
316
|
-
|
|
317
313
|
Joi.assert(params, Joi.object().required());
|
|
318
314
|
Joi.assert(params.docId, Joi.string().required());
|
|
319
315
|
Joi.assert(params.page, Joi.string().required());
|
|
@@ -327,6 +323,39 @@ class AdminDocuments {
|
|
|
327
323
|
return self._returnData(await apiCall);
|
|
328
324
|
}
|
|
329
325
|
|
|
326
|
+
/**
|
|
327
|
+
*
|
|
328
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
329
|
+
* @description Get the data of a document
|
|
330
|
+
* @param {object} params Params to request signed url
|
|
331
|
+
* @param {string} params.id The unique id of the document
|
|
332
|
+
* @param {string} apiKey Api Key as permission to use this functionality
|
|
333
|
+
* @return {Promise<object>} data the document data
|
|
334
|
+
* @public
|
|
335
|
+
* @async
|
|
336
|
+
* @example
|
|
337
|
+
*
|
|
338
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
339
|
+
* const api = new API();
|
|
340
|
+
* const params - {
|
|
341
|
+
* id: '5dadd01dc4af3941d42f8c5c'
|
|
342
|
+
* };
|
|
343
|
+
* const apiKey: '...';
|
|
344
|
+
* await api.admin.document.getDocumentData(params, apiKey);
|
|
345
|
+
*/
|
|
346
|
+
async getDocumentData(params = {}, apiKey) {
|
|
347
|
+
Joi.assert(params, Joi.object().required());
|
|
348
|
+
Joi.assert(params.id, Joi.string().required());
|
|
349
|
+
Joi.assert(apiKey, Joi.string().required());
|
|
350
|
+
|
|
351
|
+
const self = this;
|
|
352
|
+
const { id } = params;
|
|
353
|
+
const url = `/api/documents/${id}?apiKey=${apiKey}`;
|
|
354
|
+
const apiCall = self._client
|
|
355
|
+
.get(url);
|
|
356
|
+
return self._returnData(await apiCall);
|
|
357
|
+
}
|
|
358
|
+
|
|
330
359
|
}
|
|
331
360
|
|
|
332
361
|
export default AdminDocuments;
|
package/dist/bundle.cjs
CHANGED
|
@@ -12683,7 +12683,6 @@ class AdminDocuments {
|
|
|
12683
12683
|
* const { signedUrl, imageType } = await api.admin.document.signedUrl(params, apiKey);
|
|
12684
12684
|
*/
|
|
12685
12685
|
async signedUrl(params = {}, apiKey) {
|
|
12686
|
-
|
|
12687
12686
|
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
12688
12687
|
Joi__default["default"].assert(params.methodType, Joi__default["default"].string().required());
|
|
12689
12688
|
Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
|
|
@@ -12721,7 +12720,6 @@ class AdminDocuments {
|
|
|
12721
12720
|
* await api.admin.document.updateContent(params, apiKey);
|
|
12722
12721
|
*/
|
|
12723
12722
|
async updateContent(params = {}, apiKey) {
|
|
12724
|
-
|
|
12725
12723
|
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
12726
12724
|
Joi__default["default"].assert(params.content, Joi__default["default"].string().required());
|
|
12727
12725
|
Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
|
|
@@ -12768,7 +12766,6 @@ class AdminDocuments {
|
|
|
12768
12766
|
* await api.admin.document.updateContent(params, apiKey);
|
|
12769
12767
|
*/
|
|
12770
12768
|
async updateAI(params = {}, apiKey) {
|
|
12771
|
-
|
|
12772
12769
|
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
12773
12770
|
Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
|
|
12774
12771
|
Joi__default["default"].assert(apiKey, Joi__default["default"].string().required());
|
|
@@ -12813,7 +12810,6 @@ class AdminDocuments {
|
|
|
12813
12810
|
* await api.admin.document.getContent(params, apiKey);
|
|
12814
12811
|
*/
|
|
12815
12812
|
async getContent(params = {}, apiKey) {
|
|
12816
|
-
|
|
12817
12813
|
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
12818
12814
|
Joi__default["default"].assert(params.docId, Joi__default["default"].string().required());
|
|
12819
12815
|
Joi__default["default"].assert(params.page, Joi__default["default"].string().required());
|
|
@@ -12827,6 +12823,39 @@ class AdminDocuments {
|
|
|
12827
12823
|
return self._returnData(await apiCall);
|
|
12828
12824
|
}
|
|
12829
12825
|
|
|
12826
|
+
/**
|
|
12827
|
+
*
|
|
12828
|
+
* @author Myndware <augusto.pissarra@myndware.com>
|
|
12829
|
+
* @description Get the data of a document
|
|
12830
|
+
* @param {object} params Params to request signed url
|
|
12831
|
+
* @param {string} params.id The unique id of the document
|
|
12832
|
+
* @param {string} apiKey Api Key as permission to use this functionality
|
|
12833
|
+
* @return {Promise<object>} data the document data
|
|
12834
|
+
* @public
|
|
12835
|
+
* @async
|
|
12836
|
+
* @example
|
|
12837
|
+
*
|
|
12838
|
+
* const API = require('@docbrasil/api-systemmanager');
|
|
12839
|
+
* const api = new API();
|
|
12840
|
+
* const params - {
|
|
12841
|
+
* id: '5dadd01dc4af3941d42f8c5c'
|
|
12842
|
+
* };
|
|
12843
|
+
* const apiKey: '...';
|
|
12844
|
+
* await api.admin.document.getDocumentData(params, apiKey);
|
|
12845
|
+
*/
|
|
12846
|
+
async getDocumentData(params = {}, apiKey) {
|
|
12847
|
+
Joi__default["default"].assert(params, Joi__default["default"].object().required());
|
|
12848
|
+
Joi__default["default"].assert(params.id, Joi__default["default"].string().required());
|
|
12849
|
+
Joi__default["default"].assert(apiKey, Joi__default["default"].string().required());
|
|
12850
|
+
|
|
12851
|
+
const self = this;
|
|
12852
|
+
const { id } = params;
|
|
12853
|
+
const url = `/api/documents/${id}?apiKey=${apiKey}`;
|
|
12854
|
+
const apiCall = self._client
|
|
12855
|
+
.get(url);
|
|
12856
|
+
return self._returnData(await apiCall);
|
|
12857
|
+
}
|
|
12858
|
+
|
|
12830
12859
|
}
|
|
12831
12860
|
|
|
12832
12861
|
/**
|