@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
@@ -0,0 +1,72 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface SearchableDocumentClass
21
+ */
22
+ export interface SearchableDocumentClass {
23
+ /**
24
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
25
+ * @type {number}
26
+ * @memberof SearchableDocumentClass
27
+ */
28
+ 'id': number;
29
+ /**
30
+ * Searchable document name.
31
+ * @type {string}
32
+ * @memberof SearchableDocumentClass
33
+ */
34
+ 'name': string;
35
+ /**
36
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
37
+ * @type {number}
38
+ * @memberof SearchableDocumentClass
39
+ */
40
+ 'ownerId': number;
41
+ /**
42
+ * Searchable document owner name.
43
+ * @type {string}
44
+ * @memberof SearchableDocumentClass
45
+ */
46
+ 'ownerName': string;
47
+ /**
48
+ * Headlines (snippets) from the document.
49
+ * @type {Array<string>}
50
+ * @memberof SearchableDocumentClass
51
+ */
52
+ 'headlines': Array<string>;
53
+ /**
54
+ * S3 key of the searchable document file.
55
+ * @type {string}
56
+ * @memberof SearchableDocumentClass
57
+ */
58
+ 's3Key': string;
59
+ /**
60
+ * Signed URL to download the document file from S3.
61
+ * @type {string}
62
+ * @memberof SearchableDocumentClass
63
+ */
64
+ 'signedS3Url': string;
65
+ /**
66
+ * Rank of the document in the search.
67
+ * @type {number}
68
+ * @memberof SearchableDocumentClass
69
+ */
70
+ 'rank': number;
71
+ }
72
+
@@ -0,0 +1,36 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface SearchableDocumentOwnerClass
21
+ */
22
+ export interface SearchableDocumentOwnerClass {
23
+ /**
24
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
25
+ * @type {number}
26
+ * @memberof SearchableDocumentOwnerClass
27
+ */
28
+ 'id': number;
29
+ /**
30
+ * Searchable document owner name.
31
+ * @type {string}
32
+ * @memberof SearchableDocumentOwnerClass
33
+ */
34
+ 'name': string;
35
+ }
36
+
@@ -13,7 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
- import { CreateHtmlTemplateDto } from './create-html-template-dto';
16
+ import { UpdateHtmlTemplateDto } from './update-html-template-dto';
17
17
 
18
18
  /**
19
19
  *
@@ -22,34 +22,40 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
22
22
  */
23
23
  export interface UpdateDocTemplateRequestDto {
24
24
  /**
25
- * Template name
25
+ * Template name.
26
26
  * @type {string}
27
27
  * @memberof UpdateDocTemplateRequestDto
28
28
  */
29
29
  'name': string;
30
30
  /**
31
- * Template slug
31
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
32
32
  * @type {string}
33
33
  * @memberof UpdateDocTemplateRequestDto
34
34
  */
35
35
  'slug': string;
36
36
  /**
37
- * Template id
37
+ * Unique identifier referencing the layout.
38
38
  * @type {number}
39
39
  * @memberof UpdateDocTemplateRequestDto
40
40
  */
41
- 'id': number;
41
+ 'layoutId': number;
42
+ /**
43
+ * Body templates.
44
+ * @type {UpdateHtmlTemplateDto}
45
+ * @memberof UpdateDocTemplateRequestDto
46
+ */
47
+ 'bodyTemplate': UpdateHtmlTemplateDto;
42
48
  /**
43
- *
44
- * @type {CreateHtmlTemplateDto}
49
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
50
+ * @type {string}
45
51
  * @memberof UpdateDocTemplateRequestDto
46
52
  */
47
- 'bodyTemplate': CreateHtmlTemplateDto;
53
+ 'productSlug'?: string;
48
54
  /**
49
- *
55
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
50
56
  * @type {number}
51
57
  * @memberof UpdateDocTemplateRequestDto
52
58
  */
53
- 'layoutId': number;
59
+ 'id': number;
54
60
  }
55
61
 
@@ -22,7 +22,7 @@ import { DocTemplateClass } from './doc-template-class';
22
22
  */
