@epilot/document-client 0.18.1 → 0.19.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 (2) hide show
  1. package/package.json +4 -4
  2. package/src/openapi.d.ts +37 -3
package/package.json CHANGED
@@ -1,6 +1,6 @@
1
1
  {
2
2
  "name": "@epilot/document-client",
3
- "version": "0.18.1",
3
+ "version": "0.19.1",
4
4
  "description": "API Client for epilot document API",
5
5
  "main": "dist/index.js",
6
6
  "types": "dist/index.d.ts",
@@ -25,7 +25,7 @@
25
25
  "dependencies": {
26
26
  "buffer": "^6.0.3",
27
27
  "https-browserify": "^1.0.0",
28
- "openapi-client-axios": "^7.6.0",
28
+ "openapi-client-axios": "^7.8.0",
29
29
  "stream-http": "^3.1.1",
30
30
  "url": "^0.11.0",
31
31
  "util": "^0.12.3"
@@ -34,10 +34,10 @@
34
34
  "@types/jest": "^26.0.20",
35
35
  "axios": "^1.11.0",
36
36
  "copy-webpack-plugin": "^7.0.0",
37
- "jest": "^26.6.3",
37
+ "jest": "^29.6.2",
38
38
  "json-loader": "^0.5.7",
39
39
  "openapicmd": "^2.7.0",
40
- "ts-jest": "^26.5.0",
40
+ "ts-jest": "^29.4.1",
41
41
  "ts-loader": "^8.0.14",
42
42
  "ts-node": "^10.9.1",
43
43
  "typescript": "^4.1.3",
package/src/openapi.d.ts CHANGED
@@ -11,6 +11,12 @@ import type {
11
11
  declare namespace Components {
12
12
  namespace Schemas {
13
13
  export interface ConvertDocumentRequest {
14
+ /**
15
+ * Language
16
+ * example:
17
+ * de
18
+ */
19
+ language?: string;
14
20
  /**
15
21
  * Input document
16
22
  */
@@ -67,7 +73,7 @@ declare namespace Components {
67
73
  /**
68
74
  * Language
69
75
  * example:
70
- * en
76
+ * de
71
77
  */
72
78
  language?: string;
73
79
  /**
@@ -166,6 +172,32 @@ declare namespace Components {
166
172
  s3ref?: S3Reference;
167
173
  };
168
174
  };
175
+ xlsx_output?: {
176
+ /**
177
+ * Pre-signed S3 GET URL for XLSX preview
178
+ * example:
179
+ * https://document-api-prod.s3.eu-central-1.amazonaws.com/preview/my-template-OR-001.xlsx
180
+ */
181
+ preview_url?: string;
182
+ /**
183
+ * example:
184
+ * {
185
+ * "s3ref": {
186
+ * "bucket": "document-api-preview-prod",
187
+ * "key": "preview/my-template.xlsx"
188
+ * }
189
+ * }
190
+ */
191
+ output_document?: {
192
+ /**
193
+ * Generated document filename for XLSX
194
+ * example:
195
+ * my-template-OR-001.xlsx
196
+ */
197
+ filename?: string;
198
+ s3ref?: S3Reference;
199
+ };
200
+ };
169
201
  error_output?: ErrorOutput;
170
202
  /**
171
203
  * List of variables and its corresponding replaced values from the document template
@@ -477,6 +509,7 @@ declare namespace Paths {
477
509
  }
478
510
  }
479
511
 
512
+
480
513
  export interface OperationMethods {
481
514
  /**
482
515
  * getTemplateMeta - getTemplateMeta
@@ -506,7 +539,7 @@ export interface OperationMethods {
506
539
  * - .docx but limited to only text based variables
507
540
  * - .ics
508
541
  *
509
- * Uses [Template Variable API](https://docs.epilot.io/api/template-variables) to replace variables in the input document.
542
+ * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the input document.
510
543
  *
511
544
  */
512
545
  'generateDocumentV2'(
@@ -565,7 +598,7 @@ export interface PathsDictionary {
565
598
  * - .docx but limited to only text based variables
566
599
  * - .ics
567
600
  *
568
- * Uses [Template Variable API](https://docs.epilot.io/api/template-variables) to replace variables in the input document.
601
+ * Uses [Template Variables API](https://docs.epilot.io/api/template-variables) to replace variables in the input document.
569
602
  *
570
603
  */
571
604
  'post'(
@@ -597,6 +630,7 @@ export interface PathsDictionary {
597
630
 
598
631
  export type Client = OpenAPIClient<OperationMethods, PathsDictionary>
599
632
 
633
+
600
634
  export type ConvertDocumentRequest = Components.Schemas.ConvertDocumentRequest;
601
635
  export type ConvertDocumentResponse = Components.Schemas.ConvertDocumentResponse;
602
636
  export type DocumentGenerationV2Request = Components.Schemas.DocumentGenerationV2Request;