@emilgroup/document-sdk 1.6.0 → 1.7.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.
Files changed (32) hide show
  1. package/.openapi-generator/FILES +6 -0
  2. package/README.md +2 -2
  3. package/api/default-api.ts +120 -0
  4. package/api/docx-templates-api.ts +554 -0
  5. package/api.ts +4 -0
  6. package/dist/api/default-api.d.ts +66 -0
  7. package/dist/api/default-api.js +196 -0
  8. package/dist/api/docx-templates-api.d.ts +316 -0
  9. package/dist/api/docx-templates-api.js +538 -0
  10. package/dist/api.d.ts +2 -0
  11. package/dist/api.js +2 -0
  12. package/dist/models/create-document-request-dto.d.ts +17 -0
  13. package/dist/models/create-document-request-dto.js +5 -1
  14. package/dist/models/create-presigned-post-request-dto.d.ts +6 -0
  15. package/dist/models/index.d.ts +4 -0
  16. package/dist/models/index.js +4 -0
  17. package/dist/models/inline-response200.d.ts +54 -0
  18. package/dist/models/inline-response200.js +15 -0
  19. package/dist/models/inline-response503.d.ts +54 -0
  20. package/dist/models/inline-response503.js +15 -0
  21. package/dist/models/shared-update-docx-template-request-dto.d.ts +36 -0
  22. package/dist/models/shared-update-docx-template-request-dto.js +15 -0
  23. package/dist/models/upload-docx-template-request-dto.d.ts +54 -0
  24. package/dist/models/upload-docx-template-request-dto.js +15 -0
  25. package/models/create-document-request-dto.ts +18 -0
  26. package/models/create-presigned-post-request-dto.ts +6 -0
  27. package/models/index.ts +4 -0
  28. package/models/inline-response200.ts +48 -0
  29. package/models/inline-response503.ts +48 -0
  30. package/models/shared-update-docx-template-request-dto.ts +42 -0
  31. package/models/upload-docx-template-request-dto.ts +60 -0
  32. package/package.json +1 -1
@@ -41,6 +41,8 @@ __exportStar(require("./get-signed-s3-key-url-response-class"), exports);
41
41
  __exportStar(require("./grpc-create-doc-template-request-dto"), exports);
42
42
  __exportStar(require("./grpc-update-doc-template-request-dto"), exports);
43
43
  __exportStar(require("./html-template-class"), exports);
44
+ __exportStar(require("./inline-response200"), exports);
45
+ __exportStar(require("./inline-response503"), exports);
44
46
  __exportStar(require("./layout-class"), exports);
45
47
  __exportStar(require("./list-doc-template-request-dto"), exports);
46
48
  __exportStar(require("./list-doc-templates-response-class"), exports);
@@ -57,6 +59,7 @@ __exportStar(require("./list-searchable-documents-response-class"), exports);
57
59
  __exportStar(require("./product-document-class"), exports);
58
60
  __exportStar(require("./searchable-document-class"), exports);
59
61
  __exportStar(require("./searchable-document-owner-class"), exports);
62
+ __exportStar(require("./shared-update-docx-template-request-dto"), exports);
60
63
  __exportStar(require("./update-doc-template-request-dto"), exports);
61
64
  __exportStar(require("./update-doc-template-response-class"), exports);
62
65
  __exportStar(require("./update-document-request-dto"), exports);
@@ -64,4 +67,5 @@ __exportStar(require("./update-document-response-class"), exports);
64
67
  __exportStar(require("./update-html-template-dto"), exports);
65
68
  __exportStar(require("./update-layout-request-dto"), exports);
66
69
  __exportStar(require("./update-layout-response-class"), exports);
70
+ __exportStar(require("./upload-docx-template-request-dto"), exports);
67
71
  __exportStar(require("./upload-product-document-request-dto"), exports);
