@docbrasil/api-systemmanager 1.1.39 → 1.1.41

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
@@ -2942,6 +2942,8 @@ Class for process, permission user
2942
2942
  * [.processDocs(params, session)](#Process+processDocs) ⇒ <code>promise</code> \| <code>array.&lt;object&gt;</code>
2943
2943
  * [.downloadDocs(params, session)](#Process+downloadDocs) ⇒ <code>promise</code>
2944
2944
  * [.getOrgDocTypes(params, session)](#Process+getOrgDocTypes) ⇒ <code>Promise</code>
2945
+ * [.getOrgGroups(params, session)](#Process+getOrgGroups) ⇒ <code>Promise</code>
2946
+ * [.getOrgUsers(params, session)](#Process+getOrgUsers) ⇒ <code>Promise</code>
2945
2947
 
2946
2948
  <a name="Process+start"></a>
2947
2949
 
@@ -3226,6 +3228,56 @@ const params = {
3226
3228
  const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
3227
3229
  await api.user.process.getOrgDocTypes(params, session);
3228
3230
  ```
3231
+ <a name="Process+getOrgGroups"></a>
3232
+
3233
+ ### process.getOrgGroups(params, session) ⇒ <code>Promise</code>
3234
+ Get Org Groups
3235
+
3236
+ **Kind**: instance method of [<code>Process</code>](#Process)
3237
+ **Access**: public
3238
+ **Author**: Myndware <augusto.pissarra@myndware.com>
3239
+
3240
+ | Param | Type | Description |
3241
+ | --- | --- | --- |
3242
+ | params | <code>object</code> | Params to get Org Groups |
3243
+ | params.orgId | <code>string</code> | Organization id (_id database); |
3244
+ | session | <code>string</code> | Session, token JWT |
3245
+
3246
+ **Example**
3247
+ ```js
3248
+ const API = require('@docbrasil/api-systemmanager');
3249
+ const api = new API();
3250
+ const params = {
3251
+ orgId: '5edd11c46b6ce9729c2c297c',
3252
+ }
3253
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
3254
+ await api.user.process.getOrgGroups(params, session);
3255
+ ```
3256
+ <a name="Process+getOrgUsers"></a>
3257
+
3258
+ ### process.getOrgUsers(params, session) ⇒ <code>Promise</code>
3259
+ Get Org Users
3260
+
3261
+ **Kind**: instance method of [<code>Process</code>](#Process)
3262
+ **Access**: public
3263
+ **Author**: Myndware <augusto.pissarra@myndware.com>
3264
+
3265
+ | Param | Type | Description |
3266
+ | --- | --- | --- |
3267
+ | params | <code>object</code> | Params to get Org Users |
3268
+ | params.orgId | <code>string</code> | Organization id (_id database); |
3269
+ | session | <code>string</code> | Session, token JWT |
3270
+
3271
+ **Example**
3272
+ ```js
3273
+ const API = require('@docbrasil/api-systemmanager');
3274
+ const api = new API();
3275
+ const params = {
3276
+ orgId: '5edd11c46b6ce9729c2c297c',
3277
+ }
3278
+ const session = 'eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9...';
3279
+ await api.user.process.getOrgUsers(params, session);
3280
+ ```
3229
3281
  <a name="Register"></a>
3230
3282
 
3231
3283
  ## Register
@@ -3920,8 +3972,11 @@ Create new document
3920
3972
  | params.model | <code>string</code> | | The model to use for the explain |
3921
3973
  | params.context | <code>object</code> | | The context to apply to a prompt |
3922
3974
  | params.text | <code>string</code> | | The text to add to the prompt |
3923
- | params.medias | <code>array.&lt;base64&gt;</code> | | Medias to add to the case in base64 (PDF, Image, Video, Audio) |
3924
- | params.mediaIds | <code>array.&lt;string&gt;</code> | | Media Ids to add - id of an internal document (PDF, Image, Video, Audio) |
3975
+ | params.medias | <code>array.&lt;object&gt;</code> | | Medias to add (PDF, Image, Video, Audio) |
3976
+ | params.medias.type | <code>string</code> | | can be base64 | document |
3977
+ | params.medias.mime | <code>string</code> | | the mime type of the media |
3978
+ | params.medias.base64 | <code>string</code> | | the base64 of the image (in the case the type is base64) |
3979
+ | params.medias.document | <code>string</code> | | the document path for the image (in the case the type is document) |
3925
3980
  | params.prompt | <code>string</code> | | The actual prompt with context and text to apply to |
3926
3981
  | params.json | <code>boolean</code> | <code>false</code> | If we return in json format or not |
3927
3982
 
package/docs/MyndAI.html CHANGED
@@ -397,7 +397,7 @@
397
397
  <td class="type">
398
398
 
399
399
 
400
- <code class="param-type">array.&lt;base64></code>
400
+ <code class="param-type">array.&lt;object></code>
401
401
 
402
402
 
403
403
 
@@ -411,20 +411,101 @@
411
411
  </td>
412
412
 
413
413
 
414
- <td class="description last">Medias to add to the case in base64 (PDF, Image, Video, Audio)</td>
414
+ <td class="description last">Medias to add (PDF, Image, Video, Audio)</td>
415
415
  </tr>
416
416
 
417
417
 
418
418
 
419
419
  <tr class="deep-level-1">
420
420
 
421
- <td class="name"><code>mediaIds</code></td>
421
+ <td class="name"><code>medias.type</code></td>
422
422
 
423
423
 
424
424
  <td class="type">
425
425
 
426
426
 
427
- <code class="param-type">array.&lt;string></code>
427
+ <code class="param-type">string</code>
428
+
429
+
430
+
431
+ </td>
432
+
433
+
434
+
435
+
436
+ <td class="default">
437
+
438
+ </td>
439
+
440
+
441
+ <td class="description last">can be base64 | document</td>
442
+ </tr>
443
+
444
+
445
+
446
+ <tr class="deep-level-1">
447
+
448
+ <td class="name"><code>medias.mime</code></td>
449
+
450
+
451
+ <td class="type">
452
+
453
+
454
+ <code class="param-type">string</code>
455
+
456
+
457
+
458
+ </td>
459
+
460
+
461
+
462
+
463
+ <td class="default">
464
+
465
+ </td>
466
+
467
+
468
+ <td class="description last">the mime type of the media</td>
469
+ </tr>
470
+
471
+
472
+
473
+ <tr class="deep-level-1">
474
+
475
+ <td class="name"><code>medias.base64</code></td>
476
+
477
+
478
+ <td class="type">
479
+
480
+
481
+ <code class="param-type">string</code>
482
+
483
+
484
+
485
+ </td>
486
+
487
+
488
+
489
+
490
+ <td class="default">
491
+
492
+ </td>
493
+
494
+
495
+ <td class="description last">the base64 of the image (in the case the type is base64)</td>
496
+ </tr>
497
+
498
+
499
+
500
+ <tr class="deep-level-1">
501
+
502
+ <td class="name"><code>medias.document</code></td>
503
+
504
+
505
+ <td class="type">
506
+
507
+
508
+ <code class="param-type">string</code>
428
509
 
429
510
 
430
511
 
@@ -438,7 +519,7 @@
438
519
  </td>
439
520
 
440
521
 
441
- <td class="description last">Media Ids to add - id of an internal document (PDF, Image, Video, Audio)</td>
522
+ <td class="description last">the document path for the image (in the case the type is document)</td>
442
523
  </tr>
443
524
 
444
525
 
@@ -551,7 +632,7 @@
551
632
  <p class="tag-source">
552
633
  <a href="ai.js.html" class="button">View Source</a>
553
634
  <span>
554
- <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line82">line 82</a>
635
+ <a href="ai.js.html">ai.js</a>, <a href="ai.js.html#line85">line 85</a>
555
636
  </span>
556
637
  </p>
557
638
 
package/docs/ai.js.html CHANGED
@@ -141,8 +141,11 @@ class MyndAI {
141
141
  * @param {string} params.model The model to use for the explain
142
142
  * @param {object} params.context The context to apply to a prompt
143
143
  * @param {string} params.text The text to add to the prompt
144
- * @param {array&lt;base64>} params.medias Medias to add to the case in base64 (PDF, Image, Video, Audio)
145
- * @param {array&lt;string>} params.mediaIds Media Ids to add - id of an internal document (PDF, Image, Video, Audio)
144
+ * @param {array&lt;object>} params.medias Medias to add (PDF, Image, Video, Audio)
145
+ * @param {string} params.medias.type can be base64 | document
146
+ * @param {string} params.medias.mime the mime type of the media
147
+ * @param {string} params.medias.base64 the base64 of the image (in the case the type is base64)
148
+ * @param {string} params.medias.document the document path for the image (in the case the type is document)
146
149
  * @param {string} params.prompt The actual prompt with context and text to apply to
147
150
  * @param {boolean} params.json=false If we return in json format or not
148
151
  * @return {Promise&lt;object>} data