@emilgroup/document-sdk 1.38.0 → 1.38.1-beta.0
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 +2 -2
- package/api/document-templates-api.ts +20 -20
- package/api/documents-api.ts +32 -32
- package/api/docx-templates-api.ts +24 -24
- package/api/layouts-api.ts +20 -20
- package/api/product-documents-api.ts +20 -20
- package/api/search-keywords-api.ts +4 -4
- package/api/searchable-document-owners-api.ts +4 -4
- package/api/searchable-documents-api.ts +4 -4
- package/dist/api/document-templates-api.d.ts +20 -20
- package/dist/api/document-templates-api.js +20 -20
- package/dist/api/documents-api.d.ts +32 -32
- package/dist/api/documents-api.js +32 -32
- package/dist/api/docx-templates-api.d.ts +24 -24
- package/dist/api/docx-templates-api.js +24 -24
- package/dist/api/layouts-api.d.ts +20 -20
- package/dist/api/layouts-api.js +20 -20
- package/dist/api/product-documents-api.d.ts +20 -20
- package/dist/api/product-documents-api.js +20 -20
- package/dist/api/search-keywords-api.d.ts +4 -4
- package/dist/api/search-keywords-api.js +4 -4
- package/dist/api/searchable-document-owners-api.d.ts +4 -4
- package/dist/api/searchable-document-owners-api.js +4 -4
- package/dist/api/searchable-documents-api.d.ts +4 -4
- package/dist/api/searchable-documents-api.js +4 -4
- package/package.json +1 -1
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@1.38.0 --save
|
|
20
|
+
npm install @emilgroup/document-sdk@1.38.1-beta.0 --save
|
|
21
21
|
```
|
|
22
22
|
or
|
|
23
23
|
```
|
|
24
|
-
yarn add @emilgroup/document-sdk@1.38.0
|
|
24
|
+
yarn add @emilgroup/document-sdk@1.38.1-beta.0
|
|
25
25
|
```
|
|
26
26
|
|
|
27
27
|
And then you can import `DocumentsApi`.
|
|
@@ -41,7 +41,7 @@ import { UpdateDocTemplateResponseClass } from '../models';
|
|
|
41
41
|
export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
42
42
|
return {
|
|
43
43
|
/**
|
|
44
|
-
* This will create a document template.
|
|
44
|
+
* This will create a document template. **Required Permissions** \"document-management.documents.create\"
|
|
45
45
|
* @summary Create the document template
|
|
46
46
|
* @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
|
|
47
47
|
* @param {string} [authorization] Bearer Token
|
|
@@ -88,7 +88,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
88
88
|
};
|
|
89
89
|
},
|
|
90
90
|
/**
|
|
91
|
-
* Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
|
|
91
|
+
* 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\"
|
|
92
92
|
* @summary Delete the document template
|
|
93
93
|
* @param {number} id
|
|
94
94
|
* @param {string} [authorization] Bearer Token
|
|
@@ -133,7 +133,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
133
133
|
};
|
|
134
134
|
},
|
|
135
135
|
/**
|
|
136
|
-
* 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.
|
|
136
|
+
* 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\"
|
|
137
137
|
* @summary Retrieve the document template
|
|
138
138
|
* @param {number} id
|
|
139
139
|
* @param {string} [authorization] Bearer Token
|
|
@@ -183,7 +183,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
183
183
|
};
|
|
184
184
|
},
|
|
185
185
|
/**
|
|
186
|
-
* 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.
|
|
186
|
+
* 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\"
|
|
187
187
|
* @summary List document templates
|
|
188
188
|
* @param {string} [authorization] Bearer Token
|
|
189
189
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
@@ -254,7 +254,7 @@ export const DocumentTemplatesApiAxiosParamCreator = function (configuration?: C
|
|
|
254
254
|
};
|
|
255
255
|
},
|
|
256
256
|
/**
|
|
257
|
-
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
257
|
+
* 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\"
|
|
258
258
|
* @summary Update the document template
|
|
259
259
|
* @param {number} id
|
|
260
260
|
* @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
|
|
@@ -315,7 +315,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
315
315
|
const localVarAxiosParamCreator = DocumentTemplatesApiAxiosParamCreator(configuration)
|
|
316
316
|
return {
|
|
317
317
|
/**
|
|
318
|
-
* This will create a document template.
|
|
318
|
+
* This will create a document template. **Required Permissions** \"document-management.documents.create\"
|
|
319
319
|
* @summary Create the document template
|
|
320
320
|
* @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
|
|
321
321
|
* @param {string} [authorization] Bearer Token
|
|
@@ -327,7 +327,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
327
327
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
328
328
|
},
|
|
329
329
|
/**
|
|
330
|
-
* Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
|
|
330
|
+
* 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\"
|
|
331
331
|
* @summary Delete the document template
|
|
332
332
|
* @param {number} id
|
|
333
333
|
* @param {string} [authorization] Bearer Token
|
|
@@ -339,7 +339,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
339
339
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
340
340
|
},
|
|
341
341
|
/**
|
|
342
|
-
* 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.
|
|
342
|
+
* 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\"
|
|
343
343
|
* @summary Retrieve the document template
|
|
344
344
|
* @param {number} id
|
|
345
345
|
* @param {string} [authorization] Bearer Token
|
|
@@ -352,7 +352,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
352
352
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
353
353
|
},
|
|
354
354
|
/**
|
|
355
|
-
* 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.
|
|
355
|
+
* 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\"
|
|
356
356
|
* @summary List document templates
|
|
357
357
|
* @param {string} [authorization] Bearer Token
|
|
358
358
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
@@ -369,7 +369,7 @@ export const DocumentTemplatesApiFp = function(configuration?: Configuration) {
|
|
|
369
369
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
370
370
|
},
|
|
371
371
|
/**
|
|
372
|
-
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
372
|
+
* 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\"
|
|
373
373
|
* @summary Update the document template
|
|
374
374
|
* @param {number} id
|
|
375
375
|
* @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
|
|
@@ -392,7 +392,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
392
392
|
const localVarFp = DocumentTemplatesApiFp(configuration)
|
|
393
393
|
return {
|
|
394
394
|
/**
|
|
395
|
-
* This will create a document template.
|
|
395
|
+
* This will create a document template. **Required Permissions** \"document-management.documents.create\"
|
|
396
396
|
* @summary Create the document template
|
|
397
397
|
* @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
|
|
398
398
|
* @param {string} [authorization] Bearer Token
|
|
@@ -403,7 +403,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
403
403
|
return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
404
404
|
},
|
|
405
405
|
/**
|
|
406
|
-
* Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
|
|
406
|
+
* 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\"
|
|
407
407
|
* @summary Delete the document template
|
|
408
408
|
* @param {number} id
|
|
409
409
|
* @param {string} [authorization] Bearer Token
|
|
@@ -414,7 +414,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
414
414
|
return localVarFp.deleteDocTemplate(id, authorization, options).then((request) => request(axios, basePath));
|
|
415
415
|
},
|
|
416
416
|
/**
|
|
417
|
-
* 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.
|
|
417
|
+
* 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\"
|
|
418
418
|
* @summary Retrieve the document template
|
|
419
419
|
* @param {number} id
|
|
420
420
|
* @param {string} [authorization] Bearer Token
|
|
@@ -426,7 +426,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
426
426
|
return localVarFp.getDocTemplate(id, authorization, expand, options).then((request) => request(axios, basePath));
|
|
427
427
|
},
|
|
428
428
|
/**
|
|
429
|
-
* 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.
|
|
429
|
+
* 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\"
|
|
430
430
|
* @summary List document templates
|
|
431
431
|
* @param {string} [authorization] Bearer Token
|
|
432
432
|
* @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
|
|
@@ -442,7 +442,7 @@ export const DocumentTemplatesApiFactory = function (configuration?: Configurati
|
|
|
442
442
|
return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then((request) => request(axios, basePath));
|
|
443
443
|
},
|
|
444
444
|
/**
|
|
445
|
-
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
445
|
+
* 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\"
|
|
446
446
|
* @summary Update the document template
|
|
447
447
|
* @param {number} id
|
|
448
448
|
* @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
|
|
@@ -618,7 +618,7 @@ export interface DocumentTemplatesApiUpdateDocTemplateRequest {
|
|
|
618
618
|
*/
|
|
619
619
|
export class DocumentTemplatesApi extends BaseAPI {
|
|
620
620
|
/**
|
|
621
|
-
* This will create a document template.
|
|
621
|
+
* This will create a document template. **Required Permissions** \"document-management.documents.create\"
|
|
622
622
|
* @summary Create the document template
|
|
623
623
|
* @param {DocumentTemplatesApiCreateDocTemplateRequest} requestParameters Request parameters.
|
|
624
624
|
* @param {*} [options] Override http request option.
|
|
@@ -630,7 +630,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
630
630
|
}
|
|
631
631
|
|
|
632
632
|
/**
|
|
633
|
-
* Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
|
|
633
|
+
* 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\"
|
|
634
634
|
* @summary Delete the document template
|
|
635
635
|
* @param {DocumentTemplatesApiDeleteDocTemplateRequest} requestParameters Request parameters.
|
|
636
636
|
* @param {*} [options] Override http request option.
|
|
@@ -642,7 +642,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
642
642
|
}
|
|
643
643
|
|
|
644
644
|
/**
|
|
645
|
-
* 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.
|
|
645
|
+
* 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\"
|
|
646
646
|
* @summary Retrieve the document template
|
|
647
647
|
* @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
|
|
648
648
|
* @param {*} [options] Override http request option.
|
|
@@ -654,7 +654,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
654
654
|
}
|
|
655
655
|
|
|
656
656
|
/**
|
|
657
|
-
* 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.
|
|
657
|
+
* 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\"
|
|
658
658
|
* @summary List document templates
|
|
659
659
|
* @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
|
|
660
660
|
* @param {*} [options] Override http request option.
|
|
@@ -666,7 +666,7 @@ export class DocumentTemplatesApi extends BaseAPI {
|
|
|
666
666
|
}
|
|
667
667
|
|
|
668
668
|
/**
|
|
669
|
-
* Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
669
|
+
* 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\"
|
|
670
670
|
* @summary Update the document template
|
|
671
671
|
* @param {DocumentTemplatesApiUpdateDocTemplateRequest} requestParameters Request parameters.
|
|
672
672
|
* @param {*} [options] Override http request option.
|
package/api/documents-api.ts
CHANGED
|
@@ -47,7 +47,7 @@ import { UpdateDocumentResponseClass } from '../models';
|
|
|
47
47
|
export const DocumentsApiAxiosParamCreator = function (configuration?: Configuration) {
|
|
48
48
|
return {
|
|
49
49
|
/**
|
|
50
|
-
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
|
|
50
|
+
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
|
|
51
51
|
* @summary Create the document
|
|
52
52
|
* @param {CreateDocumentRequestDto} createDocumentRequestDto
|
|
53
53
|
* @param {string} [authorization] Bearer Token
|
|
@@ -94,7 +94,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
94
94
|
};
|
|
95
95
|
},
|
|
96
96
|
/**
|
|
97
|
-
* This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
|
|
97
|
+
* 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\"
|
|
98
98
|
* @summary Upload documents using pre-signed URL
|
|
99
99
|
* @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
|
|
100
100
|
* @param {string} [authorization] Bearer Token
|
|
@@ -141,7 +141,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
141
141
|
};
|
|
142
142
|
},
|
|
143
143
|
/**
|
|
144
|
-
* Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
|
|
144
|
+
* 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\"
|
|
145
145
|
* @summary Delete the document
|
|
146
146
|
* @param {string} code
|
|
147
147
|
* @param {string} [authorization] Bearer Token
|
|
@@ -186,7 +186,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
186
186
|
};
|
|
187
187
|
},
|
|
188
188
|
/**
|
|
189
|
-
* This will return a presigned URL to download the document.
|
|
189
|
+
* This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
|
|
190
190
|
* @summary Fetches a document download URL
|
|
191
191
|
* @param {string} code Document code
|
|
192
192
|
* @param {string} [authorization] Bearer Token
|
|
@@ -236,7 +236,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
236
236
|
};
|
|
237
237
|
},
|
|
238
238
|
/**
|
|
239
|
-
* This will return a presigned URL for a random S3 key
|
|
239
|
+
* This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
|
|
240
240
|
* @summary Fetches a presigned URL for a S3 key
|
|
241
241
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
242
242
|
* @param {string} [authorization] Bearer Token
|
|
@@ -289,7 +289,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
289
289
|
};
|
|
290
290
|
},
|
|
291
291
|
/**
|
|
292
|
-
* 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.
|
|
292
|
+
* 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\"
|
|
293
293
|
* @summary List documents
|
|
294
294
|
* @param {string} [authorization] Bearer Token
|
|
295
295
|
* @param {number} [pageSize] Page size
|
|
@@ -365,7 +365,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
365
365
|
};
|
|
366
366
|
},
|
|
367
367
|
/**
|
|
368
|
-
* 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.
|
|
368
|
+
* 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\"
|
|
369
369
|
* @summary Save external document
|
|
370
370
|
* @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
|
|
371
371
|
* @param {string} [authorization] Bearer Token
|
|
@@ -412,7 +412,7 @@ export const DocumentsApiAxiosParamCreator = function (configuration?: Configura
|
|
|
412
412
|
};
|
|
413
413
|
},
|
|
414
414
|
/**
|
|
415
|
-
* Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
415
|
+
* 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\"
|
|
416
416
|
* @summary Update the document
|
|
417
417
|
* @param {string} code
|
|
418
418
|
* @param {UpdateDocumentRequestDto} updateDocumentRequestDto
|
|
@@ -473,7 +473,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
473
473
|
const localVarAxiosParamCreator = DocumentsApiAxiosParamCreator(configuration)
|
|
474
474
|
return {
|
|
475
475
|
/**
|
|
476
|
-
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
|
|
476
|
+
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
|
|
477
477
|
* @summary Create the document
|
|
478
478
|
* @param {CreateDocumentRequestDto} createDocumentRequestDto
|
|
479
479
|
* @param {string} [authorization] Bearer Token
|
|
@@ -485,7 +485,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
485
485
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
486
486
|
},
|
|
487
487
|
/**
|
|
488
|
-
* This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
|
|
488
|
+
* 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\"
|
|
489
489
|
* @summary Upload documents using pre-signed URL
|
|
490
490
|
* @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
|
|
491
491
|
* @param {string} [authorization] Bearer Token
|
|
@@ -497,7 +497,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
497
497
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
498
498
|
},
|
|
499
499
|
/**
|
|
500
|
-
* Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
|
|
500
|
+
* 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\"
|
|
501
501
|
* @summary Delete the document
|
|
502
502
|
* @param {string} code
|
|
503
503
|
* @param {string} [authorization] Bearer Token
|
|
@@ -509,7 +509,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
509
509
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
510
510
|
},
|
|
511
511
|
/**
|
|
512
|
-
* This will return a presigned URL to download the document.
|
|
512
|
+
* This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
|
|
513
513
|
* @summary Fetches a document download URL
|
|
514
514
|
* @param {string} code Document code
|
|
515
515
|
* @param {string} [authorization] Bearer Token
|
|
@@ -522,7 +522,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
522
522
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
523
523
|
},
|
|
524
524
|
/**
|
|
525
|
-
* This will return a presigned URL for a random S3 key
|
|
525
|
+
* This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
|
|
526
526
|
* @summary Fetches a presigned URL for a S3 key
|
|
527
527
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
528
528
|
* @param {string} [authorization] Bearer Token
|
|
@@ -535,7 +535,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
535
535
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
536
536
|
},
|
|
537
537
|
/**
|
|
538
|
-
* 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.
|
|
538
|
+
* 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\"
|
|
539
539
|
* @summary List documents
|
|
540
540
|
* @param {string} [authorization] Bearer Token
|
|
541
541
|
* @param {number} [pageSize] Page size
|
|
@@ -553,7 +553,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
553
553
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
554
554
|
},
|
|
555
555
|
/**
|
|
556
|
-
* 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.
|
|
556
|
+
* 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\"
|
|
557
557
|
* @summary Save external document
|
|
558
558
|
* @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
|
|
559
559
|
* @param {string} [authorization] Bearer Token
|
|
@@ -565,7 +565,7 @@ export const DocumentsApiFp = function(configuration?: Configuration) {
|
|
|
565
565
|
return createRequestFunction(localVarAxiosArgs, globalAxios, BASE_PATH, configuration);
|
|
566
566
|
},
|
|
567
567
|
/**
|
|
568
|
-
* Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
568
|
+
* 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\"
|
|
569
569
|
* @summary Update the document
|
|
570
570
|
* @param {string} code
|
|
571
571
|
* @param {UpdateDocumentRequestDto} updateDocumentRequestDto
|
|
@@ -588,7 +588,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
588
588
|
const localVarFp = DocumentsApiFp(configuration)
|
|
589
589
|
return {
|
|
590
590
|
/**
|
|
591
|
-
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
|
|
591
|
+
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
|
|
592
592
|
* @summary Create the document
|
|
593
593
|
* @param {CreateDocumentRequestDto} createDocumentRequestDto
|
|
594
594
|
* @param {string} [authorization] Bearer Token
|
|
@@ -599,7 +599,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
599
599
|
return localVarFp.createDocument(createDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
600
600
|
},
|
|
601
601
|
/**
|
|
602
|
-
* This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
|
|
602
|
+
* 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\"
|
|
603
603
|
* @summary Upload documents using pre-signed URL
|
|
604
604
|
* @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
|
|
605
605
|
* @param {string} [authorization] Bearer Token
|
|
@@ -610,7 +610,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
610
610
|
return localVarFp.createPresignedPost(createPresignedPostRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
611
611
|
},
|
|
612
612
|
/**
|
|
613
|
-
* Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
|
|
613
|
+
* 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\"
|
|
614
614
|
* @summary Delete the document
|
|
615
615
|
* @param {string} code
|
|
616
616
|
* @param {string} [authorization] Bearer Token
|
|
@@ -621,7 +621,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
621
621
|
return localVarFp.deleteDocument(code, authorization, options).then((request) => request(axios, basePath));
|
|
622
622
|
},
|
|
623
623
|
/**
|
|
624
|
-
* This will return a presigned URL to download the document.
|
|
624
|
+
* This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
|
|
625
625
|
* @summary Fetches a document download URL
|
|
626
626
|
* @param {string} code Document code
|
|
627
627
|
* @param {string} [authorization] Bearer Token
|
|
@@ -633,7 +633,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
633
633
|
return localVarFp.getDocumentDownloadUrl(code, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
634
634
|
},
|
|
635
635
|
/**
|
|
636
|
-
* This will return a presigned URL for a random S3 key
|
|
636
|
+
* This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
|
|
637
637
|
* @summary Fetches a presigned URL for a S3 key
|
|
638
638
|
* @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
|
|
639
639
|
* @param {string} [authorization] Bearer Token
|
|
@@ -645,7 +645,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
645
645
|
return localVarFp.getSignedS3keyUrl(s3Key, authorization, contentDisposition, options).then((request) => request(axios, basePath));
|
|
646
646
|
},
|
|
647
647
|
/**
|
|
648
|
-
* 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.
|
|
648
|
+
* 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\"
|
|
649
649
|
* @summary List documents
|
|
650
650
|
* @param {string} [authorization] Bearer Token
|
|
651
651
|
* @param {number} [pageSize] Page size
|
|
@@ -662,7 +662,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
662
662
|
return localVarFp.listDocuments(authorization, pageSize, pageToken, filter, search, order, expand, filters, options).then((request) => request(axios, basePath));
|
|
663
663
|
},
|
|
664
664
|
/**
|
|
665
|
-
* 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.
|
|
665
|
+
* 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\"
|
|
666
666
|
* @summary Save external document
|
|
667
667
|
* @param {SaveExternalDocumentRequestDto} saveExternalDocumentRequestDto
|
|
668
668
|
* @param {string} [authorization] Bearer Token
|
|
@@ -673,7 +673,7 @@ export const DocumentsApiFactory = function (configuration?: Configuration, base
|
|
|
673
673
|
return localVarFp.saveExternalDocument(saveExternalDocumentRequestDto, authorization, options).then((request) => request(axios, basePath));
|
|
674
674
|
},
|
|
675
675
|
/**
|
|
676
|
-
* Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
676
|
+
* 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\"
|
|
677
677
|
* @summary Update the document
|
|
678
678
|
* @param {string} code
|
|
679
679
|
* @param {UpdateDocumentRequestDto} updateDocumentRequestDto
|
|
@@ -926,7 +926,7 @@ export interface DocumentsApiUpdateDocumentRequest {
|
|
|
926
926
|
*/
|
|
927
927
|
export class DocumentsApi extends BaseAPI {
|
|
928
928
|
/**
|
|
929
|
-
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3).
|
|
929
|
+
* This will create a document in database and upload the file to Amazon Simple Storage Service (S3). **Required Permissions** \"document-management.documents.create\"
|
|
930
930
|
* @summary Create the document
|
|
931
931
|
* @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
|
|
932
932
|
* @param {*} [options] Override http request option.
|
|
@@ -938,7 +938,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
938
938
|
}
|
|
939
939
|
|
|
940
940
|
/**
|
|
941
|
-
* This will create a URL that allows user upload its documents in Database.The URL will be expires between 5 minutes to 7 days.
|
|
941
|
+
* 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\"
|
|
942
942
|
* @summary Upload documents using pre-signed URL
|
|
943
943
|
* @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
|
|
944
944
|
* @param {*} [options] Override http request option.
|
|
@@ -950,7 +950,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
950
950
|
}
|
|
951
951
|
|
|
952
952
|
/**
|
|
953
|
-
* Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
|
|
953
|
+
* 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\"
|
|
954
954
|
* @summary Delete the document
|
|
955
955
|
* @param {DocumentsApiDeleteDocumentRequest} requestParameters Request parameters.
|
|
956
956
|
* @param {*} [options] Override http request option.
|
|
@@ -962,7 +962,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
962
962
|
}
|
|
963
963
|
|
|
964
964
|
/**
|
|
965
|
-
* This will return a presigned URL to download the document.
|
|
965
|
+
* This will return a presigned URL to download the document. **Required Permissions** \"document-management.documents.view\"
|
|
966
966
|
* @summary Fetches a document download URL
|
|
967
967
|
* @param {DocumentsApiGetDocumentDownloadUrlRequest} requestParameters Request parameters.
|
|
968
968
|
* @param {*} [options] Override http request option.
|
|
@@ -974,7 +974,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
974
974
|
}
|
|
975
975
|
|
|
976
976
|
/**
|
|
977
|
-
* This will return a presigned URL for a random S3 key
|
|
977
|
+
* This will return a presigned URL for a random S3 key **Required Permissions** \"document-management.documents.view\"
|
|
978
978
|
* @summary Fetches a presigned URL for a S3 key
|
|
979
979
|
* @param {DocumentsApiGetSignedS3keyUrlRequest} requestParameters Request parameters.
|
|
980
980
|
* @param {*} [options] Override http request option.
|
|
@@ -986,7 +986,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
986
986
|
}
|
|
987
987
|
|
|
988
988
|
/**
|
|
989
|
-
* 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.
|
|
989
|
+
* 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\"
|
|
990
990
|
* @summary List documents
|
|
991
991
|
* @param {DocumentsApiListDocumentsRequest} requestParameters Request parameters.
|
|
992
992
|
* @param {*} [options] Override http request option.
|
|
@@ -998,7 +998,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
998
998
|
}
|
|
999
999
|
|
|
1000
1000
|
/**
|
|
1001
|
-
* 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.
|
|
1001
|
+
* 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\"
|
|
1002
1002
|
* @summary Save external document
|
|
1003
1003
|
* @param {DocumentsApiSaveExternalDocumentRequest} requestParameters Request parameters.
|
|
1004
1004
|
* @param {*} [options] Override http request option.
|
|
@@ -1010,7 +1010,7 @@ export class DocumentsApi extends BaseAPI {
|
|
|
1010
1010
|
}
|
|
1011
1011
|
|
|
1012
1012
|
/**
|
|
1013
|
-
* Updates the specified document by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
|
|
1013
|
+
* 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\"
|
|
1014
1014
|
* @summary Update the document
|
|
1015
1015
|
* @param {DocumentsApiUpdateDocumentRequest} requestParameters Request parameters.
|
|
1016
1016
|
* @param {*} [options] Override http request option.
|