@@ -0,0 +1,54 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface InlineResponse200
16
+ */
17
+ export interface InlineResponse200 {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof InlineResponse200
22
+ */
23
+ 'status'?: string;
24
+ /**
25
+ *
26
+ * @type {{ [key: string]: { [key: string]: string; }; }}
27
+ * @memberof InlineResponse200
28
+ */
29
+ 'info'?: {
30
+ [key: string]: {
31
+ [key: string]: string;
32
+ };
33
+ } | null;
34
+ /**
35
+ *
36
+ * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @memberof InlineResponse200
38
+ */
39
+ 'error'?: {
40
+ [key: string]: {
41
+ [key: string]: string;
42
+ };
43
+ } | null;
44
+ /**
45
+ *
46
+ * @type {{ [key: string]: { [key: string]: string; }; }}
47
+ * @memberof InlineResponse200
48
+ */
49
+ 'details'?: {
50
+ [key: string]: {
51
+ [key: string]: string;
52
+ };
53
+ };
54
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,54 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface InlineResponse503
16
+ */
17
+ export interface InlineResponse503 {
18
+ /**
19
+ *
20
+ * @type {string}
21
+ * @memberof InlineResponse503
22
+ */
23
+ 'status'?: string;
24
+ /**
25
+ *
26
+ * @type {{ [key: string]: { [key: string]: string; }; }}
27
+ * @memberof InlineResponse503
28
+ */
29
+ 'info'?: {
30
+ [key: string]: {
31
+ [key: string]: string;
32
+ };
33
+ } | null;
34
+ /**
35
+ *
36
+ * @type {{ [key: string]: { [key: string]: string; }; }}
37
+ * @memberof InlineResponse503
38
+ */
39
+ 'error'?: {
40
+ [key: string]: {
41
+ [key: string]: string;
42
+ };
43
+ } | null;
44
+ /**
45
+ *
46
+ * @type {{ [key: string]: { [key: string]: string; }; }}
47
+ * @memberof InlineResponse503
48
+ */
49
+ 'details'?: {
50
+ [key: string]: {
51
+ [key: string]: string;
52
+ };
53
+ };
54
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,36 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface SharedUpdateDocxTemplateRequestDto
16
+ */
17
+ export interface SharedUpdateDocxTemplateRequestDto {
18
+ /**
19
+ * Description of the document. Usually a short summary about the context in which the template is being used.
20
+ * @type {string}
21
+ * @memberof SharedUpdateDocxTemplateRequestDto
22
+ */
23
+ 'description': string;
24
+ /**
25
+ * Name of the file the end user will see when he downloads it.
26
+ * @type {string}
27
+ * @memberof SharedUpdateDocxTemplateRequestDto
28
+ */
29
+ 'filename': string;
30
+ /**
31
+ * Entity type of the docx template.
32
+ * @type {string}
33
+ * @memberof SharedUpdateDocxTemplateRequestDto
34
+ */
35
+ 'entityType': string;
36
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -0,0 +1,54 @@
1
+ /**
2
+ * EMIL DocumentService
3
+ * The EMIL DocumentService API description
4
+ *
5
+ * The version of the OpenAPI document: 1.0
6
+ * Contact: kontakt@emil.de
7
+ *
8
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
9
+ * https://openapi-generator.tech
10
+ * Do not edit the class manually.
11
+ */
12
+ /**
13
+ *
14
+ * @export
15
+ * @interface UploadDocxTemplateRequestDto
16
+ */
17
+ export interface UploadDocxTemplateRequestDto {
18
+ /**
19
+ * Slug of the docx template.
20
+ * @type {string}
21
+ * @memberof UploadDocxTemplateRequestDto
22
+ */
23
+ 'slug': string;
24
+ /**
25
+ * Slug of the product.
26
+ * @type {string}
27
+ * @memberof UploadDocxTemplateRequestDto
28
+ */
29
+ 'productSlug': string;
30
+ /**
31
+ * Description of the document. Usually a short summary about the context in which the template is being used.
32
+ * @type {string}
33
+ * @memberof UploadDocxTemplateRequestDto
34
+ */
35
+ 'description': string;
36
+ /**
37
+ * Name of the file the end user will see when he downloads it.
38
+ * @type {string}
39
+ * @memberof UploadDocxTemplateRequestDto
40
+ */
41
+ 'filename': string;
42
+ /**
43
+ * Entity type of the docx template.
44
+ * @type {string}
45
+ * @memberof UploadDocxTemplateRequestDto
46
+ */
47
+ 'entityType': string;
48
+ /**
49
+ * Id of the product version, and is optional. If not provided, the document will be attached to the latest version of the product.
50
+ * @type {number}
51
+ * @memberof UploadDocxTemplateRequestDto
52
+ */
53
+ 'productVersionId'?: number;
54
+ }
@@ -0,0 +1,15 @@
1
+ "use strict";
2
+ /* tslint:disable */
3
+ /* eslint-disable */
4
+ /**
5
+ * EMIL DocumentService
6
+ * The EMIL DocumentService API description
7
+ *
8
+ * The version of the OpenAPI document: 1.0
9
+ * Contact: kontakt@emil.de
10
+ *
11
+ * NOTE: This class is auto generated by OpenAPI Generator (https://openapi-generator.tech).
12
+ * https://openapi-generator.tech
13
+ * Do not edit the class manually.
14
+ */
15
+ Object.defineProperty(exports, "__esModule", { value: true });
@@ -104,6 +104,18 @@ export interface CreateDocumentRequestDto {
104
104
  * @memberof CreateDocumentRequestDto
105
105
  */
106
106
  'productSlug'?: string;
107
+ /**
108
+ * If true, the default margins will be skipped when generating the document.
109
+ * @type {boolean}
110
+ * @memberof CreateDocumentRequestDto
111
+ */
112
+ 'shouldSkipDefaultMargins'?: boolean;
113
+ /**
114
+ * Type of the document engine to use to generate the document. Defaults to HTML.
115
+ * @type {string}
116
+ * @memberof CreateDocumentRequestDto
117
+ */
118
+ 'engine'?: CreateDocumentRequestDtoEngineEnum;
107
119
  }
108
120
 
109
121
  export const CreateDocumentRequestDtoEntityTypeEnum = {
@@ -164,5 +176,11 @@ export const CreateDocumentRequestDtoContentTypeEnum = {
164
176
  } as const;
165
177
 
166
178
  export type CreateDocumentRequestDtoContentTypeEnum = typeof CreateDocumentRequestDtoContentTypeEnum[keyof typeof CreateDocumentRequestDtoContentTypeEnum];
179
+ export const CreateDocumentRequestDtoEngineEnum = {
180
+ Docx: 'docx',
181
+ Html: 'html'
182
+ } as const;
183
+
184
+ export type CreateDocumentRequestDtoEngineEnum = typeof CreateDocumentRequestDtoEngineEnum[keyof typeof CreateDocumentRequestDtoEngineEnum];
167
185
 
168
186
 
@@ -92,6 +92,12 @@ export interface CreatePresignedPostRequestDto {
92
92
  * @memberof CreatePresignedPostRequestDto
93
93
  */
94
94
  'productSlug'?: string;
95
+ /**
96
+ * ERN under which the document will be uploaded. This is useful when uploading documents on behalf of a child organization
97
+ * @type {string}
98
+ * @memberof CreatePresignedPostRequestDto
99
+ */
100
+ 'ern'?: string;
95
101
  }
96
102
 
97
103
  export const CreatePresignedPostRequestDtoRequesterEnum = {
package/models/index.ts CHANGED
@@ -25,6 +25,8 @@ export * from './get-signed-s3-key-url-response-class';
25
25
  export * from './grpc-create-doc-template-request-dto';
26
26
  export * from './grpc-update-doc-template-request-dto';
27
27
  export * from './html-template-class';
28
+ export * from './inline-response200';
29
+ export * from './inline-response503';
28
30
  export * from './layout-class';
29
31
  export * from './list-doc-template-request-dto';
30
32
  export * from './list-doc-templates-response-class';
@@ -41,6 +43,7 @@ export * from './list-searchable-documents-response-class';
41
43
  export * from './product-document-class';
42
44
  export * from './searchable-document-class';
43
45
  export * from './searchable-document-owner-class';
46
+ export * from './shared-update-docx-template-request-dto';
44
47
  export * from './update-doc-template-request-dto';
45
48
  export * from './update-doc-template-response-class';
46
49
  export * from './update-document-request-dto';
@@ -48,4 +51,5 @@ export * from './update-document-response-class';
48
51
  export * from './update-html-template-dto';
49
52
  export * from './update-layout-request-dto';
50
53
  export * from './update-layout-response-class';
54
+ export * from './upload-docx-template-request-dto';
51
55
  export * from './upload-product-document-request-dto';
@@ -0,0 +1,48 @@
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
+ * Contact: kontakt@emil.de
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 InlineResponse200
21
+ */
22
+ export interface InlineResponse200 {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof InlineResponse200
27
+ */
28
+ 'status'?: string;
29
+ /**
30
+ *
31
+ * @type {{ [key: string]: { [key: string]: string; }; }}
32
+ * @memberof InlineResponse200
33
+ */
34
+ 'info'?: { [key: string]: { [key: string]: string; }; } | null;
35
+ /**
36
+ *
37
+ * @type {{ [key: string]: { [key: string]: string; }; }}
38
+ * @memberof InlineResponse200
39
+ */
40
+ 'error'?: { [key: string]: { [key: string]: string; }; } | null;
41
+ /**
42
+ *
43
+ * @type {{ [key: string]: { [key: string]: string; }; }}
44
+ * @memberof InlineResponse200
45
+ */
46
+ 'details'?: { [key: string]: { [key: string]: string; }; };
47
+ }
48
+
@@ -0,0 +1,48 @@
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
+ * Contact: kontakt@emil.de
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 InlineResponse503
21
+ */
22
+ export interface InlineResponse503 {
23
+ /**
24
+ *
25
+ * @type {string}
26
+ * @memberof InlineResponse503
27
+ */
28
+ 'status'?: string;
29
+ /**
30
+ *
31
+ * @type {{ [key: string]: { [key: string]: string; }; }}
32
+ * @memberof InlineResponse503
33
+ */
34
+ 'info'?: { [key: string]: { [key: string]: string; }; } | null;
35
+ /**
36
+ *
37
+ * @type {{ [key: string]: { [key: string]: string; }; }}
38
+ * @memberof InlineResponse503
39
+ */
40
+ 'error'?: { [key: string]: { [key: string]: string; }; } | null;
41
+ /**
42
+ *
43
+ * @type {{ [key: string]: { [key: string]: string; }; }}
44
+ * @memberof InlineResponse503
45
+ */
46
+ 'details'?: { [key: string]: { [key: string]: string; }; };
47
+ }
48
+
@@ -0,0 +1,42 @@
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
+ * Contact: kontakt@emil.de
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 SharedUpdateDocxTemplateRequestDto
21
+ */
22
+ export interface SharedUpdateDocxTemplateRequestDto {
23
+ /**
24
+ * Description of the document. Usually a short summary about the context in which the template is being used.
25
+ * @type {string}
26
+ * @memberof SharedUpdateDocxTemplateRequestDto
27
+ */
28
+ 'description': string;
29
+ /**
30
+ * Name of the file the end user will see when he downloads it.
31
+ * @type {string}
32
+ * @memberof SharedUpdateDocxTemplateRequestDto
33
+ */
34
+ 'filename': string;
35
+ /**
36
+ * Entity type of the docx template.
37
+ * @type {string}
38
+ * @memberof SharedUpdateDocxTemplateRequestDto
39
+ */
40
+ 'entityType': string;
41
+ }
42
+
@@ -0,0 +1,60 @@
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
+ * Contact: kontakt@emil.de
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 UploadDocxTemplateRequestDto
21
+ */
22
+ export interface UploadDocxTemplateRequestDto {
23
+ /**
24
+ * Slug of the docx template.
25
+ * @type {string}
26
+ * @memberof UploadDocxTemplateRequestDto
27
+ */
28
+ 'slug': string;
29
+ /**
30
+ * Slug of the product.
31
+ * @type {string}
32
+ * @memberof UploadDocxTemplateRequestDto
33
+ */
34
+ 'productSlug': string;
35
+ /**
36
+ * Description of the document. Usually a short summary about the context in which the template is being used.
37
+ * @type {string}
38
+ * @memberof UploadDocxTemplateRequestDto
39
+ */
40
+ 'description': string;
41
+ /**
42
+ * Name of the file the end user will see when he downloads it.
43
+ * @type {string}
44
+ * @memberof UploadDocxTemplateRequestDto
45
+ */
46
+ 'filename': string;
47
+ /**
48
+ * Entity type of the docx template.
49
+ * @type {string}
50
+ * @memberof UploadDocxTemplateRequestDto
51
+ */
52
+ 'entityType': string;
53
+ /**
54
+ * Id of the product version, and is optional. If not provided, the document will be attached to the latest version of the product.
55
+ * @type {number}
56
+ * @memberof UploadDocxTemplateRequestDto
57
+ */
58
+ 'productVersionId'?: number;
59
+ }
60
+
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@emilgroup/document-sdk",
3
- "version": "1.6.0",
3
+ "version": "1.7.0",
4
4
  "description": "OpenAPI client for @emilgroup/document-sdk",
5
5
  "author": "OpenAPI-Generator Contributors",
6
6
  "keywords": [