23
23
  export interface UpdateDocTemplateResponseClass {
24
24
  /**
25
- * Document template
25
+ * Document template.
26
26
  * @type {DocTemplateClass}
27
27
  * @memberof UpdateDocTemplateResponseClass
28
28
  */
@@ -21,25 +21,31 @@
21
21
  */
22
22
  export interface UpdateDocumentRequestDto {
23
23
  /**
24
- * Document description
24
+ * Document description.
25
25
  * @type {string}
26
26
  * @memberof UpdateDocumentRequestDto
27
27
  */
28
28
  'description'?: string;
29
29
  /**
30
- * Policy code
30
+ * Unique identifier of the policy that this object belongs to.
31
31
  * @type {string}
32
32
  * @memberof UpdateDocumentRequestDto
33
33
  */
34
34
  'policyCode'?: string;
35
35
  /**
36
- * Account code
36
+ * Unique identifier of the account that this object belongs to.
37
37
  * @type {string}
38
38
  * @memberof UpdateDocumentRequestDto
39
39
  */
40
40
  'accountCode'?: string;
41
41
  /**
42
- * Entity id
42
+ * Unique identifier of the lead that this object belongs to.
43
+ * @type {string}
44
+ * @memberof UpdateDocumentRequestDto
45
+ */
46
+ 'leadCode'?: string;
47
+ /**
48
+ * Unique identifier referencing the entity.
43
49
  * @type {number}
44
50
  * @memberof UpdateDocumentRequestDto
45
51
  */
@@ -0,0 +1,31 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+ import { DocumentClass } from './document-class';
17
+
18
+ /**
19
+ *
20
+ * @export
21
+ * @interface UpdateDocumentResponseClass
22
+ */
23
+ export interface UpdateDocumentResponseClass {
24
+ /**
25
+ * Document
26
+ * @type {DocumentClass}
27
+ * @memberof UpdateDocumentResponseClass
28
+ */
29
+ 'document': DocumentClass;
30
+ }
31
+
@@ -0,0 +1,51 @@
1
+ /* tslint:disable */
2
+ /* eslint-disable */
3
+ /**
4
+ * EMIL DocumentService
5
+ * The EMIL DocumentService API description
6
+ *
7
+ * The version of the OpenAPI document: 1.0
8
+ *
9
+ *
10
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
11
+ * https://openapi-generator.tech
12
+ * Do not edit the class manually.
13
+ */
14
+
15
+
16
+
17
+ /**
18
+ *
19
+ * @export
20
+ * @interface UpdateHtmlTemplateDto
21
+ */
22
+ export interface UpdateHtmlTemplateDto {
23
+ /**
24
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
25
+ * @type {number}
26
+ * @memberof UpdateHtmlTemplateDto
27
+ */
28
+ 'id': number;
29
+ /**
30
+ * Template type based on HTML layout elements: Header,Body and Footer.
31
+ * @type {string}
32
+ * @memberof UpdateHtmlTemplateDto
33
+ */
34
+ 'type': UpdateHtmlTemplateDtoTypeEnum;
35
+ /**
36
+ * Template draft content.
37
+ * @type {string}
38
+ * @memberof UpdateHtmlTemplateDto
39
+ */
40
+ 'draftContent': string;
41
+ }
42
+
43
+ export const UpdateHtmlTemplateDtoTypeEnum = {
44
+ Header: 'header',
45
+ Footer: 'footer',
46
+ Body: 'body'
47
+ } as const;
48
+
49
+ export type UpdateHtmlTemplateDtoTypeEnum = typeof UpdateHtmlTemplateDtoTypeEnum[keyof typeof UpdateHtmlTemplateDtoTypeEnum];
50
+
51
+
@@ -13,7 +13,7 @@
13
13
  */
14
14
 
15
15
 
16
- import { CreateHtmlTemplateDto } from './create-html-template-dto';
16
+ import { UpdateHtmlTemplateDto } from './update-html-template-dto';
17
17
 
18
18
  /**
19
19
  *
@@ -22,40 +22,40 @@ import { CreateHtmlTemplateDto } from './create-html-template-dto';
22
22
  */
23
23
  export interface UpdateLayoutRequestDto {
24
24
  /**
25
- * Layout name
25
+ * Layout name.
26
26
  * @type {string}
27
27
  * @memberof UpdateLayoutRequestDto
28
28
  */
29
29
  'name': string;
30
30
  /**
31
- * Layout slug
31
+ * A slug is a human-readable, unique identifier, used to identify a resource instead of a less human-readable identifier like an id.
32
32
  * @type {string}
33
33
  * @memberof UpdateLayoutRequestDto
34
34
  */
35
35
  'slug': string;
36
36
  /**
37
- * Layout style
38
- * @type {string}
37
+ * Header template.
38
+ * @type {UpdateHtmlTemplateDto}
39
39
  * @memberof UpdateLayoutRequestDto
40
40
  */
41
- 'style': string;
41
+ 'headerTemplate': UpdateHtmlTemplateDto;
42
42
  /**
43
- * Layout id
44
- * @type {number}
43
+ * Footer template.
44
+ * @type {UpdateHtmlTemplateDto}
45
45
  * @memberof UpdateLayoutRequestDto
46
46
  */
47
- 'id': number;
47
+ 'footerTemplate': UpdateHtmlTemplateDto;
48
48
  /**
49
- *
50
- * @type {CreateHtmlTemplateDto}
49
+ * Layout style.
50
+ * @type {string}
51
51
  * @memberof UpdateLayoutRequestDto
52
52
  */
53
- 'headerTemplate': CreateHtmlTemplateDto;
53
+ 'style': string;
54
54
  /**
55
- *
56
- * @type {CreateHtmlTemplateDto}
55
+ * Internal unique identifier for the object. You should not have to use this, use code instead.
56
+ * @type {number}
57
57
  * @memberof UpdateLayoutRequestDto
58
58
  */
59
- 'footerTemplate': CreateHtmlTemplateDto;
59
+ 'id': number;
60
60
  }
61
61
 
@@ -22,7 +22,7 @@ import { LayoutClass } from './layout-class';
22
22
  */
23
23
  export interface UpdateLayoutResponseClass {
24
24
  /**
25
- * Layout id
25
+ * Layout
26
26
  * @type {LayoutClass}
27
27
  * @memberof UpdateLayoutResponseClass
28
28
  */
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk-node",
3
- "version": "1.2.0",
3
+ "version": "1.2.1",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk-node",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [