@emilgroup/document-sdk-node 1.2.0 → 1.2.1

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.
Files changed (123) hide show
  1. package/.openapi-generator/FILES +15 -0
  2. package/README.md +2 -2
  3. package/api/document-templates-api.ts +88 -94
  4. package/api/documents-api.ts +152 -34
  5. package/api/layouts-api.ts +52 -28
  6. package/api/search-keywords-api.ts +168 -0
  7. package/api/searchable-document-owners-api.ts +26 -22
  8. package/api/searchable-documents-api.ts +16 -12
  9. package/api.ts +2 -0
  10. package/base.ts +1 -1
  11. package/dist/api/document-templates-api.d.ts +82 -78
  12. package/dist/api/document-templates-api.js +73 -67
  13. package/dist/api/documents-api.d.ts +93 -29
  14. package/dist/api/documents-api.js +121 -23
  15. package/dist/api/layouts-api.d.ts +52 -30
  16. package/dist/api/layouts-api.js +43 -23
  17. package/dist/api/search-keywords-api.d.ts +96 -0
  18. package/dist/api/search-keywords-api.js +229 -0
  19. package/dist/api/searchable-document-owners-api.d.ts +23 -19
  20. package/dist/api/searchable-document-owners-api.js +16 -12
  21. package/dist/api/searchable-documents-api.d.ts +16 -12
  22. package/dist/api/searchable-documents-api.js +14 -10
  23. package/dist/api.d.ts +1 -0
  24. package/dist/api.js +1 -0
  25. package/dist/base.js +1 -1
  26. package/dist/models/create-doc-template-request-dto.d.ts +10 -4
  27. package/dist/models/create-doc-template-response-class.d.ts +25 -0
  28. package/dist/models/create-doc-template-response-class.js +15 -0
  29. package/dist/models/create-document-request-dto.d.ts +20 -8
  30. package/dist/models/create-document-sync-response-class.d.ts +25 -0
  31. package/dist/models/create-document-sync-response-class.js +15 -0
  32. package/dist/models/create-html-template-dto.d.ts +1 -1
  33. package/dist/models/create-layout-request-dto.d.ts +10 -10
  34. package/dist/models/create-layout-response-class.d.ts +25 -0
  35. package/dist/models/create-layout-response-class.js +15 -0
  36. package/dist/models/create-presigned-post-request-dto.d.ts +127 -0
  37. package/dist/models/create-presigned-post-request-dto.js +51 -0
  38. package/dist/models/create-presigned-post-response-class.d.ts +30 -0
  39. package/dist/models/create-presigned-post-response-class.js +15 -0
  40. package/dist/models/delete-layout-request-dto.d.ts +1 -1
  41. package/dist/models/delete-request-dto.d.ts +1 -1
  42. package/dist/models/delete-response-class.d.ts +24 -0
  43. package/dist/models/delete-response-class.js +15 -0
  44. package/dist/models/doc-template-class.d.ts +25 -19
  45. package/dist/models/document-class.d.ts +20 -8
  46. package/dist/models/download-document-request-dto.d.ts +2 -2
  47. package/dist/models/get-doc-template-request-dto.d.ts +1 -1
  48. package/dist/models/get-doc-template-response-class.d.ts +1 -1
  49. package/dist/models/get-document-download-url-response-class.d.ts +1 -1
  50. package/dist/models/get-layout-request-dto.d.ts +1 -1
  51. package/dist/models/get-signed-s3-key-url-response-class.d.ts +24 -0
  52. package/dist/models/get-signed-s3-key-url-response-class.js +15 -0
  53. package/dist/models/html-template-class.d.ts +7 -7
  54. package/dist/models/index.d.ts +14 -0
  55. package/dist/models/index.js +14 -0
  56. package/dist/models/layout-class.d.ts +11 -11
  57. package/dist/models/list-doc-template-request-dto.d.ts +48 -0
  58. package/dist/models/list-doc-template-request-dto.js +15 -0
  59. package/dist/models/list-doc-templates-response-class.d.ts +1 -1
  60. package/dist/models/list-documents-response-class.d.ts +1 -1
  61. package/dist/models/list-layouts-response-class.d.ts +1 -1
  62. package/dist/models/list-search-keywords-request-dto.d.ts +24 -0
  63. package/dist/models/list-search-keywords-request-dto.js +15 -0
  64. package/dist/models/list-search-keywords-response-class.d.ts +24 -0
  65. package/dist/models/list-search-keywords-response-class.js +15 -0
  66. package/dist/models/list-searchable-document-owners-response-class.d.ts +3 -2
  67. package/dist/models/list-searchable-documents-request-dto.d.ts +2 -2
  68. package/dist/models/list-searchable-documents-response-class.d.ts +5 -4
  69. package/dist/models/searchable-document-class.d.ts +66 -0
  70. package/dist/models/searchable-document-class.js +15 -0
  71. package/dist/models/searchable-document-owner-class.d.ts +30 -0
  72. package/dist/models/searchable-document-owner-class.js +15 -0
  73. package/dist/models/update-doc-template-request-dto.d.ts +16 -10
  74. package/dist/models/update-doc-template-response-class.d.ts +1 -1
  75. package/dist/models/update-document-request-dto.d.ts +10 -4
  76. package/dist/models/update-document-response-class.d.ts +25 -0
  77. package/dist/models/update-document-response-class.js +15 -0
  78. package/dist/models/update-html-template-dto.d.ts +42 -0
  79. package/dist/models/update-html-template-dto.js +21 -0
  80. package/dist/models/update-layout-request-dto.d.ts +15 -15
  81. package/dist/models/update-layout-response-class.d.ts +1 -1
  82. package/models/create-doc-template-request-dto.ts +10 -4
  83. package/models/create-doc-template-response-class.ts +31 -0
  84. package/models/create-document-request-dto.ts +20 -8
  85. package/models/create-document-sync-response-class.ts +31 -0
  86. package/models/create-html-template-dto.ts +1 -1
  87. package/models/create-layout-request-dto.ts +10 -10
  88. package/models/create-layout-response-class.ts +31 -0
  89. package/models/create-presigned-post-request-dto.ts +137 -0
  90. package/models/create-presigned-post-response-class.ts +36 -0
  91. package/models/delete-layout-request-dto.ts +1 -1
  92. package/models/delete-request-dto.ts +1 -1
  93. package/models/delete-response-class.ts +30 -0
  94. package/models/doc-template-class.ts +25 -19
  95. package/models/document-class.ts +20 -8
  96. package/models/download-document-request-dto.ts +2 -2
  97. package/models/get-doc-template-request-dto.ts +1 -1
  98. package/models/get-doc-template-response-class.ts +1 -1
  99. package/models/get-document-download-url-response-class.ts +1 -1
  100. package/models/get-layout-request-dto.ts +1 -1
  101. package/models/get-signed-s3-key-url-response-class.ts +30 -0
  102. package/models/html-template-class.ts +7 -7
  103. package/models/index.ts +14 -0
  104. package/models/layout-class.ts +11 -11
  105. package/models/list-doc-template-request-dto.ts +54 -0
  106. package/models/list-doc-templates-response-class.ts +1 -1
  107. package/models/list-documents-response-class.ts +1 -1
  108. package/models/list-layouts-response-class.ts +1 -1
  109. package/models/list-search-keywords-request-dto.ts +30 -0
  110. package/models/list-search-keywords-response-class.ts +30 -0
  111. package/models/list-searchable-document-owners-response-class.ts +3 -2
  112. package/models/list-searchable-documents-request-dto.ts +2 -2
  113. package/models/list-searchable-documents-response-class.ts +5 -4
  114. package/models/searchable-document-class.ts +72 -0
  115. package/models/searchable-document-owner-class.ts +36 -0
  116. package/models/update-doc-template-request-dto.ts +16 -10
  117. package/models/update-doc-template-response-class.ts +1 -1
  118. package/models/update-document-request-dto.ts +10 -4
  119. package/models/update-document-response-class.ts +31 -0
  120. package/models/update-html-template-dto.ts +51 -0
  121. package/models/update-layout-request-dto.ts +15 -15
  122. package/models/update-layout-response-class.ts +1 -1
  123. package/package.json +1 -1
