@emilgroup/document-sdk-node 1.37.1-beta.1 → 1.37.1-beta.2

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/README.md CHANGED
@@ -17,11 +17,11 @@ Although this package can be used in both TypeScript and JavaScript, it is inten
17
17
  Navigate to the folder of your consuming project and run one of the following commands:
18
18
 
19
19
  ```
20
- npm install @emilgroup/document-sdk-node@1.37.1-beta.1 --save
20
+ npm install @emilgroup/document-sdk-node@1.37.1-beta.2 --save
21
21
  ```
22
22
  or
23
23
  ```
24
- yarn add @emilgroup/document-sdk-node@1.37.1-beta.1
24
+ yarn add @emilgroup/document-sdk-node@1.37.1-beta.2
25
25
  ```
26
26
 
27
27
  And then you can import `DocumentsApi`.
@@ -45,7 +45,7 @@ const FormData = require('form-data');
45
45
  export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
46
46
  return {
47
47
  /**
48
- * This will create a document template.
48
+ * This will create a document template. **Required Permissions** \"document-management.documents.create\"
49
49
  * @summary Create the document template
50
50
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
51
51
  * @param {string} [authorization] Bearer Token
@@ -92,7 +92,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
92
92
  };
93
93
  },
94
94
  /**
95
- * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
95
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it. **Required Permissions** \"document-management.documents.delete\"
96
96
  * @summary Delete the document template
97
97
  * @param {number} id
98
98
  * @param {string} [authorization] Bearer Token
@@ -137,7 +137,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
137
137
  };
138
138
  },
139
139
  /**
140
- * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
140
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information. **Required Permissions** \"document-management.documents.view\"
141
141
  * @summary Retrieve the document template
142
142
  * @param {number} id
143
143
  * @param {string} [authorization] Bearer Token
@@ -187,7 +187,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
187
187
  };
188
188
  },
189
189
  /**
190
- * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
190
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
191
191
  * @summary List document templates
192
192
  * @param {string} [authorization] Bearer Token
193
193
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
@@ -258,7 +258,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
258
258
  };
259
259
  },
260
260
  /**
261
- * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
261
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
262
262
  * @summary Update the document template
263
263
  * @param {number} id
264
264
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
@@ -319,7 +319,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
319
319
  const localVarAxiosParamCreator = DocumentTemplatesApiAxiosParamCreator(configuration)
320
320
  return {
321
321
  /**
322
- * This will create a document template.
322
+ * This will create a document template. **Required Permissions** \"document-management.documents.create\"
323
323
  * @summary Create the document template
324
324
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
325
325
  * @param {string} [authorization] Bearer Token
@@ -331,7 +331,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
331
331
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
332
332
  },
333
333
  /**
334
- * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
334
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it. **Required Permissions** \"document-management.documents.delete\"
335
335
  * @summary Delete the document template
336
336
  * @param {number} id
337
337
  * @param {string} [authorization] Bearer Token
@@ -343,7 +343,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
343
343
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
344
344
  },
345
345
  /**
346
- * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
346
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information. **Required Permissions** \"document-management.documents.view\"
347
347
  * @summary Retrieve the document template
348
348
  * @param {number} id
349
349
  * @param {string} [authorization] Bearer Token
@@ -356,7 +356,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
356
356
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
357
357
  },
358
358
  /**
359
- * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
359
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
360
360
  * @summary List document templates
361
361
  * @param {string} [authorization] Bearer Token
362
362
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
@@ -373,7 +373,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
373
373
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
374
374
  },
375
375
  /**
376
- * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
376
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
377
377
  * @summary Update the document template
378
378
  * @param {number} id
379
379
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
@@ -396,7 +396,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
396
396
  const localVarFp = DocumentTemplatesApiFp(configuration)
397
397
  return {
398
398
  /**
399
- * This will create a document template.
399
+ * This will create a document template. **Required Permissions** \"document-management.documents.create\"
400
400
  * @summary Create the document template
401
401
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
402
402
  * @param {string} [authorization] Bearer Token
@@ -407,7 +407,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
407
407
  return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
408
408
  },
409
409
  /**
410
- * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
410
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it. **Required Permissions** \"document-management.documents.delete\"
411
411
  * @summary Delete the document template
412
412
  * @param {number} id
413
413
  * @param {string} [authorization] Bearer Token
@@ -418,7 +418,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
418
418
  return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
419
419
  },
420
420
  /**
421
- * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
421
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information. **Required Permissions** \"document-management.documents.view\"
422
422
  * @summary Retrieve the document template
423
423
  * @param {number} id
424
424
  * @param {string} [authorization] Bearer Token
@@ -430,7 +430,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
430
430
  return localVarFp.getDocTemplate(id, authorization, expand, options).then((request) => request(axios, basePath));
431
431
  },
432
432
  /**
433
- * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
433
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
434
434
  * @summary List document templates
435
435
  * @param {string} [authorization] Bearer Token
436
436
  * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
@@ -446,7 +446,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
446
446
  return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
447
447
  },
448
448
  /**
449
- * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
449
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
450
450
  * @summary Update the document template
451
451
  * @param {number} id
452
452
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
@@ -622,7 +622,7 @@ export interface DocumentTemplatesApiUpdateDocTemplateRequest {
622
622
  */
623
623
  export class DocumentTemplatesApi extends BaseAPI {
624
624
  /**
625
- * This will create a document template.
625
+ * This will create a document template. **Required Permissions** \"document-management.documents.create\"
626
626
  * @summary Create the document template
627
627
  * @param {DocumentTemplatesApiCreateDocTemplateRequest} requestParameters Request parameters.
628
628
  * @param {*} [options] Override http request option.
@@ -634,7 +634,7 @@ export class DocumentTemplatesApi extends BaseAPI {
634
634
  }
635
635
 
636
636
  /**
637
- * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
637
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it. **Required Permissions** \"document-management.documents.delete\"
638
638
  * @summary Delete the document template
639
639
  * @param {DocumentTemplatesApiDeleteDocTemplateRequest} requestParameters Request parameters.
640
640
  * @param {*} [options] Override http request option.
@@ -646,7 +646,7 @@ export class DocumentTemplatesApi extends BaseAPI {
646
646
  }
647
647
 
648
648
  /**
649
- * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information.
649
+ * Retrieves the details of the document template that was previously created. Supply the unique document template id that was returned when you created it and Emil Api will return the corresponding document template information. **Required Permissions** \"document-management.documents.view\"
650
650
  * @summary Retrieve the document template
651
651
  * @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
652
652
  * @param {*} [options] Override http request option.
@@ -658,7 +658,7 @@ export class DocumentTemplatesApi extends BaseAPI {
658
658
  }
659
659
 
660
660
  /**
661
- * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
661
+ * Returns a list of document templates you have previously created. The document templates are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
662
662
  * @summary List document templates
663
663
  * @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
664
664
  * @param {*} [options] Override http request option.
@@ -670,7 +670,7 @@ export class DocumentTemplatesApi extends BaseAPI {
670
670
  }
671
671
 
672
672
  /**
673
- * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
673
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
674
674
  * @summary Update the document template
675
675
  * @param {DocumentTemplatesApiUpdateDocTemplateRequest} requestParameters Request parameters.
676
676
  * @param {*} [options] Override http request option.
@@ -51,7 +51,7 @@ const FormData = require('form-data');
51
51
  export const DocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
52
52
  return {
53
53
  /**
54
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
54
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
55
55
  * @summary Create the document
56
56
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
57
57
  * @param {string} [authorization] Bearer Token
@@ -98,7 +98,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
98
98
  };
99
99
  },
100
100
  /**
101
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
101
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
102
102
  * @summary Upload documents using pre-signed URL
103
103
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
104
104
  * @param {string} [authorization] Bearer Token
@@ -145,7 +145,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
145
145
  };
146
146
  },
147
147
  /**
148
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
148
+ * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
149
149
  * @summary Delete the document
150
150
  * @param {string} code
151
151
  * @param {string} [authorization] Bearer Token
@@ -190,7 +190,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
190
190
  };
191
191
  },
192
192
  /**
193
- * This will return a presigned URL to download the document.
193
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
194
194
  * @summary Fetches a document download URL
195
195
  * @param {string} code Document code
196
196
  * @param {string} [authorization] Bearer Token
@@ -240,7 +240,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
240
240
  };
241
241
  },
242
242
  /**
243
- * This will return a presigned URL for a random S3 key
243
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
244
244
  * @summary Fetches a presigned URL for a S3 key
245
245
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
246
246
  * @param {string} [authorization] Bearer Token
@@ -293,7 +293,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
293
293
  };
294
294
  },
295
295
  /**
296
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
296
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
297
297
  * @summary List documents
298
298
  * @param {string} [authorization] Bearer Token
299
299
  * @param {number} [pageSize] Page size
@@ -369,7 +369,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
369
369
  };
370
370
  },
371
371
  /**
372
- * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client.
372
+ * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client. **Required Permissions** \"document-management.documents.create\"
373
373
  * @summary Save external document
374
374
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
375
375
  * @param {string} [authorization] Bearer Token
@@ -416,7 +416,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
416
416
  };
417
417
  },
418
418
  /**
419
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
419
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
420
420
  * @summary Update the document
421
421
  * @param {string} code
422
422
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -477,7 +477,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
477
477
  const localVarAxiosParamCreator = DocumentsApiAxiosParamCreator(configuration)
478
478
  return {
479
479
  /**
480
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
480
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
481
481
  * @summary Create the document
482
482
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
483
483
  * @param {string} [authorization] Bearer Token
@@ -489,7 +489,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
489
489
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
490
490
  },
491
491
  /**
492
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
492
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
493
493
  * @summary Upload documents using pre-signed URL
494
494
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
495
495
  * @param {string} [authorization] Bearer Token
@@ -501,7 +501,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
501
501
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
502
502
  },
503
503
  /**
504
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
504
+ * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
505
505
  * @summary Delete the document
506
506
  * @param {string} code
507
507
  * @param {string} [authorization] Bearer Token
@@ -513,7 +513,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
513
513
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
514
514
  },
515
515
  /**
516
- * This will return a presigned URL to download the document.
516
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
517
517
  * @summary Fetches a document download URL
518
518
  * @param {string} code Document code
519
519
  * @param {string} [authorization] Bearer Token
@@ -526,7 +526,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
526
526
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
527
527
  },
528
528
  /**
529
- * This will return a presigned URL for a random S3 key
529
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
530
530
  * @summary Fetches a presigned URL for a S3 key
531
531
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
532
532
  * @param {string} [authorization] Bearer Token
@@ -539,7 +539,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
539
539
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
540
540
  },
541
541
  /**
542
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
542
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
543
543
  * @summary List documents
544
544
  * @param {string} [authorization] Bearer Token
545
545
  * @param {number} [pageSize] Page size
@@ -557,7 +557,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
557
557
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
558
558
  },
559
559
  /**
560
- * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client.
560
+ * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client. **Required Permissions** \"document-management.documents.create\"
561
561
  * @summary Save external document
562
562
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
563
563
  * @param {string} [authorization] Bearer Token
@@ -569,7 +569,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
569
569
  return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
570
570
  },
571
571
  /**
572
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
572
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
573
573
  * @summary Update the document
574
574
  * @param {string} code
575
575
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -592,7 +592,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
592
592
  const localVarFp = DocumentsApiFp(configuration)
593
593
  return {
594
594
  /**
595
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
595
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
596
596
  * @summary Create the document
597
597
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
598
598
  * @param {string} [authorization] Bearer Token
@@ -603,7 +603,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
603
603
  return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
604
604
  },
605
605
  /**
606
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
606
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
607
607
  * @summary Upload documents using pre-signed URL
608
608
  * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
609
609
  * @param {string} [authorization] Bearer Token
@@ -614,7 +614,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
614
614
  return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then((request) => request(axios, basePath));
615
615
  },
616
616
  /**
617
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
617
+ * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
618
618
  * @summary Delete the document
619
619
  * @param {string} code
620
620
  * @param {string} [authorization] Bearer Token
@@ -625,7 +625,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
625
625
  return localVarFp.deleteDocument(code, authorization, options).then((request) => request(axios, basePath));
626
626
  },
627
627
  /**
628
- * This will return a presigned URL to download the document.
628
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
629
629
  * @summary Fetches a document download URL
630
630
  * @param {string} code Document code
631
631
  * @param {string} [authorization] Bearer Token
@@ -637,7 +637,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
637
637
  return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
638
638
  },
639
639
  /**
640
- * This will return a presigned URL for a random S3 key
640
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
641
641
  * @summary Fetches a presigned URL for a S3 key
642
642
  * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
643
643
  * @param {string} [authorization] Bearer Token
@@ -649,7 +649,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
649
649
  return localVarFp.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options).then((request) => request(axios, basePath));
650
650
  },
651
651
  /**
652
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
652
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
653
653
  * @summary List documents
654
654
  * @param {string} [authorization] Bearer Token
655
655
  * @param {number} [pageSize] Page size
@@ -666,7 +666,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
666
666
  return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
667
667
  },
668
668
  /**
669
- * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client.
669
+ * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client. **Required Permissions** \"document-management.documents.create\"
670
670
  * @summary Save external document
671
671
  * @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
672
672
  * @param {string} [authorization] Bearer Token
@@ -677,7 +677,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
677
677
  return localVarFp.saveExternalDocument(saveExternalDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
678
678
  },
679
679
  /**
680
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
680
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
681
681
  * @summary Update the document
682
682
  * @param {string} code
683
683
  * @param {UpdateDocumentRequestDto} updateDocumentRequestDto
@@ -930,7 +930,7 @@ export interface DocumentsApiUpdateDocumentRequest {
930
930
  */
931
931
  export class DocumentsApi extends BaseAPI {
932
932
  /**
933
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
933
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
934
934
  * @summary Create the document
935
935
  * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
936
936
  * @param {*} [options] Override http request option.
@@ -942,7 +942,7 @@ export class DocumentsApi extends BaseAPI {
942
942
  }
943
943
 
944
944
  /**
945
- * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
945
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days. **Required Permissions** \"document-management.documents.create\"
946
946
  * @summary Upload documents using pre-signed URL
947
947
  * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
948
948
  * @param {*} [options] Override http request option.
@@ -954,7 +954,7 @@ export class DocumentsApi extends BaseAPI {
954
954
  }
955
955
 
956
956
  /**
957
- * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
957
+ * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it. **Required Permissions** \"document-management.documents.delete\"
958
958
  * @summary Delete the document
959
959
  * @param {DocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
960
960
  * @param {*} [options] Override http request option.
@@ -966,7 +966,7 @@ export class DocumentsApi extends BaseAPI {
966
966
  }
967
967
 
968
968
  /**
969
- * This will return a presigned URL to download the document.
969
+ * This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
970
970
  * @summary Fetches a document download URL
971
971
  * @param {DocumentsApiGetDocumentDownloadUrlRequest} requestParameters Request parameters.
972
972
  * @param {*} [options] Override http request option.
@@ -978,7 +978,7 @@ export class DocumentsApi extends BaseAPI {
978
978
  }
979
979
 
980
980
  /**
981
- * This will return a presigned URL for a random S3 key
981
+ * This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
982
982
  * @summary Fetches a presigned URL for a S3 key
983
983
  * @param {DocumentsApiGetSignedS3keyUrlRequest} requestParameters Request parameters.
984
984
  * @param {*} [options] Override http request option.
@@ -990,7 +990,7 @@ export class DocumentsApi extends BaseAPI {
990
990
  }
991
991
 
992
992
  /**
993
- * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation.
993
+ * Returns a list of documents you have previously created. The documents are returned in sorted order, with the oldest one appearing first. For more information about pagination, read the Pagination documentation. **Required Permissions** \"document-management.documents.view\"
994
994
  * @summary List documents
995
995
  * @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
996
996
  * @param {*} [options] Override http request option.
@@ -1002,7 +1002,7 @@ export class DocumentsApi extends BaseAPI {
1002
1002
  }
1003
1003
 
1004
1004
  /**
1005
- * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client.
1005
+ * This will save an external document in the database and return it. This is useful if one needs to call a third party API and store the document in EIS and then, for instance, send it to a client. **Required Permissions** \"document-management.documents.create\"
1006
1006
  * @summary Save external document
1007
1007
  * @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
1008
1008
  * @param {*} [options] Override http request option.
@@ -1014,7 +1014,7 @@ export class DocumentsApi extends BaseAPI {
1014
1014
  }
1015
1015
 
1016
1016
  /**
1017
- * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
1017
+ * Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged. **Required Permissions** \"document-management.documents.update\"
1018
1018
  * @summary Update the document
1019
1019
  * @param {DocumentsApiUpdateDocumentRequest} requestParameters Request parameters.
1020
1020
  * @param {*} [options] Override http request option.