@@ -97,7 +97,8 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
97
97
  var _this = this;
98
98
  return {
99
99
  /**
100
- *
100
+ * This will create a document template.
101
+ * @summary Create the document template
101
102
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
102
103
  * @param {string} [authorization] Bearer Token
103
104
  * @param {*} [options] Override http request option.
@@ -145,7 +146,8 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
145
146
  });
146
147
  },
147
148
  /**
148
- *
149
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
150
+ * @summary Delete the document template
149
151
  * @param {number} id
150
152
  * @param {string} [authorization] Bearer Token
151
153
  * @param {*} [options] Override http request option.
@@ -192,15 +194,15 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
192
194
  });
193
195
  },
194
196
  /**
195
- *
196
- * @param {string} id
197
- * @param {number} id2 Template id
197
+ * 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.
198
+ * @summary Retrieve the document template
199
+ * @param {number} id
198
200
  * @param {string} [authorization] Bearer Token
199
- * @param {string} [expand]
201
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
200
202
  * @param {*} [options] Override http request option.
201
203
  * @throws {RequiredError}
202
204
  */
203
- getDocTemplate: function (id, id2, authorization, expand, options) {
205
+ getDocTemplate: function (id, authorization, expand, options) {
204
206
  if (options === void 0) { options = {}; }
205
207
  return __awaiter(_this, void 0, void 0, function () {
206
208
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -209,8 +211,6 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
209
211
  case 0:
210
212
  // verify required parameter 'id' is not null or undefined
211
213
  (0, common_1.assertParamExists)('getDocTemplate', 'id', id);
212
- // verify required parameter 'id2' is not null or undefined
213
- (0, common_1.assertParamExists)('getDocTemplate', 'id2', id2);
214
214
  localVarPath = "/documentservice/v1/doc-templates/{id}"
215
215
  .replace("{".concat("id", "}"), encodeURIComponent(String(id)));
216
216
  localVarUrlObj = new url_1.URL(localVarPath, common_1.DUMMY_BASE_URL);
@@ -228,9 +228,6 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
228
228
  // authentication bearer required
229
229
  // http bearer authentication required
230
230
  _a.sent();
231
- if (id2 !== undefined) {
232
- localVarQueryParameter['id'] = id2;
233
- }
234
231
  if (expand !== undefined) {
235
232
  localVarQueryParameter['expand'] = expand;
236
233
  }
@@ -249,18 +246,18 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
249
246
  });
250
247
  },
251
248
  /**
252
- *
249
+ * 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.
250
+ * @summary List document templates
253
251
  * @param {string} [authorization] Bearer Token
254
- * @param {number} [pageSize] Page size
255
- * @param {string} [pageToken] Page token
256
- * @param {string} [filter] List filter
257
- * @param {string} [search] Search query
258
- * @param {string} [order] Ordering criteria
259
- * @param {string} [expand] Extra fields to fetch
252
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
253
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
254
+ * @param {string} [filter] Filter response by productSlug, slug and name.
255
+ * @param {string} [order] Order response by createdAt.
256
+ * @param {string} [expand] Expand response by bodyTemplate.
260
257
  * @param {*} [options] Override http request option.
261
258
  * @throws {RequiredError}
262
259
  */
263
- listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
260
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, order, expand, options) {
264
261
  if (options === void 0) { options = {}; }
265
262
  return __awaiter(_this, void 0, void 0, function () {
266
263
  var localVarPath, localVarUrlObj, baseOptions, baseAccessToken, localVarRequestOptions, localVarHeaderParameter, localVarQueryParameter, headersFromBaseOptions;
@@ -292,9 +289,6 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
292
289
  if (filter !== undefined) {
293
290
  localVarQueryParameter['filter'] = filter;
294
291
  }
295
- if (search !== undefined) {
296
- localVarQueryParameter['search'] = search;
297
- }
298
292
  if (order !== undefined) {
299
293
  localVarQueryParameter['order'] = order;
300
294
  }
@@ -316,7 +310,8 @@ var DocumentTemplatesApiAxiosParamCreator = function (configuration) {
316
310
  });
317
311
  },
318
312
  /**
319
- *
313
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
314
+ * @summary Update the document template
320
315
  * @param {number} id
321
316
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
322
317
  * @param {string} [authorization] Bearer Token
@@ -378,7 +373,8 @@ var DocumentTemplatesApiFp = function (configuration) {
378
373
  var localVarAxiosParamCreator = (0, exports.DocumentTemplatesApiAxiosParamCreator)(configuration);
379
374
  return {
380
375
  /**
381
- *
376
+ * This will create a document template.
377
+ * @summary Create the document template
382
378
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
383
379
  * @param {string} [authorization] Bearer Token
384
380
  * @param {*} [options] Override http request option.
@@ -398,7 +394,8 @@ var DocumentTemplatesApiFp = function (configuration) {
398
394
  });
399
395
  },
400
396
  /**
401
- *
397
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
398
+ * @summary Delete the document template
402
399
  * @param {number} id
403
400
  * @param {string} [authorization] Bearer Token
404
401
  * @param {*} [options] Override http request option.
@@ -418,20 +415,20 @@ var DocumentTemplatesApiFp = function (configuration) {
418
415
  });
419
416
  },
420
417
  /**
421
- *
422
- * @param {string} id
423
- * @param {number} id2 Template id
418
+ * 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.
419
+ * @summary Retrieve the document template
420
+ * @param {number} id
424
421
  * @param {string} [authorization] Bearer Token
425
- * @param {string} [expand]
422
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
426
423
  * @param {*} [options] Override http request option.
427
424
  * @throws {RequiredError}
428
425
  */
429
- getDocTemplate: function (id, id2, authorization, expand, options) {
426
+ getDocTemplate: function (id, authorization, expand, options) {
430
427
  return __awaiter(this, void 0, void 0, function () {
431
428
  var localVarAxiosArgs;
432
429
  return __generator(this, function (_a) {
433
430
  switch (_a.label) {
434
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocTemplate(id, id2, authorization, expand, options)];
431
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.getDocTemplate(id, authorization, expand, options)];
435
432
  case 1:
436
433
  localVarAxiosArgs = _a.sent();
437
434
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -440,23 +437,23 @@ var DocumentTemplatesApiFp = function (configuration) {
440
437
  });
441
438
  },
442
439
  /**
443
- *
440
+ * 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.
441
+ * @summary List document templates
444
442
  * @param {string} [authorization] Bearer Token
445
- * @param {number} [pageSize] Page size
446
- * @param {string} [pageToken] Page token
447
- * @param {string} [filter] List filter
448
- * @param {string} [search] Search query
449
- * @param {string} [order] Ordering criteria
450
- * @param {string} [expand] Extra fields to fetch
443
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
444
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
445
+ * @param {string} [filter] Filter response by productSlug, slug and name.
446
+ * @param {string} [order] Order response by createdAt.
447
+ * @param {string} [expand] Expand response by bodyTemplate.
451
448
  * @param {*} [options] Override http request option.
452
449
  * @throws {RequiredError}
453
450
  */
454
- listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
451
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, order, expand, options) {
455
452
  return __awaiter(this, void 0, void 0, function () {
456
453
  var localVarAxiosArgs;
457
454
  return __generator(this, function (_a) {
458
455
  switch (_a.label) {
459
- case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options)];
456
+ case 0: return [4 /*yield*/, localVarAxiosParamCreator.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options)];
460
457
  case 1:
461
458
  localVarAxiosArgs = _a.sent();
462
459
  return [2 /*return*/, (0, common_1.createRequestFunction)(localVarAxiosArgs, axios_1.default, base_1.BASE_PATH, configuration)];
@@ -465,7 +462,8 @@ var DocumentTemplatesApiFp = function (configuration) {
465
462
  });
466
463
  },
467
464
  /**
468
- *
465
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
466
+ * @summary Update the document template
469
467
  * @param {number} id
470
468
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
471
469
  * @param {string} [authorization] Bearer Token
@@ -496,7 +494,8 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
496
494
  var localVarFp = (0, exports.DocumentTemplatesApiFp)(configuration);
497
495
  return {
498
496
  /**
499
- *
497
+ * This will create a document template.
498
+ * @summary Create the document template
500
499
  * @param {CreateDocTemplateRequestDto} createDocTemplateRequestDto
501
500
  * @param {string} [authorization] Bearer Token
502
501
  * @param {*} [options] Override http request option.
@@ -506,7 +505,8 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
506
505
  return localVarFp.createDocTemplate(createDocTemplateRequestDto, authorization, options).then(function (request) { return request(axios, basePath); });
507
506
  },
508
507
  /**
509
- *
508
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
509
+ * @summary Delete the document template
510
510
  * @param {number} id
511
511
  * @param {string} [authorization] Bearer Token
512
512
  * @param {*} [options] Override http request option.
@@ -516,34 +516,35 @@ var DocumentTemplatesApiFactory = function (configuration, basePath, axios) {
516
516
  return localVarFp.deleteDocTemplate(id, authorization, options).then(function (request) { return request(axios, basePath); });
517
517
  },
518
518
  /**
519
- *
520
- * @param {string} id
521
- * @param {number} id2 Template id
519
+ * 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.
520
+ * @summary Retrieve the document template
521
+ * @param {number} id
522
522
  * @param {string} [authorization] Bearer Token
523
- * @param {string} [expand]
523
+ * @param {string} [expand] Use this parameter to fetch additional information about the list items. The expand query parameter increases the set of fields that appear in the response in addition to the default ones. Expanding resources can reduce the number of API calls required to accomplish a task. However, use this with parsimony as some expanded fields can drastically increase payload size.
524
524
  * @param {*} [options] Override http request option.
525
525
  * @throws {RequiredError}
526
526
  */
527
- getDocTemplate: function (id, id2, authorization, expand, options) {
528
- return localVarFp.getDocTemplate(id, id2, authorization, expand, options).then(function (request) { return request(axios, basePath); });
527
+ getDocTemplate: function (id, authorization, expand, options) {
528
+ return localVarFp.getDocTemplate(id, authorization, expand, options).then(function (request) { return request(axios, basePath); });
529
529
  },
530
530
  /**
531
- *
531
+ * 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.
532
+ * @summary List document templates
532
533
  * @param {string} [authorization] Bearer Token
533
- * @param {number} [pageSize] Page size
534
- * @param {string} [pageToken] Page token
535
- * @param {string} [filter] List filter
536
- * @param {string} [search] Search query
537
- * @param {string} [order] Ordering criteria
538
- * @param {string} [expand] Extra fields to fetch
534
+ * @param {number} [pageSize] A limit on the number of objects to be returned. Limit ranges between 1 and 100. Default: 10.
535
+ * @param {string} [pageToken] A cursor for use in pagination. pageToken is an ID that defines your place in the list. For instance, if you make a list request and receive 100 objects and pageToken=1, your subsequent call can include pageToken=2 in order to fetch the next page of the list.
536
+ * @param {string} [filter] Filter response by productSlug, slug and name.
537
+ * @param {string} [order] Order response by createdAt.
538
+ * @param {string} [expand] Expand response by bodyTemplate.
539
539
  * @param {*} [options] Override http request option.
540
540
  * @throws {RequiredError}
541
541
  */
542
- listDocTemplates: function (authorization, pageSize, pageToken, filter, search, order, expand, options) {
543
- return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, search, order, expand, options).then(function (request) { return request(axios, basePath); });
542
+ listDocTemplates: function (authorization, pageSize, pageToken, filter, order, expand, options) {
543
+ return localVarFp.listDocTemplates(authorization, pageSize, pageToken, filter, order, expand, options).then(function (request) { return request(axios, basePath); });
544
544
  },
545
545
  /**
546
- *
546
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
547
+ * @summary Update the document template
547
548
  * @param {number} id
548
549
  * @param {UpdateDocTemplateRequestDto} updateDocTemplateRequestDto
549
550
  * @param {string} [authorization] Bearer Token
@@ -568,7 +569,8 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
568
569
  return _super !== null && _super.apply(this, arguments) || this;
569
570
  }
570
571
  /**
571
- *
572
+ * This will create a document template.
573
+ * @summary Create the document template
572
574
  * @param {DocumentTemplatesApiCreateDocTemplateRequest} requestParameters Request parameters.
573
575
  * @param {*} [options] Override http request option.
574
576
  * @throws {RequiredError}
@@ -579,7 +581,8 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
579
581
  return (0, exports.DocumentTemplatesApiFp)(this.configuration).createDocTemplate(requestParameters.createDocTemplateRequestDto, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
580
582
  };
581
583
  /**
582
- *
584
+ * Permanently deletes the document template. Supply the unique code that was returned when you created the document template and this will delete it.
585
+ * @summary Delete the document template
583
586
  * @param {DocumentTemplatesApiDeleteDocTemplateRequest} requestParameters Request parameters.
584
587
  * @param {*} [options] Override http request option.
585
588
  * @throws {RequiredError}
@@ -590,7 +593,8 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
590
593
  return (0, exports.DocumentTemplatesApiFp)(this.configuration).deleteDocTemplate(requestParameters.id, requestParameters.authorization, options).then(function (request) { return request(_this.axios, _this.basePath); });
591
594
  };
592
595
  /**
593
- *
596
+ * 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.
597
+ * @summary Retrieve the document template
594
598
  * @param {DocumentTemplatesApiGetDocTemplateRequest} requestParameters Request parameters.
595
599
  * @param {*} [options] Override http request option.
596
600
  * @throws {RequiredError}
@@ -598,10 +602,11 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
598
602
  */
599
603
  DocumentTemplatesApi.prototype.getDocTemplate = function (requestParameters, options) {
600
604
  var _this = this;
601
- return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.id2, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
605
+ return (0, exports.DocumentTemplatesApiFp)(this.configuration).getDocTemplate(requestParameters.id, requestParameters.authorization, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
602
606
  };
603
607
  /**
604
- *
608
+ * 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.
609
+ * @summary List document templates
605
610
  * @param {DocumentTemplatesApiListDocTemplatesRequest} requestParameters Request parameters.
606
611
  * @param {*} [options] Override http request option.
607
612
  * @throws {RequiredError}
@@ -610,10 +615,11 @@ var DocumentTemplatesApi = /** @class */ (function (_super) {
610
615
  DocumentTemplatesApi.prototype.listDocTemplates = function (requestParameters, options) {
611
616
  var _this = this;
612
617
  if (requestParameters === void 0) { requestParameters = {}; }
613
- return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.search, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
618
+ return (0, exports.DocumentTemplatesApiFp)(this.configuration).listDocTemplates(requestParameters.authorization, requestParameters.pageSize, requestParameters.pageToken, requestParameters.filter, requestParameters.order, requestParameters.expand, options).then(function (request) { return request(_this.axios, _this.basePath); });
614
619
  };
615
620
  /**
616
- *
621
+ * Updates the specified document template by setting the values of the parameters passed. Any parameters not provided will be left unchanged.
622
+ * @summary Update the document template
617
623
  * @param {DocumentTemplatesApiUpdateDocTemplateRequest} requestParameters Request parameters.
618
624
  * @param {*} [options] Override http request option.
619
625
  * @throws {RequiredError}
@@ -13,16 +13,21 @@ import { AxiosPromise, AxiosInstance, AxiosRequestConfig } from 'axios';
13
13
  import { Configuration } from '../configuration';
14
14
  import { RequestArgs, BaseAPI } from '../base';
15
15
  import { CreateDocumentRequestDto } from '../models';
16
+ import { CreateDocumentSyncResponseClass } from '../models';
17
+ import { CreatePresignedPostRequestDto } from '../models';
18
+ import { CreatePresignedPostResponseClass } from '../models';
16
19
  import { GetDocumentDownloadUrlResponseClass } from '../models';
20
+ import { GetSignedS3KeyUrlResponseClass } from '../models';
17
21
  import { ListDocumentsResponseClass } from '../models';
18
22
  import { UpdateDocumentRequestDto } from '../models';
23
+ import { UpdateDocumentResponseClass } from '../models';
19
24
  /**
20
25
  * DocumentsApi - axios parameter creator
21
26
  * @export
22
27
  */
23
28
  export declare const DocumentsApiAxiosParamCreator: (configuration?: Configuration) => {
24
29
  /**
25
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
30
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
26
31
  * @summary Create the document
27
32
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
28
33
  * @param {string} [authorization] Bearer Token
@@ -31,13 +36,14 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
31
36
  */
32
37
  createDocument: (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
33
38
  /**
34
- *
35
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
39
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
40
+ * @summary Upload documents using pre-signed URL
41
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
36
42
  * @param {string} [authorization] Bearer Token
37
43
  * @param {*} [options] Override http request option.
38
44
  * @throws {RequiredError}
39
45
  */
40
- createTemporaryDocument: (createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
46
+ createPresignedPost: (createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
41
47
  /**
42
48
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
43
49
  * @summary Delete the document
@@ -56,6 +62,15 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
56
62
  * @throws {RequiredError}
57
63
  */
58
64
  getDocumentDownloadUrl: (code: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
65
+ /**
66
+ * This will return a presigned URL for a random S3 key
67
+ * @summary Fetches a presigned URL for a S3 key
68
+ * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
69
+ * @param {string} [authorization] Bearer Token
70
+ * @param {*} [options] Override http request option.
71
+ * @throws {RequiredError}
72
+ */
73
+ getSignedS3keyUrl: (s3Key: string, authorization?: string, options?: AxiosRequestConfig) => Promise<RequestArgs>;
59
74
  /**
60
75
  * 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.
61
76
  * @summary List documents
@@ -87,22 +102,23 @@ export declare const DocumentsApiAxiosParamCreator: (configuration?: Configurati
87
102
  */
88
103
  export declare const DocumentsApiFp: (configuration?: Configuration) => {
89
104
  /**
90
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
105
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
91
106
  * @summary Create the document
92
107
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
93
108
  * @param {string} [authorization] Bearer Token
94
109
  * @param {*} [options] Override http request option.
95
110
  * @throws {RequiredError}
96
111
  */
97
- createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
112
+ createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreateDocumentSyncResponseClass>>;
98
113
  /**
99
- *
100
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
114
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
115
+ * @summary Upload documents using pre-signed URL
116
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
101
117
  * @param {string} [authorization] Bearer Token
102
118
  * @param {*} [options] Override http request option.
103
119
  * @throws {RequiredError}
104
120
  */
105
- createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<void>>;
121
+ createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<CreatePresignedPostResponseClass>>;
106
122
  /**
107
123
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
108
124
  * @summary Delete the document
@@ -121,6 +137,15 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
121
137
  * @throws {RequiredError}
122
138
  */
123
139
  getDocumentDownloadUrl(code: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetDocumentDownloadUrlResponseClass>>;
140
+ /**
141
+ * This will return a presigned URL for a random S3 key
142
+ * @summary Fetches a presigned URL for a S3 key
143
+ * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
144
+ * @param {string} [authorization] Bearer Token
145
+ * @param {*} [options] Override http request option.
146
+ * @throws {RequiredError}
147
+ */
148
+ getSignedS3keyUrl(s3Key: string, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<GetSignedS3KeyUrlResponseClass>>;
124
149
  /**
125
150
  * 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.
126
151
  * @summary List documents
@@ -144,7 +169,7 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
144
169
  * @param {*} [options] Override http request option.
145
170
  * @throws {RequiredError}
146
171
  */
147
- updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<object>>;
172
+ updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: AxiosRequestConfig): Promise<(axios?: AxiosInstance, basePath?: string) => AxiosPromise<UpdateDocumentResponseClass>>;
148
173
  };
149
174
  /**
150
175
  * DocumentsApi - factory interface
@@ -152,22 +177,23 @@ export declare const DocumentsApiFp: (configuration?: Configuration) => {
152
177
  */
153
178
  export declare const DocumentsApiFactory: (configuration?: Configuration, basePath?: string, axios?: AxiosInstance) => {
154
179
  /**
155
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
180
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
156
181
  * @summary Create the document
157
182
  * @param {CreateDocumentRequestDto} createDocumentRequestDto
158
183
  * @param {string} [authorization] Bearer Token
159
184
  * @param {*} [options] Override http request option.
160
185
  * @throws {RequiredError}
161
186
  */
162
- createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
187
+ createDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<CreateDocumentSyncResponseClass>;
163
188
  /**
164
- *
165
- * @param {CreateDocumentRequestDto} createDocumentRequestDto
189
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
190
+ * @summary Upload documents using pre-signed URL
191
+ * @param {CreatePresignedPostRequestDto} createPresignedPostRequestDto
166
192
  * @param {string} [authorization] Bearer Token
167
193
  * @param {*} [options] Override http request option.
168
194
  * @throws {RequiredError}
169
195
  */
170
- createTemporaryDocument(createDocumentRequestDto: CreateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<void>;
196
+ createPresignedPost(createPresignedPostRequestDto: CreatePresignedPostRequestDto, authorization?: string, options?: any): AxiosPromise<CreatePresignedPostResponseClass>;
171
197
  /**
172
198
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
173
199
  * @summary Delete the document
@@ -186,6 +212,15 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
186
212
  * @throws {RequiredError}
187
213
  */
188
214
  getDocumentDownloadUrl(code: string, authorization?: string, options?: any): AxiosPromise<GetDocumentDownloadUrlResponseClass>;
215
+ /**
216
+ * This will return a presigned URL for a random S3 key
217
+ * @summary Fetches a presigned URL for a S3 key
218
+ * @param {string} s3Key Key for the file in S3 bucket to create the presigned download URL for
219
+ * @param {string} [authorization] Bearer Token
220
+ * @param {*} [options] Override http request option.
221
+ * @throws {RequiredError}
222
+ */
223
+ getSignedS3keyUrl(s3Key: string, authorization?: string, options?: any): AxiosPromise<GetSignedS3KeyUrlResponseClass>;
189
224
  /**
190
225
  * 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.
191
226
  * @summary List documents
@@ -209,7 +244,7 @@ export declare const DocumentsApiFactory: (configuration?: Configuration, basePa
209
244
  * @param {*} [options] Override http request option.
210
245
  * @throws {RequiredError}
211
246
  */
212
- updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<object>;
247
+ updateDocument(code: string, updateDocumentRequestDto: UpdateDocumentRequestDto, authorization?: string, options?: any): AxiosPromise<UpdateDocumentResponseClass>;
213
248
  };
214
249
  /**
215
250
  * Request parameters for createDocument operation in DocumentsApi.
@@ -231,21 +266,21 @@ export interface DocumentsApiCreateDocumentRequest {
231
266
  readonly authorization?: string;
232
267
  }
233
268
  /**
234
- * Request parameters for createTemporaryDocument operation in DocumentsApi.
269
+ * Request parameters for createPresignedPost operation in DocumentsApi.
235
270
  * @export
236
- * @interface DocumentsApiCreateTemporaryDocumentRequest
271
+ * @interface DocumentsApiCreatePresignedPostRequest
237
272
  */
238
- export interface DocumentsApiCreateTemporaryDocumentRequest {
273
+ export interface DocumentsApiCreatePresignedPostRequest {
239
274
  /**
240
275
  *
241
- * @type {CreateDocumentRequestDto}
242
- * @memberof DocumentsApiCreateTemporaryDocument
276
+ * @type {CreatePresignedPostRequestDto}
277
+ * @memberof DocumentsApiCreatePresignedPost
243
278
  */
244
- readonly createDocumentRequestDto: CreateDocumentRequestDto;
279
+ readonly createPresignedPostRequestDto: CreatePresignedPostRequestDto;
245
280
  /**
246
281
  * Bearer Token
247
282
  * @type {string}
248
- * @memberof DocumentsApiCreateTemporaryDocument
283
+ * @memberof DocumentsApiCreatePresignedPost
249
284
  */
250
285
  readonly authorization?: string;
251
286
  }
@@ -287,6 +322,25 @@ export interface DocumentsApiGetDocumentDownloadUrlRequest {
287
322
  */
288
323
  readonly authorization?: string;
289
324
  }
325
+ /**
326
+ * Request parameters for getSignedS3keyUrl operation in DocumentsApi.
327
+ * @export
328
+ * @interface DocumentsApiGetSignedS3keyUrlRequest
329
+ */
330
+ export interface DocumentsApiGetSignedS3keyUrlRequest {
331
+ /**
332
+ * Key for the file in S3 bucket to create the presigned download URL for
333
+ * @type {string}
334
+ * @memberof DocumentsApiGetSignedS3keyUrl
335
+ */
336
+ readonly s3Key: string;
337
+ /**
338
+ * Bearer Token
339
+ * @type {string}
340
+ * @memberof DocumentsApiGetSignedS3keyUrl
341
+ */
342
+ readonly authorization?: string;
343
+ }
290
344
  /**
291
345
  * Request parameters for listDocuments operation in DocumentsApi.
292
346
  * @export
@@ -369,22 +423,23 @@ export interface DocumentsApiUpdateDocumentRequest {
369
423
  */
370
424
  export declare class DocumentsApi extends BaseAPI {
371
425
  /**
372
- * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
426
+ * This will create a document in database and upload the file to Amazon Simple Storage Service (S3). Document can then be downloaded with
373
427
  * @summary Create the document
374
428
  * @param {DocumentsApiCreateDocumentRequest} requestParameters Request parameters.
375
429
  * @param {*} [options] Override http request option.
376
430
  * @throws {RequiredError}
377
431
  * @memberof DocumentsApi
378
432
  */
379
- createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
433
+ createDocument(requestParameters: DocumentsApiCreateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreateDocumentSyncResponseClass, any>>;
380
434
  /**
381
- *
382
- * @param {DocumentsApiCreateTemporaryDocumentRequest} requestParameters Request parameters.
435
+ * This will create a URL that allows user upload its documents in Database.The URL will be expires between 5minutes to 7days.
436
+ * @summary Upload documents using pre-signed URL
437
+ * @param {DocumentsApiCreatePresignedPostRequest} requestParameters Request parameters.
383
438
  * @param {*} [options] Override http request option.
384
439
  * @throws {RequiredError}
385
440
  * @memberof DocumentsApi
386
441
  */
387
- createTemporaryDocument(requestParameters: DocumentsApiCreateTemporaryDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<void, any>>;
442
+ createPresignedPost(requestParameters: DocumentsApiCreatePresignedPostRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<CreatePresignedPostResponseClass, any>>;
388
443
  /**
389
444
  * Permanently deletes the document. Supply the unique code that was returned when you created the document and this will delete it.
390
445
  * @summary Delete the document
@@ -403,6 +458,15 @@ export declare class DocumentsApi extends BaseAPI {
403
458
  * @memberof DocumentsApi
404
459
  */
405
460
  getDocumentDownloadUrl(requestParameters: DocumentsApiGetDocumentDownloadUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetDocumentDownloadUrlResponseClass, any>>;
461
+ /**
462
+ * This will return a presigned URL for a random S3 key
463
+ * @summary Fetches a presigned URL for a S3 key
464
+ * @param {DocumentsApiGetSignedS3keyUrlRequest} requestParameters Request parameters.
465
+ * @param {*} [options] Override http request option.
466
+ * @throws {RequiredError}
467
+ * @memberof DocumentsApi
468
+ */
469
+ getSignedS3keyUrl(requestParameters: DocumentsApiGetSignedS3keyUrlRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<GetSignedS3KeyUrlResponseClass, any>>;
406
470
  /**
407
471
  * 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.
408
472
  * @summary List documents
@@ -420,5 +484,5 @@ export declare class DocumentsApi extends BaseAPI {
420
484
  * @throws {RequiredError}
421
485
  * @memberof DocumentsApi
422
486
  */
423
- updateDocument(requestParameters: DocumentsApiUpdateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<object, any>>;
487
+ updateDocument(requestParameters: DocumentsApiUpdateDocumentRequest, options?: AxiosRequestConfig): Promise<import("axios").AxiosResponse<UpdateDocumentResponseClass, any>>;
424
488
  }